@defra/forms-engine-plugin 4.7.2 → 4.8.0

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

@@ -1,502 +0,0 @@
-import Boom from '@hapi/boom'
-import { type ResponseObject } from '@hapi/hapi'
-import nock from 'nock'
-
-import { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
-import { redirectOrMakeHandler } from '~/src/server/plugins/engine/routes/index.js'
-import {
-  makeGetHandler,
-  makePostHandler
-} from '~/src/server/plugins/engine/routes/questions.js'
-import {
-  type AnyFormRequest,
-  type FormContext
-} from '~/src/server/plugins/engine/types.js'
-import {
-  type FormRequest,
-  type FormRequestPayload,
-  type FormResponseToolkit
-} from '~/src/server/routes/types.js'
-jest.mock('~/src/server/plugins/engine/models/SummaryViewModel', () => ({
-  SummaryViewModel: class {
-    summary = 'mocked summary'
-  }
-}))
-
-jest.mock(
-  '~/src/server/plugins/engine/pageControllers/SummaryPageController',
-  () => ({
-    getFormSubmissionData: jest.fn().mockReturnValue([])
-  })
-)
-
-jest.mock('~/src/server/plugins/engine/outputFormatters/machine/v1', () => ({
-  format: jest.fn().mockReturnValue('mocked format')
-}))
-
-jest.mock('~/src/server/plugins/engine/routes/index')
-
-describe('makeGetHandler', () => {
-  const hMock: FormResponseToolkit = {
-    redirect: jest.fn().mockReturnValue({
-      takeover: jest.fn().mockReturnValue({
-        statusCode: 302,
-        headers: { location: '/redirect-url' }
-      })
-    }),
-    view: jest.fn(),
-    continue: Symbol('continue')
-  }
-
-  beforeEach(() => {
-    nock('http://test').persist().post('/load').reply(200, {
-      wasGetCalled: true
-    })
-  })
-
-  afterEach(() => {
-    jest.mocked(redirectOrMakeHandler).mockRestore()
-    nock.cleanAll()
-  })
-
-  it('calls the callback when events.onLoad.type is http', async () => {
-    let data = {}
-
-    const modelMock = {
-      basePath: 'some-base-path',
-      def: { name: 'Hello world' }
-    } as FormModel
-
-    const pageMock = createMockPageController(
-      modelMock,
-      (
-        _request: FormRequest,
-        context: FormContext,
-        _h: FormResponseToolkit
-      ) => {
-        data = context.data
-        return Promise.resolve({} as unknown as ResponseObject)
-      }
-    )
-
-    const contextMock = { data: {}, model: {} } as unknown as FormContext
-
-    const requestMock = {
-      params: { path: 'some-path' },
-      app: { model: modelMock }
-    } as FormRequest
-
-    jest
-      .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        (_req: AnyFormRequest, _h: FormResponseToolkit, _onRequest, fn) =>
-          Promise.resolve(fn(pageMock, contextMock))
-      )
-
-    await makeGetHandler()(requestMock, hMock)
-
-    expect(data).toMatchObject({
-      wasGetCalled: true
-    })
-  })
-
-  it('does not call the callback when the events.onLoad.type is not http', async () => {
-    let data = {}
-
-    const modelMock = {
-      basePath: 'some-base-path',
-      def: { name: 'Hello world' }
-    } as FormModel
-
-    const pageMock = createMockPageController(
-      modelMock,
-      (
-        _request: FormRequest,
-        context: FormContext,
-        _h: FormResponseToolkit
-      ) => {
-        data = context.data
-        return Promise.resolve({} as unknown as ResponseObject)
-      }
-    )
-
-    pageMock.events = {}
-
-    const contextMock = { data: {}, model: {} } as unknown as FormContext
-
-    const requestMock = {
-      params: { path: 'some-path' },
-      app: { model: modelMock }
-    } as FormRequest
-
-    jest
-      .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        (_req: AnyFormRequest, _h: FormResponseToolkit, _onRequest, fn) =>
-          Promise.resolve(fn(pageMock, contextMock))
-      )
-
-    await makeGetHandler()(requestMock, hMock)
-
-    expect(data).toMatchObject({})
-  })
-
-  it('throws when model is missing', async () => {
-    let error
-
-    const modelMock = {
-      basePath: 'some-base-path',
-      def: { name: 'Hello world' }
-    } as FormModel
-
-    const pageMock = createMockPageController(
-      modelMock,
-      (
-        _request: FormRequest,
-        _context: FormContext,
-        _h: FormResponseToolkit
-      ) => {
-        return Promise.resolve({} as unknown as ResponseObject)
-      }
-    )
-
-    const contextMock = { data: {}, model: {} } as unknown as FormContext
-
-    const requestMock = {
-      params: { path: 'some-path' },
-      app: {}
-    } as FormRequest
-
-    jest
-      .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        async (
-          _req: AnyFormRequest,
-          _h: FormResponseToolkit,
-          _onRequest,
-          fn
-        ) => {
-          try {
-            await fn(pageMock, contextMock)
-          } catch (err) {
-            error = err
-          }
-
-          return Promise.resolve({} as unknown as ResponseObject)
-        }
-      )
-
-    await makeGetHandler()(requestMock, hMock)
-
-    expect(error).toEqual(Boom.notFound('No model found for /some-path'))
-  })
-
-  it('should pass onRequest callback to redirectOrMakeHandler', async () => {
-    const onRequestCallback = jest.fn().mockResolvedValue(undefined)
-    const modelMock = {
-      basePath: 'some-base-path',
-      def: { name: 'Hello world' }
-    } as FormModel
-
-    const pageMock = createMockPageController(
-      modelMock,
-      (
-        _request: FormRequest,
-        _context: FormContext,
-        _h: FormResponseToolkit
-      ) => {
-        return Promise.resolve({} as unknown as ResponseObject)
-      }
-    )
-
-    const contextMock = { data: {}, model: {} } as unknown as FormContext
-
-    const requestMock = {
-      params: { path: 'some-path' },
-      app: { model: modelMock }
-    } as FormRequest
-
-    jest
-      .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        (_req: AnyFormRequest, _h: FormResponseToolkit, onRequest, fn) => {
-          expect(onRequest).toBe(onRequestCallback)
-          return Promise.resolve(fn(pageMock, contextMock))
-        }
-      )
-
-    await makeGetHandler(undefined, onRequestCallback)(requestMock, hMock)
-
-    expect(redirectOrMakeHandler).toHaveBeenCalledWith(
-      requestMock,
-      hMock,
-      onRequestCallback,
-      expect.any(Function)
-    )
-  })
-})
-
-describe('makePostHandler', () => {
-  const hMock: FormResponseToolkit = {
-    redirect: jest.fn(),
-    view: jest.fn(),
-    continue: Symbol('continue')
-  }
-
-  beforeEach(() => {
-    nock('http://test').post('/save').reply(200, {
-      wasPostCalled: true
-    })
-  })
-
-  afterEach(() => {
-    jest.mocked(redirectOrMakeHandler).mockRestore()
-    nock.cleanAll()
-  })
-
-  it('calls the callback when events.onSave.type is http and the page controller was successful', async () => {
-    const mockPostResponse: ResponseObject = {
-      statusCode: 200
-    } as ResponseObject
-
-    const modelMock = {
-      basePath: 'some-base-path',
-      def: { name: 'Hello world' }
-    } as FormModel
-
-    const pageMock = createMockPageController(
-      modelMock,
-      (
-        _request: FormRequest,
-        _context: FormContext,
-        _h: FormResponseToolkit
-      ) => {
-        // do return a valid ResponseObject wrapped in Promise.resolve
-        return mockPostResponse
-      }
-    )
-
-    const contextMock = { data: {}, model: {} } as unknown as FormContext
-
-    const requestMock = {
-      params: { path: 'some-path' },
-      app: { model: modelMock },
-      payload: { some: 'payload' }
-    } as unknown as FormRequestPayload
-
-    jest
-      .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        (_req: AnyFormRequest, _h: FormResponseToolkit, _onRequest, fn) =>
-          Promise.resolve(fn(pageMock, contextMock))
-      )
-
-    const response = await makePostHandler()(requestMock, hMock)
-
-    expect(nock.pendingMocks()).toBeEmpty()
-    expect(response).toBe(mockPostResponse)
-  })
-
-  it('does not call the callback when the events.onSave.type is not http', async () => {
-    const modelMock = {
-      basePath: 'some-base-path',
-      def: { name: 'Hello world' }
-    } as FormModel
-
-    const pageMock = createMockPageController(
-      modelMock,
-      (
-        _request: FormRequest,
-        _context: FormContext,
-        _h: FormResponseToolkit
-      ) => {
-        return Promise.resolve({} as unknown as ResponseObject)
-      }
-    )
-
-    pageMock.events = {}
-
-    const contextMock = { data: {}, model: {} } as unknown as FormContext
-
-    const requestMock = {
-      params: { path: 'some-path' },
-      app: { model: modelMock },
-      payload: { some: 'payload' }
-    } as unknown as FormRequestPayload
-
-    jest
-      .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        (_req: AnyFormRequest, _h: FormResponseToolkit, _onRequest, fn) =>
-          Promise.resolve(fn(pageMock, contextMock))
-      )
-
-    await makePostHandler()(requestMock, hMock)
-
-    expect(nock.pendingMocks()).not.toBeEmpty()
-  })
-
-  it('does not call the callback when events.onSave.type is http and the page controller was unsuccessful', async () => {
-    const mockPostResponse: ResponseObject = {
-      statusCode: 500
-    } as ResponseObject
-
-    const modelMock = {
-      basePath: 'some-base-path',
-      def: { name: 'Hello world' }
-    } as FormModel
-
-    const pageMock = createMockPageController(
-      modelMock,
-      (
-        _request: FormRequest,
-        _context: FormContext,
-        _h: FormResponseToolkit
-      ) => {
-        // do return a valid ResponseObject wrapped in Promise.resolve
-        return mockPostResponse
-      }
-    )
-
-    const contextMock = { data: {}, model: {} } as unknown as FormContext
-
-    const requestMock = {
-      params: { path: 'some-path' },
-      app: { model: modelMock },
-      payload: { some: 'payload' }
-    } as unknown as FormRequestPayload
-
-    jest
-      .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        (_req: AnyFormRequest, _h: FormResponseToolkit, _onRequest, fn) =>
-          Promise.resolve(fn(pageMock, contextMock))
-      )
-
-    await makePostHandler()(requestMock, hMock)
-
-    expect(nock.pendingMocks()).not.toBeEmpty()
-  })
-
-  it('throws when model is missing', async () => {
-    let error
-
-    const modelMock = {
-      basePath: 'some-base-path',
-      def: { name: 'Hello world' }
-    } as FormModel
-
-    const pageMock = createMockPageController(
-      modelMock,
-      (
-        _request: FormRequest,
-        _context: FormContext,
-        _h: FormResponseToolkit
-      ) => {
-        return Promise.resolve({} as unknown as ResponseObject)
-      }
-    )
-
-    const contextMock = { data: {}, model: {} } as unknown as FormContext
-
-    const requestMock = {
-      params: { path: 'some-path' },
-      app: {},
-      payload: { some: 'payload' }
-    } as unknown as FormRequestPayload
-
-    jest
-      .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        async (
-          _req: AnyFormRequest,
-          _h: FormResponseToolkit,
-          _onRequest,
-          fn
-        ) => {
-          try {
-            await fn(pageMock, contextMock)
-          } catch (err) {
-            error = err
-          }
-
-          return Promise.resolve({} as unknown as ResponseObject)
-        }
-      )
-
-    await makePostHandler()(requestMock, hMock)
-
-    expect(error).toEqual(Boom.notFound('No model found for /some-path'))
-  })
-
-  it('should pass onRequest callback to redirectOrMakeHandler', async () => {
-    const onRequestCallback = jest.fn().mockResolvedValue(undefined)
-    const modelMock = {
-      basePath: 'some-base-path',
-      def: { name: 'Hello world' }
-    } as FormModel
-
-    const pageMock = createMockPageController(
-      modelMock,
-      (
-        _request: FormRequest,
-        _context: FormContext,
-        _h: FormResponseToolkit
-      ) => {
-        return Promise.resolve({} as unknown as ResponseObject)
-      }
-    )
-
-    const contextMock = { data: {}, model: {} } as unknown as FormContext
-
-    const requestMock = {
-      params: { path: 'some-path' },
-      app: { model: modelMock },
-      payload: { some: 'payload' }
-    } as unknown as FormRequestPayload
-
-    jest
-      .mocked(redirectOrMakeHandler)
-      .mockImplementation(
-        (_req: AnyFormRequest, _h: FormResponseToolkit, onRequest, fn) => {
-          expect(onRequest).toBe(onRequestCallback)
-          return Promise.resolve(fn(pageMock, contextMock))
-        }
-      )
-
-    await makePostHandler(undefined, onRequestCallback)(requestMock, hMock)
-
-    expect(redirectOrMakeHandler).toHaveBeenCalledWith(
-      requestMock,
-      hMock,
-      onRequestCallback,
-      expect.any(Function)
-    )
-  })
-})
-
-function createMockPageController(
-  model: FormModel,
-  routeHandler: (
-    request: FormRequest,
-    context: FormContext,
-    h: FormResponseToolkit
-  ) => ResponseObject | Promise<ResponseObject>
-): PageControllerClass {
-  return {
-    model,
-    events: {
-      onLoad: {
-        type: 'http',
-        options: { method: 'POST', url: 'http://test/load' }
-      },
-      onSave: {
-        type: 'http',
-        options: { method: 'POST', url: 'http://test/save' }
-      }
-    },
-    makeGetRouteHandler: () => routeHandler,
-    makePostRouteHandler: () => routeHandler
-  } as unknown as PageControllerClass
-}

