chore: [AB#17441] remove automated health checks against endpoints for cigarette license

Author: jphechter

api/src/functions/express/app.ts

@@ -540,9 +540,8 @@ 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],
+      ["cigarette-license", cigaretteLicenseHealthCheckClient], // This endpoint is not being hit by the HealthCheck Lambda
+      ["cigarette-email-client", cigaretteLicenseEmailClient.health], // This endpoint is not being hit by the HealthCheck Lambda
       ["messaging-service", messagingServiceClient.health],
       ["tax-filing-client", taxFilingClient.health],
     ]),

api/src/libs/healthCheck.test.ts

@@ -1,6 +1,5 @@
 import { runHealthChecks } from "@libs/healthCheck";
 import { DummyLogWriter } from "@libs/logWriter";
-import { CONFIG_VARS, getConfigValue } from "@libs/ssmUtils";
 import axios from "axios";
 
 jest.mock("axios");
@@ -10,18 +9,9 @@ jest.mock("@libs/ssmUtils", () => ({
   getConfigValue: jest.fn(),
 }));
 
-const mockGetConfigValue = getConfigValue as jest.MockedFunction<typeof getConfigValue>;
-
 describe("healthCheck", () => {
   const logger = DummyLogWriter;
 
-  beforeEach(() => {
-    mockGetConfigValue.mockImplementation(async (paramName: CONFIG_VARS) => {
-      if (paramName === "FEATURE_CIGARETTE_LICENSE") return "true";
-      return "false";
-    });
-  });
-
   it("returns an object with pass statuses if success is true", async () => {
     mockAxios.get.mockResolvedValue({ data: { success: true } });
     expect(await runHealthChecks(logger)).toStrictEqual({
@@ -34,8 +24,6 @@ describe("healthCheck", () => {
       webserviceFormation: "PASS",
       taxClearance: "PASS",
       xrayRegistration: "PASS",
-      cigaretteLicense: "PASS",
-      cigaretteEmailClient: "PASS",
       taxFilingClient: "PASS",
     });
   });
@@ -52,8 +40,6 @@ describe("healthCheck", () => {
       webserviceFormation: "FAIL",
       taxClearance: "FAIL",
       xrayRegistration: "FAIL",
-      cigaretteLicense: "FAIL",
-      cigaretteEmailClient: "FAIL",
       taxFilingClient: "FAIL",
     });
   });
@@ -70,27 +56,7 @@ describe("healthCheck", () => {
       webserviceFormation: "ERROR",
       taxClearance: "ERROR",
       xrayRegistration: "ERROR",
-      cigaretteLicense: "ERROR",
-      cigaretteEmailClient: "ERROR",
       taxFilingClient: "ERROR",
     });
   });
-
-  describe("flagged health checks", () => {
-    it("includes cigarette health checks when feature flag is on", async () => {
-      const result = await runHealthChecks(logger);
-      expect(Object.keys(result)).toContain("cigaretteLicense");
-      expect(Object.keys(result)).toContain("cigaretteEmailClient");
-    });
-
-    it("excludes cigarette health checks when feature flag is off", async () => {
-      mockGetConfigValue.mockImplementation(async () => {
-        return "false";
-      });
-
-      const result = await runHealthChecks(logger);
-      expect(Object.keys(result)).not.toContain("cigaretteLicense");
-      expect(Object.keys(result)).not.toContain("cigaretteEmailClient");
-    });
-  });
 });

api/src/libs/healthCheck.ts

@@ -1,6 +1,5 @@
 import { CloudWatchClient, PutMetricDataCommand } from "@aws-sdk/client-cloudwatch";
 import { LogWriterType } from "@libs/logWriter";
-import { getConfigValue } from "@libs/ssmUtils";
 import axios, { AxiosError, AxiosResponse } from "axios";
 
 type Status = "PASS" | "FAIL" | "ERROR";
@@ -21,20 +20,6 @@ const healthCheckEndPoints: Record<string, string> = {
   taxFilingClient: "tax-filing-client",
 };
 
-const addFlaggedHealthChecks = (
-  endpoints: Record<string, string>,
-  flagValues: { cigarette: boolean },
-): Record<string, string> => {
-  if (flagValues.cigarette) {
-    return {
-      ...endpoints,
-      cigaretteEmailClient: "cigarette-email-client",
-      cigaretteLicense: "cigarette-license",
-    };
-  }
-  return endpoints;
-};
-
 const healthCheck = async (type: string, url: string, logger: LogWriterType): Promise<Status> => {
   const fullUrl = `${url}/health/${type}`;
 
@@ -95,14 +80,7 @@ export const runHealthChecks = async (logger: LogWriterType): Promise<StatusResu
     throw new Error("API URL is undefined");
   }
 
-  const isCigaretteLicenseEnabled =
-    (await getConfigValue("FEATURE_CIGARETTE_LICENSE", logger)) === "true";
-
-  const endpoints = addFlaggedHealthChecks(healthCheckEndPoints, {
-    cigarette: isCigaretteLicenseEnabled,
-  });
-
-  const entries = Object.entries(endpoints).map(([type, endpoint]) =>
+  const entries = Object.entries(healthCheckEndPoints).map(([type, endpoint]) =>
     healthCheck(endpoint ?? "", url, logger).then((result) => [type, result] as const),
   );