Sync with latest @opennextjs/aws

Author: vicb

examples/e2e/app-router/app/isr-data-cache/page.tsx

@@ -0,0 +1,28 @@
+import { unstable_cache } from "next/cache";
+
+async function getTime() {
+  return new Date().toISOString();
+}
+
+const cachedTime = unstable_cache(getTime, { revalidate: false });
+
+export const revalidate = 10;
+
+export default async function ISR() {
+  const responseOpenNext = await fetch("https://opennext.js.org", {
+    cache: "force-cache",
+  });
+  const dateInOpenNext = responseOpenNext.headers.get("date");
+  const cachedTimeValue = await cachedTime();
+  const time = getTime();
+  return (
+    <div>
+      <h1>Date from from OpenNext</h1>
+      <p data-testid="fetched-date">Date from from OpenNext: {dateInOpenNext}</p>
+      <h1>Cached Time</h1>
+      <p data-testid="cached-date">Cached Time: {cachedTimeValue}</p>
+      <h1>Time</h1>
+      <p data-testid="time">Time: {time}</p>
+    </div>
+  );
+}

examples/e2e/app-router/e2e/isr.test.ts

@@ -61,3 +61,31 @@ test("headers", async ({ page }) => {
     await page.reload();
   }
 });
+
+test("Incremental Static Regeneration with data cache", async ({ page }) => {
+  test.setTimeout(45000);
+  await page.goto("/isr-data-cache");
+
+  const originalFetchedDate = await page.getByTestId("fetched-date").textContent();
+  const originalCachedDate = await page.getByTestId("cached-date").textContent();
+  const originalTime = await page.getByTestId("time").textContent();
+  await page.reload();
+
+  let finalTime = originalTime;
+  let finalCachedDate = originalCachedDate;
+  let finalFetchedDate = originalFetchedDate;
+
+  // Wait 10 + 1 seconds for ISR to regenerate time
+  await page.waitForTimeout(11000);
+  do {
+    await page.waitForTimeout(2000);
+    finalTime = await page.getByTestId("time").textContent();
+    finalCachedDate = await page.getByTestId("cached-date").textContent();
+    finalFetchedDate = await page.getByTestId("fetched-date").textContent();
+    await page.reload();
+  } while (originalTime === finalTime);
+
+  expect(originalTime).not.toEqual(finalTime);
+  expect(originalCachedDate).toEqual(finalCachedDate);
+  expect(originalFetchedDate).toEqual(finalFetchedDate);
+});

packages/cloudflare/package.json

