@defra/forms-engine-plugin 4.11.3 → 4.13.0

package/src/server/plugins/engine/pageControllers/SummaryPageController.ts

@@ -433,7 +433,8 @@ export async function submitForm(
 
   const items = getFormSubmissionData(
     summaryViewModel.context,
-    summaryViewModel.details
+    summaryViewModel.details,
+    model
   )
 
   try {
@@ -531,11 +532,14 @@ function submitData(
     main: buildMainRecords(items),
     repeaters: buildRepeaterRecords(items)
   }
-
   return submit(payload)
 }
 
-export function getFormSubmissionData(context: FormContext, details: Detail[]) {
+export function getFormSubmissionData(
+  context: FormContext,
+  details: Detail[],
+  model: FormModel
+) {
   const items = context.relevantPages
     .map(({ href }) =>
       details.flatMap(({ items }) =>
@@ -544,7 +548,7 @@ export function getFormSubmissionData(context: FormContext, details: Detail[]) {
     )
     .flat()
 
-  const paymentItems = getPaymentFieldItems(context)
+  const paymentItems = getPaymentFieldItems(context, model)
 
   return [...items, ...paymentItems]
 }
@@ -553,10 +557,13 @@ export function getFormSubmissionData(context: FormContext, details: Detail[]) {
  * Gets DetailItems for PaymentField components
  * PaymentField is excluded from summaryDetails for UI but needs to be in submission data
  */
-function getPaymentFieldItems(context: FormContext): DetailItemField[] {
+function getPaymentFieldItems(
+  context: FormContext,
+  model: FormModel
+): DetailItemField[] {
   const items: DetailItemField[] = []
 
-  for (const page of context.relevantPages) {
+  for (const page of model.pages) {
     for (const field of page.collection.fields) {
       if (field instanceof PaymentField) {
         items.push({

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/routes/questions.ts

@@ -59,7 +59,11 @@ async function handleHttpEvent(
   // TODO: Update structured data POST payload with when helper
   // is updated to removing the dependency on `SummaryViewModel` etc.
   const viewModel = new SummaryViewModel(request, page, context)
-  const items = getFormSubmissionData(viewModel.context, viewModel.details)
+  const items = getFormSubmissionData(
+    viewModel.context,
+    viewModel.details,
+    model
+  )
 
   // @ts-expect-error - function signature will be refactored in the next iteration of the formatter
   const payload = format(context, items, model, undefined, undefined)

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/file-upload.html

@@ -16,7 +16,8 @@
       {{ govukButton({
         text: "Upload file",
         classes: "govuk-button--secondary upload-file-button",
-        preventDoubleClick: true
+        preventDoubleClick: true,
+        disabled: context.isForceAccess
       }) }}
     {% else %}
       {{ govukWarningText({

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 }>
   }
 }