chore: [AB#13058] add health check for tax filing API

Author: jphechter

api/src/client/ApiTaxFilingClient.test.ts

@@ -16,7 +16,8 @@ import {
   ApiTaxFilingOnboardingResponse,
 } from "@client/ApiTaxFilingClient";
 import { dateToShortISO } from "@domain/tax-filings/taxIdHelper";
-import { StatusCodes } from "http-status-codes";
+import { randomElementFromArray } from "@test/helpers";
+import { ReasonPhrases, StatusCodes } from "http-status-codes";
 
 jest.mock("axios");
 jest.mock("winston");
@@ -363,4 +364,37 @@ describe("ApiTaxFilingClient", () => {
       expect(response).toEqual({ state: "API_ERROR" });
     });
   });
+
+  describe("health", () => {
+    it("returns a passing health check if the service is available", async () => {
+      const stubResponse = generateSuccessfulApiTaxFilingLookupResponse({});
+      mockAxios.post.mockResolvedValue({ data: stubResponse });
+
+      expect(await client.health()).toEqual({ success: true, data: { message: ReasonPhrases.OK } });
+    });
+
+    it("returns a passing health check if the service returns a known validation error", async () => {
+      const state: "PENDING" | "FAILED" | "UNREGISTERED" = randomElementFromArray([
+        "PENDING",
+        "FAILED",
+        "UNREGISTERED",
+      ]);
+
+      const stubResponse = generateErroredApiTaxFilingLookupResponse({}, state);
+      mockAxios.post.mockRejectedValue({
+        response: { data: stubResponse, status: StatusCodes.BAD_REQUEST },
+      });
+
+      expect(await client.health()).toEqual({ success: true, data: { message: ReasonPhrases.OK } });
+    });
+
+    it("returns a failing health check if the service is unavailable", async () => {
+      mockAxios.post.mockRejectedValue({});
+
+      expect(await client.health()).toEqual({
+        success: false,
+        data: { message: ReasonPhrases.INTERNAL_SERVER_ERROR },
+      });
+    });
+  });
 });

api/src/client/ApiTaxFilingClient.ts

@@ -1,5 +1,6 @@
 import { flattenDeDupAndConvertTaxFilings } from "@domain/tax-filings/taxIdHelper";
 import {
+  HealthCheckMetadata,
   TaxFilingClient,
   TaxFilingLookupResponse,
   TaxFilingOnboardingResponse,
@@ -8,7 +9,7 @@ import {
 } from "@domain/types";
 import { LogWriterType } from "@libs/logWriter";
 import axios, { AxiosError } from "axios";
-import { StatusCodes } from "http-status-codes";
+import { ReasonPhrases, StatusCodes } from "http-status-codes";
 
 type ApiConfig = {
   apiKey: string;
@@ -186,9 +187,51 @@ export const ApiTaxFilingClient = (config: ApiConfig, logger: LogWriterType): Ta
     }
   };
 
+  const health = async (): Promise<HealthCheckMetadata> => {
+    return lookup({ taxId: "777777777771", businessName: "RUBB" })
+      .then((response) => {
+        if (response.state === "API_ERROR") {
+          logger.LogError(
+            `Tax Registration  Health Check - Id:${logId} - Error received: ${JSON.stringify(response.state)}`,
+          );
+          return {
+            success: false,
+            data: {
+              message: ReasonPhrases.INTERNAL_SERVER_ERROR,
+            },
+          };
+        } else {
+          // Note: The API may return a 400 and a validation error message. This still indicates the service is available.
+          logger.LogInfo(
+            `Tax Registration Health Check - Id:${logId} - Response received: ${JSON.stringify(
+              response.state,
+            )}`,
+          );
+          return {
+            success: true,
+            data: {
+              message: ReasonPhrases.OK,
+            },
+          };
+        }
+      })
+      .catch((error) => {
+        logger.LogError(
+          `Tax Registration  Health Check - Id:${logId} - Error received: ${JSON.stringify(error)}`,
+        );
+        return {
+          success: false,
+          data: {
+            message: ReasonPhrases.INTERNAL_SERVER_ERROR,
+          },
+        };
+      });
+  };
+
   return {
     lookup,
     onboarding,
+    health,
   };
 };
 

