hof 21.0.0-instrumentation-beta.0 → 21.0.0

package/model/index.js

@@ -2,10 +2,10 @@
 '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,10 +27,10 @@ module.exports = class Model extends EventEmitter {
     this.set(attributes, {
       silent: true
     });
-    this._request = request;
+    this._request = axios;
   }
 
-  save(options, callback) {
+  async save(options, callback) {
     if (typeof options === 'function' && arguments.length === 1) {
       callback = options;
       options = {};
@@ -38,21 +38,18 @@ module.exports = class Model extends EventEmitter {
       options = {};
     }
 
-    return this.prepare().then(data => {
-      data = JSON.stringify(data);
-      const reqConf = this.requestConfig(options);
-      reqConf.method = options.method || 'POST';
-
-      reqConf.headers = Object.assign({
-        'Content-Type': 'application/json',
-        'Content-Length': Buffer.byteLength(data)
-      }, reqConf.headers || {});
-
-      return this.request(reqConf, data, callback);
-    });
+    let data = await this.prepare();
+    data = JSON.stringify(data);
+    const reqConf = this.requestConfig(options);
+    reqConf.method = options.method || 'POST';
+    reqConf.headers = Object.assign({
+      'Content-Type': 'application/json',
+      'Content-Length': Buffer.byteLength(data)
+    }, reqConf.headers || {});
+    return await this.request(reqConf, data, callback);
   }
 
-  fetch(options, callback) {
+  async fetch(options, callback) {
     if (typeof options === 'function' && arguments.length === 1) {
       callback = options;
       options = {};
@@ -61,10 +58,10 @@ module.exports = class Model extends EventEmitter {
     }
     const reqConf = this.requestConfig(options);
     reqConf.method = options.method || 'GET';
-    return this.request(reqConf, callback);
+    return await this.request(reqConf, callback);
   }
 
-  delete(options, callback) {
+  async delete(options, callback) {
     if (typeof options === 'function' && arguments.length === 1) {
       callback = options;
       options = {};
@@ -73,7 +70,7 @@ module.exports = class Model extends EventEmitter {
     }
     const reqConf = this.requestConfig(options);
     reqConf.method = options.method || 'DELETE';
-    return this.request(reqConf, callback);
+    return await this.request(reqConf, callback);
   }
 
   requestConfig(options) {
@@ -86,7 +83,7 @@ module.exports = class Model extends EventEmitter {
     });
   }
 
-  request(originalSettings, body, callback) {
+  async request(originalSettings, body, callback) {
     if (typeof body === 'function' && arguments.length === 2) {
       callback = body;
       body = undefined;
@@ -94,96 +91,114 @@ 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 = {
-          user: auth.shift(),
-          pass: auth.join(':'),
+    try {
+      const authData = await this.auth();
+      let authVal = authData;
+      if (typeof authVal === 'string') {
+        const [user, ...rest] = authVal.split(':');
+        authVal = {
+          user,
+          pass: rest.join(':'),
           sendImmediately: true
         };
       }
-    })
-      .then(() => {
-        const startTime = process.hrtime();
-        let timeoutTimer;
-
-        return new Promise((resolve, reject) => {
-          const _callback = (err, data, statusCode) => {
-            if (timeoutTimer) {
-              clearTimeout(timeoutTimer);
-              timeoutTimer = null;
-            }
+      if (authVal) {
+        settings.headers = {
+          ...settings.headers,
+          Authorization: `Bearer ${authVal.bearer}`
+        };
+      }
 
-            const endTime = process.hrtime();
-            const responseTime = timeDiff(startTime, endTime);
+      const startTime = process.hrtime();
+      let timeoutTimer;
 
-            if (err) {
-              this.emit('fail', err, data, originalSettings, statusCode, responseTime);
-            } else {
-              this.emit('success', data, originalSettings, statusCode, responseTime);
-            }
-            if (err) {
-              reject(err);
-            } else {
-              resolve(data);
-            }
-          };
-
-          this._request(settings, (err, response) => {
-            if (err) {
-              if (err.code === 'ETIMEDOUT' || err.code === 'ESOCKETTIMEDOUT') {
-                err.message = 'Connection timed out';
-                err.status = 504;
-              }
-              err.status = err.status || (response && response.statusCode) || 503;
-              return _callback(err, null, err.status);
-            }
-            return this.handleResponse(response, (error, data, status) => {
-              if (error) {
+      if (timeoutTimer) {
+        clearTimeout(timeoutTimer);
+        timeoutTimer = null;
+      }
+
+      const data = await new Promise((resolve, reject) => {
+        const _callback = (err, responseData, statusCode) => {
+          if (timeoutTimer) {
+            clearTimeout(timeoutTimer);
+            timeoutTimer = null;
+          }
+
+          const endTime = process.hrtime();
+          const responseTime = timeDiff(startTime, endTime);
+          if (err) {
+            this.emit('fail', err, responseData, originalSettings, statusCode, responseTime);
+            reject(err);
+          } else {
+            this.emit('success', responseData, originalSettings, statusCode, responseTime);
+            resolve(responseData);
+          }
+        };
+
+        this._request(settings)
+          .then(response => {
+            return this.handleResponse(response)
+              .then(responseData => _callback(null, responseData, response.status))
+              .catch(error => {
                 error.headers = response.headers;
-              }
-              _callback(error, data, status);
-            });
+                _callback(error, null, response.status);
+              });
+          })
+          .catch(err => {
+            if (err.code === 'ETIMEDOUT' || err.code === 'ESOCKETTIMEDOUT') {
+              err.message = 'Connection timed out';
+              err.status = 504;
+            }
+            err.status = err.status || 503;
+            return _callback(err, null, err.status);
           });
-        });
       });
 
-    if (typeof callback === 'function') {
-      return promise.then(data => callback(null, data), callback);
+      if (typeof callback === 'function') {
+        callback(null, data);
+      }
+      return data;
+    } catch (error) {
+      if (typeof callback === 'function') {
+        callback(error);
+      }
+      return error;
     }
-    return promise;
   }
 
-  handleResponse(response, callback) {
-    let data = {};
+  async handleResponse(response) {
+    let data = null;
     try {
-      data = JSON.parse(response.body || '{}');
+      if (typeof response.data === 'object') {
+        data = response.data;
+      } else if (typeof response.data === 'string' && response.data.trim() !== '') {
+        data = JSON.parse(response.data);
+      } else {
+        data = {};
+      }
     } catch (err) {
-      err.status = response.statusCode;
-      err.body = response.body;
-      return callback(err, null, response.statusCode);
+      err.message = 'Failed to parse response data';
+      err.status = response.status;
+      err.body = response.data;
+      throw err;
     }
-    return this.parseResponse(response.statusCode, data, callback);
+    return await this.parseResponse(response.status, data);
   }
 
-  parseResponse(statusCode, data, callback) {
+  async parseResponse(statusCode, data) {
     if (statusCode < 400) {
       try {
-        data = this.parse(data);
-        callback(null, data, statusCode);
+        data = await this.parse(data);
+        return data;
       } catch (err) {
-        callback(err, null, statusCode);
+        throw err;
       }
     } else {
-      callback(this.parseError(statusCode, data), data, statusCode);
+      throw this.parseError(statusCode, data);
     }
   }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hof",
   "description": "A bootstrap for HOF projects",
-  "version": "21.0.0-instrumentation-beta.0",
+  "version": "21.0.0",
   "license": "MIT",
   "main": "index.js",
   "author": "HomeOffice",
@@ -23,9 +23,9 @@
   "scripts": {
     "test": "yarn run unit && yarn run test:cookie-banner && yarn run test:functional && yarn run test:client && yarn run test:lint",
     "unit": "LOG_LEVEL=error nyc _mocha \"test/**/*.spec.js\" \"sandbox/test/**/*.spec.js\"",
-    "unit:nocov": "LOG_LEVEL=error mocha",
+    "unit:nocov": "LOG_LEVEL=error mocha \"test/**/*.spec.js\" \"sandbox/test/**/*.spec.js\"",
     "test:lint": "eslint . --config ./node_modules/eslint-config-hof/default.js",
-    "test:functional": "funkie mocha ./test/functional-tests --exit",
+    "test:functional": "funkie mocha ./test/functional-tests --timeout 20000 --exit",
     "test:client": "karma start test/frontend/toolkit/karma.conf.js",
     "test:cookie-banner": "jest test/frontend/jest",
     "test:acceptance": "TAGS=\"${TAGS:=@feature}\" yarn run test:cucumber",
@@ -36,6 +36,7 @@
   },
   "dependencies": {
     "aliasify": "^2.1.0",
+    "axios": "^1.5.1",
     "bluebird": "^3.7.2",
     "body-parser": "^1.15.1",
     "browserify": "^17.0.0",
@@ -45,7 +46,7 @@
     "connect-redis": "^5.2.0",
     "cookie-parser": "^1.4.6",
     "cp": "^0.2.0",
-    "csrf": "^3.0.2",
+    "csrf": "^3.1.0",
     "debug": "^4.3.1",
     "deprecate": "^1.0.0",
     "dotenv": "^4.0.0",
@@ -57,6 +58,7 @@
     "findup": "^0.1.5",
     "glob": "^7.2.0",
     "govuk-elements-sass": "^3.1.3",
+    "govuk-frontend": "3.15",
     "govuk_template_mustache": "^0.26.0",
     "helmet": "^3.22.0",
     "hogan-express-strict": "^0.5.4",
@@ -65,36 +67,36 @@
     "i18n-future": "^2.0.0",
     "i18n-lookup": "^0.1.0",
     "is-pdf": "^1.0.0",
-    "libphonenumber-js": "^1.9.37",
+    "libphonenumber-js": "^1.9.44",
     "lodash": "^4.17.21",
     "markdown-it": "^12.3.2",
-    "minimatch": "^3.0.3",
+    "minimatch": "^3.0.7",
     "minimist": "^1.2.6",
     "mixwith": "^0.1.1",
     "moment": "^2.29.4",
     "morgan": "^1.10.0",
-    "mustache": "^2.3.0",
+    "mustache": "^4.2.0",
     "nodemailer": "^6.6.3",
-    "nodemailer-ses-transport": "^1.5.0",
+    "nodemailer-ses-transport": "^1.5.1",
     "nodemailer-smtp-transport": "^2.7.4",
     "nodemailer-stub-transport": "^1.1.0",
-    "notifications-node-client": "^5.1.1",
-    "prom-client": "^14.0.1",
+    "notifications-node-client": "^6.0.0",
     "redis": "^3.1.2",
     "reqres": "^3.0.1",
-    "request": "^2.79.0",
     "rimraf": "^3.0.2",
-    "sass": "^1.35.2",
+    "sass": "^1.56.2",
     "serve-static": "^1.14.1",
     "uglify-js": "^3.14.3",
-    "underscore": "^1.12.1",
+    "underscore": "^1.13.6",
     "urijs": "^1.19.11",
+    "uuid": "^8.3.2",
     "winston": "^3.7.2"
   },
   "devDependencies": {
     "@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",
@@ -121,20 +123,19 @@
     "playwright": "^1.16.3",
     "postcode": "0.2.2",
     "proxyquire": "^1.7.11",
-    "release-it": "^14.10.0",
+    "release-it": "^16.2.1",
     "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",
-    "xmldom": "^0.6.0"
+    "webdriverio": "^4.14.4"
   },
   "mocha": {
     "reporter": "spec",
     "require": "test/common.js",
     "recursive": "true",
-    "timeout": "6000",
+    "timeout": "9000",
     "exit": "true"
   },
   "resolutions": {

package/pull_request.md

@@ -0,0 +1,16 @@
+## What? 
+## Why? 
+## How? 
+## Testing?
+## Screenshots (optional)
+## Anything Else? (optional)
+## Check list
+
+- [ ] I have reviewed my own pull request for linting issues (e.g. adding new lines)
+- [ ] I have written tests (if relevant)
+- [ ] I have created a JIRA number for my branch
+- [ ] I have created a JIRA number for my commit
+- [ ] I have followed the chris beams method for my commit https://cbea.ms/git-commit/
+here is an [example commit](https://github.com/UKHomeOfficeForms/hof/commit/810959f391187c7c4af6db262bcd143b50093a6e)
+- [ ] Ensure drone builds are green especially tests
+- [ ] I will squash the commits before merging

package/sandbox/README.md

@@ -45,10 +45,10 @@ Install the dependencies
 yarn
 ```
 
-Move into the example folder 
+Move into the sandbox folder 
 
 ```bash
-cd example
+cd sandbox
 ```
 
 Install any example app specific dependencies 
@@ -63,4 +63,4 @@ Run in development mode
 yarn start:dev
 ```
 
-go to http://localhost:8080/
+go to http://localhost:8082/

package/sandbox/apps/sandbox/fields.js

@@ -8,16 +8,23 @@ module.exports = {
   'landing-page-radio': {
     mixin: 'radio-group',
     validate: ['required'],
-    legend: {
-      className: 'visuallyhidden'
-    },
+    isPageHeading: true,
+    // Design system says to avoid in-line unless it's two options,
+    // so just added as an example below but by default it isn't
+    className: ['govuk-radios--inline'],
     options: ['basic-form', 'complex-form', 'build-your-own-form']
   },
   name: {
     validate: ['required', 'notUrl', { type: 'maxlength', arguments: 200 }],
   },
-  dateOfBirth: dateComponent('dateOfBirth', {
-    validate: ['required', 'before', { type: 'after', arguments: ['1900'] }]
+  'dateOfBirth': dateComponent('dateOfBirth', {
+    mixin: 'input-date',
+    isPageHeading: 'true',
+    validate: [
+      'required',
+      'date',
+      { type: 'after', arguments: ['1900'] }
+    ]
   }),
   building: {
     validate: ['required', 'notUrl', { type: 'maxlength', arguments: 100 }]
@@ -37,6 +44,7 @@ module.exports = {
     formatter: ['removespaces', 'uppercase']
   },
   incomeTypes: {
+    isPageHeading: 'true',
     mixin: 'checkbox-group',
     labelClassName: 'visuallyhidden',
     validate: ['required'],
@@ -49,11 +57,9 @@ module.exports = {
     ]
   },
   countryOfHearing: {
+    isPageHeading: 'true',
     mixin: 'radio-group',
     validate: ['required'],
-    legend: {
-      className: 'visuallyhidden'
-    },
     options: [
       'englandAndWales',
       'scotland',
@@ -72,6 +78,7 @@ module.exports = {
   },
   countrySelect: {
     mixin: 'select',
+    isPageHeading: 'true',
     className: ['typeahead'],
     options:[''].concat(require('homeoffice-countries').allCountries),
     legend: {
@@ -81,14 +88,29 @@ module.exports = {
   },
   complaintDetails: {
     mixin: 'textarea',
-    labelClassName: 'visuallyhidden',
     // we want to ignore default formatters as we want
     // to preserve white space
     'ignore-defaults': true,
     // apply the other default formatters
     formatter: ['trim', 'hyphens'],
+    isPageHeading: 'true',
     // attributes here are passed to the field element
-    validate: ['required', { type: 'maxlength', arguments: 5000 }],
+    validate: ['required', { type: 'maxlength', arguments: 10 }],
+    attributes: [{
+      attribute: 'rows',
+      value: 8
+    }]
+  },
+  whatHappened: {
+    mixin: 'textarea',
+    // we want to ignore default formatters as we want
+    // to preserve white space
+    'ignore-defaults': true,
+    // apply the other default formatters
+    formatter: ['trim', 'hyphens'],
+    isPageHeading: 'true',
+    // attributes here are passed to the field element
+    validate: ['required', { type: 'maxword', arguments: 10 }],
     attributes: [{
       attribute: 'rows',
       value: 8
@@ -96,7 +118,7 @@ module.exports = {
   },
   appealStages: {
     mixin: 'select',
-    labelClassName: 'visuallyhidden',
+    isPageHeading: 'true',
     validate: ['required'],
     options: [{
       value: '',

package/sandbox/apps/sandbox/index.js

@@ -66,6 +66,10 @@ module.exports = {
     },
     '/text-input-area': {
       fields: ['complaintDetails'],
+      next: '/word-count'
+    },
+    '/word-count': {
+      fields: ['whatHappened'],
       next: '/select'
     },
     '/select':{ 

package/sandbox/apps/sandbox/sections/summary-data-sections.js

@@ -36,5 +36,8 @@ module.exports = {
   ],
   complaintDetails: [
     'complaintDetails'
+  ],
+  whatHappened: [
+    'whatHappened'
   ]
 };