feat DF-468: include form definition version in payload

package.json

@@ -70,7 +70,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.506",
+    "@defra/forms-model": "^3.0.552",
     "@defra/hapi-tracing": "^1.26.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",

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

@@ -141,6 +141,21 @@ describe('FormModel', () => {
       expect(model.schemaVersion).toBe(SchemaVersion.V1)
     })
 
+    it('sets versionNumber from options', () => {
+      const model = new FormModel(definition, {
+        basePath: 'test',
+        versionNumber: 42
+      })
+
+      expect(model.versionNumber).toBe(42)
+    })
+
+    it('sets versionNumber to undefined when not provided', () => {
+      const model = new FormModel(definition, { basePath: 'test' })
+
+      expect(model.versionNumber).toBeUndefined()
+    })
+
     it.each([
       {
         input: undefined,
@@ -329,6 +344,55 @@ describe('FormModel', () => {
       )
     })
 
+    it('includes submittedVersionNumber in context when versionNumber is set', () => {
+      const formModel = new FormModel(fieldsRequiredDefinition, {
+        basePath: '/components',
+        versionNumber: 123
+      })
+
+      const state = {
+        $$__referenceNumber: 'foobar'
+      }
+      const pageUrl = new URL('http://example.com/components/fields-required')
+
+      const request: FormContextRequest = buildFormContextRequest({
+        method: 'get',
+        query: {},
+        path: pageUrl.pathname,
+        params: { path: 'components', slug: 'fields-required' },
+        url: pageUrl,
+        app: { model: formModel }
+      })
+
+      const context = formModel.getFormContext(request, state)
+
+      expect(context.submittedVersionNumber).toBe(123)
+    })
+
+    it('sets submittedVersionNumber to undefined when versionNumber is not set', () => {
+      const formModel = new FormModel(fieldsRequiredDefinition, {
+        basePath: '/components'
+      })
+
+      const state = {
+        $$__referenceNumber: 'foobar'
+      }
+      const pageUrl = new URL('http://example.com/components/fields-required')
+
+      const request: FormContextRequest = buildFormContextRequest({
+        method: 'get',
+        query: {},
+        path: pageUrl.pathname,
+        params: { path: 'components', slug: 'fields-required' },
+        url: pageUrl,
+        app: { model: formModel }
+      })
+
+      const context = formModel.getFormContext(request, state)
+
+      expect(context.submittedVersionNumber).toBeUndefined()
+    })
+
     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'

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

@@ -76,6 +76,7 @@ export class FormModel {
   name: string
   values: FormDefinition
   basePath: string
+  versionNumber?: number
   conditions: Partial<Record<string, ExecutableCondition>>
   pages: PageControllerClass[]
   services: Services
@@ -94,7 +95,7 @@ export class FormModel {
 
   constructor(
     def: typeof this.def,
-    options: { basePath: string },
+    options: { basePath: string; versionNumber?: number },
     services: Services = defaultServices,
     controllers?: Record<string, typeof PageController>
   ) {
@@ -148,6 +149,7 @@ export class FormModel {
     this.name = def.name ?? ''
     this.values = result.value
     this.basePath = options.basePath
+    this.versionNumber = options.versionNumber
     this.conditions = {}
     this.services = services
     this.controllers = controllers
@@ -344,7 +346,8 @@ export class FormModel {
       componentDefMap: this.componentDefMap,
       pageMap: this.pageMap,
       componentMap: this.componentMap,
-      referenceNumber: getReferenceNumber(state)
+      referenceNumber: getReferenceNumber(state),
+      submittedVersionNumber: this.versionNumber
     }
 
     // Validate current page