server: add OpenNext response header to track version

sst · Jun 28, 2023 · 1bcb37b · 1bcb37b · vercel · Jun 28, 2023
1 parent e7c732b
commit 1bcb37b
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/.changeset/fluffy-trains-fry.md b/.changeset/fluffy-trains-fry.md
@@ -0,0 +1,5 @@
+---
+"open-next": patch
+---
+
+server: add OpenNext response header to track version
diff --git a/packages/open-next/src/adapters/server-adapter.ts b/packages/open-next/src/adapters/server-adapter.ts
@@ -132,6 +132,7 @@ export async function handler(
 
   fixCacheHeaderForHtmlPages(internalEvent.rawPath, headers);
   fixSWRCacheHeader(headers);
+  addOpenNextHeader(headers);
   await revalidateIfRequired(
     internalEvent.headers.host,
     internalEvent.rawPath,
@@ -255,6 +256,10 @@ function fixSWRCacheHeader(headers: Record<string, string | undefined>) {
   }
 }
 
+function addOpenNextHeader(headers: Record<string, string | undefined>) {
+  headers["X-OpenNext"] = process.env.OPEN_NEXT_VERSION;
+}
+
 async function revalidateIfRequired(
   host: string,
   rawPath: string,

diff --git a/packages/open-next/src/build.ts b/packages/open-next/src/build.ts
@@ -71,6 +71,7 @@ function normalizeOptions(opts: BuildOptions) {
   const appPath = process.cwd();
   const outputDir = ".open-next";
   return {
+    openNextVersion: getOpenNextVersion(),
     appPath,
     appPublicPath: path.join(appPath, "public"),
     outputDir,
@@ -167,8 +168,8 @@ function printNextjsVersion() {
 }
 
 function printOpenNextVersion() {
-  const onVersion = require(path.join(__dirname, "../package.json")).version;
-  console.info(`OpenNext v${onVersion}`);
+  const { openNextVersion } = options;
+  console.info(`OpenNext v${openNextVersion}`);
 }
 
 function initOutputDir() {
@@ -526,7 +527,7 @@ function addCacheHandler(outputPath: string) {
 /********************/
 
 function esbuildSync(esbuildOptions: ESBuildOptions) {
-  const { appPath, debug } = options;
+  const { openNextVersion, debug } = options;
   const result = buildSync({
     target: "esnext",
     format: "esm",
@@ -541,6 +542,7 @@ function esbuildSync(esbuildOptions: ESBuildOptions) {
       "process.env.OPEN_NEXT_DEBUG": process.env.OPEN_NEXT_DEBUG
         ? "true"
         : "false",
+      "process.env.OPEN_NEXT_VERSION": `"${openNextVersion}"`,
     },
   });
 
@@ -601,3 +603,7 @@ function getBuildId(dotNextPath: string) {
     .readFileSync(path.join(dotNextPath, ".next/BUILD_ID"), "utf-8")
     .trim();
 }
+
+function getOpenNextVersion() {
+  return require(path.join(__dirname, "../package.json")).version;
+}