@defra/forms-engine-plugin 4.7.2 → 4.8.0

package/src/server/services/httpService.test.js

@@ -1,491 +0,0 @@
-import { getTraceId } from '@defra/hapi-tracing'
-import Boom from '@hapi/boom'
-import Wreck from '@hapi/wreck'
-import { StatusCodes } from 'http-status-codes'
-
-import {
-  get,
-  getJson,
-  post,
-  postJson,
-  put
-} from '~/src/server/services/httpService.js'
-
-jest.mock('@defra/hapi-tracing')
-
-describe('HTTP service', () => {
-  /** @type {RequestOptions} */
-  let authOptions
-  /** @type {RequestOptions} */
-  let blankOptions
-  /** @type {RequestOptions} */
-  let timeoutOptions
-
-  beforeEach(() => {
-    authOptions = {
-      headers: { Authorization: 'Bearer ey56yDSASDFfbgcbc' }
-    }
-    blankOptions = {}
-    timeoutOptions = {
-      timeout: 5000
-    }
-  })
-
-  describe('GET', () => {
-    beforeEach(() => {
-      jest.spyOn(Wreck, 'get').mockResolvedValue({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: StatusCodes.OK
-        }),
-        payload: undefined
-      })
-    })
-
-    it('passes headers', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(get('/test', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK }
-      })
-
-      expect(Wreck.get).toHaveBeenCalledWith('/test', {
-        headers: { 'x-cdp-request-id': 'my-trace-id' }
-      })
-    })
-
-    it('passes additional headers', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(get('/test', authOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK }
-      })
-
-      expect(Wreck.get).toHaveBeenCalledWith('/test', {
-        headers: {
-          Authorization: 'Bearer ey56yDSASDFfbgcbc',
-          'x-cdp-request-id': 'my-trace-id'
-        }
-      })
-    })
-
-    it('passes non headers options', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(get('/test', timeoutOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK }
-      })
-
-      expect(Wreck.get).toHaveBeenCalledWith('/test', {
-        headers: {
-          'x-cdp-request-id': 'my-trace-id'
-        },
-        timeout: 5000
-      })
-    })
-
-    it('sends request', async () => {
-      await expect(get('/test', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK }
-      })
-
-      expect(Wreck.get).toHaveBeenCalledWith('/test', {})
-    })
-
-    it('sends request as JSON', async () => {
-      await expect(getJson('/test')).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK }
-      })
-
-      expect(Wreck.get).toHaveBeenCalledWith('/test', { json: true })
-    })
-  })
-
-  describe('GET (with error)', () => {
-    const error = Boom.notFound()
-
-    beforeEach(() => {
-      jest.spyOn(Wreck, 'get').mockResolvedValue({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: StatusCodes.NOT_FOUND
-        }),
-        payload: error
-      })
-    })
-
-    it('passes headers', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(get('/error', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.get).toHaveBeenCalledWith('/error', {
-        headers: { 'x-cdp-request-id': 'my-trace-id' }
-      })
-    })
-
-    it('passes additional headers', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(get('/error', authOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.get).toHaveBeenCalledWith('/error', {
-        headers: {
-          Authorization: 'Bearer ey56yDSASDFfbgcbc',
-          'x-cdp-request-id': 'my-trace-id'
-        }
-      })
-    })
-
-    it('passes non headers options', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(get('/error', timeoutOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.get).toHaveBeenCalledWith('/error', {
-        headers: {
-          'x-cdp-request-id': 'my-trace-id'
-        },
-        timeout: 5000
-      })
-    })
-
-    it('sends request (with error)', async () => {
-      await expect(get('/error', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.get).toHaveBeenCalledWith('/error', {})
-    })
-
-    it('sends request as JSON (with error)', async () => {
-      await expect(getJson('/error')).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.get).toHaveBeenCalledWith('/error', { json: true })
-    })
-
-    it('sends request (unknown error)', async () => {
-      jest.spyOn(Wreck, 'get').mockResolvedValue({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: StatusCodes.NOT_FOUND
-        }),
-        payload: undefined
-      })
-
-      await expect(get('/error', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error: new Error('Unknown error')
-      })
-
-      expect(Wreck.get).toHaveBeenCalledWith('/error', {})
-    })
-  })
-
-  describe('POST', () => {
-    beforeEach(() => {
-      jest.spyOn(Wreck, 'post').mockResolvedValue({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: StatusCodes.OK
-        }),
-        payload: { reference: '1234' }
-      })
-    })
-
-    it('passes headers', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(post('/test', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK },
-        payload: { reference: '1234' }
-      })
-
-      expect(Wreck.post).toHaveBeenCalledWith('/test', {
-        headers: { 'x-cdp-request-id': 'my-trace-id' }
-      })
-    })
-
-    it('passes additonal headers', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(post('/test', authOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK },
-        payload: { reference: '1234' }
-      })
-
-      expect(Wreck.post).toHaveBeenCalledWith('/test', {
-        headers: {
-          Authorization: 'Bearer ey56yDSASDFfbgcbc',
-          'x-cdp-request-id': 'my-trace-id'
-        }
-      })
-    })
-
-    it('passes non headers options', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(post('/test', timeoutOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK },
-        payload: { reference: '1234' }
-      })
-
-      expect(Wreck.post).toHaveBeenCalledWith('/test', {
-        headers: {
-          'x-cdp-request-id': 'my-trace-id'
-        },
-        timeout: 5000
-      })
-    })
-
-    it('sends request', async () => {
-      await expect(post('/test', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK },
-        payload: { reference: '1234' }
-      })
-
-      expect(Wreck.post).toHaveBeenCalledWith('/test', {})
-    })
-
-    it('sends request as JSON', async () => {
-      await expect(postJson('/test', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK },
-        payload: { reference: '1234' }
-      })
-
-      expect(Wreck.post).toHaveBeenCalledWith('/test', { json: true })
-    })
-  })
-
-  describe('POST (with error)', () => {
-    const error = Boom.notFound()
-
-    beforeEach(() => {
-      jest.spyOn(Wreck, 'post').mockResolvedValue({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: StatusCodes.NOT_FOUND
-        }),
-        payload: error
-      })
-    })
-
-    it('passes headers', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(post('/error', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.post).toHaveBeenCalledWith('/error', {
-        headers: { 'x-cdp-request-id': 'my-trace-id' }
-      })
-    })
-
-    it('passes additional headers', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(post('/error', authOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.post).toHaveBeenCalledWith('/error', {
-        headers: {
-          Authorization: 'Bearer ey56yDSASDFfbgcbc',
-          'x-cdp-request-id': 'my-trace-id'
-        }
-      })
-    })
-
-    it('passes non headers options', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(post('/error', timeoutOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.post).toHaveBeenCalledWith('/error', {
-        headers: {
-          'x-cdp-request-id': 'my-trace-id'
-        },
-        timeout: 5000
-      })
-    })
-
-    it('sends request (with error)', async () => {
-      await expect(post('/error', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.post).toHaveBeenCalledWith('/error', {})
-    })
-
-    it('sends request as JSON (with error)', async () => {
-      await expect(postJson('/error', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.post).toHaveBeenCalledWith('/error', { json: true })
-    })
-
-    it('sends request (unknown error)', async () => {
-      jest.spyOn(Wreck, 'post').mockResolvedValue({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: StatusCodes.NOT_FOUND
-        }),
-        payload: undefined
-      })
-
-      await expect(post('/error', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error: new Error('Unknown error')
-      })
-
-      expect(Wreck.post).toHaveBeenCalledWith('/error', {})
-    })
-  })
-
-  describe('PUT', () => {
-    beforeEach(() => {
-      jest.spyOn(Wreck, 'put').mockResolvedValue({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: StatusCodes.OK
-        }),
-        payload: undefined
-      })
-    })
-
-    it('passes headers', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(put('/test', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK }
-      })
-
-      expect(Wreck.put).toHaveBeenCalledWith('/test', {
-        headers: { 'x-cdp-request-id': 'my-trace-id' }
-      })
-    })
-
-    it('passes additional headers', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(put('/test', authOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK }
-      })
-
-      expect(Wreck.put).toHaveBeenCalledWith('/test', {
-        headers: {
-          Authorization: 'Bearer ey56yDSASDFfbgcbc',
-          'x-cdp-request-id': 'my-trace-id'
-        }
-      })
-    })
-
-    it('passes non headers options', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(put('/test', timeoutOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK }
-      })
-
-      expect(Wreck.put).toHaveBeenCalledWith('/test', {
-        headers: {
-          'x-cdp-request-id': 'my-trace-id'
-        },
-        timeout: 5000
-      })
-    })
-
-    it('sends request', async () => {
-      await expect(put('/test', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.OK }
-      })
-
-      expect(Wreck.put).toHaveBeenCalledWith('/test', {})
-    })
-  })
-
-  describe('PUT (with error)', () => {
-    const error = Boom.notFound()
-
-    beforeEach(() => {
-      jest.spyOn(Wreck, 'put').mockResolvedValue({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: StatusCodes.NOT_FOUND
-        }),
-        payload: error
-      })
-    })
-
-    it('passes headers', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(put('/error', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.put).toHaveBeenCalledWith('/error', {
-        headers: { 'x-cdp-request-id': 'my-trace-id' }
-      })
-    })
-
-    it('passes additional headers', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(put('/error', authOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.put).toHaveBeenCalledWith('/error', {
-        headers: {
-          Authorization: 'Bearer ey56yDSASDFfbgcbc',
-          'x-cdp-request-id': 'my-trace-id'
-        }
-      })
-    })
-
-    it('passes non headers options', async () => {
-      jest.mocked(getTraceId).mockReturnValue('my-trace-id')
-      await expect(put('/error', timeoutOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.put).toHaveBeenCalledWith('/error', {
-        headers: {
-          'x-cdp-request-id': 'my-trace-id'
-        },
-        timeout: 5000
-      })
-    })
-
-    it('sends request (with error)', async () => {
-      await expect(put('/error', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error
-      })
-
-      expect(Wreck.put).toHaveBeenCalledWith('/error', {})
-    })
-
-    it('sends request (unknown error)', async () => {
-      jest.spyOn(Wreck, 'put').mockResolvedValue({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: StatusCodes.NOT_FOUND
-        }),
-        payload: undefined
-      })
-
-      await expect(put('/error', blankOptions)).resolves.toEqual({
-        res: { statusCode: StatusCodes.NOT_FOUND },
-        error: new Error('Unknown error')
-      })
-
-      expect(Wreck.put).toHaveBeenCalledWith('/error', {})
-    })
-  })
-})
-
-/**
- * @import { IncomingMessage } from 'node:http'
- * @import { RequestOptions } from '~/src/server/services/httpService.js'
- */

