Ensure the nodejs_compat flag is always applied in autoconfig (#12572)

Co-authored-by: emily-shen <69125074+emily-shen@users.noreply.github.com>

Author: dario-piotrowicz

.changeset/fruity-views-flow.md

@@ -0,0 +1,9 @@
+---
+"wrangler": minor
+---
+
+Ensure the `nodejs_compat` flag is always applied in autoconfig
+
+Previously, the autoconfig feature relied on individual framework configurations to specify Node.js compatibility flags, some could set `nodejs_compat` while others `nodejs_als`.
+
+Now instead `nodejs_compat` is always included as a compatibility flag, this is generally beneficial and the user can always remove the flag afterwards if they want to.

packages/wrangler/src/__tests__/autoconfig/run.test.ts

@@ -270,7 +270,10 @@ describe("autoconfig (deploy)", () => {
 				    },
 				    "assets": {
 				      "directory": "dist"
-				    }
+				    },
+				    "compatibility_flags": [
+				      "nodejs_compat"
+				    ]
 				  }
 
 				🛠️  Configuring project for Fake
@@ -288,7 +291,10 @@ describe("autoconfig (deploy)", () => {
 				  },
 				  "assets": {
 				    "directory": "dist"
-				  }
+				  },
+				  "compatibility_flags": [
+				    "nodejs_compat"
+				  ]
 				}
 				"
 			`);
@@ -440,7 +446,10 @@ describe("autoconfig (deploy)", () => {
 				    },
 				    "assets": {
 				      "directory": "dist"
-				    }
+				    },
+				    "compatibility_flags": [
+				      "nodejs_compat"
+				    ]
 				  }
 				"
 			`);
