Fix: [AEA-0000] - add cpt and rum session id to api calls (#1366)

anthony-nhs · web-flow · commit ad71cf4316fc · 2025-09-29T10:38:27.000+01:00
## Summary

- Routine Change

### Details

- add rum session id to api calls
- add cpt session id to api calls
- fix dependencies we cant upgrade yet
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/cognito/package.json b/packages/cognito/package.json
@@ -27,7 +27,7 @@
     "axios": "^1.12.2",
     "jsonwebtoken": "^9.0.2",
     "jwks-rsa": "^3.2.0",
-    "uuid": "^11.1.0"
+    "uuid": "11.1.0"
   },
   "devDependencies": {
     "@types/aws-lambda": "^8.10.152",
diff --git a/packages/common/commonTypes/src/headers.ts b/packages/common/commonTypes/src/headers.ts
@@ -0,0 +1,6 @@
+export enum Headers {
+  x_request_id = "x-request-id",
+  x_correlation_id = "x-correlation-id",
+  x_rum_session_id = "x-rum-session-id",
+  x_session_id = "x-session-id",
+}
diff --git a/packages/common/commonTypes/src/index.ts b/packages/common/commonTypes/src/index.ts
@@ -37,3 +37,5 @@ export type {
   TrackerUserInfo,
   TrackerUserInfoResult
 } from "./trackerUserInfo"
+
+export {Headers} from "./headers"
diff --git a/packages/common/commonTypes/src/trackerUserInfo.ts b/packages/common/commonTypes/src/trackerUserInfo.ts
@@ -21,6 +21,7 @@ export type TrackerUserInfo = {
   user_details: UserDetails;
   multiple_sessions?: boolean;
   is_concurrent_session?: boolean;
+  sessionId?: string;
   error?: string | null;
 };
 
@@ -33,5 +34,6 @@ export type TrackerUserInfoResult = {
   hasSingleRoleAccess: boolean,
   isConcurrentSession: boolean,
   invalidSessionCause: string | undefined,
+  sessionId: string | undefined,
   error: string | null
 }
diff --git a/packages/common/lambdaUtils/package.json b/packages/common/lambdaUtils/package.json
@@ -15,6 +15,7 @@
   },
   "dependencies": {
     "@aws-lambda-powertools/logger": "^2.27.0",
+    "@cpt-ui-common/common-types": "^1.0.0",
     "aws-lambda": "^1.0.7",
     "axios": "^1.12.2",
     "uuid": "^11.1.0"
diff --git a/packages/common/lambdaUtils/src/index.ts b/packages/common/lambdaUtils/src/index.ts
@@ -1,6 +1,7 @@
 import {APIGatewayProxyEvent} from "aws-lambda"
 import {v4 as uuidv4} from "uuid"
 import {Logger} from "@aws-lambda-powertools/logger"
+import {Headers} from "@cpt-ui-common/common-types"
 
 export * as headers from "./headers"
 export * from "./exhaustiveGuard"
@@ -9,6 +10,8 @@ export type LoggerKeys = {
   "apigw-request-id"?: string,
   "x-request-id"?: string,
   "x-correlation-id"?: string
+  "x-rum-session-id"?: string
+  "x-session-id"?: string
 }
 export type InboundEventValues = {
   loggerKeys: LoggerKeys,
@@ -19,8 +22,10 @@ export const extractInboundEventValues = (event: APIGatewayProxyEvent): InboundE
   return {
     loggerKeys: {
       "apigw-request-id": event.requestContext?.requestId,
-      "x-request-id": event.headers["x-request-id"],
-      "x-correlation-id": correlationId
+      "x-request-id": event.headers[Headers.x_request_id],
+      "x-correlation-id": correlationId,
+      "x-session-id": event.headers[Headers.x_session_id],
+      "x-rum-session-id": event.headers[Headers.x_rum_session_id]
     },
     correlationId
   }
diff --git a/packages/common/pdsClient/package.json b/packages/common/pdsClient/package.json
@@ -20,7 +20,7 @@
     "ajv": "^8.17.1",
     "axios": "^1.12.2",
     "json-schema-to-ts": "^3.1.1",
-    "uuid": "^11.1.0"
+    "uuid": "11.1.0"
   },
   "devDependencies": {
     "@cpt-ui-common/testing": "^1.0.0",
diff --git a/packages/cpt-ui/__tests__/BasicDetailsSearch.test.tsx b/packages/cpt-ui/__tests__/BasicDetailsSearch.test.tsx
@@ -49,6 +49,7 @@ const signedInAuthState: AuthContextType = {
   selectedRole: undefined,
   userDetails: undefined,
   isConcurrentSession: false,
+  sessionId: "test-session-id",
   cognitoSignIn: mockCognitoSignIn,
   cognitoSignOut: mockCognitoSignOut,
   clearAuthState: mockClearAuthState,
diff --git a/packages/cpt-ui/__tests__/BasicDetailsSearchResultsPage.test.tsx b/packages/cpt-ui/__tests__/BasicDetailsSearchResultsPage.test.tsx
@@ -30,6 +30,7 @@ const mockAuthContext: AuthContextType = {
   selectedRole: undefined,
   userDetails: undefined,
   isConcurrentSession: false,
+  sessionId: undefined,
   cognitoSignIn: jest.fn(),
   cognitoSignOut: jest.fn(),
   clearAuthState: jest.fn(),
diff --git a/packages/cpt-ui/__tests__/EpsCard.test.tsx b/packages/cpt-ui/__tests__/EpsCard.test.tsx
@@ -101,6 +101,7 @@ const defaultAuthContext: AuthContextType = {
   selectedRole: undefined,
   userDetails: undefined,
   isConcurrentSession: false,
+  sessionId: undefined,
   cognitoSignIn: jest.fn(),
   cognitoSignOut: jest.fn(),
   clearAuthState: jest.fn(),
diff --git a/packages/cpt-ui/__tests__/EpsHeader.test.tsx b/packages/cpt-ui/__tests__/EpsHeader.test.tsx
@@ -59,6 +59,7 @@ const defaultAuthContext: AuthContextType = {
   selectedRole: undefined,
   userDetails: undefined,
   isConcurrentSession: false,
+  sessionId: undefined,
   cognitoSignIn: jest.fn(),
   cognitoSignOut: jest.fn(),
   clearAuthState: jest.fn(),
diff --git a/packages/cpt-ui/__tests__/EpsPrescriptionList.test.tsx b/packages/cpt-ui/__tests__/EpsPrescriptionList.test.tsx
@@ -41,6 +41,7 @@ const signedInAuthState: AuthContextType = {
   selectedRole: undefined,
   userDetails: undefined,
   isConcurrentSession: false,
+  sessionId: undefined,
   cognitoSignIn: mockCognitoSignIn,
   cognitoSignOut: mockCognitoSignOut,
   clearAuthState: jest.fn(),
diff --git a/packages/cpt-ui/__tests__/EpsSearchForAPrescription.test.tsx b/packages/cpt-ui/__tests__/EpsSearchForAPrescription.test.tsx
@@ -22,6 +22,7 @@ const defaultAuthContext: AuthContextType = {
   selectedRole: undefined,
   userDetails: undefined,
   isConcurrentSession: false,
+  sessionId: undefined,
   cognitoSignIn: jest.fn(),
   cognitoSignOut: jest.fn(),
   clearAuthState: jest.fn(),
diff --git a/packages/cpt-ui/__tests__/LoginPage.test.tsx b/packages/cpt-ui/__tests__/LoginPage.test.tsx
@@ -94,6 +94,7 @@ const defaultAuthState: AuthContextType = {
   selectedRole: undefined,
   userDetails: undefined,
   isConcurrentSession: false,
+  sessionId: undefined,
   cognitoSignIn: mockCognitoSignIn,
   cognitoSignOut: mockCognitoSignOut,
   clearAuthState: jest.fn(),
diff --git a/packages/cpt-ui/__tests__/LogoutPage.test.tsx b/packages/cpt-ui/__tests__/LogoutPage.test.tsx
@@ -74,6 +74,7 @@ const MockAuthProvider = ({
     selectedRole: undefined,
     userDetails: undefined,
     isConcurrentSession: false,
+    sessionId: undefined,
     cognitoSignIn: jest.fn(),
     cognitoSignOut: mockCognitoSignOut,
     clearAuthState: jest.fn(),
diff --git a/packages/cpt-ui/__tests__/PrescriptionDetailsPage.test.tsx b/packages/cpt-ui/__tests__/PrescriptionDetailsPage.test.tsx
@@ -31,6 +31,7 @@ const defaultAuthState: AuthContextType = {
   selectedRole: undefined,
   userDetails: undefined,
   isConcurrentSession: false,
+  sessionId: undefined,
   cognitoSignIn: jest.fn().mockName("cognitoSignIn"),
   cognitoSignOut: jest.fn().mockName("cognitoSignOut"),
   clearAuthState: jest.fn().mockName("clearAuthState"),
diff --git a/packages/cpt-ui/__tests__/PrescriptionIdSearch.test.tsx b/packages/cpt-ui/__tests__/PrescriptionIdSearch.test.tsx
@@ -28,6 +28,7 @@ const mockAuthContext: AuthContextType = {
   selectedRole: undefined,
   userDetails: undefined,
   isConcurrentSession: false,
+  sessionId: undefined,
   cognitoSignIn: jest.fn(),
   cognitoSignOut: jest.fn(),
   clearAuthState: jest.fn(),
diff --git a/packages/cpt-ui/__tests__/SessionLoggedOutPage.test.tsx b/packages/cpt-ui/__tests__/SessionLoggedOutPage.test.tsx
@@ -49,6 +49,7 @@ export const defaultAuthState: AuthContextType = {
   selectedRole: undefined,
   userDetails: undefined,
   isConcurrentSession: true,
+  sessionId: "test-session-id",
   cognitoSignIn: jest.fn(),
   cognitoSignOut: jest.fn(),
   clearAuthState: jest.fn(),
diff --git a/packages/cpt-ui/__tests__/SessionSelectionPage.test.tsx b/packages/cpt-ui/__tests__/SessionSelectionPage.test.tsx
@@ -63,6 +63,7 @@ export const defaultAuthState: AuthContextType = {
   selectedRole: undefined,
   userDetails: undefined,
   isConcurrentSession: true,
+  sessionId: "test-session-id",
   cognitoSignIn: jest.fn(),
   cognitoSignOut: jest.fn(),
   clearAuthState: jest.fn(),
diff --git a/packages/cpt-ui/__tests__/YourSelectedRole.test.tsx b/packages/cpt-ui/__tests__/YourSelectedRole.test.tsx
@@ -18,6 +18,7 @@ const mockUseAuthReturnValue: AuthContextType = {
   isSignedIn: false,
   isSigningIn: false,
   invalidSessionCause: undefined,
+  sessionId: undefined,
   rolesWithAccess: [],
   rolesWithoutAccess: [],
   hasNoAccess: false,
diff --git a/packages/cpt-ui/__tests__/axios.test.tsx b/packages/cpt-ui/__tests__/axios.test.tsx
@@ -2,6 +2,7 @@ import http from "@/helpers/axios"
 import {fetchAuthSession} from "aws-amplify/auth"
 import MockAdapter from "axios-mock-adapter"
 import {v4 as uuidv4} from "uuid"
+import {readItemGroupFromLocalStorage} from "@/helpers/useLocalStorageState"
 
 jest.mock("uuid", () => ({
   // Always return the same UUID so we can test it
@@ -12,6 +13,11 @@ jest.mock("aws-amplify/auth", () => ({
   // Always return the same UUID so we can test it
   fetchAuthSession: jest.fn().mockReturnValue({tokens: {idToken: "mock_auth_token"}})
 }))
+
+jest.mock("@/helpers/useLocalStorageState", () => ({
+  readItemGroupFromLocalStorage: jest.fn()
+}))
+
 describe("HTTP Axios Instance", () => {
   let mock: MockAdapter
 
@@ -41,6 +47,47 @@ describe("HTTP Axios Instance", () => {
     expect(response.data).toEqual({success: true})
   })
 
+  it("does add x-rum-session-id header when cwr_s cookie does exist", async () => {
+    // global value for cwr_s cookie is set in jest.setup.ts
+    mock.onGet("/test").reply((config) => {
+      expect(config.headers?.["x-rum-session-id"]).toBe("my_rum_session_id")
+      return [200, {success: true}]
+    })
+
+    const response = await http.get("/test")
+
+    expect(response.status).toBe(200)
+    expect(response.data).toEqual({success: true})
+  })
+
+  it("does add x-session-id header when it can read sessionId from local storage", async () => {
+    (readItemGroupFromLocalStorage as jest.Mock)
+      .mockReturnValueOnce({"sessionId": "my_session_id"})
+    mock.onGet("/test").reply((config) => {
+      expect(config.headers?.["x-session-id"]).toBe("my_session_id")
+      return [200, {success: true}]
+    })
+
+    const response = await http.get("/test")
+
+    expect(response.status).toBe(200)
+    expect(response.data).toEqual({success: true})
+  })
+
+  it("does not add x-session-id header when it can not read sessionId from local storage", async () => {
+    (readItemGroupFromLocalStorage as jest.Mock)
+      .mockReturnValueOnce({})
+    mock.onGet("/test").reply((config) => {
+      expect(config.headers?.["x-session-id"]).toBeUndefined()
+      return [200, {success: true}]
+    })
+
+    const response = await http.get("/test")
+
+    expect(response.status).toBe(200)
+    expect(response.data).toEqual({success: true})
+  })
+
   it("adds Authorization header on every request", async () => {
     mock.onGet("/test").reply((config) => {
       // 'config.headers' is possibly 'undefined'.
diff --git a/packages/cpt-ui/__tests__/sessionManagementHelper.test.tsx b/packages/cpt-ui/__tests__/sessionManagementHelper.test.tsx
@@ -16,6 +16,13 @@ jest.mock("@/helpers/logger", () => ({
 jest.mock("@/constants/environment", () => ({
   API_ENDPOINTS: {
     SESSION_MANAGEMENT: "/api/session-management"
+  },
+  AUTH_CONFIG: {
+    USER_POOL_ID: "mock-pool-id",
+    USER_POOL_CLIENT_ID: "mock-client-id",
+    HOSTED_LOGIN_DOMAIN: "mock-domain",
+    REDIRECT_SIGN_IN: "mock-signin",
+    REDIRECT_SIGN_OUT: "mock-signout"
   }
 }))
 
diff --git a/packages/cpt-ui/jest.setup.ts b/packages/cpt-ui/jest.setup.ts
@@ -1,6 +1,12 @@
 /* eslint-disable no-undef */
 
 import "@testing-library/jest-dom"
+const cwr_cookie_value_string = JSON.stringify({"sessionId":"my_rum_session_id"})
+const cwr_cookie_value_encoded = Buffer.from(cwr_cookie_value_string, "utf-8").toString("base64")
+
+Object.defineProperty(document, "cookie", {
+  value: `cwr_s=${cwr_cookie_value_encoded}`
+})
 
 // Mock window.matchMedia
 Object.defineProperty(window, "matchMedia", {
diff --git a/packages/cpt-ui/package.json b/packages/cpt-ui/package.json
@@ -18,14 +18,14 @@
     "aws-rum-web": "^1.25.0",
     "axios": "^1.12.2",
     "identity-obj-proxy": "^3.0.0",
-    "nhsuk-frontend": "^9.6.4",
+    "nhsuk-frontend": "9.6.4",
     "nhsuk-react-components": "^5.0.0",
     "pino": "^9.9.5",
-    "react": "^18",
-    "react-dom": "^18",
-    "react-router-dom": "^6.22.3",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "react-router-dom": "6.30.1",
     "sass": "^1.93.2",
-    "uuid": "^11.1.0"
+    "uuid": "11.1.0"
   },
   "devDependencies": {
     "@aws-amplify/auth": "^6.15.1",
@@ -34,8 +34,8 @@
     "@testing-library/react": "^16.3.0",
     "@testing-library/user-event": "^14.5.2",
     "@types/govuk-frontend": "^5.11.0",
-    "@types/react": "^18.2.64",
-    "@types/react-dom": "^18.2.21",
+    "@types/react": "18.3.1",
+    "@types/react-dom": "18.3.1",
     "@vitejs/plugin-react-swc": "^4.0.1",
     "axios-mock-adapter": "^2.1.0",
     "sass": "^1.93.2",
diff --git a/packages/cpt-ui/src/context/AuthProvider.tsx b/packages/cpt-ui/src/context/AuthProvider.tsx
@@ -27,6 +27,7 @@ export interface AuthContextType {
   isSigningOut: boolean
   isConcurrentSession: boolean
   invalidSessionCause: string | undefined
+  sessionId: string | undefined
   rolesWithAccess: Array<RoleDetails>
   rolesWithoutAccess: Array<RoleDetails>
   hasNoAccess: boolean
@@ -53,6 +54,8 @@ export const AuthProvider = ({children}: { children: React.ReactNode }) => {
   const [isSigningOut, setIsSigningOut] = useLocalStorageState<boolean>("isSigningOut", "isSigningOut", false)
   const [isConcurrentSession, setIsConcurrentSession] = useLocalStorageState<boolean>(
     "isConcurrentSession", "isConcurrentSession", false)
+  const [sessionId, setSessionId] = useLocalStorageState<string | undefined>(
+    "sessionId", "sessionId", undefined)
   const [invalidSessionCause, setInvalidSessionCause] = useLocalStorageState<string | undefined>(
     "invalidSessionCause", "invalidSessionCause", undefined)
   const [rolesWithAccess, setRolesWithAccess] = useLocalStorageState<Array<RoleDetails>>(
@@ -110,6 +113,7 @@ export const AuthProvider = ({children}: { children: React.ReactNode }) => {
     setError(trackerUserInfo.error)
     setIsConcurrentSession(trackerUserInfo.isConcurrentSession)
     setInvalidSessionCause(trackerUserInfo.invalidSessionCause)
+    setSessionId(trackerUserInfo.sessionId)
     return trackerUserInfo
   }
 
@@ -242,6 +246,7 @@ export const AuthProvider = ({children}: { children: React.ReactNode }) => {
       userDetails,
       isConcurrentSession,
       invalidSessionCause,
+      sessionId,
       cognitoSignIn,
       cognitoSignOut,
       clearAuthState,
diff --git a/packages/cpt-ui/src/helpers/axios.tsx b/packages/cpt-ui/src/helpers/axios.tsx
diff --git a/packages/cpt-ui/src/helpers/useLocalStorageState.tsx b/packages/cpt-ui/src/helpers/useLocalStorageState.tsx
diff --git a/packages/cpt-ui/src/helpers/userInfo.tsx b/packages/cpt-ui/src/helpers/userInfo.tsx
diff --git a/packages/prescriptionDetailsLambda/package.json b/packages/prescriptionDetailsLambda/package.json
diff --git a/packages/prescriptionListLambda/package.json b/packages/prescriptionListLambda/package.json
diff --git a/packages/sessionManagementLambda/.vscode/launch.json b/packages/sessionManagementLambda/.vscode/launch.json
diff --git a/packages/sessionManagementLambda/.vscode/settings.json b/packages/sessionManagementLambda/.vscode/settings.json
diff --git a/packages/trackerUserInfoLambda/src/handler.ts b/packages/trackerUserInfoLambda/src/handler.ts
diff --git a/packages/trackerUserInfoLambda/tests/test_handler.test.ts b/packages/trackerUserInfoLambda/tests/test_handler.test.ts
