@defra/forms-engine-plugin 0.1.26 → 0.1.28

package/src/server/plugins/engine/models/FormModel.test.ts

@@ -1,13 +1,27 @@
+import {
+  SchemaVersion,
+  formDefinitionV2Schema,
+  type FormDefinition
+} from '@defra/forms-model'
+
+import { todayAsDateOnly } from '~/src/server/plugins/engine/date-helper.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { type FormContextRequest } from '~/src/server/plugins/engine/types.js'
 import { V2 as definitionV2 } from '~/test/form/definitions/conditions-basic.js'
 import definition from '~/test/form/definitions/conditions-escaping.js'
 import conditionsListDefinition from '~/test/form/definitions/conditions-list.js'
+import relativeDatesDefinition from '~/test/form/definitions/conditions-relative-dates-v2.js'
 import fieldsRequiredDefinition from '~/test/form/definitions/fields-required.js'
 
+jest.mock('~/src/server/plugins/engine/date-helper.ts')
+
 describe('FormModel', () => {
+  beforeEach(() => {
+    jest.resetAllMocks()
+  })
+
   describe('Constructor', () => {
-    it("doesn't throw when conditions are passed with apostrophes", () => {
+    it('loads a valid form definition', () => {
       expect(
         () => new FormModel(definition, { basePath: 'test' })
       ).not.toThrow()
@@ -26,6 +40,109 @@ describe('FormModel', () => {
       )
       expect(model.def.pages.at(1)?.title).toBe('Date of marriage')
     })
+
+    it('Gets a list by ID', () => {
+      jest.mock('@defra/forms-model')
+
+      const definitionWithLists: FormDefinition = {
+        ...definitionV2,
+        lists: [
+          {
+            id: 'c5eba145-b04d-4d41-a50c-e5e2f9b6357f',
+            type: 'string',
+            title: 'foo',
+            name: 'foo',
+            items: [
+              { text: 'a', value: 'a' },
+              { text: 'b', value: 'b' }
+            ]
+          },
+          {
+            type: 'string',
+            title: 'bar',
+            name: 'bar',
+            items: [
+              {
+                id: 'a85a42a8-3e08-4c2a-b263-a0dc0b8c49f6',
+                text: 'a',
+                value: 'a'
+              },
+              {
+                id: 'c31664ac-887b-434b-b9f4-e5bc30d24439',
+                text: 'b',
+                value: 'b'
+              }
+            ]
+          }
+        ]
+      }
+
+      formDefinitionV2Schema.validate = jest
+        .fn()
+        .mockReturnValue({ value: definitionWithLists })
+
+      const model = new FormModel(definitionWithLists, { basePath: 'test' })
+
+      expect(
+        model.getListById('c5eba145-b04d-4d41-a50c-e5e2f9b6357f')
+      ).toBeDefined()
+      expect(model.listDefIdMap.size).toBe(2) // 1 + the yes/no list. list 'bar' isn't present as there's no ID
+    })
+
+    it('Gets a component by ID', () => {
+      jest.mock('@defra/forms-model')
+
+      formDefinitionV2Schema.validate = jest
+        .fn()
+        .mockReturnValue({ value: definitionV2 })
+
+      const model = new FormModel(definitionV2, { basePath: 'test' })
+
+      expect(
+        model.getComponentById('717eb213-4e4b-4a2d-9cfd-2780f5e1e3e5')
+      ).toBeDefined()
+      expect(model.listDefIdMap.size).toBe(1)
+    })
+
+    it('gets a condition by its ID', () => {
+      jest.mock('@defra/forms-model')
+      formDefinitionV2Schema.validate = jest
+        .fn()
+        .mockReturnValue({ value: definitionV2 })
+      const model = new FormModel(definitionV2, { basePath: 'test' })
+
+      expect(
+        model.getConditionById('6c9e2f4a-1d7b-5e8c-3f6a-9e2d5b7c4f1a')
+      ).toBeDefined()
+    })
+
+    it('throws an error if schema validation fails', () => {
+      jest.mock('@defra/forms-model')
+
+      formDefinitionV2Schema.validate = jest.fn().mockReturnValueOnce({
+        error: 'Validation error'
+      })
+
+      expect(() => new FormModel(definitionV2, { basePath: 'test' })).toThrow(
+        'Validation error'
+      )
+    })
+
+    it('assigns v1 to the schema if not defined', () => {
+      const definitionWithoutSchema: FormDefinition = {
+        ...definition,
+        schema: undefined
+      }
+
+      // Mock validation to just return the definition
+      formDefinitionV2Schema.validate = jest
+        .fn()
+        .mockReturnValue({ value: definitionWithoutSchema })
+
+      const model = new FormModel(definitionWithoutSchema, { basePath: 'test' })
+
+      expect(model.schemaVersion).toBe(SchemaVersion.V1)
+    })
   })
 
   describe('getFormContext', () => {
@@ -184,4 +301,49 @@ describe('FormModel', () => {
       })
     })
   })
+
+  describe('makeCondition', () => {
+    test('relative date condition', () => {
+      jest.mock('@defra/forms-model')
+      formDefinitionV2Schema.validate = jest
+        .fn()
+        .mockReturnValue({ value: relativeDatesDefinition })
+      const model = new FormModel(relativeDatesDefinition, { basePath: 'test' })
+
+      const allConditionsKeys = Object.keys(model.conditions)
+      expect(allConditionsKeys).toHaveLength(8)
+
+      // Only test releative date conditions
+      const relativeConditionsKeys = allConditionsKeys.slice(4)
+      expect(relativeConditionsKeys).toHaveLength(4)
+
+      const formState = {
+        ybMHIv: '2023-06-18'
+      }
+
+      const expectedResultsDayBefore = [true, false, false, true]
+
+      const expectedResultsDayOf = [true, true, false, false]
+
+      const expectedResultsDayAfter = [false, true, true, false]
+
+      // Only relative date conditions
+      for (let i = 0; i < relativeConditionsKeys.length; i++) {
+        const condition = model.conditions[relativeConditionsKeys[i]]
+        jest.mocked(todayAsDateOnly).mockReturnValue(new Date(2025, 5, 19))
+        const conditionExec = model.makeCondition(
+          // @ts-expect-error - type doesnt need to match for this test
+          condition
+        )
+        formState.ybMHIv = '2023-06-18'
+        expect(conditionExec.fn(formState)).toBe(expectedResultsDayBefore[i])
+
+        formState.ybMHIv = '2023-06-19'
+        expect(conditionExec.fn(formState)).toBe(expectedResultsDayOf[i])
+
+        formState.ybMHIv = '2023-06-20'
+        expect(conditionExec.fn(formState)).toBe(expectedResultsDayAfter[i])
+      }
+    })
+  })
 })

package/src/server/plugins/engine/models/FormModel.ts

@@ -4,26 +4,35 @@ import {
   ControllerPath,
   ControllerType,
   Engine,
+  SchemaVersion,
+  convertConditionWrapperFromV2,
   formDefinitionSchema,
+  formDefinitionV2Schema,
   hasComponents,
   hasRepeater,
+  isConditionWrapperV2,
+  yesNoListId,
+  yesNoListName,
   type ComponentDef,
   type ConditionWrapper,
+  type ConditionWrapperV2,
   type ConditionsModelData,
   type DateUnits,
   type FormDefinition,
   type List,
   type Page
 } from '@defra/forms-model'
-import { add } from 'date-fns'
+import { add, format } from 'date-fns'
 import { Parser, type Value } from 'expr-eval'
 import joi from 'joi'
 
 import { type ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js'
+import {} from '~/src/server/plugins/engine/components/YesNoField.js'
 import {
   hasListFormField,
   type Component
 } from '~/src/server/plugins/engine/components/helpers.js'
+import { todayAsDateOnly } from '~/src/server/plugins/engine/date-helper.js'
 import {
   findPage,
   getError,
@@ -53,6 +62,8 @@ export class FormModel {
   /** The runtime engine that should be used */
   engine?: Engine
 
+  schemaVersion: SchemaVersion
+
   /** the entire form JSON as an object */
   def: FormDefinition
 
@@ -67,8 +78,13 @@ export class FormModel {
 
   controllers?: Record<string, typeof PageController>
   pageDefMap: Map<string, Page>
+
   listDefMap: Map<string, List>
+  listDefIdMap: Map<string, List>
+
   componentDefMap: Map<string, ComponentDef>
+  componentDefIdMap: Map<string, ComponentDef>
+
   pageMap: Map<string, PageControllerClass>
   componentMap: Map<string, Component>
 
@@ -78,7 +94,13 @@ export class FormModel {
     services: Services = defaultServices,
     controllers?: Record<string, typeof PageController>
   ) {
-    const result = formDefinitionSchema.validate(def, { abortEarly: false })
+    let schema = formDefinitionSchema
+
+    if (def.schema === SchemaVersion.V2) {
+      schema = formDefinitionV2Schema
+    }
+
+    const result = schema.validate(def, { abortEarly: false })
 
     if (result.error) {
       throw result.error
@@ -90,15 +112,18 @@ export class FormModel {
 
     // Add default lists
     def.lists.push({
+      id: def.schema === SchemaVersion.V1 ? yesNoListName : yesNoListId,
       name: '__yesNo',
       title: 'Yes/No',
       type: 'boolean',
       items: [
         {
+          id: '02900d42-83d1-4c72-a719-c4e8228952fa',
           text: 'Yes',
           value: true
         },
         {
+          id: 'f39000eb-c51b-4019-8f82-bbda0423f04d',
           text: 'No',
           value: false
         }
@@ -109,6 +134,7 @@ export class FormModel {
     setPageTitles(def)
 
     this.engine = def.engine
+    this.schemaVersion = def.schema ?? SchemaVersion.V1
     this.def = def
     this.lists = def.lists
     this.sections = def.sections
@@ -119,8 +145,38 @@ export class FormModel {
     this.services = services
     this.controllers = controllers
 
+    this.pageDefMap = new Map(def.pages.map((page) => [page.path, page]))
+    this.listDefMap = new Map(def.lists.map((list) => [list.name, list]))
+    this.listDefIdMap = new Map(
+      def.lists
+        .filter((list) => list.id) // Skip lists without an ID
+        // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
+        .map((list) => [list.id as string, list])
+    )
+    this.componentDefMap = new Map(
+      def.pages
+        .filter(hasComponents)
+        .flatMap((page) =>
+          page.components.map((component) => [component.name, component])
+        )
+    )
+    this.componentDefIdMap = new Map(
+      def.pages.filter(hasComponents).flatMap((page) =>
+        page.components
+          .filter((component) => component.id) // Skip components without an ID
+          .map((component) => {
+            // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
+            return [component.id as string, component]
+          })
+      )
+    )
+
     def.conditions.forEach((conditionDef) => {
-      const condition = this.makeCondition(conditionDef)
+      const condition = this.makeCondition(
+        isConditionWrapperV2(conditionDef)
+          ? convertConditionWrapperFromV2(conditionDef, this)
+          : conditionDef
+      )
       this.conditions[condition.name] = condition
     })
 
@@ -142,16 +198,6 @@ export class FormModel {
       )
     }
 
-    this.pageDefMap = new Map(def.pages.map((page) => [page.path, page]))
-    this.listDefMap = new Map(def.lists.map((list) => [list.name, list]))
-    this.componentDefMap = new Map(
-      def.pages
-        .filter(hasComponents)
-        .flatMap((page) =>
-          page.components.map((component) => [component.name, component])
-        )
-    )
-
     this.pageMap = new Map(this.pages.map((page) => [page.path, page]))
     this.componentMap = new Map(
       this.pages.flatMap((page) =>
@@ -163,13 +209,6 @@ export class FormModel {
     )
   }
 
-  /**
-   * build the entire model schema from individual pages/sections
-   */
-  makeSchema() {
-    return this.makeFilteredSchema(this.pages)
-  }
-
   /**
    * build the entire model schema from individual pages/sections and filter out answers
    * for pages which are no longer accessible due to an answer that has been changed
@@ -199,7 +238,14 @@ export class FormModel {
 
     Object.assign(parser.functions, {
       dateForComparison(timePeriod: number, timeUnit: DateUnits) {
-        return add(new Date(), { [timeUnit]: timePeriod }).toISOString()
+        // The time element must be stripped (hence using startOfDay() which has no time element),
+        // then formatted as YYYY-MM-DD otherwise we can hit time element and BST issues giving the
+        // wrong date to compare against.
+        // Do not use .toISOString() to format the date as that introduces BST errors.
+        return format(
+          add(todayAsDateOnly(), { [timeUnit]: timePeriod }),
+          'yyyy-MM-dd'
+        )
       }
     })
 
@@ -246,8 +292,10 @@ export class FormModel {
     return parser.parse(conditions.toExpression())
   }
 
-  getList(name: string): List | undefined {
-    return this.lists.find((list) => list.name === name)
+  getList(nameOrId: string): List | undefined {
+    return this.schemaVersion === SchemaVersion.V1
+      ? this.lists.find((list) => list.name === nameOrId)
+      : this.lists.find((list) => list.id === nameOrId)
   }
 
   /**
@@ -448,6 +496,25 @@ export class FormModel {
       }
     }
   }
+
+  getComponentById(componentId: string): ComponentDef | undefined {
+    return this.componentDefIdMap.get(componentId)
+  }
+
+  getListById(listId: string): List | undefined {
+    return this.listDefIdMap.get(listId)
+  }
+
+  /**
+   * Returns a condition by its ID. O(n) lookup time.
+   * @param conditionId
+   * @returns
+   */
+  getConditionById(conditionId: string): ConditionWrapperV2 | undefined {
+    return this.def.conditions
+      .filter(isConditionWrapperV2)
+      .find((condition) => condition.id === conditionId)
+  }
 }
 
 /**

package/src/server/plugins/engine/outputFormatters/machine/v2.ts

@@ -1,10 +1,12 @@
 import { type SubmitResponsePayload } from '@defra/forms-model'
 
 import { config } from '~/src/config/index.js'
-import { type DatePartsState } from '~/src/server/plugins/engine/components/DatePartsField.js'
-import { type MonthYearState } from '~/src/server/plugins/engine/components/MonthYearField.js'
 import { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'
 import { FileUploadField } from '~/src/server/plugins/engine/components/index.js'
+import {
+  type DatePartsState,
+  type MonthYearState
+} from '~/src/server/plugins/engine/components/types.js'
 import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import {

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

@@ -253,8 +253,9 @@ describe('FileUploadPageController', () => {
         )
 
         expect(request.logger.error).toHaveBeenCalledWith(
+          expect.any(Error),
           expect.stringContaining(
-            'Exceeded cumulative retry delay for some-id (depth: 7). Re-initiating a new upload.'
+            '[uploadTimeout] Exceeded cumulative retry delay for uploadId: some-id at depth: 7 - re-initiating new upload'
           )
         )
 

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

@@ -325,9 +325,13 @@ export class FileUploadPageController extends QuestionPageController {
       // Depth 1: 2000ms, Depth 2: 4000ms, Depth 3: 8000ms, Depth 4: 16000ms, Depth 5+: 30000ms (capped)
       // A depth of 5 (or more) implies cumulative delays roughly reaching 55 seconds.
       if (depth >= 5) {
-        request.logger.error(
+        const error = new Error(
           `Exceeded cumulative retry delay for ${uploadId} (depth: ${depth}). Re-initiating a new upload.`
         )
+        request.logger.error(
+          error,
+          `[uploadTimeout] Exceeded cumulative retry delay for uploadId: ${uploadId} at depth: ${depth} - re-initiating new upload`
+        )
         await this.initiateAndStoreNewUpload(request, state)
         throw Boom.gatewayTimeout(
           `Timed out waiting for ${uploadId} after cumulative retries exceeding ${((CDP_UPLOAD_TIMEOUT_MS - 5000) / 1000).toFixed(0)} seconds`
@@ -335,7 +339,7 @@ export class FileUploadPageController extends QuestionPageController {
       }
       const delay = getExponentialBackoffDelay(depth)
       request.logger.info(
-        `Waiting ${delay / 1000} seconds for ${uploadId} to complete (depth: ${depth})`
+        `[uploadRetry] Waiting ${delay / 1000} seconds for uploadId: ${uploadId} to complete (retry depth: ${depth})`
       )
       await wait(delay)
       return this.checkUploadStatus(request, state, depth + 1)

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

@@ -2,7 +2,11 @@ import { existsSync } from 'fs'
 import { dirname, join } from 'path'
 import { fileURLToPath } from 'url'
 
-import { hasFormComponents, slugSchema } from '@defra/forms-model'
+import {
+  getErrorMessage,
+  hasFormComponents,
+  slugSchema
+} from '@defra/forms-model'
 import Boom from '@hapi/boom'
 import {
   type Plugin,
@@ -773,10 +777,10 @@ export const plugin = {
         request: FormRequest,
         h: Pick<ResponseToolkit, 'response'>
       ) => {
+        const { uploadId } = request.params as unknown as {
+          uploadId: string
+        }
         try {
-          const { uploadId } = request.params as unknown as {
-            uploadId: string
-          }
           const status = await getUploadStatus(uploadId)
 
           if (!status) {
@@ -785,10 +789,10 @@ export const plugin = {
 
           return h.response(status)
         } catch (error) {
+          const errMsg = getErrorMessage(error)
           request.logger.error(
-            ['upload-status'],
-            'Upload status check failed',
-            error
+            errMsg,
+            `[uploadStatusFailed] Upload status check failed for uploadId: ${uploadId} - ${errMsg}`
           )
           return h.response({ error: 'Status check error' }).code(500)
         }

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

@@ -1,4 +1,4 @@
-import { type SubmitResponsePayload } from '@defra/forms-model'
+import { getErrorMessage, type SubmitResponsePayload } from '@defra/forms-model'
 
 import { config } from '~/src/config/index.js'
 import { escapeMarkdown } from '~/src/server/plugins/engine/components/helpers.js'
@@ -56,7 +56,11 @@ export async function submit(
 
     request.logger.info(logTags, 'Email sent successfully')
   } catch (err) {
-    request.logger.error(logTags, 'Error sending email', err)
+    const errMsg = getErrorMessage(err)
+    request.logger.error(
+      errMsg,
+      `[emailSendFailed] Error sending notification email - templateId: ${templateId} - recipient: ${emailAddress} - ${errMsg}`
+    )
 
     throw err
   }

package/src/server/plugins/engine/views/components/tag-env/template.njk

@@ -1,30 +1,11 @@
 {%- from "govuk/components/tag/macro.njk" import govukTag -%}
 
-{%- switch params.env %}
-  {% case "local" %}
-    {% set text = "Local" %}
-    {% set classes = "govuk-tag--green" %}
-  {% case "dev" %}
-    {% set text = "Development" %}
-    {% set classes = "govuk-tag--grey" %}
-  {% case "test" %}
-    {% set text = "Test" %}
-    {% set classes = "govuk-tag--yellow" %}
-  {% case "ext-test" %}
-    {% set text = "External test" %}
-    {% set classes = "govuk-tag--yellow" %}
-  {% case "perf-test" %}
-    {% set text = "Performance test" %}
-    {% set classes = "govuk-tag--yellow" %}
-  {% case "prod" %}
-    {% set text = "Production" %}
-    {% set classes = "govuk-tag--red" %}
-  {% default %}
-    {% set text = params.env | replace("-", " ") | capitalize %}
-    {% set classes = "govuk-tag--grey" %}
-{% endswitch -%}
+{% set tagEnv = " app-tag--env" %}
+
+{% set text = params.env | replace("-", " ") | capitalize %}
+{% set classes = "govuk-tag--grey" %}
 
 {{ govukTag({
   text: text,
-  classes: classes + " app-tag--env"
+  classes: classes + tagEnv
 }) }}

package/src/server/plugins/engine/views/components/tag-env/template.test.js

@@ -1,66 +1,28 @@
 import { renderMacro } from '~/test/helpers/component-helpers.js'
 
 describe('Tag environment component', () => {
-  describe.each([
-    {
-      text: 'Local',
-      env: 'local',
-      colour: 'green'
-    },
-    {
-      text: 'Development',
-      env: 'dev',
-      colour: 'grey'
-    },
-    {
-      text: 'Test',
-      env: 'test',
-      colour: 'yellow'
-    },
-    {
-      text: 'External test',
-      env: 'ext-test',
-      colour: 'yellow'
-    },
-    {
-      text: 'Performance test',
-      env: 'perf-test',
-      colour: 'yellow'
-    },
-    {
-      text: 'Production',
-      env: 'prod',
-      colour: 'red'
-    },
-    {
-      text: 'Unknown environment',
-      env: 'unknown-environment',
-      colour: 'grey'
-    }
-  ])('Environment: $text', ({ text, env, colour }) => {
-    let $component = /** @type {HTMLElement | null} */ (null)
+  let $component = /** @type {HTMLElement | null} */ (null)
 
-    beforeEach(() => {
-      const { container } = renderMacro(
-        'appTagEnv',
-        'components/tag-env/macro.njk',
-        { params: { env } }
-      )
+  beforeEach(() => {
+    const { container } = renderMacro(
+      'appTagEnv',
+      'components/tag-env/macro.njk',
+      { params: { env: 'Devtool' } }
+    )
 
-      $component = container.getByRole('strong')
-    })
+    $component = container.getByRole('strong')
+  })
 
-    it('should render contents', () => {
-      expect($component).toBeInTheDocument()
-      expect($component).toHaveClass('govuk-tag')
-    })
+  it('should render contents', () => {
+    expect($component).toBeInTheDocument()
+    expect($component).toHaveClass('govuk-tag')
+  })
 
-    it('should have text content', () => {
-      expect($component).toHaveTextContent(text)
-    })
+  it('should have text content', () => {
+    expect($component).toHaveTextContent('Devtool')
+  })
 
-    it('should use environment colour', () => {
-      expect($component).toHaveClass(`govuk-tag--${colour}`)
-    })
+  it('should use environment colour', () => {
+    expect($component).toHaveClass(`govuk-tag--grey`)
   })
 })

package/src/server/plugins/errorPages.ts

@@ -25,10 +25,14 @@ export default {
             stack: response.stack
           }
 
-          request.log('error', error)
+          request.logger.error(
+            error,
+            `[httpError] HTTP ${statusCode} error occurred - ${response.message} - path: ${request.path} - method: ${request.method}`
+          )
 
           return h.response(error).code(statusCode)
         }
+
         return h.continue
       })
     }

package/src/server/plugins/nunjucks/context.js

@@ -73,7 +73,9 @@ export function devtoolContext(_request) {
       // eslint-disable-next-line -- Allow JSON type 'any'
       webpackManifest = JSON.parse(readFileSync(manifestPath, 'utf-8'))
     } catch {
-      logger.error(`Webpack ${basename(manifestPath)} not found`)
+      logger.info(
+        `[webpackManifestMissing] Webpack ${basename(manifestPath)} not found - running without asset manifest`
+      )
     }
   }
 

package/src/server/plugins/nunjucks/environment.js

@@ -109,6 +109,12 @@ export function evaluate(template) {
 
 environment.addGlobal('evaluate', evaluate)
 
+export function govukRebrand() {
+  return true
+}
+
+environment.addGlobal('govukRebrand', govukRebrand())
+
 /**
  * @import { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js'
  * @import { FormSubmissionError } from '~/src/server/plugins/engine/types.js'