@defra/forms-engine-plugin 4.7.2-alpha → 4.7.3

package/src/server/plugins/engine/views/partials/preview-banner.test.js

@@ -1,122 +0,0 @@
-import { FormStatus } from '~/src/server/routes/types.js'
-import { renderView } from '~/test/helpers/component-helpers.js'
-
-describe('Preview banner partial', () => {
-  describe.each([
-    {
-      status: FormStatus.Draft
-    },
-    {
-      status: FormStatus.Live
-    }
-  ])('Status: $status', ({ status }) => {
-    let $component = /** @type {HTMLElement | null} */ (null)
-    let $paragraphs = /** @type {HTMLElement[]} */ ([])
-
-    describe('Form preview', () => {
-      beforeEach(() => {
-        const { container } = renderView('partials/preview-banner.html', {
-          context: {
-            previewMode: status,
-            context: {
-              isForceAccess: false,
-              relevantPages: [{ title: 'Page 1' }]
-            }
-          }
-        })
-
-        $component = container.getByRole('region')
-        $paragraphs = container.getAllByRole('paragraph')
-      })
-
-      it('should render contents', () => {
-        expect($component).toBeInTheDocument()
-        expect($component).toContainElement($paragraphs[0])
-        expect($component).toHaveClass('govuk-notification-banner')
-
-        expect($paragraphs).toHaveLength(1)
-        expect($paragraphs[0]).toHaveClass('govuk-notification-banner__heading')
-      })
-
-      it('should have accessible name', () => {
-        expect($component).toHaveAccessibleName('Important')
-      })
-
-      it('should have text content', () => {
-        expect($paragraphs[0]).toHaveTextContent(
-          `This is a preview of a ${status} form. Do not enter personal information.`
-        )
-      })
-    })
-
-    describe('Preview URL direct access', () => {
-      beforeEach(() => {
-        const { container } = renderView('partials/preview-banner.html', {
-          context: {
-            previewMode: status,
-            context: {
-              isForceAccess: true,
-              relevantPages: [{ title: 'Page 1' }]
-            }
-          }
-        })
-
-        $component = container.getByRole('region')
-        $paragraphs = container.getAllByRole('paragraph')
-      })
-
-      it('should have text content', () => {
-        expect($paragraphs[0]).toHaveTextContent(
-          `This is a preview of a ${status} form page you are editing.`
-        )
-
-        expect($paragraphs[1]).toBeUndefined()
-      })
-    })
-
-    describe('Preview URL direct access (with previous pages)', () => {
-      beforeEach(() => {
-        const { container } = renderView('partials/preview-banner.html', {
-          context: {
-            previewMode: status,
-            context: {
-              isForceAccess: true,
-              relevantPages: [
-                { title: 'Page 1' },
-                { title: 'Page 2' },
-                { title: 'Page 3' }
-              ]
-            }
-          }
-        })
-
-        $component = container.getByRole('region')
-        $paragraphs = container.getAllByRole('paragraph')
-      })
-
-      it('should render contents', () => {
-        expect($component).toBeInTheDocument()
-        expect($component).toContainElement($paragraphs[0])
-        expect($component).toHaveClass('govuk-notification-banner')
-
-        expect($paragraphs).toHaveLength(2)
-        expect($paragraphs[0]).toHaveClass('govuk-notification-banner__heading')
-        expect($paragraphs[1]).toHaveClass('govuk-body')
-      })
-
-      it('should have accessible name', () => {
-        expect($component).toHaveAccessibleName('Important')
-      })
-
-      it('should have text content', () => {
-        expect($paragraphs[0]).toHaveTextContent(
-          `This is a preview of a ${status} form page you are editing.`
-        )
-
-        expect($paragraphs[1]).toHaveTextContent(
-          'It depends on answers from earlier pages in the form. In the live version, users will need to complete those questions first.'
-        )
-      })
-    })
-  })
-})

package/src/server/plugins/map/routes/get-os-token.test.js

