hof 21.0.0-instrumentation-beta.0 → 21.0.0

package/frontend/themes/gov-uk/client-js/cookieSettings.js

@@ -35,7 +35,7 @@ function showCookieBannerSubmitted() {
   document.getElementById('cookie-banner-info').style.display = 'none';
   document.getElementById('cookie-banner-actions').style.display = 'none';
   var cookieBannerSubmitted = document.getElementById('cookie-banner-submitted');
-  cookieBannerSubmitted.style.display = 'flex';
+  cookieBannerSubmitted.style.display = 'block';
   cookieBannerSubmitted.focus();
 }
 

package/frontend/themes/gov-uk/client-js/govuk-cookies.js

@@ -0,0 +1,121 @@
+/* eslint-disable no-undef, no-param-reassign, no-unused-vars */
+(function () {
+  'use strict';
+  const root = this;
+  if(typeof root.GOVUK === 'undefined') { root.GOVUK = {}; }
+
+  /*
+    Cookie methods
+    ==============
+
+    Usage:
+
+      Setting a cookie:
+      GOVUK.cookie('hobnob', 'tasty', { days: 30 });
+
+      Reading a cookie:
+      GOVUK.cookie('hobnob');
+
+      Deleting a cookie:
+      GOVUK.cookie('hobnob', null);
+  */
+  GOVUK.cookie = function (name, value, options) {
+    if(typeof value !== 'undefined') {
+      if(value === false || value === null) {
+        return GOVUK.setCookie(name, '', { days: -1 });
+      }
+      return GOVUK.setCookie(name, value, options);
+    }
+    return GOVUK.getCookie(name);
+  };
+  GOVUK.setCookie = function (name, value, options) {
+    if(typeof options === 'undefined') {
+      options = {};
+    }
+    let cookieString = name + '=' + value + '; path=/';
+    if (options.days) {
+      const date = new Date();
+      date.setTime(date.getTime() + (options.days * 24 * 60 * 60 * 1000));
+      cookieString = cookieString + '; expires=' + date.toGMTString();
+    }
+    if (document.location.protocol === 'https:') {
+      cookieString = cookieString + '; Secure';
+    }
+    document.cookie = cookieString;
+  };
+  GOVUK.getCookie = function (name) {
+    const nameEQ = name + '=';
+    const cookies = document.cookie.split(';');
+    for(let i = 0, len = cookies.length; i < len; i++) {
+      let cookie = cookies[i];
+      while (cookie.charAt(0) === ' ') {
+        cookie = cookie.substring(1, cookie.length);
+      }
+      if (cookie.indexOf(nameEQ) === 0) {
+        return decodeURIComponent(cookie.substring(nameEQ.length));
+      }
+    }
+    return null;
+  };
+}).call(this);
+(function () {
+  'use strict';
+  const root = this;
+  if (typeof root.GOVUK === 'undefined') { root.GOVUK = {}; }
+
+  GOVUK.addCookieMessage = function () {
+    const message = document.getElementById('global-cookie-message');
+
+    const hasCookieMessage = (message && GOVUK.cookie('seen_cookie_message') === null);
+
+    if (hasCookieMessage) {
+      message.style.display = 'block';
+      GOVUK.cookie('seen_cookie_message', 'yes', { days: 28 });
+
+      document.addEventListener('DOMContentLoaded', function (event) {
+        if (GOVUK.analytics && typeof GOVUK.analytics.trackEvent === 'function') {
+          GOVUK.analytics.trackEvent('cookieBanner', 'Cookie banner shown', {
+            value: 1,
+            nonInteraction: true
+          });
+        }
+      });
+    }
+  };
+}).call(this)
+;
+(function () {
+  'use strict';
+
+  // add cookie message
+  if (window.GOVUK && GOVUK.addCookieMessage) {
+    GOVUK.addCookieMessage();
+  }
+
+  // header navigation toggle
+  if (document.querySelectorAll && document.addEventListener) {
+    const els = document.querySelectorAll('.js-header-toggle');
+    let i; let _i;
+    for(i = 0, _i = els.length; i < _i; i++) {
+      els[i].addEventListener('click', function (e) {
+        e.preventDefault();
+        const target = document.getElementById(this.getAttribute('href').substr(1));
+        const targetClass = target.getAttribute('class') || '';
+        const sourceClass = this.getAttribute('class') || '';
+
+        if(targetClass.indexOf('js-visible') !== -1) {
+          target.setAttribute('class', targetClass.replace(/(^|\s)js-visible(\s|$)/, ''));
+        } else {
+          target.setAttribute('class', targetClass + ' js-visible');
+        }
+        if(sourceClass.indexOf('js-visible') !== -1) {
+          this.setAttribute('class', sourceClass.replace(/(^|\s)js-visible(\s|$)/, ''));
+        } else {
+          this.setAttribute('class', sourceClass + ' js-visible');
+        }
+        this.setAttribute('aria-expanded', this.getAttribute('aria-expanded') !== 'true');
+        target.setAttribute('aria-hidden', target.getAttribute('aria-hidden') === 'false');
+      });
+    }
+  }
+}).call(this);