@@ -71,12 +71,10 @@
     "vitest": "catalog:"
   },
   "dependencies": {
-    "@ast-grep/napi": "^0.36.1",
     "@dotenvx/dotenvx": "catalog:",
-    "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@778",
+    "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@790",
     "enquirer": "^2.4.1",
-    "glob": "catalog:",
-    "yaml": "^2.7.0"
+    "glob": "catalog:"
   },
   "peerDependencies": {
     "wrangler": "catalog:"

packages/cloudflare/src/cli/build/build.ts

@@ -120,8 +120,8 @@ export async function build(projectOpts: ProjectOptions): Promise<void> {
 }
 
 function ensureNextjsVersionSupported(options: buildHelper.BuildOptions) {
-  if (buildHelper.compareSemver(options.nextVersion, "14.0.0") < 0) {
-    logger.error("Next.js version unsupported, please upgrade to version 14 or greater.");
+  if (buildHelper.compareSemver(options.nextVersion, "<", "14.2.0")) {
+    logger.error("Next.js version unsupported, please upgrade to version 14.2 or greater.");
     process.exit(1);
   }
 }

packages/cloudflare/src/cli/build/bundle-server.ts

@@ -4,16 +4,15 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 
 import { type BuildOptions, getPackagePath } from "@opennextjs/aws/build/helper.js";
-import { build } from "esbuild";
+import { ContentUpdater } from "@opennextjs/aws/plugins/content-updater.js";
+import { build, type Plugin } from "esbuild";
 
 import { patchVercelOgLibrary } from "./patches/ast/patch-vercel-og-library.js";
 import { patchWebpackRuntime } from "./patches/ast/webpack-runtime.js";
 import * as patches from "./patches/index.js";
 import { inlineBuildId } from "./patches/plugins/build-id.js";
-import { ContentUpdater } from "./patches/plugins/content-updater.js";
 import { inlineDynamicRequires } from "./patches/plugins/dynamic-requires.js";
 import { inlineEvalManifest } from "./patches/plugins/eval-manifest.js";
-import { patchFetchCacheSetMissingWaitUntil } from "./patches/plugins/fetch-cache-wait-until.js";
 import { inlineFindDir } from "./patches/plugins/find-dir.js";
 import { patchInstrumentation } from "./patches/plugins/instrumentation.js";
 import { inlineLoadManifest } from "./patches/plugins/load-manifest.js";
@@ -68,7 +67,7 @@ export async function bundleServer(buildOpts: BuildOptions): Promise<void> {
   const openNextServer = path.join(outputPath, packagePath, `index.mjs`);
   const openNextServerBundle = path.join(outputPath, packagePath, `handler.mjs`);
 
-  const updater = new ContentUpdater();
+  const updater = new ContentUpdater(buildOpts);
 
   const result = await build({
     entryPoints: [openNextServer],
@@ -95,16 +94,15 @@ export async function bundleServer(buildOpts: BuildOptions): Promise<void> {
       fixRequire(updater),
       handleOptionalDependencies(optionalDependencies),
       patchInstrumentation(updater, buildOpts),
-      patchFetchCacheSetMissingWaitUntil(updater),
       inlineEvalManifest(updater, buildOpts),
       inlineFindDir(updater, buildOpts),
       inlineLoadManifest(updater, buildOpts),
       inlineBuildId(updater),
       patchDepdDeprecations(updater),
       patchNextMinimal(updater),
-      // Apply updater updaters, must be the last plugin
+      // Apply updater updates, must be the last plugin
       updater.plugin,
-    ],
+    ] as Plugin[],
     external: ["./middleware/handler.mjs"],
     alias: {
       // Note: it looks like node-fetch is actually not necessary for us, so we could replace it with an empty shim
@@ -119,7 +117,6 @@ export async function bundleServer(buildOpts: BuildOptions): Promise<void> {
       // Note: we apply an empty shim to next/dist/compiled/edge-runtime since (amongst others) it generated the following `eval`:
       //   eval(getModuleCode)(module, module.exports, throwingRequire, params.context, ...Object.values(params.scopedContext));
       //   which comes from https://github.com/vercel/edge-runtime/blob/6e96b55f/packages/primitives/src/primitives/load.js#L57-L63
-      // QUESTION: Why did I encountered this but mhart didn't?
       "next/dist/compiled/edge-runtime": path.join(
         buildOpts.outputDir,
         "cloudflare-templates/shims/empty.js"
@@ -220,13 +217,6 @@ export async function updateWorkerBundledCode(
       "'require(this.middlewareManifestPath)'",
       (code) => patches.inlineMiddlewareManifestRequire(code, buildOpts),
     ],
-    [
-      "`patchAsyncStorage` call",
-      (code) =>
-        code
-          // TODO: implement for cf (possibly in @opennextjs/aws)
-          .replace("patchAsyncStorage();", "//patchAsyncStorage();"),
-    ],
     [
       "`require.resolve` call",
       // workers do not support dynamic require nor require.resolve

packages/cloudflare/src/cli/build/open-next/createServerBundle.ts

@@ -10,18 +10,38 @@ import { copyTracedFiles } from "@opennextjs/aws/build/copyTracedFiles.js";
 import { generateEdgeBundle } from "@opennextjs/aws/build/edge/createEdgeBundle.js";
 import * as buildHelper from "@opennextjs/aws/build/helper.js";
 import { installDependencies } from "@opennextjs/aws/build/installDeps.js";
+import type { CodePatcher } from "@opennextjs/aws/build/patch/codePatcher.js";
+import { applyCodePatches } from "@opennextjs/aws/build/patch/codePatcher.js";
+import {
+  patchFetchCacheForISR,
+  patchUnstableCacheForISR,
+} from "@opennextjs/aws/build/patch/patchFetchCacheISR.js";
+import { patchFetchCacheSetMissingWaitUntil } from "@opennextjs/aws/build/patch/patchFetchCacheWaitUntil.js";
 import logger from "@opennextjs/aws/logger.js";
 import { minifyAll } from "@opennextjs/aws/minimize-js.js";
+import type { ContentUpdater } from "@opennextjs/aws/plugins/content-updater.js";
 import { openNextEdgePlugins } from "@opennextjs/aws/plugins/edge.js";
 import { openNextExternalMiddlewarePlugin } from "@opennextjs/aws/plugins/externalMiddleware.js";
 import { openNextReplacementPlugin } from "@opennextjs/aws/plugins/replacement.js";
 import { openNextResolvePlugin } from "@opennextjs/aws/plugins/resolve.js";
 import type { FunctionOptions, SplittedFunctionOptions } from "@opennextjs/aws/types/open-next.js";
 import { getCrossPlatformPathRegex } from "@opennextjs/aws/utils/regex.js";
+import type { Plugin } from "esbuild";
 
 import { normalizePath } from "../utils/index.js";
 
-export async function createServerBundle(options: buildHelper.BuildOptions) {
+interface CodeCustomization {
+  // These patches are meant to apply on user and next generated code
+  additionalCodePatches?: CodePatcher[];
+  // These plugins are meant to apply during the esbuild bundling process.
+  // This will only apply to OpenNext code.
+  additionalPlugins?: (contentUpdater: ContentUpdater) => Plugin[];
+}
+
+export async function createServerBundle(
+  options: buildHelper.BuildOptions,
+  codeCustomization?: CodeCustomization
+) {
   const { config } = options;
   const foundRoutes = new Set<string>();
   // Get all functions to build
@@ -39,7 +59,7 @@ export async function createServerBundle(options: buildHelper.BuildOptions) {
     if (fnOptions.runtime === "edge") {
       await generateEdgeBundle(name, options, fnOptions);
     } else {
-      await generateBundle(name, options, fnOptions);
+      await generateBundle(name, options, fnOptions, codeCustomization);
     }
   });
 
@@ -102,7 +122,8 @@ export async function createServerBundle(options: buildHelper.BuildOptions) {
 async function generateBundle(
   name: string,
   options: buildHelper.BuildOptions,
-  fnOptions: SplittedFunctionOptions
+  fnOptions: SplittedFunctionOptions,
+  codeCustomization?: CodeCustomization
 ) {
   const { appPath, appBuildOutputPath, config, outputDir, monorepoRoot } = options;
   logger.info(`Building server function: ${name}...`);
@@ -151,27 +172,37 @@ async function generateBundle(
   buildHelper.copyEnvFile(appBuildOutputPath, packagePath, outputPath);
 
   // Copy all necessary traced files
-  await copyTracedFiles({
+  const { tracedFiles, manifests } = await copyTracedFiles({
     buildOutputPath: appBuildOutputPath,
     packagePath,
     outputDir: outputPath,
     routes: fnOptions.routes ?? ["app/page.tsx"],
     bundledNextServer: isBundled,
   });
 
+  const additionalCodePatches = codeCustomization?.additionalCodePatches ?? [];
+
+  await applyCodePatches(options, tracedFiles, manifests, [
+    patchFetchCacheSetMissingWaitUntil,
+    patchFetchCacheForISR,
+    patchUnstableCacheForISR,
+    ...additionalCodePatches,
+  ]);
+
   // Build Lambda code
   // note: bundle in OpenNext package b/c the adapter relies on the
   //       "serverless-http" package which is not a dependency in user's
   //       Next.js app.
 
   const disableNextPrebundledReact =
-    buildHelper.compareSemver(options.nextVersion, "13.5.1") >= 0 ||
-    buildHelper.compareSemver(options.nextVersion, "13.4.1") <= 0;
+    buildHelper.compareSemver(options.nextVersion, ">=", "13.5.1") ||
+    buildHelper.compareSemver(options.nextVersion, "<=", "13.4.1");
 
   const overrides = fnOptions.override ?? {};
 
-  const isBefore13413 = buildHelper.compareSemver(options.nextVersion, "13.4.13") <= 0;
-  const isAfter141 = buildHelper.compareSemver(options.nextVersion, "14.1") >= 0;
+  const isBefore13413 = buildHelper.compareSemver(options.nextVersion, "<=", "13.4.13");
+  const isAfter141 = buildHelper.compareSemver(options.nextVersion, ">=", "14.1");
+  const isAfter142 = buildHelper.compareSemver(options.nextVersion, ">=", "14.2");
 
   const disableRouting = isBefore13413 || config.middleware?.external;
 
@@ -182,6 +213,7 @@ async function generateBundle(
       deletes: [
         ...(disableNextPrebundledReact ? ["applyNextjsPrebundledReact"] : []),
         ...(disableRouting ? ["withRouting"] : []),
+        ...(isAfter142 ? ["patchAsyncStorage"] : []),
       ],
     }),
     openNextReplacementPlugin({

packages/cloudflare/src/cli/build/patches/ast/patch-vercel-og-library.ts

@@ -3,9 +3,9 @@ import path from "node:path";
 
 import type { BuildOptions } from "@opennextjs/aws/build/helper.js";
 import { getPackagePath } from "@opennextjs/aws/build/helper.js";
+import { parseFile } from "@opennextjs/aws/build/patch/astCodePatcher.js";
 import { globSync } from "glob";
 
-import { parseFile } from "./util.js";
 import { patchVercelOgFallbackFont, patchVercelOgImport } from "./vercel-og.js";
 
 type TraceInfo = { version: number; files: string[] };