@@ -1,55 +0,0 @@
-import { getAccessToken } from '~/src/server/plugins/map/routes/get-os-token.js'
-import { post } from '~/src/server/services/httpService.js'
-
-jest.mock('~/src/server/services/httpService.ts')
-
-describe('OS OAuth token', () => {
-  describe('getAccessToken', () => {
-    it('should get access token', async () => {
-      jest.mocked(post).mockResolvedValueOnce({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: 200,
-          headers: {}
-        }),
-        payload: {
-          access_token: 'access_token',
-          expires_in: '299',
-          issued_at: '1770036762387',
-          token_type: 'Bearer'
-        },
-        error: undefined
-      })
-
-      const token = await getAccessToken({
-        ordnanceSurveyApiKey: 'apikey',
-        ordnanceSurveyApiSecret: 'apisecret'
-      })
-
-      expect(token).toBe('access_token')
-
-      expect(post).toHaveBeenCalledWith('https://api.os.uk/oauth2/token/v1', {
-        headers: {
-          Authorization: `Basic ${btoa('apikey:apisecret')}`,
-          'Content-Type': 'application/x-www-form-urlencoded'
-        },
-        payload: 'grant_type=client_credentials',
-        json: true
-      })
-      expect(post).toHaveBeenCalledTimes(1)
-    })
-
-    it('should return an cached token', async () => {
-      const token = await getAccessToken({
-        ordnanceSurveyApiKey: 'apikey',
-        ordnanceSurveyApiSecret: 'apisecret'
-      })
-
-      expect(token).toBe('access_token')
-      expect(post).toHaveBeenCalledTimes(0)
-    })
-  })
-})
-
-/**
- * @import  { IncomingMessage } from 'node:http'
- */

package/src/server/plugins/map/service.test.js

