PYIC-8798: Return 400 to the user on expired IPV Session in spinner pages. (#2426)

Author: thebauSoftwire

assets/javascript/app/dcmaw-async.js

@@ -8,7 +8,9 @@ function generatePollApiFunction(url) {
           return 0; // Success
         } else if (data.status === "PROCESSING") {
           return 2; // Pending
-        } else if (data.status === "ERROR") {
+        } else if (data.status === "SERVER_ERROR") {
+          return 3; // Backoff
+        } else if (data.status === "CLIENT_ERROR") {
           return 3; // Backoff
         }
         throw new Error(`Unexpected status: ${data.status}`);

src/app/ipv/middleware.ts

@@ -8,8 +8,8 @@ import fs from "fs";
 import path from "path";
 import { saveSessionAndRedirect } from "../shared/redirectHelper";
 import {
-  postJourneyEvent,
   getProvenIdentityUserDetails,
+  postJourneyEvent,
 } from "../../services/coreBackService";
 import { generateQrCodeImageData } from "../shared/qrCodeHelper";
 import { PHONE_TYPE } from "../../constants/device-constants";
@@ -21,16 +21,16 @@ import {
 } from "../../constants/update-details-journeys";
 import { getAppStoreRedirectUrl } from "../shared/appDownloadHelper";
 import {
-  getIpvPageTemplatePath,
   getIpvPagePath,
+  getIpvPageTemplatePath,
   getTemplatePath,
 } from "../../lib/paths";
 import PAGES from "../../constants/ipv-pages";
 import { getPhoneType } from "../shared/contextHelper";
 import {
-  sniffPhoneType,
   detectAppTriageEvent,
   OsType,
+  sniffPhoneType,
 } from "../shared/deviceSniffingHelper";
 import {
   isClientResponse,
@@ -453,7 +453,9 @@ export const checkVcReceiptStatus: RequestHandler = async (req, res, next) => {
   const status = await getAppVcReceiptStatusAndStoreJourneyResponse(req);
   if (status === AppVcReceiptStatus.PROCESSING) {
     await handleJourneyPageRequest(req, res, next, true);
-  } else if (status === AppVcReceiptStatus.ERROR) {
+  } else if (status === AppVcReceiptStatus.SERVER_ERROR) {
+    throw new Error("Failed to get VC response status");
+  } else if (status === AppVcReceiptStatus.CLIENT_ERROR) {
     throw new Error("Failed to get VC response status");
   } else if (status === AppVcReceiptStatus.COMPLETED) {
     return next();

src/app/ipv/tests/checkVcReceiptStatus.test.ts

@@ -64,11 +64,30 @@ describe("checkVcReceiptStatus middleware", () => {
     expect(next).to.have.not.been.calledOnce;
   });
 
-  it("should throw error if status is ERROR", async () => {
+  it("should throw error if status is SERVER_ERROR", async () => {
     // Arrange
     const req = createRequest();
     const res = createResponse();
-    getAppVcReceiptStatusAndStoreJourneyResponseStub.resolves("ERROR");
+    getAppVcReceiptStatusAndStoreJourneyResponseStub.resolves("SERVER_ERROR");
+
+    // Act & Assert
+    await expect(
+      (async () => await checkVcReceiptStatus(req, res, next))(),
+    ).to.be.rejectedWith(Error, "Failed to get VC response status");
+
+    // Assert
+    expect(
+      getAppVcReceiptStatusAndStoreJourneyResponseStub,
+    ).to.have.been.calledWith(req);
+    expect(res.render).to.not.have.been.called;
+    expect(next).to.have.not.been.calledOnce;
+  });
+
+  it("should throw client error if status is CLIENT_ERROR", async () => {
+    // Arrange
+    const req = createRequest();
+    const res = createResponse();
+    getAppVcReceiptStatusAndStoreJourneyResponseStub.resolves("CLIENT_ERROR");
 
     // Act & Assert
     await expect(

src/app/vc-receipt-status/middleware.test.ts

@@ -66,24 +66,34 @@ describe("vc receipt status middleware tests", () => {
     expect((req.session as any).journey).to.equal("journey/next");
   });
 
+  it("pollVcReceiptStatus should return CLIENT_ERROR status if appVcReceived returns 400", async () => {
+    const error = { response: { status: 400 } };
+    appVcReceivedStub.rejects(error);
+
+    await middleware.pollVcReceiptStatus(req as Request, res as Response, next);
+
+    expect(res.status).to.have.been.calledWith(400);
+    expect(res.json).to.have.been.calledWith({ status: "CLIENT_ERROR" });
+  });
+
   it("pollVcReceiptStatus should return an error when appVcReceived does not return journey response", async () => {
     appVcReceivedStub.resolves({ data: {} });
     isJourneyResponse.returns(false);
 
     await middleware.pollVcReceiptStatus(req as Request, res as Response, next);
 
     expect(res.status).to.have.been.calledWith(500);
-    expect(res.json).to.have.been.calledWith({ status: "ERROR" });
+    expect(res.json).to.have.been.calledWith({ status: "SERVER_ERROR" });
   });
 
-  it("pollVcReceiptStatus should return ERROR status if appVcReceived throws non 404 error", async () => {
+  it("pollVcReceiptStatus should return SERVER_ERROR status if appVcReceived throws non 400-499 error", async () => {
     const error = new Error("Test error");
     appVcReceivedStub.rejects(error);
 
     await middleware.pollVcReceiptStatus(req as Request, res as Response, next);
 
     expect(res.status).to.have.been.calledWith(500);
-    expect(res.json).to.have.been.calledWith({ status: "ERROR" });
+    expect(res.json).to.have.been.calledWith({ status: "SERVER_ERROR" });
   });
 
   it("pollVcReceiptStatus should return COMPLETED status when query param snapshotTest is true", async () => {

src/app/vc-receipt-status/middleware.ts

@@ -8,8 +8,9 @@ import { logger } from "../../lib/logger";
 
 export enum AppVcReceiptStatus {
   COMPLETED = "COMPLETED",
-  ERROR = "ERROR",
   PROCESSING = "PROCESSING",
+  CLIENT_ERROR = "CLIENT_ERROR",
+  SERVER_ERROR = "SERVER_ERROR",
 }
 
 export const getAppVcReceiptStatusAndStoreJourneyResponse = async (
@@ -28,12 +29,21 @@ export const getAppVcReceiptStatusAndStoreJourneyResponse = async (
   } catch (error) {
     if (isAxiosError(error) && error.response?.status === 404) {
       return AppVcReceiptStatus.PROCESSING;
+    } else if (isAxiosError(error) && isClientError(error.response?.status)) {
+      return AppVcReceiptStatus.CLIENT_ERROR;
     }
     logger.error(error, "Error getting app vc receipt status");
-    return AppVcReceiptStatus.ERROR;
+    return AppVcReceiptStatus.SERVER_ERROR;
   }
 };
 
+const isClientError = (error: number | undefined): boolean => {
+  if (!error) {
+    return false;
+  }
+  return error >= 400 && error <= 499;
+};
+
 export const pollVcReceiptStatus: RequestHandler = async (req, res) => {
   const isPreview = config.ENABLE_PREVIEW && req.query.preview === "true";
   const isSnapshot =
@@ -52,10 +62,15 @@ export const pollVcReceiptStatus: RequestHandler = async (req, res) => {
   }
 
   const status = await getAppVcReceiptStatusAndStoreJourneyResponse(req);
-  if (status === AppVcReceiptStatus.ERROR) {
+  if (status === AppVcReceiptStatus.SERVER_ERROR) {
     res.status(500).json({ status });
     return;
   }
 
+  if (status === AppVcReceiptStatus.CLIENT_ERROR) {
+    res.status(400).json({ status });
+    return;
+  }
+
   res.status(200).json({ status });
 };