@defra/forms-engine-plugin 4.7.2 → 4.7.3

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

@@ -1,279 +0,0 @@
-import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import { RepeatPageController } from '~/src/server/plugins/engine/pageControllers/RepeatPageController.js'
-import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
-import {
-  server,
-  serverWithSaveAndExit
-} from '~/src/server/plugins/engine/pageControllers/__stubs__/server.js'
-import {
-  type FormContextRequest,
-  type FormPageViewModel,
-  type FormSubmissionError,
-  type RepeatListState,
-  type RepeaterSummaryPageViewModel
-} from '~/src/server/plugins/engine/types.js'
-import definition from '~/test/form/definitions/repeat.js'
-
-describe('RepeatPageController', () => {
-  const itemId1 = 'abc-123'
-  const itemId2 = 'xyz-987'
-
-  let pageUrl: URL
-  let pageItemUrl: URL
-  let pageSummaryUrl: URL
-
-  let model: FormModel
-  let controller: RepeatPageController
-  let requestPage: FormContextRequest
-  let requestPageItem: FormContextRequest
-  let requestPageSummary: FormContextRequest
-
-  beforeEach(() => {
-    const { pages } = definition
-
-    pageUrl = new URL('/repeat/pizza-order', 'http://example.com')
-
-    pageItemUrl = new URL(
-      `${pageUrl.pathname}/${itemId1}`,
-      'http://example.com'
-    )
-
-    pageSummaryUrl = new URL(
-      `${pageUrl.pathname}/summary`,
-      'http://example.com'
-    )
-
-    model = new FormModel(definition, {
-      basePath: 'test'
-    })
-
-    controller = new RepeatPageController(model, pages[0])
-
-    requestPage = buildFormContextRequest({
-      method: 'get',
-      url: pageUrl,
-      path: pageUrl.pathname,
-      params: {
-        path: 'pizza-order',
-        slug: 'repeat'
-      },
-      query: {},
-      app: { model }
-    })
-
-    requestPageItem = {
-      method: 'get',
-      url: pageItemUrl,
-      path: pageItemUrl.pathname,
-      params: {
-        path: 'pizza-order',
-        slug: 'repeat',
-        itemId: itemId1
-      },
-      query: {},
-      app: { model },
-      server
-    }
-
-    requestPageSummary = {
-      method: 'get',
-      url: pageSummaryUrl,
-      path: pageSummaryUrl.pathname,
-      params: {
-        path: 'pizza-order',
-        slug: 'repeat'
-      },
-      query: {},
-      app: { model },
-      server
-    }
-  })
-
-  describe('Properties', () => {
-    it('returns summary view name', () => {
-      expect(controller).toHaveProperty(
-        'listSummaryViewName',
-        'repeat-list-summary'
-      )
-    })
-
-    it('returns delete view name', () => {
-      expect(controller).toHaveProperty('listDeleteViewName', 'item-delete')
-    })
-
-    it('returns repeater config', () => {
-      expect(controller).toHaveProperty('repeat', {
-        options: {
-          name: 'pizza',
-          title: 'Pizza'
-        },
-        schema: {
-          max: 3,
-          min: 2
-        }
-      })
-    })
-  })
-
-  describe('Path methods', () => {
-    describe('Summary path', () => {
-      it('returns path to summary page', () => {
-        expect(controller.getSummaryPath()).toBe('/summary')
-      })
-
-      it('returns path to repeater summary page', () => {
-        expect(controller.getSummaryPath(requestPage)).toBe(
-          '/pizza-order/summary'
-        )
-      })
-    })
-  })
-
-  describe('Item view model', () => {
-    let viewModel: FormPageViewModel
-
-    beforeEach(() => {
-      viewModel = controller.getViewModel(
-        requestPageItem,
-        model.getFormContext(requestPageItem, { $$__referenceNumber: 'foobar' })
-      )
-    })
-
-    it('updates section title with repeater title and count', () => {
-      expect(viewModel).toHaveProperty('sectionTitle', 'Food: Pizza 1')
-    })
-  })
-
-  describe.each([
-    {
-      description: 'No items',
-      list: [] satisfies RepeatListState,
-      viewModel: {
-        pageTitle: 'You have added 0 answers',
-        showTitle: true,
-        sectionTitle: 'Food'
-      }
-    },
-    {
-      description: '1 item',
-      list: [
-        {
-          itemId: itemId1,
-          toppings: 'Ham',
-          quantity: 2
-        }
-      ] satisfies RepeatListState,
-      viewModel: {
-        pageTitle: 'You have added 1 answer',
-        showTitle: true,
-        sectionTitle: 'Food'
-      }
-    },
-    {
-      description: '2 items',
-      list: [
-        {
-          itemId: itemId1,
-          toppings: 'Ham',
-          quantity: 2
-        },
-        {
-          itemId: itemId2,
-          toppings: 'Cheese',
-          quantity: 1
-        }
-      ] satisfies RepeatListState,
-      viewModel: {
-        pageTitle: 'You have added 2 answers',
-        showTitle: true,
-        sectionTitle: 'Food'
-      }
-    }
-  ])(
-    'List summary view model ($description)',
-    ({ list, viewModel: expected }) => {
-      let viewModel: RepeaterSummaryPageViewModel
-
-      beforeEach(() => {
-        viewModel = controller.getListSummaryViewModel(
-          requestPageSummary,
-          model.getFormContext(requestPageSummary, {
-            $$__referenceNumber: 'foobar'
-          }),
-          list
-        )
-      })
-
-      it('should customise page title', () => {
-        expect(viewModel).toHaveProperty('pageTitle', expected.pageTitle)
-        expect(viewModel).toHaveProperty('showTitle', expected.showTitle)
-      })
-
-      it('should extend default view model', () => {
-        const defaults = controller.viewModel
-
-        expect(viewModel).toHaveProperty('name', defaults.name)
-        expect(viewModel).toHaveProperty('page', defaults.page)
-        expect(viewModel).toHaveProperty('sectionTitle', expected.sectionTitle)
-        expect(viewModel).toHaveProperty('isStartPage', defaults.isStartPage)
-        expect(viewModel).toHaveProperty('serviceUrl', defaults.serviceUrl)
-        expect(viewModel).toHaveProperty('feedbackLink', defaults.feedbackLink)
-
-        // Unless overridden
-        expect(viewModel).not.toHaveProperty('pageTitle', defaults.pageTitle)
-      })
-    }
-  )
-
-  describe('Form validation', () => {
-    it('includes title text and errors', () => {
-      const result = controller.collection.validate()
-
-      expect(result.errors).toEqual<FormSubmissionError[]>([
-        {
-          path: ['toppings'],
-          href: '#toppings',
-          name: 'toppings',
-          text: 'Select toppings',
-          context: {
-            key: 'toppings',
-            label: 'Toppings',
-            title: 'Toppings'
-          }
-        },
-        {
-          path: ['quantity'],
-          href: '#quantity',
-          name: 'quantity',
-          text: 'Enter quantity',
-          context: {
-            key: 'quantity',
-            label: 'Quantity',
-            title: 'Quantity'
-          }
-        },
-        {
-          path: ['itemId'],
-          href: '#itemId',
-          name: 'itemId',
-          text: 'Select itemId',
-          context: {
-            key: 'itemId',
-            label: 'itemId'
-          }
-        }
-      ])
-    })
-
-    it('includes all field errors', () => {
-      const result = controller.collection.validate()
-      expect(result.errors).toHaveLength(3)
-    })
-  })
-
-  describe('shouldShowSaveAndExit', () => {
-    it('should return true when save and exit is enabled', () => {
-      expect(controller.shouldShowSaveAndExit(serverWithSaveAndExit)).toBe(true)
-    })
-  })
-})

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

