Merge pull request #4650 from alphagov/only-use-fixture-cache-ci

Only use fixture HTML 'cache' when running on CI
alphagov · Jan 17, 2024 · 39c0a23 · 39c0a23
2 parents b2cf8f5 + e3651dc
commit 39c0a23
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 12 deletions.
diff --git a/packages/govuk-frontend-review/src/app.mjs b/packages/govuk-frontend-review/src/app.mjs
@@ -48,8 +48,7 @@ export default async () => {
 
   // Feature flags
   const flags = /** @type {FeatureFlags} */ ({
-    isDeployedToHeroku: !!process.env.HEROKU_APP,
-    isDevelopment: !['test', 'production'].includes(process.env.NODE_ENV),
+    isDevelopment: !process.env.HEROKU_APP && !process.env.CI,
 
     // Check for JSDoc, SassDoc and Rollup stats
     hasDocsScripts: await hasPath(join(paths.app, 'dist/docs/jsdoc')),
@@ -219,9 +218,7 @@ export default async () => {
       const componentView = render(componentName, {
         context: fixture.options,
         env,
-
-        // Skip Nunjucks render from cache in development
-        fixture: !flags.isDevelopment ? fixture : undefined
+        fixture
       })
 
       let bodyClasses = 'app-template__body'
@@ -278,8 +275,7 @@ export default async () => {
 
 /**
  * @typedef {object} FeatureFlags
- * @property {boolean} isDeployedToHeroku - Review app using `HEROKU_APP`
- * @property {boolean} isDevelopment - Review app not using `NODE_ENV` production or test
+ * @property {boolean} isDevelopment - Review app not in CI or on Heroku
  * @property {boolean} hasDocsStyles - Stylesheets documentation (SassDoc) is available
  * @property {boolean} hasDocsScripts - JavaScripts documentation (JSDoc) is available
  * @property {boolean} hasStats - Rollup stats are available

diff --git a/packages/govuk-frontend-review/src/common/middleware/docs.mjs b/packages/govuk-frontend-review/src/common/middleware/docs.mjs
@@ -16,10 +16,10 @@ router.get('/', (req, res) => {
  * Sass docs latest release (when deployed)
  */
 router.use('/sass', ({ app }, res, next) => {
-  const { isDeployedToHeroku } =
+  const { isDevelopment } =
     /** @type {import('../../app.mjs').FeatureFlags} */ (app.get('flags'))
 
-  if (isDeployedToHeroku) {
+  if (!isDevelopment) {
     return res.redirect(
       'https://frontend.design-system.service.gov.uk/sass-api-reference/'
     )

diff --git a/packages/govuk-frontend-review/src/common/nunjucks/index.mjs b/packages/govuk-frontend-review/src/common/nunjucks/index.mjs
@@ -22,7 +22,7 @@ export function renderer(app) {
     {
       dev: true, // log stack traces
       express: app, // the Express.js review app that nunjucks should install to
-      noCache: !flags.isDeployedToHeroku, // use cache when deployed only
+      noCache: flags.isDevelopment, // use cache in development only
       watch: flags.isDevelopment // reload templates in development only
     },
     {

diff --git a/shared/lib/components.js b/shared/lib/components.js
@@ -155,8 +155,14 @@ function render(componentName, options) {
   const macroName = componentNameToMacroName(componentName)
   const macroPath = `govuk/components/${componentName}/macro.njk`
 
-  // Return built fixture or render
-  return options?.fixture?.html ?? renderMacro(macroName, macroPath, options)
+  // On Heroku / CI we know we're running against an up-to-date build so we can
+  // use the generated HTML from the component JSON (where it exists) to make
+  // things faster
+  if ((process.env.HEROKU_APP || process.env.CI) && options?.fixture?.html) {
+    return options.fixture.html
+  }
+
+  return renderMacro(macroName, macroPath, options)
 }
 
 /**