fix(DF-922): add version fallback and remove unused versionNumber option

jest.setup.js

@@ -1,8 +1,27 @@
+import nock from 'nock'
+
 process.env.MANAGER_URL = 'http://manager'
-process.env.OIDC_JWKS_URI =
-  'https://login.microsoftonline.com/770a2450-0227-4c62-90c7-4e38537f1102/discovery/v2.0/keys'
+process.env.OIDC_JWKS_URI = 'https://oidc.test/.well-known/jwks.json'
 process.env.SHAREPOINT_TENANT_ID = '6f504113-6b64-43f2-ade9-242e05780007'
 process.env.SHAREPOINT_CLIENT_ID = 'dummy'
 process.env.SHAREPOINT_CLIENT_SECRET = 'dummy'
 process.env.SHAREPOINT_FORM_MAPPINGS =
   '{"mappings":[{"formId":"my-form-id","siteId":"my-site-id","listId":"my-list-id","status":"draft"}]}'
+
+const jwks = {
+  keys: [
+    {
+      alg: 'RS256',
+      e: 'AQAB',
+      kid: '9tuAErwpIu41FajLxmC9+8Y7kMXa0kO3sY=',
+      kty: 'RSA',
+      n: 'q3DaFfvNA0C8wOaVsx-P68LqF4U5NzQuz9',
+      use: 'sig'
+    }
+  ]
+}
+
+nock('https://oidc.test')
+  .persist()
+  .get('/.well-known/jwks.json')
+  .reply(200, jwks)

package.json

@@ -81,11 +81,12 @@
     "eslint-plugin-jest": "^28.14.0",
     "eslint-plugin-jsdoc": "^51.0.1",
     "globals": "^17.3.0",
-    "neostandard": "^0.12.2",
     "husky": "^9.1.7",
     "jest": "29.7.0",
     "lint-staged": "^16.1.2",
     "luxon": "^3.6.1",
+    "neostandard": "^0.12.2",
+    "nock": "14.0.12",
     "nunjucks": "3.2.4",
     "oidc-client-ts": "^3.2.1",
     "prettier": "^3.5.3",

src/lib/manager-config.test.js

@@ -5,6 +5,14 @@ import { getJson } from '~/src/lib/fetch.js'
 import { getFormDefinition, getFormMetadata } from '~/src/lib/manager.js'
 
 jest.mock('~/src/lib/fetch.js')