@@ -455,7 +464,10 @@ describe("autoconfig (deploy)", () => {
 				  },
 				  "assets": {
 				    "directory": "dist"
-				  }
+				  },
+				  "compatibility_flags": [
+				    "nodejs_compat"
+				  ]
 				}
 				"
 			`);
@@ -595,5 +607,151 @@ describe("autoconfig (deploy)", () => {
 				`[Error: The detected framework ("Some Unsupported Framework") cannot be automatically configured.]`
 			);
 		});
+
+		describe("nodejs_compat compatibility flag", () => {
+			it("should add nodejs_compat when framework specifies no compatibility flags", async () => {
+				mockConfirm({
+					text: "Do you want to modify these settings?",
+					result: false,
+				});
+				mockConfirm({
+					text: "Proceed with setup?",
+					result: true,
+				});
+
+				await run.runAutoConfig({
+					projectPath: process.cwd(),
+					workerName: "my-worker",
+					configured: false,
+					outputDir: "dist",
+					framework: {
+						id: "no-flags-framework",
+						name: "No Flags Framework",
+						autoConfigSupported: true,
+						configure: async () => ({
+							wranglerConfig: {
+								// No compatibility_flags specified
+								assets: { directory: "dist" },
+							},
+						}),
+						isConfigured: () => false,
+					},
+					packageManager: NpmPackageManager,
+				});
+
+				const wranglerConfig = JSON.parse(readFileSync("wrangler.jsonc"));
+				expect(wranglerConfig.compatibility_flags).toEqual(["nodejs_compat"]);
+			});
+
+			it("should preserve other compatibility flags while adding nodejs_compat", async () => {
+				mockConfirm({
+					text: "Do you want to modify these settings?",
+					result: false,
+				});
+				mockConfirm({
+					text: "Proceed with setup?",
+					result: true,
+				});
+
+				await run.runAutoConfig({
+					projectPath: process.cwd(),
+					workerName: "my-worker",
+					configured: false,
+					outputDir: "dist",
+					framework: {
+						id: "other-flags-framework",
+						name: "Other Flags Framework",
+						autoConfigSupported: true,
+						configure: async () => ({
+							wranglerConfig: {
+								compatibility_flags: ["global_fetch_strictly_public"],
+								assets: { directory: "dist" },
+							},
+						}),
+						isConfigured: () => false,
+					},
+					packageManager: NpmPackageManager,
+				});
+
+				const wranglerConfig = JSON.parse(readFileSync("wrangler.jsonc"));
+				expect(wranglerConfig.compatibility_flags).toEqual([
+					"global_fetch_strictly_public",
+					"nodejs_compat",
+				]);
+			});
+
+			it("should not duplicate nodejs_compat if already present", async () => {
+				mockConfirm({
+					text: "Do you want to modify these settings?",
+					result: false,
+				});
+				mockConfirm({
+					text: "Proceed with setup?",
+					result: true,
+				});
+
+				await run.runAutoConfig({
+					projectPath: process.cwd(),
+					workerName: "my-worker",
+					configured: false,
+					outputDir: "dist",
+					framework: {
+						id: "nodejs-compat-framework",
+						name: "Nodejs Compat Framework",
+						autoConfigSupported: true,
+						configure: async () => ({
+							wranglerConfig: {
+								compatibility_flags: ["nodejs_compat"],
+								assets: { directory: "dist" },
+							},
+						}),
+						isConfigured: () => false,
+					},
+					packageManager: NpmPackageManager,
+				});
+
+				const wranglerConfig = JSON.parse(readFileSync("wrangler.jsonc"));
+				expect(wranglerConfig.compatibility_flags).toEqual(["nodejs_compat"]);
+			});
+
+			it("should replace nodejs_als with nodejs_compat", async () => {
+				mockConfirm({
+					text: "Do you want to modify these settings?",
+					result: false,
+				});
+				mockConfirm({
+					text: "Proceed with setup?",
+					result: true,
+				});
+
+				await run.runAutoConfig({
+					projectPath: process.cwd(),
+					workerName: "my-worker",
+					configured: false,
+					outputDir: "dist",
+					framework: {
+						id: "nodejs-als-framework",
+						name: "Nodejs Als Framework",
+						autoConfigSupported: true,
+						configure: async () => ({
+							wranglerConfig: {
+								compatibility_flags: ["nodejs_als", "some_other_flag"],
+								assets: { directory: "dist" },
+							},
+						}),
+						isConfigured: () => false,
+					},
+					packageManager: NpmPackageManager,
+				});
+
+				const wranglerConfig = JSON.parse(readFileSync("wrangler.jsonc"));
+				// nodejs_als should be removed, nodejs_compat should be added, some_other_flag preserved
+				expect(wranglerConfig.compatibility_flags).toEqual([
+					"some_other_flag",
+					"nodejs_compat",
+				]);
+				expect(wranglerConfig.compatibility_flags).not.toContain("nodejs_als");
+			});
+		});
 	});
 });

packages/wrangler/src/__tests__/setup.test.ts

@@ -188,6 +188,9 @@ describe("wrangler setup", () => {
 			      "directory": "public",
 			    },
 			    "compatibility_date": "YYYY-MM-DD",
+			    "compatibility_flags": [
+			      "nodejs_compat",
+			    ],
 			    "name": "test-name",
 			    "observability": {
 			      "enabled": true,
@@ -257,7 +260,10 @@ describe("wrangler setup", () => {
 				    },
 				    "assets": {
 				      "directory": "<DIR>"
-				    }
+				    },
+				    "compatibility_flags": [
+				      "nodejs_compat"
+				    ]
 				  }
 
 				✋  Autoconfig process run in dry-run mode, existing now.

packages/wrangler/src/autoconfig/frameworks/astro.ts

@@ -24,7 +24,7 @@ export class Astro extends Framework {
 		return {
 			wranglerConfig: {
 				main: `${outputDir}/_worker.js/index.js`,
-				compatibility_flags: ["nodejs_compat", "global_fetch_strictly_public"],
+				compatibility_flags: ["global_fetch_strictly_public"],
 				assets: {
 					binding: "ASSETS",
 					directory: outputDir,

packages/wrangler/src/autoconfig/frameworks/qwik.ts

@@ -38,7 +38,7 @@ export class Qwik extends Framework {
 		return {
 			wranglerConfig: {
 				main: "./dist/_worker.js",
-				compatibility_flags: ["nodejs_compat", "global_fetch_strictly_public"],
+				compatibility_flags: ["global_fetch_strictly_public"],
 				assets: {
 					binding: "ASSET",
 					directory: "./dist",

packages/wrangler/src/autoconfig/frameworks/solid-start.ts

@@ -57,7 +57,6 @@ export class SolidStart extends Framework {
 		return {
 			wranglerConfig: {
 				main: "./.output/server/index.mjs",
-				compatibility_flags: ["nodejs_compat"],
 				assets: {
 					binding: "ASSETS",
 					directory: "./.output/public",

packages/wrangler/src/autoconfig/frameworks/sveltekit.ts

@@ -39,7 +39,6 @@ export class SvelteKit extends Framework {
 		return {
 			wranglerConfig: {
 				main: ".svelte-kit/cloudflare/_worker.js",
-				compatibility_flags: ["nodejs_als"],
 				assets: {
 					binding: "ASSETS",
 					directory: ".svelte-kit/cloudflare",

packages/wrangler/src/autoconfig/frameworks/tanstack.ts

@@ -22,7 +22,6 @@ export class TanstackStart extends Framework {
 
 		return {
 			wranglerConfig: {
-				compatibility_flags: ["nodejs_compat"],
 				main: "@tanstack/react-start/server-entry",
 			},
 		};

packages/wrangler/src/autoconfig/frameworks/waku.ts

@@ -40,7 +40,6 @@ export class Waku extends Framework {
 		return {
 			wranglerConfig: {
 				main: "./dist/server/serve-cloudflare.js",
-				compatibility_flags: ["nodejs_compat"],
 				assets: {
 					binding: "ASSETS",
 					directory: "./dist/public",

packages/wrangler/src/autoconfig/run.ts

@@ -23,10 +23,7 @@ import {
 import { Static } from "./frameworks/static";
 import { getAutoConfigId } from "./telemetry-utils";
 import { usesTypescript } from "./uses-typescript";
-import type {
-	ConfigurationResults,
-	PackageJsonScriptsOverrides,
-} from "./frameworks";
+import type { PackageJsonScriptsOverrides } from "./frameworks";
 import type {
 	AutoConfigDetails,
 	AutoConfigDetailsForNonConfiguredProject,
@@ -119,10 +116,10 @@ export async function runAutoConfig(
 
 		autoConfigSummary = await buildOperationsSummary(
 			{ ...autoConfigDetails, outputDir: autoConfigDetails.outputDir },
-			{
+			ensureNodejsCompatIsInConfig({
 				...wranglerConfig,
 				...dryRunConfigurationResults.wranglerConfig,
-			},
+			}),
 			{
 				build:
 					dryRunConfigurationResults.buildCommandOverride ??
@@ -204,8 +201,10 @@ export async function runAutoConfig(
 
 		await saveWranglerJsonc(
 			autoConfigDetails.projectPath,
-			wranglerConfig,
-			configurationResults.wranglerConfig
+			ensureNodejsCompatIsInConfig({
+				...wranglerConfig,
+				...configurationResults.wranglerConfig,
+			})
 		);
 
 		addWranglerToGitIgnore(autoConfigDetails.projectPath);
@@ -254,27 +253,41 @@ export async function runAutoConfig(
 }
 
 /**
- * Saves the a wrangler.jsonc file for the current project by combining:
- *  - the autoconfig base values for wrangler config
- *  - the framework's `configure()` wrangler config values
- *  - the potential pre-existing wrangler config file generated by the framework's CLI
+ * Given a wrangler config object this function makes sure that the `nodejs_compat` flag is present
+ * in its `compatibility_flags` setting.
+ *
+ * Just to be sure the function also filters out any compatibility flag already present starting with `nodejs_` (e.g. `nodejs_als`)
+ *
+ * @param wranglerConfig The target wrangler config object
+ * @returns A copy of the config object where the `compatibility_flags` settings is assured to contain `nodejs_compat`
+ */
+function ensureNodejsCompatIsInConfig(wranglerConfig: RawConfig): RawConfig {
+	if (wranglerConfig.compatibility_flags?.includes("nodejs_compat")) {
+		return wranglerConfig;
+	}
+
+	return {
+		...wranglerConfig,
+		compatibility_flags: [
+			...(wranglerConfig.compatibility_flags?.filter(
+				(flag) => !flag.startsWith("nodejs_")
+			) ?? []),
+			"nodejs_compat",
+		],
+	};
+}
+
+/**
+ * Saves the a wrangler.jsonc file for the current project potentially combining new values to the potential
+ * pre-existing wrangler config file generated by the framework's CLI
  *
  * @param projectPath The project's path
- * @param baseWranglerConfig The base autoconfig values for the wrangler config
- * @param configurationWranglerConfig The wrangler values from the framework's `configure()`
+ * @param baseWranglerConfig The wrangler config to use
  */
 async function saveWranglerJsonc(
 	projectPath: string,
-	baseWranglerConfig: RawConfig,
-	configurationWranglerConfig:
-		| ConfigurationResults["wranglerConfig"]
-		| undefined
+	wranglerConfig: RawConfig
 ): Promise<void> {
-	const autoconfigWranglerConfigValues = {
-		...baseWranglerConfig,
-		...configurationWranglerConfig,
-	};
-
 	let existingWranglerConfig: RawConfig = {};
 
 	const wranglerConfigPath = getDirWranglerJsonConfigPath(projectPath);
@@ -291,7 +304,7 @@ async function saveWranglerJsonc(
 		JSON.stringify(
 			{
 				...existingWranglerConfig,
-				...autoconfigWranglerConfigValues,
+				...wranglerConfig,
 			},
 			null,
 			2