@dwp/govuk-casa 8.16.2 → 8.16.3

package/src/lib/MutableRouter.js

@@ -1,5 +1,4 @@
-/* eslint-disable sonarjs/no-duplicate-string,class-methods-use-this */
-import { Router } from 'express';
+import { Router } from "express";
 
 /**
  * @memberof module:@dwp/govuk-casa
@@ -35,7 +34,7 @@ export default class MutableRouter {
 
   #append(method, path, ...callbacks) {
     if (this.#sealed) {
-      throw new Error('Cannot alter middleware in a sealed mutable router');
+      throw new Error("Cannot alter middleware in a sealed mutable router");
     }
 
     this.#stack.push({
@@ -47,7 +46,7 @@ export default class MutableRouter {
 
   #prepend(method, path, ...callbacks) {
     if (this.#sealed) {
-      throw new Error('Cannot alter middleware in a sealed mutable router');
+      throw new Error("Cannot alter middleware in a sealed mutable router");
     }
 
     this.#stack.splice(0, 0, {
@@ -61,10 +60,11 @@ export default class MutableRouter {
   // given path
   #replace(method, path, ...callbacks) {
     if (this.#sealed) {
-      throw new Error('Cannot alter middleware in a sealed mutable router');
+      throw new Error("Cannot alter middleware in a sealed mutable router");
     }
 
-    const finder = (command) => `${command.method}|${command.path}` === `${method}|${path}`;
+    const finder = (command) =>
+      `${command.method}|${command.path}` === `${method}|${path}`;
     const index = this.#stack.findIndex(finder);
 
     if (index > -1) {
@@ -74,7 +74,9 @@ export default class MutableRouter {
         args: [path, ...callbacks],
       });
 
-      this.#stack = this.#stack.filter((command, idx) => idx <= index || !finder(command))
+      this.#stack = this.#stack.filter(
+        (command, idx) => idx <= index || !finder(command),
+      );
     }
   }
 
@@ -110,7 +112,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   prependAll(path, ...callbacks) {
-    this.#prepend('all', path, ...callbacks);
+    this.#prepend("all", path, ...callbacks);
   }
 
   /**
@@ -121,7 +123,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   prependGet(path, ...callbacks) {
-    this.#prepend('get', path, ...callbacks);
+    this.#prepend("get", path, ...callbacks);
   }
 
   /**
@@ -132,7 +134,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   prependPost(path, ...callbacks) {
-    this.#prepend('post', path, ...callbacks);
+    this.#prepend("post", path, ...callbacks);
   }
 
   /**
@@ -143,7 +145,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   prependDelete(path, ...callbacks) {
-    this.#prepend('delete', path, ...callbacks);
+    this.#prepend("delete", path, ...callbacks);
   }
 
   /**
@@ -154,7 +156,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   prependPut(path, ...callbacks) {
-    this.#prepend('put', path, ...callbacks);
+    this.#prepend("put", path, ...callbacks);
   }
 
   /**
@@ -165,7 +167,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   prependUse(path, ...callbacks) {
-    this.#prepend('use', path, ...callbacks);
+    this.#prepend("use", path, ...callbacks);
   }
 
   /* -------------------------------------------------------------- replacers */
@@ -178,7 +180,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   replaceAll(path, ...callbacks) {
-    this.#replace('all', path, ...callbacks);
+    this.#replace("all", path, ...callbacks);
   }
 
   /**
@@ -189,7 +191,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   replaceGet(path, ...callbacks) {
-    this.#replace('get', path, ...callbacks);
+    this.#replace("get", path, ...callbacks);
   }
 
   /**
@@ -200,7 +202,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   replacePost(path, ...callbacks) {
-    this.#replace('post', path, ...callbacks);
+    this.#replace("post", path, ...callbacks);
   }
 
   /**
@@ -211,7 +213,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   replaceDelete(path, ...callbacks) {
-    this.#replace('delete', path, ...callbacks);
+    this.#replace("delete", path, ...callbacks);
   }
 
   /**
@@ -222,7 +224,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   replacePut(path, ...callbacks) {
-    this.#replace('put', path, ...callbacks);
+    this.#replace("put", path, ...callbacks);
   }
 
   /**
@@ -233,7 +235,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   replaceUse(path, ...callbacks) {
-    this.#replace('use', path, ...callbacks);
+    this.#replace("use", path, ...callbacks);
   }
 
   /* ---------------------------------------------- express.Router() wrappers */
