@defra/forms-engine-plugin 4.5.0 → 4.5.2

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

@@ -764,6 +764,60 @@ describe('Adapter v1 formatter', () => {
   })
 
   describe('version metadata handling', () => {
+    it('should prefer $$__formVersion from definition metadata over formMetadata.versions', () => {
+      const definitionWithFormVersion = {
+        ...definition,
+        metadata: {
+          $$__formVersion: {
+            versionNumber: 42,
+            createdAt: new Date('2024-06-01T00:00:00.000Z')
+          }
+        }
+      }
+
+      const modelWithFormVersion = new FormModel(definitionWithFormVersion, {
+        basePath: 'test'
+      })
+
+      const contextWithFormVersion = modelWithFormVersion.getFormContext(
+        request,
+        state
+      )
+
+      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')
+          }
+        ]
+      }
+
+      const formStatus = {
+        isPreview: false,
+        state: FormStatus.Live
+      }
+
+      const body = format(
+        contextWithFormVersion,
+        items,
+        modelWithFormVersion,
+        submitResponse,
+        formStatus,
+        formMetadata as FormMetadata
+      )
+      const parsedBody = JSON.parse(body) as FormAdapterSubmissionMessagePayload
+
+      expect(parsedBody.meta.versionMetadata).toEqual({
+        versionNumber: 42,
+        createdAt: '2024-06-01T00:00:00.000Z'
+      })
+    })
+
     it('should include versionMetadata when context has submittedVersionNumber and formMetadata has versions', () => {
       const formMetadata: Partial<FormMetadata> = {
         id: 'form-123',

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

@@ -3,7 +3,10 @@ import {
   type SubmitResponsePayload
 } from '@defra/forms-model'
 
-import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'
+import {
+  getFormVersion,
+  type checkFormStatus
+} from '~/src/server/plugins/engine/helpers.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js'
 import { categoriseData } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
@@ -28,10 +31,9 @@ export function format(
 
   const { main: v2Main, ...v2Data } = categoriseData(items)
 
-  const versionMetadata = getVersionMetadata(
-    context.submittedVersionNumber,
-    formMetadata
-  )
+  const versionMetadata =
+    getFormVersion(model.def) ??
+    getVersionMetadata(context.submittedVersionNumber, formMetadata)
 
   const meta: FormAdapterSubmissionMessageMeta = {
     schemaVersion: FormAdapterSubmissionSchemaVersion.V1,

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

@@ -63,7 +63,7 @@ async function handleHttpEvent(
 
   // @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 }
+  const opts: httpService.RequestOptions = { payload, timeout: 5000 }
 
   if (preparePageEventRequestOptions) {
     preparePageEventRequestOptions(opts, event, page, context)

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

@@ -8,8 +8,7 @@ import { config } from '~/src/config/index.js'
 import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
 import {
   checkFormStatus,
-  encodeUrl,
-  safeGenerateCrumb
+  encodeUrl
 } from '~/src/server/plugins/engine/helpers.js'
 
 const logger = createLogger()
@@ -51,7 +50,6 @@ export async function context(request) {
     // take consumers props first so we can override it
     ...consumerViewContext,
     baseLayoutPath: pluginStorage.baseLayoutPath,
-    crumb: safeGenerateCrumb(request),
     currentPath: `${request.path}${request.url.search}`,
     previewMode: isPreviewMode ? formState : undefined,
     slug: isResponseOK ? params?.slug : undefined

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

@@ -101,43 +101,6 @@ describe('Nunjucks context', () => {
         malformedRequest.server.plugins.crumb.generate
       ).not.toHaveBeenCalled()
     })
-
-    it('should generate crumb when state exists', async () => {
-      const mockCrumb = 'generated-crumb-value'
-      const validRequest = /** @type {FormRequest} */ (
-        /** @type {unknown} */ ({
-          server: {
-            plugins: {
-              crumb: {
-                generate: jest.fn().mockReturnValue(mockCrumb)
-              },
-              'forms-engine-plugin': {
-                baseLayoutPath: 'randomValue'
-              }
-            }
-          },
-          plugins: {},
-          route: {
-            settings: {
-              plugins: {}
-            }
-          },
-          path: '/test',
-          url: { search: '' },
-          state: {},
-          yar: {
-            flash: jest.fn().mockReturnValue([]),
-            commit: jest.fn()
-          }
-        })
-      )
-
-      const { crumb } = await context(validRequest)
-      expect(crumb).toBe(mockCrumb)
-      expect(validRequest.server.plugins.crumb.generate).toHaveBeenCalledWith(
-        validRequest
-      )
-    })
   })
 })
 

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

@@ -21,7 +21,9 @@ describe('Dummy API', () => {
 
   beforeAll(async () => {
     MockDate.set('2025-01-01T00:00:00Z')
-    server = await createServer()
+    server = await createServer({
+      enforceCsrf: false
+    })
     await server.initialize()
   })