feature/DF-370: Update save and exit plugin options, routes and message publication

package.json

@@ -41,9 +41,8 @@
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
     "@aws-sdk/client-sns": "^3.864.0",
-    "@defra/forms-engine-plugin": "^2.1.9",
-    "@defra/forms-model": "^3.0.545",
-    "@aws-sdk/client-s3": "^3.679.0",
+    "@defra/forms-engine-plugin": "^3.0.0",
+    "@defra/forms-model": "^3.0.550",
     "@defra/hapi-tracing": "^1.26.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",

src/config/index.ts

@@ -286,6 +286,11 @@ export const config = convict({
     format: String,
     default: '',
     env: 'GOOGLE_ANALYTICS_TRACKING_ID'
+  },
+  saveAndExitExpiryDays: {
+    format: Number,
+    default: 30,
+    env: 'SAVE_AND_EXIT_EXPIRY_IN_DAYS'
   }
 })
 

src/server/helpers/error-helper.js

@@ -0,0 +1,21 @@
+import Joi from 'joi'
+
+/**
+ * @param {string} fieldName
+ * @param {string} message
+ * @returns {Joi.ValidationError}
+ */
+export function createJoiError(fieldName, message) {
+  return new Joi.ValidationError(
+    message,
+    [
+      {
+        message,
+        path: [fieldName],
+        type: 'custom',
+        context: { key: fieldName, label: fieldName }
+      }
+    ],
+    {}
+  )
+}

src/server/index.test.ts

@@ -4,12 +4,12 @@ import {
   UploadStatus,
   type UploadStatusResponse
 } from '@defra/forms-engine-plugin/engine/types.js'
+import { FormStatus } from '@defra/forms-engine-plugin/types'
 import { type Server } from '@hapi/hapi'
 import { StatusCodes } from 'http-status-codes'
 
 import { FORM_PREFIX } from '~/src/server/constants.js'
 import { createServer } from '~/src/server/index.js'
