Release v9.0 branch

.drone.yml

@@ -25,23 +25,23 @@ trigger:
 
 linting: &linting
   pull: if-not-exists
-  image: node:14
+  image: node:18
   environment:
     NOTIFY_KEY: USE_MOCK
   commands:
     - yarn run test:lint
 
 unit_tests: &unit_tests
   pull: if-not-exists
-  image: node:14
+  image: node:18
   environment:
     NOTIFY_KEY: USE_MOCK
   commands:
     - yarn run test:unit
 
 sonar_scanner: &sonar_scanner
   pull: if-not-exists
-  image: quay.io/ukhomeofficedigital/sonar-scanner-node:549b75f593f28da1c4a0a6f79877ec69d3b21037
+  image: quay.io/ukhomeofficedigital/sonar-scanner-nodejs:latest
   commands:
     - sonar-scanner -Dproject.settings=./sonar-project.properties
 
@@ -70,7 +70,7 @@ steps:
 
   - name: setup_deploy
     pull: if-not-exists
-    image: node:14
+    image: node:18
     environment:
       NOTIFY_KEY: USE_MOCK
     commands:
@@ -98,7 +98,7 @@ steps:
           - master
       event: push
 
-  - name: sonar_scanner_deploy
+- name: sonar_scanner_deploy
     <<: *sonar_scanner
     when:
       branch:
@@ -150,7 +150,7 @@ steps:
 
   - name: setup_branch
     pull: if-not-exists
-    image: node:14
+    image: node:18
     environment:
       NOTIFY_KEY: USE_MOCK
     commands:
