@defra/forms-engine-plugin 2.0.3 → 2.1.1

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

@@ -1,6 +1,7 @@
-import { hasFormComponents, slugSchema } from '@defra/forms-model'
+import { hasFormComponents, slugSchema, type Event } from '@defra/forms-model'
 import Boom from '@hapi/boom'
 import {
+  type ResponseObject,
   type ResponseToolkit,
   type RouteOptions,
   type ServerRoute
@@ -12,14 +13,21 @@ import {
   proceed,
   redirectPath
 } from '~/src/server/plugins/engine/helpers.js'
-import { SummaryViewModel } from '~/src/server/plugins/engine/models/index.js'
+import {
+  SummaryViewModel,
+  type FormModel
+} from '~/src/server/plugins/engine/models/index.js'
 import { format } from '~/src/server/plugins/engine/outputFormatters/machine/v1.js'
 import { getFormSubmissionData } from '~/src/server/plugins/engine/pageControllers/SummaryPageController.js'
+import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'
 import {
   dispatchHandler,
   redirectOrMakeHandler
 } from '~/src/server/plugins/engine/routes/index.js'
-import { type PreparePageEventRequestOptions } from '~/src/server/plugins/engine/types.js'
+import {
+  type FormContext,
+  type PreparePageEventRequestOptions
+} from '~/src/server/plugins/engine/types.js'
 import {
   type FormRequest,
   type FormRequestPayload,
@@ -35,7 +43,36 @@ import {
 } from '~/src/server/schemas/index.js'
 import * as httpService from '~/src/server/services/httpService.js'
 
-function makeGetHandler(
+async function handleHttpEvent(
+  request: FormRequest | FormRequestPayload,
+  page: PageControllerClass,
+  context: FormContext,
+  event: Event,
+  model: FormModel,
+  preparePageEventRequestOptions?: PreparePageEventRequestOptions
+) {
+  const { options } = event
+  const { url } = options
+
+  // TODO: Update structured data POST payload with when helper
+  // is updated to removing the dependency on `SummaryViewModel` etc.
+  const viewModel = new SummaryViewModel(request, page, context)
+  const items = getFormSubmissionData(viewModel.context, viewModel.details)
+
+  // @ts-expect-error - function signature will be refactored in the next iteration of the formatter
+  const payload = format(context, items, model, undefined, undefined)
+  const opts = { payload }
+
+  if (preparePageEventRequestOptions) {
+    preparePageEventRequestOptions(opts, event, page, context)
+  }
+
+  const { payload: response } = await httpService.postJson(url, opts)
+
+  Object.assign(context.data, response)
+}
+
+export function makeGetHandler(
   preparePageEventRequestOptions?: PreparePageEventRequestOptions
 ) {
   return function getHandler(
@@ -59,28 +96,14 @@ function makeGetHandler(
       }
 
       if (events?.onLoad && events.onLoad.type === 'http') {
-        const { options } = events.onLoad
-        const { url } = options
-
-        // TODO: Update structured data POST payload with when helper
-        // is updated to removing the dependency on `SummaryViewModel` etc.
-        const viewModel = new SummaryViewModel(request, page, context)
-        const items = getFormSubmissionData(
-          viewModel.context,
-          viewModel.details
+        await handleHttpEvent(
+          request,
+          page,
+          context,
+          events.onLoad,
+          model,
+          preparePageEventRequestOptions
         )
-
-        // @ts-expect-error - function signature will be refactored in the next iteration of the formatter
-        const payload = format(context, items, model, undefined, undefined)
-        const opts = { payload }
-
-        if (preparePageEventRequestOptions) {
-          preparePageEventRequestOptions(opts, events.onLoad, page, context)
-        }
-
-        const { payload: response } = await httpService.postJson(url, opts)
-
-        Object.assign(context.data, response)
       }
 
       return page.makeGetRouteHandler()(request, context, h)
@@ -88,23 +111,56 @@ function makeGetHandler(
   }
 }
 
-function postHandler(
-  request: FormRequestPayload,
-  h: Pick<ResponseToolkit, 'redirect' | 'view'>
+export function makePostHandler(
+  preparePageEventRequestOptions?: PreparePageEventRequestOptions
 ) {
-  const { query } = request
+  return function postHandler(
+    request: FormRequestPayload,
+    h: Pick<ResponseToolkit, 'redirect' | 'view'>
+  ) {
+    const { query } = request
 
-  return redirectOrMakeHandler(request, h, (page, context) => {
-    const { pageDef } = page
-    const { isForceAccess } = context
+    return redirectOrMakeHandler(request, h, async (page, context) => {
+      const { pageDef } = page
+      const { isForceAccess } = context
+      const { model } = request.app
+      const { events } = page
 
-    // Redirect to GET for preview URL direct access
-    if (isForceAccess && !hasFormComponents(pageDef)) {
-      return proceed(request, h, redirectPath(page.href, query))
-    }
+      // Redirect to GET for preview URL direct access
+      if (isForceAccess && !hasFormComponents(pageDef)) {
+        return proceed(request, h, redirectPath(page.href, query))
+      }
+
+      if (!model) {
+        throw Boom.notFound(`No model found for /${request.params.path}`)
+      }
+
+      const response = await page.makePostRouteHandler()(request, context, h)
+
+      if (
+        events?.onSave &&
+        events.onSave.type === 'http' &&
+        isSuccessful(response)
+      ) {
+        await handleHttpEvent(
+          request,
+          page,
+          context,
+          events.onSave,
+          model,
+          preparePageEventRequestOptions
+        )
+      }
+
+      return response
+    })
+  }
+}
+
+function isSuccessful(response: ResponseObject): boolean {
+  const { statusCode } = response
 
-    return page.makePostRouteHandler()(request, context, h)
-  })
+  return !Boom.isBoom(response) && statusCode >= 200 && statusCode < 400
 }
 
 export function getRoutes(
@@ -174,7 +230,7 @@ export function getRoutes(
     {
       method: 'post',
       path: '/{slug}/{path}/{itemId?}',
-      handler: postHandler,
+      handler: makePostHandler(preparePageEventRequestOptions),
       options: {
         ...postRouteOptions,
         validate: {
@@ -196,7 +252,7 @@ export function getRoutes(
     {
       method: 'post',
       path: '/preview/{state}/{slug}/{path}/{itemId?}',
-      handler: postHandler,
+      handler: makePostHandler(preparePageEventRequestOptions),
       options: {
         ...postRouteOptions,
         validate: {

package/src/server/plugins/engine/services/localFormsService.js

@@ -29,20 +29,19 @@ export const formsService = async () => {
   // Instantiate the file loader form service
   const loader = new FileFormService()
 
-  // Add a Json form
-  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.json', {
+  // Add a Yaml form
+  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.yaml', {
     ...metadata,
-    id: '95e92559-968d-44ae-8666-2b1ad3dffd31',
+    id: '641aeafd-13dd-40fa-9186-001703800efb',
     title: 'Register as a unicorn breeder',
     slug: 'register-as-a-unicorn-breeder'
   })
 
-  // Add a Yaml form
-  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.yaml', {
+  await loader.addForm('src/server/forms/page-events.yaml', {
     ...metadata,
-    id: '641aeafd-13dd-40fa-9186-001703800efb',
-    title: 'Register as a unicorn breeder (yaml)',
-    slug: 'register-as-a-unicorn-breeder-yaml' // if we needed to validate any JSON logic, make it available for convenience
+    id: '511db05e-ebbd-42e8-8270-5fe93f5c9762',
+    title: 'Page events demo',
+    slug: 'page-events-demo'
   })
 
   await loader.addForm('src/server/forms/components.json', {

package/src/server/routes/dummy-api.test.ts

@@ -0,0 +1,96 @@
+import { type Server } from '@hapi/hapi'
+// eslint-disable-next-line n/no-unpublished-import -- not sure why this is triggering, it's not a private module
+import MockDate from 'mockdate'
+
+import { createServer } from '~/src/server/index.js'
+
+describe('Dummy API', () => {
+  let server: Server
+
+  const payload = {
+    meta: {
+      referenceNumber: 'FOO-BAR-123'
+    },
+    data: {
+      main: {
+        applicantFirstName: 'Joe',
+        applicantLastName: 'Bloggs',
+        dateOfBirth: '2020-01-01'
+      }
+    }
+  }
+
+  beforeAll(async () => {
+    MockDate.set('2025-01-01T00:00:00Z')
+    server = await createServer()
+    await server.initialize()
+  })
+
+  afterAll(async () => {
+    await server.stop()
+    MockDate.reset()
+  })
+
+  it('should validate on-load-page POST response', async () => {
+    const res = await server.inject({
+      method: 'POST',
+      url: '/api/example/on-load-page',
+      payload
+    })
+
+    expect(res.statusCode).toBe(200)
+    expect(res.result).toMatchObject({
+      submissionEvent: 'GET',
+      submissionReferenceNumber: payload.meta.referenceNumber
+    })
+  })
+
+  /*
+  This is just dummy code that won't run in prod, we don't need a full suite of tests.
+  */
+  it('should validate on-summary POST response', async () => {
+    const res = await server.inject({
+      method: 'POST',
+      url: '/api/example/on-summary',
+      payload
+    })
+
+    expect(res.statusCode).toBe(200)
+    expect(res.result).toMatchObject({
+      calculatedAge: 5,
+      submissionEvent: 'POST',
+      submissionReferenceNumber: payload.meta.referenceNumber
+    })
+  })
+
+  it('should calculate age correctly when birthday has not occurred yet this year', async () => {
+    // Set today's date to just before the birthday in 2025
+    MockDate.set('2025-01-01T00:00:00Z')
+
+    const payloadWithFutureBirthday = {
+      meta: {
+        referenceNumber: 'FOO-BAR-456'
+      },
+      data: {
+        main: {
+          applicantFirstName: 'Jane',
+          applicantLastName: 'Doe',
+          dateOfBirth: '2020-02-01' // Birthday is in February, today is January
+        }
+      }
+    }
+
+    const res = await server.inject({
+      method: 'POST',
+      url: '/api/example/on-summary',
+      payload: payloadWithFutureBirthday
+    })
+
+    expect(res.statusCode).toBe(200)
+    expect(res.result).toMatchObject({
+      calculatedAge: 4, // Should be 4, not 5, because birthday hasn't occurred yet
+      submissionEvent: 'POST',
+      submissionReferenceNumber: payloadWithFutureBirthday.meta.referenceNumber
+    })
+  })
+})

package/src/server/routes/dummy-api.ts

@@ -0,0 +1,62 @@
+import { type Request, type ResponseToolkit } from '@hapi/hapi'
+
+function calculateAge(day: string, month: string, year: string) {
+  const dobDate = new Date(Number(day), Number(month) - 1, Number(year))
+
+  const today = new Date()
+
+  let age = today.getFullYear() - dobDate.getFullYear()
+  const m = today.getMonth() - dobDate.getMonth()
+
+  if (m < 0 || (m === 0 && today.getDate() < dobDate.getDate())) {
+    age--
+  }
+
+  return age
+}
+
+export default [
+  {
+    method: 'POST',
+    path: '/api/example/on-load-page',
+    handler(
+      request: Request<{ Payload: { meta: { referenceNumber: string } } }>,
+      _h: ResponseToolkit
+    ) {
+      return {
+        submissionEvent: 'GET',
+        submissionReferenceNumber: request.payload.meta.referenceNumber
+      }
+    }
+  },
+  {
+    method: 'POST',
+    path: '/api/example/on-summary',
+    handler(
+      request: Request<{
+        Payload: {
+          data: {
+            main: {
+              applicantFirstName: string
+              applicantLastName: string
+              dateOfBirth: string
+            }
+          }
+          meta: { event: string; referenceNumber: string }
+        }
+      }>,
+      _h: ResponseToolkit
+    ) {
+      const [day, month, year] =
+        request.payload.data.main.dateOfBirth.split('-')
+
+      const age = calculateAge(day, month, year)
+
+      return {
+        calculatedAge: age,
+        submissionEvent: 'POST',
+        submissionReferenceNumber: request.payload.meta.referenceNumber // example of receiving a payload from DXT
+      }
+    }
+  }
+]

package/src/server/routes/index.ts

@@ -1 +1,2 @@
 export { default as publicRoutes } from '~/src/server/routes/public.js'
+export { default as dummyApiRoutes } from '~/src/server/routes/dummy-api.js'