Fix and enhancement for Next 16 (#1029)

conico974 · vicb · web-flow · commit 89336e450b45 · 2025-11-05T22:07:34.000+01:00
* fix build and bump next version

* make page router build

* fix app router

* fix app-pages-router

* fix e2e locally

* handle segments during cache generation

* fix segment data prefetching with default Next

* Make segment prefetching works with cache interception

* linting

* fix interceptor

* changeset

* review fix

* bump to 20

* some fix for flaky e2e test

* review

* fixup! lock file 16.0.1

---------

Co-authored-by: Victor Berchet &lt;victor@suumit.com&gt;
diff --git a/.changeset/thirty-bears-tell.md b/.changeset/thirty-bears-tell.md
@@ -0,0 +1,5 @@
+---
+"@opennextjs/aws": minor
+---
+
+Add support for Next 16
diff --git a/.github/actions/setup/action.yml b/.github/actions/setup/action.yml
@@ -3,7 +3,7 @@ description: Install's node, pnpm, restores cache, and then installs dependencie
 
 inputs:
   node-version:
-    default: 18.x
+    default: 20.x
   registry-url:
     default: "https://registry.npmjs.org"
 
diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml
@@ -96,7 +96,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           cache: pnpm # cache pnpm store
-          node-version: 18.18.2
+          node-version: 20.x
 
       - name: Install packages
         run: pnpm install
diff --git a/examples/app-pages-router/next.config.ts b/examples/app-pages-router/next.config.ts
@@ -3,12 +3,7 @@ import type { NextConfig } from "next";
 const nextConfig: NextConfig = {
   poweredByHeader: false,
   cleanDistDir: true,
-  transpilePackages: ["@example/shared"],
   output: "standalone",
-  // outputFileTracingRoot: "../sst",
-  eslint: {
-    ignoreDuringBuilds: true,
-  },
   trailingSlash: true,
   skipTrailingSlashRedirect: true,
 };
diff --git a/examples/app-pages-router/on-proxy.ts b/examples/app-pages-router/on-proxy.ts
diff --git a/examples/app-pages-router/open-next.config.local.ts b/examples/app-pages-router/open-next.config.local.ts
@@ -29,6 +29,9 @@ export default {
     },
     loader: "fs-dev",
   },
+  dangerous: {
+    enableCacheInterception: true,
+  },
   // You can override the build command here so that you don't have to rebuild next every time you make a change
-  //buildCommand: "echo 'No build command'",
+  // buildCommand: "echo 'No build command'",
 } satisfies OpenNextConfig;
diff --git a/examples/app-pages-router/package.json b/examples/app-pages-router/package.json
@@ -5,7 +5,7 @@
   "scripts": {
     "openbuild": "node ../../packages/open-next/dist/index.js build --build-command \"npx turbo build\"",
     "openbuild:local": "node ../../packages/open-next/dist/index.js build --config-path open-next.config.local.ts",
-    "openbuild:local:start": "PORT=3003 tsx proxy.ts",
+    "openbuild:local:start": "PORT=3003 tsx on-proxy.ts",
     "dev": "next dev --turbopack --port 3003",
     "build": "next build",
     "start": "next start --port 3003",
diff --git a/examples/app-pages-router/tsconfig.json b/examples/app-pages-router/tsconfig.json
@@ -12,7 +12,7 @@
     "moduleResolution": "NodeNext",
     "resolveJsonModule": true,
     "isolatedModules": true,
-    "jsx": "preserve",
+    "jsx": "react-jsx",
     "incremental": true,
     "plugins": [
       {
@@ -23,11 +23,17 @@
       "@/*": ["./*"]
     }
   },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts",
+    ".next/dev/types/**/*.ts"
+  ],
   "exclude": [
     "node_modules",
     "open-next.config.ts",
     "open-next.config.local.ts",
-    "proxy.ts"
+    "on-proxy.ts"
   ]
 }