package/src/server/plugins/engine/routes/repeaters/item-delete.test.ts

@@ -1,83 +0,0 @@
-import { getRoutes } from '~/src/server/plugins/engine/routes/repeaters/item-delete.js'
-import { type OnRequestCallback } from '~/src/server/plugins/engine/types.js'
-
-describe('repeater item-delete routes', () => {
-  beforeEach(() => {
-    jest.clearAllMocks()
-  })
-
-  describe('route configuration', () => {
-    it('should return all expected routes', () => {
-      const routes = getRoutes({}, {}, undefined)
-
-      expect(routes).toHaveLength(4)
-
-      const expectedPaths = [
-        '/{slug}/{path}/{itemId}/confirm-delete',
-        '/preview/{state}/{slug}/{path}/{itemId}/confirm-delete'
-      ]
-
-      expectedPaths.forEach((path) => {
-        const getRoute = routes.find(
-          (route) => route.method === 'get' && route.path === path
-        )
-        const postRoute = routes.find(
-          (route) => route.method === 'post' && route.path === path
-        )
-
-        expect(getRoute).toBeDefined()
-        expect(postRoute).toBeDefined()
-      })
-    })
-
-    it('should pass onRequest callback to handlers', () => {
-      const onRequestCallback: OnRequestCallback = jest
-        .fn()
-        .mockResolvedValue(undefined)
-      const routes = getRoutes({}, {}, onRequestCallback)
-
-      // Test that the handlers are created with the onRequest callback
-      const getRoute = routes.find(
-        (route) =>
-          route.method === 'get' &&
-          route.path === '/{slug}/{path}/{itemId}/confirm-delete'
-      )
-      const postRoute = routes.find(
-        (route) =>
-          route.method === 'post' &&
-          route.path === '/{slug}/{path}/{itemId}/confirm-delete'
-      )
-
-      expect(getRoute?.handler).toBeDefined()
-      expect(postRoute?.handler).toBeDefined()
-    })
-  })
-
-  describe('handler functionality', () => {
-    it('should create handlers that accept onRequest callback', () => {
-      const onRequestCallback: OnRequestCallback = jest
-        .fn()
-        .mockResolvedValue(undefined)
-      const routes = getRoutes({}, {}, onRequestCallback)
-
-      // Test that the handlers are created with the onRequest callback
-      const getRoute = routes.find(
-        (route) =>
-          route.method === 'get' &&
-          route.path === '/{slug}/{path}/{itemId}/confirm-delete'
-      )
-      const postRoute = routes.find(
-        (route) =>
-          route.method === 'post' &&
-          route.path === '/{slug}/{path}/{itemId}/confirm-delete'
-      )
-
-      expect(getRoute?.handler).toBeDefined()
-      expect(postRoute?.handler).toBeDefined()
-
-      // Test that handlers are functions
-      expect(typeof getRoute?.handler).toBe('function')
-      expect(typeof postRoute?.handler).toBe('function')
-    })
-  })
-})

