hof 20.4.1 → 21.0.0-axios-beta.1

package/CHANGELOG.md

@@ -1,16 +1,3 @@
-## 2024-02-29, Version 20.4.0 (Stable), @sulthan-ahmed
-* Update version of govuk-frontend to 3.15
-- this adds the new crown for the King
-- this supports a lot of changes from the govuk design system
-* Adds support for Google tag manager
-* Fixes accessibility issues
-* Sandbox area for testing hof changes
-* Updates patch and minor versions including
-- libphonenumber to 1.9.44
-- nodemailer to 6.9.9
-- ip to 1.1.9
-- es5-ext to 0.10.63
-
 ## 2020-06-02, Version 16.0.0 (Stable), @andymoody
 * Update version of helmet to 3.22.0
 * Update version of i18n-future to 2.0.0

package/config/hof-defaults.js

@@ -22,14 +22,6 @@ const defaults = {
   env: process.env.NODE_ENV || 'development',
   gaTagId: process.env.GA_TAG || 'Test-GA-Tag',
   ga4TagId: process.env.GA_4_TAG,
-  // added to allow support for multiple HOF forms using GTM to customize how they track page views
-  gtm: {
-    tagId: process.env.GTM_TAG || false,
-    config: {},
-    composePageName: function (page, convertPage) {
-      return convertPage(page);
-    }
-  },
   gaCrossDomainTrackingTagId: process.env.GDS_CROSS_DOMAIN_GA_TAG,
   loglevel: process.env.LOG_LEVEL || 'info',
   ignoreMiddlewareLogs: ['/healthz'],

package/frontend/govuk-template/build/govuk_template.html

@@ -41,12 +41,13 @@
             <a href="{{{ homepageUrl }}}" title="{{ logoLinkTitle }}" id="logo" class="govuk-header__link govuk-header__link--homepage" target="_blank" data-module="track-click" data-track-category="homeLinkClicked" data-track-action="homeHeader">
 			<span class="govuk-header__logotype">
 				<!--[if gt IE 8]><!-->
-          <svg aria-hidden="true" focusable="false" class="govuk-header__logotype-crown" xmlns="http://www.w3.org/2000/svg\" viewBox="0 0 32 30" height="30" width="32">
-            <path fill="currentColor" fill-rule="evenodd"    d="M22.6 10.4c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4m-5.9 6.7c-.9.4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4m10.8-3.7c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s0 2-1 2.4m3.3 4.8c-1 .4-2-.1-2.4-1-.4-.9.1-2 1-2.4.9-.4 2 .1 2.4 1s-.1 2-1 2.4M17 4.7l2.3 1.2V2.5l-2.3.7-.2-.2.9-3h-3.4l.9 3-.2.2c-.1.1-2.3-.7-2.3-.7v3.4L15 4.7c.1.1.1.2.2.2l-1.3 4c-.1.2-.1.4-.1.6 0 1.1.8 2 1.9 2.2h.7c1-.2 1.9-1.1 1.9-2.1 0-.2 0-.4-.1-.6l-1.3-4c-.1-.2 0-.2.1-.3m-7.6 5.7c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s0 2 1 2.4m-5 3c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s.1 2 1 2.4m-3.2 4.8c.9.4 2-.1 2.4-1 .4-.9-.1-2-1-2.4-.9-.4-2 .1-2.4 1s0 2 1 2.4m14.8 11c4.4 0 8.6.3 12.3.8 1.1-4.5 2.4-7 3.7-8.8l-2.5-.9c.2 1.3.3 1.9 0 2.7-.4-.4-.8-1.1-1.1-2.3l-1.2 4c.7-.5 1.3-.8 2-.9-1.1 2.5-2.6 3.1-3.5 3-1.1-.2-1.7-1.2-1.5-2.1.3-1.2 1.5-1.5 2.1-.1 1.1-2.3-.8-3-2-2.3 1.9-1.9 2.1-3.5.6-5.6-2.1 1.6-2.1 3.2-1.2 5.5-1.2-1.4-3.2-.6-2.5 1.6.9-1.4 2.1-.5 1.9.8-.2 1.1-1.7 2.1-3.5 1.9-2.7-.2-2.9-2.1-2.9-3.6.7-.1 1.9.5 2.9 1.9l.4-4.3c-1.1 1.1-2.1 1.4-3.2 1.4.4-1.2 2.1-3 2.1-3h-5.4s1.7 1.9 2.1 3c-1.1 0-2.1-.2-3.2-1.4l.4 4.3c1-1.4 2.2-2 2.9-1.9-.1 1.5-.2 3.4-2.9 3.6-1.9.2-3.4-.8-3.5-1.9-.2-1.3 1-2.2 1.9-.8.7-2.3-1.2-3-2.5-1.6.9-2.2.9-3.9-1.2-5.5-1.5 2-1.3 3.7.6 5.6-1.2-.7-3.1 0-2 2.3.6-1.4 1.8-1.1 2.1.1.2.9-.3 1.9-1.5 2.1-.9.2-2.4-.5-3.5-3 .6 0 1.2.3 2 .9l-1.2-4c-.3 1.1-.7 1.9-1.1 2.3-.3-.8-.2-1.4 0-2.7l-2.9.9C1.3 23 2.6 25.5 3.7 30c3.7-.5 7.9-.8 12.3-.8\"></path>
+          <svg aria-hidden="true" focusable="false" class="govuk-header__logotype-crown" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 132 97" height="30" width="36">
+            <path fill="currentColor" fill-rule="evenodd" d="M25 30.2c3.5 1.5 7.7-.2 9.1-3.7 1.5-3.6-.2-7.8-3.9-9.2-3.6-1.4-7.6.3-9.1 3.9-1.4 3.5.3 7.5 3.9 9zM9 39.5c3.6 1.5 7.8-.2 9.2-3.7 1.5-3.6-.2-7.8-3.9-9.1-3.6-1.5-7.6.2-9.1 3.8-1.4 3.5.3 7.5 3.8 9zM4.4 57.2c3.5 1.5 7.7-.2 9.1-3.8 1.5-3.6-.2-7.7-3.9-9.1-3.5-1.5-7.6.3-9.1 3.8-1.4 3.5.3 7.6 3.9 9.1zm38.3-21.4c3.5 1.5 7.7-.2 9.1-3.8 1.5-3.6-.2-7.7-3.9-9.1-3.6-1.5-7.6.3-9.1 3.8-1.3 3.6.4 7.7 3.9 9.1zm64.4-5.6c-3.6 1.5-7.8-.2-9.1-3.7-1.5-3.6.2-7.8 3.8-9.2 3.6-1.4 7.7.3 9.2 3.9 1.3 3.5-.4 7.5-3.9 9zm15.9 9.3c-3.6 1.5-7.7-.2-9.1-3.7-1.5-3.6.2-7.8 3.7-9.1 3.6-1.5 7.7.2 9.2 3.8 1.5 3.5-.3 7.5-3.8 9zm4.7 17.7c-3.6 1.5-7.8-.2-9.2-3.8-1.5-3.6.2-7.7 3.9-9.1 3.6-1.5 7.7.3 9.2 3.8 1.3 3.5-.4 7.6-3.9 9.1zM89.3 35.8c-3.6 1.5-7.8-.2-9.2-3.8-1.4-3.6.2-7.7 3.9-9.1 3.6-1.5 7.7.3 9.2 3.8 1.4 3.6-.3 7.7-3.9 9.1zM69.7 17.7l8.9 4.7V9.3l-8.9 2.8c-.2-.3-.5-.6-.9-.9L72.4 0H59.6l3.5 11.2c-.3.3-.6.5-.9.9l-8.8-2.8v13.1l8.8-4.7c.3.3.6.7.9.9l-5 15.4v.1c-.2.8-.4 1.6-.4 2.4 0 4.1 3.1 7.5 7 8.1h.2c.3 0 .7.1 1 .1.4 0 .7 0 1-.1h.2c4-.6 7.1-4.1 7.1-8.1 0-.8-.1-1.7-.4-2.4V34l-5.1-15.4c.4-.2.7-.6 1-.9zM66 92.8c16.9 0 32.8 1.1 47.1 3.2 4-16.9 8.9-26.7 14-33.5l-9.6-3.4c1 4.9 1.1 7.2 0 10.2-1.5-1.4-3-4.3-4.2-8.7L108.6 76c2.8-2 5-3.2 7.5-3.3-4.4 9.4-10 11.9-13.6 11.2-4.3-.8-6.3-4.6-5.6-7.9 1-4.7 5.7-5.9 8-.5 4.3-8.7-3-11.4-7.6-8.8 7.1-7.2 7.9-13.5 2.1-21.1-8 6.1-8.1 12.3-4.5 20.8-4.7-5.4-12.1-2.5-9.5 6.2 3.4-5.2 7.9-2 7.2 3.1-.6 4.3-6.4 7.8-13.5 7.2-10.3-.9-10.9-8-11.2-13.8 2.5-.5 7.1 1.8 11 7.3L80.2 60c-4.1 4.4-8 5.3-12.3 5.4 1.4-4.4 8-11.6 8-11.6H55.5s6.4 7.2 7.9 11.6c-4.2-.1-8-1-12.3-5.4l1.4 16.4c3.9-5.5 8.5-7.7 10.9-7.3-.3 5.8-.9 12.8-11.1 13.8-7.2.6-12.9-2.9-13.5-7.2-.7-5 3.8-8.3 7.1-3.1 2.7-8.7-4.6-11.6-9.4-6.2 3.7-8.5 3.6-14.7-4.6-20.8-5.8 7.6-5 13.9 2.2 21.1-4.7-2.6-11.9.1-7.7 8.8 2.3-5.5 7.1-4.2 8.1.5.7 3.3-1.3 7.1-5.7 7.9-3.5.7-9-1.8-13.5-11.2 2.5.1 4.7 1.3 7.5 3.3l-4.7-15.4c-1.2 4.4-2.7 7.2-4.3 8.7-1.1-3-.9-5.3 0-10.2l-9.5 3.4c5 6.9 9.9 16.7 14 33.5 14.8-2.1 30.8-3.2 47.7-3.2z"></path>
           </svg>
           <!--<![endif]-->
+         <!--<![endif]-->
           <!--[if IE 8]>
-          <img src="{{ assetPath }}images/govuk-logotype-tudor-crown.png" class="govuk-header__logotype-crown-fallback-image" width="32" height="30" alt="">
+          <img src="{{ assetPath }}images/govuk-logotype-crown.png" class="govuk-header__logotype-crown-fallback-image" width="36" height="32">
           <![endif]-->
 			</span>
 				<span class="govuk-header__logotype-text">

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

@@ -1,13 +1,18 @@
 {{#gtmTagId}}
 {{#cookiesAccepted}}
-<!-- Google Tag Manager Data Layer  -->
+{{#isETA}}
+<!-- Google Tag Manager Data Layer for ETA -->
 <script {{#nonce}}nonce="{{nonce}}"{{/nonce}}>
   var dataLayer = window.dataLayer || [];
-  dataLayer.push(
-    {{{gtmConfig}}}
-  );
+  dataLayer.push({
+    'event': 'pageLoad',
+    'pageName': 'ETA | Customer Contact Webform | {{gtm-page}}',
+    'applicationType': 'ETA | Customer Contact',
+    'environmentType': '{{environmentType}}'
+  });
 </script>
-<!-- End Google Tag Manager Data Layer  -->
+<!-- End Google Tag Manager Data Layer for ETA -->
+{{/isETA}}
 
 <!-- Google Tag Manager -->
 <script {{#nonce}}nonce="{{nonce}}"{{/nonce}}>

package/lib/ga-tag.js

@@ -2,16 +2,6 @@
 
 const _ = require('lodash');
 
-const convertToGTMPage = text => {
-  // Remove leading and trailing slashes
-  let str = text.replace(/^\/|\/$/g, '');
-  // Replace hyphens with spaces and capitalize each word
-  str = str.replace(/-+/g, ' ').replace(/(^|\s)\S/g, function (match) {
-    return match.toUpperCase();
-  });
-  return str;
-};
-
 const pageView = (path, pageMap) => pageMap.get(path) || path;
 
 const createUris = routes => {
@@ -52,35 +42,19 @@ const setupPageMap = routes => {
 module.exports = (app, config) => {
   const gaTagId = config.gaTagId;
   const ga4TagId = config.ga4TagId;
-  const gtm = config.gtm;
   const gaCrossDomainTrackingTagId = config.gaCrossDomainTrackingTagId;
   const routes = config.routes;
 
-  if (gaTagId || ga4TagId || gtm.tagId) {
+  if (gaTagId || ga4TagId) {
     const pageMap = setupPageMap(routes);
 
     app.use((req, res, next) => {
-      const page = pageView(req.path, pageMap);
-
-      // Preparing common res.locals properties
-      const properties = {
-        gaAllowDebug: config.env === 'development',
-        gaTagId: gaTagId,
-        ga4TagId: ga4TagId,
-        gaCrossDomainTrackingTagId: gaCrossDomainTrackingTagId,
-        'ga-id': gaTagId,
-        'ga-page': page
-      };
-
-      // Adding extra properties if a GTM TAG is available
-      if (gtm.tagId) {
-        gtm.config.pageName = gtm.composePageName(page, convertToGTMPage);
-        Object.assign(properties, {
-          gtmConfig: JSON.stringify(gtm.config),
-          gtmTagId: gtm.tagId
-        });
-      }
-      res.locals = Object.assign(res.locals, properties);
+      res.locals.gaAllowDebug = config.env === 'development';
+      res.locals.gaTagId = gaTagId;
+      res.locals.ga4TagId = ga4TagId;
+      res.locals.gaCrossDomainTrackingTagId = gaCrossDomainTrackingTagId;
+      res.locals['ga-id'] = gaTagId;
+      res.locals['ga-page'] = pageView(req.path, pageMap);
       next();
     });
   }

package/middleware/cookies.js

@@ -22,8 +22,6 @@ module.exports = options => {
     const reqIsCookieCheckRedirect = req.query[paramName] !== undefined;
 
     if (reqIncludesCookies || isHealthcheckUrl(req.path, healthcheckUrls)) {
-      const prefs = 'cookie_preferences' in req.cookies ? JSON.parse(req.cookies.cookie_preferences) : {};
-      res.locals.cookiesAccepted = Boolean(prefs.usage);
       next();
     } else if (req.cookies === undefined || (!Object.keys(req.cookies).length && reqIsCookieCheckRedirect)) {
       const err = new Error('Cookies required');

package/model/apis/axios-settings.js

@@ -0,0 +1,9 @@
+'use strict';
+const url = require('url');
+
+module.exports = (settings, body)=>{
+    return Object.assign({}, settings, {    
+    'url' : settings.uri || settings.url || url.format(settings),
+    'data': settings.body || body || settings.data,
+  });
+}

package/model/apis/html-to-pdf-converter.js

@@ -17,17 +17,18 @@ module.exports = class PDFModel extends Model {
   }
 
   handleResponse(response, callback) {
-    if (isPdf(Buffer.from(response.body))) {
-      return this.parseResponse(response.statusCode, response.body, callback);
+    if (isPdf(Buffer.from(response.data))) {
+      return this.parseResponse(response.status, response.data, callback);
     }
     const err = new Error();
-    if (parseInt(response.statusCode, 10) === 400) {
-      err.title = response.body.code;
-      err.message = response.body.message;
+
+    if (parseInt(response.status, 10) === 400) {
+      err.title = response.status;
+      err.message = response.statusText;
     } else {
-      err.body = response.body;
+      err.body = response.data;
     }
-    err.status = response.statusCode;
-    return callback(err, null, response.statusCode);
+    err.status = response.status;
+    return callback(err, null, response.status);
   }
 };

package/model/index.js

@@ -2,10 +2,12 @@
 'use strict';
 
 const _ = require('lodash');
-const request = require('request');
+const axios = require('axios').default;
 const url = require('url');
 const EventEmitter = require('events').EventEmitter;
 
+const axiosSetting = require('./apis/axios-settings');
+
 const REFERENCE = /^\$ref:/;
 
 function timeDiff(from, to, d) {
@@ -27,7 +29,7 @@ module.exports = class Model extends EventEmitter {
     this.set(attributes, {
       silent: true
     });
-    this._request = request;
+    this._request = axios;
   }
 
   save(options, callback) {
@@ -47,7 +49,6 @@ module.exports = class Model extends EventEmitter {
         'Content-Type': 'application/json',
         'Content-Length': Buffer.byteLength(data)
       }, reqConf.headers || {});
-
       return this.request(reqConf, data, callback);
     });
   }
@@ -94,22 +95,23 @@ module.exports = class Model extends EventEmitter {
 
     let settings = Object.assign({}, originalSettings);
     settings.timeout = settings.timeout || this.options.timeout;
-    settings.uri = settings.uri || settings.url || url.format(settings);
-    settings.body = settings.body || body || settings.data;
-
-    settings = _.omit(settings, urlKeys, 'data', 'url');
+    settings = axiosSetting(settings, body)
+    settings = _.omit(settings, urlKeys);
     this.emit('sync', originalSettings);
 
     const promise = Promise.resolve().then(() => this.auth()).then(authData => {
-      settings.auth = authData;
-      if (typeof settings.auth === 'string') {
-        const auth = settings.auth.split(':');
-        settings.auth = {
+      let authVal = authData;
+      if (typeof authVal === 'string') {
+        const auth = authVal.split(':');
+        authVal = {
           user: auth.shift(),
           pass: auth.join(':'),
           sendImmediately: true
         };
       }
+      if(authVal) {
+        settings.headers = Object.assign({}, settings.headers, {Authorization: `Bearer ${authVal.bearer}`});
+      }
     })
       .then(() => {
         const startTime = process.hrtime();
@@ -124,7 +126,6 @@ module.exports = class Model extends EventEmitter {
 
             const endTime = process.hrtime();
             const responseTime = timeDiff(startTime, endTime);
-
             if (err) {
               this.emit('fail', err, data, originalSettings, statusCode, responseTime);
             } else {
@@ -136,23 +137,23 @@ module.exports = class Model extends EventEmitter {
               resolve(data);
             }
           };
-
-          this._request(settings, (err, response) => {
-            if (err) {
+          
+          this._request(settings)
+            .then(response => {
+              return this.handleResponse(response, (error, data, status) => {
+                if (error) {
+                  error.headers = response.headers;
+                }
+                _callback(error, data, status);
+              });
+            }).catch(err => {
               if (err.code === 'ETIMEDOUT' || err.code === 'ESOCKETTIMEDOUT') {
                 err.message = 'Connection timed out';
                 err.status = 504;
               }
-              err.status = err.status || (response && response.statusCode) || 503;
+              err.status = err.status || 503;
               return _callback(err, null, err.status);
-            }
-            return this.handleResponse(response, (error, data, status) => {
-              if (error) {
-                error.headers = response.headers;
-              }
-              _callback(error, data, status);
             });
-          });
         });
       });
 
@@ -165,13 +166,13 @@ module.exports = class Model extends EventEmitter {
   handleResponse(response, callback) {
     let data = {};
     try {
-      data = JSON.parse(response.body || '{}');
+      data = typeof response.data === 'object' ? response.data : JSON.parse(response.data || '{}');
     } catch (err) {
-      err.status = response.statusCode;
-      err.body = response.body;
-      return callback(err, null, response.statusCode);
+      err.status = response.status;
+      err.body = response.data;
+      return callback(err, null, response.status);
     }
-    return this.parseResponse(response.statusCode, data, callback);
+    return this.parseResponse(response.status, data, callback);
   }
 
   parseResponse(statusCode, data, callback) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hof",
   "description": "A bootstrap for HOF projects",
-  "version": "20.4.1",
+  "version": "21.0.0-axios-beta.1",
   "license": "MIT",
   "main": "index.js",
   "author": "HomeOffice",
@@ -32,10 +32,12 @@
     "test:acceptance_browser": "ACCEPTANCE_WITH_BROWSER=true TAGS=\"${TAGS:=@feature}\" yarn run test:cucumber",
     "test:cucumber": "cucumber-js -f @cucumber/pretty-formatter \"sandbox/test/_features/**/*.feature\" --require sandbox/test/_features/test.setup.js --require \"sandbox/test/_features/step_definitions/**/*.js\" --tags $TAGS",
     "ci": "travis-conditions",
-    "postversion": "git push && git push --tags"
+    "postversion": "git push && git push --tags",
+    "test-single": "mocha"
   },
   "dependencies": {
     "aliasify": "^2.1.0",
+    "axios": "^1.5.1",
     "bluebird": "^3.7.2",
     "body-parser": "^1.15.1",
     "browserify": "^17.0.0",
@@ -57,7 +59,7 @@
     "findup": "^0.1.5",
     "glob": "^7.2.0",
     "govuk-elements-sass": "^3.1.3",
-    "govuk-frontend": "3.15",
+    "govuk-frontend": "3.14",
     "govuk_template_mustache": "^0.26.0",
     "helmet": "^3.22.0",
     "hogan-express-strict": "^0.5.4",
@@ -66,7 +68,7 @@
     "i18n-future": "^2.0.0",
     "i18n-lookup": "^0.1.0",
     "is-pdf": "^1.0.0",
-    "libphonenumber-js": "^1.9.44",
+    "libphonenumber-js": "^1.9.37",
     "lodash": "^4.17.21",
     "markdown-it": "^12.3.2",
     "minimatch": "^3.0.7",
@@ -80,9 +82,9 @@
     "nodemailer-smtp-transport": "^2.7.4",
     "nodemailer-stub-transport": "^1.1.0",
     "notifications-node-client": "^6.0.0",
+    "object-mapper": "^6.2.0",
     "redis": "^3.1.2",
     "reqres": "^3.0.1",
-    "request": "^2.79.0",
     "rimraf": "^3.0.2",
     "sass": "^1.56.2",
     "serve-static": "^1.14.1",
@@ -96,7 +98,6 @@
     "@cucumber/cucumber": "^7.3.0",
     "@cucumber/pretty-formatter": "^1.0.0-alpha.1",
     "@types/jest": "^26.0.14",
-    "@xmldom/xmldom": "~0.8.4",
     "chai": "^3.5.0",
     "chai-as-promised": "^7.1.1",
     "chai-subset": "^1.6.0",
@@ -123,13 +124,14 @@
     "playwright": "^1.16.3",
     "postcode": "0.2.2",
     "proxyquire": "^1.7.11",
-    "release-it": "^16.2.1",
+    "release-it": "^14.10.0",
     "sinon": "^11.1.1",
     "sinon-chai": "^3.7.0",
     "supertest": "^3.0.0",
     "travis-conditions": "0.0.0",
     "watchify": "^4.0.0",
-    "webdriverio": "^4.14.4"
+    "webdriverio": "^4.14.4",
+    "xmldom": "^0.6.0"
   },
   "mocha": {
     "reporter": "spec",