diff --git a/examples/app-router/app/api/after/revalidate/route.ts b/examples/app-router/app/api/after/revalidate/route.ts
@@ -6,7 +6,10 @@ export function POST() {
     () =>
       new Promise<void>((resolve) =>
         setTimeout(() => {
-          revalidateTag("date");
+          revalidateTag("date", {
+            // We want to expire the "date" tag immediately
+            expire: 0,
+          });
           resolve();
         }, 5000),
       ),
diff --git a/examples/app-router/app/api/after/ssg/route.ts b/examples/app-router/app/api/after/ssg/route.ts
@@ -4,9 +4,13 @@ import { NextResponse } from "next/server";
 export const dynamic = "force-static";
 
 export async function GET() {
-  const dateFn = unstable_cache(() => new Date().toISOString(), ["date"], {
-    tags: ["date"],
-  });
+  const dateFn = unstable_cache(
+    async () => new Date().toISOString(),
+    ["date"],
+    {
+      tags: ["date"],
+    },
+  );
   const date = await dateFn();
   return NextResponse.json({ date });
 }
diff --git a/examples/app-router/app/api/revalidate-tag/route.ts b/examples/app-router/app/api/revalidate-tag/route.ts
@@ -3,7 +3,7 @@ import { revalidateTag } from "next/cache";
 export const dynamic = "force-dynamic";
 
 export async function GET() {
-  revalidateTag("revalidate");
+  revalidateTag("revalidate", { expire: 0 });
 
   return new Response("ok");
 }
diff --git a/examples/app-router/app/isr-data-cache/page.tsx b/examples/app-router/app/isr-data-cache/page.tsx
@@ -4,7 +4,7 @@ async function getTime() {
   return new Date().toISOString();
 }
 
-const cachedTime = unstable_cache(getTime, { revalidate: false });
+const cachedTime = unstable_cache(getTime, ["getTime"], { revalidate: false });
 
 export const revalidate = 10;
 
diff --git a/examples/app-router/app/og/opengraph-image.tsx b/examples/app-router/app/og/opengraph-image.tsx
@@ -31,6 +31,9 @@ export default async function Image() {
       // For convenience, we can re-use the exported opengraph-image
       // size config to also set the ImageResponse's width and height.
       ...size,
+      headers: {
+        "cache-control": "public, immutable, no-transform, max-age=31536000",
+      },
     },
   );
 }
diff --git a/examples/app-router/proxy.ts b/examples/app-router/proxy.ts
@@ -1,7 +1,7 @@
 import type { NextRequest } from "next/server";
 import { NextResponse } from "next/server";
 
