@defra/forms-engine-plugin 0.1.11 → 0.1.13

package/src/server/plugins/engine/helpers.test.ts

@@ -3,7 +3,6 @@ import { type ResponseObject, type ResponseToolkit } from '@hapi/hapi'
 import { StatusCodes } from 'http-status-codes'
 import { ValidationError } from 'joi'
 
-import { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'
 import {
   checkEmailAddressForLiveFormSubmission,
   checkFormStatus,
@@ -17,6 +16,7 @@ import {
   safeGenerateCrumb,
   type GlobalScope
 } from '~/src/server/plugins/engine/helpers.js'
+import { handleLegacyRedirect } from '~/src/server/plugins/engine/helpers.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import {
   createPage,
@@ -311,35 +311,42 @@ describe('Helpers', () => {
   })
 
   describe('checkFormStatus', () => {
-    it('should return true/live for paths starting with PREVIEW_PATH_PREFIX and form is live', () => {
-      const path = `${PREVIEW_PATH_PREFIX}/live/another/segment`
-      expect(checkFormStatus(path)).toStrictEqual({
+    it('should return true/live for params that include live state segment', () => {
+      expect(
+        checkFormStatus({
+          state: FormStatus.Live,
+          slug: 'another',
+          path: 'segment'
+        })
+      ).toStrictEqual({
         state: FormStatus.Live,
         isPreview: true
       })
     })
 
-    it('should return false for paths not starting with PREVIEW_PATH_PREFIX', () => {
-      const path = '/some/other/path'
-      expect(checkFormStatus(path)).toStrictEqual({
-        state: FormStatus.Live,
-        isPreview: false
-      })
-    })
-
-    it('should be case insensitive and return draft when form is draft', () => {
-      const path = `${PREVIEW_PATH_PREFIX.toUpperCase()}/draft/path`
-      expect(checkFormStatus(path)).toStrictEqual({
+    it('should return true/draft for params that include draft state segment', () => {
+      expect(
+        checkFormStatus({
+          state: FormStatus.Draft,
+          slug: 'another',
+          path: 'segment'
+        })
+      ).toStrictEqual({
         state: FormStatus.Draft,
         isPreview: true
       })
     })
 
-    it('should throw an error for invalid form state', () => {
-      const path = `${PREVIEW_PATH_PREFIX}/invalid-state`
-      expect(() => checkFormStatus(path)).toThrow(
-        'Invalid form state: invalid-state'
-      )
+    it('should return false/live for paths without a state segment', () => {
+      expect(
+        checkFormStatus({
+          slug: 'some',
+          path: 'other'
+        })
+      ).toStrictEqual({
+        state: FormStatus.Live,
+        isPreview: false
+      })
     })
   })
 
@@ -789,4 +796,48 @@ describe('Helpers', () => {
       })
     })
   })
+
+  describe('handleLegacyRedirect', () => {
+    let mockH: jest.Mocked<Pick<ResponseToolkit, 'redirect'>>
+    let mockRedirectResponse: jest.Mocked<
+      ReturnType<ResponseToolkit['redirect']>
+    >
+
+    beforeEach(() => {
+      mockRedirectResponse = {
+        permanent: jest.fn().mockReturnThis(),
+        takeover: jest.fn().mockReturnThis()
+      } as unknown as jest.Mocked<ReturnType<ResponseToolkit['redirect']>>
+
+      mockH = {
+        redirect: jest.fn().mockReturnValue(mockRedirectResponse)
+      }
+    })
+
+    it('should call h.redirect with the target URL', () => {
+      const targetUrl = '/another/target'
+      handleLegacyRedirect(mockH as unknown as ResponseToolkit, targetUrl)
+
+      expect(mockH.redirect).toHaveBeenCalledTimes(1)
+      expect(mockH.redirect).toHaveBeenCalledWith(targetUrl)
+    })
+
+    it('should call permanent() and takeover() on the redirect response', () => {
+      const targetUrl = '/final/destination'
+      handleLegacyRedirect(mockH as unknown as ResponseToolkit, targetUrl)
+
+      expect(mockRedirectResponse.permanent).toHaveBeenCalledTimes(1)
+      expect(mockRedirectResponse.takeover).toHaveBeenCalledTimes(1)
+    })
+
+    it('should return the final response object from takeover()', () => {
+      const targetUrl = '/the/end'
+      const response = handleLegacyRedirect(
+        mockH as unknown as ResponseToolkit,
+        targetUrl
+      )
+
+      expect(response).toBe(mockRedirectResponse)
+    })
+  })
 })

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

@@ -1,7 +1,10 @@
 import {
   ControllerPath,
   Engine,
+  hasComponents,
+  isFormType,
   type ComponentDef,
+  type FormDefinition,
   type Page
 } from '@defra/forms-model'
 import Boom from '@hapi/boom'
@@ -12,7 +15,6 @@ import { type Schema, type ValidationErrorItem } from 'joi'
 import { Liquid } from 'liquidjs'
 
 import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
-import { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'
 import {
   getAnswer,
   type Field
@@ -27,6 +29,7 @@ import {
 import {
   FormAction,
   FormStatus,
+  type FormParams,
   type FormQuery,
   type FormRequest,
   type FormRequestPayload
@@ -253,29 +256,18 @@ export function getStartPath(model?: FormModel) {
   return startPath ? `/${startPath}` : ControllerPath.Start
 }
 
-export function checkFormStatus(path: string) {
-  const isPreview = path.toLowerCase().startsWith(PREVIEW_PATH_PREFIX)
+export function checkFormStatus(params?: FormParams) {
+  const isPreview = !!params?.state
 
-  let state: FormStatus | undefined
+  let state = FormStatus.Live
 
-  if (isPreview) {
-    const previewState = path.split('/')[2]
-
-    for (const formState of Object.values(FormStatus)) {
-      if (previewState === formState.toString()) {
-        state = formState
-        break
-      }
-    }
-
-    if (!state) {
-      throw new Error(`Invalid form state: ${previewState}`)
-    }
+  if (isPreview && params.state === FormStatus.Draft) {
+    state = FormStatus.Draft
   }
 
   return {
     isPreview,
-    state: state ?? FormStatus.Live
+    state
   }
 }
 
@@ -337,7 +329,7 @@ export function safeGenerateCrumb(
     return undefined
   }
 
-  // crumb plugin or its generate method doesn’t exist
+  // crumb plugin or its generate method doesn't exist
   if (!request.server.plugins.crumb.generate) {
     return undefined
   }
@@ -382,3 +374,38 @@ export function evaluateTemplate(
 export function getCacheService(server: Server) {
   return server.plugins['forms-engine-plugin'].cacheService
 }
+
+/**
+ * Handles logging and issuing a permanent redirect for legacy routes.
+ * @param h - The Hapi response toolkit.
+ * @param targetUrl - The URL to redirect to.
+ * @returns The Hapi response object configured for permanent redirect.
+ */
+export function handleLegacyRedirect(h: ResponseToolkit, targetUrl: string) {
+  return h.redirect(targetUrl).permanent().takeover()
+}
+
+/**
+ * If the page doesn't have a title, set it from the title of the first form component
+ * @param def - the form definition
+ */
+export function setPageTitles(def: FormDefinition) {
+  def.pages.forEach((page) => {
+    if (!page.title) {
+      if (hasComponents(page)) {
+        // Set the page title from the first form component
+        const firstFormComponent = page.components.find((component) =>
+          isFormType(component.type)
+        )
+
+        page.title = firstFormComponent?.title ?? ''
+      }
+
+      if (!page.title) {
+        const formNameMsg = def.name ? ` in form '${def.name}'` : ''
+
+        logger.warn(`Page '${page.path}' has no title${formNameMsg}`)
+      }
+    }
+  })
+}

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

@@ -1,6 +1,8 @@
 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 fieldsRequiredDefinition from '~/test/form/definitions/fields-required.js'
 
 describe('FormModel', () => {
@@ -10,6 +12,20 @@ describe('FormModel', () => {
         () => new FormModel(definition, { basePath: 'test' })
       ).not.toThrow()
     })
+
+    it('Sets the page title from first form component when empty (V2 only)', () => {
+      const noTitlesDefinition = {
+        ...definitionV2,
+        pages: definitionV2.pages.map((page) => ({ ...page, title: '' }))
+      }
+
+      const model = new FormModel(noTitlesDefinition, { basePath: 'test' })
+
+      expect(model.def.pages.at(0)?.title).toBe(
+        'Have you previously been married?'
+      )
+      expect(model.def.pages.at(1)?.title).toBe('Date of marriage')
+    })
   })
 
   describe('getFormContext', () => {
@@ -74,7 +90,7 @@ describe('FormModel', () => {
       })
 
       const state = {
-        $$__referenceNumber: 1232456,
+        $$__referenceNumber: 123456789,
         checkboxesSingle: ['Arabian', 'Shetland']
       }
       const pageUrl = new URL('http://example.com/components/fields-required')
@@ -93,5 +109,79 @@ describe('FormModel', () => {
         'Reference number not found in form state'
       )
     })
+
+    it('redirects to the page if the list field (radio) is invalidated due to list item conditions', () => {
+      const formModel = new FormModel(conditionsListDefinition, {
+        basePath: '/conditional-list-items'
+      })
+
+      const state = {
+        $$__referenceNumber: 'foobar',
+        gXsqLq: true,
+        QwcNsc: 'meat',
+        zeQDES: ['peppers', 'cheese', 'ham']
+      }
+      const pageUrl = new URL(
+        'http://example.com/conditional-list-items/summary'
+      )
+
+      const request: FormContextRequest = {
+        method: 'get',
+        query: {},
+        path: pageUrl.pathname,
+        params: { path: 'summary', slug: 'conditional-list-items' },
+        url: pageUrl,
+        app: { model: formModel }
+      }
+
+      const context = formModel.getFormContext(request, state)
+
+      expect(context.errors).toHaveLength(1)
+      expect(context.errors?.at(0)?.text).toBe(
+        'Options are different because you changed a previous answer'
+      )
+      expect(context.relevantPages).toHaveLength(2)
+      expect(context.paths).toHaveLength(2)
+      expect(context.relevantState).toEqual({ gXsqLq: true, QwcNsc: 'meat' })
+    })
+
+    it('redirects to the page if the list field (check) is invalidated due to list item conditions', () => {
+      const formModel = new FormModel(conditionsListDefinition, {
+        basePath: '/conditional-list-items'
+      })
+
+      const state = {
+        $$__referenceNumber: 'foobar',
+        gXsqLq: true,
+        QwcNsc: 'vegan',
+        zeQDES: ['peppers', 'cheese', 'ham']
+      }
+      const pageUrl = new URL(
+        'http://example.com/conditional-list-items/summary'
+      )
+
+      const request: FormContextRequest = {
+        method: 'get',
+        query: {},
+        path: pageUrl.pathname,
+        params: { path: 'summary', slug: 'conditional-list-items' },
+        url: pageUrl,
+        app: { model: formModel }
+      }
+
+      const context = formModel.getFormContext(request, state)
+
+      expect(context.errors).toHaveLength(1)
+      expect(context.errors?.at(0)?.text).toBe(
+        'Options are different because you changed a previous answer'
+      )
+      expect(context.relevantPages).toHaveLength(3)
+      expect(context.paths).toHaveLength(3)
+      expect(context.relevantState).toEqual({
+        gXsqLq: true,
+        QwcNsc: 'vegan',
+        zeQDES: ['peppers', 'cheese', 'ham']
+      })
+    })
   })
 })

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

@@ -19,11 +19,16 @@ import { add } from 'date-fns'
 import { Parser, type Value } from 'expr-eval'
 import joi from 'joi'
 
-import { type Component } from '~/src/server/plugins/engine/components/helpers.js'
+import { type ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js'
+import {
+  hasListFormField,
+  type Component
+} from '~/src/server/plugins/engine/components/helpers.js'
 import {
   findPage,
   getError,
-  getPage
+  getPage,
+  setPageTitles
 } from '~/src/server/plugins/engine/helpers.js'
 import { type ExecutableCondition } from '~/src/server/plugins/engine/models/types.js'
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
@@ -100,6 +105,9 @@ export class FormModel {
       ]
     })
 
+    // Fix up page titles
+    setPageTitles(def)
+
     this.engine = def.engine
     this.def = def
     this.lists = def.lists
@@ -297,7 +305,10 @@ export class FormModel {
       this.assignRelevantState(context, nextPage)
 
       // Stop at current page
-      if (nextPage.path === currentPath) {
+      if (
+        this.pageStateIsInvalid(context, nextPage) ||
+        nextPage.path === currentPath
+      ) {
         break
       }
 
@@ -351,6 +362,78 @@ export class FormModel {
     }
   }
 
+  private pageStateIsInvalid(context: FormContext, page: PageControllerClass) {
+    // Get any list-bound fields on the page
+    const listFields = page.collection.fields.filter(hasListFormField)
+
+    // For each list field that is bound to a list that contains any conditional items,
+    // we need to check any answers are still valid. Do this by evaluating the conditions
+    // and ensuring any current answers are all included in the set of valid answers
+    for (const field of listFields) {
+      const list = field.list
+
+      // Filter out YesNo as they can't be conditional
+      if (list !== undefined && field.type !== ComponentType.YesNoField) {
+        const hasOptionalItems =
+          list.items.filter((item) => item.condition).length > 0
+
+        if (hasOptionalItems) {
+          return this.fieldStateIsInvalid(context, field, list)
+        }
+      }
+    }
+  }
+
+  private fieldStateIsInvalid(
+    context: FormContext,
+    field: ListFormComponent,
+    list: List
+  ) {
+    const { evaluationState, state } = context
+
+    const validValues = list.items
+      .filter((item) =>
+        item.condition
+          ? this.conditions[item.condition]?.fn(evaluationState)
+          : true
+      )
+      .map((item) => item.value)
+
+    // Get the field state
+    const fieldState = field.getFormValueFromState(state)
+
+    if (fieldState !== undefined) {
+      let isInvalid = false
+      const isArray = Array.isArray(fieldState)
+
+      // Check if any saved state value(s) are still valid
+      // and return true if any are invalid
+      if (isArray) {
+        isInvalid = !fieldState.every((item) => validValues.includes(item))
+      } else {
+        isInvalid = !validValues.includes(fieldState)
+      }
+
+      if (isInvalid) {
+        if (!context.errors) {
+          context.errors = []
+        }
+
+        const text =
+          'Options are different because you changed a previous answer'
+
+        context.errors.push({
+          text,
+          name: field.name,
+          href: `#${field.name}`,
+          path: [`#${field.name}`]
+        })
+      }
+
+      return isInvalid
+    }
+  }
+
   private assignPaths(context: FormContext) {
     for (const { keys, path } of context.relevantPages) {
       context.paths.push(path)

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

@@ -1,3 +1,4 @@
+import { FORM_PREFIX } from '~/src/server/constants.js'
 import {
   FormModel,
   SummaryViewModel
@@ -13,7 +14,7 @@ import {
 } from '~/src/server/plugins/engine/types.js'
 import definition from '~/test/form/definitions/repeat-mixed.js'
 
-const basePath = '/test'
+const basePath = `${FORM_PREFIX}/test`
 
 describe('SummaryViewModel', () => {
   const itemId1 = 'abc-123'
@@ -28,7 +29,7 @@ describe('SummaryViewModel', () => {
 
   beforeEach(() => {
     model = new FormModel(definition, {
-      basePath: 'test'
+      basePath: `${FORM_PREFIX}/test`
     })
 
     page = createPage(model, definition.pages[2])
@@ -55,7 +56,13 @@ describe('SummaryViewModel', () => {
         orderType: 'collection',
         pizza: []
       } satisfies FormState,
-      keys: ['How would you like to receive your pizza?', 'Pizzas'],
+      keys: [
+        'How would you like to receive your pizza?',
+        'Pizzas',
+        'How you would like to receive your pizza',
+        'Pizzas',
+        'Pizza'
+      ],
       values: ['Collection', 'Not supplied']
     },
     {
@@ -71,7 +78,13 @@ describe('SummaryViewModel', () => {
           }
         ]
       } satisfies FormState,
-      keys: ['How would you like to receive your pizza?', 'Pizza added'],
+      keys: [
+        'How would you like to receive your pizza?',
+        'Pizza added',
+        'How you would like to receive your pizza',
+        'Pizzas',
+        'Pizza'
+      ],
       values: ['Delivery', 'You added 1 Pizza']
     },
     {
@@ -92,7 +105,13 @@ describe('SummaryViewModel', () => {
           }
         ]
       } satisfies FormState,
-      keys: ['How would you like to receive your pizza?', 'Pizzas added'],
+      keys: [
+        'How would you like to receive your pizza?',
+        'Pizzas added',
+        'How you would like to receive your pizza',
+        'Pizzas',
+        'Pizza'
+      ],
       values: ['Delivery', 'You added 2 Pizzas']
     }
   ])('Check answers ($description)', ({ state, keys, values }) => {
@@ -124,7 +143,7 @@ describe('SummaryViewModel', () => {
       expect(summaryList1).toHaveProperty('rows', [
         {
           key: {
-            text: keys[0]
+            text: keys[2]
           },
           value: {
             classes: 'app-prose-scope',
@@ -181,7 +200,7 @@ describe('SummaryViewModel', () => {
       expect(summaryList1).toHaveProperty('rows', [
         {
           key: {
-            text: keys[0]
+            text: keys[2]
           },
           value: {
             classes: 'app-prose-scope',
@@ -208,5 +227,25 @@ describe('SummaryViewModel', () => {
         }
       ])
     })
+
+    it('should use correct summary labels', () => {
+      request.query.force = '' // Preview URL '?force'
+      context = model.getFormContext(request, state)
+      summaryViewModel = new SummaryViewModel(request, page, context)
+
+      expect(summaryViewModel.details).toHaveLength(2)
+
+      const [details1, details2] = summaryViewModel.details
+
+      expect(details1.items[0]).toMatchObject({
+        title: keys[2],
+        label: keys[0]
+      })
+
+      expect(details2.items[0]).toMatchObject({
+        title: keys[1],
+        label: keys[4]
+      })
+    })
   })
 })

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

@@ -4,7 +4,10 @@ import {
   getAnswer,
   type Field
 } from '~/src/server/plugins/engine/components/helpers.js'
-import { type BackLink } from '~/src/server/plugins/engine/components/types.js'
+import {
+  type BackLink,
+  type ComponentViewModel
+} from '~/src/server/plugins/engine/components/types.js'
 import {
   evaluateTemplate,
   getError,
@@ -47,6 +50,7 @@ export class SummaryViewModel {
   errors?: FormSubmissionError[]
   serviceUrl: string
   hasMissingNotificationEmail?: boolean
+  components?: ComponentViewModel[]
 
   constructor(
     request: FormContextRequest,
@@ -207,8 +211,8 @@ function ItemField(
   return {
     name: field.name,
     label: field.title,
-    title: field.title,
-    error: field.getError(options.errors),
+    title: field.label,
+    error: field.getFirstError(options.errors),
     value: getAnswer(field, state),
     href: getPageHref(page, options.path, {
       returnUrl: getPageHref(page, page.getSummaryPath())

package/src/server/plugins/engine/outputFormatters/human/v1.test.ts

@@ -93,10 +93,9 @@ describe('getPersonalisation', () => {
       `^ For security reasons, the links in this email expire at ${dateFormat(dateExpiry, 'h:mmaaa')} on ${dateFormat(dateExpiry, 'eeee d MMMM yyyy')}`
     )
 
-    // Check for form answers
     expect(body).toContain(
       outdent`
-            Form submitted at ${dateFormat(dateNow, 'h:mmaaa')} on ${dateFormat(dateNow, 'd MMMM yyyy')}.
+            ${definition.name} form received at ${dateFormat(dateNow, 'h:mmaaa')} on ${dateFormat(dateNow, 'd MMMM yyyy')}.
 
             ---
 

package/src/server/plugins/engine/outputFormatters/human/v1.ts

@@ -42,7 +42,7 @@ export function format(
     lines.push(`This is a test of the ${formName} ${formStatus.state} form.\n`)
   }
 
-  lines.push(`Form submitted at ${escapeMarkdown(formattedNow)}.\n`)
+  lines.push(`${formName} form received at ${escapeMarkdown(formattedNow)}.\n`)
   lines.push('---\n')
 
   items.forEach((item) => {

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

@@ -210,6 +210,7 @@ describe('FileUploadPageController', () => {
         expect(getUploadStatusSpy).toHaveBeenCalledTimes(2)
         expect(request.logger.info).toHaveBeenCalled()
 
+        /* eslint-disable-next-line @typescript-eslint/no-unsafe-member-access */
         const logMsg = (request.logger.info as jest.Mock).mock.calls[0][0]
         expect(logMsg).toEqual(expect.stringContaining('Waiting'))
         expect(logMsg).toEqual(expect.stringContaining('some-id'))