api/src/domain/tax-filings/taxFilingsInterfaceFactory.test.ts

@@ -38,6 +38,7 @@ describe("TaxFilingsInterfaceFactory", () => {
     taxFilingClient = {
       lookup: jest.fn(),
       onboarding: jest.fn(),
+      health: jest.fn(),
     };
     const dateNowStub = jest.fn(() => {
       return dateNow;

api/src/domain/types.ts

@@ -140,6 +140,7 @@ export interface TaxFilingClient {
     email: string;
     businessName: string;
   }) => Promise<TaxFilingOnboardingResponse>;
+  health: () => Promise<HealthCheckMetadata>;
 }
 
 export interface TaxFilingInterface {

api/src/functions/express/app.ts

@@ -536,9 +536,11 @@ app.use(
       ["webservice/formation", formationHealthCheckClient],
       ["tax-clearance", taxClearanceHealthCheckClient],
       ["xray-registration", xrayRegistrationHealthCheckClient],
+      // TODO: The following need CloudWatch metrics
       ["cigarette-license", cigaretteLicenseHealthCheckClient],
       ["cigarette-email-client", cigaretteLicenseEmailClient.health],
       ["messaging-service", messagingServiceClient.health],
+      ["tax-filing-client", taxFilingClient.health],
     ]),
     logger,
   ),

api/src/libs/healthCheck.test.ts

@@ -22,6 +22,7 @@ describe("healthCheck", () => {
       xrayRegistration: "PASS",
       cigaretteLicense: "PASS",
       cigaretteEmailClient: "PASS",
+      taxFilingClient: "PASS",
     });
   });
 
@@ -39,6 +40,7 @@ describe("healthCheck", () => {
       xrayRegistration: "FAIL",
       cigaretteLicense: "FAIL",
       cigaretteEmailClient: "FAIL",
+      taxFilingClient: "FAIL",
     });
   });
 
@@ -56,6 +58,7 @@ describe("healthCheck", () => {
       xrayRegistration: "ERROR",
       cigaretteLicense: "ERROR",
       cigaretteEmailClient: "ERROR",
+      taxFilingClient: "ERROR",
     });
   });
 });

api/src/libs/healthCheck.ts

@@ -19,6 +19,7 @@ const healthCheckEndPoints: Record<string, string> = {
   xrayRegistration: "xray-registration",
   cigaretteEmailClient: "cigarette-email-client",
   cigaretteLicense: "cigarette-license",
+  taxFilingClient: "tax-filing-client",
 };
 
 const healthCheck = async (type: string, url: string, logger: LogWriterType): Promise<Status> => {

api/wiremock/mappings/get-tax-calendar-lookup-success.json

@@ -4,7 +4,7 @@
     "url": "/lookup",
     "bodyPatterns": [
       {
-        "contains": "123456789098"
+        "contains": "777777777771"
       }
     ]
   },

api/wiremock/mappings/get-tax-calendar-onboarding-success.json

@@ -4,7 +4,7 @@
     "url": "/onboard",
     "bodyPatterns": [
       {
-        "contains": "123456789098"
+        "contains": "777777777771"
       }
     ]
   },

web/cypress/e2e/auto-tax-filing.spec.ts

@@ -37,7 +37,7 @@ describe.skip(
       clickModalSaveButton();
 
       onDashboardPage.registerForTaxes();
-      cy.get('input[name="taxId"]').type("123456789098");
+      cy.get('input[name="taxId"]').type("777777777771");
       cy.get("button").contains("Save").click();
       cy.get(`[data-testid="back-to-dashboard"]`).first().click({ force: true });
       cy.get('[data-testid="cta-funding-nudge"]').first().click();
@@ -58,7 +58,7 @@ describe.skip(
       clickModalSaveButton();
 
       onDashboardPage.registerForTaxes();
-      cy.get('input[name="taxId"]').type("123456789098");
+      cy.get('input[name="taxId"]').type("777777777771");
       cy.get("button").contains("Save").click();
       cy.get(`[data-testid="back-to-dashboard"]`).first().click({ force: true });
       cy.get('[data-testid="cta-funding-nudge"]').first().click();