@@ -1,144 +0,0 @@
-import Boom from '@hapi/boom'
-
-import * as service from '~/src/server/plugins/map/service.js'
-import { result as findResult } from '~/src/server/plugins/map/test/__stubs__/find.js'
-import { result as nearestResult } from '~/src/server/plugins/map/test/__stubs__/nearest.js'
-import { getJson } from '~/src/server/services/httpService.js'
-
-jest.mock('~/src/server/services/httpService.ts')
-
-describe('Maps service', () => {
-  describe('find', () => {
-    it('should return entires', async () => {
-      jest.mocked(getJson).mockResolvedValueOnce({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: 200,
-          headers: {}
-        }),
-        payload: findResult,
-        error: undefined
-      })
-
-      const { results } = await service.find('NW1 6XE', 'apikey')
-
-      expect(results).toHaveLength(8)
-      expect(results.at(1)).toEqual({
-        GAZETTEER_ENTRY: {
-          ID: 'NW26XE',
-          NAMES_URI: 'http://data.ordnancesurvey.co.uk/id/postcodeunit/NW26XE',
-          NAME1: 'NW2 6XE',
-          TYPE: 'other',
-          LOCAL_TYPE: 'Postcode',
-          GEOMETRY_X: 523065,
-          GEOMETRY_Y: 185795,
-          MOST_DETAIL_VIEW_RES: 3500,
-          LEAST_DETAIL_VIEW_RES: 18000,
-          POPULATED_PLACE: 'London',
-          POPULATED_PLACE_URI:
-            'http://data.ordnancesurvey.co.uk/id/4000000074813508',
-          POPULATED_PLACE_TYPE:
-            'http://www.ordnancesurvey.co.uk/xml/codelists/localtype.xml#city',
-          DISTRICT_BOROUGH: 'Brent',
-          DISTRICT_BOROUGH_URI:
-            'http://data.ordnancesurvey.co.uk/id/7000000000011447',
-          DISTRICT_BOROUGH_TYPE:
-            'http://data.ordnancesurvey.co.uk/ontology/admingeo/LondonBorough',
-          COUNTY_UNITARY: 'Greater London',
-          COUNTY_UNITARY_URI:
-            'http://data.ordnancesurvey.co.uk/id/7000000000041441',
-          COUNTY_UNITARY_TYPE:
-            'http://data.ordnancesurvey.co.uk/ontology/admingeo/GreaterLondonAuthority',
-          REGION: 'London',
-          REGION_URI: 'http://data.ordnancesurvey.co.uk/id/7000000000041428',
-          COUNTRY: 'England',
-          COUNTRY_URI: 'http://data.ordnancesurvey.co.uk/id/country/england'
-        }
-      })
-    })
-
-    it('should return an empty response when an error is encountered', async () => {
-      jest.mocked(getJson).mockResolvedValueOnce({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: 300,
-          headers: {}
-        }),
-        payload: undefined,
-        error: new Error('Unknown error')
-      })
-
-      const { results } = await service.find('NW1 6XE', 'apikey')
-
-      expect(results).toHaveLength(0)
-      expect(results).toEqual([])
-    })
-
-    it('should return an empty response when a non 200 response is encountered', async () => {
-      jest
-        .mocked(getJson)
-        .mockRejectedValueOnce(
-          Boom.badRequest(
-            'OS API error',
-            new Error('Invalid postcode segments')
-          )
-        )
-
-      const { results } = await service.find('invalid postcode', 'apikey')
-
-      expect(results).toHaveLength(0)
-      expect(results).toEqual([])
-    })
-  })
-
-  describe('nearest', () => {
-    it('should return entries', async () => {
-      jest.mocked(getJson).mockResolvedValueOnce({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: 200,
-          headers: {}
-        }),
-        payload: nearestResult,
-        error: undefined
-      })
-
-      const { results } = await service.nearest(700000, 1300000, 'apikey')
-
-      expect(results).toHaveLength(1)
-      expect(results.at(0)).toEqual({
-        GAZETTEER_ENTRY: {
-          ID: 'NW26XE',
-          NAMES_URI: 'http://data.ordnancesurvey.co.uk/id/postcodeunit/NW26XE',
-          NAME1: 'NW2 6XE',
-          TYPE: 'other',
-          LOCAL_TYPE: 'Postcode',
-          GEOMETRY_X: 523065,
-          GEOMETRY_Y: 185795,
-          MOST_DETAIL_VIEW_RES: 3500,
-          LEAST_DETAIL_VIEW_RES: 18000,
-          POPULATED_PLACE: 'London',
-          POPULATED_PLACE_URI:
-            'http://data.ordnancesurvey.co.uk/id/4000000074813508',
-          POPULATED_PLACE_TYPE:
-            'http://www.ordnancesurvey.co.uk/xml/codelists/localtype.xml#city',
-          DISTRICT_BOROUGH: 'Brent',
-          DISTRICT_BOROUGH_URI:
-            'http://data.ordnancesurvey.co.uk/id/7000000000011447',
-          DISTRICT_BOROUGH_TYPE:
-            'http://data.ordnancesurvey.co.uk/ontology/admingeo/LondonBorough',
-          COUNTY_UNITARY: 'Greater London',
-          COUNTY_UNITARY_URI:
-            'http://data.ordnancesurvey.co.uk/id/7000000000041441',
-          COUNTY_UNITARY_TYPE:
-            'http://data.ordnancesurvey.co.uk/ontology/admingeo/GreaterLondonAuthority',
-          REGION: 'London',
-          REGION_URI: 'http://data.ordnancesurvey.co.uk/id/7000000000041428',
-          COUNTRY: 'England',
-          COUNTRY_URI: 'http://data.ordnancesurvey.co.uk/id/country/england'
-        }
-      })
-    })
-  })
-})
-
-/**
- * @import  { IncomingMessage } from 'node:http'
- */

package/src/server/plugins/nunjucks/context.test.js

