@defra/forms-engine-plugin 4.7.2 → 4.7.3

package/src/server/plugins/engine/services/notifyService.test.ts

@@ -1,310 +0,0 @@
-import { type FormMetadata } from '@defra/forms-model'
-
-import { escapeMarkdown } from '~/src/server/plugins/engine/components/helpers/index.js'
-import { checkFormStatus } from '~/src/server/plugins/engine/helpers.js'
-import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
-import { type DetailItem } from '~/src/server/plugins/engine/models/types.js'
-import { getFormatter } from '~/src/server/plugins/engine/outputFormatters/index.js'
-import { submit } from '~/src/server/plugins/engine/services/notifyService.js'
-import { type FormContext } from '~/src/server/plugins/engine/types.js'
-import {
-  FormStatus,
-  type FormRequestPayload
-} from '~/src/server/routes/types.js'
-import { sendNotification } from '~/src/server/utils/notify.js'
-
-jest.mock('~/src/server/utils/notify')
-jest.mock('~/src/server/plugins/engine/helpers')
-jest.mock('~/src/server/plugins/engine/outputFormatters/index')
-jest.mock('~/src/server/plugins/engine/components/helpers')
-
-describe('notifyService', () => {
-  const submitResponse = {
-    message: 'Submit completed',
-    result: {
-      files: {
-        main: '00000000-0000-0000-0000-000000000000',
-        repeaters: {
-          pizza: '11111111-1111-1111-1111-111111111111'
-        }
-      }
-    }
-  }
-
-  const items: DetailItem[] = []
-
-  const mockRequest: FormRequestPayload = jest.mocked<FormRequestPayload>({
-    path: 'test',
-    logger: {
-      info: jest.fn(),
-      error: jest.fn()
-    }
-  } as unknown as FormRequestPayload)
-  let model: FormModel
-  const sendNotificationMock = jest.mocked(sendNotification)
-  const formContext = {} as FormContext
-
-  beforeEach(() => {
-    jest.resetAllMocks()
-    jest.mocked(escapeMarkdown).mockImplementation((text) => text)
-  })
-
-  it('creates a subject line for real forms', async () => {
-    model = {
-      name: 'foobar',
-      def: {
-        output: {
-          audience: 'human',
-          version: '1'
-        }
-      }
-    } as FormModel
-
-    jest.mocked(checkFormStatus).mockReturnValue({
-      isPreview: false,
-      state: FormStatus.Draft
-    })
-    jest.mocked(getFormatter).mockReturnValue(() => 'dummy-live')
-
-    await submit(
-      formContext,
-      mockRequest,
-      model,
-      'test@defra.gov.uk',
-      items,
-      submitResponse
-    )
-
-    expect(sendNotificationMock).toHaveBeenCalledWith(
-      expect.objectContaining({
-        personalisation: {
-          subject: `Form submission: foobar`,
-          body: 'dummy-live'
-        }
-      })
-    )
-  })
-
-  it('creates a subject line for preview forms', async () => {
-    model = {
-      name: 'foobar',
-      def: {
-        output: {
-          audience: 'human',
-          version: '1'
-        }
-      }
-    } as FormModel
-
-    jest.mocked(checkFormStatus).mockReturnValue({
-      isPreview: true,
-      state: FormStatus.Draft
-    })
-    jest.mocked(getFormatter).mockReturnValue(() => 'dummy-preview')
-
-    await submit(
-      formContext,
-      mockRequest,
-      model,
-      'test@defra.gov.uk',
-      items,
-      submitResponse
-    )
-
-    expect(sendNotificationMock).toHaveBeenCalledWith(
-      expect.objectContaining({
-        personalisation: {
-          subject: `TEST FORM SUBMISSION: foobar`,
-          body: 'dummy-preview'
-        }
-      })
-    )
-  })
-
-  it('base64 encodes form data when aimed at machines', async () => {
-    model = {
-      name: 'foobar',
-      def: {
-        output: {
-          audience: 'machine',
-          version: '1'
-        }
-      }
-    } as FormModel
-
-    jest.mocked(checkFormStatus).mockReturnValue({
-      isPreview: true,
-      state: FormStatus.Draft
-    })
-    jest
-      .mocked(getFormatter)
-      .mockReturnValue(() => 'dummy-preview " Hello world \' !@/')
-
-    await submit(
-      formContext,
-      mockRequest,
-      model,
-      'test@defra.gov.uk',
-      items,
-      submitResponse
-    )
-
-    expect(sendNotificationMock).toHaveBeenCalledWith(
-      expect.objectContaining({
-        personalisation: {
-          subject: `TEST FORM SUBMISSION: foobar`,
-          body: 'ZHVtbXktcHJldmlldyAiIEhlbGxvIHdvcmxkICcgIUAv'
-        }
-      })
-    )
-  })
-
-  it('calls outputFormatter with all correct arguments', async () => {
-    const mockFormatter = jest.fn().mockReturnValue('formatted-output')
-    jest.mocked(getFormatter).mockReturnValue(mockFormatter)
-
-    const formMetadata: FormMetadata = {
-      id: 'form-id',
-      slug: 'form-slug',
-      title: 'Form Title'
-    } as FormMetadata
-
-    const formStatus = {
-      isPreview: false,
-      state: FormStatus.Live
-    }
-
-    jest.mocked(checkFormStatus).mockReturnValue(formStatus)
-
-    model = {
-      name: 'foobar',
-      def: {
-        output: {
-          audience: 'human',
-          version: '1'
-        }
-      }
-    } as FormModel
-
-    await submit(
-      formContext,
-      mockRequest,
-      model,
-      'test@defra.gov.uk',
-      items,
-      submitResponse,
-      formMetadata
-    )
-
-    expect(getFormatter).toHaveBeenCalledWith('human', '1')
-
-    expect(mockFormatter).toHaveBeenCalledWith(
-      formContext,
-      items,
-      model,
-      submitResponse,
-      formStatus,
-      formMetadata
-    )
-
-    expect(sendNotificationMock).toHaveBeenCalledWith(
-      expect.objectContaining({
-        personalisation: {
-          subject: 'Form submission: foobar',
-          body: 'formatted-output'
-        }
-      })
-    )
-  })
-
-  it('calls outputFormatter without formMetadata when not provided', async () => {
-    const mockFormatter = jest.fn().mockReturnValue('formatted-output')
-    jest.mocked(getFormatter).mockReturnValue(mockFormatter)
-
-    const formStatus = {
-      isPreview: true,
-      state: FormStatus.Draft
-    }
-
-    jest.mocked(checkFormStatus).mockReturnValue(formStatus)
-
-    model = {
-      name: 'foobar',
-      def: {
-        output: {
-          audience: 'machine',
-          version: '2'
-        }
-      }
-    } as FormModel
-
-    await submit(
-      formContext,
-      mockRequest,
-      model,
-      'test@defra.gov.uk',
-      items,
-      submitResponse
-    )
-
-    expect(getFormatter).toHaveBeenCalledWith('machine', '2')
-
-    expect(mockFormatter).toHaveBeenCalledWith(
-      formContext,
-      items,
-      model,
-      submitResponse,
-      formStatus,
-      undefined
-    )
-
-    expect(sendNotificationMock).toHaveBeenCalledWith(
-      expect.objectContaining({
-        personalisation: {
-          subject: 'TEST FORM SUBMISSION: foobar',
-          body: Buffer.from('formatted-output').toString('base64')
-        }
-      })
-    )
-  })
-
-  it('should handle sendNotification errors and rethrow', async () => {
-    const mockFormatter = jest.fn().mockReturnValue('formatted-output')
-    jest.mocked(getFormatter).mockReturnValue(mockFormatter)
-    jest.mocked(checkFormStatus).mockReturnValue({
-      isPreview: false,
-      state: FormStatus.Live
-    })
-
-    const testError = new Error('Notification service unavailable')
-    sendNotificationMock.mockRejectedValue(testError)
-
-    model = {
-      name: 'foobar',
-      def: {
-        output: {
-          audience: 'human',
-          version: '1'
-        }
-      }
-    } as FormModel
-
-    await expect(
-      submit(
-        formContext,
-        mockRequest,
-        model,
-        'test@defra.gov.uk',
-        items,
-        submitResponse
-      )
-    ).rejects.toThrow('Notification service unavailable')
-
-    expect(mockRequest.logger.error).toHaveBeenCalledWith(
-      new Error('Notification service unavailable'),
-      expect.stringContaining(
-        '[emailSendFailed] Error sending notification email'
-      )
-    )
-  })
-})

