Merge pull request #2356 from alphagov/only-allow-update-functionalit…

…y-when-possible

Only allow plugin update functionality when installed from npm

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Fixes
 
 - [#2355: Prevent management pages using "plugin" GOV.UK Frontend views](https://github.com/alphagov/govuk-prototype-kit/pull/2355)
+- [#2356: Only allow plugin update functionality when installed from npm](https://github.com/alphagov/govuk-prototype-kit/pull/2356)
 - [#2358: Suppress Sass warnings for `$legacy` deprecated colour palette](https://github.com/alphagov/govuk-prototype-kit/pull/2358)
 - [#2359: Update application.js to `<script type"module">`](https://github.com/alphagov/govuk-prototype-kit/pull/2359)
 

cypress/e2e/plugins/1-available-plugins-tests/install-available-plugin.cypress.js

@@ -80,18 +80,23 @@ describe('Management plugins: ', () => {
 
     loadPluginsPage()
 
+    cy.get('#plugins-updates-available-message').should('not.exist')
+
     cy.visit(`${managePluginsPagePath}/install?package=${encodeURIComponent(plugin)}&version=${version1}`)
 
     cy.get('#plugin-action-button').click()
 
     performPluginAction('install', plugin, pluginName)
 
+    cy.get('#plugins-updates-available-message').contains('1 UPDATE AVAILABLE')
+
     //   ------------------------
 
     log(`Update the ${plugin}@${version1} plugin to ${plugin}@${version2}`)
     installPlugin(plugin, version1)
 
     loadInstalledPluginsPage()
+
     log(`Update the ${plugin} plugin`)
 
     cy.get(`[data-plugin-package-name="${plugin}"]`)
@@ -101,6 +106,8 @@ describe('Management plugins: ', () => {
       .click()
 
     performPluginAction('update', plugin, pluginName)
+
+    cy.get('#plugins-updates-available-message').should('not.exist')
   })
 
   it(`Create a page using a template from the ${plugin} plugin`, () => {

lib/manage-prototype-handlers.js

@@ -412,6 +412,7 @@ function buildPluginData (pluginData) {
     packageName,
     installed,
     installedLocally,
+    updateAvailable,
     latestVersion,
     installedVersion,
     required,
@@ -427,7 +428,7 @@ function buildPluginData (pluginData) {
     installedLocally,
     installLink: `${contextPath}/plugins/install?package=${encodeURIComponent(packageName)}`,
     installCommand: `npm install ${packageName}`,
-    updateLink: installed && !installedLocally && latestVersion !== installedVersion ? `${contextPath}/plugins/update?package=${encodeURIComponent(packageName)}` : undefined,
+    updateLink: updateAvailable ? `${contextPath}/plugins/update?package=${encodeURIComponent(packageName)}` : undefined,
     updateCommand: latestVersion && `npm install ${packageName}@${latestVersion}`,
     uninstallLink: installed && !required ? `${contextPath}/plugins/uninstall?package=${encodeURIComponent(packageName)}${installedLocally ? `&version=${encodeURIComponent(localVersion)}` : ''}` : undefined,
     uninstallCommand: `npm uninstall ${packageName}`,
@@ -450,7 +451,7 @@ async function prepareForPluginPage (isInstalledPage, search) {
     status: isInstalledPage ? 'installed' : 'search',
     plugins: plugins.map(buildPluginData),
     found: plugins.length,
-    updates: installedPlugins.filter(plugin => plugin.installedVersion !== plugin.latestVersion).length
+    updates: installedPlugins.filter(plugin => plugin.updateAvailable).length
   }
 }
 

lib/nunjucks/views/manage-prototype/plugins.njk

@@ -38,6 +38,7 @@
                 {% endif %}
                 {% if updatesMessage %}
                     {{ govukTag({
+                        attributes: {id: "plugins-updates-available-message"},
                         text: updatesMessage
                     }) }}
                 {% endif %}

lib/plugins/packages.js

@@ -87,6 +87,7 @@ async function refreshPackageInfo (packageName, version) {
   const installedPackageVersion = packageJson && projectPackage.dependencies[packageName]
   const installed = !!installedPackageVersion
   const installedLocally = installedPackageVersion?.startsWith('file:')
+  const installedFromGithub = installedPackageVersion?.startsWith('github:')
   const installedVersion = installed ? packageJson?.version : undefined
 
   let localVersion
@@ -118,6 +119,8 @@ async function refreshPackageInfo (packageName, version) {
     localVersion = path.resolve(installedPackageVersion.replace('file:', ''))
   }
 
+  const updateAvailable = installed && !installedLocally && !installedFromGithub && installedVersion !== latestVersion
+
   const pluginDependencies = pluginConfig?.pluginDependencies ? normaliseDependencies(pluginConfig.pluginDependencies) : undefined
 
   const packageInfo = {
@@ -133,6 +136,7 @@ async function refreshPackageInfo (packageName, version) {
     pluginConfig,
     pluginDependencies,
     localVersion,
+    updateAvailable,
     installedPackageVersion
   }
 

lib/plugins/packages.spec.js

@@ -184,6 +184,7 @@ describe('packages', () => {
         installedPackageVersion: '1.0.0',
         installedVersion: '1.0.0',
         latestVersion: '1.0.1',
+        updateAvailable: true,
         required: false,
         packageJson: {
           local: true,
@@ -211,6 +212,7 @@ describe('packages', () => {
         installed: false,
         latestVersion: '1.0.0',
         required: false,
+        updateAvailable: false,
         packageJson: {
           version: '1.0.0'
         },
@@ -232,6 +234,7 @@ describe('packages', () => {
         installed: false,
         latestVersion: '2.0.0',
         required: false,
+        updateAvailable: false,
         packageJson: {
           version: '2.0.0'
         },
@@ -266,6 +269,7 @@ describe('packages', () => {
         available: false,
         installed: false,
         localVersion: version,
+        updateAvailable: false,
         packageJson: {
           local: true,
           version: '1.0.0'