@@ -1,109 +0,0 @@
-import { tmpdir } from 'node:os'
-
-import {
-  context,
-  devtoolContext
-} from '~/src/server/plugins/nunjucks/context.js'
-
-describe('Nunjucks context', () => {
-  beforeEach(() => jest.resetModules())
-
-  describe('Asset path', () => {
-    it("should include 'assetPath' for GOV.UK Frontend icons", () => {
-      const { assetPath } = devtoolContext(null)
-      expect(assetPath).toBe('/assets')
-    })
-  })
-
-  describe('Asset helper', () => {
-    it("should locate 'assets-manifest.json' assets", () => {
-      const { getDxtAssetPath } = devtoolContext(null)
-
-      expect(getDxtAssetPath('example.scss')).toBe(
-        '/stylesheets/example.xxxxxxx.min.css'
-      )
-
-      expect(getDxtAssetPath('example.mjs')).toBe(
-        '/javascripts/example.xxxxxxx.min.js'
-      )
-    })
-
-    it("should return path when 'assets-manifest.json' is missing", async () => {
-      await jest.isolateModulesAsync(async () => {
-        const { config } = await import('~/src/config/index.js')
-
-        // Import when isolated to avoid cache
-        const { devtoolContext } =
-          await import('~/src/server/plugins/nunjucks/context.js')
-
-        // Update config for missing manifest
-        config.set('publicDir', tmpdir())
-        const { getDxtAssetPath } = devtoolContext(null)
-
-        // Uses original paths when missing
-        expect(getDxtAssetPath('example.scss')).toBe('/example.scss')
-        expect(getDxtAssetPath('example.mjs')).toBe('/example.mjs')
-      })
-    })
-
-    it('should return path to unknown assets', () => {
-      const { getDxtAssetPath } = devtoolContext(null)
-
-      expect(getDxtAssetPath('')).toBe('/')
-      expect(getDxtAssetPath('example.jpg')).toBe('/example.jpg')
-      expect(getDxtAssetPath('example.gif')).toBe('/example.gif')
-    })
-  })
-
-  describe('Config', () => {
-    it('should include environment, phase tag and service info', async () => {
-      await expect(context(null)).rejects.toThrow(
-        'context called before plugin registered'
-      )
-    })
-  })
-
-  describe('Crumb', () => {
-    it('should handle malformed requests with missing state', async () => {
-      // While state should always exist in a valid Hapi request (it holds cookies),
-      // we've seen malformed requests in production where it's missing
-      const malformedRequest = /** @type {FormRequest} */ (
-        /** @type {unknown} */ ({
-          server: {
-            plugins: {
-              crumb: {
-                generate: jest.fn()
-              },
-              'forms-engine-plugin': {
-                baseLayoutPath: 'randomValue'
-              }
-            }
-          },
-          plugins: {},
-          route: {
-            settings: {
-              plugins: {}
-            }
-          },
-          path: '/test',
-          url: { search: '' },
-          yar: {
-            flash: jest.fn().mockReturnValue([]),
-            commit: jest.fn()
-          }
-          // state intentionally omitted to test real malformed requests
-        })
-      )
-
-      const { crumb } = await context(malformedRequest)
-      expect(crumb).toBeUndefined()
-      expect(
-        malformedRequest.server.plugins.crumb.generate
-      ).not.toHaveBeenCalled()
-    })
-  })
-})
-
-/**
- * @import { FormRequest } from '~/src/server/routes/types.js'
- */

package/src/server/plugins/nunjucks/enviroment.test.js

