hof 20.0.0-redis-beta.32-redis-beta → 20.0.1

package/.github/workflows/automate-publish.yml

@@ -16,7 +16,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v1
         with:
-          node-version: 14
+          node-version: 10
           registry-url: https://registry.npmjs.org/
       - name: 'Get Previous tag'
         id: previoustag

package/.github/workflows/automate-tag.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [10.x, 12.x, 14.x]
         redis-version: [4, 5, 6]
     steps:
       - uses: actions/checkout@v2.2.0
@@ -34,7 +34,7 @@ jobs:
       - uses: actions/checkout@v2.2.0
       - uses: actions/setup-node@v1
         with:
-          node-version: 14
+          node-version: 10
           registry-url: https://registry.npmjs.org/
       - run: |
           git config --local user.email "$(git log --format='%ae' HEAD^!)"
@@ -52,7 +52,7 @@ jobs:
       - uses: actions/checkout@v2.2.0
       - uses: actions/setup-node@v1
         with:
-          node-version: 14
+          node-version: 10
           registry-url: https://registry.npmjs.org/
       - run: |
           git config --local user.email "$(git log --format='%ae' HEAD^!)"
@@ -70,7 +70,7 @@ jobs:
       - uses: actions/checkout@v2.2.0
       - uses: actions/setup-node@v1
         with:
-          node-version: 14
+          node-version: 10
           registry-url: https://registry.npmjs.org/
       - run: |
           git config --local user.email "$(git log --format='%ae' HEAD^!)"

package/README.md

@@ -1722,3 +1722,9 @@ Additional vendor JavaScript files are included. These are:
 - safari-cachebuster.js
 
 Copy `assets/javascript/vendor` into your javascript directory (ie `hmpo/vendor`) and compile them with your JavaScript.
+
+## Journey Header Navigation.html page
+
+- Navigation.html contains a journeyHeaderURL, which is set in the controller. 
+- getJourneyHeaderURL within the controller translates an empty baseURL to '/'.
+- The above helps fix broken journey header URLs in the GRO and UKVIC services which both have a baseURL's set to '/'.

package/components/notify/notify.js

@@ -1,6 +1,6 @@
 'use strict';
 const NotifyClient = require('notifications-node-client').NotifyClient;
