@defra/forms-engine-plugin 4.5.6 → 4.6.1

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

@@ -11,10 +11,7 @@ import {
   type DetailItemField,
   type DetailItemRepeat
 } from '~/src/server/plugins/engine/models/types.js'
-import {
-  format,
-  getVersionMetadata
-} from '~/src/server/plugins/engine/outputFormatters/adapter/v1.js'
+import { format } from '~/src/server/plugins/engine/outputFormatters/adapter/v1.js'
 import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
 import { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/index.js'
 import {
@@ -764,7 +761,7 @@ describe('Adapter v1 formatter', () => {
   })
 
   describe('version metadata handling', () => {
-    it('should prefer $$__formVersion from definition metadata over formMetadata.versions', () => {
+    it('should include versionMetadata from $$__formVersion in definition metadata', () => {
       const definitionWithFormVersion = {
         ...definition,
         metadata: {
@@ -818,92 +815,7 @@ describe('Adapter v1 formatter', () => {
       })
     })
 
-    it('should include versionMetadata when context has submittedVersionNumber and formMetadata has versions', () => {
-      const formMetadata: Partial<FormMetadata> = {
-        id: 'form-123',
-        slug: 'test-form',
-        title: 'Test Form',
-        notificationEmail: 'test@example.com',
-        versions: [
-          {
-            versionNumber: 1,
-            createdAt: new Date('2024-01-01T00:00:00.000Z')
-          },
-          {
-            versionNumber: 2,
-            createdAt: new Date('2024-01-15T00:00:00.000Z')
-          }
-        ]
-      }
-
-      const modelWithVersion = new FormModel(definition, {
-        basePath: 'test',
-        versionNumber: 2
-      })
-
-      const contextWithVersion = modelWithVersion.getFormContext(request, state)
-
-      const formStatus = {
-        isPreview: false,
-        state: FormStatus.Live
-      }
-
-      const body = format(
-        contextWithVersion,
-        items,
-        modelWithVersion,
-        submitResponse,
-        formStatus,
-        formMetadata as FormMetadata
-      )
-      const parsedBody = JSON.parse(body) as FormAdapterSubmissionMessagePayload
-
-      expect(parsedBody.meta.versionMetadata).toEqual({
-        versionNumber: 2,
-        createdAt: '2024-01-15T00:00:00.000Z'
-      })
-    })
-
-    it('should use first version as fallback when submittedVersionNumber is undefined', () => {
-      const formMetadata: Partial<FormMetadata> = {
-        id: 'form-123',
-        slug: 'test-form',
-        title: 'Test Form',
-        notificationEmail: 'test@example.com',
-        versions: [
-          {
-            versionNumber: 1,
-            createdAt: new Date('2024-01-01T00:00:00.000Z')
-          },
-          {
-            versionNumber: 2,
-            createdAt: new Date('2024-01-15T00:00:00.000Z')
-          }
-        ]
-      }
-
-      const formStatus = {
-        isPreview: false,
-        state: FormStatus.Live
-      }
-
-      const body = format(
-        context,
-        items,
-        model,
-        submitResponse,
-        formStatus,
-        formMetadata as FormMetadata
-      )
-      const parsedBody = JSON.parse(body) as FormAdapterSubmissionMessagePayload
-
-      expect(parsedBody.meta.versionMetadata).toEqual({
-        versionNumber: 1,
-        createdAt: '2024-01-01T00:00:00.000Z'
-      })
-    })
-
-    it('should not include versionMetadata when submittedVersionNumber is undefined and no versions exist', () => {
+    it('should not include versionMetadata when no versions exist', () => {
       const formMetadata: Partial<FormMetadata> = {
         id: 'form-123',
         slug: 'test-form',
@@ -929,7 +841,7 @@ describe('Adapter v1 formatter', () => {
       expect(parsedBody.meta.versionMetadata).toBeUndefined()
     })
 
-    it('should not include versionMetadata when submittedVersionNumber is undefined and versions array is empty', () => {
+    it('should not include versionMetadata when versions array is empty', () => {
       const formMetadata: Partial<FormMetadata> = {
         id: 'form-123',
         slug: 'test-form',
@@ -955,269 +867,5 @@ describe('Adapter v1 formatter', () => {
 
       expect(parsedBody.meta.versionMetadata).toBeUndefined()
     })
-
-    it('should not include versionMetadata when submittedVersionNumber does not match any version', () => {
-      const formMetadata: Partial<FormMetadata> = {
-        id: 'form-123',
-        slug: 'test-form',
-        title: 'Test Form',
-        notificationEmail: 'test@example.com',
-        versions: [
-          {
-            versionNumber: 1,
-            createdAt: new Date('2024-01-01T00:00:00.000Z')
-          },
-          {
-            versionNumber: 2,
-            createdAt: new Date('2024-01-15T00:00:00.000Z')
-          }
-        ]
-      }
-
-      const modelWithVersion = new FormModel(definition, {
-        basePath: 'test',
-        versionNumber: 99 // Non-existent version
-      })
-
-      const contextWithVersion = modelWithVersion.getFormContext(request, state)
-
-      const formStatus = {
-        isPreview: false,
-        state: FormStatus.Live
-      }
-
-      const body = format(
-        contextWithVersion,
-        items,
-        modelWithVersion,
-        submitResponse,
-        formStatus,
-        formMetadata as FormMetadata
-      )
-      const parsedBody = JSON.parse(body) as FormAdapterSubmissionMessagePayload
-
-      // Should fall back to first version since submittedVersionNumber doesn't match
-      expect(parsedBody.meta.versionMetadata).toEqual({
-        versionNumber: 1,
-        createdAt: '2024-01-01T00:00:00.000Z'
-      })
-    })
-
-    it('should use first version as fallback when submittedVersionNumber does not match any version', () => {
-      const formMetadata: Partial<FormMetadata> = {
-        id: 'form-123',
-        slug: 'test-form',
-        title: 'Test Form',
-        notificationEmail: 'test@example.com',
-        versions: [
-          {
-            versionNumber: 1,
-            createdAt: new Date('2024-01-01T00:00:00.000Z')
-          },
-          {
-            versionNumber: 2,
-            createdAt: new Date('2024-01-15T00:00:00.000Z')
-          }
-        ]
-      }
-
-      const modelWithVersion = new FormModel(definition, {
-        basePath: 'test',
-        versionNumber: 99 // Non-existent version
-      })
-
-      const contextWithVersion = modelWithVersion.getFormContext(request, state)
-
-      const formStatus = {
-        isPreview: false,
-        state: FormStatus.Live
-      }
-
-      const body = format(
-        contextWithVersion,
-        items,
-        modelWithVersion,
-        submitResponse,
-        formStatus,
-        formMetadata as FormMetadata
-      )
-      const parsedBody = JSON.parse(body) as FormAdapterSubmissionMessagePayload
-
-      // Should fall back to first version since submittedVersionNumber doesn't match
-      expect(parsedBody.meta.versionMetadata).toEqual({
-        versionNumber: 1,
-        createdAt: '2024-01-01T00:00:00.000Z'
-      })
-    })
-
-    it('should handle single version in versions array', () => {
-      const formMetadata: Partial<FormMetadata> = {
-        id: 'form-123',
-        slug: 'test-form',
-        title: 'Test Form',
-        notificationEmail: 'test@example.com',
-        versions: [
-          {
-            versionNumber: 5,
-            createdAt: new Date('2024-02-01T00:00:00.000Z')
-          }
-        ]
-      }
-
-      const formStatus = {
-        isPreview: false,
-        state: FormStatus.Live
-      }
-
-      const body = format(
-        context,
-        items,
-        model,
-        submitResponse,
-        formStatus,
-        formMetadata as FormMetadata
-      )
-      const parsedBody = JSON.parse(body) as FormAdapterSubmissionMessagePayload
-
-      expect(parsedBody.meta.versionMetadata).toEqual({
-        versionNumber: 5,
-        createdAt: '2024-02-01T00:00:00.000Z'
-      })
-    })
-  })
-
-  describe('getVersionMetadata', () => {
-    const mockFormMetadata: Partial<FormMetadata> = {
-      id: 'form-123',
-      slug: 'test-form',
-      title: 'Test Form',
-      notificationEmail: 'test@example.com',
-      versions: [
-        {
-          versionNumber: 1,
-          createdAt: new Date('2024-01-01T00:00:00.000Z')
-        },
-        {
-          versionNumber: 2,
-          createdAt: new Date('2024-01-02T00:00:00.000Z')
-        },
-        {
-          versionNumber: 3,
-          createdAt: new Date('2024-01-03T00:00:00.000Z')
-        }
-      ]
-    }
-
-    it('should return undefined when no form metadata provided', () => {
-      const result = getVersionMetadata(1, undefined)
-      expect(result).toBeUndefined()
-    })
-
-    it('should return undefined when form metadata has no versions', () => {
-      const formMetadataWithoutVersions: Partial<FormMetadata> = {
-        ...mockFormMetadata,
-        versions: undefined
-      }
-
-      const result = getVersionMetadata(
-        1,
-        formMetadataWithoutVersions as FormMetadata
-      )
-      expect(result).toBeUndefined()
-    })
-
-    it('should return undefined when versions array is empty', () => {
-      const formMetadataWithEmptyVersions: Partial<FormMetadata> = {
-        ...mockFormMetadata,
-        versions: []
-      }
-
-      const result = getVersionMetadata(
-        1,
-        formMetadataWithEmptyVersions as FormMetadata
-      )
-      expect(result).toBeUndefined()
-    })
-
-    it('should return specific version when submittedVersionNumber matches', () => {
-      const result = getVersionMetadata(2, mockFormMetadata as FormMetadata)
-      expect(result).toEqual({
-        versionNumber: 2,
-        createdAt: new Date('2024-01-02T00:00:00.000Z')
-      })
-    })
-
-    it('should return first version when submittedVersionNumber not found', () => {
-      const result = getVersionMetadata(999, mockFormMetadata as FormMetadata)
-      expect(result).toEqual({
-        versionNumber: 1,
-        createdAt: new Date('2024-01-01T00:00:00.000Z')
-      })
-    })
-
-    it('should return first version when no submittedVersionNumber provided', () => {
-      const result = getVersionMetadata(
-        undefined,
-        mockFormMetadata as FormMetadata
-      )
-      expect(result).toEqual({
-        versionNumber: 1,
-        createdAt: new Date('2024-01-01T00:00:00.000Z')
-      })
-    })
-
-    it('should handle single version in versions array', () => {
-      const singleVersionMetadata: Partial<FormMetadata> = {
-        ...mockFormMetadata,
-        versions: [
-          {
-            versionNumber: 5,
-            createdAt: new Date('2024-02-01T00:00:00.000Z')
-          }
-        ]
-      }
-
-      const result = getVersionMetadata(
-        undefined,
-        singleVersionMetadata as FormMetadata
-      )
-      expect(result).toEqual({
-        versionNumber: 5,
-        createdAt: new Date('2024-02-01T00:00:00.000Z')
-      })
-    })
-
-    it('should return correct version when submittedVersionNumber is 0', () => {
-      const metadataWithVersionZero: Partial<FormMetadata> = {
-        ...mockFormMetadata,
-        versions: [
-          {
-            versionNumber: 0,
-            createdAt: new Date('2024-01-01T00:00:00.000Z')
-          },
-          {
-            versionNumber: 1,
-            createdAt: new Date('2024-01-02T00:00:00.000Z')
-          }
-        ]
-      }
-
-      const result = getVersionMetadata(
-        0,
-        metadataWithVersionZero as FormMetadata
-      )
-      expect(result).toEqual({
-        versionNumber: 0,
-        createdAt: new Date('2024-01-01T00:00:00.000Z')
-      })
-    })
-
-    it('should handle negative submittedVersionNumber by falling back to first version', () => {
-      const result = getVersionMetadata(-1, mockFormMetadata as FormMetadata)
-      expect(result).toEqual({
-        versionNumber: 1,
-        createdAt: new Date('2024-01-01T00:00:00.000Z')
-      })
-    })
   })
 })

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

@@ -31,9 +31,7 @@ export function format(
 
   const { main: v2Main, ...v2Data } = categoriseData(items)
 
-  const versionMetadata =
-    getFormVersion(model.def) ??
-    getVersionMetadata(context.submittedVersionNumber, formMetadata)
+  const versionMetadata = getFormVersion(model.def)
 
   const meta: FormAdapterSubmissionMessageMeta = {
     schemaVersion: FormAdapterSubmissionSchemaVersion.V1,
@@ -79,34 +77,6 @@ export function format(
   return JSON.stringify(payload)
 }
 
-export function getVersionMetadata(
-  submittedVersionNumber: number | undefined,
-  formMetadata?: FormMetadata
-): { versionNumber: number; createdAt: Date } | undefined {
-  if (!formMetadata?.versions?.length) {
-    return undefined
-  }
-
-  if (submittedVersionNumber !== undefined) {
-    const submittedVersion = formMetadata.versions.find(
-      (v) => v.versionNumber === submittedVersionNumber
-    )
-    if (submittedVersion) {
-      return {
-        versionNumber: submittedVersion.versionNumber,
-        createdAt: submittedVersion.createdAt
-      }
-    }
-  }
-
-  // fallback to first available version
-  const firstVersion = formMetadata.versions[0]
-  return {
-    versionNumber: firstVersion.versionNumber,
-    createdAt: firstVersion.createdAt
-  }
-}
-
 function extractCsvFiles(
   submitResponse: SubmitResponsePayload
 ): FormAdapterSubmissionMessageResult['files'] {

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

@@ -1,5 +1,4 @@
 import { ControllerType, getHiddenFields } from '@defra/forms-model'
-import { validate as isValidUUID } from 'uuid'
 
 import { getCacheService } from '~/src/server/plugins/engine/helpers.js'
 import {
@@ -16,6 +15,7 @@ import {
 } from '~/src/server/plugins/engine/types.js'
 import { type FormQuery } from '~/src/server/routes/types.js'
 import { type Services } from '~/src/server/types.js'
+import { isValidUUID } from '~/src/server/utils/utils.js'
 
 const GUID_LENGTH = 36
 

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

@@ -44,6 +44,7 @@ export const messageTemplate: Record<string, JoiExpression> = {
     'Enter {{lowerFirst(#label)}} in the correct format',
     opts
   ) as JoiExpression,
+  unicode: '{{#label}} includes invalid characters, for example, long dashes',
   number: '{{#label}} must be a number',
   numberPrecision: '{{#label}} must have {{#limit}} or fewer decimal places',
   numberInteger: '{{#label}} must be a whole number',
@@ -69,6 +70,7 @@ export const messages: LanguageMessagesExt = {
   'string.empty': messageTemplate.required,
   'string.max': messageTemplate.max,
   'string.email': messageTemplate.format,
+  'string.unicode': messageTemplate.unicode,
   'string.pattern.base': messageTemplate.pattern,
   'string.maxWords': messageTemplate.maxWords,
 

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

@@ -194,7 +194,6 @@ export interface FormContext {
   pageMap: Map<string, PageControllerClass>
   componentMap: Map<string, Component>
   referenceNumber: string
-  submittedVersionNumber?: number
 }
 
 export type FormContextRequest = (

package/src/server/utils/utils.js

@@ -1,4 +1,5 @@
 import { getTraceId } from '@defra/hapi-tracing'
+import Joi from 'joi'
 
 import { config } from '~/src/config/index.js'
 
@@ -22,3 +23,13 @@ export function applyTraceHeaders(
 
   return existingHeaders ? Object.assign(existingHeaders, headers) : headers
 }
+
+/**
+ * Validates if a string conforms to the uuid structure
+ * @param {string} str
+ * @returns
+ */
+export function isValidUUID(str) {
+  const { error } = Joi.string().uuid().validate(str)
+  return error === undefined
+}

package/src/server/utils/utils.test.js

@@ -1,7 +1,7 @@
 import { getTraceId } from '@defra/hapi-tracing'
 
 import { config } from '~/src/config/index.js'
-import { applyTraceHeaders } from '~/src/server/utils/utils.js'
+import { applyTraceHeaders, isValidUUID } from '~/src/server/utils/utils.js'
 
 jest.mock('@defra/hapi-tracing')
 
@@ -51,4 +51,19 @@ describe('Header helper functions', () => {
 
     expect(result).toBe(existingHeaders)
   })
+
+  it.each([
+    { uuid: '1f457a37-7b99-452e-8324-df9e041abff2', valid: true },
+    { uuid: '0c9a2690-9a0c-4a2c-98d7-e9ef95615ac9', valid: true },
+    { uuid: 'f223de3b-5ae5-44b2-8cee-ea8439adc335', valid: true },
+    { uuid: '82ecc90c-bc47-4ec5-80af-1a9fc1c4c08c', valid: true },
+    { uuid: 'd99ff582-ecce-474f-a44b-bc5961d977c5', valid: true },
+    { uuid: '7afffc8a-81ab-4aa6-a8f5-ecf6a600a781', valid: true },
+    { uuid: '7afffc8a81ab4aa6a8f5ecf6a600a781', valid: true },
+    { uuid: '', valid: false },
+    { uuid: 'uuid', valid: false },
+    { uuid: 'h4f84ef8-b5e1-4544-94aa-1b671d50d8cb', valid: false }
+  ])('should validate uuid appropriately %s', ({ uuid, valid }) => {
+    expect(isValidUUID(uuid)).toBe(valid)
+  })
 })