@dwp/govuk-casa 8.11.0 → 8.12.0

package/src/lib/context-id-generators.js

@@ -0,0 +1,71 @@
+/* eslint-disable import/no-cycle */
+import { randomUUID } from 'node:crypto';
+
+/**
+ * @typedef {import('../casa.js').ContextIdGenerator} ContextIdGenerator
+ */
+
+/**
+ * Creates an instance of a UUID generator.
+ *
+ * @returns {ContextIdGenerator} Generator function
+ */
+const uuid = () => () => randomUUID();
+
+/**
+ * Returns a generator that returns the next incremental integer in a sequence.
+ *
+ * This generator does not take into account the removal of any contexts from
+ * session that were previously assigned a sequential ID. This means that IDs
+ * will be re-used when they are freed up.
+ *
+ * @returns {ContextIdGenerator} Generator function
+ */
+const sequentialInteger = () => ({ reservedIds }) => {
+  const contextIds = Array.from(reservedIds).sort();
+
+  if (!contextIds.length) {
+    return '1';
+  }
+
+  // Find the first numeric ID that we can increment
+  let lastInSequence;
+  do {
+    lastInSequence = Number.parseInt(contextIds.pop(), 10);
+  } while (contextIds.length && Number.isNaN(lastInSequence));
+
+  return String(!Number.isNaN(lastInSequence) ? lastInSequence + 1 : 1);
+};
+
+const shortGuid = ({
+  length = 5,
+  prefix = '',
+  pool = 'abcdefhkmnprtwxy346789',
+} = {}) => ({ reservedIds }) => {
+  // Ambiguous characters excluded
+  const poolSize = pool.length;
+
+  const maxAttempts = 10;
+  let attempts = maxAttempts;
+  let id;
+
+  do {
+    id = Array(length).fill(0).map(() => pool.charAt(Math.floor(Math.random() * poolSize))).join('');
+    attempts--;
+  } while (attempts > 0 && reservedIds.includes(id));
+
+  if (attempts === 0) {
+    throw new Error(`Failed to generate GUID after ${maxAttempts} iterations`);
+  }
+
+  return `${prefix}${id}`;
+}
+
+/**
+ * @namespace ContextIdGenerators
+ */
+export {
+  uuid,
+  sequentialInteger,
+  shortGuid,
+};

package/src/lib/validators/range.js

@@ -62,7 +62,8 @@ export default class Range extends ValidatorFactory {
     // treat an empty string as undefined
     // when user submits empty form, it stores an empty string
     if (value !== '' && value !== undefined) {
-      // add to custom validator docs to ensure not to return a falsy value as it doesn't show on screen
+      // add to custom validator docs to ensure not to return a falsy value as
+      // it doesn't show on screen
       return coerceInputToInteger(value)?.toString();
     }
     return undefined;

package/src/middleware/data.js

@@ -21,6 +21,7 @@ const editOrigin = (req) => {
 export default function dataMiddleware({
   plan,
   events,
+  contextIdGenerator,
 }) {
   return [
     (req, res, next) => {
@@ -45,6 +46,13 @@ export default function dataMiddleware({
       // Grab chosen language from session
       req.casa.journeyContext.nav.language = req.session.language;
 
+      // Context ID generator
+      Object.defineProperty(req, JourneyContext.ID_GENERATOR_REQ_KEY, {
+        value: contextIdGenerator,
+        enumerable: false,
+        writable: false,
+      });
+
       /* ------------------------------------------------- Template variables */
 
       // Capture mount URL that will be used in generating all browser URLs

package/src/middleware/gather-fields.js

@@ -29,7 +29,10 @@ export default ({
   (req, res, next) => {
     // Store a copy of the journey context before modifying it. This is useful
     // for any comparison work that may be done in subsequent middleware.
-    req.casa.archivedJourneyContext = JourneyContext.fromContext(req.casa.journeyContext);
+    req.casa.archivedJourneyContext = JourneyContext.fromContext(
+      req.casa.journeyContext,
+      req,
+    );
 
     // Ignore data for any non-persistent fields
     // ESLint disabled as `fields`, `i` and `name` are dev-controlled

package/src/middleware/sanitise-fields.js

@@ -31,7 +31,7 @@ export default ({
       }
       /* eslint-enable security/detect-object-injection */
 
-      const journeyContext = JourneyContext.fromContext(req.casa.journeyContext);
+      const journeyContext = JourneyContext.fromContext(req.casa.journeyContext, req);
       journeyContext.setDataForPage(waypoint, prunedBody);
 
       // Second, prune any fields that do not pass the validation conditional,