wrangler 2.20.0 → 3.0.0

package/src/dev/start-server.ts

@@ -1,545 +0,0 @@
-import { fork } from "node:child_process";
-import { realpathSync } from "node:fs";
-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 traverseModuleGraph from "../traverse-module-graph";
-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 { DurableObjectBindings } from "../config/environment";
-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,
-			processEntrypoint: props.processEntrypoint,
-			rules: props.rules,
-			jsxFragment: props.jsxFragment,
-			serveAssetsFromWorker: Boolean(
-				props.assetPaths && !props.isWorkersSite && props.local
-			),
-			tsconfig: props.tsconfig,
-			minify: props.minify,
-			legacyNodeCompat: props.legacyNodeCompat,
-			nodejsCompat: props.nodejsCompat,
-			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,
-			doBindings: props.bindings.durable_objects?.bindings ?? [],
-		});
-
-		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,
-				inspect: props.inspect,
-				onReady: props.onReady,
-				enablePagesAssetsServiceBinding: props.enablePagesAssetsServiceBinding,
-				usageModel: props.usageModel,
-				workerDefinitions,
-				experimentalLocal: props.experimentalLocal,
-				accountId: props.accountId,
-				experimentalLocalRemoteKv: props.experimentalLocalRemoteKv,
-				sourceMapPath: bundle?.sourceMapPath,
-			});
-
-			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,
-	processEntrypoint,
-	rules,
-	assets,
-	betaD1Shims,
-	serveAssetsFromWorker,
-	tsconfig,
-	minify,
-	legacyNodeCompat,
-	nodejsCompat,
-	define,
-	noBundle,
-	workerDefinitions,
-	services,
-	firstPartyWorkerDevFacade,
-	testScheduled,
-	local,
-	experimentalLocal,
-	doBindings,
-}: {
-	entry: Entry;
-	destination: string | undefined;
-	jsxFactory: string | undefined;
-	jsxFragment: string | undefined;
-	processEntrypoint: boolean;
-	rules: Config["rules"];
-	assets: Config["assets"];
-	betaD1Shims?: string[];
-	define: Config["define"];
-	services: Config["services"];
-	serveAssetsFromWorker: boolean;
-	tsconfig: string | undefined;
-	minify: boolean | undefined;
-	legacyNodeCompat: boolean | undefined;
-	nodejsCompat: boolean | undefined;
-	noBundle: boolean;
-	workerDefinitions: WorkerRegistry;
-	firstPartyWorkerDevFacade: boolean | undefined;
-	testScheduled?: boolean;
-	local: boolean;
-	experimentalLocal: boolean | undefined;
-	doBindings: DurableObjectBindings;
-}): Promise<EsbuildBundle | undefined> {
-	if (!destination) return;
-
-	let traverseModuleGraphResult:
-		| Awaited<ReturnType<typeof bundleWorker>>
-		| undefined;
-	let bundleResult: Awaited<ReturnType<typeof bundleWorker>> | undefined;
-	if (noBundle) {
-		traverseModuleGraphResult = await traverseModuleGraph(entry, rules);
-	}
-
-	if (processEntrypoint || !noBundle) {
-		bundleResult = await bundleWorker(entry, destination, {
-			bundle: !noBundle,
-			disableModuleCollection: noBundle,
-			serveAssetsFromWorker,
-			jsxFactory,
-			jsxFragment,
-			rules,
-			tsconfig,
-			minify,
-			legacyNodeCompat,
-			nodejsCompat,
-			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,
-			doBindings,
-		});
-	}
-
-	return {
-		id: 0,
-		entry,
-		path: bundleResult?.resolvedEntryPointPath ?? entry.file,
-		type:
-			bundleResult?.bundleType ??
-			(entry.format === "modules" ? "esm" : "commonjs"),
-		modules: traverseModuleGraphResult?.modules ?? bundleResult?.modules ?? [],
-		dependencies: bundleResult?.dependencies ?? {},
-		sourceMapPath: bundleResult?.sourceMapPath,
-		sourceMapMetadata: bundleResult?.sourceMapMetadata,
-	};
-}
-
-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,
-	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."
-			);
-		}
-
-		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,
-			workerDefinitions,
-			enablePagesAssetsServiceBinding,
-		});
-
-		if (experimentalLocal) {
-			const log = await buildMiniflare3Logger();
-			const mf3Options = await transformMf2OptionsToMf3Options({
-				miniflare2Options: options,
-				format,
-				bundle,
-				log,
-				kvNamespaces: bindings?.kv_namespaces,
-				r2Buckets: bindings?.r2_buckets,
-				d1Databases: bindings?.d1_databases,
-				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;
-		},
-	};
-}