-const {v4: uuidv4} = require('uuid');
+const { v4: uuidv4 } = require('uuid');
 
 module.exports = class Notify {
   constructor(opts) {

package/config/hof-defaults.js

@@ -27,8 +27,7 @@ const defaults = {
   ignoreMiddlewareLogs: ['/healthz'],
   redis: {
     port: process.env.REDIS_PORT || '6379',
-    host: process.env.REDIS_HOST || '127.0.0.1',
-    legacyMode: true
+    host: process.env.REDIS_HOST || '127.0.0.1'
   },
   session: {
     ttl: process.env.SESSION_TTL || 1800,

package/config/sanitisation-rules.js

@@ -3,27 +3,30 @@
 
 const sanitisationBlacklistArray = {
   // Input will be sanitised using the below rules
+  // Each one is an array which will run sequentially
+  // Some have multiple steps which allow us to remove dups then append the suffix
+  // Useful for ensuring we're not re-sanitising the same input multiple times (and appending extra hypens each time)
   // The key is what we're sanitising out
   // The regex is the rule we used to find them (note some dictate repeating characters)
   // And the replace is what we're replacing that pattern with. Usually nothing sometimes a
   // single character or sometimes a single character followed by a "-"
-  '/*': { regex: '\/\\*', replace: '-' },
-  '*/': { regex: '\\*\\/', replace: '-' },
-  '|': { regex: '\\|', replace: '-' },
-  '&&': { regex: '&&+', replace: '&' },
-  '@@': { regex: '@@+', replace: '@' },
-  '/..;/': { regex: '/\\.\\.;/', replace: '-' }, // Purposely input before ".." as they conflict
-  // '..': { regex: '\\.\\.+', replace: '.' }, // Agreed to disable this rule for now unless its specifically required
-  '/etc/passwd': { regex: '\/etc\/passwd', replace: '-' },
-  'c:\\': { regex: 'c:\\\\', replace: '-' },
-  'cmd.exe': { regex: 'cmd\\.exe', replace: '-' },
-  '<': { regex: '<', replace: '<-' },
-  '>': { regex: '>', replace: '>-' },
-  '[': { regex: '\\[+', replace: '[-' },
-  ']': { regex: '\\]+', replace: ']-' },
-  '~': { regex: '~', replace: '~-' },
-  '&#': { regex: '&#', replace: '-' },
-  '%U': { regex: '%U', replace: '-' }
+  '/*': [{ regex: '\/\\*', replace: '-' }],
+  '*/': [{ regex: '\\*\\/', replace: '-' }],
+  '|': [{ regex: '\\|', replace: '-' }],
+  '&&': [{ regex: '&&+', replace: '&' }],
+  '@@': [{ regex: '@@+', replace: '@' }],
+  '/..;/': [{ regex: '/\\.\\.;/', replace: '-' }], // Purposely input before ".." as they conflict
+  // '..': [{ regex: '\\.\\.+', replace: '.' }], // Agreed to disable this rule for now unless its specifically required
+  '/etc/passwd': [{ regex: '\/etc\/passwd', replace: '-' }],
+  'c:\\': [{ regex: 'c:\\\\', replace: '-' }],
+  'cmd.exe': [{ regex: 'cmd\\.exe', replace: '-' }],
+  '<': [{ regex: '<+', replace: '<' }, { regex: '<(?!-)', replace: '<-' }],
+  '>': [{ regex: '>+', replace: '>' }, { regex: '>(?!-)', replace: '>-' }],
+  '[': [{ regex: '\\[+', replace: '[' }, { regex: '\\[(?!-)', replace: '[-' }],
+  ']': [{ regex: '\\]+', replace: ']-' }, { regex: '\\](?!-)', replace: ']-' }],
+  '~': [{ regex: '~+', replace: '~' }, { regex: '~(?!-)', replace: '~-' }],
+  '&#': [{ regex: '&#', replace: '-' }],
+  '%U': [{ regex: '%U', replace: '-' }]
 };
 
 module.exports = sanitisationBlacklistArray;

package/controller/base-controller.js

@@ -177,9 +177,11 @@ module.exports = class BaseController extends EventEmitter {
           // For each property in our form data
           Object.keys(sanitisationBlacklistArray).forEach(function (blacklisted, blacklistedIndex) {
             const blacklistedDetail = sanitisationBlacklistArray[blacklisted];
-            const regexQuery = new RegExp(blacklistedDetail.regex, 'gi');
-            // Will perform the required replace based on our passed in regex and the replace string
-            req.form.values[property] = req.form.values[property].replace(regexQuery, blacklistedDetail.replace);
+            blacklistedDetail.forEach(step => {
+              const regexQuery = new RegExp(step.regex, 'gi');
+              // Will perform the required replace based on our passed in regex and the replace string
+              req.form.values[property] = req.form.values[property].replace(regexQuery, step.replace);
+            });
           });
         }
       });

package/controller/controller.js

@@ -113,6 +113,7 @@ module.exports = class Controller extends BaseController {
       baseUrl: req.baseUrl,
       skipToMain: this.getFirstFormItem(req.form.options.fields),
       title: this.getTitle(route, lookup, req.form.options.fields, res.locals),
+      journeyHeaderURL: this.getJourneyHeaderURL(req.baseUrl),
       header: this.getHeader(route, lookup, res.locals),
       captionHeading: this.getCaptionHeading(route, lookup, res.locals),
       warning: this.getWarning(route, lookup, res.locals),
@@ -124,6 +125,10 @@ module.exports = class Controller extends BaseController {
     }, stepLocals);
   }
 
+  getJourneyHeaderURL(url) {
+    return url === '' ? '/' : url;
+  }
+
   getFirstFormItem(fields) {
     let firstFieldKey;
     if (_.size(fields)) {

package/frontend/template-partials/views/layout.html

@@ -44,9 +44,9 @@
     {{/gaTagId}}
   {{/cookieMessage}}
   {{$footerSupportLinks}}
-    <ul>
+    <ul class="govuk-footer__inline-list">
       {{#footerSupportLinks}}
-        <li class="govuk-footer__inline-list-item"><a href="{{path}}">{{#t}}{{property}}{{/t}}</a></li>
+        <li class="govuk-footer__inline-list-item"><a class="govuk-footer__link" href="{{path}}">{{#t}}{{property}}{{/t}}</a></li>
       {{/footerSupportLinks}}
       {{^footerSupportLinks}}
         <li class="govuk-footer__inline-list-item"><a class="govuk-footer__link" href="/cookies">{{#t}}base.cookies{{/t}}</a></li>

package/frontend/template-partials/views/partials/maincontent-left.html

@@ -3,8 +3,8 @@
   <div class="govuk-grid-column-two-thirds">
     {{$validationSummary}}{{/validationSummary}}
     {{#captionHeading}}<span class="govuk-caption-l">{{captionHeading}}</span>{{/captionHeading}}
-    {{#header}}<h1 class="govuk-heading-xl">{{header}}</h1>{{/header}}
-    {{#subHeading}}<div id="page-header" class="govuk-heading-l">{{subHeading}}</div>{{/subHeading}}
+    {{#header}}<h1 class="govuk-heading-l">{{header}}</h1>{{/header}}
+    {{#subHeading}}<div id="page-header"><h2 class="govuk-heading-m">{{subHeading}}</h2></div>{{/subHeading}}
     {{$content}}{{/content}}
   </div>
 {{/content-outer}}

package/frontend/template-partials/views/partials/navigation.html

@@ -1,8 +1,8 @@
 <div class="govuk-header__content">
   {{#startPageRedirectUrl}}
-    <a href="{{startPageRedirectUrl}}" class="govuk-header__link govuk-header__link--service-name" id="proposition-name">{{$journeyHeader}}{{/journeyHeader}}</a>  
+    <a href="{{startPageRedirectUrl}}" class="govuk-header__link govuk-header__link--service-name" id="proposition-name">{{$journeyHeader}}{{/journeyHeader}}</a>
   {{/startPageRedirectUrl}}
   {{^startPageRedirectUrl}}
-    <a href="{{baseUrl}}" class="govuk-header__link govuk-header__link--service-name" id="proposition-name">{{$journeyHeader}}{{/journeyHeader}}</a> 
+    <a href="{{journeyHeaderURL}}" class="govuk-header__link govuk-header__link--service-name" id="proposition-name">{{$journeyHeader}}{{/journeyHeader}}</a>
   {{/startPageRedirectUrl}}
 </div>

package/frontend/template-partials/views/partials/summary-table-row.html

@@ -5,10 +5,10 @@
         <dt class="confirm-label">{{label}}</dt>
         <dd class="confirm-value" data-value="{{value}}">{{value}}</dd>
     {{#changeLink}}
-        <dd><span class="link"><a href="{{changeLink}}" id="{{field}}-change-{{index}}">{{#t}}buttons.change{{/t}} <span class="visuallyhidden">{{changeLinkDescription}} from {{value}}</span></a></span></dd>
+        <dd><span><a class="govuk-link" href="{{changeLink}}" id="{{field}}-change-{{index}}">{{#t}}buttons.change{{/t}} <span class="visuallyhidden">{{changeLinkDescription}} from {{value}}</span></a></span></dd>
     {{/changeLink}}
     {{^changeLink}}
-        <dd><span class="link"><a href="{{baseUrl}}{{step}}/edit#{{field}}" id="{{field}}-change">{{#t}}buttons.change{{/t}} <span class="visuallyhidden">{{changeLinkDescription}} from {{value}}</span></a></span></dd>
+        <dd><span><a class="govuk-link" href="{{baseUrl}}{{step}}/edit#{{field}}" id="{{field}}-change">{{#t}}buttons.change{{/t}} <span class="visuallyhidden">{{changeLinkDescription}} from {{value}}</span></a></span></dd>
     {{/changeLink}}
     {{/isSeparator}}
 </div>

package/frontend/template-partials/views/session-timeout.html

@@ -1,6 +1,7 @@
 {{<error}}
   {{$content}}
-    <p>{{{content.message}}}</p>
+    <h1 class="govuk-heading-l">{{{content.title}}}</h1>
+    <h2 class="govuk-heading-m">{{{content.message}}}</h2>
     <a href="{{startLink}}" class="govuk-button" role="button">{{#t}}buttons.start-again{{/t}}</a>
   {{/content}}
 {{/error}}

package/index.js

@@ -79,7 +79,7 @@ const getContentSecurityPolicy = (config, res) => {
     fontSrc: ['fonts.gstatic.com '],
     scriptSrc: ['www.google-analytics.com', 'ssl.google-analytics.com'],
     imgSrc: ['www.google-analytics.com', 'ssl.gstatic.com'],
-    connectSrc: ['www.google-analytics.com']
+    connectSrc: ['https://www.google-analytics.com', 'https://region1.google-analytics.com']
   };
 
   if (config.gaTagId) {

package/lib/health.js

@@ -15,7 +15,7 @@ module.exports = redis => {
 
   router.get('/readiness', healthCheck({
     test: () => {
-      if (!redis.isOpen && !redis.isReady) {
+      if (!redis.connected && !redis.ready) {
         return new Error('Session store unhealthy');
       }
       return 0;

package/lib/sessions.js

@@ -50,7 +50,7 @@ module.exports = (app, config) => {
       logger.error(e);
     });
   }
-  client.connect();
+
   const store = new RedisStore({
     client: client,
     ttl: config.session.ttl,

package/middleware/errors.js

@@ -12,6 +12,8 @@ const getContent = (err, translate) => {
   if (err.code === 'SESSION_TIMEOUT') {
     err.status = 401;
     err.template = 'session-timeout';
+    err.title = (translate && translate('errors.session.title'));
+    err.message = (translate && translate('errors.session.message'));
     content.title = (translate && translate('errors.session.title'));
     content.message = (translate && translate('errors.session.message'));
   }

package/middleware/rate-limiter.js

@@ -25,11 +25,9 @@ module.exports = (options, rateLimitType) => {
     }
 
     const closeConnection = async err => {
-      await redisClient.v4.QUIT();
+      await redisClient.quit();
       return next(err);
     };
-    redisClient.on('error', err => logger.log('error', err));
-    await redisClient.connect();
 
     try {
       // fetch records of current user using IP address, returns null when no record is found

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hof",
   "description": "A bootstrap for HOF projects",
-  "version": "20.0.0-redis-beta.32-redis-beta",
+  "version": "20.0.1",
   "license": "MIT",
   "main": "index.js",
   "author": "HomeOffice",
@@ -42,7 +42,7 @@
     "callsite": "^1.0.0",
     "chalk": "^2.0.0",
     "chokidar": "^3.4.0",
-    "connect-redis": "^6.1.3",
+    "connect-redis": "^5.2.0",
     "cookie-parser": "^1.4.6",
     "cp": "^0.2.0",
     "csrf": "^3.0.2",
@@ -72,7 +72,7 @@
     "minimatch": "^3.0.3",
     "minimist": "^1.2.6",
     "mixwith": "^0.1.1",
-    "moment": "^2.29.2",
+    "moment": "^2.29.4",
     "morgan": "^1.10.0",
     "mustache": "^2.3.0",
     "nodemailer": "^6.6.3",
@@ -80,7 +80,7 @@
     "nodemailer-smtp-transport": "^2.7.4",
     "nodemailer-stub-transport": "^1.1.0",
     "notifications-node-client": "^5.1.1",
-    "redis": "^4.3.1",
+    "redis": "^3.1.2",
     "reqres": "^3.0.1",
     "request": "^2.79.0",
     "rimraf": "^3.0.2",
@@ -89,6 +89,7 @@
     "uglify-js": "^3.14.3",
     "underscore": "^1.12.1",
     "urijs": "^1.19.11",
+    "uuid": "^8.3.2",
     "winston": "^3.7.2"
   },
   "devDependencies": {

package/sandbox/server.js

@@ -14,5 +14,5 @@ bootstrap({
     }
   },
   getAccessibility: true,
-  "port": 8080
+  "port": 8082
 });

package/wizard/middleware/check-progress.js

@@ -28,6 +28,41 @@ module.exports = (route, controller, steps, begin) => {
     return _.uniq(allSteps);
   };
 
+  // Gets all the possible routes
+  const walkAllPossibleSteps = (stepName, allStepsInService, allVisitedSteps) => {
+    const stepIncludingFieldsAndForks = allStepsInService[stepName];
+    if (!stepIncludingFieldsAndForks) { return; }
+
+    const forkTargets = _.map(stepIncludingFieldsAndForks.forks, 'target') || [];
+    const nextStep = stepIncludingFieldsAndForks.next || '';
+
+    // If there is no next step or fork, then we have reached the end of the journey
+    if (!forkTargets.length && !nextStep) {
+      allVisitedSteps.push(stepName);
+      // eslint-disable-next-line consistent-return
+      return _.uniq(allVisitedSteps);
+    }
+
+    const nextStepsAndForks = _.uniq(forkTargets.concat(nextStep));
+
+    // We need to transverse through all 'Next' and 'Forks' for this route
+    nextStepsAndForks.map(each => {
+      if (!allVisitedSteps.includes(each)) {
+        allVisitedSteps.push(each);
+        walkAllPossibleSteps(each, allStepsInService, allVisitedSteps);
+      }
+    });
+  };
+
+  // Create a list of all visited steps
+  const createAllVisitedSteps = (stepName, allStepsInService) => {
+    const allVisitedSteps = [stepName];
+    if (allStepsInService[stepName]) {
+      walkAllPossibleSteps(stepName, allStepsInService, allVisitedSteps);
+    }
+    return _.uniq(allVisitedSteps);
+  };
+
   const invalidateStep = (stepName, scopedSteps, sessionModel) => {
     debug('Invalidating', stepName);
     const step = scopedSteps[stepName] || {};
@@ -55,7 +90,7 @@ module.exports = (route, controller, steps, begin) => {
     debug('next', nextStep);
     debug('potential paths', potentialPaths);
     // if we're following a loop then allow the loop to be invalidated
-    const whitelist = isLoop(nextStep, req.path) ? [route] : getAllPossibleSteps(nextStep, steps);
+    const whitelist = isLoop(nextStep, req.path) ? [route] : createAllVisitedSteps(nextStep, steps);
     // aggregate all potential journeys from the invalidating step
     const invalidateSteps = potentialPaths.reduce((arr, step) => arr.concat(getAllPossibleSteps(step, steps)), []);