@defra/forms-engine-plugin 4.11.2 → 4.12.0

package/src/server/plugins/engine/beta/form-context.ts

@@ -3,6 +3,7 @@ import { type Request, type Server } from '@hapi/hapi'
 import { isEqual } from 'date-fns'
 
 import { PREVIEW_PATH_PREFIX } from '../../../constants.js'
+import { assertFormAvailable } from '../form-availability.js'
 import {
   checkEmailAddressForLiveFormSubmission,
   getCacheService
@@ -52,6 +53,7 @@ export async function getFormModel(
   const formState = resolveState(state)
 
   const metadata = await formsService.getFormMetadata(slug)
+  assertFormAvailable(metadata)
 
   const definition = await formsService.getFormDefinition(
     metadata.id,
@@ -134,6 +136,7 @@ export async function resolveFormModel(
   const { formsService } = services
 
   const metadata = await formsService.getFormMetadata(slug)
+  assertFormAvailable(metadata)
   const formState = resolveState(state)
   const isPreview = options.isPreview ?? isPreviewState(state, options)
   const stateMetadata = metadata[formState]
@@ -145,15 +148,10 @@ export async function resolveFormModel(
   }
 
   // The models cache is created lazily per server instance
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  if (!server.app.models) {
-    server.app.models = new Map<string, { model: FormModel; updatedAt: Date }>()
-  }
 
-  const cache = server.app.models as Map<
-    string,
-    { model: FormModel; updatedAt: Date }
-  >
+  server.app.models ??= new Map<string, { model: FormModel; updatedAt: Date }>()
+
+  const cache = server.app.models
 
   const cacheKey = `${metadata.id}_${formState}_${isPreview}`
   let entry = cache.get(cacheKey)

package/src/server/plugins/engine/components/helpers/geospatial.ts

@@ -116,7 +116,7 @@ export function getGeospatialSchema(country?: GeospatialFieldOptionsCountry) {
       return value
     }
 
-    const result = booleanWithin(value, countryFeature)
+    const result = booleanWithin(value as Geometry | Feature, countryFeature)
 
     if (!result) {
       return helpers.error('any.custom', {

package/src/server/plugins/engine/form-availability.ts

@@ -0,0 +1,31 @@
+import { type FormMetadata } from '@defra/forms-model'
+import Boom from '@hapi/boom'
+
+export interface OfflineBoomData {
+  offline: true
+  metadata: FormMetadata
+}
+
+/**
+ * Throws when the form has been taken offline. The plugin's
+ * unavailable-response extension catches the marker and renders the
+ * "Sorry, this form is unavailable" view at HTTP 200.
+ */
+export function assertFormAvailable(metadata: FormMetadata): void {
+  if (metadata.offline === true) {
+    const data: OfflineBoomData = { offline: true, metadata }
+    throw Boom.boomify(new Error(`Form ${metadata.slug} is offline`), {
+      statusCode: 503,
+      data
+    })
+  }
+}
+
+/** Type guard for the offline Boom marker. */
+export function isOfflineBoom(
+  err: unknown
+): err is Boom.Boom<OfflineBoomData> & { data: OfflineBoomData } {
+  if (!Boom.isBoom(err)) return false
+  const data = err.data as Partial<OfflineBoomData> | null | undefined
+  return data?.offline === true && !!data.metadata
+}

package/src/server/plugins/engine/models/unavailable-view-model.ts

@@ -0,0 +1,36 @@
+import { type FormMetadata } from '@defra/forms-model'
+
+export interface UnavailableViewModel {
+  pageTitle: string
+  formTitle: string
+  organisationName: string
+  phoneLines?: string[]
+}
+
+/**
+ * Defra organisations carry an abbreviation suffix on the enum value, e.g.
+ * "Rural Payments Agency – RPA". The unavailable page reads cleanly without it.
+ */
+function stripOrgSuffix(organisation: string) {
+  return organisation.split(' – ')[0]
+}
+
+function splitPhoneLines(phone: string | undefined) {
+  if (!phone) return undefined
+  const lines = phone
+    .split('\n')
+    .map((line) => line.trim())
+    .filter((line) => line.length > 0)
+  return lines.length > 0 ? lines : undefined
+}
+
+export function unavailableViewModel(
+  metadata: FormMetadata
+): UnavailableViewModel {
+  return {
+    pageTitle: 'Sorry, this form is unavailable',
+    formTitle: metadata.title,
+    organisationName: stripOrgSuffix(metadata.organisation),
+    phoneLines: splitPhoneLines(metadata.contact?.phone)
+  }
+}

package/src/server/plugins/engine/plugin.ts

@@ -15,6 +15,7 @@ import { getRoutes as getQuestionRoutes } from './routes/questions.js'
 import { getRoutes as getRepeaterItemDeleteRoutes } from './routes/repeaters/item-delete.js'
 import { getRoutes as getRepeaterSummaryRoutes } from './routes/repeaters/summary.js'
 import { type PluginOptions } from './types.js'
+import { registerUnavailableResponse } from './unavailable-response.js'
 import { registerVision } from './vision.js'
 import { mapPlugin } from '../map/index.js'
 import { postcodeLookupPlugin } from '../postcode-lookup/index.js'
@@ -129,5 +130,10 @@ export const plugin = {
     ]
 
     server.route(routes as unknown as ServerRoute[]) // TODO
+
+    // Registration order is important: must be registered after the engine's
+    // routes so it sees their responses, but before any global error-page
+    // handler that would re-shape Boom errors.
+    registerUnavailableResponse(server)
   }
 } satisfies Plugin<PluginOptions>

package/src/server/plugins/engine/unavailable-response.ts

@@ -0,0 +1,29 @@
+import { type Request, type ResponseToolkit, type Server } from '@hapi/hapi'
+
+import { isOfflineBoom } from './form-availability.js'
+import { unavailableViewModel } from './models/unavailable-view-model.js'
+
+/**
+ * Registers a server-wide onPreResponse extension that intercepts the offline
+ * Boom thrown and renders the unavailable view.
+ *
+ * Must be registered after the engine's routes so it sees their responses,
+ * but before any global error-page handler that would re-shape Boom errors.
+ */
+export function registerUnavailableResponse(server: Server) {
+  server.ext('onPreResponse', (request: Request, h: ResponseToolkit) => {
+    const response = request.response
+    if (!isOfflineBoom(response)) {
+      return h.continue
+    }
+
+    const { metadata } = response.data
+
+    return h
+      .view('unavailable', unavailableViewModel(metadata))
+      .header('Cache-Control', 'no-store, no-cache, must-revalidate')
+      .header('X-Robots-Tag', 'noindex, nofollow')
+      .code(200)
+      .takeover()
+  })
+}

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

@@ -0,0 +1,20 @@
+{% extends baseLayoutPath %}
+
+{% block content %}
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      <h1 class="govuk-heading-l">Sorry, this form is unavailable</h1>
+      <p class="govuk-body">'{{ formTitle }}' has been archived and is no longer available.</p>
+      <p class="govuk-body">Contact the {{ organisationName }}.</p>
+
+      {% if phoneLines %}
+        <ul class="govuk-list govuk-list--bullet">
+          {% for line in phoneLines %}
+            <li>{{ line }}</li>
+          {% endfor %}
+        </ul>
+        <p class="govuk-body"><a href="https://www.gov.uk/call-charges" class="govuk-link govuk-link--no-visited-state">Find out about call charges</a></p>
+      {% endif %}
+    </div>
+  </div>
+{% endblock %}

package/src/typings/hapi/index.d.ts

@@ -59,7 +59,7 @@ declare module '@hapi/hapi' {
 
   interface ServerApplicationState {
     model?: FormModel
-    models: Map<string, { model: FormModel; updatedAt: Date }>
+    models?: Map<string, { model: FormModel; updatedAt: Date }>
   }
 }