@defra/forms-engine-plugin 0.1.10 → 0.1.12

package/src/server/plugins/engine/views/layout.html

@@ -1,199 +0,0 @@
-{% extends "govuk/template.njk" %}
-
-{% from "govuk/components/back-link/macro.njk" import govukBackLink -%}
-{% from "govuk/components/footer/macro.njk" import govukFooter -%}
-{% from "govuk/components/phase-banner/macro.njk" import govukPhaseBanner -%}
-{% from "govuk/components/skip-link/macro.njk" import govukSkipLink -%}
-{% from "govuk/macros/attributes.njk" import govukAttributes -%}
-{% from "components/service-banner/macro.njk" import appServiceBanner -%}
-{% from "components/tag-env/macro.njk" import appTagEnv -%}
-{% from "govuk/components/cookie-banner/macro.njk" import govukCookieBanner -%}
-{% from "govuk/components/notification-banner/macro.njk" import govukNotificationBanner -%}
-
-{% set productName %}
-  {% if config.cdpEnvironment !== "prod" %}
-    {{ appTagEnv({ env: config.cdpEnvironment }) }}
-  {% endif %}
-{% endset %}
-
-{% block head %}
-  <meta name="application-name" content="@defra/forms-runner" {{- govukAttributes({
-    "data-environment": {
-      value: config.cdpEnvironment,
-      optional: true
-    },
-    "data-version": {
-      value: config.serviceVersion,
-      optional: true
-    }
-  }) }}>
-
-  <link rel="preload" as="font" href="{{ assetPath }}/fonts/bold-b542beb274-v2.woff2" type="font/woff2" crossorigin="anonymous">
-  <link rel="preload" as="font" href="{{ assetPath }}/fonts/light-94a07e06a1-v2.woff2" type="font/woff2" crossorigin="anonymous">
-  <link rel="stylesheet" href="{{ getAssetPath("stylesheets/application.scss") }}">
-{% endblock %}
-
-{% block pageTitle -%}
-  {{ "Error: " if errors | length }}{{ pageTitle | evaluate }} - {{ name if name else config.serviceName }} - GOV.UK
-{%- endblock %}
-
-{% block skipLink %}
-  {{ govukSkipLink({
-    href: '#main-content',
-    text: 'Skip to main content'
-  }) }}
-{% endblock %}
-
-{% block header %}
-  {% if config.googleAnalyticsTrackingId and slug %}
-    <form method="post" action="/help/cookie-preferences/{{ slug }}?returnUrl={{ currentPath | urlencode }}">
-      <input type="hidden" name="crumb" value="{{ crumb }}">
-
-    {% set acceptHtml %}
-      <p class="govuk-body">You’ve accepted analytics cookies. You can <a class="govuk-link" href="/help/cookies/{{ slug }}">change your cookie settings</a> at any time.</p>
-    {% endset %}
-
-    {% set rejectedHtml %}
-      <p class="govuk-body">You’ve rejected analytics cookies. You can <a class="govuk-link" href="/help/cookies/{{ slug }}">change your cookie settings</a> at any time.</p>
-    {% endset %}
-
-    {% if cookieConsent.analytics !== true and cookieConsent.analytics !== false and cookieConsent.dismissed !== true %}
-      {% set html %}
-        <p class="govuk-body">We use some essential cookies to make this service work.</p>
-        <p class="govuk-body">We’d like to set analytics cookies so we can understand how people use the service and make improvements.</p>
-      {% endset %}
-
-      {{ govukCookieBanner({
-        ariaLabel: "Cookies on " + config.serviceName,
-        messages: [
-          {
-            headingText: config.serviceName,
-            html: html,
-            actions: [
-              {
-                text: "Accept analytics cookies",
-                type: "submit",
-                name: "cookies[analytics]",
-                value: "yes"
-              },
-              {
-                text: "Reject analytics cookies",
-                type: "submit",
-                name: "cookies[analytics]",
-                value: "no"
-              },
-              {
-                text: "View cookies",
-                href: "/help/cookies/" + slug
-              }
-            ]
-          }
-        ]
-      }) }}
-    {% elif cookieConsent.dismissed === false %}
-      {{ govukCookieBanner({
-        ariaLabel: "Cookies on " + config.serviceName,
-        messages: [
-          {
-            html: acceptHtml if cookieConsent.analytics === true else rejectedHtml,
-            actions: [
-              {
-                text: "Hide cookie message",
-                type: "submit",
-                name: "cookies[dismissed]",
-                value: "yes"
-              }
-            ]
-          }
-        ]
-      }) }}
-    {% endif %}
-
-    </form>
-  {% endif %}
-
-  {% if config.serviceBannerText | length %}
-    {{ appServiceBanner({
-      title: "Service status",
-      text: config.serviceBannerText
-    }) }}
-  {% endif %}
-
-  {{ govukHeader({
-    homepageUrl: currentPath if context.isForceAccess else "https://www.gov.uk",
-    containerClasses: "govuk-width-container",
-    productName: productName | safe | trim,
-    serviceName: name if name else config.serviceName,
-    serviceUrl: currentPath if context.isForceAccess else serviceUrl
-  }) }}
-{% endblock %}
-
-{% block beforeContent %}
-  {% set feedbackLink = feedbackLink or config.feedbackLink -%}
-  {% set phaseTag = phaseTag or config.phaseTag -%}
-
-  {% if phaseTag and feedbackLink %}
-    {% set feedbackLinkHtml -%}
-      <a href="{{ currentPath if context.isForceAccess else feedbackLink }}" class="govuk-link" {%- if not context.isForceAccess %} target="_blank" rel="noopener noreferrer" {%- endif %}>
-        {%- if "mailto:" in feedbackLink -%}
-          give your feedback by email
-        {%- else -%}
-          give your feedback (opens in new tab)
-        {%- endif -%}
-      </a>
-    {%- endset %}
-
-    {{ govukPhaseBanner({
-      tag: { text: phaseTag | capitalize },
-      html: "This is a new service. Help us improve it and " + feedbackLinkHtml | safe + "."
-    }) }}
-  {% endif %}
-  {% if backLink %}
-    {{ govukBackLink(backLink) }}
-  {% endif %}
-{% endblock %}
-
-{% block content %}
-  <h1 class="govuk-heading-l">Default page template</h1>
-{% endblock %}
-
-{% block bodyEnd %}
-  <script type="module" nonce="{{ cspNonce }}" src="{{ getAssetPath("application.js") }}"></script>
-
-  {% if config.googleAnalyticsTrackingId and cookieConsent.analytics === true %}
-  <script id="ga-tag-js-main" nonce="{{ cspNonce }}" src="https://www.googletagmanager.com/gtag/js?id={{ config.googleAnalyticsTrackingId }}" defer></script>
-  <script id="ga-tag-js-init" nonce="{{ cspNonce }}">
-    window.dataLayer = window.dataLayer || [];
-    function gtag(){dataLayer.push(arguments);}
-    gtag('js', new Date());
-    gtag('config', '{{ config.googleAnalyticsTrackingId }}');
-  </script>
-{% endif %}
-{% endblock %}
-
-{% block footer %}
-  {% set meta = {
-    items: [
-      {
-        href: '/help/get-support/' + slug,
-        text: 'Get help with this form'
-      },
-      {
-        href: '/help/privacy/' + slug,
-        text: 'Privacy'
-      },
-      {
-        href: '/help/cookies/' + slug,
-        text: 'Cookies'
-      },
-      {
-        href: '/help/accessibility-statement/' + slug,
-        text: 'Accessibility Statement'
-      }
-    ]
-  } if slug %}
-
-  {% if not context.isForceAccess %}
-    {{ govukFooter({ meta: meta }) }}
-  {% endif %}
-{% endblock %}

