Merge pull request #599 from PRX/feat/598-log-all-requests-responses

598: log all requests and responses

Author: rpeterman-gp

next.config.ts

@@ -7,6 +7,7 @@ const nextConfig: NextConfig = withPlausibleProxy({
 })({
   output: "standalone",
   trailingSlash: false,
+  skipProxyUrlNormalize: true,
   redirects,
   experimental: {
     turbopackFileSystemCacheForDev: false,

src/app/(main)/@hero/[...alias]/page.tsx

@@ -35,7 +35,7 @@ export default async function PageHero({
     resourceType = undefined;
   }
 
-  if (resourceType !== "post--page") {
+  if (!resourceId || resourceType !== "post--page") {
     return null;
   }
 

src/app/(main)/episodes/page.tsx

@@ -64,8 +64,6 @@ export default async function EpisodesPage({
   };
   const whereArgs = convertSearchFiltersToWhereArgs(searchFilters);
 
-  console.warn(whereArgs);
-
   const data = await getCachedEpisodes({
     first: 60,
     where: {

src/hooks/useLocalStorage.ts

@@ -54,6 +54,7 @@ export function useLocalStorage<T>(key: string, initialValue?: T) {
           setLocalStorageItem(key, nextState);
         }
       } catch (e) {
+        // There was a problem parsing local storage data. This should not halt. Log as a warning.
         console.warn(e);
       }
     },

src/instrumentation.ts

@@ -4,7 +4,8 @@ import { PinoTransport } from "@loglayer/transport-pino";
 import pino from "pino";
 import { serializeError } from "serialize-error";
 
-const deploymentEnv = process.env.NODE_ENV || "development";
+const deploymentEnv =
+  process.env.PRX_ENVIRONMENT || process.env.NODE_ENV || "development";
 
 function stripAnsiCodes(str: string): string {
   // This regex matches all ANSI escape sequences that next.js likes to put in the console logs
@@ -89,6 +90,14 @@ export async function register() {
               },
             },
           }),
+          redact: [
+            "cookie",
+            "cookies",
+            "request.cookie",
+            "request.cookies",
+            "request.*.cookie",
+            "request.*.cookies",
+          ],
         }),
       }),
     ],

src/proxy.ts

@@ -2,7 +2,42 @@ import { SFContentTypeEnum } from "@/gen/search_filters_pb";
 import { encodeContentSearchFiltersParam } from "@/lib/util/binaryData";
 import { type NextRequest, NextResponse, type ProxyConfig } from "next/server";
 
+const deploymentEnv =
+  process.env.PRX_ENVIRONMENT || process.env.NODE_ENV || "development";
+
+function logger(
+  request: NextRequest,
+  response: NextResponse | Response,
+  requestedAt: Temporal.Instant,
+) {
+  const requestUrl = request.nextUrl.clone();
+  const now = Temporal.Now.instant();
+  const responseDuration = now.since(requestedAt);
+
+  console.log("Proxy Logger", {
+    totalTime: responseDuration.milliseconds,
+    request: {
+      path: requestUrl.pathname,
+      searchParams: requestUrl.searchParams.toString(),
+      method: request.method,
+      headers: request.headers
+        .entries()
+        // biome-ignore lint/performance/noAccumulatingSpread: Fine for now.
+        .reduce((acc, [k, v]) => ({ ...acc, [k]: v }), {}),
+    },
+    response: {
+      status: response.status,
+      statusText: response.statusText,
+      headers: response.headers
+        .entries()
+        // biome-ignore lint/performance/noAccumulatingSpread: Fine for now.
+        .reduce((acc, [k, v]) => ({ ...acc, [k]: v }), {}),
+    },
+  });
+}
+
 export async function proxy(request: NextRequest) {
+  const requestedAt = Temporal.Now.instant();
   const url = request.nextUrl.clone();
 
   /**
@@ -17,7 +52,11 @@ export async function proxy(request: NextRequest) {
     url.searchParams.set("sf", sf);
     url.searchParams.delete("v");
 
-    return NextResponse.redirect(url);
+    const response = NextResponse.redirect(url);
+
+    logger(request, response, requestedAt);
+
+    return response;
   }
 
   /**
@@ -33,7 +72,11 @@ export async function proxy(request: NextRequest) {
 
     url.pathname = newPath;
 
-    return NextResponse.redirect(url);
+    const response = NextResponse.redirect(url);
+
+    logger(request, response, requestedAt);
+
+    return response;
   }
 
   /**
@@ -52,13 +95,17 @@ export async function proxy(request: NextRequest) {
     }
 
     if (!isImageUrlOk) {
-      return Response.json(
+      const response = Response.json(
         {
           success: false,
           message: `Source image not accessible: ${imageApiUrl}`,
         },
         { status: 422 },
       );
+
+      logger(request, response, requestedAt);
+
+      return response;
     }
   }
 
@@ -136,6 +183,10 @@ export async function proxy(request: NextRequest) {
     }
   }
 
+  if (deploymentEnv !== "development") {
+    logger(request, response, requestedAt);
+  }
+
   return response;
 }