package/src/server/plugins/engine/routes/repeaters/summary.test.ts

@@ -1,75 +0,0 @@
-import { getRoutes } from '~/src/server/plugins/engine/routes/repeaters/summary.js'
-import { type OnRequestCallback } from '~/src/server/plugins/engine/types.js'
-
-describe('repeater summary routes', () => {
-  describe('route configuration', () => {
-    it('should return all expected routes', () => {
-      const routes = getRoutes({}, {}, undefined)
-
-      expect(routes).toHaveLength(4)
-
-      const expectedPaths = [
-        '/{slug}/{path}/summary',
-        '/preview/{state}/{slug}/{path}/summary'
-      ]
-
-      expectedPaths.forEach((path) => {
-        const getRoute = routes.find(
-          (route) => route.method === 'get' && route.path === path
-        )
-        const postRoute = routes.find(
-          (route) => route.method === 'post' && route.path === path
-        )
-
-        expect(getRoute).toBeDefined()
-        expect(postRoute).toBeDefined()
-      })
-    })
-
-    it('should pass onRequest callback to handlers', () => {
-      const onRequestCallback: OnRequestCallback = jest
-        .fn()
-        .mockResolvedValue(undefined)
-      const routes = getRoutes({}, {}, onRequestCallback)
-
-      // Test that the handlers are created with the onRequest callback
-      const getRoute = routes.find(
-        (route) =>
-          route.method === 'get' && route.path === '/{slug}/{path}/summary'
-      )
-      const postRoute = routes.find(
-        (route) =>
-          route.method === 'post' && route.path === '/{slug}/{path}/summary'
-      )
-
-      expect(getRoute?.handler).toBeDefined()
-      expect(postRoute?.handler).toBeDefined()
-    })
-  })
-
-  describe('handler functionality', () => {
-    it('should create handlers that accept onRequest callback', () => {
-      const onRequestCallback: OnRequestCallback = jest
-        .fn()
-        .mockResolvedValue(undefined)
-      const routes = getRoutes({}, {}, onRequestCallback)
-
-      // Test that the handlers are created with the onRequest callback
-      const getRoute = routes.find(
-        (route) =>
-          route.method === 'get' && route.path === '/{slug}/{path}/summary'
-      )
-      const postRoute = routes.find(
-        (route) =>
-          route.method === 'post' && route.path === '/{slug}/{path}/summary'
-      )
-
-      expect(getRoute?.handler).toBeDefined()
-      expect(postRoute?.handler).toBeDefined()
-
-      // Test that handlers are functions
-      expect(typeof getRoute?.handler).toBe('function')
-      expect(typeof postRoute?.handler).toBe('function')
-    })
-  })
-})

package/src/server/plugins/engine/services/formsService.test.js

@@ -1,26 +0,0 @@
-import { FormStatus } from '@defra/forms-model'
-
-import {
-  getFormDefinition,
-  getFormMetadata,
-  getFormMetadataById,
-  getFormSecret
-} from '~/src/server/plugins/engine/services/formsService.js'
-
-describe('formsService', () => {
-  it('getFormMetadata should throw error', () => {
-    expect(() => getFormMetadata('slug')).toThrow()
-  })
-
-  it('getFormMetadataById should throw error', () => {
-    expect(() => getFormMetadataById('id')).toThrow()
-  })
-
-  it('getFormDefinition should throw error', () => {
-    expect(() => getFormDefinition('id', FormStatus.Draft)).toThrow()
-  })
-
-  it('getFormSecret should throw error', () => {
-    expect(() => getFormSecret('id', 'my-secret-name')).toThrow()
-  })
-})