@opennextjs/cloudflare 1.0.0-beta.1 → 1.0.0-beta.3

package/dist/cli/templates/init.js

@@ -0,0 +1,105 @@
+/**
+ * Initialization for the workerd runtime.
+ *
+ * The file must be imported at the top level the worker.
+ */
+import { AsyncLocalStorage } from "node:async_hooks";
+import process from "node:process";
+import stream from "node:stream";
+// @ts-expect-error: resolved by wrangler build
+import * as nextEnvVars from "./next-env.mjs";
+const cloudflareContextALS = new AsyncLocalStorage();
+// Note: this symbol needs to be kept in sync with `src/api/get-cloudflare-context.ts`
+Object.defineProperty(globalThis, Symbol.for("__cloudflare-context__"), {
+    get() {
+        return cloudflareContextALS.getStore();
+    },
+});
+/**
+ * Executes the handler with the Cloudflare context.
+ */
+export async function runWithCloudflareRequestContext(request, env, ctx, handler) {
+    init(request, env);
+    return cloudflareContextALS.run({ env, ctx, cf: request.cf }, handler);
+}
+let initialized = false;
+/**
+ * Initializes the runtime on the first call,
+ * no-op on subsequent invocations.
+ */
+function init(request, env) {
+    if (initialized) {
+        return;
+    }
+    initialized = true;
+    const url = new URL(request.url);
+    initRuntime();
+    populateProcessEnv(url, env);
+}
+function initRuntime() {
+    // Some packages rely on `process.version` and `process.versions.node` (i.e. Jose@4)
+    // TODO: Remove when https://github.com/unjs/unenv/pull/493 is merged
+    Object.assign(process, { version: process.version || "v22.14.0" });
+    // @ts-expect-error Node type does not match workerd
+    Object.assign(process.versions, { node: "22.14.0", ...process.versions });
+    globalThis.__dirname ??= "";
+    globalThis.__filename ??= "";
+    // Do not crash on cache not supported
+    // https://github.com/cloudflare/workerd/pull/2434
+    // compatibility flag "cache_option_enabled" -> does not support "force-cache"
+    const __original_fetch = globalThis.fetch;
+    globalThis.fetch = (input, init) => {
+        if (init) {
+            delete init.cache;
+        }
+        return __original_fetch(input, init);
+    };
+    const CustomRequest = class extends globalThis.Request {
+        constructor(input, init) {
+            if (init) {
+                delete init.cache;
+                // https://github.com/cloudflare/workerd/issues/2746
+                // https://github.com/cloudflare/workerd/issues/3245
+                Object.defineProperty(init, "body", {
+                    // @ts-ignore
+                    value: init.body instanceof stream.Readable ? ReadableStream.from(init.body) : init.body,
+                });
+            }
+            super(input, init);
+        }
+    };
+    Object.assign(globalThis, {
+        Request: CustomRequest,
+        __BUILD_TIMESTAMP_MS__: __BUILD_TIMESTAMP_MS__,
+        __NEXT_BASE_PATH__: __NEXT_BASE_PATH__,
+    });
+}
+/**
+ * Populate process.env with:
+ * - the environment variables and secrets from the cloudflare platform
+ * - the variables from Next .env* files
+ * - the origin resolver information
+ */
+function populateProcessEnv(url, env) {
+    for (const [key, value] of Object.entries(env)) {
+        if (typeof value === "string") {
+            process.env[key] = value;
+        }
+    }
+    const mode = env.NEXTJS_ENV ?? "production";
+    if (nextEnvVars[mode]) {
+        for (const key in nextEnvVars[mode]) {
+            process.env[key] ??= nextEnvVars[mode][key];
+        }
+    }
+    // Set the default Origin for the origin resolver.
+    // This is only needed for an external middleware bundle
+    process.env.OPEN_NEXT_ORIGIN = JSON.stringify({
+        default: {
+            host: url.hostname,
+            protocol: url.protocol.slice(0, -1),
+            port: url.port,
+        },
+    });
+}
+/* eslint-enable no-var */

package/dist/cli/templates/worker.js