package/src/server/plugins/router.ts

@@ -1,201 +0,0 @@
-import { slugSchema } from '@defra/forms-model'
-import Boom from '@hapi/boom'
-import { type ServerRegisterPluginObject } from '@hapi/hapi'
-import humanizeDuration from 'humanize-duration'
-import Joi from 'joi'
-
-import {
-  defaultConsent,
-  parseCookieConsent,
-  serialiseCookieConsent
-} from '~/src/common/cookies.js'
-import { type CookieConsent } from '~/src/common/types.js'
-import { config } from '~/src/config/index.js'
-import { isPathRelative } from '~/src/server/plugins/engine/helpers.js'
-import { getFormMetadata } from '~/src/server/plugins/engine/services/formsService.js'
-import { healthRoute, publicRoutes } from '~/src/server/routes/index.js'
-import { crumbSchema } from '~/src/server/schemas/index.js'
-
-const routes = [...publicRoutes, healthRoute]
-
-export default {
-  plugin: {
-    name: 'router',
-    register: (server) => {
-      server.route(routes)
-
-      // Shared help routes params schema & options
-      const params = Joi.object()
-        .keys({
-          slug: slugSchema
-        })
-        .required()
-
-      const options = {
-        validate: {
-          params
-        }
-      }
-
-      server.route<{ Params: { slug: string } }>({
-        method: 'get',
-        path: '/help/get-support/{slug}',
-        async handler(request, h) {
-          const { slug } = request.params
-          const form = await getFormMetadata(slug)
-
-          return h.view('help/get-support', { form })
-        },
-        options
-      })
-
-      server.route<{ Params: { slug: string } }>({
-        method: 'get',
-        path: '/help/privacy/{slug}',
-        async handler(request, h) {
-          const { slug } = request.params
-          const form = await getFormMetadata(slug)
-
-          return h.view('help/privacy-notice', { form })
-        },
-        options
-      })
-
-      server.route<{ Params: { slug: string } }>({
-        method: 'get',
-        path: '/help/cookies/{slug}',
-        handler(_request, h) {
-          const sessionTimeout = config.get('sessionTimeout')
-
-          const sessionDurationPretty = humanizeDuration(sessionTimeout)
-
-          return h.view('help/cookies', {
-            googleAnalyticsContainerId: config
-              .get('googleAnalyticsTrackingId')
-              .replace(/^G-/, ''),
-            sessionDurationPretty
-          })
-        },
-        options
-      })
-
-      server.route<{
-        Params: { slug: string }
-        Payload: {
-          crumb?: string
-          'cookies[analytics]'?: string
-          'cookies[dismissed]'?: string
-        }
-        Query: { returnUrl?: string }
-      }>({
-        method: 'post',
-        path: '/help/cookie-preferences/{slug}',
-        handler(request, h) {
-          const { params, payload, query } = request
-          const { slug } = params
-          let { returnUrl } = query
-
-          if (returnUrl && !isPathRelative(returnUrl)) {
-            throw Boom.badRequest('Return URL must be relative')
-          }
-
-          const analyticsDecision = (
-            payload['cookies[analytics]'] ?? ''
-          ).toLowerCase()
-
-          const dismissedDecision = (
-            payload['cookies[dismissed]'] ?? ''
-          ).toLowerCase()
-
-          // move the parser into our JS code so we can delegate to the frontend in a future iteration
-          let cookieConsent: CookieConsent
-
-          if (typeof request.state.cookieConsent === 'string') {
-            cookieConsent = parseCookieConsent(request.state.cookieConsent)
-          } else {
-            cookieConsent = defaultConsent
-          }
-
-          if (analyticsDecision) {
-            cookieConsent.analytics = analyticsDecision === 'yes'
-            cookieConsent.dismissed = false
-          }
-
-          if (dismissedDecision) {
-            cookieConsent.dismissed = dismissedDecision === 'yes'
-          }
-
-          if (!returnUrl) {
-            cookieConsent.dismissed = true // this page already has a confirmation message, don't show another
-            returnUrl = `/help/cookie-preferences/${slug}`
-          }
-
-          const serialisedCookieConsent = serialiseCookieConsent(cookieConsent)
-          h.state('cookieConsent', serialisedCookieConsent)
-
-          return h.redirect(returnUrl)
-        },
-        options: {
-          validate: {
-            params,
-            payload: Joi.object({
-              crumb: crumbSchema,
-              'cookies[analytics]': Joi.string().valid('yes', 'no').optional(),
-              'cookies[dismissed]': Joi.string().valid('yes', 'no').optional()
-            }),
-            query: Joi.object({
-              returnUrl: Joi.string().optional()
-            })
-          }
-        }
-      })
-
-      server.route({
-        method: 'get',
-        path: '/',
-        handler() {
-          throw Boom.notFound()
-        }
-      })
-
-      server.route<{ Params: { slug: string } }>({
-        method: 'get',
-        path: '/help/cookie-preferences/{slug}',
-        handler(request, h) {
-          const { params } = request
-          const { slug } = params
-          let cookieConsentDismissed = false
-
-          if (typeof request.state.cookieConsent === 'string') {
-            const cookieConsent = parseCookieConsent(
-              request.state.cookieConsent
-            )
-
-            cookieConsentDismissed = cookieConsent.dismissed
-          }
-
-          // if the user has come back to this page after updating their preferences
-          // override the 'dismissed' behaviour to show a success notification instead of
-          // the cookie banner
-          const showConsentSuccess =
-            cookieConsentDismissed &&
-            request.info.referrer.endsWith(`/help/cookie-preferences/${slug}`)
-
-          return h.view('help/cookie-preferences', {
-            cookieConsentUpdated: showConsentSuccess
-          })
-        },
-        options
-      })
-
-      server.route<{ Params: { slug: string } }>({
-        method: 'get',
-        path: '/help/accessibility-statement/{slug}',
-        handler(_request, h) {
-          return h.view('help/accessibility-statement')
-        },
-        options
-      })
-    }
-  }
-} satisfies ServerRegisterPluginObject<void>