package/src/server/utils/file-form-service.test.js

@@ -1,127 +0,0 @@
-import { join } from 'node:path'
-
-import { FormStatus } from '~/src/server/routes/types.js'
-import { FileFormService } from '~/src/server/utils/file-form-service.js'
-
-describe('File-form-service', () => {
-  /** @type {FileFormService} */
-  let service
-  beforeEach(async () => {
-    const now = new Date()
-    const user = { id: 'user', displayName: 'Username' }
-    const author = {
-      createdAt: now,
-      createdBy: user,
-      updatedAt: now,
-      updatedBy: user
-    }
-    service = new FileFormService()
-    const metadata = {
-      organisation: 'Defra',
-      teamName: 'Team name',
-      teamEmail: 'team@defra.gov.uk',
-      submissionGuidance: "Thanks for your submission, we'll be in touch",
-      notificationEmail: 'email@domain.com',
-      ...author,
-      live: author
-    }
-    await service.addForm(
-      `${join(import.meta.dirname, '../../../test/form/definitions')}/components.json`,
-      {
-        ...metadata,
-        id: '95e92559-968d-44ae-8666-2b1ad3dffd31',
-        title: 'Form test',
-        slug: 'form-test'
-      }
-    )
-  })
-
-  describe('metadata by slug', () => {
-    it('should get form metadata by slug', () => {
-      const meta = service.getFormMetadata('form-test')
-      expect(meta.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')
-      expect(meta.title).toBe('Form test')
-    })
-
-    it('should throw if not found', () => {
-      expect(() => service.getFormMetadata('form-test-missing')).toThrow(
-        "Form metadata 'form-test-missing' not found"
-      )
-    })
-  })
-
-  describe('metadata by id', () => {
-    it('should get form metadata by id', () => {
-      const meta = service.getFormMetadataById(
-        '95e92559-968d-44ae-8666-2b1ad3dffd31'
-      )
-      expect(meta.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')
-      expect(meta.title).toBe('Form test')
-    })
-
-    it('should throw if not found', () => {
-      expect(() => service.getFormMetadataById('id-missing')).toThrow(
-        "Form metadata id 'id-missing' not found"
-      )
-    })
-  })
-
-  describe('definition by id', () => {
-    it('should get form definition by id', () => {
-      const form = service.getFormDefinition(
-        '95e92559-968d-44ae-8666-2b1ad3dffd31'
-      )
-      expect(form.name).toBe('All components')
-      expect(form.startPage).toBe('/all-components')
-    })
-
-    it('should throw if not found', () => {
-      expect(() => service.getFormDefinition('id-missing')).toThrow(
-        "Form definition 'id-missing' not found"
-      )
-    })
-  })
-
-  describe('toFormsService', () => {
-    it('should create interface', async () => {
-      const interfaceImpl = service.toFormsService()
-      const res1 = await interfaceImpl.getFormMetadata('form-test')
-      expect(res1.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')
-      expect(res1.title).toBe('Form test')
-
-      const res2 = await interfaceImpl.getFormMetadataById(
-        '95e92559-968d-44ae-8666-2b1ad3dffd31'
-      )
-      expect(res2.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')
-      expect(res2.title).toBe('Form test')
-
-      const res3 = await interfaceImpl.getFormDefinition(
-        '95e92559-968d-44ae-8666-2b1ad3dffd31',
-        FormStatus.Draft
-      )
-      expect(res3?.name).toBe('All components')
-      expect(res3?.startPage).toBe('/all-components')
-
-      const res4 = await interfaceImpl.getFormSecret(
-        '95e92559-968d-44ae-8666-2b1ad3dffd31',
-        'my-secret-name'
-      )
-      expect(res4).toBe('test-api-key')
-
-      delete process.env.PAYMENT_PROVIDER_API_KEY_TEST
-      const res5 = await interfaceImpl.getFormSecret(
-        '95e92559-968d-44ae-8666-2b1ad3dffd31',
-        'my-secret-name'
-      )
-      expect(res5).toBe('')
-    })
-  })
-
-  describe('readForm', () => {
-    it('should throw if invalid extension', async () => {
-      await expect(
-        service.readForm('/some-folder/some-file.bad')
-      ).rejects.toThrow("Invalid file extension '.bad'")
-    })
-  })
-})

package/src/server/utils/notify.test.ts

@@ -1,37 +0,0 @@
-import { postJson } from '~/src/server/services/httpService.js'
-import { sendNotification } from '~/src/server/utils/notify.js'
-
-jest.mock('~/src/server/services/httpService')
-
-describe('Utils: Notify', () => {
-  const templateId = 'example-template-id'
-  const emailAddress = 'enrique.chase@defra.gov.uk'
-  const personalisation = {
-    subject: 'Hello',
-    body: 'World'
-  }
-
-  describe('sendNotification', () => {
-    it('calls postJson with personalised email payload', async () => {
-      await sendNotification({
-        templateId,
-        emailAddress,
-        personalisation
-      })
-
-      expect(postJson).toHaveBeenCalledWith(
-        'https://api.notifications.service.gov.uk/v2/notifications/email',
-        {
-          payload: {
-            template_id: templateId,
-            email_address: emailAddress,
-            personalisation
-          },
-          headers: {
-            Authorization: expect.stringMatching(/^Bearer /)
-          }
-        }
-      )
-    })
-  })
-})

package/src/server/utils/secure-context/get-trust-store-certs.test.js

@@ -1,19 +0,0 @@
-import { getTrustStoreCerts } from '~/src/server/utils/secure-context/get-trust-store-certs.js'
-
-describe('#getTrustStoreCerts', () => {
-  const mockProcessEnvWithCerts = {
-    TRUSTSTORE_CA_ONE:
-      'LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCm1vY2stY2VydC1kb3JpcwotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==',
-    UNRELATED_ENV: 'not-a-cert'
-  }
-
-  test('Should provide expected result with "certs"', () => {
-    expect(getTrustStoreCerts(mockProcessEnvWithCerts)).toEqual([
-      '-----BEGIN CERTIFICATE-----\nmock-cert-doris\n-----END CERTIFICATE-----'
-    ])
-  })
-
-  test('Should provide expected empty array', () => {
-    expect(getTrustStoreCerts({})).toEqual([])
-  })
-})