invert module collector config - no longer need to return it as it is passed in

Author: petebacondarwin

packages/wrangler/src/api/pages/deploy.tsx

@@ -277,7 +277,6 @@ export async function deploy({
 				stop: undefined,
 				resolvedEntryPointPath: _workerPath,
 				bundleType: "esm",
-				moduleCollector: undefined,
 			};
 		}
 	}

packages/wrangler/src/config/environment.ts

@@ -77,8 +77,19 @@ interface EnvironmentInheritable {
 	main: string | undefined;
 
 	/**
-	 * The directory in which module rules should be evaluated in a `--no-bundle` worker
-	 * This defaults to dirname(main) when left undefined
+	 * If true then Wrangler will traverse the file tree below `base_dir`;
+	 * Any files that match `rules` will be included in the deployed worker.
+	 * Defaults to true if `no_bundle` is true, otherwise false.
+	 *
+	 * @inheritable
+	 */
+	find_additional_modules: boolean | undefined;
+
+	/**
+	 * The directory in which module rules should be evaluated when including additional files into a worker deployment.
+	 * This defaults to the directory containing the `main` entry point of the worker if not specified.
+	 *
+	 * @inheritable
 	 */
 	base_dir: string | undefined;
 

packages/wrangler/src/config/validation.ts

@@ -1119,6 +1119,14 @@ function normalizeAndValidateEnvironment(
 			),
 			deprecatedUpload
 		),
