@opennextjs/cloudflare 1.0.1 → 1.0.3

package/dist/api/config.js

@@ -26,6 +26,17 @@ export function defineCloudflareConfig(config = {}) {
         dangerous: {
             enableCacheInterception,
         },
+        middleware: {
+            external: true,
+            override: {
+                wrapper: "cloudflare-edge",
+                converter: "edge",
+                proxyExternalRequest: "fetch",
+                incrementalCache: resolveIncrementalCache(incrementalCache),
+                tagCache: resolveTagCache(tagCache),
+                queue: resolveQueue(queue),
+            },
+        },
     };
 }
 function resolveIncrementalCache(value = "dummy") {

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

@@ -22,6 +22,7 @@ import { openNextResolvePlugin } from "@opennextjs/aws/plugins/resolve.js";
 import { getCrossPlatformPathRegex } from "@opennextjs/aws/utils/regex.js";
 import { getOpenNextConfig } from "../../../api/config.js";
 import { patchResRevalidate } from "../patches/plugins/res-revalidate.js";
+import { patchUseCacheIO } from "../patches/plugins/use-cache.js";
 import { normalizePath } from "../utils/index.js";
 import { copyWorkerdPackages } from "../utils/workerd.js";
 export async function createServerBundle(options, codeCustomization) {
@@ -141,6 +142,7 @@ async function generateBundle(name, options, fnOptions, codeCustomization) {
         patchBackgroundRevalidation,
         // Cloudflare specific patches
         patchResRevalidate,
+        patchUseCacheIO,
         ...additionalCodePatches,
     ]);
     // Build Lambda code

package/dist/cli/build/patches/plugins/instrumentation.js

@@ -2,6 +2,7 @@ import { existsSync } from "node:fs";
 import { join } from "node:path";
 import { getPackagePath } from "@opennextjs/aws/build/helper.js";
 import { patchCode } from "@opennextjs/aws/build/patch/astCodePatcher.js";
+import { normalizePath } from "../../utils/normalize-path.js";
 export function patchInstrumentation(updater, buildOpts) {
     const builtInstrumentationPath = getBuiltInstrumentationPath(buildOpts);
     updater.updateContent("patch-instrumentation-next15", [
@@ -69,7 +70,7 @@ export function getNext14Rule(builtInstrumentationPath) {
 function getBuiltInstrumentationPath(buildOpts) {
     const { outputDir } = buildOpts;
     const maybeBuiltInstrumentationPath = join(outputDir, "server-functions/default", getPackagePath(buildOpts), `.next/server/${INSTRUMENTATION_HOOK_FILENAME}.js`);
-    return existsSync(maybeBuiltInstrumentationPath) ? maybeBuiltInstrumentationPath : null;
+    return existsSync(maybeBuiltInstrumentationPath) ? normalizePath(maybeBuiltInstrumentationPath) : null;
 }
 /**
  * Pattern to detect instrumentation hooks file

package/dist/cli/build/patches/plugins/use-cache.d.ts

@@ -0,0 +1,3 @@
+import type { CodePatcher } from "@opennextjs/aws/build/patch/codePatcher.js";
+export declare const rule = "\nrule:\n  kind: if_statement\n  inside:\n    kind: function_declaration\n    stopBy: end\n    has:\n      kind: identifier\n      pattern: createSnapshot\nfix:\n  '// Ignored snapshot'\n";
+export declare const patchUseCacheIO: CodePatcher;

package/dist/cli/build/patches/plugins/use-cache.js

@@ -0,0 +1,40 @@
+/**
+ * This patch will replace the createSnapshot function in the
+ * server/app-render/async-local-storage.js file to an empty string.
+ * This is necessary because the createSnapshot function is causing I/O issues for
+ * ISR/SSG revalidation in Cloudflare Workers.
+ * This is because by default it will use AsyncLocalStorage.snapshot() and it will
+ * bind everything to the initial request context.
+ * The downsides is that use cache function will have access to the full request
+ * ALS context from next (i.e. cookies, headers ...)
+ * TODO: Find a better fix for this issue.
+ */
+import { patchCode } from "@opennextjs/aws/build/patch/astCodePatcher.js";
+import { getCrossPlatformPathRegex } from "@opennextjs/aws/utils/regex.js";
+export const rule = `
+rule:
+  kind: if_statement
+  inside:
+    kind: function_declaration
+    stopBy: end
+    has:
+      kind: identifier
+      pattern: createSnapshot
+fix:
+  '// Ignored snapshot'
+`;
+export const patchUseCacheIO = {
+    name: "patch-use-cache",
+    patches: [
+        {
+            versions: ">=15.3.1",
+            field: {
+                pathFilter: getCrossPlatformPathRegex(String.raw `server/app-render/async-local-storage\.js$`, {
+                    escape: false,
+                }),
+                contentFilter: /createSnapshot/,
+                patchCode: async ({ code }) => patchCode(code, rule),
+            },
+        },
+    ],
+};

package/dist/cli/build/patches/plugins/use-cache.spec.d.ts

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

package/dist/cli/build/patches/plugins/use-cache.spec.js

@@ -0,0 +1,156 @@
+import { patchCode } from "@opennextjs/aws/build/patch/astCodePatcher.js";
+import { expect, test } from "vitest";
+import { rule } from "./use-cache.js";
+const codeToPatch = `"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+0 && (module.exports = {
+    bindSnapshot: null,
+    createAsyncLocalStorage: null,
+    createSnapshot: null
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    bindSnapshot: function() {
+        return bindSnapshot;
+    },
+    createAsyncLocalStorage: function() {
+        return createAsyncLocalStorage;
+    },
+    createSnapshot: function() {
+        return createSnapshot;
+    }
+});
+const sharedAsyncLocalStorageNotAvailableError = Object.defineProperty(new Error('Invariant: AsyncLocalStorage accessed in runtime where it is not available'), "__NEXT_ERROR_CODE", {
+    value: "E504",
+    enumerable: false,
+    configurable: true
+});
+class FakeAsyncLocalStorage {
+    disable() {
+        throw sharedAsyncLocalStorageNotAvailableError;
+    }
+    getStore() {
+        // This fake implementation of AsyncLocalStorage always returns \`undefined\`.
+        return undefined;
+    }
+    run() {
+        throw sharedAsyncLocalStorageNotAvailableError;
+    }
+    exit() {
+        throw sharedAsyncLocalStorageNotAvailableError;
+    }
+    enterWith() {
+        throw sharedAsyncLocalStorageNotAvailableError;
+    }
+    static bind(fn) {
+        return fn;
+    }
+}
+const maybeGlobalAsyncLocalStorage = typeof globalThis !== 'undefined' && globalThis.AsyncLocalStorage;
+function createAsyncLocalStorage() {
+    if (maybeGlobalAsyncLocalStorage) {
+        return new maybeGlobalAsyncLocalStorage();
+    }
+    return new FakeAsyncLocalStorage();
+}
+function bindSnapshot(fn) {
+    if (maybeGlobalAsyncLocalStorage) {
+        return maybeGlobalAsyncLocalStorage.bind(fn);
+    }
+    return FakeAsyncLocalStorage.bind(fn);
+}
+function createSnapshot() {
+    if (maybeGlobalAsyncLocalStorage) {
+        return maybeGlobalAsyncLocalStorage.snapshot();
+    }
+    return function(fn, ...args) {
+        return fn(...args);
+    };
+}
+
+//# sourceMappingURL=async-local-storage.js.map
+`;
+test("patch the createSnapshot function", () => {
+    const patchedCode = patchCode(codeToPatch, rule);
+    expect(patchedCode).toMatchInlineSnapshot(`""use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+0 && (module.exports = {
+    bindSnapshot: null,
+    createAsyncLocalStorage: null,
+    createSnapshot: null
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    bindSnapshot: function() {
+        return bindSnapshot;
+    },
+    createAsyncLocalStorage: function() {
+        return createAsyncLocalStorage;
+    },
+    createSnapshot: function() {
+        return createSnapshot;
+    }
+});
+const sharedAsyncLocalStorageNotAvailableError = Object.defineProperty(new Error('Invariant: AsyncLocalStorage accessed in runtime where it is not available'), "__NEXT_ERROR_CODE", {
+    value: "E504",
+    enumerable: false,
+    configurable: true
+});
+class FakeAsyncLocalStorage {
+    disable() {
+        throw sharedAsyncLocalStorageNotAvailableError;
+    }
+    getStore() {
+        // This fake implementation of AsyncLocalStorage always returns \`undefined\`.
+        return undefined;
+    }
+    run() {
+        throw sharedAsyncLocalStorageNotAvailableError;
+    }
+    exit() {
+        throw sharedAsyncLocalStorageNotAvailableError;
+    }
+    enterWith() {
+        throw sharedAsyncLocalStorageNotAvailableError;
+    }
+    static bind(fn) {
+        return fn;
+    }
+}
+const maybeGlobalAsyncLocalStorage = typeof globalThis !== 'undefined' && globalThis.AsyncLocalStorage;
+function createAsyncLocalStorage() {
+    if (maybeGlobalAsyncLocalStorage) {
+        return new maybeGlobalAsyncLocalStorage();
+    }
+    return new FakeAsyncLocalStorage();
+}
+function bindSnapshot(fn) {
+    if (maybeGlobalAsyncLocalStorage) {
+        return maybeGlobalAsyncLocalStorage.bind(fn);
+    }
+    return FakeAsyncLocalStorage.bind(fn);
+}
+function createSnapshot() {
+    // Ignored snapshot
+    return function(fn, ...args) {
+        return fn(...args);
+    };
+}
+
+//# sourceMappingURL=async-local-storage.js.map
+"`);
+});

package/dist/cli/build/patches/plugins/wrangler-external.js

@@ -14,6 +14,7 @@
  * ref: https://developers.cloudflare.com/workers/wrangler/bundling/
  */
 import { dirname, resolve } from "node:path";
+import { normalizePath } from "../../utils/normalize-path.js";
 export function setWranglerExternal() {
     return {
         name: "wrangler-externals",
@@ -22,7 +23,7 @@ export function setWranglerExternal() {
             //TODO: Ideally in the future we would like to analyze the files in case they are using wasm in a Node way (i.e. WebAssembly.instantiate)
             build.onResolve({ filter: /(\.bin|\.wasm(\?module)?)$/ }, ({ path, importer }) => {
                 return {
-                    path: resolve(dirname(importer), path),
+                    path: normalizePath(resolve(dirname(importer), path)),
                     namespace,
                     external: true,
                 };

package/dist/cli/build/utils/ensure-cf-config.js

@@ -6,6 +6,7 @@ import logger from "@opennextjs/aws/logger.js";
  */
 export function ensureCloudflareConfig(config) {
     const requirements = {
+        // Check for the default function
         dftUseCloudflareWrapper: config.default?.override?.wrapper === "cloudflare-node",
         dftUseEdgeConverter: config.default?.override?.converter === "edge",
         dftUseFetchProxy: config.default?.override?.proxyExternalRequest === "fetch",
@@ -16,7 +17,11 @@ export function ensureCloudflareConfig(config) {
         dftMaybeUseQueue: config.default?.override?.queue === "dummy" ||
             config.default?.override?.queue === "direct" ||
             typeof config.default?.override?.queue === "function",
-        mwIsMiddlewareIntegrated: config.middleware === undefined,
+        // Check for the middleware function
+        mwIsMiddlewareExternal: config.middleware?.external === true,
+        mwUseCloudflareWrapper: config.middleware?.override?.wrapper === "cloudflare-edge",
+        mwUseEdgeConverter: config.middleware?.override?.converter === "edge",
+        mwUseFetchProxy: config.middleware?.override?.proxyExternalRequest === "fetch",
         hasCryptoExternal: config.edgeExternals?.includes("node:crypto"),
     };
     if (config.default?.override?.queue === "direct") {
@@ -31,11 +36,22 @@ export function ensureCloudflareConfig(config) {
               converter: "edge",
               proxyExternalRequest: "fetch",
               incrementalCache: "dummy" | function,
-              tagCache: "dummy",
+              tagCache: "dummy" | function,
               queue: "dummy" | "direct" | function,
             },
           },
           edgeExternals: ["node:crypto"],
+          middleware: {
+            external: true,
+            override: {
+              wrapper: "cloudflare-edge",
+              converter: "edge",
+              proxyExternalRequest: "fetch",
+              incrementalCache: "dummy" | function,
+              tagCache: "dummy" | function,
+              queue: "dummy" | "direct" | function,
+            },
+          },
         }\n\n`.replace(/^ {8}/gm, ""));
     }
 }

package/dist/cli/commands/populate-cache.js

@@ -9,6 +9,7 @@ import { BINDING_NAME as R2_CACHE_BINDING_NAME, NAME as R2_CACHE_NAME, PREFIX_EN
 import { CACHE_DIR as STATIC_ASSETS_CACHE_DIR, NAME as STATIC_ASSETS_CACHE_NAME, } from "../../api/overrides/incremental-cache/static-assets-incremental-cache.js";
 import { computeCacheKey } from "../../api/overrides/internal.js";
 import { BINDING_NAME as D1_TAG_BINDING_NAME, NAME as D1_TAG_NAME, } from "../../api/overrides/tag-cache/d1-next-tag-cache.js";
+import { normalizePath } from "../build/utils/normalize-path.js";
 import { runWrangler } from "../utils/run-wrangler.js";
 async function resolveCacheName(value) {
     return typeof value === "function" ? (await value()).name : value;
@@ -20,8 +21,8 @@ export function getCacheAssets(opts) {
     }).filter((f) => f.isFile());
     const assets = [];
     for (const file of allFiles) {
-        const fullPath = file.fullpathPosix();
-        const relativePath = path.relative(path.join(opts.outputDir, "cache"), fullPath);
+        const fullPath = file.fullpath();
+        const relativePath = normalizePath(path.relative(path.join(opts.outputDir, "cache"), fullPath));
         if (relativePath.startsWith("__fetch")) {
             const [__fetch, buildId, ...keyParts] = relativePath.split("/");
             if (__fetch !== "__fetch" || buildId === undefined || keyParts.length === 0) {
@@ -74,7 +75,11 @@ async function populateR2IncrementalCache(options, populateCacheOptions) {
             buildId,
             cacheType: isFetch ? "fetch" : "cache",
         });
-        runWrangler(options, ["r2 object put", quoteShellMeta(path.join(bucket, cacheKey)), `--file ${quoteShellMeta(fullPath)}`], 
+        runWrangler(options, [
+            "r2 object put",
+            quoteShellMeta(normalizePath(path.join(bucket, cacheKey))),
+            `--file ${quoteShellMeta(fullPath)}`,
+        ], 
         // NOTE: R2 does not support the environment flag and results in the following error:
         // Incorrect type for the 'cacheExpiry' field on 'HttpMetadata': the provided value is not of type 'date'.
         { target: populateCacheOptions.target, logging: "error" });

package/dist/cli/templates/init.js

@@ -75,6 +75,10 @@ function initRuntime() {
         Request: CustomRequest,
         __BUILD_TIMESTAMP_MS__: __BUILD_TIMESTAMP_MS__,
         __NEXT_BASE_PATH__: __NEXT_BASE_PATH__,
+        // The external middleware will use the convertTo function of the `edge` converter
+        // by default it will try to fetch the request, but since we are running everything in the same worker
+        // we need to use the request as is.
+        __dangerous_ON_edge_converter_returns_request: true,
     });
 }
 /**

package/dist/cli/templates/worker.js

@@ -1,5 +1,7 @@
 //@ts-expect-error: Will be resolved by wrangler build
 import { runWithCloudflareRequestContext } from "./cloudflare/init.js";
+// @ts-expect-error: Will be resolved by wrangler build
+import { handler as middlewareHandler } from "./middleware/handler.mjs";
 //@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
@@ -27,9 +29,14 @@ export default {
                     ? env.ASSETS?.fetch(`http://assets.local${imageUrl}`)
                     : fetch(imageUrl, { cf: { cacheEverything: true } });
             }
+            // - `Request`s are handled by the Next server
+            const reqOrResp = await middlewareHandler(request, env, ctx);
+            if (reqOrResp instanceof Response) {
+                return reqOrResp;
+            }
             // @ts-expect-error: resolved by wrangler build
             const { handler } = await import("./server-functions/default/handler.mjs");
-            return handler(request, env, ctx);
+            return handler(reqOrResp, env, ctx);
         });
     },
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "1.0.1",
+  "version": "1.0.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.6.0",
+    "@opennextjs/aws": "^3.6.1",
     "enquirer": "^2.4.1",
     "glob": "^11.0.0",
     "ts-tqdm": "^0.8.6"

package/templates/wrangler.jsonc

@@ -13,9 +13,10 @@
     // See https://opennext.js.org/cloudflare/caching
     {
       "binding": "NEXT_INC_CACHE_R2_BUCKET",
-      // Create a bucket before deploying
+      // Create the bucket before deploying
+      // You can change the bucket name if you want
       // See https://developers.cloudflare.com/workers/wrangler/commands/#r2-bucket-create
-      "bucket_name": "<BUCKET_NAME>"
+      "bucket_name": "cache"
     }
   ]
 }