@@ -1,25 +1,13 @@
-import { AsyncLocalStorage } from "node:async_hooks";
-import process from "node:process";
-// @ts-expect-error: resolved by wrangler build
-import * as nextEnvVars from "./env/next-env.mjs";
-const cloudflareContextALS = new AsyncLocalStorage();
-// Note: this symbol needs to be kept in sync with `src/api/get-cloudflare-context.ts`
-Object.defineProperty(globalThis, Symbol.for("__cloudflare-context__"), {
-    get() {
-        return cloudflareContextALS.getStore();
-    },
-});
+//@ts-expect-error: Will be resolved by wrangler build
+import { runWithCloudflareRequestContext } from "./cloudflare/init.js";
 //@ts-expect-error: Will be resolved by wrangler build
 export { DOQueueHandler } from "./.build/durable-objects/queue.js";
 //@ts-expect-error: Will be resolved by wrangler build
 export { DOShardedTagCache } from "./.build/durable-objects/sharded-tag-cache.js";
-// Populate process.env on the first request
-let processEnvPopulated = false;
 export default {
     async fetch(request, env, ctx) {
-        return cloudflareContextALS.run({ env, ctx, cf: request.cf }, async () => {
+        return runWithCloudflareRequestContext(request, env, ctx, async () => {
             const url = new URL(request.url);
-            populateProcessEnv(url, env);
             // Serve images in development.
             // Note: "/cdn-cgi/image/..." requests do not reach production workers.
             if (url.pathname.startsWith("/cdn-cgi/image/")) {
@@ -33,10 +21,10 @@ export default {
                     : env.ASSETS?.fetch(new URL(`/${imageUrl}`, url));
             }
             // Fallback for the Next default image loader.
-            if (url.pathname === "/_next/image") {
+            if (url.pathname === `${globalThis.__NEXT_BASE_PATH__}/_next/image`) {
                 const imageUrl = url.searchParams.get("url") ?? "";
                 return imageUrl.startsWith("/")
-                    ? env.ASSETS?.fetch(new URL(imageUrl, request.url))
+                    ? env.ASSETS?.fetch(`http://assets.local${imageUrl}`)
                     : fetch(imageUrl, { cf: { cacheEverything: true } });
             }
             // @ts-expect-error: resolved by wrangler build
@@ -45,39 +33,3 @@ export default {
         });
     },
 };
-/**
- * Populate process.env with:
- * - the environment variables and secrets from the cloudflare platform
- * - the variables from Next .env* files
- * - the origin resolver information
- */
-function populateProcessEnv(url, env) {
-    if (processEnvPopulated) {
-        return;
-    }
-    // Some packages rely on `process.version` and `process.versions.node` (i.e. Jose@4)
-    // TODO: Remove when https://github.com/unjs/unenv/pull/493 is merged
-    Object.assign(process, { version: process.version || "v22.14.0" });
-    // @ts-expect-error Node type does not match workerd
-    Object.assign(process.versions, { node: "22.14.0", ...process.versions });
-    processEnvPopulated = true;
-    for (const [key, value] of Object.entries(env)) {
-        if (typeof value === "string") {
-            process.env[key] = value;
-        }
-    }
-    const mode = env.NEXTJS_ENV ?? "production";
-    if (nextEnvVars[mode]) {
-        for (const key in nextEnvVars[mode]) {
-            process.env[key] ??= nextEnvVars[mode][key];
-        }
-    }
-    // Set the default Origin for the origin resolver.
-    process.env.OPEN_NEXT_ORIGIN = JSON.stringify({
-        default: {
-            host: url.hostname,
-            protocol: url.protocol.slice(0, -1),
-            port: url.port,
-        },
-    });
-}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "type": "module",
   "bin": {
     "opennextjs-cloudflare": "dist/cli/index.js"
@@ -43,7 +43,7 @@
   "homepage": "https://github.com/opennextjs/opennextjs-cloudflare",
   "dependencies": {
     "@dotenvx/dotenvx": "1.31.0",
-    "@opennextjs/aws": "3.5.5",
+    "@opennextjs/aws": "3.5.7",
     "enquirer": "^2.4.1",
     "glob": "^11.0.0",
     "ts-tqdm": "^0.8.6"

package/templates/open-next.config.ts

@@ -1,7 +1,7 @@
 // default open-next.config.ts file created by @opennextjs/cloudflare
 import { defineCloudflareConfig } from "@opennextjs/cloudflare/config";
-import kvIncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/kv-incremental-cache";
+import r2IncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/r2-incremental-cache";
 
 export default defineCloudflareConfig({
-  incrementalCache: kvIncrementalCache,
+  incrementalCache: r2IncrementalCache,
 });

package/templates/wrangler.jsonc

@@ -8,12 +8,14 @@
     "directory": ".open-next/assets",
     "binding": "ASSETS"
   },
-  "kv_namespaces": [
-    // Create a KV binding with the binding name "NEXT_INC_CACHE_KV"
-    // to enable the KV based caching:
-    // {
-    //   "binding": "NEXT_INC_CACHE_KV",
-    //   "id": "<BINDING_ID>"
-    // }
+  "r2_buckets": [
+    // Use R2 incremental cache
+    // See https://opennext.js.org/cloudflare/caching
+    {
+      "binding": "NEXT_INC_CACHE_R2_BUCKET",
+      // Create a bucket before deploying
+      // See https://developers.cloudflare.com/workers/wrangler/commands/#r2-bucket-create
+      "bucket_name": "<BUCKET_NAME>"
+    }
   ]
 }

package/dist/cli/build/open-next/copyCacheAssets.d.ts

@@ -1,2 +0,0 @@
-import * as buildHelper from "@opennextjs/aws/build/helper.js";
-export declare function copyCacheAssets(options: buildHelper.BuildOptions): void;

package/dist/cli/build/open-next/copyCacheAssets.js

@@ -1,10 +0,0 @@
-import { cpSync, mkdirSync } from "node:fs";
-import { join } from "node:path";
-import { CACHE_ASSET_DIR } from "../../../api/overrides/incremental-cache/kv-incremental-cache.js";
-export function copyCacheAssets(options) {
-    const { outputDir } = options;
-    const srcPath = join(outputDir, "cache");
-    const dstPath = join(outputDir, "assets", CACHE_ASSET_DIR);
-    mkdirSync(dstPath, { recursive: true });
-    cpSync(srcPath, dstPath, { recursive: true });
-}

package/dist/cli/build/patches/plugins/next-minimal.d.ts

@@ -1,4 +0,0 @@
-import { ContentUpdater, type Plugin } from "@opennextjs/aws/plugins/content-updater.js";
-export declare const abortControllerRule = "\nrule:\n  all:\n    - kind: lexical_declaration\n      pattern: let $VAR = new AbortController\n    - precedes:\n        kind: function_declaration\n        stopBy: end\n        has:\n          kind: statement_block\n          has:\n            kind: try_statement\n            has:\n              kind: catch_clause\n              has:\n                kind: statement_block\n                has:\n                  kind: return_statement\n                  all:\n                    - has:\n                        stopBy: end\n                        kind: member_expression\n                        pattern: $VAR.signal.aborted\n                    - has:\n                        stopBy: end\n                        kind: call_expression\n                        regex: console.error\\(\"Failed to fetch RSC payload for\n\nfix:\n  'let $VAR = {signal:{aborted: false}};'\n";
-export declare const nextMinimalRule = "\nrule:\n  kind: member_expression\n  pattern: process.env.NEXT_MINIMAL\n  any:\n    - inside:\n        kind: parenthesized_expression\n        stopBy: end\n        inside:\n          kind: if_statement\n          any:\n            - inside:\n                kind: statement_block\n                inside:\n                  kind: method_definition\n                  any:\n                    - has: {kind: property_identifier, field: name, regex: runEdgeFunction}\n                    - has: {kind: property_identifier, field: name, regex: runMiddleware}\n                    - has: {kind: property_identifier, field: name, regex: imageOptimizer}\n            - has:\n                kind: statement_block\n                has:\n                  kind: expression_statement\n                  pattern: res.statusCode = 400;\nfix:\n  'true'\n";
-export declare function patchNextMinimal(updater: ContentUpdater): Plugin;

package/dist/cli/build/patches/plugins/next-minimal.js

@@ -1,86 +0,0 @@
-import { patchCode } from "@opennextjs/aws/build/patch/astCodePatcher.js";
-// Remove an instantiation of `AbortController` from the runtime.
-//
-//  Solves https://github.com/cloudflare/workerd/issues/3657:
-// - The `AbortController` is meant for the client side, but ends in the server code somehow.
-//   That's why we can get ride of it. See https://github.com/vercel/next.js/pull/73975/files.
-// - Top level instantiation of `AbortController` are not supported by workerd as of March, 2025.
-//   See https://github.com/cloudflare/workerd/issues/3657
-// - As Next code is not more executed at top level, we do not need to apply this patch
-//   See https://github.com/opennextjs/opennextjs-cloudflare/pull/497
-//
-// We try to be as specific as possible to avoid patching the wrong thing here
-export const abortControllerRule = `
-rule:
-  all:
-    - kind: lexical_declaration
-      pattern: let $VAR = new AbortController
-    - precedes:
-        kind: function_declaration
-        stopBy: end
-        has:
-          kind: statement_block
-          has:
-            kind: try_statement
-            has:
-              kind: catch_clause
-              has:
-                kind: statement_block
-                has:
-                  kind: return_statement
-                  all:
-                    - has:
-                        stopBy: end
-                        kind: member_expression
-                        pattern: $VAR.signal.aborted
-                    - has:
-                        stopBy: end
-                        kind: call_expression
-                        regex: console.error\\("Failed to fetch RSC payload for
-
-fix:
-  'let $VAR = {signal:{aborted: false}};'
-`;
-// This rule is used instead of defining `process.env.NEXT_MINIMAL` in the `esbuild config.
-// Do we want to entirely replace these functions to reduce the bundle size?
-// In next `renderHTML` is used as a fallback in case of errors, but in minimal mode it just throws the error and the responsibility of handling it is on the infra.
-export const nextMinimalRule = `
-rule:
-  kind: member_expression
-  pattern: process.env.NEXT_MINIMAL
-  any:
-    - inside:
-        kind: parenthesized_expression
-        stopBy: end
-        inside:
-          kind: if_statement
-          any:
-            - inside:
-                kind: statement_block
-                inside:
-                  kind: method_definition
-                  any:
-                    - has: {kind: property_identifier, field: name, regex: runEdgeFunction}
-                    - has: {kind: property_identifier, field: name, regex: runMiddleware}
-                    - has: {kind: property_identifier, field: name, regex: imageOptimizer}
-            - has:
-                kind: statement_block
-                has:
-                  kind: expression_statement
-                  pattern: res.statusCode = 400;
-fix:
-  'true'
-`;
-export function patchNextMinimal(updater) {
-    return updater.updateContent("patch-next-minimal", [
-        {
-            field: {
-                filter: /next-server\.(js)$/,
-                contentFilter: /.*/,
-                callback: ({ contents }) => {
-                    return patchCode(contents, nextMinimalRule);
-                },
-            },
-        },
-    ]);
-}

package/dist/cli/build/patches/plugins/next-minimal.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/cli/build/patches/plugins/next-minimal.spec.js

@@ -1,71 +0,0 @@
-import { patchCode } from "@opennextjs/aws/build/patch/astCodePatcher.js";
-import { describe, expect, test } from "vitest";
-import { abortControllerRule } from "./next-minimal";
-const appPageRuntimeProdJs = `let p = new AbortController;
-async function h(e3, t3) {
-  let { flightRouterState: r3, nextUrl: a2, prefetchKind: i2 } = t3, u2 = { [n2.hY]: "1", [n2.B]: encodeURIComponent(JSON.stringify(r3)) };
-  i2 === o.ob.AUTO && (u2[n2._V] = "1"), a2 && (u2[n2.kO] = a2);
-  try {
-    var c2;
-    let t4 = i2 ? i2 === o.ob.TEMPORARY ? "high" : "low" : "auto";
-    "export" === process.env.__NEXT_CONFIG_OUTPUT && ((e3 = new URL(e3)).pathname.endsWith("/") ? e3.pathname += "index.txt" : e3.pathname += ".txt");
-    let r4 = await m(e3, u2, t4, p.signal), a3 = d(r4.url), h2 = r4.redirected ? a3 : void 0, g = r4.headers.get("content-type") || "", v = !!(null == (c2 = r4.headers.get("vary")) ? void 0 : c2.includes(n2.kO)), b = !!r4.headers.get(n2.jc), S = r4.headers.get(n2.UK), _ = null !== S ? parseInt(S, 10) : -1, w = g.startsWith(n2.al);
-    if ("export" !== process.env.__NEXT_CONFIG_OUTPUT || w || (w = g.startsWith("text/plain")), !w || !r4.ok || !r4.body)
-      return e3.hash && (a3.hash = e3.hash), f(a3.toString());
-    let k = b ? function(e4) {
-      let t5 = e4.getReader();
-      return new ReadableStream({ async pull(e5) {
-        for (; ; ) {
-          let { done: r5, value: n3 } = await t5.read();
-          if (!r5) {
-            e5.enqueue(n3);
-            continue;
-          }
-          return;
-        }
-      } });
-    }(r4.body) : r4.body, E = await y(k);
-    if ((0, l.X)() !== E.b)
-      return f(r4.url);
-    return { flightData: (0, s.aj)(E.f), canonicalUrl: h2, couldBeIntercepted: v, prerendered: E.S, postponed: b, staleTime: _ };
-  } catch (t4) {
-    return p.signal.aborted || console.error("Failed to fetch RSC payload for " + e3 + ". Falling back to browser navigation.", t4), { flightData: e3.toString(), canonicalUrl: void 0, couldBeIntercepted: false, prerendered: false, postponed: false, staleTime: -1 };
-  }
-}
-`;
-describe("Abort controller", () => {
-    test("minimal", () => {
-        expect(patchCode(appPageRuntimeProdJs, abortControllerRule)).toBe(`let p = {signal:{aborted: false}};
-async function h(e3, t3) {
-  let { flightRouterState: r3, nextUrl: a2, prefetchKind: i2 } = t3, u2 = { [n2.hY]: "1", [n2.B]: encodeURIComponent(JSON.stringify(r3)) };
-  i2 === o.ob.AUTO && (u2[n2._V] = "1"), a2 && (u2[n2.kO] = a2);
-  try {
-    var c2;
-    let t4 = i2 ? i2 === o.ob.TEMPORARY ? "high" : "low" : "auto";
-    "export" === process.env.__NEXT_CONFIG_OUTPUT && ((e3 = new URL(e3)).pathname.endsWith("/") ? e3.pathname += "index.txt" : e3.pathname += ".txt");
-    let r4 = await m(e3, u2, t4, p.signal), a3 = d(r4.url), h2 = r4.redirected ? a3 : void 0, g = r4.headers.get("content-type") || "", v = !!(null == (c2 = r4.headers.get("vary")) ? void 0 : c2.includes(n2.kO)), b = !!r4.headers.get(n2.jc), S = r4.headers.get(n2.UK), _ = null !== S ? parseInt(S, 10) : -1, w = g.startsWith(n2.al);
-    if ("export" !== process.env.__NEXT_CONFIG_OUTPUT || w || (w = g.startsWith("text/plain")), !w || !r4.ok || !r4.body)
-      return e3.hash && (a3.hash = e3.hash), f(a3.toString());
-    let k = b ? function(e4) {
-      let t5 = e4.getReader();
-      return new ReadableStream({ async pull(e5) {
-        for (; ; ) {
-          let { done: r5, value: n3 } = await t5.read();
-          if (!r5) {
-            e5.enqueue(n3);
-            continue;
-          }
-          return;
-        }
-      } });
-    }(r4.body) : r4.body, E = await y(k);
-    if ((0, l.X)() !== E.b)
-      return f(r4.url);
-    return { flightData: (0, s.aj)(E.f), canonicalUrl: h2, couldBeIntercepted: v, prerendered: E.S, postponed: b, staleTime: _ };
-  } catch (t4) {
-    return p.signal.aborted || console.error("Failed to fetch RSC payload for " + e3 + ". Falling back to browser navigation.", t4), { flightData: e3.toString(), canonicalUrl: void 0, couldBeIntercepted: false, prerendered: false, postponed: false, staleTime: -1 };
-  }
-}
-`);
-    });
-});