package/src/server/plugins/engine/types/schema.test.ts

@@ -1,234 +0,0 @@
-import { FormStatus } from '@defra/forms-model'
-
-import { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'
-import {
-  formAdapterSubmissionMessageDataSchema,
-  formAdapterSubmissionMessageMetaSchema,
-  formAdapterSubmissionMessagePayloadSchema
-} from '~/src/server/plugins/engine/types/schema.js'
-import {
-  type FormAdapterSubmissionMessageData,
-  type FormAdapterSubmissionMessageMeta,
-  type FormAdapterSubmissionMessagePayload,
-  type RichFormValue
-} from '~/src/server/plugins/engine/types.js'
-
-describe('Schema validation', () => {
-  const main: Record<string, RichFormValue> = {
-    QMwMir: 'Roman Pizza',
-    duOEvZ: 'Small',
-    DzEODf: ['Mozzarella'],
-    juiCfC: ['Pepperoni', 'Sausage', 'Onions', 'Basil'],
-    YEpypP: 'None',
-    JumNVc: 'Joe Bloggs',
-    ALNehP: '+441234567890',
-    vAqTmg: {
-      addressLine1: '1 Anywhere Street',
-      town: 'Anywhereville',
-      postcode: 'AN1 2WH'
-    },
-    IbXVGY: {
-      day: 22,
-      month: 8,
-      year: 2025
-    },
-    HGBWLt: ['Garlic sauce']
-  }
-
-  const value1: Record<string, RichFormValue> = {
-    IEKzko: 'dsfsdfsdf'
-  }
-  const value2: Record<string, RichFormValue> = {
-    IEKzko: 'dfghfgh'
-  }
-
-  const validData: FormAdapterSubmissionMessageData = {
-    main,
-    repeaters: {
-      qLVLgb: [value1, value2]
-    },
-    files: {
-      dLzALM: [
-        {
-          fileId: '489ecc1b-a145-4618-ba5a-b4a0d5ee2dbd',
-          fileName: 'file-name.json',
-          userDownloadLink:
-            'http://localhost:3005/file-download/489ecc1b-a145-4618-ba5a-b4a0d5ee2dbd'
-        }
-      ]
-    }
-  }
-
-  describe('formAdapterSubmissionMessageMetaSchema', () => {
-    const validMeta: FormAdapterSubmissionMessageMeta = {
-      schemaVersion: FormAdapterSubmissionSchemaVersion.V1,
-      timestamp: new Date('2025-08-22T18:15:10.785Z'),
-      referenceNumber: '576-225-943',
-      formName: 'Order a pizza',
-      formId: '68a8b0449ab460290c28940a',
-      formSlug: 'order-a-pizza',
-      status: FormStatus.Live,
-      isPreview: false,
-      notificationEmail: 'info@example.com'
-    }
-
-    it('should validate valid meta object', () => {
-      const { error } =
-        formAdapterSubmissionMessageMetaSchema.validate(validMeta)
-      expect(error).toBeUndefined()
-    })
-
-    it('should validate valid meta object with valid custom properties', () => {
-      const validMetaWithCustom = {
-        ...validMeta,
-        custom: {
-          property1: 'value 1',
-          property2: 'value2'
-        }
-      }
-      const { error } =
-        formAdapterSubmissionMessageMetaSchema.validate(validMetaWithCustom)
-      expect(error).toBeUndefined()
-    })
-
-    it('should validate valid meta object with empty custom properties', () => {
-      const validMetaWithCustom = {
-        ...validMeta,
-        custom: {}
-      }
-      const { error } =
-        formAdapterSubmissionMessageMetaSchema.validate(validMetaWithCustom)
-      expect(error).toBeUndefined()
-    })
-
-    it('should reject invalid schema version', () => {
-      const invalidMeta = { ...validMeta, schemaVersion: 'invalid' }
-      const { error } =
-        formAdapterSubmissionMessageMetaSchema.validate(invalidMeta)
-      expect(error).toBeDefined()
-    })
-
-    it('should reject missing required fields', () => {
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      const { timestamp: _, ...metaWithoutTimestamp } = validMeta
-      const { error } =
-        formAdapterSubmissionMessageMetaSchema.validate(metaWithoutTimestamp)
-      expect(error).toBeDefined()
-    })
-
-    it('should reject invalid custom structure', () => {
-      const validMetaWithInvalidCustom = {
-        ...validMeta,
-        custom: 'invalid'
-      }
-      const { error } = formAdapterSubmissionMessageMetaSchema.validate(
-        validMetaWithInvalidCustom
-      )
-      expect(error).toBeDefined()
-    })
-  })
-
-  describe('formAdapterSubmissionMessageDataSchema', () => {
-    it('should validate valid data object', () => {
-      const { error } =
-        formAdapterSubmissionMessageDataSchema.validate(validData)
-      expect(error).toBeUndefined()
-    })
-
-    it('should validate empty objects', () => {
-      const emptyData = { main: {}, repeaters: {}, files: {} }
-      const { error } =
-        formAdapterSubmissionMessageDataSchema.validate(emptyData)
-      expect(error).toBeUndefined()
-    })
-  })
-
-  describe('formAdapterSubmissionMessagePayloadSchema', () => {
-    const meta: FormAdapterSubmissionMessageMeta = {
-      schemaVersion: FormAdapterSubmissionSchemaVersion.V1,
-      timestamp: new Date('2025-08-22T18:15:10.785Z'),
-      referenceNumber: '576-225-943',
-      formName: 'Order a pizza',
-      formId: '68a8b0449ab460290c28940a',
-      formSlug: 'order-a-pizza',
-      status: FormStatus.Live,
-      isPreview: false,
-      notificationEmail: 'info@example.com'
-    }
-
-    const validPayload: FormAdapterSubmissionMessagePayload = {
-      meta,
-      data: validData,
-      result: {
-        files: {
-          main: '3d289230-83a3-4852-a68a-cb3569e9b0fe',
-          repeaters: {
-            ImxIOP: 'Joe Bloggs'
-          }
-        }
-      }
-    }
-
-    it('should validate complete payload', () => {
-      const { error } =
-        formAdapterSubmissionMessagePayloadSchema.validate(validPayload)
-      expect(error).toBeUndefined()
-    })
-
-    it('should reject payload without meta', () => {
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      const { meta: _, ...payloadWithoutMeta } = validPayload
-      const { error } =
-        formAdapterSubmissionMessagePayloadSchema.validate(payloadWithoutMeta)
-      expect(error).toBeDefined()
-    })
-
-    it('should reject payload without data', () => {
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      const { data: _, ...payloadWithoutData } = validPayload
-      const { error } =
-        formAdapterSubmissionMessagePayloadSchema.validate(payloadWithoutData)
-      expect(error).toBeDefined()
-    })
-
-    it('should validate payload with versionMetadata', () => {
-      const payloadWithVersion = {
-        ...validPayload,
-        meta: {
-          ...validPayload.meta,
-          versionMetadata: {
-            versionNumber: 19,
-            createdAt: new Date('2025-09-08T09:28:15.576Z')
-          }
-        }
-      }
-      const { error } =
-        formAdapterSubmissionMessagePayloadSchema.validate(payloadWithVersion)
-      expect(error).toBeUndefined()
-    })
-
-    it('should validate payload without versionMetadata', () => {
-      const { error } =
-        formAdapterSubmissionMessagePayloadSchema.validate(validPayload)
-      expect(error).toBeUndefined()
-    })
-
-    it('should reject invalid versionMetadata', () => {
-      const payloadWithInvalidVersion = {
-        ...validPayload,
-        meta: {
-          ...validPayload.meta,
-          versionMetadata: {
-            versionNumber: 'not-a-number', // Invalid - should be number
-            createdAt: new Date('2025-09-08T09:28:15.576Z')
-          }
-        }
-      }
-      const { error } = formAdapterSubmissionMessagePayloadSchema.validate(
-        payloadWithInvalidVersion
-      )
-      expect(error).toBeDefined()
-      expect(error?.message).toContain('must be a number')
-    })
-  })
-})

package/src/server/plugins/engine/views/components/service-banner/template.test.js

@@ -1,43 +0,0 @@
-import { renderMacro } from '~/test/helpers/component-helpers.js'
-
-describe('Service banner component', () => {
-  let $component = /** @type {HTMLElement | null} */ (null)
-  let $content = /** @type {HTMLElement | null} */ (null)
-  let $text = /** @type {HTMLElement | null} */ (null)
-
-  beforeEach(() => {
-    const { container, document } = renderMacro(
-      'appServiceBanner',
-      'components/service-banner/macro.njk',
-      {
-        params: {
-          title: 'Service status',
-          text: 'This is a service status message'
-        }
-      }
-    )
-
-    $component = container.getByRole('complementary')
-    $content = document.querySelector('.app-service-banner__content')
-    $text = document.querySelector('.app-service-banner__text')
-  })
-
-  it('should render contents', () => {
-    expect($component).toBeInTheDocument()
-    expect($component).toHaveClass('app-service-banner')
-    expect($component).toContainElement($content)
-    expect($content).toContainElement($text)
-  })
-
-  it('should announce service message', () => {
-    expect($component).toHaveAttribute('aria-live', 'polite')
-  })
-
-  it('should have accessible name', () => {
-    expect($component).toHaveAccessibleName('Service status')
-  })
-
-  it('should have text content', () => {
-    expect($text).toHaveTextContent('This is a service status message')
-  })
-})

package/src/server/plugins/engine/views/components/tag-env/template.test.js

@@ -1,28 +0,0 @@
-import { renderMacro } from '~/test/helpers/component-helpers.js'
-
-describe('Tag environment component', () => {
-  let $component = /** @type {HTMLElement | null} */ (null)
-
-  beforeEach(() => {
-    const { container } = renderMacro(
-      'appTagEnv',
-      'components/tag-env/macro.njk',
-      { params: { env: 'Devtool' } }
-    )
-
-    $component = container.getByRole('strong')
-  })
-
-  it('should render contents', () => {
-    expect($component).toBeInTheDocument()
-    expect($component).toHaveClass('govuk-tag')
-  })
-
-  it('should have text content', () => {
-    expect($component).toHaveTextContent('Devtool')
-  })
-
-  it('should use environment colour', () => {
-    expect($component).toHaveClass(`govuk-tag--grey`)
-  })
-})