@defra/forms-engine-plugin 4.7.2 → 4.8.0

package/src/server/index.test.ts

@@ -1,644 +0,0 @@
-import { type Server } from '@hapi/hapi'
-import { StatusCodes } from 'http-status-codes'
-import { type Environment } from 'nunjucks'
-
-import { FORM_PREFIX } from '~/src/server/constants.js'
-import { createServer } from '~/src/server/index.js'
-import { prepareNunjucksEnvironment } from '~/src/server/plugins/engine/index.js'
-import {
-  getFormDefinition,
-  getFormMetadata
-} from '~/src/server/plugins/engine/services/formsService.js'
-import * as defaultServices from '~/src/server/plugins/engine/services/index.js'
-import { getUploadStatus } from '~/src/server/plugins/engine/services/uploadService.js'
-import {
-  FileStatus,
-  UploadStatus,
-  type PluginOptions,
-  type UploadStatusResponse
-} from '~/src/server/plugins/engine/types.js'
-import { FormStatus } from '~/src/server/routes/types.js'
-import * as fixtures from '~/test/fixtures/index.js'
-
-jest.mock('~/src/server/plugins/engine/services/formsService.js')
-jest.mock('~/src/server/plugins/engine/services/uploadService.js')
-
-describe('Model cache', () => {
-  let server: Server
-
-  const getCacheSize = () => {
-    return server.app.models.size
-  }
-
-  const getCacheItem = (key: string) => {
-    return server.app.models.get(key)
-  }
-
-  beforeAll(async () => {
-    server = await createServer({
-      services: defaultServices
-    })
-    await server.initialize()
-  })
-
-  beforeEach(() => {
-    jest.mocked(getFormMetadata).mockResolvedValue(fixtures.form.metadata)
-    server.app.models.clear()
-  })
-
-  afterAll(async () => {
-    await server.stop()
-  })
-
-  describe('Success responses', () => {
-    test('Dispatch page with the correct state returns 302', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        live: fixtures.form.state
-      })
-
-      jest.mocked(getFormDefinition).mockResolvedValue(fixtures.form.definition)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/slug`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.MOVED_TEMPORARILY)
-      expect(res.headers.location).toBe(`${FORM_PREFIX}/slug/page-one`)
-      expect(getCacheSize()).toBe(1)
-    })
-
-    test('Dispatch preview page with the correct live state returns 302', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        live: fixtures.form.state
-      })
-
-      jest.mocked(getFormDefinition).mockResolvedValue(fixtures.form.definition)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/live/slug`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.MOVED_TEMPORARILY)
-      expect(res.headers.location).toBe(
-        `${FORM_PREFIX}/preview/live/slug/page-one`
-      )
-      expect(getCacheSize()).toBe(1)
-    })
-
-    test('Dispatch preview page with the correct draft state returns 302', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        draft: fixtures.form.state
-      })
-
-      jest.mocked(getFormDefinition).mockResolvedValue(fixtures.form.definition)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/draft/slug`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.MOVED_TEMPORARILY)
-      expect(res.headers.location).toBe(
-        `${FORM_PREFIX}/preview/draft/slug/page-one`
-      )
-      expect(getCacheSize()).toBe(1)
-    })
-
-    test('Get page with the correct live state returns 200', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        live: fixtures.form.state
-      })
-
-      jest.mocked(getFormDefinition).mockResolvedValue(fixtures.form.definition)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/slug/page-one`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.OK)
-      expect(getCacheSize()).toBe(1)
-    })
-
-    test('Get preview page with the correct live state returns 200', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        live: fixtures.form.state
-      })
-
-      jest.mocked(getFormDefinition).mockResolvedValue(fixtures.form.definition)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/live/slug/page-one`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.OK)
-      expect(getCacheSize()).toBe(1)
-    })
-
-    test('Get preview page with the correct draft state returns 200', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        draft: fixtures.form.state
-      })
-
-      jest.mocked(getFormDefinition).mockResolvedValue(fixtures.form.definition)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/draft/slug/page-one`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.OK)
-      expect(getCacheSize()).toBe(1)
-    })
-
-    test('Get page with the correct state returns 200', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        live: fixtures.form.state
-      })
-
-      jest.mocked(getFormDefinition).mockResolvedValue(fixtures.form.definition)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/slug/page-one`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.OK)
-      expect(getCacheSize()).toBe(1)
-    })
-
-    test('Get page with the correct state populates the cache correctly', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValue({
-        ...fixtures.form.metadata,
-        draft: fixtures.form.state,
-        live: fixtures.form.state
-      })
-
-      jest.mocked(getFormDefinition).mockResolvedValue(fixtures.form.definition)
-
-      // Populate live/live cache item
-      const options1 = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/slug/page-one`
-      }
-
-      const res1 = await server.inject(options1)
-
-      expect(res1.statusCode).toBe(StatusCodes.OK)
-      expect(getCacheSize()).toBe(1)
-
-      // Populate live/preview cache item
-      const options2 = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/live/slug/page-one`
-      }
-
-      const res2 = await server.inject(options2)
-
-      expect(res2.statusCode).toBe(StatusCodes.OK)
-      expect(getCacheSize()).toBe(2)
-
-      // Populate draft/preview cache item
-      const options3 = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/draft/slug/page-one`
-      }
-
-      const res3 = await server.inject(options3)
-
-      expect(res3.statusCode).toBe(StatusCodes.OK)
-      expect(getCacheSize()).toBe(3)
-
-      // Execute each request again and
-      // assert the cache size is unchanged
-      await server.inject(options1)
-      await server.inject(options2)
-      await server.inject(options3)
-
-      expect(getCacheSize()).toBe(3)
-
-      // Check models cache item is regenerated on an update to the state
-      const now2 = new Date()
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        draft: fixtures.form.state,
-        live: { ...fixtures.form.state, updatedAt: now2 }
-      })
-
-      await server.inject(options1)
-
-      // Expect `getFormDefinition` to be called as the updatedAt has moved on
-      expect(getFormDefinition).toHaveBeenLastCalledWith(
-        fixtures.form.metadata.id,
-        FormStatus.Live
-      )
-
-      // Assert the live/live cache item has the correct updatedAt timestamp
-      expect(
-        getCacheItem(`${fixtures.form.metadata.id}_live_false`)?.updatedAt
-      ).toBe(now2)
-
-      // Expect the cache size to remain unchanged
-      expect(getCacheSize()).toBe(3)
-
-      // Assert the number of times `getFormDefinition`
-      // has only been called 4 times for the 7 requests
-      expect(getFormDefinition).toHaveBeenCalledTimes(4)
-    })
-  })
-
-  describe('Error responses', () => {
-    test('Dispatch page without the correct state returns 404', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce(fixtures.form.metadata)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/slug`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.NOT_FOUND)
-      expect(getCacheSize()).toBe(0)
-    })
-
-    test('Dispatch preview page without the correct draft state returns 404', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce(fixtures.form.metadata)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/draft/slug`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.NOT_FOUND)
-      expect(getCacheSize()).toBe(0)
-    })
-
-    test('Dispatch preview page without the correct live state returns 404', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce(fixtures.form.metadata)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/live/slug`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.NOT_FOUND)
-      expect(getCacheSize()).toBe(0)
-    })
-
-    test('Dispatch page with the correct live state but no definition returns 404', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        live: fixtures.form.state
-      })
-      jest.mocked(getFormDefinition).mockResolvedValue(undefined)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/slug`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.NOT_FOUND)
-      expect(getCacheSize()).toBe(0)
-    })
-
-    test('Dispatch preview page with the correct draft state but no definition returns 404', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        live: fixtures.form.state
-      })
-      jest.mocked(getFormDefinition).mockResolvedValue(undefined)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/draft/slug`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.NOT_FOUND)
-      expect(getCacheSize()).toBe(0)
-    })
-
-    test('Dispatch preview page with the correct live state but no definition returns 404', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        live: fixtures.form.state
-      })
-      jest.mocked(getFormDefinition).mockResolvedValue(undefined)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/live/slug`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.NOT_FOUND)
-      expect(getCacheSize()).toBe(0)
-    })
-
-    test('Get page without the correct state returns 404', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce(fixtures.form.metadata)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/slug/page-one`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.NOT_FOUND)
-      expect(getCacheSize()).toBe(0)
-    })
-
-    test('Get preview page without the correct draft state returns 404', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce(fixtures.form.metadata)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/draft/slug/page-one`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.NOT_FOUND)
-      expect(getCacheSize()).toBe(0)
-    })
-
-    test('Get preview page without the correct live state returns 404', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce(fixtures.form.metadata)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/live/slug/page-one`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.NOT_FOUND)
-      expect(getCacheSize()).toBe(0)
-    })
-
-    test('Get page with the correct live state but no definition returns 404', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        live: fixtures.form.state
-      })
-      jest.mocked(getFormDefinition).mockResolvedValue(undefined)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/slug/page-one`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.NOT_FOUND)
-      expect(getCacheSize()).toBe(0)
-    })
-
-    test('Get preview page with the correct draft state but no definition returns 404', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        live: fixtures.form.state
-      })
-      jest.mocked(getFormDefinition).mockResolvedValue(undefined)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/draft/slug/page-one`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.NOT_FOUND)
-      expect(getCacheSize()).toBe(0)
-    })
-
-    test('Get preview page with the correct live state but no definition returns 404', async () => {
-      jest.mocked(getFormMetadata).mockResolvedValueOnce({
-        ...fixtures.form.metadata,
-        live: fixtures.form.state
-      })
-      jest.mocked(getFormDefinition).mockResolvedValue(undefined)
-
-      const options = {
-        method: 'GET',
-        url: `${FORM_PREFIX}/preview/live/slug/page-one`
-      }
-
-      const res = await server.inject(options)
-
-      expect(res.statusCode).toBe(StatusCodes.NOT_FOUND)
-      expect(getCacheSize()).toBe(0)
-    })
-  })
-})
-
-describe('Upload status route', () => {
-  let server: Server
-
-  beforeAll(async () => {
-    server = await createServer()
-    await server.initialize()
-  })
-
-  afterAll(async () => {
-    await server.stop()
-  })
-
-  beforeEach(() => {
-    jest.resetAllMocks()
-  })
-
-  test('GET /upload-status/{uploadId} returns upload status with 200 when successful', async () => {
-    const mockStatus: UploadStatusResponse = {
-      uploadStatus: UploadStatus.ready,
-      metadata: {
-        retrievalKey: 'some-key'
-      },
-      form: {
-        file: {
-          fileId: 'some-file-id',
-          filename: 'some-file-name',
-          contentLength: 1024,
-          fileStatus: FileStatus.complete
-        }
-      },
-      numberOfRejectedFiles: 0
-    }
-    jest.mocked(getUploadStatus).mockResolvedValueOnce(mockStatus)
-
-    const options = {
-      method: 'GET',
-      url: `${FORM_PREFIX}/upload-status/123e4567-e89b-12d3-a456-426614174000`
-    }
-
-    const res = await server.inject(options)
-
-    expect(res.statusCode).toBe(StatusCodes.OK)
-    expect(res.result).toEqual({
-      uploadStatus: UploadStatus.ready
-    })
-    expect(getUploadStatus).toHaveBeenCalledWith(
-      '123e4567-e89b-12d3-a456-426614174000'
-    )
-  })
-
-  test('GET /upload-status/{uploadId} returns 400 when status check fails', async () => {
-    jest.mocked(getUploadStatus).mockResolvedValueOnce(undefined)
-
-    const options = {
-      method: 'GET',
-      url: `${FORM_PREFIX}/upload-status/123e4567-e89b-12d3-a456-426614174000`
-    }
-
-    const res = await server.inject(options)
-
-    expect(res.statusCode).toBe(StatusCodes.BAD_REQUEST)
-    expect(res.result).toEqual({ error: 'Status check failed' })
-  })
-
-  test('GET /upload-status/{uploadId} returns 500 when exception occurs', async () => {
-    jest
-      .mocked(getUploadStatus)
-      .mockRejectedValueOnce(new Error('Service unavailable'))
-
-    const options = {
-      method: 'GET',
-      url: `${FORM_PREFIX}/upload-status/123e4567-e89b-12d3-a456-426614174000`
-    }
-
-    const res = await server.inject(options)
-
-    expect(res.statusCode).toBe(StatusCodes.INTERNAL_SERVER_ERROR)
-    expect(res.result).toEqual({ error: 'Status check error' })
-  })
-
-  test('GET /upload-status/{uploadId} returns 400 for invalid uploadId format', async () => {
-    const options = {
-      method: 'GET',
-      url: `${FORM_PREFIX}/upload-status/not-a-valid-guid`
-    }
-
-    const res = await server.inject(options)
-
-    expect(res.statusCode).toBe(StatusCodes.BAD_REQUEST)
-  })
-})
-
-describe('prepareEnvironment', () => {
-  const mockEnv = {
-    addFilter: jest.fn(),
-    addGlobal: jest.fn()
-  } as unknown as Environment
-
-  const mockPluginOptions: PluginOptions = {
-    baseUrl: 'http://localhost',
-    nunjucks: {
-      baseLayoutPath: '',
-      paths: []
-    },
-    viewContext: undefined
-  }
-
-  beforeEach(() => {
-    jest.clearAllMocks()
-  })
-
-  const expectedBaseFilters = [
-    'highlight',
-    'inspect',
-    'evaluate',
-    'answer',
-    'href',
-    'field',
-    'page',
-    'merge',
-    'markdown'
-  ]
-
-  test('registers base filters', () => {
-    prepareNunjucksEnvironment(mockEnv, mockPluginOptions)
-
-    expect(mockEnv.addFilter).toHaveBeenCalledTimes(expectedBaseFilters.length)
-    expectedBaseFilters.forEach((name) => {
-      expect(mockEnv.addFilter).toHaveBeenCalledWith(name, expect.any(Function))
-    })
-  })
-
-  test('registers additional filters', () => {
-    prepareNunjucksEnvironment(mockEnv, {
-      ...mockPluginOptions,
-      filters: {
-        customFilter: (value) => value
-      }
-    })
-
-    expect(mockEnv.addFilter).toHaveBeenCalledWith(
-      'customFilter',
-      expect.any(Function)
-    )
-  })
-
-  test('registers base globals', () => {
-    const expectedGlobals = [
-      'checkComponentTemplates',
-      'checkErrorTemplates',
-      'evaluate',
-      'govukRebrand'
-    ]
-
-    prepareNunjucksEnvironment(mockEnv, mockPluginOptions)
-
-    expect(mockEnv.addGlobal).toHaveBeenCalledTimes(expectedGlobals.length)
-    expectedGlobals.forEach((name) => {
-      expect(mockEnv.addGlobal).toHaveBeenCalledWith(name, expect.any(Function))
-    })
-  })
-
-  test('registers additional globals', () => {
-    prepareNunjucksEnvironment(mockEnv, {
-      ...mockPluginOptions,
-      globals: {
-        customGlobal: (value) => value
-      }
-    })
-
-    expect(mockEnv.addGlobal).toHaveBeenCalledWith(
-      'customGlobal',
-      expect.any(Function)
-    )
-  })
-})