@@ -246,7 +248,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   all(path, ...callbacks) {
-    this.#append('all', path, ...callbacks);
+    this.#append("all", path, ...callbacks);
   }
 
   /**
@@ -257,7 +259,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   get(path, ...callbacks) {
-    this.#append('get', path, ...callbacks);
+    this.#append("get", path, ...callbacks);
   }
 
   /**
@@ -268,7 +270,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   post(path, ...callbacks) {
-    this.#append('post', path, ...callbacks);
+    this.#append("post", path, ...callbacks);
   }
 
   /**
@@ -279,7 +281,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   delete(path, ...callbacks) {
-    this.#append('delete', path, ...callbacks);
+    this.#append("delete", path, ...callbacks);
   }
 
   /**
@@ -290,7 +292,7 @@ export default class MutableRouter {
    * @returns {void}
    */
   put(path, ...callbacks) {
-    this.#append('put', path, ...callbacks);
+    this.#append("put", path, ...callbacks);
   }
 
   /**
@@ -301,10 +303,12 @@ export default class MutableRouter {
    * @returns {void}
    */
   use(path, ...callbacks) {
-    this.#append('use', path, ...callbacks);
+    this.#append("use", path, ...callbacks);
   }
 
   route() {
-    throw new Error('route() method is not supported on MutableRouter. Use verb methods for now.');
+    throw new Error(
+      "route() method is not supported on MutableRouter. Use verb methods for now.",
+    );
   }
 }

package/src/lib/Plan.js

@@ -1,8 +1,8 @@
-import { Graph } from '@dagrejs/graphlib';
-import JourneyContext from './JourneyContext.js';
-import logger from './logger.js';
+import { Graph } from "@dagrejs/graphlib";
+import JourneyContext from "./JourneyContext.js";
+import logger from "./logger.js";
 
