@opennextjs/cloudflare 0.3.2 → 0.3.4

package/dist/cli/args.d.ts

@@ -1,5 +1,6 @@
 export declare function getArgs(): {
     skipNextBuild: boolean;
+    skipWranglerConfigCheck: boolean;
     outputDir?: string;
     minify: boolean;
 };

package/dist/cli/args.js

@@ -2,7 +2,7 @@ import { mkdirSync, statSync } from "node:fs";
 import { resolve } from "node:path";
 import { parseArgs } from "node:util";
 export function getArgs() {
-    const { skipBuild, output, noMinify } = parseArgs({
+    const { skipBuild, skipWranglerConfigCheck, output, noMinify } = parseArgs({
         options: {
             skipBuild: {
                 type: "boolean",
@@ -17,6 +17,10 @@ export function getArgs() {
                 type: "boolean",
                 default: false,
             },
+            skipWranglerConfigCheck: {
+                type: "boolean",
+                default: false,
+            },
         },
         allowPositionals: false,
     }).values;
@@ -27,6 +31,8 @@ export function getArgs() {
     return {
         outputDir,
         skipNextBuild: skipBuild || ["1", "true", "yes"].includes(String(process.env.SKIP_NEXT_APP_BUILD)),
+        skipWranglerConfigCheck: skipWranglerConfigCheck ||
+            ["1", "true", "yes"].includes(String(process.env.SKIP_WRANGLER_CONFIG_CHECK)),
         minify: !noMinify,
     };
 }

package/dist/cli/build/bundle-server.d.ts

@@ -4,3 +4,10 @@ import { Config } from "../config.js";
  * Bundle the Open Next server.
  */
 export declare function bundleServer(config: Config, openNextOptions: BuildOptions): Promise<void>;
+/**
+ * Gets the path of the worker.js file generated by the build process
+ *
+ * @param openNextOptions the open-next build options
+ * @returns the path of the worker.js file that the build process generates
+ */
+export declare function getOutputWorkerPath(openNextOptions: BuildOptions): string;

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

@@ -82,7 +82,7 @@ fetch = globalThis.fetch;
 const CustomRequest = class extends globalThis.Request {
   constructor(input, init) {
     if (init) {
-      init.cache = undefined;
+      delete init.cache;
       // https://github.com/cloudflare/workerd/issues/2746
       // https://github.com/cloudflare/workerd/issues/3245
       Object.defineProperty(init, "body", {
@@ -106,7 +106,7 @@ globalThis.__BUILD_TIMESTAMP_MS__ = ${Date.now()};
         const packagePosixPath = packagePath.split(path.sep).join(path.posix.sep);
         fs.writeFileSync(path.join(outputPath, "handler.mjs"), `export * from "./${packagePosixPath}/handler.mjs";`);
     }
-    console.log(`\x1b[35mWorker saved in \`${openNextServerBundle}\` 🚀\n\x1b[0m`);
+    console.log(`\x1b[35mWorker saved in \`${getOutputWorkerPath(openNextOptions)}\` 🚀\n\x1b[0m`);
 }
 /**
  * This function applies string replacements on the bundled worker code necessary to get it to run in workerd
@@ -185,3 +185,12 @@ async function patchCodeWithValidations(code, patches) {
     console.log(`All ${patches.length} patches applied\n`);
     return patchedCode;
 }
+/**
+ * Gets the path of the worker.js file generated by the build process
+ *
+ * @param openNextOptions the open-next build options
+ * @returns the path of the worker.js file that the build process generates
+ */
+export function getOutputWorkerPath(openNextOptions) {
+    return path.join(openNextOptions.outputDir, "worker.js");
+}

package/dist/cli/build/index.d.ts

@@ -7,3 +7,4 @@ import type { ProjectOptions } from "../config.js";
  * @param projectOpts The options for the project
  */
 export declare function build(projectOpts: ProjectOptions): Promise<void>;
+export declare function getLatestCompatDate(): Promise<string | undefined>;

package/dist/cli/build/index.js

@@ -1,4 +1,4 @@
-import { cpSync, existsSync } from "node:fs";
+import { cpSync, existsSync, readFileSync, writeFileSync } from "node:fs";
 import { createRequire } from "node:module";
 import { dirname, join } from "node:path";
 import { buildNextjsApp, setStandaloneBuildMode } from "@opennextjs/aws/build/buildNextApp.js";
@@ -76,6 +76,9 @@ export async function build(projectOpts) {
     const projConfig = getConfig(projectOpts);
     // TODO: rely on options only.
     await bundleServer(projConfig, options);
+    if (!projectOpts.skipWranglerConfigCheck) {
+        await createWranglerConfigIfNotExistent(projectOpts);
+    }
     logger.info("OpenNext build complete.");
 }
 /**
@@ -141,3 +144,68 @@ function ensureCloudflareConfig(config) {
         }\n\n`.replace(/^ {8}/gm, ""));
     }
 }
+/**
+ * Creates a `wrangler.json` file for the user if a wrangler config file doesn't already exist,
+ * but only after asking for the user's confirmation.
+ *
+ * If the user refuses a warning is shown (which offers ways to opt out of this check to the user).
+ *
+ * Note: we generate a wrangler.json file with comments instead of using the jsonc extension,
+ *       we decided to do that since json is more common than jsonc, wrangler also parses
+ *       them in the same way and we also expect developers to associate `wrangler.json`
+ *       files to the jsonc language
+ *
+ * @param projectOpts The options for the project
+ */
+async function createWranglerConfigIfNotExistent(projectOpts) {
+    const possibleExts = ["toml", "json", "jsonc"];
+    const wranglerConfigFileExists = possibleExts.some((ext) => existsSync(join(projectOpts.sourceDir, `wrangler.${ext}`)));
+    if (wranglerConfigFileExists) {
+        return;
+    }
+    const answer = await askConfirmation("No `wrangler.(toml|json|jsonc)` config file found, do you want to create one?");
+    if (!answer) {
+        console.warn("No Wrangler config file created" +
+            "\n" +
+            "(to avoid this check use the `--skipWranglerConfigCheck` flag or set a `SKIP_WRANGLER_CONFIG_CHECK` environment variable to `yes`)");
+        return;
+    }
+    const wranglerConfigTemplate = readFileSync(join(getPackageTemplatesDirPath(), "defaults", "wrangler.jsonc"), "utf8");
+    let wranglerConfigContent = wranglerConfigTemplate;
+    const appName = getAppNameFromPackageJson(projectOpts.sourceDir) ?? "app-name";
+    if (appName) {
+        wranglerConfigContent = wranglerConfigContent.replace('"app-name"', JSON.stringify(appName.replaceAll("_", "-")));
+    }
+    const compatDate = await getLatestCompatDate();
+    if (compatDate) {
+        wranglerConfigContent = wranglerConfigContent.replace(/"compatibility_date": "\d{4}-\d{2}-\d{2}"/, `"compatibility_date": ${JSON.stringify(compatDate)}`);
+    }
+    writeFileSync(join(projectOpts.sourceDir, "wrangler.json"), wranglerConfigContent);
+}
+function getAppNameFromPackageJson(sourceDir) {
+    try {
+        const packageJsonStr = readFileSync(join(sourceDir, "package.json"), "utf8");
+        const packageJson = JSON.parse(packageJsonStr);
+        if (typeof packageJson.name === "string")
+            return packageJson.name;
+    }
+    catch {
+        /* empty */
+    }
+}
+export async function getLatestCompatDate() {
+    try {
+        const resp = await fetch(`https://registry.npmjs.org/workerd`);
+        const latestWorkerdVersion = (await resp.json())["dist-tags"].latest;
+        // The format of the workerd version is `major.yyyymmdd.patch`.
+        const match = latestWorkerdVersion.match(/\d+\.(\d{4})(\d{2})(\d{2})\.\d+/);
+        if (match) {
+            const [, year, month, date] = match;
+            const compatDate = `${year}-${month}-${date}`;
+            return compatDate;
+        }
+    }
+    catch {
+        /* empty */
+    }
+}

package/dist/cli/build/patches/investigated/copy-package-cli-files.d.ts

@@ -3,4 +3,4 @@ import { Config } from "../../../config.js";
 /**
  * Copies the template files present in the cloudflare adapter package into the standalone node_modules folder
  */
-export declare function copyPackageCliFiles(packageDistDir: string, config: Config, openNextConfig: BuildOptions): void;
+export declare function copyPackageCliFiles(packageDistDir: string, config: Config, openNextOptions: BuildOptions): void;

package/dist/cli/build/patches/investigated/copy-package-cli-files.js

@@ -1,12 +1,13 @@
 import fs from "node:fs";
 import path from "node:path";
+import { getOutputWorkerPath } from "../../bundle-server.js";
 /**
  * Copies the template files present in the cloudflare adapter package into the standalone node_modules folder
  */
-export function copyPackageCliFiles(packageDistDir, config, openNextConfig) {
+export function copyPackageCliFiles(packageDistDir, config, openNextOptions) {
     console.log("# copyPackageTemplateFiles");
     const sourceDir = path.join(packageDistDir, "cli");
     const destinationDir = path.join(config.paths.internal.package, "cli");
     fs.cpSync(sourceDir, destinationDir, { recursive: true });
-    fs.copyFileSync(path.join(packageDistDir, "cli", "templates", "worker.js"), path.join(openNextConfig.outputDir, "worker.js"));
+    fs.copyFileSync(path.join(packageDistDir, "cli", "templates", "worker.js"), getOutputWorkerPath(openNextOptions));
 }

package/dist/cli/build/utils/extract-project-env-vars.d.ts

@@ -6,7 +6,7 @@ import type { BuildOptions } from "@opennextjs/aws/build/helper.js";
  *
  * Merged variables respect the following priority order.
  * 1. `.env.{mode}.local`
- * 2. `.env.local`
+ * 2. `.env.local` (when mode is not equal to `test`)
  * 3. `.env.{mode}`
  * 4. `.env`
  *

package/dist/cli/build/utils/extract-project-env-vars.js

@@ -13,7 +13,7 @@ function readEnvFile(filePath) {
  *
  * Merged variables respect the following priority order.
  * 1. `.env.{mode}.local`
- * 2. `.env.local`
+ * 2. `.env.local` (when mode is not equal to `test`)
  * 3. `.env.{mode}`
  * 4. `.env`
  *
@@ -23,7 +23,7 @@ function readEnvFile(filePath) {
  * the env files at the root of the monorepo.
  */
 export function extractProjectEnvVars(mode, { monorepoRoot, appPath }) {
-    return [".env", `.env.${mode}`, ".env.local", `.env.${mode}.local`]
+    return [".env", `.env.${mode}`, ...(mode !== "test" ? [".env.local"] : []), `.env.${mode}.local`]
         .flatMap((fileName) => [
         ...(monorepoRoot !== appPath ? [readEnvFile(path.join(monorepoRoot, fileName))] : []),
         readEnvFile(path.join(appPath, fileName)),

package/dist/cli/build/utils/extract-project-env-vars.spec.js

@@ -8,6 +8,8 @@ describe("extractProjectEnvVars", () => {
         mockFs({
             ".env": "ENV_VAR=value",
             ".env.local": "ENV_LOCAL_VAR=value",
+            ".env.test": "ENV_TEST_VAR=value",
+            ".env.test.local": "ENV_TEST_LOCAL_VAR=value",
             ".env.development": "ENV_DEV_VAR=value",
             ".env.development.local": "ENV_DEV_LOCAL_VAR=value",
             ".env.production": "ENV_PROD_VAR=value",
@@ -54,4 +56,12 @@ describe("extractProjectEnvVars", () => {
             ENV_VAR: "value",
         });
     });
+    it("should exclude .env.local files when extracting test env vars", () => {
+        const result = extractProjectEnvVars("test", options);
+        expect(result).toEqual({
+            ENV_TEST_LOCAL_VAR: "value",
+            ENV_TEST_VAR: "value",
+            ENV_VAR: "value",
+        });
+    });
 });

package/dist/cli/config.d.ts

@@ -37,5 +37,6 @@ export type ProjectOptions = {
     sourceDir: string;
     outputDir: string;
     skipNextBuild: boolean;
+    skipWranglerConfigCheck: boolean;
     minify: boolean;
 };

package/dist/cli/index.js

@@ -3,10 +3,11 @@ import { resolve } from "node:path";
 import { getArgs } from "./args.js";
 import { build } from "./build/index.js";
 const nextAppDir = process.cwd();
-const { skipNextBuild, outputDir, minify } = getArgs();
+const { skipNextBuild, skipWranglerConfigCheck, outputDir, minify } = getArgs();
 await build({
     sourceDir: nextAppDir,
     outputDir: resolve(outputDir ?? nextAppDir, ".open-next"),
     skipNextBuild,
+    skipWranglerConfigCheck,
     minify,
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "type": "module",
   "bin": {
     "opennextjs-cloudflare": "dist/cli/index.js"
@@ -61,7 +61,7 @@
   },
   "dependencies": {
     "@dotenvx/dotenvx": "1.31.0",
-    "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@684",
+    "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@688",
     "glob": "^11.0.0",
     "rimraf": "^6.0.1",
     "ts-morph": "^23.0.0",

package/templates/defaults/wrangler.jsonc

@@ -0,0 +1,18 @@
+{
+  "main": ".open-next/worker.js",
+  "name": "app-name",
+  "compatibility_date": "2024-12-30",
+  "compatibility_flags": ["nodejs_compat"],
+  "assets": {
+    "directory": ".open-next/assets",
+    "binding": "ASSETS"
+  },
+  "kv_namespaces": [
+    // Create a KV binding with the binding name "NEXT_CACHE_WORKERS_KV"
+    // to enable the KV based caching:
+    // {
+    //   "binding": "NEXT_CACHE_WORKERS_KV",
+    //   "id": "<BINDING_ID>"
+    // }
+  ]
+}