Add OpenNext version header only in debug mode (#274)

* Add OpenNext version header only in debug mode

* Sync

* Sync

Author: fwang

.changeset/smooth-snakes-tease.md

@@ -0,0 +1,5 @@
+---
+"open-next": patch
+---
+
+Add OpenNext version header only in debug mode

packages/open-next/src/adapters/logger.ts

@@ -1,5 +1,9 @@
+declare global {
+  var openNextDebug: boolean;
+}
+
 export function debug(...args: any[]) {
-  if (process.env.OPEN_NEXT_DEBUG) {
+  if (globalThis.openNextDebug) {
     console.log(...args);
   }
 }

packages/open-next/src/adapters/plugins/routing/util.ts

@@ -6,6 +6,11 @@ import { IncomingMessage } from "../../http/request.js";
 import { ServerlessResponse } from "../../http/response.js";
 import { awsLogger, debug } from "../../logger.js";
 
+declare global {
+  var openNextDebug: boolean;
+  var openNextVersion: string;
+}
+
 enum CommonHeaders {
   CACHE_CONTROL = "cache-control",
 }
@@ -73,7 +78,10 @@ export function fixSWRCacheHeader(
 }
 
 export function addOpenNextHeader(headers: Record<string, string | undefined>) {
-  headers["X-OpenNext"] = process.env.OPEN_NEXT_VERSION;
+  headers["X-OpenNext"] = "1";
+  if (globalThis.openNextDebug) {
+    headers["X-OpenNext-Version"] = globalThis.openNextVersion;
+  }
 }
 
 export async function revalidateIfRequired(

packages/open-next/src/build.ts

@@ -744,11 +744,14 @@ function addCacheHandler(outputPath: string, options?: DangerousOptions) {
     target: ["node18"],
     format: "cjs",
     banner: {
-      js: `globalThis.disableIncrementalCache = ${
-        options?.disableIncrementalCache ?? false
-      }; globalThis.disableDynamoDBCache = ${
-        options?.disableDynamoDBCache ?? false
-      };`,
+      js: [
+        `globalThis.disableIncrementalCache = ${
+          options?.disableIncrementalCache ?? false
+        };`,
+        `globalThis.disableDynamoDBCache = ${
+          options?.disableDynamoDBCache ?? false
+        };`,
+      ].join(""),
     },
   });
 }
@@ -767,12 +770,13 @@ function esbuildSync(esbuildOptions: ESBuildOptions) {
     minify: debug ? false : true,
     sourcemap: debug ? "inline" : false,
     ...esbuildOptions,
-    define: {
-      ...esbuildOptions.define,
-      "process.env.OPEN_NEXT_DEBUG": process.env.OPEN_NEXT_DEBUG
-        ? "true"
-        : "false",
-      "process.env.OPEN_NEXT_VERSION": `"${openNextVersion}"`,
+    banner: {
+      ...esbuildOptions.banner,
+      js: [
+        esbuildOptions.banner?.js || "",
+        `globalThis.openNextDebug = ${process.env.OPEN_NEXT_DEBUG ?? false};`,
+        `globalThis.openNextVersion = ${openNextVersion};`,
+      ].join(""),
     },
   });
 
@@ -796,13 +800,13 @@ async function esbuildAsync(esbuildOptions: ESBuildOptions) {
     minify: debug ? false : true,
     sourcemap: debug ? "inline" : false,
     ...esbuildOptions,
-    // "process.env.OPEN_NEXT_DEBUG" determines if the logger writes to console.log
-    define: {
-      ...esbuildOptions.define,
-      "process.env.OPEN_NEXT_DEBUG": process.env.OPEN_NEXT_DEBUG
-        ? "true"
-        : "false",
-      "process.env.OPEN_NEXT_VERSION": `"${openNextVersion}"`,
+    banner: {
+      ...esbuildOptions.banner,
+      js: [
+        esbuildOptions.banner?.js || "",
+        `globalThis.openNextDebug = ${process.env.OPEN_NEXT_DEBUG ?? false};`,
+        `globalThis.openNextVersion = ${openNextVersion};`,
+      ].join(""),
     },
   });