hmpo-form-wizard 11.11.0 → 12.0.0

package/injection/session-injection.js

@@ -62,7 +62,7 @@ class SessionInjection {
             throw new Error('No express session is available in request');
         }
 
-        options = _.extend({}, DEFAULTS, options);
+        options = Object.assign({}, DEFAULTS, options);
 
         req.session.exists = options.sessionExists;
 
@@ -81,7 +81,7 @@ class SessionInjection {
     setFeatureFlags(req, flags) {
         debug('setFeatureFlags', flags);
         if (flags) {
-            req.session.featureFlags = _.extend({}, flags);
+            req.session.featureFlags = Object.assign({}, flags);
         }
     }
 

package/lib/controller/index.js

@@ -3,7 +3,7 @@
 const debug = require('debug')('hmpo:controller');
 const _ = require('underscore');
 const path = require('path');
-const url = require('url');
+const { URL } = require('url');
 const ErrorClass = require('../error');
 const deepCloneMerge = require('deep-clone-merge');
 const express = require('express');
@@ -11,6 +11,8 @@ const express = require('express');
 const formatting = require('../formatting');
 const validation = require('../validation');
 
+const url = req => new URL(req.originalUrl, 'http://hostname');
+
 class BaseController {
     constructor(options) {
         if (!options) {
@@ -194,18 +196,18 @@ class BaseController {
         // pick errorValues that were generated on the same url
         errorValues = _.pick(errorValues, (e, k) => !errs || !errs[k] || !errs[k].url || errs[k].url === req.path);
 
-        values = _.extend(values, errorValues);
+        values = Object.assign(values, errorValues);
         callback(null, values);
     }
 
     _locals(req, res, next) {
         debug('%s #_locals', req.originalUrl);
 
-        let errorlist = _.reject(req.form.errors, (error, key) => error.errorGroup && error.errorGroup !== key);
+        const errorlist = _.reject(req.form.errors, (error, key) => error.errorGroup && error.errorGroup !== key);
 
-        let pathname = url.parse(req.originalUrl).pathname;
+        const pathname = url(req).pathname;
 
-        _.extend(res.locals, {
+        Object.assign(res.locals, {
             errors: req.form.errors,
             errorlist,
             values: req.form.values,
@@ -215,12 +217,12 @@ class BaseController {
         });
 
         if (this.locals.length < 3) {
-            _.extend(res.locals, this.locals(req, res));
+            Object.assign(res.locals, this.locals(req, res));
             return next();
         }
 
         this.locals(req, res, (err, locals) => {
-            _.extend(res.locals, locals);
+            Object.assign(res.locals, locals);
             next(err);
         });
     }
@@ -239,7 +241,7 @@ class BaseController {
             return this.successHandler(req, res, next);
         }
 
-        let pathname = url.parse(req.originalUrl).pathname;
+        const pathname = url(req).pathname;
         if (typeof this.post !== 'function' && res.locals.nextPage !== pathname && req.form.options.checkJourney) {
             this.setStepComplete(req, res);
         }
@@ -359,8 +361,8 @@ class BaseController {
         }
         let nextStep = this.getNextStep(req, res);
         if (req.form.options.forwardQuery) {
-            let parsed = url.parse(req.originalUrl);
-            if (parsed && parsed.search) nextStep += parsed.search;
+            const search = url(req).search;
+            if (search) nextStep += search;
         }
         res.redirect(nextStep);
     }

package/lib/controller/mixins/next-step.js

@@ -30,15 +30,15 @@ module.exports = Controller => class extends Controller {
 
     _getConditionFieldNames(fieldNames) {
         if (typeof fieldNames == 'string') return fieldNames;
-        let fields = {};
+        const fields = Object.create(null);
 
-        let getFieldNames = fieldName => {
+        const getFieldNames = fieldName => {
             if (typeof fieldName === 'string') {
                 fields[fieldName] = fieldName;
             } else if (_.isArray(fieldName)) {
-                _.each(fieldNames, getFieldNames);
+                fieldNames.forEach(getFieldNames);
             } else {
-                _.extend(fields, fieldName);
+                Object.assign(fields, fieldName);
             }
         };
 
@@ -103,7 +103,7 @@ module.exports = Controller => class extends Controller {
     }
 
     decodeConditions(req, res, nextStep) {
-        let fieldsUsed = [];
+        const fieldsUsed = [];
         let successfulCondition = null;
         while (_.isArray(nextStep)) {
             let conditions = nextStep;
@@ -157,7 +157,7 @@ module.exports = Controller => class extends Controller {
     }
 
     getNextStep(req, res) {
-        let nextStep = this.getNextStepObject(req, res);
+        const nextStep = this.getNextStepObject(req, res);
 
         if (nextStep.url) {
             return this.resolvePath(req.baseUrl, nextStep.url);
@@ -167,7 +167,7 @@ module.exports = Controller => class extends Controller {
     }
 
     getErrorStep(err, req, res) {
-        let allErrorsHaveRedirects = _.every(err, error => error.redirect);
+        const allErrorsHaveRedirects = _.every(err, error => error.redirect);
 
         if (allErrorsHaveRedirects) {
             let redirect = _.find(err, error => error.redirect).redirect;

package/lib/controller/mixins/session-model.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const WizardModel = require('../../wizard-model');
-const _ = require('underscore');
 
 module.exports = Controller => class extends Controller {
 
@@ -23,7 +22,7 @@ module.exports = Controller => class extends Controller {
             req,
             key: 'hmpo-wizard-' + req.form.options.name,
             journeyModel: req.journeyModel,
-            fields: _.extend({}, req.form.options.allFields, req.form.options.fields)
+            fields: Object.assign({}, req.form.options.allFields, req.form.options.fields)
         });
 
         next();

package/lib/model.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const LocalModel = require('hmpo-model').Local;
-const _ = require('underscore');
 
 class SessionModel extends LocalModel {
     constructor(attrs, options) {
@@ -19,7 +18,7 @@ class SessionModel extends LocalModel {
             throw new Error('session-model - key must be defined');
         }
 
-        super({}, options);
+        super(null, options);
 
         let initialValues = this.getSessionData();
         this.set(initialValues, { silent: true });
@@ -41,7 +40,7 @@ class SessionModel extends LocalModel {
 
     updateSessionData(changes) {
         let session = this.options.req.session;
-        _.extend(session[this.options.key], changes);
+        Object.assign(session[this.options.key], changes);
     }
 
     resetSessionData() {
@@ -62,7 +61,7 @@ class SessionModel extends LocalModel {
     }
 
     _reload() {
-        this.attributes = {};
+        this.attributes = Object.create(null);
         let data = this.getSessionData();
         this.set(data, { silent: true });
     }

package/lib/validation/index.js

@@ -33,7 +33,7 @@ function applyValidator(validator, key, value, field, context) {
     let result = validator.fn.apply(context, [value].concat(validator.arguments));
 
     if (!result) {
-        return _.extend({
+        return Object.assign({
             key: key,
             errorGroup: field.errorGroup
         }, _.omit(validator, 'fn'));

package/lib/wizard-model.js

@@ -39,28 +39,26 @@ class WizardModel extends SessionModel {
     getSessionData() {
         let defaults = this.getDefaults();
         let wizardData = super.getSessionData();
-        let journeyData = _.mapObject(
+        let journeyData = _.omit(_.mapObject(
             this.getJourneyKeys(),
             journeyKey => this.options.journeyModel.get(journeyKey)
-        );
-        return _.defaults(journeyData, wizardData, defaults);
+        ), _.isUndefined);
+        return Object.assign({}, defaults, wizardData, journeyData);
     }
 
     resetSessionData() {
         super.resetSessionData();
-        // load in journey and defaults after reset
-        this.attributes = this.getSessionData();
+        this._reload();
     }
 
     updateSessionData(changes) {
-        let journeyKeys = this.getJourneyKeys();
-        let journeyChanges = {};
-        let wizardChanges = {};
+        const journeyKeys = this.getJourneyKeys();
+        const journeyChanges = Object.create(null);
+        const wizardChanges = Object.create(null);
 
         _.each(changes, (value, key) => {
-            let journeyKey = journeyKeys[key];
-            if (journeyKey) {
-                journeyChanges[journeyKey] = value;
+            if (Object.prototype.hasOwnProperty.call(journeyKeys, key)) {
+                journeyChanges[journeyKeys[key]] = value;
             } else {
                 wizardChanges[key] = value;
             }

package/lib/wizard.js

@@ -16,7 +16,7 @@ let wizard = function (steps, fields, wizardOptions) {
 
     // process step options and merge with wizard options
     let processedSteps = _.mapObject(steps, (options, route) => {
-        options = _.extend({
+        options = Object.assign({
             route,
             params: '',
             controller: Controller,
@@ -35,7 +35,7 @@ let wizard = function (steps, fields, wizardOptions) {
         }, wizardOptions, options);
 
         // convert field list to field definitions
-        if (_.isArray(options.fields)) {
+        if (Array.isArray(options.fields)) {
             options.fields = _.object(
                 options.fields,
                 _.map(options.fields, f => fields[f] || {} )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hmpo-form-wizard",
-  "version": "11.11.0",
+  "version": "12.0.0",
   "description": "Routing and request handling for a multi-step form processes",
   "main": "index.js",
   "scripts": {
@@ -16,7 +16,7 @@
   "author": "HMPO",
   "license": "MIT",
   "engines": {
-    "node": ">=8"
+    "node": ">=10"
   },
   "bugs": {
     "url": "https://github.com/UKHomeOffice/passports-form-wizard/issues"
@@ -25,9 +25,9 @@
   "dependencies": {
     "body-parser": "^1.19.0",
     "csrf": "^3.1.0",
-    "debug": "^4.3.2",
-    "deep-clone-merge": "^1.5.2",
-    "hmpo-model": "^3.2.2",
+    "debug": "^4.3.3",
+    "deep-clone-merge": "^1.5.3",
+    "hmpo-model": "^4.0.1",
     "json5": "^2.2.0",
     "moment": "^2.29.1",
     "underscore": "^1.13.1"
@@ -37,13 +37,13 @@
   },
   "devDependencies": {
     "chai": "^4.3.4",
-    "eslint": "^7.31.0",
+    "eslint": "^8.3.0",
     "express": "^4.17.1",
-    "mocha": "^9.0.2",
+    "mocha": "^9.1.3",
     "nyc": "^15.1.0",
     "proxyquire": "^2.1.3",
     "reqres": "^3.0.1",
-    "sinon": "^11.1.1",
+    "sinon": "^12.0.1",
     "sinon-chai": "^3.7.0"
   },
   "mocha": {

package/test/controller/spec.index.js

@@ -28,6 +28,7 @@ describe('Form Controller', () => {
         };
         req = request({
             method: 'GET',
+            protocol: 'http',
             originalUrl: '/base/route?this=is&a=query',
             url: '/route',
             baseUrl: '/base',

package/test/controller/spec.lifecycle.js

@@ -21,6 +21,7 @@ describe('Controller Lifecycle', () => {
         };
         req = request({
             method: 'GET',
+            protocol: 'http:',
             originalUrl: '/base/route',
             url: '/route',
             baseUrl: '/base',

package/test/spec.model.js

@@ -149,7 +149,7 @@ describe('session model', () => {
         it('should reset the sessionModel attributes', () => {
             sessionModel.attributes = { foo: 'bar '};
             sessionModel._reload();
-            sessionModel.attributes.should.eql({});
+            expect(sessionModel.attributes).to.eql({});
         });
 
         it('should silently set the sessionModel with session data', () => {

package/test/spec.wizard-model.js

@@ -104,7 +104,7 @@ describe('wizard model', () => {
             wizardModel.getSessionData().should.deep.equal({
                 a: 'val1', // from wizard data
                 b: 'bar',  // from journey data
-                c: 'baz',   // from default
+                c: 'baz',  // from default
                 d: 'bam'   // from default
             });
         });
@@ -119,7 +119,7 @@ describe('wizard model', () => {
             wizardModel.reset();
             wizardModel.toJSON().should.deep.equal({
                 b: 'bar',  // from journey data
-                c: 'baz',   // from default
+                c: 'baz',  // from default
                 d: 'bam'   // from default
             });
         });