hof 22.7.0-service-paused-beta.3 → 22.7.0-service-paused-beta.5

package/components/service-paused/index.js

@@ -1,47 +1,47 @@
-/**
- *
- * @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.
- */
+// /**
+//  *
+//  * @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';
+// 'use strict';
 
-const config = require('../../config/hof-defaults');
-const logger = require('../../lib/logger')(config);
+// 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...`);
-        return 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;
-  }
-};
+// 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...`);
+//         return 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/frontend/template-partials/translations/src/en/errors.json

@@ -26,5 +26,10 @@
     "message": "You have submitted too many applications in a short space of time.",
     "pre-time-to-wait": "Please try again in ",
     "post-time-to-wait": " minutes."
-  }
+  },
+  "service-paused": {
+    "title": "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

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

package/index.js

@@ -51,6 +51,12 @@ const loadRoutes = (app, config) => {
 };
 
 const applyErrorMiddlewares = (app, config) => {
+  if (config.servicePaused === true || config.servicePaused === 'true') {
+    app.use(hofMiddleware.servicePaused({
+      logger: config.logger
+    }));
+  }
+  
   app.use(hofMiddleware.notFound({
     logger: config.logger
   }));
@@ -155,6 +161,7 @@ function bootstrap(options) {
     res.locals.sessionTimeoutWarningContent = config.sessionTimeoutWarningContent;
     res.locals.exitFormContent = config.exitFormContent;
     res.locals.saveExitFormContent = config.saveExitFormContent;
+    res.locals.servicePaused = config.servicePaused;
     next();
   });
 
@@ -231,12 +238,16 @@ 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')));
 
+  // Check if service has been paused and redirect accordingly
   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);
+    app.use((req, res, next) => {
+      if (req.path !== '/service-paused') {
+        return res.redirect('/service-paused');
+      }
+      next();
     });
-  }
+  };
+
 
   if (config.getAccessibility === true) {
     deprecate(

package/middleware/errors.js

@@ -2,6 +2,7 @@
 'use strict';
 
 const rateLimitsConfig = require('../config/rate-limits');
+const hofDefaultsConfig = require('../config/hof-defaults');
 
 const errorTitle = code => `${code}_ERROR`;
 const errorMsg = code => `There is a ${code}_ERROR`;
@@ -55,6 +56,21 @@ const getContent = (err, translate) => {
     content.postTimeToWait = (translate && translate('errors.submission-rate-limit.post-time-to-wait'));
   }
 
+  // if (hofDefaultsConfig.servicePaused === true || hofDefaultsConfig.servicePaused === 'true') {
+  //   console.log('hello')
+  // // if(err.code === 'SERVICE_PAUSED'){
+  //   err.status = 503;
+  //   err.template = 'service-paused';
+  //   err.title = (translate && translate('errors.service-paused.title'));
+  //   err.message = (translate && translate('errors.service-paused.message'));
+  //   err['answers-saved'] = (translate && translate('errors.service-paused.answers-saved'));
+  //   err.contact = (translate && translate('errors.service-paused.contact'));
+  //   content.title = (translate && translate('errors.service-paused.title'));
+  //   content.message = (translate && translate('errors.service-paused.message'));
+  //   content['answers-saved'] = (translate && translate('errors.service-paused.answers-saved'));
+  //   content.contact = (translate && translate('errors.service-paused.contact'));
+  // }
+
   err.code = err.code || 'UNKNOWN';
   err.status = err.status || 500;
 

package/middleware/index.js

@@ -5,5 +5,6 @@ module.exports = {
   errors: require('./errors'),
   notFound: require('./not-found'),
   deepTranslate: require('./deep-translate'),
-  rateLimiter: require('./rate-limiter')
+  rateLimiter: require('./rate-limiter'),
+  servicePaused: require('./service-paused')
 };

package/middleware/service-paused.js

@@ -0,0 +1,53 @@
+'use strict';
+
+const config = require('../config/hof-defaults');
+const getTranslations = translate => {
+  const translations = {
+    title: 'Sorry, this service is unavailable',
+    message: 'This service is temporarily unavailable',
+    'answers-saved': 'Your answers have not been saved'
+  };
+
+  if (translate) {
+    const contact = translate('errors.service-paused.contact');
+    const alternative = translate('errors.service-paused.alternative');
+
+    translations.title = translate('errors.service-paused.title');
+    translations.message = translate('errors.service-paused.message');
+    translations['answers-saved'] = translate('errors.service-paused.answers-saved');
+
+    // Only render contact and alternative information if the key has a value set
+    if (contact === 'errors.service-paused.contact') {
+      translations.contact = ''
+    } else {
+      translations.contact = translate('errors.service-paused.contact');
+    }
+    if (alternative === 'errors.service-paused.alternative') {
+      translations.alternative = ''
+    } else {
+      translations.alternative = translate('errors.service-paused.alternative');
+    }
+  }
+  return translations;
+};
+
+module.exports = options => {
+  const opts = options || {};
+  const logger = opts.logger;
+
+  return (req, res) => {
+    const translate = opts.translate || req.translate;
+    const translations = getTranslations(translate);
+      if (logger && logger.warn) {
+        logger.warn(`Cannot find: ${req.url}`);
+      }
+      res.status(503).render('service-paused', {
+        title: translations.title,
+        message: translations.message,
+        'answers-saved': translations['answers-saved'],
+        contact: translations.contact,
+        alternative: translations.alternative
+      });
+  };
+};
+

package/package.json

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

package/sandbox/.env

@@ -1 +1 @@
-SERVICE_DOWN=true
+SERVICE_PAUSED=true

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

@@ -1,4 +1,9 @@
 {
+  "errors": {
+    "service-paused": {
+      "contact": "You can email for more information"
+    }
+  },
   "exit": {
     "header": "You have left this form",
     "title": "You have left this form"

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

@@ -0,0 +1,5 @@
+{
+  "service-paused": {
+    "contact": "You can email for more information"
+  }
+}

package/sandbox/package.json

@@ -8,7 +8,7 @@
   },
   "scripts": {
     "start": "node server.js",
-    "start:dev": "HOF_SANDBOX=true ../bin/hof-build watch",
+    "start:dev": "HOF_SANDBOX=true ../bin/hof-build watch --env",
     "dev": "yarn && GA_TAG=test nodemon server",
     "build": "HOF_SANDBOX=true ../bin/hof-build",
     "postinstall": "yarn run build"

package/sandbox/server.js

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