Merge pull request #1754 from companieshouse/feat/cc-3051/redirecting-from-to-the-interrupt-page-with-entity-ids

feat/cc 3051/redirecting from to the interrupt page with entity ids when ROE flag is Set

Author: knite51

src/controllers/update/overseas.entity.query.controller.ts

@@ -11,7 +11,7 @@ import { mapCompanyProfileToOverseasEntity } from "../../utils/update/company.pr
 import { mapInputDate } from "../../utils/update/mapper.utils";
 import { CompanyProfile } from "@companieshouse/api-sdk-node/dist/services/company-profile/types";
 import { retrieveBoAndMoData } from "../../utils/update/beneficial_owners_managing_officers_data_fetch";
-import { isRemoveJourney } from "../../utils/url";
+import { getBackLinkUrl, isRemoveJourney } from "../../utils/url";
 
 export const get = async (req: Request, res: Response, next: NextFunction) => {
   try {
@@ -29,8 +29,14 @@ export const get = async (req: Request, res: Response, next: NextFunction) => {
       });
     }
 
+    const backLinkUrl = getBackLinkUrl({
+      req,
+      urlWithEntityIds: config.UPDATE_INTERRUPT_CARD_WITH_PARAMS_URL,
+      urlWithoutEntityIds: config.UPDATE_INTERRUPT_CARD_URL,
+    });
+
     return res.render(config.OVERSEAS_ENTITY_QUERY_PAGE, {
-      backLinkUrl: config.UPDATE_INTERRUPT_CARD_URL,
+      backLinkUrl,
       templateName: config.OVERSEAS_ENTITY_QUERY_PAGE,
       chsUrl: process.env.CHS_URL,
       [EntityNumberKey]: appData[EntityNumberKey]

src/controllers/update/update.interrupt.card.controller.ts

@@ -1,11 +1,9 @@
 import { NextFunction, Request, Response } from "express";
-import { logger } from "../../utils/logger";
 import * as config from "../../config";
-import { isActiveFeature } from "../../utils/feature.flag";
+import { logger } from "../../utils/logger";
 import {
-  isRemoveJourney,
-  getUrlWithTransactionIdAndSubmissionId,
-  getTransactionIdAndSubmissionIdFromOriginalUrl,
+  getBackLinkUrl,
+  isRemoveJourney
 } from "../../utils/url";
 
 export const get = async (req: Request, res: Response, next: NextFunction) => {
@@ -23,8 +21,14 @@ export const get = async (req: Request, res: Response, next: NextFunction) => {
       });
     }
 
+    const backLinkUrl = getBackLinkUrl({
+      req,
+      urlWithEntityIds: config.SECURE_UPDATE_FILTER_WITH_PARAMS_URL,
+      urlWithoutEntityIds: config.SECURE_UPDATE_FILTER_URL,
+    });
+
     return res.render(config.UPDATE_INTERRUPT_CARD_PAGE, {
-      backLinkUrl: getBackLinkUrl(req),
+      backLinkUrl,
       templateName: config.UPDATE_INTERRUPT_CARD_PAGE,
     });
   } catch (error) {
@@ -49,23 +53,3 @@ export const post = async (req: Request, res: Response, next: NextFunction) => {
     next(error);
   }
 };
-
-const getBackLinkUrl = (req: Request) => {
-
-  try {
-
-    const ids = getTransactionIdAndSubmissionIdFromOriginalUrl(req);
-
-    if (!isActiveFeature(config.FEATURE_FLAG_ENABLE_REDIS_REMOVAL) || (typeof ids === "undefined")) {
-      return config.SECURE_UPDATE_FILTER_URL;
-    }
-    return getUrlWithTransactionIdAndSubmissionId(
-      config.SECURE_UPDATE_FILTER_WITH_PARAMS_URL,
-      ids[config.ROUTE_PARAM_TRANSACTION_ID],
-      ids[config.ROUTE_PARAM_SUBMISSION_ID]
-    );
-  } catch (error) {
-    logger.errorRequest(req, error);
-    return config.SECURE_UPDATE_FILTER_URL;
-  }
-};

src/utils/url.ts

@@ -5,12 +5,43 @@ import { getApplicationData } from "./application.data";
 import { Session } from "@companieshouse/node-session-handler";
 import { IsRemoveKey } from "../model/data.types.model";
 import { createAndLogErrorRequest, logger } from "./logger";
+import { isActiveFeature } from "./feature.flag";
 
+interface BackLinkUrlDependencies {
+ req: Request;
+ urlWithEntityIds: string;
+ urlWithoutEntityIds: string;
+}
 export interface TransactionIdAndSubmissionId {
   transactionId: string;
   submissionId: string;
 }
 
