VIA-630 Calculate age group of user and save on session

Author: donna-belsey-nhs

src/app/_components/hub/ageGroupHelper.test.ts

@@ -0,0 +1,24 @@
+import { getAgeGroup } from "@src/app/_components/hub/ageGroupHelper";
+import { AgeGroup } from "@src/models/ageBasedHub";
+
+describe("Age group helper", () => {
+  const expectedGroupsForEachAge = [
+    { age: 12, expectedAgeGroup: AgeGroup.AGE_12_to_16 },
+    { age: 16, expectedAgeGroup: AgeGroup.AGE_12_to_16 },
+    { age: 17, expectedAgeGroup: AgeGroup.AGE_17_to_24 },
+    { age: 24, expectedAgeGroup: AgeGroup.AGE_17_to_24 },
+    { age: 25, expectedAgeGroup: AgeGroup.AGE_25_to_64 },
+    { age: 64, expectedAgeGroup: AgeGroup.AGE_25_to_64 },
+    { age: 65, expectedAgeGroup: AgeGroup.AGE_65_to_74 },
+    { age: 74, expectedAgeGroup: AgeGroup.AGE_65_to_74 },
+    { age: 75, expectedAgeGroup: AgeGroup.AGE_75_to_80 },
+  ];
+
+  it.each(expectedGroupsForEachAge)(`returns $expectedAgeGroup for user age $age`, ({ age, expectedAgeGroup }) => {
+    expect(getAgeGroup(age)).toEqual(expectedAgeGroup);
+  });
+
+  it("returns unknown age group when age not in defined ranges", () => {
+    expect(getAgeGroup(6)).toBe(AgeGroup.UNKNOWN_AGE_GROUP);
+  });
+});

src/app/_components/hub/ageGroupHelper.ts

@@ -0,0 +1,24 @@
+import { AgeGroup } from "@src/models/ageBasedHub";
+
+const getAgeGroup = (age: number): AgeGroup => {
+  if (12 <= age && age <= 16) {
+    return AgeGroup.AGE_12_to_16;
+  }
+  if (17 <= age && age <= 24) {
+    return AgeGroup.AGE_17_to_24;
+  }
+  if (25 <= age && age <= 64) {
+    return AgeGroup.AGE_25_to_64;
+  }
+  if (65 <= age && age <= 74) {
+    return AgeGroup.AGE_65_to_74;
+  }
+  if (75 <= age && age <= 80) {
+    return AgeGroup.AGE_75_to_80;
+  }
+  if (81 <= age) {
+    return AgeGroup.AGE_81_PLUS;
+  } else return AgeGroup.UNKNOWN_AGE_GROUP;
+};
+
+export { getAgeGroup };

src/app/_components/inactivity/InactivityDialog.test.tsx

@@ -1,17 +1,19 @@
 import { InactivityDialog } from "@src/app/_components/inactivity/InactivityDialog";
 import { unprotectedUrlPaths } from "@src/app/_components/inactivity/constants";
+import { AgeGroup } from "@src/models/ageBasedHub";
 import { NhsNumber } from "@src/models/vaccine";
 import useInactivityTimer from "@src/utils/auth/inactivity-timer";
+import { Age } from "@src/utils/auth/types";
 import { userLogout } from "@src/utils/auth/user-logout";
 import { render, screen } from "@testing-library/react";
 import { Session } from "next-auth";
-import { Age } from "@src/utils/auth/types";
 
 const mockSessionValue: Partial<Session> = {
   expires: new Date(Date.now() + 60000).toISOString(),
   user: {
     nhs_number: "" as NhsNumber,
     age: 20 as Age,
+    age_group: AgeGroup.AGE_17_to_24,
   },
 };
 let mockSession = { data: mockSessionValue, status: "authenticated" };

src/models/ageBasedHub.ts

@@ -0,0 +1,41 @@
+import { VaccineType } from "@src/models/vaccine";
+
+enum AgeGroup {
+  AGE_12_to_16 = "AGE_12_to_16",
+  AGE_17_to_24 = "AGE_17_to_24",
+  AGE_25_to_64 = "AGE_25_to_64",
+  AGE_65_to_74 = "AGE_65_to_74",
+  AGE_75_to_80 = "AGE_75_to_80",
+  AGE_81_PLUS = "AGE_81_PLUS",
+  UNKNOWN_AGE_GROUP = "UNKNOWN_AGE_GROUP",
+}
+
+type AgeSpecificVaccineCardDetails = {
+  vaccineName: VaccineType;
+  cardLinkDescription: string;
+};
+
+type AgeBasedHubDetails = {
+  heading: string;
+  vaccines: AgeSpecificVaccineCardDetails[];
+};
+
+// TODO: VIA-630 remove 'undefined' from the type definition below after all hubs are implemented?
+const AgeBasedHubInfo: Record<AgeGroup, AgeBasedHubDetails | undefined> = {
+  AGE_12_to_16: undefined,
+  AGE_17_to_24: undefined,
+  AGE_25_to_64: undefined,
+  AGE_65_to_74: {
+    heading: "Adults aged 65 to 74 should get these routine vaccines",
+    vaccines: [
+      { vaccineName: VaccineType.PNEUMOCOCCAL, cardLinkDescription: "65 years and over" },
+      { vaccineName: VaccineType.FLU_FOR_ADULTS, cardLinkDescription: "65 years and over" },
+      { vaccineName: VaccineType.SHINGLES, cardLinkDescription: "65 to 67 and 70 to 79 years" },
+    ],
+  },
+  AGE_75_to_80: undefined,
+  AGE_81_PLUS: undefined,
+  UNKNOWN_AGE_GROUP: undefined,
+};
+
+export { AgeGroup, AgeBasedHubInfo };

