use the new resolve.builtins vite config to specify the cloudflare and node builtins

Author: dario-piotrowicz

packages/vite-plugin-cloudflare/src/cloudflare-environment.ts

@@ -1,4 +1,3 @@
-import { builtinModules } from 'node:module';
 import * as path from 'node:path';
 import * as vite from 'vite';
 import { getNodeCompatExternals } from './node-js-compat';
@@ -134,6 +133,7 @@ export function createCloudflareEnvironmentOptions(
 				noExternal: true,
 				// We want to use `workerd` package exports if available (e.g. for postgres).
 				conditions: ['workerd', 'module', 'browser', 'development|production'],
+				builtins: [...cloudflareBuiltInModules],
 			},
 			dev: {
 				createEnvironment(name, config) {
@@ -155,17 +155,12 @@ export function createCloudflareEnvironmentOptions(
 					input: userConfig.root
 						? path.resolve(userConfig.root, options.main)
 						: path.resolve(options.main),
-					external: [...cloudflareBuiltInModules, ...getNodeCompatExternals()],
+					external: [...getNodeCompatExternals()],
 				},
 			},
 			optimizeDeps: {
 				// Note: ssr pre-bundling is opt-in, and we need to enabled it by setting noDiscovery to false
 				noDiscovery: false,
-				exclude: [
-					...cloudflareBuiltInModules,
-					// we have to exclude all node modules to work in dev-mode not just the unenv externals...
-					...builtinModules.concat(builtinModules.map((m) => `node:${m}`)),
-				],
 				esbuildOptions: {
 					platform: 'neutral',
 					resolveExtensions: [

packages/vite-plugin-cloudflare/src/index.ts

@@ -1,4 +1,5 @@
 import * as fs from 'node:fs';
+import { builtinModules } from 'node:module';
 import path from 'node:path';
 import { createMiddleware } from '@hattip/adapter-node';
 import { Miniflare } from 'miniflare';
@@ -15,6 +16,7 @@ import {
 import {
 	getNodeCompatAliases,
 	injectGlobalCode,
+	isNodeCompat,
 	resolveNodeAliases,
 } from './node-js-compat';
 import { normalizePluginConfig } from './plugin-config';
@@ -96,6 +98,9 @@ export function cloudflare<T extends Record<string, WorkerOptions>>(
 				pluginConfig,
 				resolvedConfig,
 			);
+			Object.keys(normalizedPluginConfig.workers).forEach((name) =>
+				addNodeBuiltinsIfNeeded(resolvedConfig, name, normalizedPluginConfig),
+			);
 		},
 		async resolveId(source) {
 			const worker = normalizedPluginConfig.workers[this.environment.name];
@@ -206,3 +211,38 @@ export function cloudflare<T extends Record<string, WorkerOptions>>(
 		},
 	};
 }
+
+/**
+ * Adds to the worker resolved configuration the necessary node builtin config options if the worker is under nodejs compat
+ *
+ * @param resolvedConfig the vite resolved config (that will be side-effectfully updated)
+ * @param name the name of the worker
+ * @param normalizedPluginConfig the normalized/resolved plugin config
+ */
+function addNodeBuiltinsIfNeeded(
+	resolvedConfig: vite.ResolvedConfig,
+	name: string,
+	normalizedPluginConfig: NormalizedPluginConfig,
+) {
+	invariant(
+		resolvedConfig.environments[name] && normalizedPluginConfig.workers[name],
+		`environment configs for worker "${name}" not found`,
+	);
+
+	const nodeCompat = isNodeCompat(
+		normalizedPluginConfig.workers[name].workerOptions,
+	);
+
+	const nodeCompatModules = nodeCompat
+		? [...builtinModules.concat(builtinModules.map((m) => `node:${m}`))]
+		: [];
+
+	resolvedConfig.environments[name].resolve.builtins = [
+		...resolvedConfig.environments[name].resolve.builtins,
+		...nodeCompatModules,
+	];
+	resolvedConfig.environments[name].optimizeDeps.exclude = [
+		...(resolvedConfig.environments[name].optimizeDeps.exclude ?? []),
+		...nodeCompatModules,
+	];
+}