+jest.mock('~/src/helpers/logging/logger.js', () => ({
+  createLogger: () => ({
+    info: jest.fn(),
+    warn: jest.fn(),
+    error: jest.fn(),
+    debug: jest.fn()
+  })
+}))
 jest.mock('~/src/config/index.js', () => ({
   config: {
     get: jest.fn().mockReturnValueOnce('')

src/lib/manager.js

@@ -1,11 +1,14 @@
 import { FormStatus } from '@defra/forms-model'
 
 import { config } from '~/src/config/index.js'
+import { createLogger } from '~/src/helpers/logging/logger.js'
 import { getJson } from '~/src/lib/fetch.js'
 
 const managerUrl = config.get('managerUrl')
+const logger = createLogger()
+
 /**
- * Gets the form definition from the Forms Manager API∂
+ * Gets the form definition from the Forms Manager API
  * @param {string} formId
  * @param {FormStatus} formStatus
  * @param {number|undefined} versionNumber - Optional specific version to fetch
@@ -16,16 +19,27 @@ export async function getFormDefinition(formId, formStatus, versionNumber) {
     throw new Error('Missing MANAGER_URL')
   }
 
-  const statusPath = formStatus === FormStatus.Draft ? FormStatus.Draft : ''
-  const formUrl =
-    versionNumber || versionNumber === 0
-      ? new URL(
+  if (versionNumber !== undefined) {
+    try {
+      const { body: versionedBody } = await getJson(
+        new URL(
           `/forms/${formId}/versions/${versionNumber}/definition`,
           managerUrl
         )
-      : new URL(`/forms/${formId}/definition/${statusPath}`, managerUrl)
+      )
+      return versionedBody
+    } catch (err) {
+      logger.warn(
+        err,
+        `[getFormDefinition] Version ${versionNumber} not found for form ${formId}, falling back to current definition`
+      )
+    }
+  }
 
-  const { body } = await getJson(formUrl)
+  const statusPath = formStatus === FormStatus.Draft ? FormStatus.Draft : ''
+  const { body } = await getJson(
+    new URL(`/forms/${formId}/definition/${statusPath}`, managerUrl)
+  )
 
   return body
 }

src/lib/manager.test.js

@@ -5,6 +5,14 @@ import { getJson } from '~/src/lib/fetch.js'
 import { getFormDefinition, getFormMetadata } from '~/src/lib/manager.js'
 
 jest.mock('~/src/lib/fetch.js')
+jest.mock('~/src/helpers/logging/logger.js', () => ({
+  createLogger: () => ({
+    info: jest.fn(),
+    warn: jest.fn(),
+    error: jest.fn(),
+    debug: jest.fn()
+  })
+}))
 jest.mock('~/src/config/index.js', () => ({
   config: {
     get: jest.fn().mockReturnValueOnce('http://forms-manager')
@@ -91,6 +99,64 @@ describe('Manager', () => {
       expect(definition).toEqual(expectedDefinition)
     })
 
+    it('should fall back to current definition when versioned endpoint fails', async () => {
+      const expectedDefinition = buildDefinition()
+      const formId = '68a890909ab460290c289409'
+      const versionNumber = 5
+      jest
+        .mocked(getJson)
+        .mockRejectedValueOnce(new Error('Version not found'))
+        .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
+      const definition = await getFormDefinition(
+        formId,
+        FormStatus.Live,
+        versionNumber
+      )
+      expect(getJson).toHaveBeenCalledTimes(2)
+      expect(getJson).toHaveBeenNthCalledWith(
+        1,
+        expect.objectContaining({
+          href: 'http://forms-manager/forms/68a890909ab460290c289409/versions/5/definition'
+        })
+      )
+      expect(getJson).toHaveBeenNthCalledWith(
+        2,
+        expect.objectContaining({
+          href: 'http://forms-manager/forms/68a890909ab460290c289409/definition/'
+        })
+      )
+      expect(definition).toEqual(expectedDefinition)
+    })
+
+    it('should fall back to draft definition when versioned endpoint fails for draft status', async () => {
+      const expectedDefinition = buildDefinition()
+      const formId = '68a890909ab460290c289409'
+      const versionNumber = 2
+      jest
+        .mocked(getJson)
+        .mockRejectedValueOnce(new Error('Version not found'))
+        .mockResolvedValueOnce({ response: {}, body: expectedDefinition })
+      const definition = await getFormDefinition(
+        formId,
+        FormStatus.Draft,
+        versionNumber
+      )
+      expect(getJson).toHaveBeenCalledTimes(2)
+      expect(getJson).toHaveBeenNthCalledWith(
+        1,
+        expect.objectContaining({
+          href: 'http://forms-manager/forms/68a890909ab460290c289409/versions/2/definition'
+        })
+      )
+      expect(getJson).toHaveBeenNthCalledWith(
+        2,
+        expect.objectContaining({
+          href: 'http://forms-manager/forms/68a890909ab460290c289409/definition/draft'
+        })
+      )
+      expect(definition).toEqual(expectedDefinition)
+    })
+
     it('should handle version number 0 correctly', async () => {
       const expectedDefinition = buildDefinition()
       const formId = '68a890909ab460290c289409'

src/service/sharepoint.js

@@ -312,8 +312,7 @@ export async function saveToSharepointList(message) {
   const columnProperties = await createMapOfColumnProperties(siteId, listId)
 
   const formModel = new FormModel(replaceCustomControllers(definition), {
-    basePath: '',
-    versionNumber: versionMetadata?.versionNumber
+    basePath: ''
   })
 
   /** @type {Map<string, CellValue >} */