-import { FormStatus } from '~/src/server/routes/types.js'
 import {
   getFormDefinition,
   getFormMetadata

src/server/index.ts

@@ -1,9 +1,15 @@
 import { join, parse } from 'path'
 
 import plugin from '@defra/forms-engine-plugin'
+import { checkFormStatus } from '@defra/forms-engine-plugin/engine/helpers.js'
 import { FormModel } from '@defra/forms-engine-plugin/engine/models/FormModel.js'
-import { type PluginOptions } from '@defra/forms-engine-plugin/engine/types.js'
 import { formSubmissionService } from '@defra/forms-engine-plugin/services/index.js'
+import {
+  type FormContext,
+  type FormRequestPayload,
+  type FormResponseToolkit,
+  type PluginOptions
+} from '@defra/forms-engine-plugin/types'
 import { type FormDefinition } from '@defra/forms-model'
 import { Engine as CatboxMemory } from '@hapi/catbox-memory'
 import { Engine as CatboxRedis } from '@hapi/catbox-redis'
@@ -129,15 +135,30 @@ export const configureEnginePlugin = async ({
   const pluginObject = {
     plugin,
     options: {
-      cacheName: 'session',
+      cache: 'session',
       nunjucks: {
         baseLayoutPath: 'layout.html',
         paths
       },
       model,
       services,
       viewContext: context,
-      baseUrl: config.get('baseUrl')
+      baseUrl: config.get('baseUrl'),
+      saveAndExit: (
+        request: FormRequestPayload,
+        h: FormResponseToolkit,
+        _context: FormContext
+      ) => {
+        const { params } = request
+        const { slug } = params
+        const { isPreview, state } = checkFormStatus(params)
+
+        return h.redirect(
+          !isPreview
+            ? `/save-and-exit/${slug}`
+            : `/save-and-exit/${slug}/${state}`
+        )
+      }
     }
   }
   const routeOptions = {

src/server/messaging/__stubs__/builder.js

@@ -16,16 +16,18 @@ export function buildSaveAndExitMessageData(
   partialSaveAndExitMessageData = {}
 ) {
   return {
-    formId: saveAndExitFormId,
+    form: {
+      id: 'formId',
+      title: 'My First Form',
+      isPreview: false,
+      status: FormStatus.Draft,
+      baseUrl: 'http://localhost:3009'
+    },
     security: {
       question: SecurityQuestionsEnum.MemorablePlace,
       answer: 'a1'
     },
     email: 'forms@example.com',
-    formStatus: {
-      status: FormStatus.Draft,
-      isPreview: false
-    },
     state: {},
     ...partialSaveAndExitMessageData
   }

src/server/messaging/mappers/events.js

@@ -1,25 +1,43 @@
 import {
+  FormStatus,
   SubmissionEventMessageCategory,
   SubmissionEventMessageSchemaVersion,
   SubmissionEventMessageSource,
   SubmissionEventMessageType
 } from '@defra/forms-model'
 
+import { config } from '~/src/config/index.js'
+
+const baseUrl = config.get('baseUrl')
+
 /**
  * @param { string } formId
+ * @param { string } formTitle
  * @param { string } email
  * @param {{ question: SecurityQuestionsEnum, answer: string }} security
- * @param {{ status: FormStatus, isPreview: boolean }} formStatus
  * @param { FormState } state
+ * @param { FormStatus } [status]
  * @returns {SaveAndExitMessage}
  */
-export function saveAndExitMapper(formId, email, security, formStatus, state) {
+export function saveAndExitMapper(
+  formId,
+  formTitle,
+  email,
+  security,
+  state,
+  status
+) {
   /** @type {SaveAndExitMessageData} */
   const data = {
-    formId,
+    form: {
+      id: formId,
+      title: formTitle,
+      status: status ?? FormStatus.Live,
+      isPreview: !!status,
+      baseUrl
+    },
     email,
     security,
-    formStatus,
     state
   }
   const now = new Date()
@@ -35,6 +53,6 @@ export function saveAndExitMapper(formId, email, security, formStatus, state) {
 }
 
 /**
- * @import { FormStatus, SaveAndExitMessage, SaveAndExitMessageData, SecurityQuestionsEnum } from '@defra/forms-model'
+ * @import { SaveAndExitMessage, SaveAndExitMessageData, SecurityQuestionsEnum } from '@defra/forms-model'
  * @import { FormState } from '@defra/forms-engine-plugin/engine/types.js'
  */

src/server/messaging/mappers/events.test.js

@@ -12,29 +12,36 @@ import { saveAndExitMapper } from '~/src/server/messaging/mappers/events.js'
 describe('runner-events', () => {
   describe('saveAndExitMapper', () => {
     it('should map a payload into a SAVE_AND_EXIT event', () => {
+      /**
+       * @type {import('@defra/forms-model').SaveAndExitMessageData}
+       */
       const payload = {
-        formId: 'formId',
+        form: {
+          id: 'formId',
+          title: 'My First Form',
+          isPreview: true,
+          status: FormStatus.Draft,
+          baseUrl: 'http://localhost:3009'
+        },
         email: 'my-email@here.com',
         security: {
           question: SecurityQuestionsEnum.CharacterName,
           answer: 'brown'
         },
-        formStatus: {
-          status: FormStatus.Draft,
-          isPreview: false
-        },
         state: {
           formVal1: '123',
           formVal2: '456'
         }
       }
+
       expect(
         saveAndExitMapper(
-          payload.formId,
+          payload.form.id,
+          payload.form.title,
           payload.email,
           payload.security,
-          payload.formStatus,
-          payload.state
+          payload.state,
+          payload.form.status
         )
       ).toEqual({
         schemaVersion: SubmissionEventMessageSchemaVersion.V1,
@@ -44,16 +51,18 @@ describe('runner-events', () => {
         createdAt: expect.any(Date),
         messageCreatedAt: expect.any(Date),
         data: {
-          formId: payload.formId,
+          form: {
+            id: payload.form.id,
+            title: payload.form.title,
+            isPreview: payload.form.isPreview,
+            status: payload.form.status,
+            baseUrl: 'http://localhost:3009'
+          },
           email: payload.email,
           security: {
             question: payload.security.question,
             answer: payload.security.answer
           },
-          formStatus: {
-            status: payload.formStatus.status,
-            isPreview: payload.formStatus.isPreview
-          },
           state: payload.state
         }
       })

src/server/messaging/publish-base.js

@@ -23,7 +23,7 @@ export async function publishEvent(message) {
   const result = await client.send(command)
 
   logger.info(
-    `Published ${message.type} event for formId ${message.data.formId}. MessageId: ${result.MessageId}`
+    `Published ${message.type} event for formId ${message.data.form.id}. MessageId: ${result.MessageId}`
   )
 
   return result

src/server/messaging/publish.js

@@ -20,19 +20,28 @@ async function validateAndPublishEvent(saveAndExitMessage) {
  * Publish 'save and exit' event
  * The returned entityId will be a newly-generated guid
  * @param {string} formId
+ * @param {string} formTitle
  * @param {string} email
  * @param {{ question: SecurityQuestionsEnum, answer: string }} security
- * @param {{ status: FormStatus, isPreview: boolean }} formStatus
  * @param {FormState} state
+ * @param {FormStatus} [status]
  */
 export async function publishSaveAndExitEvent(
   formId,
+  formTitle,
   email,
   security,
-  formStatus,
-  state
+  state,
+  status
 ) {
-  const message = saveAndExitMapper(formId, email, security, formStatus, state)
+  const message = saveAndExitMapper(
+    formId,
+    formTitle,
+    email,
+    security,
+    state,
+    status
+  )
 
   return validateAndPublishEvent(message)
 }

src/server/messaging/publish.test.js

@@ -13,17 +13,22 @@ import { publishSaveAndExitEvent } from '~/src/server/messaging/publish.js'
 
 jest.mock('~/src/server/messaging/publish-base.js')
 
+/**
+ * @type {SaveAndExitMessageData}
+ */
 const saveAndExitPayload = {
-  formId: 'formId',
+  form: {
+    id: 'formId',
+    title: 'My First Form',
+    isPreview: true,
+    status: FormStatus.Draft,
+    baseUrl: 'http://localhost:3009'
+  },
   email: 'my-email@here.com',
   security: {
     question: SecurityQuestionsEnum.CharacterName,
     answer: 'brown'
   },
-  formStatus: {
-    status: FormStatus.Draft,
-    isPreview: true
-  },
   state: {
     formVal1: '123',
     formVal2: '456'
@@ -45,11 +50,12 @@ describe('publish', () => {
   describe('publishSaveAndExitEvent', () => {
     it('should publish SAVE_AND_EXIT event', async () => {
       await publishSaveAndExitEvent(
-        saveAndExitPayload.formId,
+        saveAndExitPayload.form.id,
+        saveAndExitPayload.form.title,
         saveAndExitPayload.email,
         saveAndExitPayload.security,
-        saveAndExitPayload.formStatus,
-        saveAndExitPayload.state
+        saveAndExitPayload.state,
+        saveAndExitPayload.form.status
       )
 
       expect(publishEvent).toHaveBeenCalledWith({
@@ -72,11 +78,15 @@ describe('publish', () => {
         publishSaveAndExitEvent(invalidPayload)
       ).rejects.toThrow(
         new ValidationError(
-          '"data.formId" must be a string. "data.email" is required. "data.state" is required',
+          '"data.form.id" must be a string. "data.form.title" is required. "data.email" is required. "data.state" is required',
           [],
           {}
         )
       )
     })
   })
 })
+
+/**
+ * @import { SaveAndExitMessageData } from '@defra/forms-model'
+ */