@@ -1,207 +0,0 @@
-import * as helpers from '~/src/server/plugins/engine/helpers.js'
-import { environment } from '~/src/server/plugins/nunjucks/environment.js'
-
-describe('Nunjucks environment', () => {
-  describe('checkErrorTemplates function', () => {
-    /** @type {Function} */
-    let checkErrorTemplates
-
-    beforeEach(() => {
-      checkErrorTemplates = environment.getGlobal('checkErrorTemplates')
-
-      jest
-        .spyOn(helpers, 'evaluateTemplate')
-        .mockImplementation((text) => `evaluated-${text}`)
-    })
-
-    afterEach(() => {
-      jest.restoreAllMocks()
-    })
-
-    test('returns errors unchanged when context is not present', () => {
-      const nunjucksCtx = {
-        ctx: {}
-      }
-
-      const errors = [{ text: 'Error 1' }, { text: 'Error 2' }]
-
-      const result = checkErrorTemplates.call(nunjucksCtx, errors)
-
-      expect(result).toBe(errors)
-      expect(helpers.evaluateTemplate).not.toHaveBeenCalled()
-    })
-
-    test('evaluates error texts when context is present', () => {
-      const formContext = { someData: 'some-text' }
-      const nunjucksCtx = {
-        ctx: { context: formContext }
-      }
-
-      const errors = [{ text: 'Error 1' }, { text: 'Error 2' }]
-
-      const result = checkErrorTemplates.call(nunjucksCtx, errors)
-
-      expect(helpers.evaluateTemplate).toHaveBeenCalledTimes(2)
-      expect(helpers.evaluateTemplate).toHaveBeenCalledWith(
-        'Error 1',
-        formContext
-      )
-      expect(helpers.evaluateTemplate).toHaveBeenCalledWith(
-        'Error 2',
-        formContext
-      )
-
-      expect(result).toEqual([
-        { text: 'evaluated-Error 1' },
-        { text: 'evaluated-Error 2' }
-      ])
-    })
-  })
-
-  describe('checkComponentTemplates function', () => {
-    /** @type {Function} */
-    let checkComponentTemplates
-
-    beforeEach(() => {
-      checkComponentTemplates = environment.getGlobal('checkComponentTemplates')
-
-      jest
-        .spyOn(helpers, 'evaluateTemplate')
-        .mockImplementation((text) => `evaluated-${text}`)
-    })
-
-    afterEach(() => {
-      jest.restoreAllMocks()
-    })
-
-    test('evaluates string content for Html components', () => {
-      const formContext = { someData: 'some-text' }
-      const nunjucksCtx = {
-        ctx: { context: formContext }
-      }
-
-      const component = {
-        type: 'Html',
-        isFormComponent: false,
-        model: {
-          content: 'Some {{ context.someData }} content'
-        }
-      }
-
-      const result = /** @type {{ model: { content: string } }} */ (
-        checkComponentTemplates.call(nunjucksCtx, component)
-      )
-
-      expect(helpers.evaluateTemplate).toHaveBeenCalledWith(
-        'Some {{ context.someData }} content',
-        formContext
-      )
-      expect(result.model.content).toBe(
-        'evaluated-Some {{ context.someData }} content'
-      )
-    })
-
-    test('does not evaluate non-string content for Html components', () => {
-      const formContext = { someData: 'some-text' }
-      const nunjucksCtx = {
-        ctx: { context: formContext }
-      }
-
-      const nonStringContent = { some: 'object' }
-      const component = {
-        type: 'Html',
-        isFormComponent: false,
-        model: {
-          content: nonStringContent
-        }
-      }
-
-      const result = /** @type {{ model: { content: string } }} */ (
-        checkComponentTemplates.call(nunjucksCtx, component)
-      )
-
-      expect(helpers.evaluateTemplate).not.toHaveBeenCalled()
-
-      expect(result.model.content).toBe(nonStringContent)
-    })
-
-    test('evaluates label text for form components', () => {
-      const formContext = { someData: 'some-text' }
-      const nunjucksCtx = {
-        ctx: { context: formContext }
-      }
-
-      const component = {
-        isFormComponent: true,
-        model: {
-          label: {
-            text: 'Label with {{ context.someData }}'
-          }
-        }
-      }
-
-      const result = /** @type {{ model: { label?: { text: string } } }} */ (
-        checkComponentTemplates.call(nunjucksCtx, component)
-      )
-
-      expect(helpers.evaluateTemplate).toHaveBeenCalledWith(
-        'Label with {{ context.someData }}',
-        formContext
-      )
-
-      expect(result.model.label?.text).toBe(
-        'evaluated-Label with {{ context.someData }}'
-      )
-    })
-  })
-
-  describe('evaluate function', () => {
-    /** @type {Function} */
-    let evaluateFunc
-
-    beforeEach(() => {
-      evaluateFunc = environment.getGlobal('evaluate')
-
-      jest
-        .spyOn(helpers, 'evaluateTemplate')
-        .mockImplementation((text) => `evaluated-${text}`)
-    })
-
-    afterEach(() => {
-      jest.restoreAllMocks()
-    })
-
-    test('evaluates template when context is present', () => {
-      const formContext = { someData: 'some-text' }
-      const nunjucksCtx = {
-        ctx: { context: formContext }
-      }
-
-      const template = 'Template with {{ context.someData }}'
-      const result = evaluateFunc.call(nunjucksCtx, template)
-
-      expect(helpers.evaluateTemplate).toHaveBeenCalledWith(
-        template,
-        formContext
-      )
-      expect(result).toBe('evaluated-Template with {{ context.someData }}')
-    })
-
-    test('returns template unchanged when context is not present', () => {
-      const nunjucksCtx = {
-        ctx: {}
-      }
-
-      const template = 'Template with {{ context.someData }}'
-      const result = evaluateFunc.call(nunjucksCtx, template)
-
-      expect(helpers.evaluateTemplate).not.toHaveBeenCalled()
-
-      expect(result).toBe(template)
-    })
-  })
-})
-
-/*
- * @import { ComponentViewModel } from '~/src/server/plugins/engine/components/types.js'
- */