Locate GOV.UK Frontend using `require.resolve()` by colinrotherham · Pull Request #2306 · alphagov/govuk-prototype-kit

colinrotherham · 2023-08-22T09:58:25Z

This PR ensures we locate all previously hard-coded GOV.UK Frontend paths

This is in preparation for path changes between v4 (current) and v5 (upcoming) releases:

GOV.UK Frontend v4

Base path: node_modules/govuk-frontend
Entry path: node_modules/govuk-frontend/govuk/all.js
Include path: node_modules/govuk-frontend/govuk

GOV.UK Frontend v5

Base path: node_modules/govuk-frontend
Entry path: node_modules/govuk-frontend/dist/govuk/all.bundle.js
Include path: node_modules/govuk-frontend/dist/govuk

Partially closes #2293 and resolves alphagov/govuk-frontend#3759

lib/errorServer.js

lib/plugins/plugins.js

package.json

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

colinrotherham · 2023-08-24T16:09:49Z

I've moved the GOV.UK Frontend v5 preview commits to another branch

Installing the preview from GitHub via npm install was causing test issues:

npm install --save "alphagov/govuk-frontend#6d1a4ef0a"

Not sure if a few sleep() or cy.wait() commands were expecting it to take so long?

Test output is looking a lot better now with some new changes pushed

colinrotherham · 2023-08-24T16:22:29Z

Pushed again with the GOV.UK Frontend v5 preview

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

package.json

__tests__/spec/sanity-checks.js

bin/utils/index.js

lib/authentication.js

lib/errorServer.js

colinrotherham · 2023-09-04T16:08:25Z

server.js

+// Set up GOV.UK Frontend relative paths
+app.locals.govukFrontend = {
+  assetPath: govukFrontend.assetPath,
+  scripts: govukFrontend.config?.scripts || []
+}


@nataliecarey I think these lines need a suggestion

As written, Nunjucks views will get govukFrontend set to the internal GOV.UK Frontend version

Is there a router/middleware approach we can use to set:

Set Nunjucks local govukFrontend to "internal version" by default

Set Nunjucks local govukFrontend to "plugin version" in plugin pages only

Turns out Nunjucks, Sass and the error server had overlapping GOV.UK Frontend versions:

Fix error server /manage-prototype/dependencies #2333

But now they're separated I've added separate locals for each:

// Add GOV.UK Frontend paths to Nunjucks locals app.locals.govukFrontend = govukFrontend app.locals.govukFrontendInternal = govukFrontendInternal

This allows prototype pages and management pages to clearly use their own versions:

{%- set assetPath = '/manage-prototype/dependencies/govuk-frontend' + govukFrontendInternal.assetPath -%}

Or for govuk-branded.njk it can be overridden or default to the plugin version:

{%- set assetPath = assetPath | default('/plugin-assets/govuk-frontend' + govukFrontend.assetPath) -%}

colinrotherham · 2023-09-14T16:21:30Z

lib/govukFrontendPaths.js

+    // GOV.UK Frontend plugin config
+    config: fse.readJsonSync(path.join(baseDir, 'govuk-prototype-kit.config.json'), {
+      throws: false
+    })


@BenSurgisonGDS has suggested a new getScriptsAndAssetsConfig() utility for this

Couldn't find a "sync" way using an existing helper so might be a better option

lib/govukFrontendPaths.js

nataliecarey · 2023-09-21T12:29:29Z

Looks good to me, just needs a changelog entry.

Replaces `getInternalGovukFrontendDir()` with `govukFrontendPaths()` 1. Prefers internal package in packageDir, then projectDir 2. Prefers plugin package in projectDir, then packageDir

Nunjucks locals have been added to prepare for a future GOV.UK Frontend v5 plugin update with a different directory structure

colinrotherham force-pushed the frontend-v5-compatibility-colin branch 3 times, most recently from a73b9d9 to 3e9f2f7 Compare August 22, 2023 14:15

colinrotherham commented Aug 22, 2023

View reviewed changes

lib/errorServer.js Outdated Show resolved Hide resolved

colinrotherham commented Aug 22, 2023

View reviewed changes

lib/plugins/plugins.js Outdated Show resolved Hide resolved

colinrotherham commented Aug 22, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

colinrotherham force-pushed the frontend-v5-compatibility-colin branch 2 times, most recently from e01676d to 592ea50 Compare August 22, 2023 18:03

colinrotherham commented Aug 22, 2023

View reviewed changes

lib/nunjucks/views/manage-prototype/password.njk Outdated Show resolved Hide resolved

