VIA-206 MD Added code to call the eligibility API - SSM tests are failing

marie-dedikova-nhs · marie-dedikova-nhs · commit f08a2cd76939 · 2025-06-10T11:34:34.000+01:00
diff --git a/src/_lambda/content-cache-hydrator/content-fetcher.ts b/src/_lambda/content-cache-hydrator/content-fetcher.ts
@@ -1,5 +1,8 @@
 import { VaccineTypes } from "@src/models/vaccine";
-import { vaccineTypeToPath } from "@src/services/content-api/constants";
+import {
+  VaccineContentPaths,
+  vaccineTypeToPath,
+} from "@src/services/content-api/constants";
 import { AppConfig, configProvider } from "@src/utils/config";
 import { logger } from "@src/utils/logger";
 import axios, { AxiosResponse } from "axios";
@@ -12,11 +15,11 @@ const fetchContentForVaccine = async (
 ): Promise<string> => {
   const config: AppConfig = await configProvider();
 
-  const apiEndpoint = config.CONTENT_API_ENDPOINT;
-  const vaccinePath = vaccineTypeToPath[vaccine];
-  const apiKey = config.CONTENT_API_KEY;
+  const apiEndpoint: string = config.CONTENT_API_ENDPOINT;
+  const vaccinePath: VaccineContentPaths = vaccineTypeToPath[vaccine];
+  const apiKey: string = config.CONTENT_API_KEY;
 
-  const uri = `${apiEndpoint}${CONTENT_API_PATH_PREFIX}${vaccinePath}`;
+  const uri: string = `${apiEndpoint}${CONTENT_API_PATH_PREFIX}${vaccinePath}`;
   let response: AxiosResponse;
   try {
     log.info("Fetching content from %s", uri);
diff --git a/src/app/_components/vaccine/Vaccine.test.tsx b/src/app/_components/vaccine/Vaccine.test.tsx
@@ -8,7 +8,7 @@ import {
 import { render, screen } from "@testing-library/react";
 import { ContentErrorTypes } from "@src/services/content-api/types";
 import { EligibilityStatus } from "@src/services/eligibility-api/types";
-import { getEligibilityForPerson } from "@src/services/eligibility-api/gateway/eligibility-reader-service";
+import { getEligibilityContentForPerson } from "@src/services/eligibility-api/gateway/eligibility-reader-service";
 import { mockStyledEligibility } from "@test-data/eligibility-api/data";
 
 jest.mock("@src/services/content-api/gateway/content-reader-service");
@@ -31,7 +31,7 @@ describe("Any vaccine page", () => {
       (getContentForVaccine as jest.Mock).mockResolvedValue({
         styledVaccineContent: mockStyledContent,
       });
-      (getEligibilityForPerson as jest.Mock).mockResolvedValue({
+      (getEligibilityContentForPerson as jest.Mock).mockResolvedValue({
         styledEligibilityContent: mockStyledEligibility,
       });
     });
@@ -182,7 +182,7 @@ describe("Any vaccine page", () => {
 
   describe("when eligible", () => {
     beforeEach(() => {
-      (getEligibilityForPerson as jest.Mock).mockResolvedValue({
+      (getEligibilityContentForPerson as jest.Mock).mockResolvedValue({
         eligibilityStatus: EligibilityStatus.ELIGIBLE_BOOKABLE,
         styledEligibilityContent: mockStyledEligibility,
       });
@@ -198,7 +198,7 @@ describe("Any vaccine page", () => {
 
   describe("when not eligible", () => {
     beforeEach(() => {
-      (getEligibilityForPerson as jest.Mock).mockResolvedValue({
+      (getEligibilityContentForPerson as jest.Mock).mockResolvedValue({
         eligibilityStatus: EligibilityStatus.NOT_ELIGIBLE,
         styledEligibilityContent: mockStyledEligibility,
       });
@@ -265,7 +265,7 @@ describe("Any vaccine page", () => {
       (getContentForVaccine as jest.Mock).mockResolvedValue({
         styledVaccineContent: mockStyledContent,
       });
-      (getEligibilityForPerson as jest.Mock).mockResolvedValue({
+      (getEligibilityContentForPerson as jest.Mock).mockResolvedValue({
         styledEligibilityContent: mockStyledEligibility,
       });
     });
diff --git a/src/app/vaccines/6-in-1/page.test.tsx b/src/app/vaccines/6-in-1/page.test.tsx
diff --git a/src/app/vaccines/covid-19/page.test.tsx b/src/app/vaccines/covid-19/page.test.tsx
diff --git a/src/app/vaccines/flu/page.test.tsx b/src/app/vaccines/flu/page.test.tsx
diff --git a/src/app/vaccines/menacwy/page.test.tsx b/src/app/vaccines/menacwy/page.test.tsx
diff --git a/src/services/eligibility-api/gateway/eligibility-reader-service.test.ts b/src/services/eligibility-api/gateway/eligibility-reader-service.test.ts
@@ -0,0 +1,25 @@
+import { getEligibilityContentForPerson } from "@src/services/eligibility-api/gateway/eligibility-reader-service";
+import { VaccineTypes } from "@src/models/vaccine";
+import {
+  EligibilityStatus,
+  GetEligibilityForPersonResponse,
+} from "@src/services/eligibility-api/types";
+import { expect } from "@playwright/test";
+import { mockEligibilityResponse } from "@test-data/eligibility-api/data";
+
+describe("getEligibilityContentForPerson", () => {
+  it("return eligibility content for elderly person and RSV vaccine", async () => {
+    const {
+      eligibilityStatus,
+      styledEligibilityContent,
+      eligibilityError,
+    }: GetEligibilityForPersonResponse = await getEligibilityContentForPerson(
+      "5000000014",
+      VaccineTypes.RSV,
+    );
+
+    expect(eligibilityStatus).toEqual(EligibilityStatus.NOT_ELIGIBLE);
+    expect(styledEligibilityContent).toEqual(mockEligibilityResponse);
+    expect(eligibilityError).toBeUndefined();
+  });
+});
diff --git a/src/services/eligibility-api/gateway/eligibility-reader-service.ts b/src/services/eligibility-api/gateway/eligibility-reader-service.ts
@@ -1,23 +1,47 @@
 import { VaccineTypes } from "@src/models/vaccine";
-import {
-  EligibilityStatus,
-  GetEligibilityForPersonResponse,
-} from "@src/services/eligibility-api/types";
+import { GetEligibilityForPersonResponse } from "@src/services/eligibility-api/types";
+import { AppConfig, configProvider } from "@src/utils/config";
+import axios, { AxiosResponse } from "axios";
+import { logger } from "@src/utils/logger";
 
-const getEligibilityForPerson = async (
+const log = logger.child({ module: "content-fetcher" });
+const ELIGIBILITY_API_PATH_PREFIX = "/patient-check/";
+
+const getEligibilityContentForPerson = async (
   nhsNumber: string, // eslint-disable-line @typescript-eslint/no-unused-vars
   vaccineType: VaccineTypes, // eslint-disable-line @typescript-eslint/no-unused-vars
 ): Promise<GetEligibilityForPersonResponse> => {
-  const styledEligibilityContent = {
-    heading: "dummy heading",
-    content: "dummy content",
-  };
+  const config: AppConfig = await configProvider();
+
+  const apiEndpoint: string = config.ELIGIBILITY_API_ENDPOINT;
+  const apiKey: string = config.ELIGIBILITY_API_KEY;
 
-  return {
-    eligibilityStatus: EligibilityStatus.NOT_ELIGIBLE,
-    styledEligibilityContent,
-    eligibilityError: undefined,
-  };
+  const uri: string = `${apiEndpoint}${ELIGIBILITY_API_PATH_PREFIX}/${nhsNumber}`;
+  let response: AxiosResponse;
+  try {
+    log.info("Fetching content from %s", uri);
+    response = await axios.get(uri, {
+      headers: {
+        accept: "application/json",
+        apikey: apiKey,
+      },
+    });
+    log.info("Successfully fetched content from %s", uri);
+    return response.data;
+  } catch (error) {
+    log.error(`Error in fetching ${uri}: ${error}`);
+    throw error;
+  }
+  // const styledEligibilityContent = {
+  //   heading: "dummy heading",
+  //   content: "dummy content",
+  // };
+  //
+  // return {
+  //   eligibilityStatus: EligibilityStatus.NOT_ELIGIBLE,
+  //   styledEligibilityContent,
+  //   eligibilityError: undefined,
+  // };
 };
 
-export { getEligibilityForPerson };
+export { getEligibilityContentForPerson };
diff --git a/src/services/eligibility-api/types.ts b/src/services/eligibility-api/types.ts
@@ -22,3 +22,29 @@ export type StyledEligibilityContent = {
   heading: string;
   content: string;
 };
+
+// Downstream API
+export type EligibilityApiResponse = {
+  responseId: string;
+  meta: LastUpdated;
+  processedSuggestions: ProcessedSuggestion[];
+};
+
+type LastUpdated = {
+  lastUpdated: string;
+};
+
+type ProcessedSuggestion = {
+  condition: string;
+  status: Status;
+  statusText: string;
+  eligibilityCohorts: EligibilityCohort[];
+};
+
+type Status = "NotEligible" | "NotActionable" | "Actionable";
+
+type EligibilityCohort = {
+  cohortCode: string;
+  cohortText: string;
+  cohortStatus: string;
+};
diff --git a/src/utils/config.test.ts b/src/utils/config.test.ts
@@ -1,4 +1,4 @@
-import { configProvider } from "./config";
+import { AppConfig, configProvider } from "./config";
 import getSSMParam from "@src/utils/get-ssm-param";
 
 jest.mock("@src/utils/get-ssm-param");
@@ -19,7 +19,7 @@ describe("configProvider", () => {
       "api-key",
     );
 
-    const config = await configProvider();
+    const config: AppConfig = await configProvider();
 
     expect(config).toMatchObject({
       CONTENT_API_ENDPOINT: "api-endpoint",
diff --git a/src/utils/config.ts b/src/utils/config.ts
@@ -2,7 +2,9 @@ import getSSMParam from "@src/utils/get-ssm-param";
 
 type AppConfig = {
   CONTENT_API_ENDPOINT: string;
+  ELIGIBILITY_API_ENDPOINT: string;
   CONTENT_API_KEY: string;
+  ELIGIBILITY_API_KEY: string;
   CONTENT_CACHE_PATH: string;
   NHS_LOGIN_URL: string;
   NHS_LOGIN_CLIENT_ID: string;
@@ -19,10 +21,18 @@ const configProvider = async (): Promise<AppConfig> => {
       SSM_PREFIX,
       "CONTENT_API_ENDPOINT",
     ),
+    ELIGIBILITY_API_ENDPOINT: await getFromEnvironmentOrSSM(
+      SSM_PREFIX,
+      "ELIGIBILITY_API_ENDPOINT",
+    ),
     CONTENT_API_KEY: await getFromEnvironmentOrSSM(
       SSM_PREFIX,
       "CONTENT_API_KEY",
     ),
+    ELIGIBILITY_API_KEY: await getFromEnvironmentOrSSM(
+      SSM_PREFIX,
+      "ELIGIBILITY_API_KEY",
+    ),
     CONTENT_CACHE_PATH: await getFromEnvironmentOrSSM(
       SSM_PREFIX,
       "CONTENT_CACHE_PATH",
diff --git a/test-data/eligibility-api/data.tsx b/test-data/eligibility-api/data.tsx
@@ -1,4 +1,30 @@
-import { StyledEligibilityContent } from "@src/services/eligibility-api/types";
+import { EligibilityApiResponse, StyledEligibilityContent } from "@src/services/eligibility-api/types";
+
+export const mockEligibilityResponse: EligibilityApiResponse = {
+    "responseId": "1a233ba5-e1eb-4080-a086-2962f6fc3473",
+    "meta": {
+    "lastUpdated": "2025-02-12T16:11:22Z"
+  },
+    "processedSuggestions": [
+    {
+      "condition": "RSV",
+      "status": "NotEligible",
+      "statusText": "We do not believe you should have this vaccine",
+      "eligibilityCohorts": [
+        {
+          "cohortCode": "rsv_age_rolling",
+          "cohortText": "You are not aged 75 to 79 years old.",
+          "cohortStatus": "NotEligible"
+        },
+        {
+          "cohortCode": "rsv_age_catchup",
+          "cohortText": "You did not turn 80 between 2nd September 2024 and 31st August 2025",
+          "cohortStatus": "NotEligible"
+        }
+      ]
+    }
+  ]
+};
 
 export const mockStyledEligibility: StyledEligibilityContent = {
   heading: "dummy heading",
