Make NEXT_BUILD_ID and NEXT_PREVIEW_MODE_ID always available on `… (#1044)

Author: vicb

.changeset/thick-windows-fetch.md

@@ -0,0 +1,5 @@
+---
+"@opennextjs/aws": patch
+---
+
+Make `NEXT_BUILD_ID` and `NEXT_PREVIEW_MODE_ID` always available on `process.env`

packages/open-next/src/adapters/config/index.ts

@@ -40,3 +40,6 @@ export const AppPathRoutesManifest =
 
 export const FunctionsConfigManifest =
   /* @__PURE__ */ loadFunctionsConfigManifest(NEXT_DIR);
+
+process.env.NEXT_BUILD_ID = BuildId;
+process.env.NEXT_PREVIEW_MODE_ID = PrerenderManifest?.preview?.previewModeId;

packages/open-next/src/adapters/config/util.ts

@@ -76,10 +76,15 @@ export function loadConfigHeaders(nextDir: string) {
   return routesManifest.headers;
 }
 
-export function loadPrerenderManifest(nextDir: string) {
+export function loadPrerenderManifest(
+  nextDir: string,
+): PrerenderManifest | undefined {
   const filePath = path.join(nextDir, "prerender-manifest.json");
+  if (!fs.existsSync(filePath)) {
+    return undefined;
+  }
   const json = fs.readFileSync(filePath, "utf-8");
-  return JSON.parse(json) as PrerenderManifest;
+  return JSON.parse(json);
 }
 
 export function loadAppPathsManifest(nextDir: string) {

packages/open-next/src/adapters/server-adapter.ts

@@ -1,14 +1,9 @@
-// We load every config here so that they are only loaded once
-// and during cold starts
-import { BuildId } from "config/index.js";
-
 import { createMainHandler } from "../core/createMainHandler.js";
 import { setNodeEnv } from "./util.js";
 
 // We load every config here so that they are only loaded once
 // and during cold starts
 setNodeEnv();
-setBuildIdEnv();
 setNextjsServerWorkingDirectory();
 
 // Because next is messing with fetch, we have to make sure that we use an untouched version of fetch
@@ -29,9 +24,3 @@ function setNextjsServerWorkingDirectory() {
   // See https://opennext.js.org/aws/v2/advanced/workaround#workaround-set-nextserver-working-directory-aws-specific
   process.chdir(__dirname);
 }
-
-function setBuildIdEnv() {
-  // This allows users to access the CloudFront invalidating path when doing on-demand
-  // invalidations. ie. `/_next/data/${process.env.NEXT_BUILD_ID}/foo.json`
-  process.env.NEXT_BUILD_ID = BuildId;
-}

packages/open-next/src/build/copyTracedFiles.ts

@@ -362,7 +362,7 @@ File ${serverPath} does not exist
     const staticFiles: Array<string> = Object.values(pagesManifest);
     // Then we need to get all fallback: true dynamic routes html
     const locales = config.i18n?.locales;
-    Object.values(prerenderManifest.dynamicRoutes).forEach((route) => {
+    Object.values(prerenderManifest?.dynamicRoutes ?? {}).forEach((route) => {
       if (typeof route.fallback === "string") {
         if (locales) {
           locales.forEach((locale) => {

packages/open-next/src/core/routing/cacheInterceptor.ts

@@ -42,7 +42,7 @@ async function computeCacheControl(
 ) {
   let finalRevalidate = CACHE_ONE_YEAR;
 
-  const existingRoute = Object.entries(PrerenderManifest.routes).find(
+  const existingRoute = Object.entries(PrerenderManifest?.routes ?? {}).find(
     (p) => p[0] === path,
   )?.[1];
   if (revalidate === undefined && existingRoute) {
@@ -259,8 +259,10 @@ export async function cacheInterceptor(
   debug("Checking cache for", localizedPath, PrerenderManifest);
 
   const isISR =
-    Object.keys(PrerenderManifest.routes).includes(localizedPath ?? "/") ||
-    Object.values(PrerenderManifest.dynamicRoutes).some((dr) =>
+    Object.keys(PrerenderManifest?.routes ?? {}).includes(
+      localizedPath ?? "/",
+    ) ||
+    Object.values(PrerenderManifest?.dynamicRoutes ?? {}).some((dr) =>
       new RegExp(dr.routeRegex).test(localizedPath),
     );
   debug("isISR", isISR);

packages/open-next/src/core/routing/matcher.ts

@@ -422,10 +422,10 @@ export function fixDataPage(
 
 export function handleFallbackFalse(
   internalEvent: InternalEvent,
-  prerenderManifest: PrerenderManifest,
+  prerenderManifest?: PrerenderManifest,
 ): { event: InternalEvent; isISR: boolean } {
   const { rawPath } = internalEvent;
-  const { dynamicRoutes, routes } = prerenderManifest;
+  const { dynamicRoutes = {}, routes = {} } = prerenderManifest ?? {};
   const prerenderedFallbackRoutes = Object.entries(dynamicRoutes).filter(
     ([, { fallback }]) => fallback === false,
   );

packages/open-next/src/core/routing/middleware.ts

@@ -60,7 +60,7 @@ export async function handleMiddleware(
   if (
     headers["x-isr"] &&
     headers["x-prerender-revalidate"] ===
-      PrerenderManifest.preview.previewModeId
+      PrerenderManifest?.preview?.previewModeId
   )
     return internalEvent;
 

packages/open-next/src/plugins/edge.ts

@@ -194,8 +194,8 @@ ${contents}
   export const FunctionsConfigManifest = ${JSON.stringify(FunctionsConfigManifest)};
   export const PagesManifest = ${JSON.stringify(PagesManifest)};
 
-
   process.env.NEXT_BUILD_ID = BuildId;
+  process.env.NEXT_PREVIEW_MODE_ID = PrerenderManifest?.preview?.previewModeId;
 `;
           return { contents };
         },