@opennextjs/cloudflare 0.4.3 → 0.4.4

package/dist/api/cloudflare-context.js

@@ -15,6 +15,17 @@ export function getCloudflareContext() {
     const global = globalThis;
     const cloudflareContext = global[cloudflareContextSymbol];
     if (!cloudflareContext) {
+        // For SSG Next.js creates (jest) workers that run in parallel, those don't get the current global
+        // state so they can't get access to the cloudflare context, unfortunately there isn't anything we
+        // can do about this, so the only solution is to error asking the developer to opt-out of SSG
+        // Next.js sets globalThis.__NEXT_DATA__.nextExport to true for the worker, so we can use that to detect
+        // that the route is being SSG'd (source: https://github.com/vercel/next.js/blob/4e394608423/packages/next/src/export/worker.ts#L55-L57)
+        if (global.__NEXT_DATA__?.nextExport === true) {
+            throw new Error(`\n\nERROR: \`getCloudflareContext\` has been called in a static route` +
+                ` that is not allowed, please either avoid calling \`getCloudflareContext\`` +
+                ` in the route or make the route non static (for example by exporting the` +
+                ` \`dynamic\` route segment config set to \`'force-dynamic'\`.\n`);
+        }
         // the cloudflare context is initialized by the worker and is always present in production/preview
         // during local development (`next dev`) it might be missing only if the developers hasn't called
         // the `initOpenNextCloudflareForDev` function in their Next.js config file

package/dist/cli/build/build.js

@@ -13,6 +13,7 @@ import { compileEnvFiles } from "./open-next/compile-env-files.js";
 import { copyCacheAssets } from "./open-next/copyCacheAssets.js";
 import { createServerBundle } from "./open-next/createServerBundle.js";
 import { createOpenNextConfigIfNotExistent, createWranglerConfigIfNotExistent, ensureCloudflareConfig, } from "./utils/index.js";
+import { getVersion } from "./utils/version.js";
 /**
  * Builds the application in a format that can be passed to workerd
  *
@@ -40,7 +41,9 @@ export async function build(projectOpts) {
     logger.info(`App directory: ${options.appPath}`);
     buildHelper.printNextjsVersion(options);
     ensureNextjsVersionSupported(options);
-    buildHelper.printOpenNextVersion(options);
+    const { aws, cloudflare } = getVersion();
+    logger.info(`@opennextjs/cloudflare version: ${cloudflare}`);
+    logger.info(`@opennextjs/aws version: ${aws}`);
     if (projectOpts.skipNextBuild) {
         logger.warn("Skipping Next.js build");
     }

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

@@ -2,16 +2,15 @@ import fs from "node:fs";
 import { readFile, writeFile } from "node:fs/promises";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
-import { Lang, parse } from "@ast-grep/napi";
 import { getPackagePath } from "@opennextjs/aws/build/helper.js";
 import { getCrossPlatformPathRegex } from "@opennextjs/aws/utils/regex.js";
 import { build } from "esbuild";
-import { patchOptionalDependencies } from "./patches/ast/optional-deps.js";
 import { patchVercelOgLibrary } from "./patches/ast/patch-vercel-og-library.js";
 import * as patches from "./patches/index.js";
-import fixRequire from "./patches/plugins/require.js";
-import inlineRequirePagePlugin from "./patches/plugins/require-page.js";
-import setWranglerExternal from "./patches/plugins/wrangler-external.js";
+import { handleOptionalDependencies } from "./patches/plugins/optional-deps.js";
+import { fixRequire } from "./patches/plugins/require.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)), "../..");
@@ -56,8 +55,9 @@ export async function bundleServer(buildOpts) {
             inlineRequirePagePlugin(buildOpts),
             setWranglerExternal(),
             fixRequire(),
+            handleOptionalDependencies(optionalDependencies),
         ],
-        external: ["./middleware/handler.mjs", ...optionalDependencies],
+        external: ["./middleware/handler.mjs"],
         alias: {
             // Note: we apply an empty shim to next/dist/compiled/ws because it generates two `eval`s:
             //   eval("require")("bufferutil");
@@ -74,7 +74,7 @@ export async function bundleServer(buildOpts) {
         },
         define: {
             // config file used by Next.js, see: https://github.com/vercel/next.js/blob/68a7128/packages/next/src/build/utils.ts#L2137-L2139
-            "process.env.__NEXT_PRIVATE_STANDALONE_CONFIG": `${JSON.stringify(nextConfig)}`,
+            "process.env.__NEXT_PRIVATE_STANDALONE_CONFIG": JSON.stringify(JSON.stringify(nextConfig)),
             // Next.js tried to access __dirname so we need to define it
             __dirname: '""',
             // Note: we need the __non_webpack_require__ variable declared as it is used by next-server:
@@ -168,9 +168,7 @@ export async function updateWorkerBundledCode(workerOutputFile, buildOpts) {
             (code) => code.replace('require.resolve("./cache.cjs")', '"unused"'),
         ],
     ]);
-    const bundle = parse(Lang.TypeScript, patchedCode).root();
-    const { edits } = patchOptionalDependencies(bundle, optionalDependencies);
-    await writeFile(workerOutputFile, bundle.commitEdits(edits));
+    await writeFile(workerOutputFile, patchedCode);
 }
 function createFixRequiresESBuildPlugin(options) {
     return {

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

@@ -0,0 +1,15 @@
+/**
+ * ESBuild plugin to handle optional dependencies.
+ *
+ * Optional dependencies might be installed by the application to support optional features.
+ *
+ * When an optional dependency is installed, it must be inlined in the bundle.
+ * When it is not installed, the plugin swaps it for a throwing implementation.
+ *
+ * The plugin uses ESBuild built-in resolution to check if the dependency is installed.
+ */
+import type { PluginBuild } from "esbuild";
+export declare function handleOptionalDependencies(dependencies: string[]): {
+    name: string;
+    setup: (build: PluginBuild) => Promise<void>;
+};

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

@@ -0,0 +1,52 @@
+/**
+ * ESBuild plugin to handle optional dependencies.
+ *
+ * Optional dependencies might be installed by the application to support optional features.
+ *
+ * When an optional dependency is installed, it must be inlined in the bundle.
+ * When it is not installed, the plugin swaps it for a throwing implementation.
+ *
+ * The plugin uses ESBuild built-in resolution to check if the dependency is installed.
+ */
+export function handleOptionalDependencies(dependencies) {
+    // Regex matching either a full module ("module") or a prefix ("module/...")
+    const filter = new RegExp(`^(${dependencies.flatMap((name) => [`${name}$`, String.raw `${name}/`]).join("|")})`);
+    const name = "optional-deps";
+    const marker = {};
+    const nsMissingDependency = `${name}-missing-dependency`;
+    return {
+        name,
+        setup: async (build) => {
+            build.onResolve({ filter }, async ({ path, pluginData, ...options }) => {
+                // Use ESBuild to resolve the dependency.
+                // Because the plugin asks ESBuild to resolve the path we just received,
+                // ESBuild will ask this plugin again.
+                // We use a marker in the pluginData to break the loop.
+                if (pluginData === marker) {
+                    return {};
+                }
+                const result = await build.resolve(path, {
+                    ...options,
+                    pluginData: marker,
+                });
+                // ESBuild reports error when the dependency is not installed.
+                // In such a case the OnLoad hook will inline a throwing implementation.
+                if (result.errors.length > 0) {
+                    return {
+                        path: `/${path}`,
+                        namespace: nsMissingDependency,
+                        pluginData: { name: path },
+                    };
+                }
+                // Returns ESBuild resolution information when the dependency is installed.
+                return result;
+            });
+            // Replaces missing dependency with a throwing implementation.
+            build.onLoad({ filter: /.*/, namespace: nsMissingDependency }, ({ pluginData }) => {
+                return {
+                    contents: `throw new Error('Missing optional dependency "${pluginData.name}"')`,
+                };
+            });
+        },
+    };
+}

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

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

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

@@ -4,7 +4,7 @@ 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) {
+export function inlineRequirePagePlugin(buildOpts) {
     return {
         name: "inline-require-page",
         setup: async (build) => {

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

@@ -1,5 +1,5 @@
 import type { PluginBuild } from "esbuild";
-export default function fixRequire(): {
+export declare function fixRequire(): {
     name: string;
     setup: (build: PluginBuild) => Promise<void>;
 };

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

@@ -1,9 +1,9 @@
 import fs from "node:fs/promises";
-export default function fixRequire() {
+export function fixRequire() {
     return {
         name: "fix-require",
         setup: async (build) => {
-            build.onLoad({ filter: /.*/ }, async ({ path }) => {
+            build.onLoad({ filter: /\.(js|mjs|cjs|jsx|ts|tsx)$/ }, async ({ path }) => {
                 let contents = await fs.readFile(path, "utf-8");
                 // `eval(...)` is not supported by workerd.
                 contents = contents.replaceAll(`eval("require")`, "require");

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

@@ -14,7 +14,7 @@
  * ref: https://developers.cloudflare.com/workers/wrangler/bundling/
  */
 import type { PluginBuild } from "esbuild";
-export default function setWranglerExternal(): {
+export declare function setWranglerExternal(): {
     name: string;
     setup: (build: PluginBuild) => Promise<void>;
 };

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

@@ -14,7 +14,7 @@
  * ref: https://developers.cloudflare.com/workers/wrangler/bundling/
  */
 import { dirname, resolve } from "node:path";
-export default function setWranglerExternal() {
+export function setWranglerExternal() {
     return {
         name: "wrangler-externals",
         setup: async (build) => {

package/dist/cli/build/utils/version.d.ts

@@ -0,0 +1,4 @@
+export declare function getVersion(): {
+    cloudflare: any;
+    aws: any;
+};

package/dist/cli/build/utils/version.js

@@ -0,0 +1,12 @@
+import { createRequire } from "node:module";
+import { join } from "node:path";
+import { fileURLToPath } from "node:url";
+export function getVersion() {
+    const require = createRequire(import.meta.url);
+    const __dirname = fileURLToPath(new URL(".", import.meta.url));
+    const pkgJson = require(join(__dirname, "../../../../package.json"));
+    return {
+        cloudflare: pkgJson.version,
+        aws: pkgJson.dependencies["@opennextjs/aws"],
+    };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "type": "module",
   "bin": {
     "opennextjs-cloudflare": "dist/cli/index.js"
@@ -63,7 +63,7 @@
   "dependencies": {
     "@ast-grep/napi": "^0.34.1",
     "@dotenvx/dotenvx": "1.31.0",
-    "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@715",
+    "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@722",
     "enquirer": "^2.4.1",
     "glob": "^11.0.0",
     "ts-morph": "^23.0.0",

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

@@ -1,20 +0,0 @@
-import { type SgNode } from "@ast-grep/napi";
-/**
- * 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 function buildOptionalDepRule(dependencies: string[]): string;
-/**
- * Wraps requires for passed dependencies in a `try ... catch`.
- *
- * @param root AST root node
- * @param dependencies List of dependencies to wrap
- * @returns matches and edits, see `applyRule`
- */
-export declare function patchOptionalDependencies(root: SgNode, dependencies: string[]): {
-    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,44 +0,0 @@
-import { applyRule } from "./util.js";
-/**
- * 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 function buildOptionalDepRule(dependencies) {
-    // Build a regexp matching either
-    // - the full packages names, i.e. `package`
-    // - subpaths in the package, i.e. `package/...`
-    const regex = `^(${dependencies.join("|")})(/|$)`;
-    return `
-  rule:
-    pattern: $$$LHS = require($$$REQ)
-    has:
-      pattern: $MOD
-      kind: string_fragment
-      stopBy: end
-      regex: ${regex}
-    not:
-      inside:
-        kind: try_statement
-        stopBy: end
-
-  fix: |-
-    try {
-      $$$LHS = require($$$REQ);
-    } catch {
-      throw new Error('The optional dependency "$MOD" is not installed');
-    }
-  `;
-}
-/**
- * Wraps requires for passed dependencies in a `try ... catch`.
- *
- * @param root AST root node
- * @param dependencies List of dependencies to wrap
- * @returns matches and edits, see `applyRule`
- */
-export function patchOptionalDependencies(root, dependencies) {
-    return applyRule(buildOptionalDepRule(dependencies), root);
-}

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

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

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

@@ -1,135 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { buildOptionalDepRule } from "./optional-deps.js";
-import { patchCode } from "./util.js";
-describe("optional dependecy", () => {
-    it('should wrap a top-level require("caniuse-lite") in a try-catch', () => {
-        const code = `t = require("caniuse-lite");`;
-        expect(patchCode(code, buildOptionalDepRule(["caniuse-lite"]))).toMatchInlineSnapshot(`
-      "try {
-        t = require("caniuse-lite");
-      } catch {
-        throw new Error('The optional dependency "caniuse-lite" is not installed');
-      };"
-    `);
-    });
-    it('should wrap a top-level require("caniuse-lite/data") in a try-catch', () => {
-        const code = `t = require("caniuse-lite/data");`;
-        expect(patchCode(code, buildOptionalDepRule(["caniuse-lite"]))).toMatchInlineSnapshot(`
-      "try {
-        t = require("caniuse-lite/data");
-      } catch {
-        throw new Error('The optional dependency "caniuse-lite/data" is not installed');
-      };"
-    `);
-    });
-    it('should wrap e.exports = require("caniuse-lite") in a try-catch', () => {
-        const code = 'e.exports = require("caniuse-lite");';
-        expect(patchCode(code, buildOptionalDepRule(["caniuse-lite"]))).toMatchInlineSnapshot(`
-      "try {
-        e.exports = require("caniuse-lite");
-      } catch {
-        throw new Error('The optional dependency "caniuse-lite" is not installed');
-      };"
-    `);
-    });
-    it('should wrap module.exports = require("caniuse-lite") in a try-catch', () => {
-        const code = 'module.exports = require("caniuse-lite");';
-        expect(patchCode(code, buildOptionalDepRule(["caniuse-lite"]))).toMatchInlineSnapshot(`
-      "try {
-        module.exports = require("caniuse-lite");
-      } catch {
-        throw new Error('The optional dependency "caniuse-lite" is not installed');
-      };"
-    `);
-    });
-    it('should wrap exports.foo = require("caniuse-lite") in a try-catch', () => {
-        const code = 'exports.foo = require("caniuse-lite");';
-        expect(patchCode(code, buildOptionalDepRule(["caniuse-lite"]))).toMatchInlineSnapshot(`
-      "try {
-        exports.foo = require("caniuse-lite");
-      } catch {
-        throw new Error('The optional dependency "caniuse-lite" is not installed');
-      };"
-    `);
-    });
-    it('should not wrap require("lodash") in a try-catch', () => {
-        const code = 't = require("lodash");';
-        expect(patchCode(code, buildOptionalDepRule(["caniuse-lite"]))).toMatchInlineSnapshot(`"t = require("lodash");"`);
-    });
-    it('should not wrap require("other-module") if it does not match caniuse-lite regex', () => {
-        const code = 't = require("other-module");';
-        expect(patchCode(code, buildOptionalDepRule(["caniuse-lite"]))).toMatchInlineSnapshot(`"t = require("other-module");"`);
-    });
-    it("should not wrap a require() call already inside a try-catch", () => {
-        const code = `
-try {
-  t = require("caniuse-lite");
-} catch {}
-`;
-        expect(patchCode(code, buildOptionalDepRule(["caniuse-lite"]))).toMatchInlineSnapshot(`
-      "try {
-        t = require("caniuse-lite");
-      } catch {}
-      "
-    `);
-    });
-    it("should handle require with subpath and not wrap if already in try-catch", () => {
-        const code = `
-try {
-   t = require("caniuse-lite/path");
-} catch {}
-`;
-        expect(patchCode(code, buildOptionalDepRule(["caniuse-lite"]))).toMatchInlineSnapshot(`
-      "try {
-         t = require("caniuse-lite/path");
-      } catch {}
-      "
-    `);
-    });
-    it("should handle multiple dependencies", () => {
-        const code = `
-t1 = require("caniuse-lite");
-t2 = require("caniuse-lite/path");
-t3 = require("jimp");
-t4 = require("jimp/path");
-`;
-        expect(patchCode(code, buildOptionalDepRule(["caniuse-lite", "jimp"]))).toMatchInlineSnapshot(`
-      "try {
-        t1 = require("caniuse-lite");
-      } catch {
-        throw new Error('The optional dependency "caniuse-lite" is not installed');
-      };
-      try {
-        t2 = require("caniuse-lite/path");
-      } catch {
-        throw new Error('The optional dependency "caniuse-lite/path" is not installed');
-      };
-      try {
-        t3 = require("jimp");
-      } catch {
-        throw new Error('The optional dependency "jimp" is not installed');
-      };
-      try {
-        t4 = require("jimp/path");
-      } catch {
-        throw new Error('The optional dependency "jimp/path" is not installed');
-      };
-      "
-    `);
-    });
-    it("should not update partial matches", () => {
-        const code = `
-t1 = require("before-caniuse-lite");
-t2 = require("before-caniuse-lite/path");
-t3 = require("caniuse-lite-after");
-t4 = require("caniuse-lite-after/path");
-`;
-        expect(patchCode(code, buildOptionalDepRule(["caniuse-lite"]))).toMatchInlineSnapshot(`
-      "t1 = require("before-caniuse-lite");
-      t2 = require("before-caniuse-lite/path");
-      t3 = require("caniuse-lite-after");
-      t4 = require("caniuse-lite-after/path");
-      "
-    `);
-    });
-});