refactor(wrangler): Explicitely pick node compat plugins for each mode

Author: vicb

packages/wrangler/src/deployment-bundle/bundle.ts

@@ -1,7 +1,5 @@
 import * as fs from "node:fs";
 import * as path from "node:path";
-import NodeGlobalsPolyfills from "@esbuild-plugins/node-globals-polyfill";
-import NodeModulesPolyfills from "@esbuild-plugins/node-modules-polyfill";
 import chalk from "chalk";
 import * as esbuild from "esbuild";
 import {
@@ -18,12 +16,9 @@ import {
 } from "./build-failures";
 import { dedupeModulesByName } from "./dedupe-modules";
 import { getEntryPointFromMetafile } from "./entry-point-from-metafile";
-import { asyncLocalStoragePlugin } from "./esbuild-plugins/als-external";
 import { cloudflareInternalPlugin } from "./esbuild-plugins/cloudflare-internal";
 import { configProviderPlugin } from "./esbuild-plugins/config-provider";
-import { nodejsHybridPlugin } from "./esbuild-plugins/hybrid-nodejs-compat";
-import { nodejsCompatPlugin } from "./esbuild-plugins/nodejs-compat";
-import { standardURLPlugin } from "./esbuild-plugins/standard-url";
+import { getNodeJSCompatPlugins } from "./esbuild-plugins/nodejs-plugins";
 import { writeAdditionalModules } from "./find-additional-modules";
 import { noopModuleCollector } from "./module-collection";
 import type { Config } from "../config";
@@ -440,20 +435,7 @@ export async function bundleWorker(
 		plugins: [
 			aliasPlugin,
 			moduleCollector.plugin,
-			...(nodejsCompatMode === "als" ? [asyncLocalStoragePlugin] : []),
-			...(nodejsCompatMode === "legacy"
-				? [
-						NodeGlobalsPolyfills({ buffer: true }),
-						standardURLPlugin(),
-						NodeModulesPolyfills(),
-					]
-				: []),
-			// Runtime Node.js compatibility (will warn if not using nodejs compat flag and are trying to import from a Node.js builtin).
-			...(nodejsCompatMode === "v1" || nodejsCompatMode !== "v2"
-				? [nodejsCompatPlugin(nodejsCompatMode === "v1")]
-				: []),
-			// Hybrid Node.js compatibility
-			...(nodejsCompatMode === "v2" ? [nodejsHybridPlugin()] : []),
+			...getNodeJSCompatPlugins(nodejsCompatMode ?? null),
 			cloudflareInternalPlugin,
 			buildResultPlugin,
 			...(plugins || []),

packages/wrangler/src/deployment-bundle/esbuild-plugins/nodejs-compat.ts

@@ -3,13 +3,16 @@ import chalk from "chalk";
 import { logger } from "../../logger";
 import { dedent } from "../../utils/dedent";
 import type { Plugin } from "esbuild";
+import type { NodeJSCompatMode } from "miniflare";
 
 /**
- * An esbuild plugin that will mark any `node:...` imports as external.
+ * An esbuild plugin that will:
+ * - mark any `node:...` imports as external
+ * - warn if there are node imports (if not in v1 mode)
+ *
+ * Applies to: null, als, legacy and v1 modes.
  */
-export const nodejsCompatPlugin: (silenceWarnings: boolean) => Plugin = (
-	silenceWarnings
-) => ({
+export const nodejsCompatPlugin = (mode: NodeJSCompatMode): Plugin => ({
 	name: "nodejs_compat-imports",
 	setup(pluginBuild) {
 		// Infinite loop detection
@@ -87,7 +90,7 @@ export const nodejsCompatPlugin: (silenceWarnings: boolean) => Plugin = (
 		// Wait until the build finishes to log warnings, so that all files which import a package
 		// can be collated
 		pluginBuild.onEnd(() => {
-			if (!silenceWarnings) {
+			if (mode !== "v1") {
 				warnedPackaged.forEach((importers: string[], path: string) => {
 					logger.warn(
 						dedent`

packages/wrangler/src/deployment-bundle/esbuild-plugins/nodejs-plugins.ts

@@ -0,0 +1,31 @@
+import NodeGlobalsPolyfills from "@esbuild-plugins/node-globals-polyfill";
+import NodeModulesPolyfills from "@esbuild-plugins/node-modules-polyfill";
+import { asyncLocalStoragePlugin } from "./als-external";
+import { nodejsHybridPlugin } from "./hybrid-nodejs-compat";
+import { nodejsCompatPlugin } from "./nodejs-compat";
+import { standardURLPlugin } from "./standard-url";
+import type { Plugin } from "esbuild";
+import type { NodeJSCompatMode } from "miniflare";
+
+/**
+ * Returns the list of ESBuild plugins to use for a given compat mode.
+ */
+export function getNodeJSCompatPlugins(mode: NodeJSCompatMode): Plugin[] {
+	switch (mode) {
+		case "als":
+			return [asyncLocalStoragePlugin, nodejsCompatPlugin(mode)];
+		case "legacy":
+			return [
+				NodeGlobalsPolyfills({ buffer: true }),
+				standardURLPlugin(),
+				NodeModulesPolyfills(),
+				nodejsCompatPlugin(mode),
+			];
+		case "v1":
+			return [nodejsCompatPlugin(mode)];
+		case "v2":
+			return [nodejsHybridPlugin()];
+		case null:
+			return [nodejsCompatPlugin(mode)];
+	}
+}