Merge pull request #467 from DEFRA/feat/df-870-unlimited-save-and-exit

feat/df-870: Re-use of save-and-exit links

Author: jbarnsley10

package-lock.json

@@ -41,7 +41,7 @@
     "@aws-sdk/client-sqs": "^3.982.0",
     "@aws-sdk/s3-request-presigner": "^3.679.0",
     "@defra/forms-engine-plugin": "^4.0.57",
-    "@defra/forms-model": "^3.0.627",
+    "@defra/forms-model": "^3.0.635",
     "@defra/hapi-tracing": "^1.12.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",

package.json

@@ -0,0 +1,21 @@
+import { getErrorMessage } from '@defra/forms-model'
+import Boom from '@hapi/boom'
+
+/**
+ * Extract underlying Boom message for Boom errors, otherwise default to standard error object
+ * @param {unknown} err
+ * @returns {string}
+ */
+export function getBoomErrorMessage(err) {
+  if (Boom.isBoom(err)) {
+    const boomMessages =
+      /** @type {{ error: string, message: string }[] | undefined } */ (
+        err.data?.errors
+      )
+    const boomMessage = boomMessages
+      ? boomMessages.map((e) => `${e.error}: ${e.message}`).join(', ')
+      : ''
+    return `${getErrorMessage(err)} ${boomMessage}`.trim()
+  }
+  return getErrorMessage(err)
+}

src/helpers/error-helper.js

@@ -0,0 +1,36 @@
+import Boom from '@hapi/boom'
+
+import { getBoomErrorMessage } from '~/src/helpers/error-helper.js'
+
+describe('error-helper', () => {
+  test('handles non-boom error', () => {
+    const err = new Error('error message 1')
+    expect(getBoomErrorMessage(err)).toBe('error message 1')
+  })
+
+  test('handles boom error with no underlying message', () => {
+    const err = Boom.badRequest('general error message')
+    expect(getBoomErrorMessage(err)).toBe('general error message')
+  })
+
+  test('handles boom error with one message', () => {
+    const err = Boom.badRequest('general error message', {
+      errors: [{ error: 'error type 2', message: 'error message 2' }]
+    })
+    expect(getBoomErrorMessage(err)).toBe(
+      'general error message error type 2: error message 2'
+    )
+  })
+
+  test('handles boom error with multiple messages', () => {
+    const err = Boom.badRequest('general error message', {
+      errors: [
+        { error: 'error type 3', message: 'error message 3' },
+        { error: 'error type 4', message: 'error message 4' }
+      ]
+    })
+    expect(getBoomErrorMessage(err)).toBe(
+      'general error message error type 3: error message 3, error type 4: error message 4'
+    )
+  })
+})

src/helpers/error-helper.test.js

@@ -31,7 +31,8 @@ export const validateSavedLinkResponseSchema = Joi.object({
   state: Joi.object(),
   securityQuestion: Joi.string().required(),
   invalidPasswordAttempts: Joi.number().min(0).required(),
-  validPassword: Joi.boolean().required()
+  validPassword: Joi.boolean().required(),
+  magicLinkGroupId: Joi.string().required()
 }).label('validateSavedLinkResponse')
 
 export const generateFormSubmissionsFileResponseSchema = Joi.object({

src/models/form.js

@@ -53,6 +53,7 @@ export async function prepareDb(logger) {
   const saveColl = db.collection(SAVE_AND_EXIT_COLLECTION_NAME)
 
   await saveColl.createIndex({ magicLinkId: 1 }, { unique: true })
+  await saveColl.createIndex({ magicLinkGroupId: 1 })
   await saveColl.createIndex({ expireAt: 1 }, { expireAfterSeconds: 0 }) // enables TTL
   await saveColl.createIndex({
     'notify.expireEmailSentTimestamp': 1,