hof 22.7.0-service-paused-beta.6 → 22.7.0-service-paused-beta.8

package/CHANGELOG.md

@@ -1,9 +1,9 @@
 ## 2025-05-14, Version 22.7.0 (Stable), @Rhodine-orleans-lindsay
 ### Added
 - Service paused funtionality that allows for services to redirect to a 'Service Unavailable' when there is a need to pause a service.
-  - Includes service paused component
-  - default service paused html view
-  - Flag to set service paused config to true or false in order to run component
+  - Adds 'service paused' error middleware
+  - Includes default service paused html view
+  - Includes flag to set service paused config to true or false in order to enable page
 ### Security
 - Updates patch and minor dependencies
 

package/README.md

@@ -805,7 +805,7 @@ const pdfData = await pdfModel.save();
 
 # HOF Middleware
 
-A collection of commonly used HOF middleware, exports `cookies`, `notFound`, and `errors` on `middleware`
+A collection of commonly used HOF middleware, exports `cookies`, `notFound`, `servicePaused` and `errors` on `middleware`
 
 ## Arranging the middleware in your app
 
@@ -844,6 +844,26 @@ You can also provide an array of healthcheck URLs with `healthcheckUrls`,
 should you not want to throw a Cookies required error when requesting the app with specific URLs.
 Kubernetes healthcheck URLs are provided as defaults if no overrides are supplied.
 
+## Service Unavailable (Service Paused)
+Allows a service to be paused when required and then resumed. It ensures that anyone using the service  that lands on any part of the form is diverted to a "Service Unavailable" page which will communicate to the user that the service is not available at this time.
+
+### Usage
+- Set the `SERVICE_PAUSED` env to `true` in your service.
+
+### Page Content Customisation
+There is default text for this page. Default text can be overridden by setting the `message` and `answers-saved` properties in the `errors.json` file of the service. Note that information relating to who to contact and alternatives to using the form is optional and so there is no default text for these unless the properties `contact` and `alternative` are set in errors.json:
+
+```json
+{
+  "service-paused" : {
+    "message": "This service will be unavailble for a week.",
+    "answers-saved":  "Your answers have not been saved.",
+    "contact":  "You can contact test@test.com for more information",
+    "alternative": "You can access the www.test.com website instead"
+  }
+}
+```
+
 ## Not found (404)
 
 Expects there to be a view called 404 in your configured `/views` directory

package/frontend/template-partials/views/service-paused.html

@@ -1,9 +1,14 @@
 {{<layout}}
-  {{$header}}
-    {{title}}
-  {{/header}}
+  {{$journeyHeader}}
+    {{#t}}journey.header{{/t}}
+  {{/journeyHeader}}
+
+  {{$propositionHeader}}
+  {{> partials-navigation}}
+  {{/propositionHeader}}
+
   {{$content}}
-   <h1 class="govuk-heading-l">{{{title}}}</h1>
+   <h1 class="govuk-heading-l">{{title}}</h1>
    <p class="govuk-body">{{message}}</p>
    <p class="govuk-body">{{answers-saved}}</p>
    {{#contact}}

package/middleware/service-paused.js

@@ -3,6 +3,7 @@
 const config = require('../config/hof-defaults');
 const getTranslations = translate => {
   const translations = {
+    serviceName: translate('journey.serviceName') || translate('journey.header'),
     title: 'Sorry, this service is unavailable',
     message: 'This service is temporarily unavailable',
     'answers-saved': 'Your answers have not been saved'
@@ -42,6 +43,7 @@ module.exports = options => {
         logger.warn(`Service paused.`);
       }
       res.status(503).render('service-paused', {
+        serviceName: translations.serviceName,
         title: translations.title,
         message: translations.message,
         'answers-saved': translations['answers-saved'],

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hof",
   "description": "A bootstrap for HOF projects",
-  "version": "22.7.0-service-paused-beta.6",
+  "version": "22.7.0-service-paused-beta.8",
   "license": "MIT",
   "main": "index.js",
   "author": "HomeOffice",

package/sandbox/apps/sandbox/translations/en/default.json

@@ -111,6 +111,7 @@
   },
   "journey": {
     "header": "HOF Bootstrap Sandbox Form",
+    "serviceName": "HOF Bootstrap Sandbox Form",
     "confirmation": {
       "details": "Your reference number <br><strong>HDJ2123F</strong>"
     }

package/sandbox/apps/sandbox/translations/src/en/journey.json

@@ -1,5 +1,6 @@
 {
   "header": "HOF Bootstrap Sandbox Form",
+  "serviceName": "HOF Bootstrap Sandbox Form",
   "confirmation": {
     "details": "Your reference number <br><strong>HDJ2123F</strong>"
   }