colinrotherham force-pushed the frontend-v5-compatibility-colin branch 5 times, most recently from 87e9690 to 7be56f0 Compare August 23, 2023 10:14

This was referenced Aug 23, 2023

The Prototype Kit has a hardcoded reference to the assets folder which has moved in v5 alphagov/govuk-frontend#3759

Closed

Manually test that v5 works with the Prototype Kit alphagov/govuk-frontend#3484

Closed

colinrotherham force-pushed the frontend-v5-compatibility-colin branch 4 times, most recently from 6f8247b to c909c86 Compare August 24, 2023 15:53

colinrotherham force-pushed the frontend-v5-compatibility-colin branch 3 times, most recently from 237d632 to 6f55f04 Compare September 1, 2023 16:17

colinrotherham changed the title ~~Updates for GOV.UK Frontend v5.0.0 support~~ Automatically locate GOV.UK Frontend paths Sep 1, 2023

colinrotherham mentioned this pull request Sep 1, 2023

Use GOV.UK Frontend v5 on management pages and tests #2327

Merged

colinrotherham force-pushed the frontend-v5-compatibility-colin branch from 6f55f04 to 65a2e3e Compare September 1, 2023 16:47

colinrotherham commented Sep 4, 2023

View reviewed changes

lib/nunjucks/views/manage-prototype/scripts.njk Outdated Show resolved Hide resolved

nataliecarey reviewed Sep 4, 2023

View reviewed changes

colinrotherham commented Sep 4, 2023

View reviewed changes

colinrotherham force-pushed the frontend-v5-compatibility-colin branch 4 times, most recently from 60af033 to 5d73dd9 Compare September 13, 2023 16:00

colinrotherham mentioned this pull request Sep 13, 2023

Fix errors.json logging ENOENT: no such file or directory #2332

Merged

colinrotherham force-pushed the frontend-v5-compatibility-colin branch 7 times, most recently from 3ec7f0f to 88a76ec Compare September 14, 2023 16:16

colinrotherham commented Sep 14, 2023

View reviewed changes

colinrotherham marked this pull request as ready for review September 14, 2023 16:24

colinrotherham force-pushed the frontend-v5-compatibility-colin branch from 7291342 to 79bbbe4 Compare September 19, 2023 10:32

nataliecarey reviewed Sep 21, 2023

View reviewed changes

lib/govukFrontendPaths.js Outdated Show resolved Hide resolved

colinrotherham force-pushed the frontend-v5-compatibility-colin branch from 79bbbe4 to ed36da2 Compare September 21, 2023 09:12

colinrotherham changed the title ~~Automatically locate GOV.UK Frontend paths~~ Locate GOV.UK Frontend using require.resolve() Sep 21, 2023

colinrotherham added 4 commits September 21, 2023 16:26

Locate GOV.UK Frontend using require.resolve()

e649805

Replaces `getInternalGovukFrontendDir()` with `govukFrontendPaths()` 1. Prefers internal package in packageDir, then projectDir 2. Prefers plugin package in projectDir, then packageDir

Remove GOV.UK Frontend hard-coded paths

c488c4e

Nunjucks locals have been added to prepare for a future GOV.UK Frontend v5 plugin update with a different directory structure

Prefer lowercase govUk → govuk

4b865e4

Add changelog entry

4a40024

colinrotherham force-pushed the frontend-v5-compatibility-colin branch from ed36da2 to 4a40024 Compare September 21, 2023 15:35

BenSurgisonGDS approved these changes Sep 21, 2023

View reviewed changes

colinrotherham merged commit c3f7655 into main Sep 21, 2023

colinrotherham deleted the frontend-v5-compatibility-colin branch September 21, 2023 16:01

BenSurgisonGDS mentioned this pull request Oct 2, 2023

Preparing for release 13.13.4 (automated). #2350

Merged

colinrotherham mentioned this pull request Oct 9, 2023

Support GOV.UK Frontend v5 plugin #2293

Closed

4 tasks

Conversation

colinrotherham commented Aug 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

GOV.UK Frontend v4

GOV.UK Frontend v5

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

colinrotherham commented Aug 24, 2023

Uh oh!

colinrotherham commented Aug 24, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

colinrotherham Sep 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

colinrotherham Sep 14, 2023

Choose a reason for hiding this comment

Uh oh!

colinrotherham Sep 14, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nataliecarey commented Sep 21, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

colinrotherham commented Aug 22, 2023 •

edited

Loading

colinrotherham Sep 4, 2023 •

edited

Loading