Prevent management pages using "plugin" GOV.UK Frontend views #2355
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
colinrotherham
changed the title
colinrotherham
commented
Oct 5, 2023
|
Plenty of failing tests to look at Nunjucks wise, management pages won’t have access to plugin filters, functions or Express.js app locals |
colinrotherham
changed the title
GOV.UK Frontend `nunjucksPaths` and `sass` config fields may potentially be `string | string[]` values one day
Prototype pages should use the “plugin” version by default although we’ll add an improved way to provide a backup version should the plugin be uninstalled
colinrotherham
force-pushed
the
nunjucks-env
branch
from
bd054fd
to
60ea990
Compare
Adds an option param to `getNunjucksAppEnv()` to append backup view directories
colinrotherham
force-pushed
the
nunjucks-env
branch
3 times, most recently
from
e9086d2
to
d3a4381
Compare
Jest uses Babel to hoist `jest.mock()` calls above `require()` already But this change avoids needing a second call to update the mock implementation in a `beforeEach()` when it would be too late to do so
This prevents Manage prototype pages using “plugin” GOV.UK Frontend Unlike other management pages, the handler `getTemplatesViewHandler()` will still pick up the GOV.UK Frontend “plugin” version
Management pages use locals like `serviceName` which custom Nunjucks environments don’t provide Here we’re restoring the same `app.locals` that the route’s `res.render()` included by default previously
colinrotherham
force-pushed
the
nunjucks-env
branch
from
d3a4381
to
293015b
Compare
|
We're all set on this one now I've made sure management pages keep Express.js app locals |
colinrotherham
changed the title
|
Thanks @BenSurgisonGDS, just added a CHANGELOG entry |
BenSurgisonGDS
previously approved these changes
Oct 9, 2023
CHANGELOG.md
Outdated
| @@ -8,6 +8,7 @@ | |||
|
|
|||
| - [#2306: Locate GOV.UK Frontend using `require.resolve()`](https://github.com/alphagov/govuk-prototype-kit/pull/2306) | |||
| - [#2349: Fix GOV.UK Frontend `initAll()` on management pages](https://github.com/alphagov/govuk-prototype-kit/pull/2349) | |||
| - [#2355: Prevent management pages using "plugin" GOV.UK Frontend views](https://github.com/alphagov/govuk-prototype-kit/pull/2355) | |||
There was a problem hiding this comment.
This should be under "Unreleased" instead of "13.13.4".
There was a problem hiding this comment.
Nice spot, done ✅
colinrotherham
force-pushed
the
nunjucks-env
branch
from
99492e1
to
4781c10
Compare
|
|
||
| beforeEach(() => { | ||
| mockSend = jest.fn() | ||
| res.status = jest.fn().mockReturnValue({ send: mockSend }) | ||
| res.status = jest.fn().mockReturnValue({ send: res.send }) |
There was a problem hiding this comment.
Is there any reason we're not using:
res.status = jest.fn().mockReturnValue(res)
There was a problem hiding this comment.
No not at all, loads of ways to do this
Let me know if it's a blocker
There was a problem hiding this comment.
I've added it this morning, nice improvement should we need it in future
There's another handy shorthand if it's helpful for other tests:
- lookupPackageInfo: jest.fn().mockImplementation((packageName) => {
+ lookupPackageInfo: jest.fn((packageName) => {
BenSurgisonGDS
approved these changes
Oct 11, 2023
This was referenced Oct 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes #2352 for management pages only
The fix uses
res.send()with a custom Nunjucks environment as used bygetTemplatesViewHandler()Management pages previously used Express.js
res.render()with all plugin Nunjucks views availableGOV.UK Frontend v5 release
Without this bugfix, users upgrading to GOV.UK Frontend v5 would see management pages load Nunjucks views from GOV.UK Frontend v5 but fonts, assets, styles and scripts from GOV.UK Frontend v4