@defra/forms-engine-plugin 4.7.2 → 4.8.0

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

@@ -1,182 +0,0 @@
-import {
-  ComponentType,
-  ControllerType,
-  ControllerTypes,
-  PageTypes,
-  type Page
-} from '@defra/forms-model'
-
-import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import { PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
-import { getProxyUrlForLocalDevelopment } from '~/src/server/plugins/engine/pageControllers/helpers/index.js'
-import {
-  createPage,
-  type PageControllerType
-} from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
-import {
-  FileUploadPageController,
-  QuestionPageController,
-  RepeatPageController,
-  StartPageController,
-  StatusPageController,
-  SummaryPageController,
-  TerminalPageController
-} from '~/src/server/plugins/engine/pageControllers/index.js'
-import definition from '~/test/form/definitions/blank.js'
-
-describe('Page controller helpers', () => {
-  const examples = PageTypes.filter(
-    (pageType) =>
-      pageType.controller !== ControllerType.SummaryWithConfirmationEmail
-  ).map((pageType) => {
-    const pageDef = structuredClone(pageType)
-
-    let controller: PageControllerType | undefined
-
-    switch (pageDef.controller) {
-      case ControllerType.Start:
-        controller = StartPageController
-        break
-
-      case ControllerType.Page:
-        controller = QuestionPageController
-        break
-
-      case ControllerType.Terminal:
-        controller = TerminalPageController
-        break
-
-      case ControllerType.Repeat:
-        controller = RepeatPageController
-        break
-
-      case ControllerType.FileUpload:
-        controller = FileUploadPageController
-
-        // Avoid minimum component requirements
-        pageDef.components = [
-          {
-            type: ComponentType.FileUploadField,
-            name: 'fileUpload',
-            title: 'Upload something',
-            options: {},
-            schema: {}
-          }
-        ]
-        break
-
-      case ControllerType.Summary:
-        controller = SummaryPageController
-        break
-
-      case ControllerType.Status:
-        controller = StatusPageController
-        break
-    }
-
-    return {
-      controller,
-      pageDef
-    }
-  })
-
-  describe('Helper: createPage', () => {
-    const model = new FormModel(definition, {
-      basePath: 'test'
-    })
-
-    it.each([...examples])(
-      "creates page for controller '$pageDef.controller'",
-      ({ controller, pageDef }) => {
-        const pageDef1 = structuredClone(pageDef)
-        const pageDef2 = structuredClone(pageDef)
-
-        expect(createPage(model, pageDef1)).toBeInstanceOf(controller)
-
-        const controllerType = ControllerTypes.find(
-          ({ name }) => name === pageDef1.controller
-        )
-
-        // @ts-expect-error - Allow invalid property for test
-        pageDef2.controller = controllerType?.path
-
-        // Check for legacy path support
-        expect(createPage(model, pageDef2)).toBeInstanceOf(controller)
-      }
-    )
-
-    describe('Helper: createPage (custom controllers)', () => {
-      it('uses custom controllers from model.controllers', () => {
-        class CustomPageController extends PageController {
-          customProperty: string
-
-          constructor(model: FormModel, pageDef: Page) {
-            super(model, pageDef)
-            this.customProperty = 'some-value'
-          }
-        }
-
-        const customPageDef = {
-          path: '/custom-page',
-          title: 'Custom Page',
-          controller: 'CustomController',
-          components: []
-        }
-
-        const testModel = new FormModel(definition, {
-          basePath: 'test'
-        })
-
-        type ControllerMap = Record<string, typeof PageController>
-        testModel.controllers = {
-          CustomController: CustomPageController
-        } as ControllerMap
-
-        const controller = createPage(testModel, customPageDef as Page)
-
-        expect(controller).toBeInstanceOf(CustomPageController)
-        expect(controller).toHaveProperty('customProperty', 'some-value')
-      })
-    })
-
-    it('throws if page controller is unknown', () => {
-      const pageDef: Page = {
-        title: 'Unknown page',
-        path: '/unknown-page',
-        // @ts-expect-error - Allow invalid property for test
-        controller: 'UnknownPageController'
-      }
-
-      expect(() => createPage(model, pageDef)).toThrow(
-        `Page controller ${pageDef.controller} does not exist`
-      )
-    })
-  })
-
-  describe('Helper: getProxyUrlForLocalDevelopment', () => {
-    it('returns null if uploadUrl is undefined', () => {
-      expect(getProxyUrlForLocalDevelopment(undefined)).toBeNull()
-    })
-
-    it('returns null if uploadUrl does not include localhost:7337', () => {
-      expect(getProxyUrlForLocalDevelopment('https://some-url.com')).toBeNull()
-      expect(getProxyUrlForLocalDevelopment('http://localhost:8080')).toBeNull()
-    })
-
-    it('replaces localhost:7337 with uploader.127.0.0.1.sslip.io:7300', () => {
-      const originalUrl = 'http://localhost:7337/upload'
-      const expectedUrl = 'http://uploader.127.0.0.1.sslip.io:7300/upload'
-
-      expect(getProxyUrlForLocalDevelopment(originalUrl)).toBe(expectedUrl)
-    })
-
-    it('handles multiple occurrences of localhost:7337', () => {
-      const originalUrl =
-        'http://localhost:7337/path?redirect=http://localhost:7337/callback'
-      const expectedUrl =
-        'http://uploader.127.0.0.1.sslip.io:7300/path?redirect=http://uploader.127.0.0.1.sslip.io:7300/callback'
-
-      expect(getProxyUrlForLocalDevelopment(originalUrl)).toBe(expectedUrl)
-    })
-  })
-})

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

@@ -1,359 +0,0 @@
-import { ComponentType, ControllerType, type Page } from '@defra/forms-model'
-
-import { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
-import {
-  checkSaveAndExitRepeater,
-  copyNotYetValidatedState,
-  prefillStateFromQueryParameters,
-  stripParam
-} from '~/src/server/plugins/engine/pageControllers/helpers/state.js'
-import {
-  type AnyFormRequest,
-  type FormContext
-} from '~/src/server/plugins/engine/types.js'
-import { type FormsService, type Services } from '~/src/server/types.js'
-
-const mockGetCacheService = jest.fn()
-const mockCacheService = { setState: jest.fn() }
-
-jest.mock('~/src/server/plugins/engine/helpers.ts', () => ({
-  __esModule: true,
-  getCacheService: (...args: unknown[]) => mockGetCacheService(...args)
-}))
-
-function buildMockPage(
-  pagesOverride = {},
-  stateOverride = {},
-  servicesOverride = {} as Services
-) {
-  return {
-    model: {
-      def: {
-        metadata: {
-          submission: { code: 'TEST-CODE' }
-        } as { submission: { code: string } },
-        pages: pagesOverride
-      },
-      getFormContext: jest.fn().mockReturnValue({
-        isForceAccess: false,
-        data: {}
-      }),
-      services: servicesOverride
-    } as unknown as FormModel,
-    ...stateOverride
-  } as unknown as PageControllerClass
-}
-
-describe('State helpers', () => {
-  describe('prefillStateFromQueryParameters', () => {
-    const mockGetState = jest.fn()
-    const mockMergeState = jest.fn()
-    const mockRequestPrefill: AnyFormRequest = {
-      app: {},
-      yar: { flash: () => [] },
-      params: { path: 'test-path' },
-      query: {}
-    } as unknown as AnyFormRequest
-
-    it('should not add any state if no params', async () => {
-      const mockPagePrefill = buildMockPage([], {
-        getState: mockGetState,
-        mergeState: mockMergeState
-      })
-
-      expect(
-        await prefillStateFromQueryParameters(
-          mockRequestPrefill,
-          mockPagePrefill
-        )
-      ).toBeFalse()
-      expect(mockMergeState).not.toHaveBeenCalled()
-    })
-
-    it('should ignore if no params (but some hidden fields)', async () => {
-      const mockRequest2 = {
-        ...mockRequestPrefill,
-        query: {}
-      } as unknown as AnyFormRequest
-
-      const mockPagePrefill = buildMockPage(
-        [
-          {
-            components: [
-              {
-                type: ComponentType.HiddenField,
-                name: 'param2'
-              },
-              {
-                type: ComponentType.HiddenField,
-                name: 'param4'
-              }
-            ],
-            next: []
-          } as unknown as Page
-        ],
-        {
-          getState: mockGetState,
-          mergeState: mockMergeState
-        }
-      )
-
-      expect(
-        await prefillStateFromQueryParameters(mockRequest2, mockPagePrefill)
-      ).toBeFalse()
-      expect(mockMergeState).not.toHaveBeenCalled()
-    })
-
-    it('should only add state where param names match hidden field names', async () => {
-      const mockRequest2 = {
-        ...mockRequestPrefill,
-        query: {
-          param1: 'val1',
-          param2: 'val2',
-          param3: 'val3',
-          param4: 'val4'
-        }
-      } as unknown as AnyFormRequest
-
-      const mockPagePrefill = buildMockPage(
-        [
-          {
-            components: [
-              {
-                type: ComponentType.HiddenField,
-                name: 'param2'
-              },
-              {
-                type: ComponentType.HiddenField,
-                name: 'param4'
-              }
-            ],
-            next: []
-          } as unknown as Page
-        ],
-        {
-          getState: mockGetState.mockResolvedValue({}),
-          mergeState: mockMergeState
-        }
-      )
-
-      expect(
-        await prefillStateFromQueryParameters(mockRequest2, mockPagePrefill)
-      ).toBe(true)
-      expect(mockMergeState).toHaveBeenCalledWith(
-        expect.anything(),
-        expect.anything(),
-        {
-          param2: 'val2',
-          param4: 'val4'
-        }
-      )
-    })
-
-    it('should call lookup function for formId', async () => {
-      const mockRequest3 = {
-        ...mockRequestPrefill,
-        query: {
-          formId: 'c644804b-2f23-4c96-a2fc-ad4975974723'
-        }
-      } as unknown as AnyFormRequest
-
-      const mockPagePrefill = buildMockPage(
-        [
-          {
-            components: [
-              {
-                type: ComponentType.HiddenField,
-                name: 'formId'
-              }
-            ],
-            next: []
-          } as unknown as Page
-        ],
-        {
-          getState: mockGetState.mockResolvedValue({}),
-          mergeState: mockMergeState
-        },
-        {
-          formsService: {
-            getFormMetadata: jest.fn(),
-            getFormMetadataById: jest
-              .fn()
-              .mockResolvedValue({ title: 'My looked-up form name' }),
-            getFormDefinition: jest.fn()
-          } as unknown as FormsService
-        } as Services
-      )
-
-      await prefillStateFromQueryParameters(mockRequest3, mockPagePrefill)
-      expect(mockMergeState).toHaveBeenCalledWith(
-        expect.anything(),
-        expect.anything(),
-        {
-          formId: 'c644804b-2f23-4c96-a2fc-ad4975974723',
-          formName: 'My looked-up form name'
-        }
-      )
-    })
-  })
-
-  describe('stripParam', () => {
-    it('should remove param when exists', () => {
-      const params = {
-        paramName1: 'val1',
-        returnUrl: 'http://somesite.com',
-        paramName2: 'val2',
-        paramName3: undefined
-      }
-      expect(stripParam(params, 'returnUrl')).toStrictEqual({
-        paramName1: 'val1',
-        paramName2: 'val2',
-        paramName3: ''
-      })
-    })
-
-    it('should handle param missing', () => {
-      const params = {
-        paramName1: 'val1',
-        returnUrl: 'http://somesite.com',
-        paramName2: 'val2'
-      }
-      expect(stripParam(params, 'paramNotThere')).toStrictEqual({
-        paramName1: 'val1',
-        returnUrl: 'http://somesite.com',
-        paramName2: 'val2'
-      })
-    })
-
-    it('should handle no params', () => {
-      const params = {}
-      expect(stripParam(params, 'anyParam')).toBeUndefined()
-    })
-  })
-
-  describe('copyNotYetValidatedState', () => {
-    beforeEach(() => {
-      mockGetCacheService.mockReturnValue(mockCacheService)
-    })
-    it('should ignore if no invalid state', async () => {
-      const mockRequest = {} as AnyFormRequest
-      const mockContext = {
-        state: { abc: '123' },
-        payload: {}
-      } as unknown as FormContext
-      await copyNotYetValidatedState(mockRequest, mockContext)
-      expect(mockContext.state).toEqual({ abc: '123' })
-      expect(mockContext.payload).toEqual({})
-    })
-
-    it('should ignore if wrong path', async () => {
-      const mockRequest = {
-        url: {
-          pathname: '/form-page1'
-        }
-      } as unknown as AnyFormRequest
-      const mockContext = {
-        state: {
-          abc: '123',
-          __stateNotYetValidated: {
-            def: '456',
-            __currentPagePath: '/root'
-          }
-        },
-        payload: {}
-      } as unknown as FormContext
-      await copyNotYetValidatedState(mockRequest, mockContext)
-      expect(mockContext.state).toEqual({
-        abc: '123',
-        __stateNotYetValidated: {
-          def: '456',
-          __currentPagePath: '/root'
-        }
-      })
-      expect(mockContext.payload).toEqual({})
-    })
-
-    it('should apply if correct path', async () => {
-      const mockRequest = {
-        url: {
-          pathname: '/form-page1'
-        }
-      } as unknown as AnyFormRequest
-      const mockContext = {
-        state: {
-          abc: '123',
-          __stateNotYetValidated: {
-            def: '456',
-            __currentPagePath: '/form-page1'
-          }
-        },
-        payload: {}
-      } as unknown as FormContext
-      await copyNotYetValidatedState(mockRequest, mockContext)
-      expect(mockContext.state).toEqual({
-        abc: '123',
-        __stateNotYetValidated: undefined
-      })
-      expect(mockContext.payload).toEqual({
-        def: '456'
-      })
-    })
-  })
-
-  describe('checkSaveAndExitRepeater', () => {
-    function createMockContextWithPath(path: string) {
-      return {
-        state: {
-          abc: '123',
-          __stateNotYetValidated: {
-            def: '456',
-            __currentPagePath: path
-          }
-        },
-        payload: {}
-      } as unknown as FormContext
-    }
-
-    const mockModel = {
-      def: {
-        pages: [
-          {
-            controller: ControllerType.Repeat,
-            path: '/personal_details'
-          }
-        ]
-      },
-      basePath: 'form/preview/draft/repeater-test'
-    } as unknown as FormModel
-
-    it('should return undefined if url does not end in a guid', () => {
-      const mockContext = createMockContextWithPath(
-        '/form/preview/draft/repeater-test/personal_details'
-      )
-      expect(checkSaveAndExitRepeater(mockContext, mockModel)).toBeUndefined()
-    })
-
-    it('should return undefined if url ends in a guid but not a repeater path', () => {
-      const mockContext = createMockContextWithPath(
-        '/form/preview/draft/repeater-test/wrong_page/7d27fe6e-73e8-4265-84bd-1e118c92470b'
-      )
-      expect(checkSaveAndExitRepeater(mockContext, mockModel)).toBeUndefined()
-    })
-
-    it('should return undefined if url is not a string', () => {
-      // @ts-expect-error - invalid dataype on purpose for this test
-      const mockContext = createMockContextWithPath({})
-      expect(checkSaveAndExitRepeater(mockContext, mockModel)).toBeUndefined()
-    })
-
-    it('should return correct urls if url ends in a guid and is a repeater path', () => {
-      const mockContext = createMockContextWithPath(
-        '/form/preview/draft/repeater-test/personal_details/7d27fe6e-73e8-4265-84bd-1e118c92470b'
-      )
-      expect(checkSaveAndExitRepeater(mockContext, mockModel)).toBe(
-        '/form/preview/draft/repeater-test/personal_details/7d27fe6e-73e8-4265-84bd-1e118c92470b'
-      )
-    })
-  })
-})