Updates to Fix Issues from Improved Forms Engine Plugin Package (#1109)

Scullyon · web-flow · commit a086307ec6d6 · 2026-04-21T15:37:58.000+01:00
* Updates to resolve type issues (when forms-engine-plugin package has relative paths, making types better resolvable)
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -46,7 +46,7 @@
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
     "@aws-sdk/client-sns": "^3.997.0",
-    "@defra/forms-engine-plugin": "^4.7.2",
+    "@defra/forms-engine-plugin": "^4.7.3",
     "@defra/forms-model": "^3.0.647",
     "@defra/hapi-tracing": "^1.30.0",
     "@elastic/ecs-pino-format": "^1.5.0",
diff --git a/src/server/index.test.ts b/src/server/index.test.ts
@@ -494,7 +494,7 @@ describe('Model cache', () => {
     const mockYar = {
       flash: mockFlash
     }
-    const mockRequest = /** @type {any} */ {
+    const mockRequest = {
       params: {
         slug: 'test-form'
       },
@@ -511,6 +511,7 @@ describe('Model cache', () => {
       expect(pluginObject).toBeDefined()
       const saveAndExitFunc = pluginObject.options.saveAndExit
       expect(saveAndExitFunc).toBeDefined()
+      // @ts-expect-error - partial mock objects for tests
       saveAndExitFunc(mockRequest, mockH, undefined)
       expect(mockFlash).toHaveBeenCalledWith(
         'SAVE_AND_EXIT_PAYLOAD',
diff --git a/src/server/messaging/formAdapterEventPublisher.test.js b/src/server/messaging/formAdapterEventPublisher.test.js
@@ -1,4 +1,5 @@
 import { PublishCommand } from '@aws-sdk/client-sns'
+import { FormStatus } from '@defra/forms-model'
 
 import { publishFormAdapterEvent } from '~/src/server/messaging/formAdapterEventPublisher.js'
 import { getSNSClient } from '~/src/server/messaging/sns.js'
@@ -33,7 +34,7 @@ const basePayload = {
     formSlug: 'test-form',
     formName: 'Test Form',
     referenceNumber: 'REF-123456',
-    status: 'live',
+    status: FormStatus.Live,
     isPreview: false,
     notificationEmail: 'test@example.com'
   },
@@ -54,7 +55,7 @@ describe('formAdapterEventPublisher', () => {
   /** @type {FormAdapterSubmissionMessagePayload} */
   let mockPayload
 
-  /** @type {any} */
+  /** @type {{ send: jest.Mock }} */
   let mockSnsClient
 
   beforeEach(() => {
@@ -65,10 +66,14 @@ describe('formAdapterEventPublisher', () => {
       meta: { ...basePayload.meta }
     })
 
-    mockSnsClient = {
-      send: jest.fn()
-    }
-    jest.mocked(getSNSClient).mockReturnValue(mockSnsClient)
+    mockSnsClient = { send: jest.fn() }
+    jest
+      .mocked(getSNSClient)
+      .mockReturnValue(
+        /** @type {import('@aws-sdk/client-sns').SNSClient} */ (
+          /** @type {unknown} */ (mockSnsClient)
+        )
+      )
   })
 
   describe('publishFormAdapterEvent', () => {
@@ -123,7 +128,7 @@ describe('formAdapterEventPublisher', () => {
             formSlug: 'complex-form',
             formName: 'Complex Form',
             referenceNumber: 'COMPLEX-REF',
-            status: 'live',
+            status: FormStatus.Live,
             isPreview: false,
             notificationEmail: 'complex@example.com'
           },
@@ -263,12 +268,18 @@ describe('per-form topic routing (SNS_FORM_TOPIC_ARN_MAP)', () => {
     meta: { ...basePayload.meta, formId: mappedFormId }
   }
 
-  /** @type {any} */
+  /** @type {{ send: jest.Mock }} */
   let mockSnsClient
 
   beforeEach(() => {
     mockSnsClient = { send: jest.fn() }
-    jest.mocked(getSNSClient).mockReturnValue(mockSnsClient)
+    jest
+      .mocked(getSNSClient)
+      .mockReturnValue(
+        /** @type {import('@aws-sdk/client-sns').SNSClient} */ (
+          /** @type {unknown} */ (mockSnsClient)
+        )
+      )
   })
 
   it('publishes to form-specific topic in addition to global topic when formId is mapped', async () => {
diff --git a/src/server/messaging/formAdapterEventPublisher.ts b/src/server/messaging/formAdapterEventPublisher.ts
@@ -17,7 +17,7 @@ const snsFormTopicArnMap: Record<string, string> = snsFormTopicArnMapRaw
  * Validate form adapter submission payload against schema
  * @param submissionPayload - Form submission payload to validate
  * @returns Validated payload
- * @throws Error if validation fails
+ * @throws {Error} if validation fails
  */
 function validateFormAdapterPayload(
   submissionPayload: FormAdapterSubmissionMessagePayload
diff --git a/src/server/models/FeedbackPageViewModel.ts b/src/server/models/FeedbackPageViewModel.ts
@@ -0,0 +1,9 @@
+import { type FormPageViewModel } from '@defra/forms-engine-plugin/types'
+
+/**
+ * Extends {@link FormPageViewModel} with template variables specific to the feedback page.
+ */
+export interface FeedbackPageViewModel extends FormPageViewModel {
+  hidePhaseBanner?: boolean
+  submitButtonText: string
+}
diff --git a/src/server/models/SummaryViewModelWithEmail.ts b/src/server/models/SummaryViewModelWithEmail.ts
@@ -0,0 +1,10 @@
+import { type SummaryViewModel } from '@defra/forms-engine-plugin/engine/models/SummaryViewModel.js'
+import { type GovukField } from '@defra/forms-model'
+
+/**
+ * Extends {@link SummaryViewModel} with an optional confirmation email field
+ * rendered on the summary page when the user opts in to receive a confirmation email.
+ */
+export interface SummaryViewModelWithEmail extends SummaryViewModel {
+  userConfirmationEmailField?: GovukField
+}
diff --git a/src/server/plugins/FeedbackPageController.test.ts b/src/server/plugins/FeedbackPageController.test.ts
@@ -21,10 +21,11 @@ describe('FeedbackPageController', () => {
   const response = {
     code: jest.fn().mockImplementation(() => response)
   }
-  const h: FormResponseToolkit = {
+  const h = {
     redirect: jest.fn().mockReturnValue(response),
-    view: jest.fn()
-  }
+    view: jest.fn(),
+    continue: Symbol('continue')
+  } as unknown as FormResponseToolkit
 
   beforeEach(() => {
     model = new FormModel(definition, {
@@ -70,11 +71,12 @@ describe('FeedbackPageController', () => {
         errors: [
           {
             name: 'PMPyjg',
-            path: '/feedback',
-            text: 'Select how you feel about this service'
+            path: ['feedback'],
+            text: 'Select how you feel about this service',
+            href: '#PMPyjg'
           }
         ]
-      } as FormContext
+      } as unknown as FormContext
 
       jest
         .spyOn(controller as unknown as QuestionPageController, 'getState')
diff --git a/src/server/plugins/FeedbackPageController.ts b/src/server/plugins/FeedbackPageController.ts
@@ -6,24 +6,25 @@ import {
   type FormContextRequest
 } from '@defra/forms-engine-plugin/engine/types.js'
 import {
-  type FormPageViewModel,
   type FormRequestPayload,
   type FormResponseToolkit
 } from '@defra/forms-engine-plugin/types'
 
+import { type FeedbackPageViewModel } from '~/src/server/models/FeedbackPageViewModel.js'
+
 export class FeedbackPageController extends QuestionPageController {
   allowSaveAndExit = false
 
   getViewModel(
     request: FormContextRequest,
     context: FormContext
-  ): FormPageViewModel {
+  ): FeedbackPageViewModel {
     const viewModel = super.getViewModel(request, context)
     return {
       ...viewModel,
       hidePhaseBanner: true,
       submitButtonText: 'Send feedback',
-      name: context.state.formName
+      name: context.state.formName as string | undefined
     }
   }
 
@@ -63,10 +64,11 @@ export class FeedbackPageController extends QuestionPageController {
       // Save state
       await this.setState(request, state)
 
-      const summary = new SummaryPageController(
-        model,
-        context.pageMap.get(context.paths[0])
-      )
+      const pageController = context.pageMap.get(context.paths[0])
+      if (!pageController) {
+        throw new Error('Summary page controller not found')
+      }
+      const summary = new SummaryPageController(model, pageController.pageDef)
       return summary.handleFormSubmit(request, context, h)
     }
   }
diff --git a/src/server/plugins/SummaryPageWithConfirmationEmailController.test.ts b/src/server/plugins/SummaryPageWithConfirmationEmailController.test.ts
@@ -27,10 +27,11 @@ describe('SummaryPageWithConfirmationEmailController', () => {
   const response = {
     code: jest.fn().mockImplementation(() => response)
   }
-  const h: FormResponseToolkit = {
+  const h = {
     redirect: jest.fn().mockReturnValue(response),
-    view: jest.fn()
-  }
+    view: jest.fn(),
+    continue: Symbol('continue')
+  } as unknown as FormResponseToolkit
 
   beforeEach(() => {
     model = new FormModel(definition, {
diff --git a/src/server/plugins/SummaryPageWithConfirmationEmailController.ts b/src/server/plugins/SummaryPageWithConfirmationEmailController.ts
@@ -1,7 +1,6 @@
 import { type PageController } from '@defra/forms-engine-plugin/controllers/PageController.js'
 import { type QuestionPageController } from '@defra/forms-engine-plugin/controllers/QuestionPageController.js'
 import { SummaryPageController } from '@defra/forms-engine-plugin/controllers/SummaryPageController.js'
-import { type SummaryViewModel } from '@defra/forms-engine-plugin/engine/models/SummaryViewModel.js'
 import {
   type FormContext,
   type FormContextRequest,
@@ -17,6 +16,8 @@ import {
 import { preventUnicodeInEmail, type GovukField } from '@defra/forms-model'
 import Joi, { type CustomHelpers } from 'joi'
 
+import { type SummaryViewModelWithEmail } from '~/src/server/models/SummaryViewModelWithEmail.js'
+
 export const CONFIRMATION_EMAIL_FIELD_NAME = 'userConfirmationEmailAddress'
 
 const schema = Joi.object().keys({
@@ -42,9 +43,12 @@ export class SummaryPageWithConfirmationEmailController extends SummaryPageContr
   getSummaryViewModel(
     request: FormContextRequest,
     context: FormContext
-  ): SummaryViewModel {
-    const viewModel = super.getSummaryViewModel(request, context)
-    const payerEmail = viewModel?.paymentState?.payerEmail
+  ): SummaryViewModelWithEmail {
+    const viewModel = super.getSummaryViewModel(
+      request,
+      context
+    ) as SummaryViewModelWithEmail
+    const payerEmail = viewModel.paymentState?.payerEmail
     // Fill in user confirmation email, if supplied from payment journey
     if (payerEmail) {
       const payload = (request.payload ?? {}) as FormPayload
diff --git a/src/server/plugins/router.ts b/src/server/plugins/router.ts
@@ -170,7 +170,7 @@ export default {
         options
       })
 
-      server.route<{ Params: { slug: string } }>({
+      server.route({
         method: 'get',
         path: '/help/cookies/{slug}',
         async handler(request, h) {
@@ -182,7 +182,7 @@ export default {
 
           const state = await cacheService.getState(request)
 
-          const formId = state?.formId ?? ''
+          const formId = (state.formId ?? '') as string
 
           return h.view('help/cookies', {
             googleAnalyticsContainerId: config.get(
diff --git a/src/server/routes/save-and-exit-with-cache.test.js b/src/server/routes/save-and-exit-with-cache.test.js
@@ -1,4 +1,5 @@
 import { getCacheService } from '@defra/forms-engine-plugin/engine/helpers.js'
+import { FormStatus } from '@defra/forms-model'
 import { StatusCodes } from 'http-status-codes'
 
 import { createServer } from '~/src/server/index.js'
@@ -82,7 +83,7 @@ describe('Save-and-exit check routes', () => {
         // @ts-expect-error - allow partial objects for tests
         form: {
           id: FORM_ID,
-          status: 'draft',
+          status: FormStatus.Draft,
           isPreview: true
         }
       })
diff --git a/src/server/routes/save-and-exit.js b/src/server/routes/save-and-exit.js
@@ -88,7 +88,9 @@ export default [
       // (in case the current page wasn't yet validated and saved).
       // The current page state may be invalid so we don't want to push into the cache as normal properties.
       const cacheService = getCacheService(request.server)
-      const formState = await cacheService.getState(request)
+      const formState = await cacheService.getState(
+        /** @type {CacheRequest} */ (request)
+      )
 
       // Handle the user navigating back from previously submitting a save-and-exit. The state has been cleared
       // so just show the form from the start
@@ -118,7 +120,10 @@ export default [
             mergeArrays: false
           }
         )
-        await cacheService.setState(request, combinedState)
+        await cacheService.setState(
+          /** @type {CacheRequest} */ (request),
+          combinedState
+        )
       }
 
       // Clear any previous save and exit session state
@@ -152,7 +157,9 @@ export default [
         question: securityQuestion,
         answer: securityAnswer
       }
-      const state = await cacheService.getState(request)
+      const state = await cacheService.getState(
+        /** @type {CacheRequest} */ (request)
+      )
 
       const statusPath = status ? `/${status}` : ''
 
@@ -181,7 +188,7 @@ export default [
       )
 
       // Clear all form data
-      await cacheService.clearState(request)
+      await cacheService.clearState(/** @type {CacheRequest} */ (request))
 
       // Add email to session for the confirmation page
       request.yar.set(getKey(slug, status), email)
@@ -410,7 +417,7 @@ export default [
       if (validatedLink.validPassword) {
         // Restore state
         const cacheService = getCacheService(request.server)
-        await cacheService.setState(request, {
+        await cacheService.setState(/** @type {CacheRequest} */ (request), {
           ...validatedLink.state,
           [MAGIC_LINK_GROUP_ID]: validatedLink.magicLinkGroupId
         })
@@ -493,7 +500,10 @@ export default [
       const { params } = request
       const { slug, state } = params
       const form = await getFormMetadata(slug)
-      const model = resumeSuccessViewModel(form, state)
+      const model = resumeSuccessViewModel(
+        form,
+        /** @type {FormStatus | undefined} */ (state)
+      )
 
       return h.view(RESUME_SUCCESS, model)
     },
@@ -512,6 +522,7 @@ export default [
 
 /**
  * @import { ServerRoute } from '@hapi/hapi'
- * @import { FormPayload } from '@defra/forms-engine-plugin/engine/types.js'
+ * @import { CacheRequest, FormPayload } from '@defra/forms-engine-plugin/engine/types.js'
+ * @import { FormStatus } from '@defra/forms-model'
  * @import { BoomErrorCustomSaveAndExit, SaveAndExitParams, SaveAndExitPayload, SaveAndExitResumePasswordPayload, SaveAndExitResumePasswordParams } from '~/src/server/models/save-and-exit.js'
  */
diff --git a/src/server/routes/save-and-exit.test.js b/src/server/routes/save-and-exit.test.js
diff --git a/src/server/services/outputService.test.js b/src/server/services/outputService.test.js
diff --git a/src/server/services/outputService.ts b/src/server/services/outputService.ts
diff --git a/test/form/feedback.test.js b/test/form/feedback.test.js
