hof 22.6.0 → 22.7.0-service-paused-beta

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 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
+### Security
+- Updates patch and minor dependencies
+
 ## 2025-05-09, Version 22.6.0 (Stable), @vivekkumar-ho
 ### Changed
 - Support for passing `maxlengthAttribute` property for input-text field. The HTML maxlength attribute is applied when `maxlengthAttribute: true` and the `maxlength` validator are specified in the field config

package/components/index.js

@@ -9,5 +9,6 @@ module.exports = {
   homeOfficeCountries: require('./homeoffice-countries'),
   notify: require('./notify'),
   summary: require('./summary'),
-  sessionTimeoutWarning: require('./session-timeout-warning')
+  sessionTimeoutWarning: require('./session-timeout-warning'),
+  servicePaused: require('./service-paused')
 };

package/components/service-paused/Readme.md

@@ -0,0 +1,26 @@
+# Service Paused Behaviour
+
+## What this does
+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.
+
+## Implementation
+- Add the behaviour to the hof-settings.json file of the service
+- Set the `SERVICE_PAUSED` env to `true`
+
+## 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 pages.json 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 pages.json:
+
+```json
+"message": {
+  "message": "This service will be unavailble for a week."
+},
+"answers-saved": {
+  "message": "Your information has not been saved."
+},
+"contact": {
+  "message": "You can contact test@test.com for more information"
+},
+"alternative": {
+  "message": "You can access the www.test.com website instead"
+},
+```

package/components/service-paused/index.js

@@ -0,0 +1,48 @@
+/**
+ *
+ * @fileOverview
+ * Provides custom behavior for rendering a service down template when a service needs to be temporarily paused. This includes
+ * - Redirecting the user to a 'service down' page 
+ * - Setting custom content and titles on the service down page.
+ *
+ * @module servicePausedBehaviour
+ * @requires ../../config/hof-defaults
+ * @param {Class} superclass - The class to be extended.
+ * @returns {Class} - The extended class with service down handling functionality.
+ */
+
+'use strict';
+
+const config = require('../../config/hof-defaults');
+const logger = require('../../lib/logger')(config);
+
+module.exports = superclass => class extends superclass {
+  getValues(req, res, callback) {
+    return super.getValues(req, res, (err, values) => {
+      if (err) {
+        logger.error(`Error getting values: ${err}`);
+        return callback(err, values);
+      }
+      if (config.servicePaused === true || config.servicePaused === 'true') {
+        logger.info(`Service is paused. Redirecting...`);
+        res.redirect('/service-paused');
+      }
+
+      return callback(null, values);
+    });
+  }
+  locals(req, res) {
+    // set default service unavailable message
+    const superLocals = super.locals(req, res);
+    if (config.servicePaused === true || config.servicePaused === 'true') {
+      superLocals.header = req.translate('pages.service-paused.header');
+      superLocals.title = req.translate('pages.service-paused.title');
+      superLocals.message = req.translate('pages.service-paused.message');
+      superLocals['answers-saved'] = req.translate('pages.service-paused.answers-saved');
+      superLocals.contact = req.translate('pages.service-paused.contact');
+      superLocals.alternative = req.translate('pages.service-paused.alternative');
+      return superLocals;
+    }
+    return superLocals;
+  }
+};

package/config/hof-defaults.js

@@ -51,7 +51,8 @@ const defaults = {
     pdfConverter: process.env.PDF_CONVERTER_URL
   },
   serveStatic: process.env.SERVE_STATIC_FILES !== 'false',
-  sessionTimeOutWarning: process.env.SESSION_TIMEOUT_WARNING || 300
+  sessionTimeOutWarning: process.env.SESSION_TIMEOUT_WARNING || 300,
+  servicePaused: process.env.SERVICE_PAUSED || false
 };
 
 module.exports = Object.assign({}, defaults, rateLimits);

package/frontend/template-partials/translations/src/en/pages.json

@@ -0,0 +1,8 @@
+{
+  "service-paused": {
+    "title": "Sorry, the service is unavailable",
+    "header": "Sorry, the service is unavailable",
+    "message": "This service is temporarily unavailable",
+    "answers-saved": "Your answers have not been saved"
+  }
+}

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

@@ -0,0 +1,24 @@
+{{<layout}}
+  {{$journeyHeader}}
+    {{#t}}journey.header{{/t}}
+  {{/journeyHeader}}
+
+  {{$propositionHeader}}
+  {{> partials-navigation}}
+  {{/propositionHeader}}
+
+  {{$header}}
+    {{header}}
+  {{/header}}
+
+  {{$content}}
+   <p>{{message}}</p>
+   <p>{{answers-saved}}</p>
+   {{#contact}}
+   <p>{{contact}}</p>
+   {{/contact}}
+   {{#alternative}}
+   <p>{{alternative}}</p>
+   {{/alternative}}
+  {{/content}}
+{{/layout}}

package/index.js

@@ -231,6 +231,13 @@ function bootstrap(options) {
   // Set up routing so <YOUR-SITE-URL>/assets are served from /node_modules/govuk-frontend/govuk/assets
   app.use('/assets', express.static(path.join(__dirname, '/node_modules/govuk-frontend/govuk/assets')));
 
+  if (config.servicePaused === true || config.servicePaused === 'true') {
+    app.use('/service-paused', (req, res) => {
+      const locals = Object.assign({}, req.translate('pages.service-paused'));
+      res.render('service-paused', locals);
+    });
+  }
+
   if (config.getAccessibility === true) {
     deprecate(
       '`getAccessibility` option is deprecated and may be removed in future versions.',

package/package.json

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

package/sandbox/server.js

@@ -9,7 +9,8 @@ bootstrap({
     require('./apps/sandbox')
   ],
   behaviours: [
-    require('../').components.sessionTimeoutWarning
+    require('../').components.sessionTimeoutWarning,
+    require('../').components.servicePaused,
   ],
   rateLimits: {
     requests: {