@opennextjs/cloudflare 0.3.9 → 0.3.10

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

@@ -2,7 +2,10 @@ 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 { 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 { normalizePath, patchCodeWithValidations } from "./utils/index.js";
 /** The dist directory of the Cloudflare adapter package */
@@ -31,7 +34,7 @@ export async function bundleServer(config, openNextOptions) {
         target: "esnext",
         minify: false,
         plugins: [createFixRequiresESBuildPlugin(config)],
-        external: ["./middleware/handler.mjs"],
+        external: ["./middleware/handler.mjs", "caniuse-lite"],
         alias: {
             // Note: we apply an empty shim to next/dist/compiled/ws because it generates two `eval`s:
             //   eval("require")("bufferutil");
@@ -149,14 +152,16 @@ async function updateWorkerBundledCode(workerOutputFile, config, openNextOptions
             (code) => code.replace('require.resolve("./cache.cjs")', '"unused"'),
         ],
     ]);
-    await writeFile(workerOutputFile, patchedCode);
+    const bundle = parse(Lang.TypeScript, patchedCode).root();
+    const edits = patchOptionalDependencies(bundle);
+    await writeFile(workerOutputFile, bundle.commitEdits(edits));
 }
 function createFixRequiresESBuildPlugin(config) {
     return {
         name: "replaceRelative",
         setup(build) {
             // Note: we (empty) shim require-hook modules as they generate problematic code that uses requires
-            build.onResolve({ filter: /^\.(\/|\\)require-hook$/ }, () => ({
+            build.onResolve({ filter: getCrossPlatformPathRegex(String.raw `^\./require-hook$`, { escape: false }) }, () => ({
                 path: path.join(config.paths.internal.templates, "shims", "empty.js"),
             }));
         },

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

@@ -13,6 +13,7 @@ import { minifyAll } from "@opennextjs/aws/minimize-js.js";
 import { openNextEdgePlugins } from "@opennextjs/aws/plugins/edge.js";
 import { openNextReplacementPlugin } from "@opennextjs/aws/plugins/replacement.js";
 import { openNextResolvePlugin } from "@opennextjs/aws/plugins/resolve.js";
+import { getCrossPlatformPathRegex } from "@opennextjs/aws/utils/regex.js";
 import { normalizePath } from "../utils/index.js";
 export async function createServerBundle(options) {
     const { config } = options;
@@ -117,7 +118,7 @@ async function generateBundle(name, options, fnOptions) {
     const plugins = [
         openNextReplacementPlugin({
             name: `requestHandlerOverride ${name}`,
-            target: /core(\/|\\)requestHandler\.js/g,
+            target: getCrossPlatformPathRegex("core/requestHandler.js"),
             deletes: [
                 ...(disableNextPrebundledReact ? ["applyNextjsPrebundledReact"] : []),
                 ...(disableRouting ? ["withRouting"] : []),
@@ -125,7 +126,7 @@ async function generateBundle(name, options, fnOptions) {
         }),
         openNextReplacementPlugin({
             name: `utilOverride ${name}`,
-            target: /core(\/|\\)util\.js/g,
+            target: getCrossPlatformPathRegex("core/util.js"),
             deletes: [
                 ...(disableNextPrebundledReact ? ["requireHooks"] : []),
                 ...(isBefore13413 ? ["trustHostHeader"] : ["requestHandlerHost"]),

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

@@ -0,0 +1,10 @@
+import { type SgNode } from "@ast-grep/napi";
+/**
+ * Handle 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 function patchOptionalDependencies(root: SgNode): import("@ast-grep/napi").Edit[];

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

@@ -0,0 +1,31 @@
+import { getRuleEdits } from "./util.js";
+/**
+ * Handle 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 const optionalDepRule = `
+rule:
+  pattern: $$$LHS = require($$$REQ)
+  has:
+    pattern: $MOD
+    kind: string_fragment
+    stopBy: end
+    regex: ^caniuse-lite(/|$)
+  not:
+    inside:
+      kind: try_statement
+      stopBy: end
+
+fix: |-
+  try {
+    $$$LHS = require($$$REQ);
+  } catch {
+    throw new Error('The optional dependency "$MOD" is not installed');
+  }
+`;
+export function patchOptionalDependencies(root) {
+    return getRuleEdits(optionalDepRule, root);
+}

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

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

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

@@ -0,0 +1,89 @@
+import { describe, expect, it } from "vitest";
+import { optionalDepRule } 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, optionalDepRule)).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, optionalDepRule)).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, optionalDepRule)).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, optionalDepRule)).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, optionalDepRule)).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, optionalDepRule)).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, optionalDepRule)).toMatchInlineSnapshot(`"t = require("other-module");"`);
+    });
+    it("should not wrap a require() call already inside a try-catch", () => {
+        const code = `
+try {
+  const t = require("caniuse-lite");
+} catch {}
+`;
+        expect(patchCode(code, optionalDepRule)).toMatchInlineSnapshot(`
+      "try {
+        const t = require("caniuse-lite");
+      } catch {}
+      "
+    `);
+    });
+    it("should handle require with subpath and not wrap if already in try-catch", () => {
+        const code = `
+try {
+  const t = require("caniuse-lite/path");
+} catch {}
+`;
+        expect(patchCode(code, optionalDepRule)).toMatchInlineSnapshot(`
+      "try {
+        const t = require("caniuse-lite/path");
+      } catch {}
+      "
+    `);
+    });
+});

package/dist/cli/build/patches/ast/util.d.ts

@@ -0,0 +1,39 @@
+import { type Edit, Lang, type NapiConfig, type SgNode } from "@ast-grep/napi";
+/**
+ * fix has the same meaning as in yaml rules
+ * see https://ast-grep.github.io/guide/rewrite-code.html#using-fix-in-yaml-rule
+ */
+export type RuleConfig = NapiConfig & {
+    fix?: string;
+};
+/**
+ * Returns the `Edit`s for an ast-grep rule in yaml format
+ *
+ * The rule must have a `fix` to rewrite the matched node.
+ *
+ * Tip: use https://ast-grep.github.io/playground.html to create rules.
+ *
+ * @param rule The rule. Either a yaml string or an instance of `RuleConfig`
+ * @param root The root node
+ * @param once only apply once
+ * @returns A list of edits.
+ */
+export declare function getRuleEdits(rule: string | RuleConfig, root: SgNode, { once }?: {
+    once?: boolean | undefined;
+}): Edit[];
+/**
+ * Patches the code from by applying the rule.
+ *
+ * This function is mainly for on off edits and tests,
+ * use `getRuleEdits` to apply multiple rules.
+ *
+ * @param code The source code
+ * @param rule The astgrep rule (yaml or NapiConfig)
+ * @param lang The language used by the source code
+ * @param lang Whether to apply the rule only once
+ * @returns The patched code
+ */
+export declare function patchCode(code: string, rule: string | RuleConfig, { lang, once }?: {
+    lang?: Lang | undefined;
+    once?: boolean | undefined;
+}): string;

package/dist/cli/build/patches/ast/util.js

@@ -0,0 +1,54 @@
+import { Lang, parse } from "@ast-grep/napi";
+import yaml from "yaml";
+/**
+ * Returns the `Edit`s for an ast-grep rule in yaml format
+ *
+ * The rule must have a `fix` to rewrite the matched node.
+ *
+ * Tip: use https://ast-grep.github.io/playground.html to create rules.
+ *
+ * @param rule The rule. Either a yaml string or an instance of `RuleConfig`
+ * @param root The root node
+ * @param once only apply once
+ * @returns A list of edits.
+ */
+export function getRuleEdits(rule, root, { once = false } = {}) {
+    const ruleConfig = typeof rule === "string" ? yaml.parse(rule) : rule;
+    if (ruleConfig.transform) {
+        throw new Error("transform is not supported");
+    }
+    if (!ruleConfig.fix) {
+        throw new Error("no fix to apply");
+    }
+    const fix = ruleConfig.fix;
+    const matches = once ? [root.find(ruleConfig)].filter((m) => m !== null) : root.findAll(ruleConfig);
+    const edits = [];
+    matches.forEach((match) => {
+        edits.push(match.replace(
+        // Replace known placeholders by their value
+        fix
+            .replace(/\$\$\$([A-Z0-9_]+)/g, (_m, name) => match
+            .getMultipleMatches(name)
+            .map((n) => n.text())
+            .join(""))
+            .replace(/\$([A-Z0-9_]+)/g, (m, name) => match.getMatch(name)?.text() ?? m)));
+    });
+    return edits;
+}
+/**
+ * Patches the code from by applying the rule.
+ *
+ * This function is mainly for on off edits and tests,
+ * use `getRuleEdits` to apply multiple rules.
+ *
+ * @param code The source code
+ * @param rule The astgrep rule (yaml or NapiConfig)
+ * @param lang The language used by the source code
+ * @param lang Whether to apply the rule only once
+ * @returns The patched code
+ */
+export function patchCode(code, rule, { lang = Lang.TypeScript, once = false } = {}) {
+    const node = parse(lang, code).root();
+    const edits = getRuleEdits(rule, node, { once });
+    return node.commitEdits(edits);
+}

package/dist/cli/build/patches/ast/util.spec.d.ts

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

package/dist/cli/build/patches/ast/util.spec.js

@@ -0,0 +1,43 @@
+import { afterEach, describe, expect, it, vi } from "vitest";
+import { patchCode } from "./util.js";
+describe("patchCode", () => {
+    afterEach(() => {
+        vi.clearAllMocks();
+    });
+    it("should throw an error if rule has a transform", () => {
+        expect(() => patchCode(`console.log("hi")`, { rule: { pattern: "console.log($MSG)" }, transform: "not supported" })).toThrow(/not supported/);
+    });
+    it("should throw an error if rule has no fix", () => {
+        expect(() => patchCode(`console.log("hi")`, { rule: { pattern: "console.log($MSG)" } })).toThrow(/no fix/);
+    });
+    it("should accept yaml rules", () => {
+        const yamlRule = `
+rule:
+  pattern: a
+fix: b
+`;
+        expect(patchCode(`a`, yamlRule)).toEqual("b");
+    });
+    it("should apply fix to a single match when once is true", () => {
+        expect(patchCode(`a+a`, { rule: { pattern: "a" }, fix: "b" }, { once: true })).toEqual("b+a");
+    });
+    it("should apply fix to all matches when once is false (default)", () => {
+        expect(patchCode(`a+a`, { rule: { pattern: "a" }, fix: "b" })).toEqual("b+b");
+        expect(patchCode(`a+a`, { rule: { pattern: "a" }, fix: "b" }, { once: false })).toEqual("b+b");
+    });
+    it("should handle no matches", () => {
+        expect(patchCode(`a`, { rule: { pattern: "b" }, fix: "c" })).toEqual("a");
+    });
+    it("should replace $PLACEHOLDER with match text", () => {
+        expect(patchCode(`console.log(message)`, { rule: { pattern: "console.log($MSG)" }, fix: "$MSG" })).toEqual("message");
+    });
+    it("should handle $PLACEHODLERS that are not found in matches", () => {
+        expect(patchCode(`console.log(message)`, { rule: { pattern: "console.log($MSG)" }, fix: "$WHAT$$$WHAT" })).toEqual("$WHAT");
+    });
+    it("should replace $$$PLACEHOLDER with match text", () => {
+        expect(patchCode(`console.log("hello" + world, "!")`, {
+            rule: { pattern: "console.log($$$ARGS)" },
+            fix: "$$$ARGS",
+        })).toEqual(`"hello" + world,"!"`);
+    });
+});

package/dist/cli/build/patches/to-investigate/inline-eval-manifest.js

@@ -9,7 +9,7 @@ import { normalizePath } from "../../utils/index.js";
  * there is a vm `runInNewContext` call which we also don't support (source: https://github.com/vercel/next.js/blob/b1e32c5d1f/packages/next/src/server/load-manifest.ts#L88)
  */
 export function inlineEvalManifest(code, config) {
-    const manifestJss = globSync(normalizePath(join(config.paths.output.standaloneAppDotNext, "**", "*_client-reference-manifest.js"))).map((file) => normalizePath(file).replace(normalizePath(config.paths.output.standaloneApp) + posix.sep, ""));
+    const manifestJss = globSync(normalizePath(join(config.paths.output.standaloneAppDotNext, "**/*_client-reference-manifest.js"))).map((file) => normalizePath(file).replace(normalizePath(config.paths.output.standaloneApp) + posix.sep, ""));
     return code.replace(/function evalManifest\((.+?), .+?\) {/, `$&
 		${manifestJss
         .map((manifestJs) => `

package/dist/cli/build/patches/to-investigate/patch-read-file.js

@@ -15,7 +15,7 @@ export function patchLoadManifest(code, config) {
     // Same as patchBuildId, the next-server code loads the manifests with `readFileSync` and we want to avoid that
     // (source: https://github.com/vercel/next.js/blob/15aeb92e/packages/next/src/server/load-manifest.ts#L34-L56)
     // Note: we could/should probably just patch readFileSync here or something!
-    const manifestJsons = globSync(normalizePath(join(config.paths.output.standaloneAppDotNext, "**", "*-manifest.json"))).map((file) => normalizePath(file).replace(normalizePath(config.paths.output.standaloneApp) + posix.sep, ""));
+    const manifestJsons = globSync(normalizePath(join(config.paths.output.standaloneAppDotNext, "**/*-manifest.json"))).map((file) => normalizePath(file).replace(normalizePath(config.paths.output.standaloneApp) + posix.sep, ""));
     return code.replace(/function loadManifest\((.+?), .+?\) {/, `$&
     ${manifestJsons
         .map((manifestJson) => `

package/dist/cli/build/patches/to-investigate/wrangler-deps.js

@@ -12,7 +12,7 @@ export function patchWranglerDeps(config) {
     // [alias]
     // # critters is `require`d from `pages.runtime.prod.js` when running wrangler dev, so we need to stub it out
     // "critters" = "./.next/standalone/node_modules/cf/templates/shims/empty.ts"
-    const pagesRuntimeFile = join(distPath, "compiled", "next-server", "pages.runtime.prod.js");
+    const pagesRuntimeFile = join(distPath, "compiled/next-server/pages.runtime.prod.js");
     const patchedPagesRuntime = readFileSync(pagesRuntimeFile, "utf-8").replace(`e.exports=require("critters")`, `e.exports={}`);
     writeFileSync(pagesRuntimeFile, patchedPagesRuntime);
     patchRequireReactDomServerEdge(config);
@@ -26,7 +26,7 @@ export function patchWranglerDeps(config) {
     // #            try block here: https://github.com/vercel/next.js/blob/9e8266a7/packages/next/src/server/lib/trace/tracer.ts#L27-L31
     // #            causing the code to require the 'next/dist/compiled/@opentelemetry/api' module instead (which properly works)
     // #"@opentelemetry/api" = "./.next/standalone/node_modules/cf/templates/shims/throw.ts"
-    const tracerFile = join(distPath, "server", "lib", "trace", "tracer.js");
+    const tracerFile = join(distPath, "server/lib/trace/tracer.js");
     const patchedTracer = readFileSync(tracerFile, "utf-8").replaceAll(/\w+\s*=\s*require\([^/]*opentelemetry.*\)/g, `throw new Error("@opentelemetry/api")`);
     writeFileSync(tracerFile, patchedTracer);
 }
@@ -45,7 +45,7 @@ export function patchWranglerDeps(config) {
 function getDistPath(config) {
     for (const root of [config.paths.output.standaloneApp, config.paths.output.standaloneRoot]) {
         try {
-            const distPath = join(root, "node_modules", "next", "dist");
+            const distPath = join(root, "node_modules/next/dist");
             if (statSync(distPath).isDirectory())
                 return distPath;
         }
@@ -73,7 +73,7 @@ function getDistPath(config) {
 function patchRequireReactDomServerEdge(config) {
     const distPath = getDistPath(config);
     // Patch .next/standalone/node_modules/next/dist/compiled/next-server/pages.runtime.prod.js
-    const pagesRuntimeFile = join(distPath, "compiled", "next-server", "pages.runtime.prod.js");
+    const pagesRuntimeFile = join(distPath, "compiled/next-server/pages.runtime.prod.js");
     const code = readFileSync(pagesRuntimeFile, "utf-8");
     const file = tsParseFile(code);
     // we need to update this function: `e=>{"use strict";e.exports=require("react-dom/server.edge")}`

package/dist/cli/build/utils/create-config-files.js

@@ -28,7 +28,7 @@ export async function createWranglerConfigIfNotExistent(projectOpts) {
             "(to avoid this check use the `--skipWranglerConfigCheck` flag or set a `SKIP_WRANGLER_CONFIG_CHECK` environment variable to `yes`)");
         return;
     }
-    let wranglerConfig = readFileSync(join(getPackageTemplatesDirPath(), "defaults", "wrangler.json"), "utf8");
+    let wranglerConfig = readFileSync(join(getPackageTemplatesDirPath(), "defaults/wrangler.json"), "utf8");
     const appName = getAppNameFromPackageJson(projectOpts.sourceDir) ?? "app-name";
     if (appName) {
         wranglerConfig = wranglerConfig.replace('"app-name"', JSON.stringify(appName.replaceAll("_", "-")));
@@ -80,6 +80,6 @@ export async function createOpenNextConfigIfNotExistent(projectOpts) {
         if (!answer) {
             throw new Error("The `open-next.config.ts` file is required, aborting!");
         }
-        cpSync(join(getPackageTemplatesDirPath(), "defaults", "open-next.config.ts"), openNextConfigPath);
+        cpSync(join(getPackageTemplatesDirPath(), "defaults/open-next.config.ts"), openNextConfigPath);
     }
 }

package/dist/cli/config.js

@@ -17,7 +17,7 @@ export function getConfig(projectOpts) {
     const standaloneAppServer = join(standaloneAppDotNext, "server");
     const nodeModules = join(standaloneApp, "node_modules");
     const internalPackage = join(nodeModules, ...PACKAGE_NAME.split("/"));
-    const internalTemplates = join(internalPackage, "cli", "templates");
+    const internalTemplates = join(internalPackage, "cli/templates");
     return {
         build: {
             skipNextBuild: projectOpts.skipNextBuild,
@@ -72,7 +72,7 @@ function getNextjsApplicationPath(dotNextDir) {
 }
 function findServerParentPath(parentPath) {
     try {
-        if (statSync(join(parentPath, ".next", "server")).isDirectory()) {
+        if (statSync(join(parentPath, ".next/server")).isDirectory()) {
             return parentPath;
         }
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "0.3.9",
+  "version": "0.3.10",
   "type": "module",
   "bin": {
     "opennextjs-cloudflare": "dist/cli/index.js"
@@ -48,27 +48,29 @@
     "@types/mock-fs": "^4.13.4",
     "@types/node": "^22.2.0",
     "esbuild": "^0.23.0",
+    "eslint": "^9.11.1",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-unicorn": "^55.0.0",
-    "eslint": "^9.11.1",
     "globals": "^15.9.0",
     "mock-fs": "^5.4.1",
     "next": "14.2.11",
     "rimraf": "^6.0.1",
+    "typescript": "^5.7.3",
     "typescript-eslint": "^8.7.0",
-    "typescript": "^5.5.4",
     "vitest": "^2.1.1"
   },
   "dependencies": {
+    "@ast-grep/napi": "^0.33.1",
     "@dotenvx/dotenvx": "1.31.0",
     "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@704",
+    "enquirer": "^2.4.1",
     "glob": "^11.0.0",
     "ts-morph": "^23.0.0",
-    "enquirer": "^2.4.1"
+    "yaml": "^2.7.0"
   },
   "peerDependencies": {
-    "wrangler": "^3.101.0"
+    "wrangler": "^3.103.0"
   },
   "scripts": {
     "clean": "rimraf dist",

package/templates/defaults/wrangler.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "node_modules/wrangler/config-schema.json",
   "main": ".open-next/worker.js",
   "name": "app-name",
   "compatibility_date": "2024-12-30",