package/src/server/routes/health.js

@@ -1,13 +0,0 @@
-import { StatusCodes } from 'http-status-codes'
-
-export default /** @type {ServerRoute} */ ({
-  method: 'GET',
-  path: '/health',
-  handler(_, h) {
-    return h.response({ message: 'success' }).code(StatusCodes.OK)
-  }
-})
-
-/**
- * @import { ServerRoute } from '@hapi/hapi'
- */

package/src/server/routes/health.test.js

@@ -1,35 +0,0 @@
-import { createServer } from '~/src/server/index.js'
-
-describe('Health check route', () => {
-  const startServer = async () => {
-    const server = await createServer()
-    await server.initialize()
-    return server
-  }
-
-  /** @type {Server} */
-  let server
-
-  afterEach(async () => {
-    await server.stop()
-  })
-
-  test('/health route response is correct', async () => {
-    server = await startServer()
-
-    const options = {
-      method: 'GET',
-      url: '/health'
-    }
-
-    const { result } = await server.inject(options)
-
-    expect(result).toMatchObject({
-      message: 'success'
-    })
-  })
-})
-
-/**
- * @import { Server } from '@hapi/hapi'
- */

package/src/server/routes/index.test.ts

@@ -1,125 +0,0 @@
-import { type Server } from '@hapi/hapi'
-import { StatusCodes } from 'http-status-codes'
-
-import { config } from '~/src/config/index.js'
-import { createServer } from '~/src/server/index.js'
-import { getFormMetadata } from '~/src/server/plugins/engine/services/formsService.js'
-import * as fixtures from '~/test/fixtures/index.js'
-import { renderResponse } from '~/test/helpers/component-helpers.js'
-
-jest.mock('~/src/server/plugins/engine/services/formsService.js')
-
-describe('Routes', () => {
-  let server: Server
-
-  beforeAll(async () => {
-    server = await createServer()
-    await server.initialize()
-  })
-
-  afterAll(async () => {
-    await server.stop()
-  })
-
-  test('cookies page is served with 24 hour duration', async () => {
-    config.set('sessionTimeout', 86400000)
-
-    const options = {
-      method: 'GET',
-      url: '/help/cookies/slug'
-    }
-
-    const { container } = await renderResponse(server, options)
-
-    const $heading = container.getByRole('heading', {
-      name: 'Cookies',
-      level: 1
-    })
-
-    const $googleAnalyticsRowheader = container.getByRole('rowheader', {
-      name: '_ga_123456789'
-    })
-
-    const $sessionDurationRow = container.getByRole('row', {
-      name: 'session Remembers the information you enter When you close the browser, or after 1 day'
-    })
-
-    expect($heading).toBeInTheDocument()
-    expect($heading).toHaveClass('govuk-heading-l')
-    expect($googleAnalyticsRowheader).toBeInTheDocument()
-    expect($sessionDurationRow).toBeInTheDocument()
-  })
-
-  test('accessibility statement page is served', async () => {
-    const options = {
-      method: 'GET',
-      url: '/help/accessibility-statement/slug'
-    }
-
-    const { container } = await renderResponse(server, options)
-
-    const $heading = container.getByRole('heading', {
-      name: 'Accessibility statement for this form',
-      level: 1
-    })
-
-    expect($heading).toBeInTheDocument()
-    expect($heading).toHaveClass('govuk-heading-l')
-  })
-
-  test('Help page is served', async () => {
-    jest.mocked(getFormMetadata).mockResolvedValue(fixtures.form.metadata)
-
-    const options = {
-      method: 'GET',
-      url: '/help/get-support/slug'
-    }
-
-    const res = await server.inject(options)
-
-    expect(res.statusCode).toBe(StatusCodes.OK)
-  })
-
-  test('Service banner is not shown by default', async () => {
-    const { container } = await renderResponse(server, {
-      method: 'GET',
-      url: '/'
-    })
-
-    const $banner = container.queryByRole('complementary', {
-      name: 'Service status'
-    })
-
-    expect($banner).not.toBeInTheDocument()
-  })
-
-  test('Service banner is not shown when empty', async () => {
-    config.set('serviceBannerText', '')
-
-    const { container } = await renderResponse(server, {
-      method: 'GET',
-      url: '/'
-    })
-
-    const $banner = container.queryByRole('complementary', {
-      name: 'Service status'
-    })
-
-    expect($banner).not.toBeInTheDocument()
-  })
-
-  test('Service banner is shown when configured', async () => {
-    config.set('serviceBannerText', 'Hello world')
-
-    const { container } = await renderResponse(server, {
-      method: 'GET',
-      url: '/'
-    })
-
-    const $banner = container.getByRole('complementary', {
-      name: 'Service status'
-    })
-
-    expect($banner).toHaveTextContent('Hello world')
-  })
-})

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