@@ -1,32 +0,0 @@
-import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import { StartPageController } from '~/src/server/plugins/engine/pageControllers/StartPageController.js'
-import { serverWithSaveAndExit } from '~/src/server/plugins/engine/pageControllers/__stubs__/server.js'
-import definition from '~/test/form/definitions/basic.js'
-
-describe('StartPageController', () => {
-  let model: FormModel
-  let controller: StartPageController
-
-  beforeEach(() => {
-    model = new FormModel(definition, {
-      basePath: 'test'
-    })
-
-    // Create a mock page for StartPageController
-    const mockPage = {
-      ...definition.pages[0],
-      controller: 'start'
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    controller = new StartPageController(model, mockPage as any)
-  })
-
-  describe('shouldShowSaveAndExit', () => {
-    it('should return false (StartPageController does not allow save and exit)', () => {
-      expect(controller.shouldShowSaveAndExit(serverWithSaveAndExit)).toBe(
-        false
-      )
-    })
-  })
-})

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

@@ -1,32 +0,0 @@
-import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import { StatusPageController } from '~/src/server/plugins/engine/pageControllers/StatusPageController.js'
-import { serverWithSaveAndExit } from '~/src/server/plugins/engine/pageControllers/__stubs__/server.js'
-import definition from '~/test/form/definitions/basic.js'
-
-describe('StatusPageController', () => {
-  let model: FormModel
-  let controller: StatusPageController
-
-  beforeEach(() => {
-    model = new FormModel(definition, {
-      basePath: 'test'
-    })
-
-    // Create a mock page for StatusPageController
-    const mockPage = {
-      ...definition.pages[0],
-      controller: 'status'
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    controller = new StatusPageController(model, mockPage as any)
-  })
-
-  describe('shouldShowSaveAndExit', () => {
-    it('should return false (StatusPageController does not allow save and exit)', () => {
-      expect(controller.shouldShowSaveAndExit(serverWithSaveAndExit)).toBe(
-        false
-      )
-    })
-  })
-})

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

@@ -1,89 +0,0 @@
-import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import { SummaryPageController } from '~/src/server/plugins/engine/pageControllers/SummaryPageController.js'
-import { buildFormRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
-import { type FormSubmissionState } from '~/src/server/plugins/engine/types.js'
-import {
-  type FormRequest,
-  type FormRequestPayload,
-  type FormResponseToolkit
-} from '~/src/server/routes/types.js'
-import { type CacheService } from '~/src/server/services/cacheService.js'
-import definition from '~/test/form/definitions/basic.js'
-
-describe('SummaryPageController', () => {
-  let model: FormModel
-  let controller: SummaryPageController
-  let requestPage: FormRequest
-
-  const response = {
-    code: jest.fn().mockImplementation(() => response)
-  }
-  const h: FormResponseToolkit = {
-    redirect: jest.fn().mockReturnValue(response),
-    view: jest.fn(),
-    continue: Symbol('continue')
-  }
-
-  beforeEach(() => {
-    model = new FormModel(definition, {
-      basePath: 'test'
-    })
-
-    // Create a mock page for SummaryPageController
-    const mockPage = {
-      ...definition.pages[0],
-      controller: 'summary'
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    controller = new SummaryPageController(model, mockPage as any)
-
-    requestPage = buildFormRequest({
-      method: 'get',
-      url: new URL('http://example.com/test/summary'),
-      path: '/test/summary',
-      params: {
-        path: 'summary',
-        slug: 'test'
-      },
-      query: {},
-      app: { model }
-    } as FormRequest)
-  })
-
-  describe('handleSaveAndExit', () => {
-    it('should invoke saveAndExit plugin option', async () => {
-      const saveAndExitMock = jest.fn(() => ({}))
-      const state: FormSubmissionState = {
-        $$__referenceNumber: 'foobar',
-        licenceLength: 365,
-        fullName: 'John Smith'
-      }
-      const request = {
-        ...requestPage,
-        server: {
-          plugins: {
-            'forms-engine-plugin': {
-              saveAndExit: saveAndExitMock,
-              cacheService: {
-                clearState: jest.fn()
-              } as unknown as CacheService
-            }
-          }
-        },
-        method: 'post',
-        payload: { fullName: 'John Smith', action: 'save-and-exit' }
-      } as unknown as FormRequestPayload
-
-      const context = model.getFormContext(request, state)
-
-      const postHandler = controller.makePostRouteHandler()
-      await postHandler(request, context, h)
-
-      expect(saveAndExitMock).toHaveBeenCalledWith(request, h, context)
-    })
-  })
-
-  // Note: InvalidComponentStateError handling is comprehensively tested
-  // in the integration test: test/form/component-state-errors.test.js
-})

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

@@ -1,37 +0,0 @@
-import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import { TerminalPageController } from '~/src/server/plugins/engine/pageControllers/TerminalPageController.js'
-import { serverWithSaveAndExit } from '~/src/server/plugins/engine/pageControllers/__stubs__/server.js'
-import definition from '~/test/form/definitions/basic.js'
-
-describe('TerminalController', () => {
-  let model: FormModel
-  let controller1: TerminalPageController
-
-  beforeEach(() => {
-    const { pages } = definition
-
-    const page1 = pages[0]
-
-    model = new FormModel(definition, {
-      basePath: 'test'
-    })
-
-    controller1 = new TerminalPageController(model, page1)
-  })
-
-  describe('Route handlers', () => {
-    it('does not support POST route handler', () => {
-      expect(() => controller1.makePostRouteHandler()).toThrow(
-        'POST method not allowed for terminal pages'
-      )
-    })
-  })
-
-  describe('shouldShowSaveAndExit', () => {
-    it('should return false (TerminalPageController does not allow save and exit)', () => {
-      expect(controller1.shouldShowSaveAndExit(serverWithSaveAndExit)).toBe(
-        false
-      )
-    })
-  })
-})

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

@@ -1,78 +0,0 @@
-import { ComponentType } from '@defra/forms-model'
-
-import { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'
-import { TextField } from '~/src/server/plugins/engine/components/TextField.js'
-import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import {
-  InvalidComponentStateError,
-  PaymentSubmissionError
-} from '~/src/server/plugins/engine/pageControllers/errors.js'
-import definition from '~/test/form/definitions/file-upload-basic.js'
-
-describe('InvalidComponentStateError', () => {
-  let model: FormModel
-
-  beforeEach(() => {
-    model = new FormModel(definition, {
-      basePath: 'test'
-    })
-  })
-
-  describe('getStateKeys', () => {
-    it('should return component name and nested upload path for FileUploadField', () => {
-      const page = model.pages.find((p) => p.path === '/file-upload-component')
-      const component = new FileUploadField(
-        {
-          name: 'fileUpload',
-          title: 'Upload something',
-          type: ComponentType.FileUploadField,
-          options: {},
-          schema: {}
-        },
-        { model, page }
-      )
-
-      const error = new InvalidComponentStateError(
-        component,
-        'Test error message'
-      )
-      const stateKeys = error.getStateKeys()
-
-      expect(stateKeys).toEqual([
-        'fileUpload',
-        "upload['/file-upload-component']"
-      ])
-    })
-
-    it('should return only component name for non-FileUploadField components', () => {
-      const page = model.pages.find((p) => p.path === '/file-upload-component')
-      const component = new TextField(
-        {
-          name: 'textField',
-          title: 'Text field',
-          type: ComponentType.TextField,
-          options: {},
-          schema: {}
-        },
-        { model, page }
-      )
-
-      const error = new InvalidComponentStateError(
-        component,
-        'Test error message'
-      )
-      const stateKeys = error.getStateKeys()
-
-      expect(stateKeys).toEqual(['textField'])
-    })
-  })
-
-  describe('PaymentSubmissionError', () => {
-    it('should instantiate', () => {
-      const error = new PaymentSubmissionError('reference-number', '/help-link')
-      expect(error).toBeDefined()
-      expect(error.referenceNumber).toBe('reference-number')
-      expect(error.helpLink).toBe('/help-link')
-    })
-  })
-})