-const log = logger('lib:plan');
+const log = logger("lib:plan");
 
 /**
  * @access private
@@ -39,7 +39,9 @@ const log = logger('lib:plan');
  */
 function defaultNextFollow(r, context) {
   const { validation: v = {} } = context.toObject();
-  return Object.prototype.hasOwnProperty.call(v, r.source) && v[r.source] === null;
+  return (
+    Object.prototype.hasOwnProperty.call(v, r.source) && v[r.source] === null
+  );
 }
 
 /**
@@ -51,7 +53,9 @@ function defaultNextFollow(r, context) {
  */
 function defaultPrevFollow(r, context) {
   const { validation: v = {} } = context.toObject();
-  return Object.prototype.hasOwnProperty.call(v, r.target) && v[r.target] === null;
+  return (
+    Object.prototype.hasOwnProperty.call(v, r.target) && v[r.target] === null
+  );
 }
 
 /**
@@ -64,11 +68,13 @@ function defaultPrevFollow(r, context) {
  * @throws {SyntaxError} If waypoint ID is incorrectly formatted
  */
 function validateWaypointId(val) {
-  if (typeof val !== 'string') {
-    throw new TypeError(`Expected waypoint id to be a string, got ${typeof val}`);
+  if (typeof val !== "string") {
+    throw new TypeError(
+      `Expected waypoint id to be a string, got ${typeof val}`,
+    );
   }
-  if (val.substr(0, 6) === 'url://' && !val.endsWith('/')) {
-    throw new SyntaxError('url:// waypoints must include a trailing /')
+  if (val.substr(0, 6) === "url://" && !val.endsWith("/")) {
+    throw new SyntaxError("url:// waypoints must include a trailing /");
   }
 }
 
@@ -82,10 +88,14 @@ function validateWaypointId(val) {
  * @throws {ReferenceError} If route name is neither "next" or "prev"
  */
 function validateRouteName(val) {
-  if (typeof val !== 'string') {
-    throw new TypeError(`Expected route name to be a string, got ${typeof val}`);
-  } else if (!['next', 'prev'].includes(val)) {
-    throw new ReferenceError(`Expected route name to be one of next or prev. Got ${val}`)
+  if (typeof val !== "string") {
+    throw new TypeError(
+      `Expected route name to be a string, got ${typeof val}`,
+    );
+  } else if (!["next", "prev"].includes(val)) {
+    throw new ReferenceError(
+      `Expected route name to be one of next or prev. Got ${val}`,
+    );
   }
   return val;
 }
@@ -100,7 +110,9 @@ function validateRouteName(val) {
  */
 function validateRouteCondition(val) {
   if (!(val instanceof Function)) {
-    throw new TypeError(`Expected route condition to be a function, got ${typeof val}`);
+    throw new TypeError(
+      `Expected route condition to be a function, got ${typeof val}`,
+    );
   }
 }
 
@@ -174,14 +186,18 @@ export default class Plan {
     });
 
     // Gather options
-    const options = Object.assign(Object.create(null), {
-      // When true, the validation state of the source node must be `null` (i.e.
-      // no validation errors) before any custom route conditions are evaluated.
-      validateBeforeRouteCondition: true,
-
-      // Traversal arbitration
-      arbiter: undefined,
-    }, opts);
+    const options = Object.assign(
+      Object.create(null),
+      {
+        // When true, the validation state of the source node must be `null` (i.e.
+        // no validation errors) before any custom route conditions are evaluated.
+        validateBeforeRouteCondition: true,
+
+        // Traversal arbitration
+        arbiter: undefined,
+      },
+      opts,
+    );
     Object.freeze(options);
 
     priv.set(this, {
@@ -261,7 +277,9 @@ export default class Plan {
    */
   getRoutes() {
     const self = priv.get(this);
-    return self.dgraph.edges().map((edge) => makeRouteObject(self.dgraph, edge));
+    return self.dgraph
+      .edges()
+      .map((edge) => makeRouteObject(self.dgraph, edge));
   }
 
   /**
@@ -286,7 +304,9 @@ export default class Plan {
    */
   getOutwardRoutes(src, tgt = null) {
     const self = priv.get(this);
-    return self.dgraph.outEdges(src, tgt).map((e) => makeRouteObject(self.dgraph, e));
+    return self.dgraph
+      .outEdges(src, tgt)
+      .map((e) => makeRouteObject(self.dgraph, e));
   }
 
   /**
@@ -298,7 +318,7 @@ export default class Plan {
    * @returns {PlanRoute[]} Route objects found.
    */
   getPrevOutwardRoutes(src, tgt = null) {
-    return this.getOutwardRoutes(src, tgt).filter((r) => r.name === 'prev');
+    return this.getOutwardRoutes(src, tgt).filter((r) => r.name === "prev");
   }
 
   /**
@@ -326,7 +346,7 @@ export default class Plan {
    * @returns {Plan} Chain
    */
   setNextRoute(src, tgt, follow) {
-    return this.setNamedRoute(src, tgt, 'next', follow);
+    return this.setNamedRoute(src, tgt, "next", follow);
   }
 
   /**
@@ -338,7 +358,7 @@ export default class Plan {
    * @returns {Plan} Chain
    */
   setPrevRoute(src, tgt, follow) {
-    return this.setNamedRoute(src, tgt, 'prev', follow);
+    return this.setNamedRoute(src, tgt, "prev", follow);
   }
 
   /**
@@ -364,21 +384,24 @@ export default class Plan {
    * @returns {Plan} Chain
    */
   setRoute(src, tgt, followNext = undefined, followPrev = undefined) {
-    this.setNamedRoute(src, tgt, 'next', followNext);
+    this.setNamedRoute(src, tgt, "next", followNext);
 
     let followPrevious = followPrev;
     if (followPrevious === undefined) {
-      followPrevious = followNext === undefined ? undefined : (r, c) => {
-        const invertedRoute = {
-          ...r,
-          source: r.target,
-          target: r.source,
-        };
-        return followNext(invertedRoute, c);
-      }
+      followPrevious =
+        followNext === undefined
+          ? undefined
+          : (r, c) => {
+              const invertedRoute = {
+                ...r,
+                source: r.target,
+                target: r.source,
+              };
+              return followNext(invertedRoute, c);
+            };
     }
 
-    this.setNamedRoute(tgt, src, 'prev', followPrevious);
+    this.setNamedRoute(tgt, src, "prev", followPrevious);
 
     return this;
   }
@@ -419,7 +442,12 @@ export default class Plan {
 
     // Warn if we're overwriting an existing edge on the same name
     if (self.dgraph.hasEdge(src, tgt, name)) {
-      log.warn('Setting a route that already exists (%s, %s, %s). Will be overridden', src, tgt, name);
+      log.warn(
+        "Setting a route that already exists (%s, %s, %s). Will be overridden",
+        src,
+        tgt,
+        name,
+      );
     }
     self.dgraph.setEdge(src, tgt, { conditionName }, name);
 
@@ -428,18 +456,18 @@ export default class Plan {
     if (follow) {
       if (!self.options.validateBeforeRouteCondition) {
         followFunc = follow;
-      } else if (name === 'next') {
+      } else if (name === "next") {
         // Retain the original function name of route condition
         followFunc = {
-          [follow.name]: (r, c) => (defaultNextFollow(r, c) && follow(r, c)),
+          [follow.name]: (r, c) => defaultNextFollow(r, c) && follow(r, c),
         }[follow.name];
       } else {
         // Retain the original function name of route condition
         followFunc = {
-          [follow.name]: (r, c) => (defaultPrevFollow(r, c) && follow(r, c)),
+          [follow.name]: (r, c) => defaultPrevFollow(r, c) && follow(r, c),
         }[follow.name];
       }
-    } else if (name === 'next') {
+    } else if (name === "next") {
       followFunc = defaultNextFollow;
     } else {
       followFunc = defaultPrevFollow;
@@ -473,7 +501,7 @@ export default class Plan {
    * @returns {PlanRoute[]} List of traversed waypoints
    */
   traverseNextRoutes(context, options = {}) {
-    return this.traverseRoutes(context, { ...options, routeName: 'next' })
+    return this.traverseRoutes(context, { ...options, routeName: "next" });
   }
 
   /**
@@ -485,7 +513,7 @@ export default class Plan {
    * @returns {PlanRoute[]} List of traversed waypoints
    */
   traversePrevRoutes(context, options = {}) {
-    return this.traverseRoutes(context, { ...options, routeName: 'prev' })
+    return this.traverseRoutes(context, { ...options, routeName: "prev" });
   }
 
   /**
@@ -505,7 +533,9 @@ export default class Plan {
    */
   traverseRoutes(context, options = {}) {
     if (!(context instanceof JourneyContext)) {
-      throw new TypeError(`Expected context to be an instance of JourneyContext, got ${typeof context}`);
+      throw new TypeError(
+        `Expected context to be an instance of JourneyContext, got ${typeof context}`,
+      );
     }
 
     const self = priv.get(this);
@@ -513,13 +543,15 @@ export default class Plan {
     /** @type {PlanTraverseOptions} */
     const {
       startWaypoint = this.getWaypoints()[0],
-      stopCondition = () => (false),
+      stopCondition = () => false,
       arbiter = self.options.arbiter,
       routeName,
     } = options;
 
     if (!self.dgraph.hasNode(startWaypoint)) {
-      throw new ReferenceError(`Plan does not contain waypoint '${startWaypoint}'`);
+      throw new ReferenceError(
+        `Plan does not contain waypoint '${startWaypoint}'`,
+      );
     }
 
     validateRouteName(routeName);
@@ -537,7 +569,11 @@ export default class Plan {
           /* eslint-disable-next-line security/detect-object-injection */
           return self.follows[routeName][`${e.v}/${e.w}`](route, context);
         } catch (ex) {
-          log.warn('Route follow function threw an exception, "%s" (%s)', ex.message, `${e.v} -> ${e.w}`);
+          log.warn(
+            'Route follow function threw an exception, "%s" (%s)',
+            ex.message,
+            `${e.v} -> ${e.w}`,
+          );
           return false;
         }
       });
@@ -545,10 +581,12 @@ export default class Plan {
       // When there's more than one candidate route to take, we need help to choose
       if (target.length > 1) {
         const satisfied = target.map((t) => `${t.v} -> ${t.w}`);
-        log.debug(`Multiple routes were satisfied for "${routeName}" from "${startWP}" (${satisfied.join(' / ')}). Deciding how to resolve ...`);
+        log.debug(
+          `Multiple routes were satisfied for "${routeName}" from "${startWP}" (${satisfied.join(" / ")}). Deciding how to resolve ...`,
+        );
 
-        if (arbiter === 'auto') {
-          log.debug('Using automatic arbitration process');
+        if (arbiter === "auto") {
+          log.debug("Using automatic arbitration process");
           const targetNames = target.map(({ w }) => w);
           const forwardTraversal = this.traverseNextRoutes(context, {
             stopCondition: ({ source }) => targetNames.includes(source),
@@ -556,7 +594,7 @@ export default class Plan {
           const resolved = forwardTraversal.pop();
           target = target.filter((t) => t.w === resolved.source);
         } else if (arbiter instanceof Function) {
-          log.debug('Using custom arbitration process');
+          log.debug("Using custom arbitration process");
           // Convert to routeObject and back to edge object so that only the
           // routeObject is used in the public API
           target = arbiter({
@@ -564,9 +602,13 @@ export default class Plan {
             journeyContext: context,
             travereOptions: options,
           });
-          target = target.map((r) => ({ v: r.source, w: r.target, name: r.name }));
+          target = target.map((r) => ({
+            v: r.source,
+            w: r.target,
+            name: r.name,
+          }));
         } else {
-          log.warn('Unable to arbitrate');
+          log.warn("Unable to arbitrate");
           target = [];
         }
       }
@@ -593,15 +635,20 @@ export default class Plan {
 
           return results;
         }
-        log.debug('Encountered loop (%s). Stopping traversal.', `${route.source} -> ${route.target}`);
+        log.debug(
+          "Encountered loop (%s). Stopping traversal.",
+          `${route.source} -> ${route.target}`,
+        );
       }
 
-      return [makeRouteObject(self.dgraph, {
-        v: startWP,
-        w: null,
-        name: routeName,
-        label: {},
-      })];
+      return [
+        makeRouteObject(self.dgraph, {
+          v: startWP,
+          w: null,
+          name: routeName,
+          label: {},
+        }),
+      ];
     };
 
     return traverse(startWaypoint);

package/src/lib/ValidationError.js

@@ -1,4 +1,4 @@
-import lodash from 'lodash';
+import lodash from "lodash";
 
 const { isPlainObject } = lodash; // CommonJS
 
@@ -41,13 +41,13 @@ export default class ValidationError {
    *
    * @param {object} args Arguments
    * @param {ErrorMessageConfig} args.errorMsg Error message config to seed ValidationError
-   * @param {ValidateContext} [args.dataContext={}] Data for error msg function
+   * @param {ValidateContext} [args.dataContext] Data for error msg function
    * @returns {ValidationError} Error instance
    * @throws {TypeError} If errorMsg is not in a valid type
    */
   static make({ errorMsg, dataContext = {} }) {
     // Convert strings to the most basic object primitive
-    if (typeof errorMsg === 'string') {
+    if (typeof errorMsg === "string") {
       return new ValidationError({
         summary: errorMsg,
         inline: errorMsg,
@@ -63,7 +63,7 @@ export default class ValidationError {
 
     // Use the user-defined function to generate an error primitive for the
     // given context
-    if (typeof errorMsg === 'function') {
+    if (typeof errorMsg === "function") {
       return new ValidationError(errorMsg.call(null, { ...dataContext }));
     }
 
@@ -77,7 +77,9 @@ export default class ValidationError {
     }
 
     // Unsupported
-    throw new TypeError('errorMsg must be a string, Error, primitive object or function that generates a primitive object');
+    throw new TypeError(
+      "errorMsg must be a string, Error, primitive object or function that generates a primitive object",
+    );
   }
 
   /**
@@ -86,10 +88,11 @@ export default class ValidationError {
    * @param {string|ErrorMessageConfigObject} errorParam Error configuration
    */
   constructor(errorParam = {}) {
-    if (!isPlainObject(errorParam) && typeof errorParam !== 'string') {
-      throw new TypeError('Constructor requires a string or object');
+    if (!isPlainObject(errorParam) && typeof errorParam !== "string") {
+      throw new TypeError("Constructor requires a string or object");
     }
-    const error = typeof errorParam === 'string' ? { summary: errorParam } : errorParam;
+    const error =
+      typeof errorParam === "string" ? { summary: errorParam } : errorParam;
 
     // Store parameters for later use in applying contexts
     const originals = {
@@ -133,7 +136,7 @@ export default class ValidationError {
     const originals = params.get(this);
 
     // Expand variables
-    if (typeof originals.variables === 'function') {
+    if (typeof originals.variables === "function") {
       this.variables = originals.variables.call(this, context);
     }
 
@@ -150,7 +153,7 @@ export default class ValidationError {
         fieldHref += focusSuffix[0];
       }
 
-      this.field = context.fieldName + (originals.fieldKeySuffix || '');
+      this.field = context.fieldName + (originals.fieldKeySuffix || "");
       this.fieldHref = fieldHref;
       this.focusSuffix = focusSuffix || [];
     }

package/src/lib/ValidatorFactory.js

@@ -1,5 +1,4 @@
-/* eslint-disable class-methods-use-this */
-import lodash from 'lodash';
+import lodash from "lodash";
 
 const { isPlainObject } = lodash; // CommonJS
 
@@ -48,14 +47,13 @@ export default class ValidatorFactory {
    */
   static make(config = {}) {
     if (!isPlainObject(config)) {
-      throw new TypeError('Configuration must be an object');
+      throw new TypeError("Configuration must be an object");
     }
 
     const validator = Reflect.construct(this, [config]);
 
-    /* eslint-disable-next-line sonarjs/prefer-object-literal */
     const instance = {};
-    instance.name = validator.name || 'unknown';
+    instance.name = validator.name || "unknown";
     instance.config = config;
     instance.validate = validator.validate.bind(instance);
     instance.sanitise = validator.sanitise.bind(instance);
@@ -72,7 +70,9 @@ export default class ValidatorFactory {
    */
   constructor(config = {}) {
     if (new.target === ValidatorFactory) {
-      throw new TypeError('Cannot instantiate the abstract class, ValidatorFactory');
+      throw new TypeError(
+        "Cannot instantiate the abstract class, ValidatorFactory",
+      );
     }
     this.config = config;
   }
@@ -89,10 +89,9 @@ export default class ValidatorFactory {
    * @throws {Error}
    */
   validate(fieldValue, context) {
-    throw new Error('validate() method has not been implemented');
+    throw new Error("validate() method has not been implemented");
   }
 
-  /* eslint-disable-next-line jsdoc/require-returns-check */
   /**
    * Sanitise the given value.
    *