@@ -172,17 +172,17 @@ steps:
           - feature/*
       event: pull_request
 
-  - name: unit_tests_branch
-    <<: *unit_tests
+  - name: sonar_scanner_branch
+    <<: *sonar_scanner
     when:
       branch:
         include:
           - master
           - feature/*
       event: pull_request
 
-  - name: sonar_scanner_branch
-    <<: *sonar_scanner
+  - name: unit_tests_branch
+    <<: *unit_tests
     when:
       branch:
         include:
@@ -205,7 +205,7 @@ steps:
   # Snyk & Anchore security scans which run after branch deployment to prevent blocking of PR UAT tests
   - name: snyk_scan
     pull: if-not-exists
-    image: node:14
+    image: node:18
     environment:
       SNYK_TOKEN:
         from_secret: snyk_token
@@ -391,7 +391,7 @@ steps:
 
   - name: cron_snyk_scan
     pull: if-not-exists
-    image: node:14
+    image: node:18
     environment:
       SNYK_TOKEN:
         from_secret: snyk_token

.snyk

@@ -25,5 +25,9 @@ ignore:
   SNYK-JS-REQUEST-3361831:
     - hof > request:
         reason: No current upgrade available
-        expires: '2023-05-05T10:44:27.223Z'
+        expires: '2024-05-05T10:44:27.223Z'
+  SNYK-JS-XML2JS-5414874:
+     - '*':
+        reason: No current upgrade available
+        expires: '2024-05-05T10:44:27.223Z'
 patch: {}

Dockerfile

@@ -1,10 +1,10 @@
-FROM node:14-alpine@sha256:5c33bc6f021453ae2e393e6e20650a4df0a4737b1882d389f17069dc1933fdc5
+FROM node:18-alpine@sha256:2322b1bb3917b313f2e9308395aa5c39d51b91cc92a5d4d5be6d0451fcfb4d24
 
 USER root
 
 # Update packages as a result of Anchore security vulnerability checks
 RUN apk update && \
-    apk add --upgrade gnutls binutils nodejs nodejs-npm apk-tools libjpeg-turbo libcurl libx11 libxml2
+    apk add --upgrade gnutls binutils nodejs nodejs apk-tools libjpeg-turbo libcurl libx11 libxml2
 
 # Setup nodejs group & nodejs user
 RUN addgroup --system nodejs --gid 998 && \

README.md

@@ -70,23 +70,23 @@ Run the app like normal and you should see all emails going to http://localhost:
 Start the application in default mode (production).
 We use Nginx to serve our static resources in production and ci.
 ```bash
-$ npm start
+$ yarn start
 ```
 
 Start the application with [Nodemon](https://www.npmjs.com/package/nodemon) in development mode.
 Debug is switched on and the server restarts when the JS or Sass are recompiled.
 ```bash
-$ npm run dev
+$ yarn dev
 ```
 
 Run the unit tests
 ```bash
-$ npm run test
+$ yarn test
 ```
 
 Run the EcmaScript (ES) linter.  Rules are defined in [.eslintrc](./.eslintrc)
 ```bash
-$ npm run lint
+$ yarn test:lint
 ```
 
 Run the jscs style checker. Rules are defined in [.jscsrc.json](./.jscsrc.json)

apps/correct-mistakes/behaviours/about-error.js

@@ -2,18 +2,26 @@
 'use strict';
 
 const _ = require('underscore');
+const fields = require('../translations/src/en/fields.json');
+const pages = require('../translations/src/en/pages.json');
 
 const truncateConfigs = [
   {
     id: 'first-name-error',
+    prettyName: fields['first-name-error-checkbox'].label,
+    translations: pages['exit-truncated']['first-name'],
     max: 30
   },
   {
     id: 'last-name-error',
+    prettyName: fields['last-name-error-checkbox'].label,
+    translations: pages['exit-truncated']['last-name'],
     max: 30
   },
   {
     id: 'birth-place-error',
+    prettyName: fields['birth-place-error-checkbox'].label,
+    translations: pages['exit-truncated']['birth-place'],
     max: 16
   }
 ];
@@ -34,7 +42,7 @@ function getTruncatedItems(req) {
 
   truncateConfigs.forEach(config => {
     if (isTooLong.call(this, config.id, config.max, req)) {
-      items.unshift({id: config.id});
+      items.unshift({id: config.id, max: config.max, prettyName: config.prettyName, translations: config.translations});
     }
   });
   return items;
@@ -77,6 +85,15 @@ module.exports = superclass => class AboutError extends superclass {
 
     req.sessionModel.unset(diff);
 
+    // Regardless of whether we are truncating these fields
+    // We still need to store them against the appropriate "-truncated" property for our confirm page
+    truncateConfigs.forEach(config => {
+      req.sessionModel.set(
+        config.id + '-truncated',
+        req.form.values[config.id] ? req.form.values[config.id].slice(0, config.max) : ''
+      );
+    });
+
     super.saveValues(req, res, callback);
   }
 

apps/correct-mistakes/behaviours/truncated.js

@@ -10,6 +10,8 @@ function getTruncatedItems(req) {
 }
 
 function truncatedItem(req) {
+  // Gets the first truncated item that has not yet been shown to the user
+  // If the value is set, we have warned the user about the truncation
   const itemOne = getTruncatedItems(req).filter(item => {
     return item.value === undefined;
   })[0];
@@ -20,12 +22,16 @@ function truncatedItem(req) {
       pretty: prettyName(itemOne.id),
       value: req.form.values[itemOne.id],
       length: req.form.values[itemOne.id].length,
-      slice: req.form.values[itemOne.id].slice(0, 30)
+      slice: req.form.values[itemOne.id].slice(0, itemOne.max),
+      max: itemOne.max
     };
   }
 }
 
 function updateTruncatedItems(req) {
+  // Called once the user confirms if their BRP shows the correctly truncated value
+  // Will update our session to show that we have informed the user that it should be truncated
+  // This is so we don't show this truncated item warning again
   const values = req.form.values;
   let items = getTruncatedItems(req);
 
@@ -55,17 +61,40 @@ module.exports = superclass => class Truncated extends superclass {
   }
 
   saveValues(req, res, next) {
+    // We've shown the user a truncated item warning and they've confirmed how it appears on their BRP
     updateTruncatedItems(req);
 
+    // Have we warned the user about all truncated items?
     if (identity(req, true, 'yes') === true) {
+      // Yes, show the exit-truncation page
+      // Set our data for the template
+      const truncatedDetail = getTruncatedItems(req).map(item => {
+        return {
+          id: item.id,
+          prettyName: item.prettyName,
+          max: item.max,
+          translations: item.translations
+        };
+      });
+      req.sessionModel.set('truncatedDetail', truncatedDetail);
+
       req.form.options.next = '/exit-truncated';
+    } else {
+      // We need to store the truncated value in session so we can display the truncated value on the confirmation page
+      getTruncatedItems(req).forEach(item => {
+        req.sessionModel.set(item.id + '-truncated', req.form.historicalValues[item.id].slice(0, item.max));
+      });
     }
 
+    // Have we got any truncated items at all?
     if (identity(req, false, 'no') === true) {
+      // No we don't, so continue down the happy path
       req.form.options.next = '/uk-address';
     }
 
+    // Do we still have truncated items that we need to warn the user about?
     if (identity(req, false, undefined) === true) {
+      // Yes we do, loop back to the truncated page
       req.form.options.next = '/truncated';
     }
 

apps/correct-mistakes/translations/src/en/fields.json

@@ -63,20 +63,23 @@
   },
   "last-name-error": {
     "label": "What is your correct family name?",
-    "title": "This is the first line under 'name' on your BRP."
+    "title": "This is the first line under 'name' on your BRP.",
+    "hint": "Due to limitations, we can only print the first 30 characters of your Family Name on your BRP. This is not an error and you will be able to use your BRP."
   },
   "first-name-error-checkbox": {
     "label": "Given name(s)"
   },
   "first-name-error": {
     "label": "What are your correct given name(s)?",
-    "title": "This is the second line under 'name' on your BRP."
+    "title": "This is the second line under 'name' on your BRP.",
+    "hint": "Due to limitations, we can only print the first 30 characters of your Given Name(s) on your BRP. This is not an error and you will be able to use your BRP."
   },
   "birth-place-error-checkbox": {
     "label": "Place of birth"
   },
   "birth-place-error": {
-    "label": "What is your correct place of birth?"
+    "label": "What is your correct place of birth?",
+    "hint": "Due to limitations, we can only print the first 16 characters of your Place of Birth on your BRP. This is not an error and you will be able to use your BRP."
   },
   "date-of-birth-error-checkbox": {
     "label": "Date of birth"

apps/correct-mistakes/translations/src/en/pages.json

@@ -52,6 +52,7 @@
   "check-details-error": {
     "header": "Check the details you have provided",
     "subheader": "If any information is incorrect, you can change it here.",
+    "limitations-info": "Due to limitations, we can only print the first 16 characters of your Place of Birth and the first 30 characters of your Given Name(s) and Family Name on your BRP.",
     "corrected-details-table": {
       "title": "Corrected BRP details"
     },
@@ -97,7 +98,7 @@
     }
   },
   "truncated": {
-    "header": "Long names on BRPs",
+    "header": "Long names and places of birth on BRPs",
     "paras": {
       "one": {
         "parts": {
@@ -109,22 +110,43 @@
         "parts": {
           "one": "Your",
           "two": "has",
-          "three": "letters. Your BRP can only show a maximum of 30 letters, so it is shortened to this on your BRP:"
+          "three": "letters. Your BRP can only show a maximum of ",
+          "four": " letters, so it is shortened to this on your BRP:"
         }
       },
       "three": {
         "parts": {
-          "one": "Is this how it looks on your BRP?"
+          "one": "Is this how it looks on the BRP you've received?"
         }
       }
     },
     "reason-no": "Continue using this service. At the end you can check the spelling of your name, and we shall send you a replacement BRP"
   },
   "exit-truncated": {
-    "paras": {
-      "one": "Due to limitations, we can only print the first 30 characters of your name on your BRP.",
-      "two": "This is not an error and you will be able to use your BRP.",
-      "three": "You do not need to do anything else."
+    "title": "Please note the following information regarding the fields you have selected:",
+    "first-name": {
+      "paras": {
+        "one": "Due to limitations, we can only print the first ",
+        "two": " characters of your name on your BRP.",
+        "three": "This is not an error and you will be able to use your BRP.",
+        "four": "You do not need to do anything else."
+      }
+    },
+    "last-name": {
+      "paras": {
+        "one": "Due to limitations, we can only print the first ",
+        "two": " characters of your name on your BRP.",
+        "three": "This is not an error and you will be able to use your BRP.",
+        "four": "You do not need to do anything else."
+      }
+    },
+    "birth-place": {
+      "paras": {
+        "one": "Due to limitations, we can only print the first ",
+        "two": " characters of your birth place on your BRP.",
+        "three": "This is not an error and you will be able to use your BRP.",
+        "four": "You do not need to do anything else."
+      }
     }
   }
 }