package/frontend/themes/gov-uk/client-js/index.js

@@ -1,4 +1,4 @@
-/* eslint-disable no-var */
+/* eslint-disable no-var, vars-on-top, no-unused-vars */
 'use strict';
 
 var toolkit = require('../../../toolkit');
@@ -8,6 +8,11 @@ var formFocus = toolkit.formFocus;
 var characterCount = toolkit.characterCount;
 var validation = toolkit.validation;
 
+var GOVUK = require('govuk-frontend');
+GOVUK.initAll();
+window.GOVUK = GOVUK;
+var skipToMain = require('./skip-to-main');
+var cookie = require('./govuk-cookies');
 var cookieSettings = require('./cookieSettings');
 
 toolkit.detailsSummary();

package/frontend/themes/gov-uk/client-js/skip-to-main.js

@@ -0,0 +1,19 @@
+const skipToMain = function () {
+  const skipToMainLink = document.getElementById('skip-to-main');
+  const firstControlId = skipToMainLink.hash.split('#')[1] ? skipToMainLink.hash.split('#')[1] : 'main-content';
+  if(firstControlId === 'main-content') {
+    skipToMainLink.setAttribute('href', '#main-content');
+  }
+  if(firstControlId) {
+    // eslint-disable-next-line no-unused-vars
+    skipToMainLink.onclick = function (e) {
+      // here timeout added just to make this functionality asynchronous
+      // to focus on form as well as non form contents
+      setTimeout(() => {
+        const firstControl = document.getElementById(firstControlId);
+        firstControl.focus();
+      }, 10);
+    };
+  }
+};
+skipToMain();

package/frontend/themes/gov-uk/styles/_cookie-banner.scss

@@ -10,7 +10,6 @@
 }
 
 #cookie-banner {
-  max-width: 960px;
   margin: 0 15px;
   p {
     margin: 0;
@@ -62,3 +61,54 @@
     height: fit-content;
   }
 }
+
+// the following are additional hof specific govuk cookie banner styling
+.govuk-banner--success {
+  border-color: #00703c;
+  color: #00703c;
+}
+
+.govuk-banner {
+  border: 5px solid #1d70b8;
+  font-size: 0;
+  margin-bottom: 30px;
+  padding: 10px;
+}
+
+.govuk-banner__icon{
+  display: inline-block;
+}
+
+.govuk-banner__message {
+  font-family: "GDS Transport", Arial, sans-serif;
+  -webkit-font-smoothing: antialiased;
+  font-weight: 400;
+  font-size: 1rem;
+  line-height: 1.25;
+  color: #0b0c0c;
+  display: block;
+  overflow: hidden;
+  display: inline-block;
+  margin-left: 10px;
+}
+
+.govuk-banner__assistive {
+  position: absolute !important;
+  width: 1px !important;
+  height: 1px !important;
+  margin: 0 !important;
+  padding: 0 !important;
+  overflow: hidden !important;
+  clip: rect(0 0 0 0) !important;
+  clip-path: inset(50%) !important;
+  border: 0 !important;
+  white-space: nowrap !important;
+  }
+
+.cookie-table-holder > table > tbody > tr > td:first-child{
+  font-weight:bold;
+}
+
+.js-enabled #global-cookie-message {
+  display: none;
+}

package/frontend/themes/gov-uk/styles/govuk.scss

@@ -12,6 +12,10 @@ $path: "/public/images/" !default;
 // https://github.com/alphagov/govuk_elements/blob/master/packages/govuk-elements-sass/public/sass/_elements.scss
 @import "govuk-elements-sass/public/sass/elements";
 
+// Govuk frontend
+// https://github.com/alphagov/govuk-frontend-docs
+@import "govuk-frontend";
+
 // Custom
 @import "base";
 @import "layout";

package/frontend/themes/gov-uk/styles/modules/_validation.scss

@@ -22,10 +22,10 @@
     }
 }
 