@@ -1,79 +0,0 @@
-import { FormStatus } from '~/src/server/routes/types.js'
-import { FileFormService } from '~/src/server/utils/file-form-service.js'
-
-// Create the metadata which is shared for all forms
-const now = new Date()
-const user = { id: 'user', displayName: 'Username' }
-const author = {
-  createdAt: now,
-  createdBy: user,
-  updatedAt: now,
-  updatedBy: user
-}
-
-const metadata = {
-  id: '95e92559-968d-44ae-8666-2b1ad3dffd31',
-  slug: 'example-form',
-  title: 'Example form',
-  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
-}
-
-describe('File Form Service', () => {
-  it('should load JSON files from disk', async () => {
-    const loader = new FileFormService()
-
-    const definition = await loader.addForm(
-      'src/server/forms/test.json',
-      metadata
-    )
-
-    const formsService = loader.toFormsService()
-    expect(await formsService.getFormMetadata(metadata.slug)).toBe(metadata)
-    expect(
-      await formsService.getFormDefinition(metadata.id, FormStatus.Draft)
-    ).toBe(definition)
-
-    expect(() => loader.getFormMetadata('invalid-slug')).toThrow(
-      "Form metadata 'invalid-slug' not found"
-    )
-    expect(() => loader.getFormDefinition('invalid-id')).toThrow(
-      "Form definition 'invalid-id' not found"
-    )
-  })
-
-  it('should load YAML files from disk', async () => {
-    const loader = new FileFormService()
-
-    const definition = await loader.addForm(
-      'src/server/forms/test.yaml',
-      metadata
-    )
-
-    const formsService = loader.toFormsService()
-    expect(await formsService.getFormMetadata(metadata.slug)).toBe(metadata)
-    expect(
-      await formsService.getFormDefinition(metadata.id, FormStatus.Draft)
-    ).toBe(definition)
-
-    expect(() => loader.getFormMetadata('invalid-slug')).toThrow(
-      "Form metadata 'invalid-slug' not found"
-    )
-    expect(() => loader.getFormDefinition('invalid-id')).toThrow(
-      "Form definition 'invalid-id' not found"
-    )
-  })
-
-  it("should throw if the file isn't JSON or YAML", async () => {
-    const loader = new FileFormService()
-
-    await expect(
-      loader.addForm('src/server/forms/test.txt', metadata)
-    ).rejects.toThrow("Invalid file extension '.txt'")
-  })
-})

