VIA-357 Log nextUrl and traceId on ClientSideError. Refactor requestContext to reduce duplication

donna-belsey-nhs · donna-belsey-nhs · commit 619bbfcacd84 · 2025-09-12T16:24:27.000+01:00
nextURL is now available on requestContext and included in all nodeJs
logs
diff --git a/auth.ts b/auth.ts
@@ -8,9 +8,10 @@ import { getUpdatedSession } from "@src/utils/auth/callbacks/get-updated-session
 import { isValidSignIn } from "@src/utils/auth/callbacks/is-valid-signin";
 import { MaxAgeInSeconds } from "@src/utils/auth/types";
 import { AppConfig, configProvider } from "@src/utils/config";
-import { extractRootTraceIdFromAmznTraceId, logger } from "@src/utils/logger";
+import { logger } from "@src/utils/logger";
 import { profilePerformanceEnd, profilePerformanceStart } from "@src/utils/performance";
 import { RequestContext, asyncLocalStorage } from "@src/utils/requestContext";
+import { extractRequestContextFromHeaders } from "@src/utils/requestScopedStorageWrapper";
 import NextAuth from "next-auth";
 import "next-auth/jwt";
 import { headers } from "next/headers";
@@ -25,9 +26,8 @@ export const { handlers, signIn, signOut, auth } = NextAuth(async () => {
   const config: AppConfig = await configProvider();
   const MAX_SESSION_AGE_SECONDS: number = config.MAX_SESSION_AGE_MINUTES * 60;
   const headerValues = await headers();
-  const traceId =
-    extractRootTraceIdFromAmznTraceId(headerValues.get("X-Amzn-Trace-Id") ?? "") ?? "undefined-request-id";
-  const requestContext: RequestContext = { traceId: traceId };
+
+  const requestContext: RequestContext = extractRequestContextFromHeaders(headerValues);
 
   return await asyncLocalStorage.run(requestContext, async () => {
     return {
@@ -58,7 +58,11 @@ export const { handlers, signIn, signOut, auth } = NextAuth(async () => {
           }
 
           if (response) {
-            const auditEvent: AuditEvent = createLoginAuditEvent(profile!.nhs_number, traceId, "Success");
+            const auditEvent: AuditEvent = createLoginAuditEvent(
+              profile!.nhs_number,
+              requestContext.traceId,
+              "Success",
+            );
             await sendAuditEvent(auditEvent);
           }
 
diff --git a/contract/fetch-eligibility-content.contract.ts b/contract/fetch-eligibility-content.contract.ts
@@ -81,7 +81,7 @@ pactWith({ consumer: "VitA", provider: "EliD", port: 1234, logLevel: "warn" }, (
     });
 
     it("fetches eligibility content successfully", async () => {
-      const response = await asyncLocalStorage.run({ traceId: vitaTraceId }, async () => {
+      const response = await asyncLocalStorage.run({ traceId: vitaTraceId, nextUrl: "" }, async () => {
         return await fetchEligibilityContent(mockNhsNumber);
       });
 
diff --git a/src/_lambda/content-cache-hydrator/handler.test.ts b/src/_lambda/content-cache-hydrator/handler.test.ts
@@ -258,7 +258,7 @@ describe("Lambda Handler", () => {
 
       await handler({}, contextWithRequestId);
 
-      expect(asyncLocalStorage.run).toHaveBeenCalledWith({ traceId: requestId }, expect.anything());
+      expect(asyncLocalStorage.run).toHaveBeenCalledWith({ traceId: requestId, nextUrl: "" }, expect.anything());
     });
 
     it("should only update one vaccine if vaccine name is set in inbound event", async () => {
diff --git a/src/_lambda/content-cache-hydrator/handler.ts b/src/_lambda/content-cache-hydrator/handler.ts
@@ -188,6 +188,7 @@ const runContentCacheHydrator = async (event: ContentCacheHydratorEvent) => {
 export const handler = async (event: object, context: Context): Promise<void> => {
   const requestContext: RequestContext = {
     traceId: context.awsRequestId,
+    nextUrl: "",
   };
 
   await asyncLocalStorage.run(requestContext, () => runContentCacheHydrator(event));
diff --git a/src/app/api/sso-to-nbs/route.ts b/src/app/api/sso-to-nbs/route.ts
@@ -1,10 +1,11 @@
 import { SSO_FAILURE_ROUTE } from "@src/app/sso-failure/constants";
 import { VaccineTypes } from "@src/models/vaccine";
 import { getNbsQueryParams, getSSOUrlToNBSForVaccine } from "@src/services/nbs/nbs-service";
-import { extractRootTraceIdFromAmznTraceId, logger } from "@src/utils/logger";
+import { logger } from "@src/utils/logger";
 import { getVaccineTypeFromLowercaseString } from "@src/utils/path";
 import { profilePerformanceEnd, profilePerformanceStart } from "@src/utils/performance";
 import { RequestContext, asyncLocalStorage } from "@src/utils/requestContext";
+import { extractRequestContextFromHeaders } from "@src/utils/requestScopedStorageWrapper";
 import { notFound, redirect } from "next/navigation";
 import { NextRequest } from "next/server";
 
@@ -14,9 +15,7 @@ const REDIRECT_TARGET_PARAM = "redirectTarget";
 const ApiSSONBSPerformanceMarker = "api-sso-nbs";
 
 export const GET = async (request: NextRequest) => {
-  const traceId =
-    extractRootTraceIdFromAmznTraceId(request?.headers?.get("X-Amzn-Trace-Id") ?? "") ?? "undefined-request-id";
-  const requestContext: RequestContext = { traceId: traceId };
+  const requestContext: RequestContext = extractRequestContextFromHeaders(request?.headers);
   await asyncLocalStorage.run(requestContext, async () => {
     let shouldReturnNotFound: boolean;
     let finalRedirectUrl: string;
diff --git a/src/app/api/sso/route.ts b/src/app/api/sso/route.ts
@@ -1,9 +1,10 @@
 import { signIn } from "@project/auth";
 import { NHS_LOGIN_PROVIDER_ID } from "@src/app/api/auth/[...nextauth]/provider";
 import { SSO_FAILURE_ROUTE } from "@src/app/sso-failure/constants";
-import { extractRootTraceIdFromAmznTraceId, logger } from "@src/utils/logger";
+import { logger } from "@src/utils/logger";
 import { profilePerformanceEnd, profilePerformanceStart } from "@src/utils/performance";
 import { RequestContext, asyncLocalStorage } from "@src/utils/requestContext";
+import { extractRequestContextFromHeaders } from "@src/utils/requestScopedStorageWrapper";
 import { redirect } from "next/navigation";
 import { NextRequest } from "next/server";
 
@@ -12,9 +13,8 @@ const ASSERTED_LOGIN_IDENTITY_PARAM = "assertedLoginIdentity";
 const ApiSSOPerformanceMarker = "api-sso";
 
 export const GET = async (request: NextRequest) => {
-  const traceId =
-    extractRootTraceIdFromAmznTraceId(request?.headers?.get("X-Amzn-Trace-Id") ?? "") ?? "undefined-request-id";
-  const requestContext: RequestContext = { traceId: traceId };
+  const requestContext: RequestContext = extractRequestContextFromHeaders(request?.headers);
+
   await asyncLocalStorage.run(requestContext, async () => {
     const assertedLoginIdentity: string | null = request.nextUrl.searchParams.get(ASSERTED_LOGIN_IDENTITY_PARAM);
 
diff --git a/src/middleware.ts b/src/middleware.ts
@@ -1,8 +1,9 @@
 import { auth } from "@project/auth";
 import { AppConfig, configProvider } from "@src/utils/config";
-import { extractRootTraceIdFromAmznTraceId, logger } from "@src/utils/logger";
+import { logger } from "@src/utils/logger";
 import { profilePerformanceEnd, profilePerformanceStart } from "@src/utils/performance";
 import { RequestContext, asyncLocalStorage } from "@src/utils/requestContext";
+import { extractRequestContextFromHeaders } from "@src/utils/requestScopedStorageWrapper";
 import { Session } from "next-auth";
 import { NextRequest, NextResponse } from "next/server";
 import { Logger } from "pino";
@@ -11,17 +12,19 @@ const log: Logger = logger.child({ module: "middleware" });
 const MiddlewarePerformanceMarker = "middleware";
 
 export async function middleware(request: NextRequest) {
-  const requestContext: RequestContext = {
-    traceId:
-      extractRootTraceIdFromAmznTraceId(request?.headers?.get("X-Amzn-Trace-Id") ?? "") ?? "undefined-request-id",
-  };
+  const requestContext: RequestContext = extractRequestContextFromHeaders(request?.headers);
 
   return await asyncLocalStorage.run(requestContext, () => middlewareWrapper(request));
 }
 
 const middlewareWrapper = async (request: NextRequest) => {
   profilePerformanceStart(MiddlewarePerformanceMarker);
   log.info({ context: { nextUrl: request.nextUrl.href } }, "Inspecting request");
+
+  // Add URL to request headers to make available for logging in the nodejs layer
+  const headers = new Headers(request.headers);
+  headers.set("nextUrl", request.nextUrl.href);
+
   const config: AppConfig = await configProvider();
 
   let response: NextResponse;
@@ -30,7 +33,7 @@ const middlewareWrapper = async (request: NextRequest) => {
     log.info({ context: { nextUrl: request.nextUrl.href } }, "Missing user session, redirecting to login");
     response = NextResponse.redirect(new URL(config.NHS_APP_REDIRECT_LOGIN_URL));
   } else {
-    response = NextResponse.next();
+    response = NextResponse.next({ headers });
   }
 
   profilePerformanceEnd(MiddlewarePerformanceMarker);
diff --git a/src/utils/auth/callbacks/get-token.ts b/src/utils/auth/callbacks/get-token.ts
@@ -3,8 +3,9 @@ import { retrieveApimCredentials } from "@src/utils/auth/apim/get-apim-access-to
 import { ApimAccessCredentials } from "@src/utils/auth/apim/types";
 import { ExpiresSoonAt, IdToken, MaxAgeInSeconds, NowInSeconds } from "@src/utils/auth/types";
 import { AppConfig } from "@src/utils/config";
-import { extractRootTraceIdFromAmznTraceId, logger } from "@src/utils/logger";
+import { logger } from "@src/utils/logger";
 import { RequestContext, asyncLocalStorage } from "@src/utils/requestContext";
+import { extractRequestContextFromHeaders } from "@src/utils/requestScopedStorageWrapper";
 import { Account, Profile } from "next-auth";
 import { JWT } from "next-auth/jwt";
 import { headers } from "next/headers";
@@ -27,9 +28,9 @@ const getToken = async (
   maxAgeInSeconds: MaxAgeInSeconds,
 ) => {
   const headerValues = await headers();
-  const traceId =
-    extractRootTraceIdFromAmznTraceId(headerValues?.get("X-Amzn-Trace-Id") ?? "") ?? "undefined-request-id";
-  const requestContext: RequestContext = { traceId: traceId };
+
+  const requestContext: RequestContext = extractRequestContextFromHeaders(headerValues);
+
   return await asyncLocalStorage.run(requestContext, async () => {
     if (!token) {
       log.error("getToken: No token available in jwt callback. Returning null");
diff --git a/src/utils/client-side-error-logger/client-side-error-logger.ts b/src/utils/client-side-error-logger/client-side-error-logger.ts
@@ -2,11 +2,16 @@
 
 import { ClientSideErrorTypes } from "@src/utils/constants";
 import { logger } from "@src/utils/logger";
+import { requestScopedStorageWrapper } from "@src/utils/requestScopedStorageWrapper";
 import { Logger } from "pino";
 
 const log: Logger = logger.child({ module: "client-side-error-logger" });
 
 const logClientSideError = async (clientSideErrorType: ClientSideErrorTypes): Promise<void> => {
+  return requestScopedStorageWrapper(logClientSideErrorAction, clientSideErrorType);
+};
+
+const logClientSideErrorAction = async (clientSideErrorType: ClientSideErrorTypes): Promise<void> => {
   log.error({ context: { clientSideErrorType: clientSideErrorType } }, "Client side error occurred");
 };
 
diff --git a/src/utils/logger.ts b/src/utils/logger.ts
@@ -75,6 +75,7 @@ const pinoLoggerForNode = () => {
     mixin() {
       return {
         traceId: asyncLocalStorage?.getStore()?.traceId,
+        nextUrl: asyncLocalStorage?.getStore()?.nextUrl,
         ...applicationContextFields,
       };
     },
diff --git a/src/utils/requestContext.ts b/src/utils/requestContext.ts
@@ -2,6 +2,7 @@ import { AsyncLocalStorage } from "async_hooks";
 
 export type RequestContext = {
   traceId: string;
+  nextUrl: string;
 };
 
 const asyncLocalStorage = new AsyncLocalStorage<RequestContext>();
diff --git a/src/utils/requestScopedStorageWrapper.ts b/src/utils/requestScopedStorageWrapper.ts
@@ -1,20 +1,24 @@
+/* eslint @typescript-eslint/no-explicit-any: 0 */
 import { extractRootTraceIdFromAmznTraceId } from "@src/utils/logger";
 import { RequestContext, asyncLocalStorage } from "@src/utils/requestContext";
 import { headers } from "next/headers";
-import { JSX } from "react";
 
 async function requestScopedStorageWrapper<A extends unknown[]>(
-  wrappedFunction: (...args: A) => Promise<JSX.Element>,
+  wrappedFunction: (...args: A) => Promise<any>,
   ...args: A
 ) {
   const requestHeaders = await headers();
-  const traceId =
-    extractRootTraceIdFromAmznTraceId(requestHeaders.get("X-Amzn-Trace-Id") ?? "") ?? "undefined-request-id";
-  const requestContext: RequestContext = { traceId: traceId };
+  const requestContext = extractRequestContextFromHeaders(requestHeaders);
 
   return asyncLocalStorage.run(requestContext, () => {
     return wrappedFunction(...args);
   });
 }
 
-export { requestScopedStorageWrapper };
+const extractRequestContextFromHeaders = (headers: Headers): RequestContext => {
+  const traceId = extractRootTraceIdFromAmznTraceId(headers?.get("X-Amzn-Trace-Id") ?? "") ?? "undefined-request-id";
+  const nextUrl = headers?.get("nextUrl") ?? "";
+  return { traceId: traceId, nextUrl: nextUrl };
+};
+
+export { requestScopedStorageWrapper, extractRequestContextFromHeaders };