-.validation-error {
+.govuk-form-group--error {
     box-sizing: border-box;
     padding-left: $gutter-half - $validation-bdr-size;
-    border-left: $validation-bdr-size-lg solid $error-colour;
+    //border-left: $validation-bdr-size-lg solid $error-colour;
 
     &:focus {
         outline: $focus-outline;
@@ -36,16 +36,16 @@
     }
 }
 
-.error-message {
+.govuk-error-message {
     display: block;
     @include media(tablet) {
         margin-bottom: 0.5em;
     }
     @include bold-19;
-    color: $error-colour;
+    //color: $error-colour;
 }
 
 .invalid-input,
-.validation-error .date-input {
+.govuk-form-group--error .date-input {
     border: $validation-bdr-size solid $error-colour;
 }

package/frontend/toolkit/assets/javascript/character-count.js

@@ -30,12 +30,12 @@ CharacterCount.prototype.updateCount = function () {
   this.$maxlengthHint.innerHTML = 'You have ' + number + characterNoun + remainderSuffix;
 
   if (currentLength >= this.maxLength + 1) {
-    helpers.removeClass(this.$maxlengthHint, 'form-hint');
-    helpers.addClass(this.$maxlengthHint, 'error-message');
+    helpers.removeClass(this.$maxlengthHint, 'govuk-hint');
+    helpers.addClass(this.$maxlengthHint, 'govuk-error-message');
     helpers.addClass(this.$textarea, 'textarea-error');
   } else {
-    helpers.addClass(this.$maxlengthHint, 'form-hint');
-    helpers.removeClass(this.$maxlengthHint, 'error-message');
+    helpers.addClass(this.$maxlengthHint, 'govuk-hint');
+    helpers.removeClass(this.$maxlengthHint, 'govuk-error-message');
     helpers.removeClass(this.$textarea, 'textarea-error');
   }
 };

package/frontend/toolkit/assets/javascript/progressive-reveal.js

@@ -7,12 +7,14 @@ var groupBy = require('lodash').groupBy;
 var helpers = require('./helpers');
 var inputs; var groups;
 var toggleAttr = 'data-toggle';
-var hiddenClass = 'js-hidden';
+var checkboxHiddenClass = 'govuk-checkboxes__conditional--hidden';
+var radioHiddenClass = 'govuk-radios__conditional--hidden';
 
 function inputClicked(e, target) {
   target = target || helpers.target(e);
   var shown;
   each(groups[target.name], function (input) {
+    var hiddenClass = (input.type.match(/checkbox/)) ? checkboxHiddenClass : radioHiddenClass;
     var id = input.getAttribute('aria-controls');
     var toggle = document.getElementById(id);
     if (toggle) {

package/frontend/toolkit/assets/javascript/validation.js

@@ -53,7 +53,11 @@ function setup(summary) {
 }
 
 function validation() {
-  var summaries = helpers.getElementsByClass(document.getElementById('content'), 'div', 'validation-summary');
+  var summaries = [];
+
+  if (document.getElementById('content')) {
+    summaries = helpers.getElementsByClass(document.getElementById('content'), 'div', 'validation-summary');
+  }
 
   if (summaries.length) {
     summary = summaries[0];

package/frontend/toolkit/assets/stylesheets/modules/_validation.scss

@@ -22,7 +22,7 @@
     }
 }
 
-.validation-error {
+.govuk-form-group--error {
     box-sizing: border-box;
     padding-left: $gutter-half - $validation-bdr-size;
     border-left: $validation-bdr-size-lg solid $error-colour;
@@ -36,7 +36,7 @@
     }
 }
 
-.error-message {
+.govuk-error-message {
     display: block;
     @include media(tablet) {
         margin-bottom: 0.5em;
@@ -46,6 +46,6 @@
 }
 
 .invalid-input,
-.validation-error .date-input {
+.govuk-form-group--error .date-input {
     border: $validation-bdr-size solid $error-colour;
 }

package/index.js

@@ -78,8 +78,16 @@ const getContentSecurityPolicy = (config, res) => {
     styleSrc: ['www.googletagmanager.com', 'fonts.googleapis.com', 'tagmanager.google.com'],
     fontSrc: ['fonts.gstatic.com '],
     scriptSrc: ['www.google-analytics.com', 'ssl.google-analytics.com'],
-    imgSrc: ['www.google-analytics.com', 'ssl.gstatic.com'],
-    connectSrc: ['https://www.google-analytics.com', 'https://region1.google-analytics.com']
+    imgSrc: [
+      'www.google-analytics.com',
+      'ssl.gstatic.com',
+      'www.google.co.uk/ads/ga-audiences'
+    ],
+    connectSrc: [
+      'https://www.google-analytics.com',
+      'https://region1.google-analytics.com',
+      'https://region1.analytics.google.com'
+    ]
   };
 
   if (config.gaTagId) {
@@ -120,6 +128,8 @@ const getContentSecurityPolicy = (config, res) => {
  * @param options.getTerms {boolean} Optional boolean - whether to mount the /terms endpoint
  * @param options.getCookies {boolean} Optional boolean - whether to mount the /cookies endpoint
  * @param options.noCache {boolean} Optional boolean - whether to disable caching
+ * @param options.getAccessibilityStatement {boolean} Optional boolean - whether to mount the
+ * /accessibility-statement endpoint
  *
  * @returns {object} A new HOF application using the configuration supplied in options
  */
@@ -209,6 +219,9 @@ function bootstrap(options) {
     app.use(hofMiddleware.rateLimiter(config, 'requests'));
   }
 
+  // Set up routing so <YOUR-SITE-URL>/assets are served from /node_modules/govuk-frontend/govuk/assets
+  app.use('/assets', express.static(path.join(__dirname, '/node_modules/govuk-frontend/govuk/assets')));
+
   if (config.getAccessibility === true) {
     deprecate(
       '`getAccessibility` option is deprecated and may be removed in future versions.',

package/lib/ga-tag.js

@@ -2,6 +2,16 @@
 
 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 => {
@@ -42,19 +52,35 @@ 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) {
+  if (gaTagId || ga4TagId || gtm.tagId) {
     const pageMap = setupPageMap(routes);
 
     app.use((req, res, next) => {
-      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);
+      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);
       next();
     });
   }

package/lib/settings.js

@@ -7,7 +7,22 @@ const hoganExpressStrict = require('hogan-express-strict');
 const expressPartialTemplates = require('express-partial-templates');
 const bodyParser = require('body-parser');
 
-module.exports = (app, config) => {
+const dirExists = dir => {
+  try {
+    if (fs.existsSync(dir)) {
+      return true;
+    }
+    return false;
+  } catch(err) {
+    throw new Error(`${err}: Cannot check if the directory path exists`);
+  }
+};
+
+const filterEmptyViews = views => {
+  return views.filter(view => dirExists(view));
+};
+
+module.exports = async (app, config) => {
   const viewEngine = config.viewEngine || 'html';
 
   app.use((req, res, next) => {
@@ -17,7 +32,8 @@ module.exports = (app, config) => {
 
   app.use(config.theme());
 
-  const viewPaths = [].concat(config.theme.views);
+  const filteredViews = filterEmptyViews(config.theme.views);
+  const viewPaths = [].concat(filteredViews);
   app.set('view engine', viewEngine);
   app.enable('view cache');
 

package/middleware/cookies.js

@@ -22,6 +22,8 @@ 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/middleware/errors.js

@@ -2,7 +2,6 @@
 'use strict';
 
 const rateLimitsConfig = require('../config/rate-limits');
-const monitor = require('./monitor');
 
 const errorTitle = code => `${code}_ERROR`;
 const errorMsg = code => `There is a ${code}_ERROR`;
@@ -13,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'));
   }
@@ -90,8 +91,6 @@ module.exports = options => {
       baseUrl: returnBaseUrl(req.path)
     };
 
-    monitor(req, res, err.status);
-
     if (logger && logger.error) {
       logger.error(err.message || err.error, err);
     }

package/middleware/not-found.js

@@ -1,5 +1,4 @@
 'use strict';
-const monitor = require('./monitor');
 
 const getTranslations = translate => {
   const translations = {
@@ -27,8 +26,6 @@ module.exports = options => {
       logger.warn(`Cannot find: ${req.url}`);
     }
 
-    monitor(req, res, '404');
-
     res.status(404).render('404', {
       title: translations.title,
       description: translations.description,

package/middleware/rate-limiter.js

@@ -4,6 +4,7 @@ const redis = require('redis');
 const config = require('./../config/hof-defaults');
 
 module.exports = (options, rateLimitType) => {
+  // eslint-disable-next-line no-console
   const logger = options.logger || { log: (func, msg) => console[func](msg) };
   const rateLimits = options.rateLimits[rateLimitType];
   const timestampName = `${rateLimitType}TimeStamp`;

package/model/apis/axios-settings.js

@@ -0,0 +1,21 @@
+'use strict';
+const { format } = require('url'); // Destructure 'format' from 'url' module
+
+module.exports = (settings = {}, body = null) => {
+  if (typeof settings !== 'object' || settings === null) {
+    throw new TypeError('settings must be a non-null object');
+  }
+
+  const {
+    uri,
+    url,
+    body: settingsBody,
+    data: settingsData,
+    ...restSettings
+  } = settings;
+
+  return Object.assign({}, restSettings, {
+    url: uri || url || format(settings),
+    data: settingsBody || body || settingsData
+  });
+};

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

@@ -9,6 +9,7 @@ module.exports = class PDFModel extends Model {
     const settings = super.requestConfig(options);
     settings.encoding = null;
     settings.rejectUnauthorized = false;
+    settings.responseType = 'arraybuffer';
     return settings;
   }
 
@@ -17,17 +18,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);
   }
 };