Allowing upgrade and update to be used interchangably in the URLs (to…

… support updating the kit).

cypress/e2e/plugins/2-prototype-kit-plugin-tests/allow-upgrade-in-url.cypress.js

@@ -0,0 +1,34 @@
+const { replaceInFile, waitForApplication, uninstallPlugin, log } = require('../../utils')
+const path = require('path')
+const { performPluginAction } = require('../plugin-utils')
+const plugin = '@govuk-prototype-kit/task-list'
+const pluginVersion = '1.1.1'
+const originalText = '"dependencies": {'
+const replacementText = `"dependencies": { "${plugin}": "${pluginVersion}",`
+const pkgJsonFile = path.join(Cypress.env('projectFolder'), 'package.json')
+
+function restore () {
+  uninstallPlugin(plugin)
+}
+
+describe('Allow upgrade in URLs', () => {
+  before(restore)
+  after(restore)
+
+  it('When updating the old upgrade URL should still work', () => {
+    waitForApplication()
+
+    log(`Add an old version of ${plugin} within the package.json`)
+    replaceInFile(pkgJsonFile, originalText, '', replacementText)
+    cy.exec(`cd ${Cypress.env('projectFolder')} && npm install`)
+
+    log('Make sure old upgrade URL still works')
+    cy.visit(`/manage-prototype/plugins/upgrade?package=${encodeURIComponent(plugin)}`)
+    cy.get('button#plugin-action-button')
+      .contains('Update')
+      .click()
+
+    log('Force the plugins to be installed with an npm install')
+    performPluginAction('update', plugin, 'Task List')
+  })
+})

lib/manage-prototype-handlers.js

@@ -514,7 +514,7 @@ async function getPluginsHandler (req, res) {
 async function getPluginForRequest (req) {
   const packageName = req.query.package || req.body.package
   const version = req.query.version || req.body.version
-  const { mode } = req.params
+  const mode = getModeFromRequest(req)
   let chosenPlugin
 
   if (packageName) {
@@ -569,7 +569,7 @@ function modeIsComplete (mode, { installedVersion, latestVersion, version, insta
 
 async function getPluginsModeHandler (req, res) {
   const isSameOrigin = req.headers['sec-fetch-site'] === 'same-origin'
-  const { mode } = req.params
+  const mode = getModeFromRequest(req)
   const { version } = req.query
   const verb = verbs[mode]
 
@@ -623,8 +623,16 @@ function setKitRestarted (state) {
   kitRestarted = state
 }
 
-async function postPluginsStatusHandler (req, res) {
+function getModeFromRequest (req) {
   const { mode } = req.params
+  if (mode === 'upgrade') {
+    return 'update'
+  }
+  return mode
+}
+
+async function postPluginsStatusHandler (req, res) {
+  const mode = getModeFromRequest(req)
   let status = 'processing'
   try {
     if (kitRestarted) {
@@ -658,7 +666,7 @@ async function postPluginsModeMiddleware (req, res, next) {
 }
 
 async function postPluginsModeHandler (req, res) {
-  const { mode } = req.params
+  const mode = getModeFromRequest(req)
 
   // Allow smooth update from 13.1.0 as the status route is incorrectly matched
   if (mode === 'status') {