@opennextjs/cloudflare 0.4.0 → 0.4.1

package/dist/api/cloudflare-context.js

@@ -41,10 +41,28 @@ export function getCloudflareContext() {
  * Note: this function should only be called inside the Next.js config file, and although async it doesn't need to be `await`ed
  */
 export async function initOpenNextCloudflareForDev() {
+    const shouldInitializationRun = shouldContextInitializationRun();
+    if (!shouldInitializationRun)
+        return;
     const context = await getCloudflareContextFromWrangler();
     addCloudflareContextToNodejsGlobal(context);
     await monkeyPatchVmModuleEdgeContext(context);
 }
+/**
+ * Next dev server imports the config file twice (in two different processes, making it hard to track),
+ * this causes the initialization to run twice as well, to keep things clean, not allocate extra
+ * resources (i.e. instantiate two miniflare instances) and avoid extra potential logs, it would be best
+ * to run the initialization only once, this function is used to try to make it so that it does, it returns
+ * a flag which indicates if the initialization should run in the current process or not.
+ *
+ * @returns boolean indicating if the initialization should run
+ */
+function shouldContextInitializationRun() {
+    // via debugging we've seen that AsyncLocalStorage is only set in one of the
+    // two processes so we're using it as the differentiator between the two
+    const AsyncLocalStorage = globalThis["AsyncLocalStorage"];
+    return !!AsyncLocalStorage;
+}
 /**
  * Adds the cloudflare context to the global scope in which the Next.js dev node.js process runs in, enabling
  * future calls to `getCloudflareContext` to retrieve and return such context

package/dist/cli/build/bundle-server.js

@@ -8,6 +8,8 @@ import { getCrossPlatformPathRegex } from "@opennextjs/aws/utils/regex.js";
 import { build } from "esbuild";
 import { patchOptionalDependencies } from "./patches/ast/optional-deps.js";
 import * as patches from "./patches/index.js";
+import inlineRequirePagePlugin from "./patches/plugins/require-page.js";
+import setWranglerExternal from "./patches/plugins/wrangler-external.js";
 import { normalizePath, patchCodeWithValidations } from "./utils/index.js";
 /** The dist directory of the Cloudflare adapter package */
 const packageDistDir = path.join(path.dirname(fileURLToPath(import.meta.url)), "../..");
@@ -34,8 +36,18 @@ export async function bundleServer(buildOpts) {
         format: "esm",
         target: "esnext",
         minify: false,
-        plugins: [createFixRequiresESBuildPlugin(buildOpts)],
-        external: ["./middleware/handler.mjs", "caniuse-lite"],
+        plugins: [
+            createFixRequiresESBuildPlugin(buildOpts),
+            inlineRequirePagePlugin(buildOpts),
+            setWranglerExternal(),
+        ],
+        external: [
+            "./middleware/handler.mjs",
+            // Next optional dependencies.
+            "caniuse-lite",
+            "jimp",
+            "probe-image-size",
+        ],
         alias: {
             // Note: we apply an empty shim to next/dist/compiled/ws because it generates two `eval`s:
             //   eval("require")("bufferutil");
@@ -121,7 +133,6 @@ async function updateWorkerBundledCode(workerOutputFile, buildOpts) {
         ["require", patches.patchRequire],
         ["`buildId` function", (code) => patches.patchBuildId(code, buildOpts)],
         ["`loadManifest` function", (code) => patches.patchLoadManifest(code, buildOpts)],
-        ["next's require", (code) => patches.inlineNextRequire(code, buildOpts)],
         ["`findDir` function", (code) => patches.patchFindDir(code, buildOpts)],
         ["`evalManifest` function", (code) => patches.inlineEvalManifest(code, buildOpts)],
         ["cacheHandler", (code) => patches.patchCache(code, buildOpts)],

package/dist/cli/build/patches/ast/optional-deps.d.ts

@@ -1,12 +1,12 @@
 import { type SgNode } from "@ast-grep/napi";
 /**
- * Handle optional dependencies.
+ * Handles optional dependencies.
  *
  * A top level `require(optionalDep)` would throw when the dep is not installed.
  *
  * So we wrap `require(optionalDep)` in a try/catch (if not already present).
  */
-export declare const optionalDepRule = "\nrule:\n  pattern: $$$LHS = require($$$REQ)\n  has:\n    pattern: $MOD\n    kind: string_fragment\n    stopBy: end\n    regex: ^caniuse-lite(/|$)\n  not:\n    inside:\n      kind: try_statement\n      stopBy: end\n\nfix: |-\n  try {\n    $$$LHS = require($$$REQ);\n  } catch {\n    throw new Error('The optional dependency \"$MOD\" is not installed');\n  }\n";
+export declare const optionalDepRule = "\nrule:\n  pattern: $$$LHS = require($$$REQ)\n  has:\n    pattern: $MOD\n    kind: string_fragment\n    stopBy: end\n    regex: ^(caniuse-lite|jimp|probe-image-size)(/|$)\n  not:\n    inside:\n      kind: try_statement\n      stopBy: end\n\nfix: |-\n  try {\n    $$$LHS = require($$$REQ);\n  } catch {\n    throw new Error('The optional dependency \"$MOD\" is not installed');\n  }\n";
 export declare function patchOptionalDependencies(root: SgNode): {
     edits: import("@ast-grep/napi").Edit[];
     matches: SgNode<import("@ast-grep/napi/types/staticTypes.js").TypesMap, import("@ast-grep/napi/types/staticTypes.js").Kinds<import("@ast-grep/napi/types/staticTypes.js").TypesMap>>[];

package/dist/cli/build/patches/ast/optional-deps.js

@@ -1,6 +1,6 @@
 import { applyRule } from "./util.js";
 /**
- * Handle optional dependencies.
+ * Handles optional dependencies.
  *
  * A top level `require(optionalDep)` would throw when the dep is not installed.
  *
@@ -13,7 +13,7 @@ rule:
     pattern: $MOD
     kind: string_fragment
     stopBy: end
-    regex: ^caniuse-lite(/|$)
+    regex: ^(caniuse-lite|jimp|probe-image-size)(/|$)
   not:
     inside:
       kind: try_statement

package/dist/cli/build/patches/plugins/require-page.d.ts

@@ -0,0 +1,6 @@
+import { type BuildOptions } from "@opennextjs/aws/build/helper.js";
+import type { PluginBuild } from "esbuild";
+export default function inlineRequirePagePlugin(buildOpts: BuildOptions): {
+    name: string;
+    setup: (build: PluginBuild) => Promise<void>;
+};

package/dist/cli/build/patches/plugins/require-page.js

@@ -0,0 +1,70 @@
+import { existsSync, readFileSync } from "node:fs";
+import { readFile } from "node:fs/promises";
+import { join } from "node:path";
+import { getPackagePath } from "@opennextjs/aws/build/helper.js";
+import { getCrossPlatformPathRegex } from "@opennextjs/aws/utils/regex.js";
+import { patchCode } from "../ast/util.js";
+export default function inlineRequirePagePlugin(buildOpts) {
+    return {
+        name: "inline-require-page",
+        setup: async (build) => {
+            build.onLoad({
+                filter: getCrossPlatformPathRegex(String.raw `/next/dist/server/require\.js$`, { escape: false }),
+            }, async ({ path }) => {
+                const jsCode = await readFile(path, "utf8");
+                if (/function requirePage\(/.test(jsCode)) {
+                    return { contents: patchCode(jsCode, getRule(buildOpts)) };
+                }
+            });
+        },
+    };
+}
+function getRule(buildOpts) {
+    const { outputDir } = buildOpts;
+    const serverDir = join(outputDir, "server-functions/default", getPackagePath(buildOpts), ".next/server");
+    const pagesManifestFile = join(serverDir, "pages-manifest.json");
+    const appPathsManifestFile = join(serverDir, "app-paths-manifest.json");
+    const pagesManifests = existsSync(pagesManifestFile)
+        ? Object.values(JSON.parse(readFileSync(pagesManifestFile, "utf-8")))
+        : [];
+    const appPathsManifests = existsSync(appPathsManifestFile)
+        ? Object.values(JSON.parse(readFileSync(appPathsManifestFile, "utf-8")))
+        : [];
+    const manifests = pagesManifests.concat(appPathsManifests);
+    const htmlFiles = manifests.filter((file) => file.endsWith(".html"));
+    const jsFiles = manifests.filter((file) => file.endsWith(".js"));
+    // Inline fs access and dynamic require that are not supported by workerd.
+    const fnBody = `
+// html
+${htmlFiles
+        .map((file) => `if (pagePath.endsWith("${file}")) {
+        return ${JSON.stringify(readFileSync(join(serverDir, file), "utf-8"))};
+      }`)
+        .join("\n")}
+// js
+process.env.__NEXT_PRIVATE_RUNTIME_TYPE = isAppPath ? 'app' : 'pages';
+try {
+  ${jsFiles
+        .map((file) => `if (pagePath.endsWith("${file}")) {
+        return require(${JSON.stringify(join(serverDir, file))});
+      }`)
+        .join("\n")}
+} finally {
+  process.env.__NEXT_PRIVATE_RUNTIME_TYPE = '';
+}
+`;
+    return {
+        rule: {
+            pattern: `
+function requirePage($PAGE, $DIST_DIR, $IS_APPP_ATH) {
+  const $_ = getPagePath($$$ARGS);
+  $$$_BODY
+}`,
+        },
+        fix: `
+function requirePage($PAGE, $DIST_DIR, $IS_APPP_ATH) {
+  const pagePath = getPagePath($$$ARGS);
+  ${fnBody}
+}`,
+    };
+}

package/dist/cli/build/patches/plugins/wrangler-external.d.ts

@@ -0,0 +1,20 @@
+/**
+ * ESBuild plugin to mark files bundled by wrangler as external.
+ *
+ * `.wasm` and `.bin` will ultimately be bundled by wrangler.
+ * We should only mark them as external in the adapter.
+ *
+ * However simply marking them as external would copy the import path to the bundle,
+ * i.e. `import("./file.wasm?module")` and given than the bundle is generated in a
+ * different location than the input files, the relative path would not be valid.
+ *
+ * This ESBuild plugin convert relative paths to absolute paths so that they are
+ * still valid from inside the bundle.
+ *
+ * ref: https://developers.cloudflare.com/workers/wrangler/bundling/
+ */
+import type { PluginBuild } from "esbuild";
+export default function setWranglerExternal(): {
+    name: string;
+    setup: (build: PluginBuild) => Promise<void>;
+};

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

@@ -0,0 +1,36 @@
+/**
+ * ESBuild plugin to mark files bundled by wrangler as external.
+ *
+ * `.wasm` and `.bin` will ultimately be bundled by wrangler.
+ * We should only mark them as external in the adapter.
+ *
+ * However simply marking them as external would copy the import path to the bundle,
+ * i.e. `import("./file.wasm?module")` and given than the bundle is generated in a
+ * different location than the input files, the relative path would not be valid.
+ *
+ * This ESBuild plugin convert relative paths to absolute paths so that they are
+ * still valid from inside the bundle.
+ *
+ * ref: https://developers.cloudflare.com/workers/wrangler/bundling/
+ */
+import { dirname, resolve } from "node:path";
+export default function setWranglerExternal() {
+    return {
+        name: "wrangler-externals",
+        setup: async (build) => {
+            const namespace = "wrangler-externals-plugin";
+            build.onResolve({ filter: /(\.bin|\.wasm\?module)$/ }, ({ path, importer }) => {
+                return {
+                    path: resolve(dirname(importer), path),
+                    namespace,
+                    external: true,
+                };
+            });
+            build.onLoad({ filter: /.*/, namespace }, async ({ path }) => {
+                return {
+                    contents: `export * from '${path}';`,
+                };
+            });
+        },
+    };
+}

package/dist/cli/build/patches/to-investigate/index.d.ts

@@ -1,6 +1,5 @@
 export * from "./inline-eval-manifest.js";
 export * from "./inline-middleware-manifest-require.js";
-export * from "./inline-next-require.js";
 export * from "./patch-exception-bubbling.js";
 export * from "./patch-find-dir.js";
 export * from "./patch-load-instrumentation-module.js";

package/dist/cli/build/patches/to-investigate/index.js

@@ -1,6 +1,5 @@
 export * from "./inline-eval-manifest.js";
 export * from "./inline-middleware-manifest-require.js";
-export * from "./inline-next-require.js";
 export * from "./patch-exception-bubbling.js";
 export * from "./patch-find-dir.js";
 export * from "./patch-load-instrumentation-module.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "type": "module",
   "bin": {
     "opennextjs-cloudflare": "dist/cli/index.js"

package/dist/cli/build/patches/to-investigate/inline-next-require.d.ts

@@ -1,6 +0,0 @@
-import { type BuildOptions } from "@opennextjs/aws/build/helper.js";
-/**
- * The following avoid various Next.js specific files `require`d at runtime since we can just read
- * and inline their content during build time
- */
-export declare function inlineNextRequire(code: string, buildOpts: BuildOptions): string;

package/dist/cli/build/patches/to-investigate/inline-next-require.js

@@ -1,40 +0,0 @@
-import { existsSync, readFileSync } from "node:fs";
-import { join } from "node:path";
-import { getPackagePath } from "@opennextjs/aws/build/helper.js";
-/**
- * The following avoid various Next.js specific files `require`d at runtime since we can just read
- * and inline their content during build time
- */
-// TODO(vicb): __NEXT_PRIVATE_RUNTIME_TYPE is not handled by this patch
-export function inlineNextRequire(code, buildOpts) {
-    const { outputDir } = buildOpts;
-    const serverDir = join(outputDir, "server-functions/default", getPackagePath(buildOpts), ".next/server");
-    const pagesManifestFile = join(serverDir, "pages-manifest.json");
-    const appPathsManifestFile = join(serverDir, "app-paths-manifest.json");
-    const pagesManifests = existsSync(pagesManifestFile)
-        ? Object.values(JSON.parse(readFileSync(pagesManifestFile, "utf-8")))
-        : [];
-    const appPathsManifests = existsSync(appPathsManifestFile)
-        ? Object.values(JSON.parse(readFileSync(appPathsManifestFile, "utf-8")))
-        : [];
-    const manifests = pagesManifests.concat(appPathsManifests);
-    const htmlPages = manifests.filter((file) => file.endsWith(".html"));
-    const pageModules = manifests.filter((file) => file.endsWith(".js"));
-    return code.replace(/const pagePath = getPagePath\(.+?\);/, `$&
-    ${htmlPages
-        .map((htmlPage) => `
-          if (pagePath.endsWith("${htmlPage}")) {
-            return ${JSON.stringify(readFileSync(join(serverDir, htmlPage), "utf-8"))};
-          }
-        `)
-        .join("\n")}
-    ${pageModules
-        .map((module) => `
-          if (pagePath.endsWith("${module}")) {
-            return require(${JSON.stringify(join(serverDir, module))});
-          }
-        `)
-        .join("\n")}
-    throw new Error("Unknown pagePath: " + pagePath);
-    `);
-}