New Plugin Details page #2328

nataliecarey · 2023-09-06T06:37:24Z

New plugin page, this also changes the install/uninstall/update mechanism. It introduces a plugin lookup which is behind a feature flag and the option of downgrading to a specific version which is also behind a feature flag.

nataliecarey · 2023-09-11T09:44:11Z

The remaining tasks here:

Test updating to this version (it will almost certainly show a failure currently)
Show prereleases
Pagination

Pagination is probably worth moving to a separate PR/ticket, if so I suggest we keep the plugin list shorter until we have pagination - I added the additional plugins because I was planning to do the pagination.

BenSurgisonGDS

I like where this is going, but I think we should split the changes so the improved install, uninstall and update API is in a separate PR as well as another PR for the improved changes to the internal store of the plugin details.

BenSurgisonGDS · 2023-09-11T12:21:39Z

CHANGELOG.md

 ### Fixes

 - [#2318: Only show Clear search link if there's a search](https://github.com/alphagov/govuk-prototype-kit/pull/2318)
 - [#2321: Update hint for create page](https://github.com/alphagov/govuk-prototype-kit/pull/2321)
- [#2317: Using internal GOV.UK Frontend more widely](https://github.com/alphagov/govuk-prototype-kit/pull/2317) - this makes error pages, password pages etc. more reliable.


There is a change log entry for a non related PR and none for this PR

That's really weird ... I don't know how that got in there. I'll add one for this.

BenSurgisonGDS · 2023-09-11T12:36:08Z

lib/utils/packageDetails.js

@@ -219,7 +219,7 @@ async function getPluginDetailsFromRef (ref) {
      return await self.getInstalledPluginDetails(id)
    }
    if (source === 'fs') {
-      return await self.getPluginDetailsFromFileSystem(id)
+      return await self.getPluginDetailsFromFileSystem([id, ...extra].join(':'))


I think this is a case where a comment would be helpful for anyone other than us to know what is happening here.

I'll add something to make it clearer.

BenSurgisonGDS · 2023-09-11T13:02:38Z

cypress/e2e/plugins/0-mock-plugin-tests/install-plugin-via-ui-test.cypress.js

+  beforeEach(() => () => {
+    cy.exec(`cd ${Cypress.env('projectFolder')} && npm uninstall ${dependentPluginPackageName}`)
+    cy.task('addToConfigJson', { allowGovukFrontendUninstall: true })
+    waitForApplication()


I found in the past that "waitForApplication()" is problematic within the beforeEach. If it's required, you need it at the start of each test. There was a change a few versions ago as to how cypress loads each test that required this.

Changed, thanks.

BenSurgisonGDS · 2023-09-11T13:14:17Z

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

@@ -108,6 +114,8 @@ describe('Management plugins: ', () => {
    deleteFile(path.join(appViews, 'step-by-step-navigation.html'))
    installPlugin(plugin, version2)

+    waitForApplication()


Not required as waitForApplication is called within loadInstalledPluginsPage

I'll remove it.

BenSurgisonGDS · 2023-09-11T13:21:43Z

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


    //   ------------------------

    log('Fail when installing a plugin with a non existent version')
-    cy.visit(`${managePluginsPagePath}/install?package=${encodeURIComponent(plugin)}&version=0.0.1`)
-    cy.get('h2').contains(`Install ${pluginName}`)
-    failAction('install')


Please see previous fail action comment

Fair, I'll take another look at this.

BenSurgisonGDS · 2023-09-11T14:01:15Z

lib/assets/javascripts/manage-prototype/manage-plugins.test.js

@@ -76,10 +76,20 @@ describe('manage-plugins', () => {
      if (status === 'throws') {
        return Promise.reject(new Error('The server is restarting'))
      }
-      return fetchResponse({ status })


I'm pretty sure that even though I like the use of an object of status being returned here, this will definetly break our current api and make an upgrade to this version problematic. It was the reason I didn't change it before.

As long as you support the previous routes for the status call in the new version, server side, this will work,

Yeah, I'll be looking at the upgrade.

BenSurgisonGDS · 2023-09-11T14:36:04Z

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

@@ -149,7 +137,10 @@
                        </li>
                    {% endfor %}
                </ul>
+                </form>
+              {% if showPluginLookup %}


As stated earlier, I think even with a feature flag this should be in a separate PR as it is not part of the ticket even if it is useful.

The reason for it being part of this PR is that it allows us to test the functionality of looking up from Github, File System etc. Without this it's much harder to test.

It also allows us to test the plugin dependencies with local plugins.

BenSurgisonGDS · 2023-09-11T14:36:56Z

lib/nunjucks/views/manage-prototype/lookup-plugin.njk

@@ -0,0 +1,128 @@
+{% from "govuk/components/radios/macro.njk" import govukRadios %}


I think even with a feature flag this should be in a separate PR as it is not part of the ticket even if it is useful.

(see other response)

BenSurgisonGDS · 2023-09-11T14:38:54Z

lib/plugins/plugins.js

@@ -219,12 +221,15 @@ function prepareWordForPackageNameDisplay (word) {
 }

 function prepareName (name) {
+  if (name === 'x-govuk') {


Perhaps this should be in the separate PR that supports additional plugins we haven't yet discussed as being included.

It's worth making the names clearer even if we're not including it in the "available" list because it appears once people have installed. It's a small enough change that I'd rather keep it in here but I can raise it as a separate PR if needed.

BenSurgisonGDS · 2023-09-11T14:52:54Z

lib/utils/functionCache.js

@@ -0,0 +1,75 @@
+const { promises: fsp, existsSync } = require('fs')


Clever, but I'm a bit nervous about this being difficult for someone other than us to figure out what's happening when there is a bug that's not obvious. Perhaps some comments explaining what this is and why its used.

Yeah, this was done by my IDE, I'll change it to our usual approach.

nataliecarey · 2023-09-12T15:17:51Z

The remaining tasks here:

Test updating to this version (it will almost certainly show a failure currently)

Show prereleases

Pagination

Pagination is probably worth moving to a separate PR/ticket, if so I suggest we keep the plugin list shorter until we have pagination - I added the additional plugins because I was planning to do the pagination.

Points 1 and 2 are now complete, pagination is not included.

The requested changes have been made. Feel free to re-review.

nataliecarey force-pushed the 2295_add-plugins-ui-improvents branch 2 times, most recently from 66e55bd to 416b421 Compare September 8, 2023 15:49

BenSurgisonGDS previously requested changes Sep 11, 2023

View reviewed changes

nataliecarey force-pushed the 2295_add-plugins-ui-improvents branch 2 times, most recently from 2d2e71d to c5119bf Compare September 12, 2023 14:02

nataliecarey changed the title ~~Initial work on plugin UI improvements~~ New Plugin Details page Sep 12, 2023

nataliecarey requested a review from BenSurgisonGDS September 12, 2023 15:17

nataliecarey force-pushed the 2295_add-plugins-ui-improvents branch from 208861c to 305f723 Compare September 12, 2023 15:21

nataliecarey marked this pull request as ready for review September 12, 2023 21:39

nataliecarey added 3 commits September 15, 2023 19:07

Adding plugin page, updating plugin lookup and install/uninstall/update

69d6394

Correcting casing on Govuk.

fd70f7a

Correcting cancel link.

bd6347c

nataliecarey force-pushed the 2295_add-plugins-ui-improvents branch from 7ecc397 to bd6347c Compare September 15, 2023 18:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Plugin Details page #2328

New Plugin Details page #2328

nataliecarey commented Sep 6, 2023 •

edited

nataliecarey commented Sep 11, 2023

BenSurgisonGDS left a comment •

edited

BenSurgisonGDS Sep 11, 2023

nataliecarey Sep 11, 2023

BenSurgisonGDS Sep 11, 2023

nataliecarey Sep 11, 2023

BenSurgisonGDS Sep 11, 2023

nataliecarey Sep 11, 2023

BenSurgisonGDS Sep 11, 2023

nataliecarey Sep 11, 2023

BenSurgisonGDS Sep 11, 2023

nataliecarey Sep 11, 2023

nataliecarey Sep 11, 2023

BenSurgisonGDS Sep 11, 2023

BenSurgisonGDS Sep 11, 2023

nataliecarey Sep 11, 2023

BenSurgisonGDS Sep 11, 2023

nataliecarey Sep 11, 2023

BenSurgisonGDS Sep 11, 2023

nataliecarey Sep 11, 2023

BenSurgisonGDS Sep 11, 2023

nataliecarey Sep 11, 2023

BenSurgisonGDS Sep 11, 2023

nataliecarey Sep 11, 2023

nataliecarey commented Sep 12, 2023

		@@ -0,0 +1,128 @@
		{% from "govuk/components/radios/macro.njk" import govukRadios %}

		@@ -0,0 +1,75 @@
		const { promises: fsp, existsSync } = require('fs')

New Plugin Details page #2328

Are you sure you want to change the base?

New Plugin Details page #2328

Conversation

nataliecarey commented Sep 6, 2023 • edited

nataliecarey commented Sep 11, 2023

BenSurgisonGDS left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nataliecarey commented Sep 12, 2023

nataliecarey commented Sep 6, 2023 •

edited

BenSurgisonGDS left a comment •

edited