wrangler 0.0.0-e178d6fb → 0.0.0-e1c2f5b9

package/src/dev/start-server.ts

@@ -0,0 +1,543 @@
+import { fork } from "node:child_process";
+import { realpathSync } from "node:fs";
+import { writeFile } from "node:fs/promises";
+import * as path from "node:path";
+import * as util from "node:util";
+import onExit from "signal-exit";
+import tmp from "tmp-promise";
+import { bundleWorker } from "../bundle";
+import {
+	getBoundRegisteredWorkers,
+	registerWorker,
+	startWorkerRegistry,
+	stopWorkerRegistry,
+} from "../dev-registry";
+import { runCustomBuild } from "../entry";
+import { logger } from "../logger";
+import { waitForPortToBeAvailable } from "../proxy";
+import {
+	setupBindings,
+	getMiniflare3,
+	buildMiniflare3Logger,
+	setupMiniflareOptions,
+	setupNodeOptions,
+	transformMf2OptionsToMf3Options,
+} from "./local";
+import { startRemoteServer } from "./remote";
+import { validateDevProps } from "./validate-dev-props";
+
+import type { Config } from "../config";
+import type { WorkerRegistry } from "../dev-registry";
+import type { Entry } from "../entry";
+import type { DevProps, DirectorySyncResult } from "./dev";
+import type { LocalProps } from "./local";
+import type { EsbuildBundle } from "./use-esbuild";
+import type { Miniflare as Miniflare3Type } from "@miniflare/tre";
+
+import type { ChildProcess } from "node:child_process";
+
+export async function startDevServer(
+	props: DevProps & {
+		local: boolean;
+		disableDevRegistry: boolean;
+	}
+) {
+	try {
+		let workerDefinitions: WorkerRegistry = {};
+		validateDevProps(props);
+
+		if (props.build.command) {
+			const relativeFile =
+				path.relative(props.entry.directory, props.entry.file) || ".";
+			await runCustomBuild(props.entry.file, relativeFile, props.build).catch(
+				(err) => {
+					logger.error("Custom build failed:", err);
+				}
+			);
+		}
+
+		//implement a react-free version of useTmpDir
+		const directory = setupTempDir();
+		if (!directory) {
+			throw new Error("Failed to create temporary directory.");
+		}
+
+		//start the worker registry
+		logger.log("disableDevRegistry: ", props.disableDevRegistry);
+		if (!props.disableDevRegistry) {
+			try {
+				await startWorkerRegistry();
+				if (props.local) {
+					const boundRegisteredWorkers = await getBoundRegisteredWorkers({
+						services: props.bindings.services,
+						durableObjects: props.bindings.durable_objects,
+					});
+
+					if (
+						!util.isDeepStrictEqual(boundRegisteredWorkers, workerDefinitions)
+					) {
+						workerDefinitions = boundRegisteredWorkers || {};
+					}
+				}
+			} catch (err) {
+				logger.error("failed to start worker registry", err);
+			}
+		}
+
+		const betaD1Shims = props.bindings.d1_databases?.map((db) => db.binding);
+
+		//implement a react-free version of useEsbuild
+		const bundle = await runEsbuild({
+			entry: props.entry,
+			destination: directory.name,
+			jsxFactory: props.jsxFactory,
+			rules: props.rules,
+			jsxFragment: props.jsxFragment,
+			serveAssetsFromWorker: Boolean(
+				props.assetPaths && !props.isWorkersSite && props.local
+			),
+			tsconfig: props.tsconfig,
+			minify: props.minify,
+			nodeCompat: props.nodeCompat,
+			define: props.define,
+			noBundle: props.noBundle,
+			assets: props.assetsConfig,
+			betaD1Shims,
+			workerDefinitions,
+			services: props.bindings.services,
+			firstPartyWorkerDevFacade: props.firstPartyWorker,
+			testScheduled: props.testScheduled,
+			local: props.local,
+			experimentalLocal: props.experimentalLocal,
+		});
+
+		if (props.local) {
+			const { stop, inspectorUrl } = await startLocalServer({
+				name: props.name,
+				bundle: bundle,
+				format: props.entry.format,
+				compatibilityDate: props.compatibilityDate,
+				compatibilityFlags: props.compatibilityFlags,
+				bindings: props.bindings,
+				assetPaths: props.assetPaths,
+				initialPort: props.initialPort,
+				initialIp: props.initialIp,
+				rules: props.rules,
+				inspectorPort: props.inspectorPort,
+				localPersistencePath: props.localPersistencePath,
+				liveReload: props.liveReload,
+				crons: props.crons,
+				queueConsumers: props.queueConsumers,
+				localProtocol: props.localProtocol,
+				localUpstream: props.localUpstream,
+				logPrefix: props.logPrefix,
+				inspect: props.inspect,
+				onReady: props.onReady,
+				enablePagesAssetsServiceBinding: props.enablePagesAssetsServiceBinding,
+				usageModel: props.usageModel,
+				workerDefinitions,
+				experimentalLocal: props.experimentalLocal,
+				accountId: props.accountId,
+				experimentalLocalRemoteKv: props.experimentalLocalRemoteKv,
+			});
+
+			return {
+				stop: async () => {
+					stop();
+					await stopWorkerRegistry();
+				},
+				inspectorUrl,
+			};
+		} else {
+			const { stop } = await startRemoteServer({
+				name: props.name,
+				bundle: bundle,
+				format: props.entry.format,
+				accountId: props.accountId,
+				bindings: props.bindings,
+				assetPaths: props.assetPaths,
+				isWorkersSite: props.isWorkersSite,
+				port: props.initialPort,
+				ip: props.initialIp,
+				localProtocol: props.localProtocol,
+				inspectorPort: props.inspectorPort,
+				inspect: props.inspect,
+				compatibilityDate: props.compatibilityDate,
+				compatibilityFlags: props.compatibilityFlags,
+				usageModel: props.usageModel,
+				env: props.env,
+				legacyEnv: props.legacyEnv,
+				zone: props.zone,
+				host: props.host,
+				routes: props.routes,
+				onReady: props.onReady,
+				sourceMapPath: bundle?.sourceMapPath,
+				sendMetrics: props.sendMetrics,
+			});
+			return {
+				stop: async () => {
+					stop();
+					await stopWorkerRegistry();
+				},
+				// TODO: inspectorUrl,
+			};
+		}
+	} catch (err) {
+		logger.error(err);
+	}
+}
+
+function setupTempDir(): DirectorySyncResult | undefined {
+	let dir: DirectorySyncResult | undefined;
+	try {
+		dir = tmp.dirSync({ unsafeCleanup: true });
+
+		return dir;
+	} catch (err) {
+		logger.error("Failed to create temporary directory to store built files.");
+	}
+}
+
+async function runEsbuild({
+	entry,
+	destination,
+	jsxFactory,
+	jsxFragment,
+	rules,
+	assets,
+	betaD1Shims,
+	serveAssetsFromWorker,
+	tsconfig,
+	minify,
+	nodeCompat,
+	define,
+	noBundle,
+	workerDefinitions,
+	services,
+	firstPartyWorkerDevFacade,
+	testScheduled,
+	local,
+	experimentalLocal,
+}: {
+	entry: Entry;
+	destination: string | undefined;
+	jsxFactory: string | undefined;
+	jsxFragment: string | undefined;
+	rules: Config["rules"];
+	assets: Config["assets"];
+	betaD1Shims?: string[];
+	define: Config["define"];
+	services: Config["services"];
+	serveAssetsFromWorker: boolean;
+	tsconfig: string | undefined;
+	minify: boolean | undefined;
+	nodeCompat: boolean | undefined;
+	noBundle: boolean;
+	workerDefinitions: WorkerRegistry;
+	firstPartyWorkerDevFacade: boolean | undefined;
+	testScheduled?: boolean;
+	local: boolean;
+	experimentalLocal: boolean | undefined;
+}): Promise<EsbuildBundle | undefined> {
+	if (!destination) return;
+
+	const {
+		resolvedEntryPointPath,
+		bundleType,
+		modules,
+		dependencies,
+		sourceMapPath,
+	}: Awaited<ReturnType<typeof bundleWorker>> = noBundle
+		? {
+				modules: [],
+				dependencies: {},
+				resolvedEntryPointPath: entry.file,
+				bundleType: entry.format === "modules" ? "esm" : "commonjs",
+				stop: undefined,
+				sourceMapPath: undefined,
+		  }
+		: await bundleWorker(entry, destination, {
+				serveAssetsFromWorker,
+				jsxFactory,
+				jsxFragment,
+				rules,
+				tsconfig,
+				minify,
+				nodeCompat,
+				define,
+				checkFetch: true,
+				assets: assets && {
+					...assets,
+					// disable the cache in dev
+					bypassCache: true,
+				},
+				betaD1Shims,
+				workerDefinitions,
+				services,
+				firstPartyWorkerDevFacade,
+				targetConsumer: "dev", // We are starting a dev server
+				testScheduled,
+				local,
+				experimentalLocal,
+		  });
+
+	return {
+		id: 0,
+		entry,
+		path: resolvedEntryPointPath,
+		type: bundleType,
+		modules,
+		dependencies,
+		sourceMapPath,
+	};
+}
+
+export async function startLocalServer({
+	name: workerName,
+	bundle,
+	format,
+	compatibilityDate,
+	compatibilityFlags,
+	usageModel,
+	bindings,
+	workerDefinitions,
+	assetPaths,
+	initialPort,
+	inspectorPort,
+	rules,
+	localPersistencePath,
+	liveReload,
+	initialIp,
+	crons,
+	queueConsumers,
+	localProtocol,
+	localUpstream,
+	inspect,
+	onReady,
+	logPrefix,
+	enablePagesAssetsServiceBinding,
+	experimentalLocal,
+	accountId,
+	experimentalLocalRemoteKv,
+}: LocalProps) {
+	let local: ChildProcess | undefined;
+	let experimentalLocalRef: Miniflare3Type | undefined;
+	let removeSignalExitListener: (() => void) | undefined;
+	let inspectorUrl: string | undefined;
+	const setInspectorUrl = (url: string) => {
+		inspectorUrl = url;
+	};
+
+	const abortController = new AbortController();
+	async function startLocalWorker() {
+		if (!bundle || !format) return;
+
+		// port for the worker
+		await waitForPortToBeAvailable(initialPort, {
+			retryPeriod: 200,
+			timeout: 2000,
+			abortSignal: abortController.signal,
+		});
+
+		if (bindings.services && bindings.services.length > 0) {
+			logger.warn(
+				"⎔ Support for service bindings in local mode is experimental and may change."
+			);
+		}
+
+		// In local mode, we want to copy all referenced modules into
+		// the output bundle directory before starting up
+		for (const module of bundle.modules) {
+			await writeFile(
+				path.join(path.dirname(bundle.path), module.name),
+				module.content
+			);
+		}
+
+		const scriptPath = realpathSync(bundle.path);
+
+		const upstream =
+			typeof localUpstream === "string"
+				? `${localProtocol}://${localUpstream}`
+				: undefined;
+
+		const {
+			externalDurableObjects,
+			internalDurableObjects,
+			wasmBindings,
+			textBlobBindings,
+			dataBlobBindings,
+		} = setupBindings({
+			wasm_modules: bindings.wasm_modules,
+			text_blobs: bindings.text_blobs,
+			data_blobs: bindings.data_blobs,
+			durable_objects: bindings.durable_objects,
+			format,
+			bundle,
+		});
+
+		const { forkOptions, miniflareCLIPath, options } = setupMiniflareOptions({
+			workerName,
+			port: initialPort,
+			scriptPath,
+			localProtocol,
+			ip: initialIp,
+			format,
+			rules,
+			compatibilityDate,
+			compatibilityFlags,
+			usageModel,
+			kv_namespaces: bindings?.kv_namespaces,
+			queueBindings: bindings?.queues,
+			queueConsumers,
+			r2_buckets: bindings?.r2_buckets,
+			d1_databases: bindings?.d1_databases,
+			internalDurableObjects,
+			externalDurableObjects,
+			localPersistencePath,
+			liveReload,
+			assetPaths,
+			vars: bindings?.vars,
+			wasmBindings,
+			textBlobBindings,
+			dataBlobBindings,
+			crons,
+			upstream,
+			logPrefix,
+			workerDefinitions,
+			enablePagesAssetsServiceBinding,
+		});
+
+		if (experimentalLocal) {
+			const log = await buildMiniflare3Logger(logPrefix);
+			const mf3Options = await transformMf2OptionsToMf3Options({
+				miniflare2Options: options,
+				format,
+				bundle,
+				log,
+				kvNamespaces: bindings?.kv_namespaces,
+				r2Buckets: bindings?.r2_buckets,
+				authenticatedAccountId: accountId,
+				kvRemote: experimentalLocalRemoteKv,
+				inspectorPort,
+			});
+			const { Miniflare } = await getMiniflare3();
+			const mf = new Miniflare(mf3Options);
+			const runtimeURL = await mf.ready;
+			experimentalLocalRef = mf;
+			removeSignalExitListener = onExit((_code, _signal) => {
+				logger.log("⎔ Shutting down experimental local server.");
+				void mf.dispose();
+				experimentalLocalRef = undefined;
+			});
+			onReady?.(runtimeURL.hostname, parseInt(runtimeURL.port ?? 8787));
+			return;
+		}
+
+		const nodeOptions = setupNodeOptions({ inspect, inspectorPort });
+		logger.log("⎔ Starting a local server...");
+
+		const child = (local = fork(miniflareCLIPath, forkOptions, {
+			cwd: path.dirname(scriptPath),
+			execArgv: nodeOptions,
+			stdio: "pipe",
+		}));
+
+		child.on("message", async (messageString) => {
+			const message = JSON.parse(messageString as string);
+			if (message.ready) {
+				// Let's register our presence in the dev registry
+				if (workerName) {
+					await registerWorker(workerName, {
+						protocol: localProtocol,
+						mode: "local",
+						port: message.port,
+						host: initialIp,
+						durableObjects: internalDurableObjects.map((binding) => ({
+							name: binding.name,
+							className: binding.class_name,
+						})),
+						...(message.durableObjectsPort
+							? {
+									durableObjectsHost: initialIp,
+									durableObjectsPort: message.durableObjectsPort,
+							  }
+							: {}),
+					});
+				}
+				onReady?.(initialIp, message.port);
+			}
+		});
+
+		child.on("close", (code) => {
+			if (code) {
+				logger.log(`Miniflare process exited with code ${code}`);
+			}
+		});
+
+		child.stdout?.on("data", (data: Buffer) => {
+			process.stdout.write(data);
+		});
+
+		// parse the node inspector url (which may be received in chunks) from stderr
+		let stderrData = "";
+		let inspectorUrlFound = false;
+		child.stderr?.on("data", (data: Buffer) => {
+			if (!inspectorUrlFound) {
+				stderrData += data.toString();
+				const matches =
+					/Debugger listening on (ws:\/\/127\.0\.0\.1:\d+\/[A-Za-z0-9-]+)[\r|\n]/.exec(
+						stderrData
+					);
+				if (matches) {
+					inspectorUrlFound = true;
+					setInspectorUrl(matches[1]);
+				}
+			}
+
+			process.stderr.write(data);
+		});
+
+		child.on("exit", (code) => {
+			if (code) {
+				logger.error(`Miniflare process exited with code ${code}`);
+			}
+		});
+
+		child.on("error", (error: Error) => {
+			logger.error(`Miniflare process failed to spawn`);
+			logger.error(error);
+		});
+
+		removeSignalExitListener = onExit((_code, _signal) => {
+			logger.log("⎔ Shutting down local server.");
+			child.kill();
+			local = undefined;
+		});
+	}
+
+	startLocalWorker().catch((err) => {
+		logger.error("local worker:", err);
+	});
+
+	return {
+		inspectorUrl,
+		stop: () => {
+			abortController.abort();
+			if (local) {
+				logger.log("⎔ Shutting down local server.");
+				local.kill();
+				local = undefined;
+			}
+			if (experimentalLocalRef) {
+				logger.log("⎔ Shutting down experimental local server.");
+				// Initialisation errors are also thrown asynchronously by dispose().
+				// The catch() above should've caught them though.
+				experimentalLocalRef?.dispose().catch(() => {});
+				experimentalLocalRef = undefined;
+			}
+			removeSignalExitListener?.();
+			removeSignalExitListener = undefined;
+		},
+	};
+}