src/utils/auth/callbacks/get-updated-session.test.ts

@@ -1,3 +1,5 @@
+import { getAgeGroup } from "@src/app/_components/hub/ageGroupHelper";
+import { AgeGroup } from "@src/models/ageBasedHub";
 import { NhsNumber } from "@src/models/vaccine";
 import { getUpdatedSession } from "@src/utils/auth/callbacks/get-updated-session";
 import { AccessToken, Age, BirthDate, ExpiresAt, IdToken } from "@src/utils/auth/types";
@@ -7,20 +9,24 @@ import { JWT } from "next-auth/jwt";
 
 jest.mock("sanitize-data", () => ({ sanitize: jest.fn() }));
 jest.mock("@src/utils/date", () => ({ calculateAge: jest.fn() }));
+jest.mock("@src/app/_components/hub/ageGroupHelper.ts", () => ({ getAgeGroup: jest.fn() }));
 
 const mockBirthdate = "1995-01-01";
 const mockCalculatedAge = 30;
+const mockAgeGroup = AgeGroup.AGE_75_to_80;
 
-describe("getSession", () => {
+describe("getUpdatedSession", () => {
   beforeEach(() => {
     (calculateAge as jest.Mock).mockImplementation(() => mockCalculatedAge);
+    (getAgeGroup as jest.Mock).mockImplementation(() => mockAgeGroup);
   });
 
-  it("updates session user fields from token when both defined", () => {
+  it("updates session with user fields and age information from token", () => {
     const session: Session = {
       user: {
         nhs_number: "" as NhsNumber,
         age: 0 as Age,
+        age_group: undefined,
       },
       expires: "some-date",
     };
@@ -43,13 +49,15 @@ describe("getSession", () => {
 
     expect(result.user.nhs_number).toBe("test-nhs-number");
     expect(result.user.age).toBe(mockCalculatedAge);
+    expect(result.user.age_group).toBe(mockAgeGroup);
   });
 
   it("does not update session if token.user is missing", () => {
     const session: Session = {
       user: {
         nhs_number: "old-nhs-number" as NhsNumber,
         age: 36 as Age,
+        age_group: AgeGroup.AGE_25_to_64,
       },
       expires: "some-date",
     };
@@ -60,6 +68,7 @@ describe("getSession", () => {
 
     expect(result.user.nhs_number).toBe("old-nhs-number");
     expect(result.user.age).toBe(36);
+    expect(result.user.age_group).toBe(AgeGroup.AGE_25_to_64);
   });
 
   it("does not update session if session.user is missing", () => {

src/utils/auth/callbacks/get-updated-session.ts

@@ -1,8 +1,9 @@
+import { getAgeGroup } from "@src/app/_components/hub/ageGroupHelper";
+import { calculateAge } from "@src/utils/date";
 import { logger } from "@src/utils/logger";
 import { Session } from "next-auth";
 import { JWT } from "next-auth/jwt";
 import { Logger } from "pino";
-import { calculateAge } from "@src/utils/date";
 
 const log: Logger = logger.child({
   module: "utils-auth-callbacks-get-session",
@@ -12,6 +13,7 @@ const getUpdatedSession = (session: Session, token: JWT): Session => {
   if (token?.user && session.user) {
     session.user.nhs_number = token.user.nhs_number;
     session.user.age = calculateAge(token.user.birthdate);
+    session.user.age_group = getAgeGroup(session.user.age);
   } else {
     log.info(
       {

src/utils/auth/types.d.ts

@@ -1,3 +1,4 @@
+import { AgeGroup } from "@src/models/ageBasedHub";
 import { NhsNumber } from "@src/models/vaccine";
 import { Brand } from "@src/utils/types";
 import type { DefaultSession } from "next-auth";
@@ -45,7 +46,8 @@ declare module "next-auth" {
   interface Session {
     user: {
       nhs_number: NhsNumber;
-      age: Age;
+      age?: Age;
+      age_group?: undefined | AgeGroup;
     } & DefaultSession["user"];
   }
 

src/utils/date.test.ts

@@ -65,8 +65,16 @@ describe("utils-date", () => {
     });
   });
   describe("calculateAge", () => {
+    beforeAll(() => {
+      jest.useFakeTimers();
+    });
+
     beforeEach(() => {
-      jest.useFakeTimers().setSystemTime(new Date("2025-01-15T00:00:00.000Z").getTime());
+      jest.setSystemTime(new Date("2025-01-15T00:00:00.000Z").getTime());
+    });
+
+    afterAll(() => {
+      jest.useRealTimers();
     });
 
     it("should return age based on birthdate", () => {