# This is a combination of 5 commits.

# This is the 1st commit message: pcq-1760 adding return to service path # This is the commit message #2: PCQ-1760 end page test # This is the commit message #3: PCQ-1760 end page test # This is the commit message #4: PCQ-1760 test and lint # This is the commit message #5: PCQ-1760 config semi
hmcts · Jul 2, 2024 · 1f783e3 · 1f783e3
1 parent f68539e
commit 1f783e3
Show file tree

Hide file tree

Showing 10 changed files with 131 additions and 63 deletions.
diff --git a/app/components/app-insights.js b/app/components/app-insights.js
@@ -37,10 +37,10 @@ exports.initAppInsights = function initAppInsights() {
             fs.mkdirSync(tempDir);
         }
     }
-}
+};
 
 exports.trackTrace = function trackTrace(trace){
     if(instrumentationKey && client){
         client.trackTrace(trace);
     }
-}
+};
diff --git a/app/middleware/optOut.js b/app/middleware/optOut.js
@@ -4,6 +4,7 @@ const config = require('config');
 const ServiceMapper = require('app/utils/ServiceMapper');
 const moment = require('moment');
 const appInsights = require('app/components/app-insights');
+const validateUrl = require('app/middleware/validateUrl');
 
 const setOptOut = (req, res) => {
     const token = req.session.token;
@@ -27,7 +28,7 @@ const setOptOut = (req, res) => {
             req.log.error(err);
         })
         .finally(() => {
-            res.redirect(validUrl(req))
+            res.redirect(validateUrl(req));
         });
 };
 
@@ -38,20 +39,8 @@ const optOut = (req, res) => {
     if (!('optOut' in form)) {
         return setOptOut(req, res);
     }
-    res.redirect(validUrl(req));
+    res.redirect(validateUrl(req));
 
 };
 
-const validUrl = (req) => {
-    const redirect = req.session.returnUrl || '/offline';
-    let givenUrl ;
-    try {
-        givenUrl = new URL (redirect);
-    } catch (error) {
-        req.log.error(error);
-        givenUrl = '/offline';
-    }
-    return givenUrl;
-};
-
 module.exports = optOut;
diff --git a/app/middleware/returnToService.js b/app/middleware/returnToService.js
@@ -0,0 +1,11 @@
+'use strict';
+
+const validateUrl = require('app/middleware/validateUrl');
+const appInsights = require('app/components/app-insights');
+
+const returnToService = (req, res) => {
+    appInsights.trackTrace({message: 'Returning to primary service', properties: {['ServiceId']:req.session.form.serviceId}});
+    res.redirect(validateUrl(req));
+};
+
+module.exports = returnToService;
diff --git a/app/middleware/validateUrl.js b/app/middleware/validateUrl.js
@@ -0,0 +1,15 @@
+'use strict';
+
+const validateUrl = (req) => {
+    const redirect = req.session.returnUrl || '/offline';
+    let givenUrl ;
+    try {
+        givenUrl = new URL (redirect);
+    } catch (error) {
+        req.log.error(error);
+        givenUrl = '/offline';
+    }
+    return givenUrl;
+};
+
+module.exports = validateUrl;
diff --git a/app/routes.js b/app/routes.js
@@ -9,6 +9,7 @@ const initSession = require('app/middleware/initSession');
 const registerIncomingService = require('app/registerIncomingService');
 const validateParams = require('app/middleware/validateParams');
 const optOut = require('app/middleware/optOut');
+const returnToService = require('app/middleware/returnToService');
 const featureToggle = new (require('app/utils/FeatureToggle'))();
 
 router.use(initSession);
