chore: [AB#17315] move cigarette health checks behind a feature flag

Author: jphechter

api/src/libs/healthCheck.test.ts

@@ -1,13 +1,27 @@
 import { runHealthChecks } from "@libs/healthCheck";
 import { DummyLogWriter } from "@libs/logWriter";
+import { CONFIG_VARS, getConfigValue } from "@libs/ssmUtils";
 import axios from "axios";
 
 jest.mock("axios");
 const mockAxios = axios as jest.Mocked<typeof axios>;
 
+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({
@@ -61,4 +75,22 @@ describe("healthCheck", () => {
       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,5 +1,6 @@
 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";
@@ -17,11 +18,23 @@ const healthCheckEndPoints: Record<string, string> = {
   webserviceFormation: "webservice/formation",
   taxClearance: "tax-clearance",
   xrayRegistration: "xray-registration",
-  cigaretteEmailClient: "cigarette-email-client",
-  cigaretteLicense: "cigarette-license",
   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}`;
 
@@ -82,7 +95,14 @@ export const runHealthChecks = async (logger: LogWriterType): Promise<StatusResu
     throw new Error("API URL is undefined");
   }
 
-  const entries = Object.entries(healthCheckEndPoints).map(([type, endpoint]) =>
+  const isCigaretteLicenseEnabled =
+    (await getConfigValue("FEATURE_CIGARETTE_LICENSE", logger)) === "true";
+
+  const endpoints = addFlaggedHealthChecks(healthCheckEndPoints, {
+    cigarette: isCigaretteLicenseEnabled,
+  });
+
+  const entries = Object.entries(endpoints).map(([type, endpoint]) =>
     healthCheck(endpoint ?? "", url, logger).then((result) => [type, result] as const),
   );
 

api/src/libs/ssmUtils.ts

@@ -14,7 +14,8 @@ export type CONFIG_VARS =
   | ENV_REQ_CONFIG_VARS
   | USER_MESSAGING_CONFIG_VARS
   | "dep_base_url"
-  | "zod_parsing_on";
+  | "zod_parsing_on"
+  | "FEATURE_CIGARETTE_LICENSE";
 
 export type CIGARETTE_PAYMENT_CONFIG_VARS =
   | "cigarette_license_base_url"