AUT-4297: Add mobile channel

Accept 'mobile' as a valid channel on the FE and render the same mobile
pages as the strategic app when res.locals.mobileChannel is true.

Author: alhcomer

src/app.constants.ts

@@ -244,6 +244,7 @@ export enum JOURNEY_TYPE {
 export enum CHANNEL {
   WEB = "web",
   STRATEGIC_APP = "strategic_app",
+  MOBILE = "mobile",
 }
 
 export const ENVIRONMENT_NAME = {

src/components/account-not-found/account-not-found-controller.ts

@@ -17,7 +17,7 @@ export function accountNotFoundGet(req: Request, res: Response): void {
   const template: string = getAccountNotFoundTemplate(
     clientIsOneLogin(req),
     req.session.client.serviceType,
-    res.locals.strategicAppChannel
+    res.locals.strategicAppChannel || res.locals.mobileChannel
   );
 
   res.render(template, {

src/components/account-not-found/get-account-not-found-template.ts

@@ -6,7 +6,7 @@ import { getChannelSpecificTemplate } from "../../utils/get-channel-specific-tem
 export function getAccountNotFoundTemplate(
   isOneLoginService: boolean,
   serviceType: string,
-  isStrategicAppChannel: boolean
+  isMobileOrStrategicAppChannel: boolean
 ): string {
   let webTemplate;
 
@@ -20,7 +20,7 @@ export function getAccountNotFoundTemplate(
 
   return getChannelSpecificTemplate(
     webTemplate,
-    isStrategicAppChannel,
+    isMobileOrStrategicAppChannel,
     WEB_TO_MOBILE_TEMPLATE_MAPPINGS
   );
 }

src/components/account-not-found/tests/account-not-found-controller.test.ts

@@ -25,7 +25,7 @@ describe("account not found controller", () => {
   });
 
   describe("accountNotFoundGet", () => {
-    describe("when strategicAppChannel is not defined", () => {
+    describe("when strategicAppChannel or mobileChannel is not defined", () => {
       it("should render the account not found mandatory view when serviceType undefined", () => {
         accountNotFoundGet(req, res);
 
@@ -53,9 +53,10 @@ describe("account not found controller", () => {
       });
     });
 
-    describe("when strategicAppChannel is false", () => {
+    describe("when strategicAppChannel and mobileChannel are false", () => {
       beforeEach(() => {
         res.locals.strategicAppChannel = false;
+        res.locals.mobileChannel = false;
       });
 
       it("should render the account not found mandatory view when serviceType undefined", () => {
@@ -85,35 +86,47 @@ describe("account not found controller", () => {
       });
     });
 
-    describe("when strategicAppChannel is true", () => {
-      beforeEach(() => {
-        res.locals.strategicAppChannel = true;
-      });
+    describe("when strategicAppChannel or mobileChannel are true", () => {
+      const testCases = [
+        { strategicAppChannel: true, mobileChannel: false },
+        { strategicAppChannel: false, mobileChannel: true },
+      ];
 
-      it("should render the account not found mandatory view when serviceType undefined", () => {
-        accountNotFoundGet(req, res);
+      testCases.forEach((testCase) => {
+        it("should render the account not found mandatory view when serviceType undefined", () => {
+          res.locals.strategicAppChannel = testCase.strategicAppChannel;
+          res.locals.mobileChannel = testCase.mobileChannel;
 
-        expect(res.render).to.have.calledWith(
-          "account-not-found/index-mobile.njk"
-        );
-      });
+          accountNotFoundGet(req, res);
 
-      it("should render the account not found optional view when serviceType optional", () => {
-        req.session.client.serviceType = SERVICE_TYPE.OPTIONAL;
-        accountNotFoundGet(req, res);
+          expect(res.render).to.have.calledWith(
+            "account-not-found/index-mobile.njk"
+          );
+        });
 
-        expect(res.render).to.have.calledWith(
-          "account-not-found/index-mobile.njk"
-        );
-      });
+        it("should render the account not found optional view when serviceType optional", () => {
+          req.session.client.serviceType = SERVICE_TYPE.OPTIONAL;
+          res.locals.strategicAppChannel = testCase.strategicAppChannel;
+          res.locals.mobileChannel = testCase.mobileChannel;
 
-      it("should render the account not found optional view when the service is part of One Login", () => {
-        req.session.client.isOneLoginService = true;
-        accountNotFoundGet(req, res);
+          accountNotFoundGet(req, res);
 
-        expect(res.render).to.have.calledWith(
-          "account-not-found/index-mobile.njk"
-        );
+          expect(res.render).to.have.calledWith(
+            "account-not-found/index-mobile.njk"
+          );
+        });
+
+        it("should render the account not found optional view when the service is part of One Login", () => {
+          req.session.client.isOneLoginService = true;
+          res.locals.strategicAppChannel = testCase.strategicAppChannel;
+          res.locals.mobileChannel = testCase.mobileChannel;
+
+          accountNotFoundGet(req, res);
+
+          expect(res.render).to.have.calledWith(
+            "account-not-found/index-mobile.njk"
+          );
+        });
       });
     });
   });

src/components/sign-in-or-create/sign-in-or-create-controller.ts

@@ -16,7 +16,7 @@ export async function signInOrCreateGet(
 
   const template = getChannelSpecificTemplate(
     "sign-in-or-create/index.njk",
-    res.locals.strategicAppChannel,
+    res.locals.strategicAppChannel || res.locals.mobileChannel,
     WEB_TO_MOBILE_TEMPLATE_MAPPINGS
   );
 

src/components/sign-in-or-create/tests/sign-in-or-create-controller.test.ts

@@ -33,17 +33,26 @@ describe("sign in or create controller", () => {
     });
 
     describe("where the context is mobile", () => {
-      it("should render the mobile template", async () => {
-        res.locals.strategicAppChannel = true;
+      const testCases = [
+        { strategicAppChannel: true, mobileChannel: false },
+        { strategicAppChannel: false, mobileChannel: true },
+      ];
 
-        signInOrCreateGet(req as Request, res as Response);
+      testCases.forEach((testCase) => {
+        it("should render the mobile template", async () => {
+          res.locals.strategicAppChannel = testCase.strategicAppChannel;
+          res.locals.mobileChannel = testCase.mobileChannel;
 
-        expect(res.render).to.have.calledWith(
-          "sign-in-or-create/index-mobile.njk"
-        );
+          signInOrCreateGet(req as Request, res as Response);
+
+          expect(res.render).to.have.calledWith(
+            "sign-in-or-create/index-mobile.njk"
+          );
+        });
       });
     });
   });
+
   describe("signInOrCreatePost", () => {
     it("should redirect to enter email new create account", async () => {
       req.body.optionSelected = "create";

src/config.ts

@@ -176,7 +176,11 @@ export function supportHttpKeepAlive(): boolean {
 }
 
 export function isValidChannel(channel: string): boolean {
-  return channel === CHANNEL.WEB || channel === CHANNEL.STRATEGIC_APP;
+  return (
+    channel === CHANNEL.WEB ||
+    channel === CHANNEL.STRATEGIC_APP ||
+    channel === CHANNEL.MOBILE
+  );
 }
 
 export function showTestBanner(): boolean {

src/middleware/channel-middleware.ts

@@ -19,4 +19,5 @@ export function channelMiddleware(
 function setChannelFlags(res: Response, channel?: string): void {
   res.locals.strategicAppChannel = channel === CHANNEL.STRATEGIC_APP;
   res.locals.webChannel = channel === CHANNEL.WEB;
+  res.locals.mobileChannel = channel === CHANNEL.MOBILE;
 }

src/middleware/tests/channel-middleware.test.ts

@@ -26,6 +26,7 @@ describe("session-middleware", () => {
 
       expect(res.locals.strategicAppChannel).to.equal(true);
       expect(res.locals.webChannel).to.equal(false);
+      expect(res.locals.mobileChannel).to.equal(false);
       expect(next).to.be.calledOnce;
     });
 
@@ -37,6 +38,19 @@ describe("session-middleware", () => {
 
       expect(res.locals.strategicAppChannel).to.equal(false);
       expect(res.locals.webChannel).to.equal(true);
+      expect(res.locals.mobileChannel).to.equal(false);
+      expect(next).to.be.calledOnce;
+    });
+
+    it("should set mobile to true for mobile clients", () => {
+      const req = mockRequest({
+        session: { client: {}, user: { channel: "mobile" } },
+      });
+      channelMiddleware(req as Request, res as Response, next);
+
+      expect(res.locals.strategicAppChannel).to.equal(false);
+      expect(res.locals.webChannel).to.equal(false);
+      expect(res.locals.mobileChannel).to.equal(true);
       expect(next).to.be.calledOnce;
     });
 
@@ -65,6 +79,7 @@ describe("session-middleware", () => {
 
         expect(res.locals.strategicAppChannel).to.equal(true);
         expect(res.locals.webChannel).to.equal(false);
+        expect(res.locals.mobileChannel).to.equal(false);
         expect(next).to.be.calledOnce;
       });
 
@@ -75,6 +90,7 @@ describe("session-middleware", () => {
 
         expect(res.locals.strategicAppChannel).to.equal(false);
         expect(res.locals.webChannel).to.equal(true);
+        expect(res.locals.mobileChannel).to.equal(false);
         expect(next).to.be.calledOnce;
       });
     });

src/utils/get-channel-specific-template.ts

@@ -1,10 +1,10 @@
 import { logger } from "./logger.js";
 export function getChannelSpecificTemplate(
   webTemplateAndPath: string,
-  isStrategicAppChannel: boolean,
+  isMobileOrStrategicAppChannel: boolean,
   templateMappings: Record<string, string>
 ): string {
-  if (!isStrategicAppChannel) {
+  if (!isMobileOrStrategicAppChannel) {
     return webTemplateAndPath;
   }