+export const getBackLinkUrl = ({
+  req,
+  urlWithEntityIds,
+  urlWithoutEntityIds,
+}: BackLinkUrlDependencies): string => {
+  try {
+    const ids = getTransactionIdAndSubmissionIdFromOriginalUrl(req);
+
+    if (
+      !isActiveFeature(config.FEATURE_FLAG_ENABLE_REDIS_REMOVAL) ||
+      typeof ids === "undefined"
+    ) {
+      return urlWithoutEntityIds;
+    }
+    return getUrlWithTransactionIdAndSubmissionId(
+      urlWithEntityIds,
+      ids[config.ROUTE_PARAM_TRANSACTION_ID],
+      ids[config.ROUTE_PARAM_SUBMISSION_ID]
+    );
+  } catch (error) {
+    logger.errorRequest(req, error);
+    return urlWithoutEntityIds;
+  }
+};
+
 export const getUrlWithTransactionIdAndSubmissionId = (url: string, transactionId: string, submissionId: string): string => {
   url = url
     .replace(`:${config.ROUTE_PARAM_TRANSACTION_ID}`, transactionId)

test/utils/url.spec.ts

@@ -2,13 +2,15 @@ import { expect, jest } from "@jest/globals";
 
 jest.mock('../../src/utils/application.data');
 jest.mock("../../src/utils/logger");
+jest.mock("../../src/utils/feature.flag");
 
 import { Request, request } from "express";
 import * as config from "../../src/config";
 import * as urlUtils from "../../src/utils/url";
 import { getApplicationData } from '../../src/utils/application.data';
 import { APPLICATION_DATA_MOCK } from "../__mocks__/session.mock";
 import { createAndLogErrorRequest, logger } from "../../src/utils/logger";
+import { isActiveFeature } from "../../src/utils/feature.flag";
 
 const mockGetApplicationData = getApplicationData as jest.Mock;
 const mockCreateAndLogErrorRequest = createAndLogErrorRequest as jest.Mock;
@@ -391,4 +393,52 @@ describe("Url utils tests", () => {
       expect(previousPage).toBeUndefined();
     });
   });
+
+  describe("getBackLinkUrl tests", () => {
+    const urlWithEntityIds = "/transaction/:transactionId/submission/:submissionId/entity";
+    const urlWithoutEntityIds = "/entity";
+    const transactionId = "tx123";
+    const submissionId = "sub456";
+    const mockIsActiveFeature = isActiveFeature as jest.Mock;
+
+    beforeEach(() => {
+      jest.spyOn(urlUtils, "getTransactionIdAndSubmissionIdFromOriginalUrl").mockImplementation(() => ({
+        transactionId,
+        submissionId
+      }));
+      jest.spyOn(urlUtils, "getUrlWithTransactionIdAndSubmissionId").mockImplementation((url, tId, sId) => {
+        return url.replace(":transactionId", tId).replace(":submissionId", sId);
+      });
+      jest.clearAllMocks();
+    });
+
+    test("returns url with entity ids when feature flag is enabled and ids are present", () => {
+      mockIsActiveFeature.mockReturnValueOnce(true);
+      const req = { originalUrl: "/transaction/tx123/submission/sub456", params: {}, query: {} } as unknown as Request;
+      const result = urlUtils.getBackLinkUrl({ req, urlWithEntityIds, urlWithoutEntityIds });
+      expect(result).toBe("/transaction/tx123/submission/sub456/entity");
+    });
+
+    test("returns urlWithoutEntityIds when feature flag is disabled", () => {
+      mockIsActiveFeature.mockReturnValueOnce(false);
+      const req = { originalUrl: "/transaction/tx123/submission/sub456", params: {}, query: {} } as unknown as Request;
+      const result = urlUtils.getBackLinkUrl({ req, urlWithEntityIds, urlWithoutEntityIds });
+      expect(result).toBe(urlWithoutEntityIds);
+    });
+
+    test("returns urlWithoutEntityIds when ids are undefined", () => {
+      jest.spyOn(urlUtils, "getTransactionIdAndSubmissionIdFromOriginalUrl").mockReturnValue(undefined);
+      const req = { originalUrl: "/no-ids-here", params: {}, query: {} } as unknown as Request;
+      const result = urlUtils.getBackLinkUrl({ req, urlWithEntityIds, urlWithoutEntityIds });
+      expect(result).toBe(urlWithoutEntityIds);
+    });
+
+    test("returns urlWithoutEntityIds and logs error if exception is thrown", () => {
+      jest.spyOn(urlUtils, "getTransactionIdAndSubmissionIdFromOriginalUrl").mockImplementation(() => { throw new Error("fail"); });
+      const req = { originalUrl: "/fail", params: {}, query: {} } as unknown as Request;
+      const result = urlUtils.getBackLinkUrl({ req, urlWithEntityIds, urlWithoutEntityIds });
+      expect(result).toBe(urlWithoutEntityIds);
+      expect(logger.errorRequest).toHaveBeenCalled();
+    });
+  });
 });