@defra/forms-engine-plugin 2.0.1 → 2.0.3

package/src/server/plugins/engine/pageControllers/QuestionPageController.test.ts

@@ -1,6 +1,7 @@
 import { type PageQuestion } from '@defra/forms-model'
 import { type ResponseToolkit } from '@hapi/hapi'
 
+import { getCacheService } from '~/src/server/plugins/engine/helpers.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'
 import {
@@ -1333,63 +1334,127 @@ describe('Save and Return functionality', () => {
 
   describe('handleSaveAndReturn', () => {
     it('should save state and redirect to exit page', async () => {
+      const sessionPersisterMock = jest.fn()
       const state: FormSubmissionState = {
         $$__referenceNumber: 'foobar',
         yesNoField: true
       }
       const request = {
         ...requestPage1,
+        server: {
+          plugins: {
+            'forms-engine-plugin': {
+              saveAndReturn: {
+                sessionPersister: sessionPersisterMock
+              },
+              cacheService: {
+                clearState: jest.fn()
+              } as unknown as CacheService
+            }
+          }
+        },
         method: 'post',
         payload: { yesNoField: true, action: 'save-and-return' }
       } as unknown as FormRequestPayload
 
-      const context = model.getFormContext(request, state)
+      const cacheService = getCacheService(request.server)
 
-      jest.spyOn(controller1, 'setState').mockResolvedValue(state)
+      const context = model.getFormContext(request, state)
 
       await controller1.handleSaveAndReturn(request, context, h)
 
-      expect(controller1.setState).toHaveBeenCalledWith(request, state)
+      expect(sessionPersisterMock).toHaveBeenCalledWith(context.state, request)
+      expect(cacheService.clearState).toHaveBeenCalledWith(request)
       expect(h.redirect).toHaveBeenCalledWith('/test/exit')
     })
 
-    it('should handle save-and-return with incomplete data', async () => {
+    it('should throw if sessionPersister inside saveAndReturn options provided', async () => {
+      const sessionPersisterMock = jest.fn()
       const state: FormSubmissionState = {
         $$__referenceNumber: 'foobar',
-        yesNoField: null
+        yesNoField: true
       }
       const request = {
         ...requestPage1,
+        server: {
+          plugins: {
+            'forms-engine-plugin': {
+              // No sessionPersister object
+              saveAndReturn: {}
+            }
+          }
+        },
         method: 'post',
-        payload: { yesNoField: '', action: 'save-and-return' }
+        payload: { yesNoField: true, action: 'save-and-return' }
       } as unknown as FormRequestPayload
 
       const context = model.getFormContext(request, state)
 
-      jest.spyOn(controller1, 'setState').mockResolvedValue(state)
+      await expect(
+        controller1.handleSaveAndReturn(request, context, h)
+      ).rejects.toThrow('Server misconfigured for save and return')
 
-      await controller1.handleSaveAndReturn(request, context, h)
+      expect(sessionPersisterMock).not.toHaveBeenCalled()
+      expect(h.redirect).not.toHaveBeenCalled()
+    })
 
-      expect(controller1.setState).toHaveBeenCalledWith(request, state)
-      expect(h.redirect).toHaveBeenCalledWith('/test/exit')
+    it('should throw if no saveAndReturn options provided', async () => {
+      const sessionPersisterMock = jest.fn()
+      const state: FormSubmissionState = {
+        $$__referenceNumber: 'foobar',
+        yesNoField: true
+      }
+      const request = {
+        ...requestPage1,
+        server: {
+          plugins: {
+            'forms-engine-plugin': {
+              // No saveAndReturn object
+            }
+          }
+        },
+        method: 'post',
+        payload: { yesNoField: true, action: 'save-and-return' }
+      } as unknown as FormRequestPayload
+
+      const context = model.getFormContext(request, state)
+
+      await expect(
+        controller1.handleSaveAndReturn(request, context, h)
+      ).rejects.toThrow('Server misconfigured for save and return')
+
+      expect(sessionPersisterMock).not.toHaveBeenCalled()
+      expect(h.redirect).not.toHaveBeenCalled()
     })
 
-    it('should handle save-and-return with validation errors', async () => {
+    it('should throw if sessionPersister throws as well with validation errors', async () => {
+      const sessionPersisterMock = jest.fn().mockImplementation(() => {
+        throw new Error('Session persister error')
+      })
       const state: FormSubmissionState = { $$__referenceNumber: 'foobar' }
       const request = {
         ...requestPage1,
         method: 'post',
+        server: {
+          plugins: {
+            'forms-engine-plugin': {
+              saveAndReturn: {
+                sessionPersister: sessionPersisterMock
+              }
+            }
+          }
+        },
         payload: { action: 'save-and-return' }
       } as unknown as FormRequestPayload
 
       const context = model.getFormContext(request, state)
 
-      jest.spyOn(controller1, 'setState').mockResolvedValue(state)
-
-      await controller1.handleSaveAndReturn(request, context, h)
+      await expect(
+        controller1.handleSaveAndReturn(request, context, h)
+      ).rejects.toThrow('Session persister error')
 
-      expect(controller1.setState).toHaveBeenCalledWith(request, state)
-      expect(h.redirect).toHaveBeenCalledWith('/test/exit')
+      expect(sessionPersisterMock).toHaveBeenCalledWith(context.state, request)
+      expect(h.redirect).not.toHaveBeenCalledWith('/test/exit')
     })
   })
 

package/src/server/plugins/engine/pageControllers/QuestionPageController.ts

@@ -8,6 +8,7 @@ import {
   type Link,
   type Page
 } from '@defra/forms-model'
+import Boom from '@hapi/boom'
 import { type ResponseToolkit, type RouteOptions } from '@hapi/hapi'
 import { type ValidationErrorItem } from 'joi'
 
@@ -17,6 +18,7 @@ import { type BackLink } from '~/src/server/plugins/engine/components/types.js'
 import {
   getCacheService,
   getErrors,
+  getSaveAndReturnHelpers,
   normalisePath,
   proceed
 } from '~/src/server/plugins/engine/helpers.js'
@@ -548,7 +550,17 @@ export class QuestionPageController extends PageController {
     const { state } = context
 
     // Save the current state and redirect to exit page
-    await this.setState(request, state)
+    const saveAndReturn = getSaveAndReturnHelpers(request.server)
+
+    if (!saveAndReturn?.sessionPersister) {
+      throw Boom.internal('Server misconfigured for save and return')
+    }
+
+    await saveAndReturn.sessionPersister(state, request)
+
+    const cacheService = getCacheService(request.server)
+    await cacheService.clearState(request)
+
     return h.redirect(this.getHref('/exit'))
   }
 

package/src/server/plugins/engine/pageControllers/SummaryPageController.ts

@@ -105,7 +105,6 @@ export class SummaryPageController extends QuestionPageController {
     ) => {
       const { model } = this
       const { params } = request
-      const { state } = context
       const cacheService = getCacheService(request.server)
 
       const { formsService } = this.model.services
@@ -121,7 +120,7 @@ export class SummaryPageController extends QuestionPageController {
       // Send submission email
       if (emailAddress) {
         const viewModel = this.getSummaryViewModel(request, context)
-        await submitForm(request, viewModel, model, state, emailAddress)
+        await submitForm(context, request, viewModel, model, emailAddress)
       }
 
       await cacheService.setConfirmationState(request, { confirmed: true })
@@ -147,13 +146,13 @@ export class SummaryPageController extends QuestionPageController {
 }
 
 async function submitForm(
+  context: FormContext,
   request: FormRequestPayload,
   summaryViewModel: SummaryViewModel,
   model: FormModel,
-  state: FormSubmissionState,
   emailAddress: string
 ) {
-  await extendFileRetention(model, state, emailAddress)
+  await extendFileRetention(model, context.state, emailAddress)
 
   const formStatus = checkFormStatus(request.params)
   const logTags = ['submit', 'submissionApi']
@@ -180,6 +179,7 @@ async function submitForm(
   }
 
   return model.services.outputService.submit(
+    context,
     request,
     model,
     emailAddress,

package/src/server/plugins/engine/plugin.ts

@@ -43,8 +43,7 @@ export const plugin = {
       cacheName,
       options: {
         keyGenerator: saveAndReturn?.keyGenerator,
-        sessionHydrator: saveAndReturn?.sessionHydrator,
-        sessionPersister: saveAndReturn?.sessionPersister
+        sessionHydrator: saveAndReturn?.sessionHydrator
       }
     })
 

package/src/server/plugins/engine/routes/questions.ts

@@ -71,7 +71,7 @@ function makeGetHandler(
         )
 
         // @ts-expect-error - function signature will be refactored in the next iteration of the formatter
-        const payload = format(items, model, undefined, undefined)
+        const payload = format(context, items, model, undefined, undefined)
         const opts = { payload }
 
         if (preparePageEventRequestOptions) {

package/src/server/plugins/engine/services/notifyService.test.ts

@@ -3,6 +3,7 @@ import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js'
 import { getFormatter } from '~/src/server/plugins/engine/outputFormatters/index.js'
 import { submit } from '~/src/server/plugins/engine/services/notifyService.js'
+import { type FormContext } from '~/src/server/plugins/engine/types.js'
 import {
   FormStatus,
   type FormRequestPayload
@@ -36,6 +37,7 @@ describe('notifyService', () => {
   } as unknown as FormRequestPayload)
   let model: FormModel
   const sendNotificationMock = jest.mocked(sendNotification)
+  const formContext = {} as FormContext
 
   beforeEach(() => {
     jest.resetAllMocks()
@@ -58,7 +60,14 @@ describe('notifyService', () => {
     })
     jest.mocked(getFormatter).mockReturnValue(() => 'dummy-live')
 
-    await submit(mockRequest, model, 'test@defra.gov.uk', items, submitResponse)
+    await submit(
+      formContext,
+      mockRequest,
+      model,
+      'test@defra.gov.uk',
+      items,
+      submitResponse
+    )
 
     expect(sendNotificationMock).toHaveBeenCalledWith(
       expect.objectContaining({
@@ -87,7 +96,14 @@ describe('notifyService', () => {
     })
     jest.mocked(getFormatter).mockReturnValue(() => 'dummy-preview')
 
-    await submit(mockRequest, model, 'test@defra.gov.uk', items, submitResponse)
+    await submit(
+      formContext,
+      mockRequest,
+      model,
+      'test@defra.gov.uk',
+      items,
+      submitResponse
+    )
 
     expect(sendNotificationMock).toHaveBeenCalledWith(
       expect.objectContaining({
@@ -118,7 +134,14 @@ describe('notifyService', () => {
       .mocked(getFormatter)
       .mockReturnValue(() => 'dummy-preview " Hello world \' !@/')
 
-    await submit(mockRequest, model, 'test@defra.gov.uk', items, submitResponse)
+    await submit(
+      formContext,
+      mockRequest,
+      model,
+      'test@defra.gov.uk',
+      items,
+      submitResponse
+    )
 
     expect(sendNotificationMock).toHaveBeenCalledWith(
       expect.objectContaining({

package/src/server/plugins/engine/services/notifyService.ts

@@ -6,12 +6,14 @@ import { checkFormStatus } from '~/src/server/plugins/engine/helpers.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js'
 import { getFormatter } from '~/src/server/plugins/engine/outputFormatters/index.js'
+import { type FormContext } from '~/src/server/plugins/engine/types.js'
 import { type FormRequestPayload } from '~/src/server/routes/types.js'
 import { sendNotification } from '~/src/server/utils/notify.js'
 
 const templateId = config.get('notifyTemplateId')
 
 export async function submit(
+  context: FormContext,
   request: FormRequestPayload,
   model: FormModel,
   emailAddress: string,
@@ -33,7 +35,7 @@ export async function submit(
   const outputVersion = model.def.output?.version ?? '1'
 
   const outputFormatter = getFormatter(outputAudience, outputVersion)
-  let body = outputFormatter(items, model, submitResponse, formStatus)
+  let body = outputFormatter(context, items, model, submitResponse, formStatus)
 
   // GOV.UK Notify transforms quotes into curly quotes, so we can't just send the raw payload
   // This is logic specific to Notify, so we include the logic here rather than in the formatter

package/src/server/plugins/engine/types.ts

@@ -370,7 +370,6 @@ export interface PluginOptions {
     keyGenerator: (request: RequestType) => string
     sessionHydrator: (request: RequestType) => Promise<FormSubmissionState>
     sessionPersister: (
-      key: string,
       state: FormSubmissionState,
       request: RequestType
     ) => Promise<void>

package/src/server/services/cacheService.test.ts

@@ -136,7 +136,7 @@ describe('CacheService', () => {
   })
 
   describe('setState', () => {
-    it('should set state with correct TTL', async () => {
+    it('should set state with correct TTL and return updated state', async () => {
       const mockRequest = {
         yar: { id: 'some-session' },
         params: { state: 'form1', slug: 'page1' }
@@ -146,7 +146,12 @@ describe('CacheService', () => {
 
       jest.spyOn(config, 'get').mockReturnValue(mockTTL)
 
-      await cacheService.setState(mockRequest, mockState)
+      // Mock getState to return the updated state after set
+      jest.spyOn(cacheService, 'getState').mockResolvedValue(mockState)
+
+      await expect(
+        cacheService.setState(mockRequest, mockState)
+      ).resolves.toEqual(mockState)
 
       expect(mockCache.set).toHaveBeenCalledWith(
         {
@@ -156,6 +161,7 @@ describe('CacheService', () => {
         mockState,
         mockTTL
       )
+      expect(cacheService.getState).toHaveBeenCalledWith(mockRequest)
     })
   })
 

package/src/server/services/cacheService.ts

@@ -30,12 +30,6 @@ export class CacheService {
     request: Request | FormRequest | FormRequestPayload
   ) => Promise<FormSubmissionState | null>
 
-  customPersister?: (
-    key: string,
-    state: FormSubmissionState,
-    request: Request | FormRequest | FormRequestPayload
-  ) => Promise<void>
-
   logger: Server['logger']
 
   constructor({
@@ -52,14 +46,9 @@ export class CacheService {
       sessionHydrator?: (
         request: Request | FormRequest | FormRequestPayload
       ) => Promise<FormSubmissionState | null>
-      sessionPersister?: (
-        key: string,
-        state: FormSubmissionState,
-        request: Request | FormRequest | FormRequestPayload
-      ) => Promise<void>
     }
   }) {
-    const { keyGenerator, sessionHydrator, sessionPersister } = options ?? {}
+    const { keyGenerator, sessionHydrator } = options ?? {}
     if (!cacheName) {
       server.log(
         'warn',
@@ -68,7 +57,6 @@ export class CacheService {
     }
     this.generateKey = keyGenerator ?? this.defaultKeyGenerator.bind(this)
     this.customFetcher = sessionHydrator ?? undefined
-    this.customPersister = sessionPersister ?? undefined
     this.cache = server.cache({ cache: cacheName, segment: 'formSubmission' })
     this.logger = server.logger
   }

package/src/server/types.ts

@@ -9,6 +9,7 @@ import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js'
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
 import {
+  type FormContext,
   type OnRequestCallback,
   type PluginOptions,
   type PreparePageEventRequestOptions
@@ -53,6 +54,7 @@ export interface RouteConfig {
 
 export interface OutputService {
   submit: (
+    context: FormContext,
     request: FormRequestPayload,
     model: FormModel,
     emailAddress: string,