package/src/server/views/404.html

@@ -1,16 +0,0 @@
-{% extends 'layout.html' %}
-
-{% block content %}
-  <div class="govuk-width-container">
-    <div class="govuk-main-wrapper">
-      <div class="govuk-grid-row">
-        <div class="govuk-grid-column-two-thirds">
-          <h1 class="govuk-heading-l">Page not found</h1>
-          <p class="govuk-body">If you typed the web address, check it is correct.</p>
-          <p class="govuk-body">If you pasted the web address, check you copied the entire address.</p>
-          <p class="govuk-body">If the web address is correct or you selected a link or button, <a href="https://www.gov.uk/guidance/contact-defra" class="govuk-link">contact the Defra Helpline</a> if you need to speak to someone about your form.</p>
-        </div>
-      </div>
-    </div>
-  </div>
-{% endblock %}

package/src/server/views/500.html

@@ -1,19 +0,0 @@
-{% extends 'layout.html' %}
-
-{% block content %}
-  <div class="govuk-width-container">
-    <div class="govuk-main-wrapper">
-      <div class="govuk-grid-row">
-        <div class="govuk-grid-column-two-thirds">
-          <h1 class="govuk-heading-l">Sorry, there is a problem with the service</h1>
-          <p class="govuk-body">You can:</p>
-          <ul class="govuk-list govuk-list--bullet">
-            <li>try your browser back button as your data may be saved</li>
-            <li><a class="govuk-link" href="https://www.gov.uk/guidance/contact-defra">contact the Defra Helpline</a> if you
-            have any questions</li>
-          </ul>
-        </div>
-      </div>
-    </div>
-  </div>
-{% endblock %}