+		find_additional_modules: inheritable(
+			diagnostics,
+			topLevelEnv,
+			rawEnv,
+			"find_additional_modules",
+			isBoolean,
+			undefined
+		),
 		base_dir: normalizeAndValidateBaseDirField(
 			configPath,
 			inheritable(

packages/wrangler/src/deploy/deploy.ts

@@ -14,6 +14,10 @@ import {
 import { getBundleType } from "../deployment-bundle/bundle-type";
 import { createWorkerUploadForm } from "../deployment-bundle/create-worker-upload-form";
 import findAdditionalModules from "../deployment-bundle/find-additional-modules";
+import {
+	createModuleCollector,
+	getWrangler1xLegacyModuleReferences,
+} from "../deployment-bundle/module-collection";
 import { addHyphens } from "../deployments";
 import { confirm } from "../dialogs";
 import { getMigrationsToUpload } from "../durable";
@@ -453,6 +457,16 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 			);
 		}
 
+		const entryDirectory = path.dirname(props.entry.file);
+		const moduleCollector = createModuleCollector({
+			wrangler1xLegacyModuleReferences: getWrangler1xLegacyModuleReferences(
+				entryDirectory,
+				props.entry.file
+			),
+			format: props.entry.format,
+			rules: props.rules,
+		});
+
 		const { modules, dependencies, resolvedEntryPointPath, bundleType } =
 			props.noBundle
 				? {
@@ -465,6 +479,10 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 						props.entry,
 						typeof destination === "string" ? destination : destination.path,
 						{
+							bundle: true,
+							findAdditionalModules: false,
+							additionalModules: [],
+							moduleCollector,
 							serveAssetsFromWorker:
 								!props.isWorkersSite && Boolean(props.assetPaths),
 							doBindings: config.durable_objects.bindings,

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

@@ -15,7 +15,7 @@ import { getEntryPointFromMetafile } from "./entry-point-from-metafile";
 import { cloudflareInternalPlugin } from "./esbuild-plugins/cloudflare-internal";
 import { configProviderPlugin } from "./esbuild-plugins/config-provider";
 import { nodejsCompatPlugin } from "./esbuild-plugins/nodejs-compat";
-import createModuleCollector from "./module-collection";
+import { noopModuleCollector } from "./module-collection";
 import type { Config } from "../config";
 import type { DurableObjectBindings } from "../config/environment";
 import type { WorkerRegistry } from "../dev-registry";
@@ -47,12 +47,17 @@ export type BundleResult = {
 	stop: (() => void) | undefined;
 	sourceMapPath?: string | undefined;
 	sourceMapMetadata?: SourceMapMetadata | undefined;
-	moduleCollector: ModuleCollector | undefined;
 };
 
 export type BundleOptions = {
 	// When `bundle` is set to false, we apply shims to the Worker, but won't pull in any imports
-	bundle?: boolean;
+	bundle: boolean;
+	// When `findAdditionalModules is true we will also traverse the file tree to find modules that match module rules.
+	findAdditionalModules: boolean;
+	// Known additional modules provided by the outside.
+	additionalModules: CfModule[];
+	// A module collector enables you to observe what modules are in the Worker.
+	moduleCollector: ModuleCollector;
 	serveAssetsFromWorker: boolean;
 	assets?: Config["assets"];
 	bypassAssetCache?: boolean;
@@ -77,9 +82,6 @@ export type BundleOptions = {
 	loader?: Record<string, string>;
 	sourcemap?: esbuild.CommonOptions["sourcemap"];
 	plugins?: esbuild.Plugin[];
-	additionalModules?: CfModule[];
-	// TODO: Rip these out https://github.com/cloudflare/workers-sdk/issues/2153
-	disableModuleCollection?: boolean;
 	isOutfile?: boolean;
 	forPages?: boolean;
 };
@@ -91,13 +93,14 @@ export async function bundleWorker(
 	entry: Entry,
 	destination: string,
 	{
-		bundle = true,
+		bundle,
+		moduleCollector = noopModuleCollector,
+		additionalModules = [],
 		serveAssetsFromWorker,
 		doBindings,
 		jsxFactory,
 		jsxFragment,
 		entryName,
-		rules,
 		watch,
 		tsconfig,
 		minify,
@@ -115,10 +118,8 @@ export async function bundleWorker(
 		loader,
 		sourcemap,
 		plugins,
-		disableModuleCollection,
 		isOutfile,
 		forPages,
-		additionalModules = [],
 	}: BundleOptions
 ): Promise<BundleResult> {
 	// We create a temporary directory for any one-off files we
@@ -128,33 +129,6 @@ export async function bundleWorker(
 
 	const entryFile = entry.file;
 
-	const entryDirectory = path.dirname(entryFile);
-	let moduleCollector = createModuleCollector({
-		wrangler1xlegacyModuleReferences: {
-			rootDirectory: entryDirectory,
-			fileNames: new Set(
-				fs
-					.readdirSync(entryDirectory, { withFileTypes: true })
-					.filter(
-						(dirEntry) =>
-							dirEntry.isFile() && dirEntry.name !== path.basename(entryFile)
-					)
-					.map((dirEnt) => dirEnt.name)
-			),
-		},
-		format: entry.format,
-		rules,
-	});
-	if (disableModuleCollection) {
-		moduleCollector = {
-			modules: [],
-			plugin: {
-				name: moduleCollector.plugin.name,
-				setup: () => {},
-			},
-		};
-	}
-
 	// At this point, we take the opportunity to "wrap" the worker with middleware.
 	const middlewareToLoad: MiddlewareLoader[] = [];
 
@@ -394,6 +368,5 @@ export async function bundleWorker(
 			tmpDir: tmpDir.path,
 			entryDirectory: entry.directory,
 		},
-		moduleCollector,
 	};
 }

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

@@ -1,4 +1,5 @@
 import crypto from "node:crypto";
+import { readdirSync } from "node:fs";
 import { readFile } from "node:fs/promises";
 import path from "node:path";
 import globToRegExp from "glob-to-regexp";
@@ -90,12 +91,20 @@ export type ModuleCollector = {
 	plugin: esbuild.Plugin;
 };
 
-export default function createModuleCollector(props: {
+export const noopModuleCollector = {
+	modules: [],
+	plugin: {
+		name: "wrangler-module-collector",
+		setup: () => {},
+	},
+};
+
+export function createModuleCollector(props: {
 	format: CfScriptFormat;
 	rules?: Config["rules"];
 	// a collection of "legacy" style module references, which are just file names
 	// we will eventually deprecate this functionality, hence the verbose greppable name
-	wrangler1xlegacyModuleReferences: {
+	wrangler1xLegacyModuleReferences?: {
 		rootDirectory: string;
 		fileNames: Set<string>;
 	};
@@ -129,12 +138,15 @@ export default function createModuleCollector(props: {
 					});
 				});
 
-				if (props.wrangler1xlegacyModuleReferences.fileNames.size > 0) {
+				if (
+					props.wrangler1xLegacyModuleReferences &&
+					props.wrangler1xLegacyModuleReferences.fileNames.size > 0
+				) {
 					build.onResolve(
 						{
 							filter: new RegExp(
 								"^(" +
-									[...props.wrangler1xlegacyModuleReferences.fileNames]
+									[...props.wrangler1xLegacyModuleReferences.fileNames]
 										.map((name) => name.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"))
 										.join("|") +
 									")$"
@@ -160,7 +172,8 @@ export default function createModuleCollector(props: {
 							// take the file and massage it to a
 							// transportable/manageable format
 							const filePath = path.join(
-								props.wrangler1xlegacyModuleReferences.rootDirectory,
+								// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+								props.wrangler1xLegacyModuleReferences!.rootDirectory,
 								args.path
 							);
 							const fileContent = await readFile(filePath);
@@ -269,3 +282,20 @@ export default function createModuleCollector(props: {
 		},
 	};
 }
+
+export function getWrangler1xLegacyModuleReferences(
+	rootDirectory: string,
+	entryPath: string
+) {
+	return {
+		rootDirectory,
+		fileNames: new Set(
+			readdirSync(rootDirectory, { withFileTypes: true })
+				.filter(
+					(dirEntry) =>
+						dirEntry.isFile() && dirEntry.name !== path.basename(entryPath)
+				)
+				.map((dirEnt) => dirEnt.name)
+		),
+	};
+}

packages/wrangler/src/dev/start-server.ts

@@ -7,6 +7,11 @@ import { bundleWorker } from "../deployment-bundle/bundle";
 import { getBundleType } from "../deployment-bundle/bundle-type";
 import { dedupeModulesByName } from "../deployment-bundle/dedupe-modules";
 import findAdditionalModules from "../deployment-bundle/find-additional-modules";
+import {
+	createModuleCollector,
+	getWrangler1xLegacyModuleReferences,
+	noopModuleCollector,
+} from "../deployment-bundle/module-collection";
 import { runCustomBuild } from "../deployment-bundle/run-custom-build";
 import {
 	getBoundRegisteredWorkers,
@@ -233,11 +238,25 @@ async function runEsbuild({
 		]);
 	}
 
+	const entryDirectory = path.dirname(entry.file);
+	const moduleCollector = noBundle
+		? noopModuleCollector
+		: createModuleCollector({
+				wrangler1xLegacyModuleReferences: getWrangler1xLegacyModuleReferences(
+					entryDirectory,
+					entry.file
+				),
+				format: entry.format,
+				rules,
+		  });
+
 	const bundleResult =
 		processEntrypoint || !noBundle
 			? await bundleWorker(entry, destination, {
 					bundle: !noBundle,
-					disableModuleCollection: noBundle,
+					findAdditionalModules: false,
+					additionalModules,
+					moduleCollector,
 					serveAssetsFromWorker,
 					jsxFactory,
 					jsxFragment,
@@ -256,7 +275,6 @@ async function runEsbuild({
 					targetConsumer: "dev", // We are starting a dev server
 					testScheduled,
 					doBindings,
-					additionalModules,
 			  })
 			: undefined;