-export function middleware(request: NextRequest) {
+export default function proxy(request: NextRequest) {
   const path = request.nextUrl.pathname; //new URL(request.url).pathname;
 
   const host = request.headers.get("host");
diff --git a/examples/app-router/tsconfig.json b/examples/app-router/tsconfig.json
@@ -12,7 +12,7 @@
     "moduleResolution": "NodeNext",
     "resolveJsonModule": true,
     "isolatedModules": true,
-    "jsx": "preserve",
+    "jsx": "react-jsx",
     "incremental": true,
     "plugins": [
       {
@@ -23,7 +23,13 @@
       "@/*": ["./*"]
     }
   },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts",
+    ".next/dev/types/**/*.ts"
+  ],
   "exclude": [
     "node_modules",
     "open-next.config.ts",
diff --git a/examples/pages-router/next.config.ts b/examples/pages-router/next.config.ts
@@ -9,10 +9,6 @@ const nextConfig: NextConfig = {
   cleanDistDir: true,
   reactStrictMode: true,
   output: "standalone",
-  // outputFileTracingRoot: "../sst",
-  eslint: {
-    ignoreDuringBuilds: true,
-  },
   headers: async () => [
     {
       source: "/",
diff --git a/examples/pages-router/src/middleware.ts b/examples/pages-router/src/middleware.ts
@@ -8,6 +8,8 @@ export function middleware(request: NextRequest) {
   return NextResponse.next({
     headers: {
       "x-from-middleware": "true",
+      // We need to disable caching in cloudfront to ensure we always hit the origin for this test
+      "cache-control": "private, no-store",
     },
   });
 }
diff --git a/examples/pages-router/tsconfig.json b/examples/pages-router/tsconfig.json
@@ -12,7 +12,7 @@
     "moduleResolution": "NodeNext",
     "resolveJsonModule": true,
     "isolatedModules": true,
-    "jsx": "preserve",
+    "jsx": "react-jsx",
     "incremental": true,
     "baseUrl": ".",
     "paths": {
diff --git a/examples/sst/stacks/OpenNextReferenceImplementation.ts b/examples/sst/stacks/OpenNextReferenceImplementation.ts
@@ -189,7 +189,7 @@ export class OpenNextCdkReferenceImplementation extends Construct {
         code: Code.fromAsset(
           path.join(this.openNextBasePath, ".open-next/dynamodb-provider"),
         ),
-        runtime: Runtime.NODEJS_18_X,
+        runtime: Runtime.NODEJS_20_X,
         timeout: Duration.minutes(15),
         memorySize: 128,
         environment: {
@@ -293,7 +293,7 @@ export class OpenNextCdkReferenceImplementation extends Construct {
             "",
         ),
       ),
-      runtime: Runtime.NODEJS_18_X,
+      runtime: Runtime.NODEJS_20_X,
       timeout: Duration.seconds(30),
     });
     consumer.addEventSource(
@@ -330,7 +330,7 @@ export class OpenNextCdkReferenceImplementation extends Construct {
     const environment = this.getEnvironment();
     const fn = new CdkFunction(this, `${key}Function`, {
       architecture: Architecture.ARM_64,
-      runtime: Runtime.NODEJS_18_X,
+      runtime: Runtime.NODEJS_20_X,
       handler: origin.handler,
       code: Code.fromAsset(path.join(this.openNextBasePath, origin.bundle)),
       environment,
diff --git a/package.json b/package.json
@@ -7,6 +7,8 @@
   "scripts": {
     "dev": "turbo run dev",
     "build": "turbo run build",
+    "openbuild:local": "turbo run openbuild:local",
+    "openbuild:local:start": "turbo run openbuild:local:start",
     "clean": "turbo run clean && rm -rf node_modules pnpm-lock.yaml",
     "lint": "biome check",
     "lint:fix": "biome check --fix",
diff --git a/packages/open-next/src/adapters/cache.ts b/packages/open-next/src/adapters/cache.ts
@@ -148,6 +148,14 @@ export default class Cache {
       }
       if (cacheData?.type === "page" || cacheData?.type === "app") {
         if (globalThis.isNextAfter15 && cacheData?.type === "app") {
+          const segmentData = new Map<string, Buffer>();
+          if (cacheData.segmentData) {
+            for (const [segmentPath, segmentContent] of Object.entries(
+              cacheData.segmentData ?? {},
+            )) {
+              segmentData.set(segmentPath, Buffer.from(segmentContent));
+            }
+          }
           return {
             lastModified: _lastModified,
             value: {
@@ -157,6 +165,7 @@ export default class Cache {
               status: meta?.status,
               headers: meta?.headers,
               postponed: meta?.postponed,
+              segmentData,
             },
           } as CacheHandlerValue;
         }
diff --git a/packages/open-next/src/adapters/plugins/image-optimization/image-optimization.replacement.ts b/packages/open-next/src/adapters/plugins/image-optimization/image-optimization.replacement.ts
@@ -27,7 +27,9 @@ export async function optimizeImage(
   const { isAbsolute, href } = imageParams;
 
   const imageUpstream = isAbsolute
-    ? await fetchExternalImage(href)
+    ? //@ts-expect-error - fetchExternalImage signature has changed in Next.js 16, it has an extra boolean parameter.
+      // https://github.com/vercel/next.js/blob/bfe2ab4/packages/next/src/server/image-optimizer.ts#L711
+      await fetchExternalImage(href)
     : await fetchInternalImage(
         href,
         // @ts-expect-error - It is supposed to be an IncomingMessage object, but only the headers are used.
diff --git a/packages/open-next/src/build/copyTracedFiles.ts b/packages/open-next/src/build/copyTracedFiles.ts
@@ -260,6 +260,7 @@ File ${serverPath} does not exist
 
   // Only files that are actually copied
   const tracedFiles: string[] = [];
+  const erroredFiles: string[] = [];
   //Actually copy the files
   filesToCopy.forEach((to, from) => {
     // We don't want to copy excluded packages (e.g. sharp)
@@ -285,7 +286,15 @@ File ${serverPath} does not exist
         }
       }
     } else {
-      copyFileSync(from, to);
+      // Adding this inside a try-catch to handle errors on Next 16+
+      // where some files listed in the .nft.json might not be present in the standalone folder
+      // TODO: investigate that further - is it expected?
+      try {
+        copyFileSync(from, to);
+      } catch (e) {
+        logger.debug("Error copying file:", e);
+        erroredFiles.push(to);
+      }
     }
   });
 
@@ -383,7 +392,7 @@ File ${serverPath} does not exist
   logger.debug("copyTracedFiles:", Date.now() - tsStart, "ms");
 
   return {
-    tracedFiles,
+    tracedFiles: tracedFiles.filter((f) => !erroredFiles.includes(f)),
     nodePackages,
     manifests,
   };
diff --git a/packages/open-next/src/build/createAssets.ts b/packages/open-next/src/build/createAssets.ts
@@ -105,6 +105,10 @@ export function createCacheAssets(options: buildHelper.BuildOptions) {
   const isFileSkipped = (relativePath: string) =>
     relativePath.endsWith(".js") ||
     relativePath.endsWith(".js.nft.json") ||
+    // We skip manifest files as well
+    relativePath.endsWith("-manifest.json") ||
+    // We skip the segment rsc files as they are treated in a different way
+    relativePath.endsWith(".segment.rsc") ||
     (relativePath.endsWith(".html") && htmlPages.has(relativePath));
 
   // Merge cache files into a single file
@@ -169,6 +173,23 @@ export function createCacheAssets(options: buildHelper.BuildOptions) {
       logger.warn(`Skipping invalid cache file: ${cacheFilePath}`);
       return;
     }
+
+    // If we have a meta file, and it contains segmentPaths, we need to add them to the cache file
+    const segments: Record<string, string> = Array.isArray(
+      cacheFileMeta?.segmentPaths,
+    )
+      ? Object.fromEntries(
+          cacheFileMeta!.segmentPaths.map((segmentPath: string) => {
+            const absoluteSegmentPath = path.join(
+              files.meta!.replace(/\.meta$/, ".segments"),
+              `${segmentPath}.segment.rsc`,
+            );
+            const segmentContent = fs.readFileSync(absoluteSegmentPath, "utf8");
+            return [segmentPath, segmentContent];
+          }),
+        )
+      : {};
+
     const cacheFileContent = {
       type: files.body ? "route" : files.json ? "page" : "app",
       meta: cacheFileMeta,
@@ -184,6 +205,7 @@ export function createCacheAssets(options: buildHelper.BuildOptions) {
                 : "utf8",
             )
         : undefined,
+      segmentData: Object.keys(segments).length > 0 ? segments : undefined,
     };
 
     // Ensure directory exists before writing
diff --git a/packages/open-next/src/core/routing/cacheInterceptor.ts b/packages/open-next/src/core/routing/cacheInterceptor.ts
diff --git a/packages/open-next/src/types/overrides.ts b/packages/open-next/src/types/overrides.ts
diff --git a/packages/tests-e2e/tests/appRouter/og.test.ts b/packages/tests-e2e/tests/appRouter/og.test.ts
diff --git a/packages/tests-e2e/tests/pagesRouter/amp.test.ts b/packages/tests-e2e/tests/pagesRouter/amp.test.ts
diff --git a/packages/tests-e2e/tests/pagesRouter/data.test.ts b/packages/tests-e2e/tests/pagesRouter/data.test.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
diff --git a/turbo.json b/turbo.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@opennextjs/aws": minor
 +---
++
 +Add support for Next 16