package/src/dev/use-esbuild.ts

@@ -2,12 +2,13 @@ import assert from "node:assert";
 import { watch } from "chokidar";
 import { useApp } from "ink";
 import { useState, useEffect } from "react";
-import { bundleWorker } from "../bundle";
-import { logger } from "../logger";
+import { bundleWorker, rewriteNodeCompatBuildFailure } from "../bundle";
+import { logBuildFailure, logger } from "../logger";
 import type { Config } from "../config";
+import type { WorkerRegistry } from "../dev-registry";
 import type { Entry } from "../entry";
 import type { CfModule } from "../worker";
-import type { WatchMode } from "esbuild";
+import type { WatchMode, Metafile } from "esbuild";
 
 export type EsbuildBundle = {
 	id: number;
@@ -15,6 +16,8 @@ export type EsbuildBundle = {
 	entry: Entry;
 	type: "esm" | "commonjs";
 	modules: CfModule[];
+	dependencies: Metafile["outputs"][string]["inputs"];
+	sourceMapPath: string | undefined;
 };
 
 export function useEsbuild({
@@ -23,24 +26,44 @@ export function useEsbuild({
 	jsxFactory,
 	jsxFragment,
 	rules,
+	assets,
 	serveAssetsFromWorker,
 	tsconfig,
 	minify,
 	nodeCompat,
+	betaD1Shims,
 	define,
 	noBundle,
+	workerDefinitions,
+	services,
+	durableObjects,
+	firstPartyWorkerDevFacade,
+	local,
+	targetConsumer,
+	testScheduled,
+	experimentalLocal,
 }: {
 	entry: Entry;
 	destination: string | undefined;
 	jsxFactory: string | undefined;
 	jsxFragment: string | undefined;
 	rules: Config["rules"];
+	assets: Config["assets"];
 	define: Config["define"];
+	services: Config["services"];
 	serveAssetsFromWorker: boolean;
 	tsconfig: string | undefined;
 	minify: boolean | undefined;
 	nodeCompat: boolean | undefined;
+	betaD1Shims?: string[];
 	noBundle: boolean;
+	workerDefinitions: WorkerRegistry;
+	durableObjects: Config["durable_objects"];
+	firstPartyWorkerDevFacade: boolean | undefined;
+	local: boolean;
+	targetConsumer: "dev" | "publish";
+	testScheduled: boolean;
+	experimentalLocal: boolean | undefined;
 }): EsbuildBundle | undefined {
 	const [bundle, setBundle] = useState<EsbuildBundle>();
 	const { exit } = useApp();
@@ -61,8 +84,11 @@ export function useEsbuild({
 
 		const watchMode: WatchMode = {
 			async onRebuild(error) {
-				if (error) logger.error("Watch build failed:", error);
-				else {
+				if (error !== null) {
+					if (!nodeCompat) rewriteNodeCompatBuildFailure(error);
+					logBuildFailure(error);
+					logger.error("Watch build failed:", error.message);
+				} else {
 					updateBundle();
 				}
 			},
@@ -75,13 +101,17 @@ export function useEsbuild({
 				resolvedEntryPointPath,
 				bundleType,
 				modules,
+				dependencies,
 				stop,
+				sourceMapPath,
 			}: Awaited<ReturnType<typeof bundleWorker>> = noBundle
 				? {
 						modules: [],
+						dependencies: {},
 						resolvedEntryPointPath: entry.file,
 						bundleType: entry.format === "modules" ? "esm" : "commonjs",
 						stop: undefined,
+						sourceMapPath: undefined,
 				  }
 				: await bundleWorker(entry, destination, {
 						serveAssetsFromWorker,
@@ -92,8 +122,21 @@ export function useEsbuild({
 						tsconfig,
 						minify,
 						nodeCompat,
+						betaD1Shims,
 						define,
 						checkFetch: true,
+						assets: assets && {
+							...assets,
+							// disable the cache in dev
+							bypassCache: true,
+						},
+						workerDefinitions,
+						services,
+						firstPartyWorkerDevFacade,
+						local,
+						targetConsumer,
+						testScheduled,
+						experimentalLocal,
 				  });
 
 			// Capture the `stop()` method to use as the `useEffect()` destructor.
@@ -109,16 +152,17 @@ export function useEsbuild({
 				});
 
 				stopWatching = () => {
-					watcher.close();
+					void watcher.close();
 				};
 			}
-
 			setBundle({
 				id: 0,
 				entry,
 				path: resolvedEntryPointPath,
 				type: bundleType,
 				modules,
+				dependencies,
+				sourceMapPath,
 			});
 		}
 
@@ -145,6 +189,16 @@ export function useEsbuild({
 		minify,
 		nodeCompat,
 		define,
+		assets,
+		services,
+		durableObjects,
+		workerDefinitions,
+		firstPartyWorkerDevFacade,
+		betaD1Shims,
+		local,
+		targetConsumer,
+		testScheduled,
+		experimentalLocal,
 	]);
 	return bundle;
 }