@@ -30,6 +31,8 @@ router.get('/', (req, res) => {
 
 router.post('/opt-out', optOut);
 
+router.get('/return-to-service', returnToService);
+
 const allSteps = {
     'en': initSteps([`${__dirname}/steps/ui`], 'en'),
     'cy': initSteps([`${__dirname}/steps/ui`], 'cy')

diff --git a/app/steps/ui/endpage/template.html b/app/steps/ui/endpage/template.html
@@ -22,7 +22,7 @@
         {% if fields.returnUrl.value %}
             {{ govukButton({
                 text: common.continueToNextSteps | safe,
-                href: fields.returnUrl.value
+                href: "/return-to-service"
             }) }}
         {% endif %}
     </div>

diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -1,36 +1,43 @@
-import js from "@eslint/js";
-import globals from "globals";
+import js from '@eslint/js';
+import globals from 'globals';
 
 const config = {
 
-    languageOptions: {
-        ecmaVersion: 2020,
-        sourceType: 'module',
-        globals: {
-            ...globals.browser,
-            ...globals.mocha,
-            ...globals.node,
-            'actor': true,
-            'Feature': true,
-            'Scenario': true,
-            'codecept_helper': true
-        }
+  languageOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    globals: {
+      ...globals.browser,
+      ...globals.mocha,
+      ...globals.node,
+      'actor': true,
+      'Feature': true,
+      'Scenario': true,
+      'codecept_helper': true,
     },
+  },
+
+  rules: {
+    ...js.configs.recommended.rules,
+    'linebreak-style': ['error', 'unix'],
+    quotes: ['error', 'single'],
+    semi: ['error', 'always'],
+    'no-unused-vars': 0,
+  },
 };
 
 export default [
-    js.configs.recommended,
-    config,
-    {
-        ignores: [
-            'govuk/*',
-            'public/*',
-            'app/assets/javascripts/*.js',
-            'coverage',
-            'functional-output/*',
-            '.pnp.cjs',
-            '.pnp.loader.mjs',
-            '.stryker-tmp'
-        ]
-    }
+  config,
+  {
+    ignores: [
+      'govuk/*',
+      'public/*',
+      'app/assets/javascripts/*.js',
+      'coverage',
+      'functional-output/*',
+      '.pnp.cjs',
+      '.pnp.loader.mjs',
+      '.stryker-tmp',
+    ],
+  },
 ];
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "protected-characteristics-frontend",
   "description": "Protected Characteristics web app",
-  "version": "1.2.176",
+  "version": "1.2.177",
   "license": "MIT",
   "engines": {
     "node": ">=14.18.1"

diff --git a/test/component/testEndPage.js b/test/component/testEndPage.js
@@ -17,22 +17,5 @@ describe('EndPage', () => {
         it('test content loaded on the page', (done) => {
             testWrapper.testContent(done);
         });
-
-        it('test link to return URL is present', (done) => {
-            const sessionData = {
-                validParameters: true,
-                returnUrl: 'http://invoking-service-return-url'
-            };
-
-            testWrapper.agent.post('/prepare-session-field')
-                .send(sessionData)
-                .end(() => {
-                    const playbackData = {
-                        returnUrl: 'http://invoking-service-return-url'
-                    };
-
-                    testWrapper.testDataPlayback(done, playbackData);
-                });
-        });
     });
 });
diff --git a/test/unit/middleware/testReturnToService.js b/test/unit/middleware/testReturnToService.js
@@ -0,0 +1,60 @@
+'use strict';
+
+const expect = require('chai').expect;
+const nock = require('nock');
+const sinon = require('sinon');
+const returnToService = require('app/middleware/returnToService');
+
+describe('returnToService', () => {
+    let req = {};
+    let res = {};
+
+    describe('redirect', () => {
+
+        beforeEach(() => {
+            req = {
+                session: {
+                    form: {
+                        serviceId: 'test'
+                    }
+                }
+            };
+            res = {redirect: sinon.spy()};
+        });
+
+        it('should redirect to the given return URL', () => {
+            nock('http://localhost:4550')
+                .get('/return-to-service')
+                .reply(
+                    200,
+                    {status: ':thumbs_up:'}
+                );
+
+            req.session.returnUrl = 'http://test.com';
+            returnToService(req,res);
+
+            expect(res.redirect.calledOnce).to.equal(true);
+            expect(res.redirect.args[0][0].href).to.equal('http://test.com/');
+            nock.cleanAll();
+
+        });
+
+        it('should redirect to offline if URL not valid', () => {
+            nock('http://localhost:4550')
+                .get('/return-to-service')
+                .reply(
+                    200,
+                    {status: ':thumbs_up:'}
+                );
+
+            req.session.returnUrl = 'http:/[/]test.com';
+            req.log = sinon.spy();
+            req.log.error = sinon.spy();
+
+            returnToService(req, res);
+            expect(res.redirect.calledOnce).to.equal(true);
+            expect(res.redirect.args[0][0]).to.equal('/offline');
+            nock.cleanAll();
+        });
+    });
+});