wrangler 2.0.26 → 2.0.29

package/src/dev.tsx

@@ -8,6 +8,7 @@ import { findWranglerToml, printBindings, readConfig } from "./config";
 import Dev from "./dev/dev";
 import { getVarsForDev } from "./dev/dev-vars";
 
+import { startDevServer } from "./dev/start-server";
 import { getEntry } from "./entry";
 import { logger } from "./logger";
 import * as metrics from "./metrics";
@@ -63,6 +64,8 @@ interface DevArgs {
 	tsconfig?: string;
 	local?: boolean;
 	minify?: boolean;
+	var?: string[];
+	define?: string[];
 	"node-compat"?: boolean;
 	"experimental-enable-local-persistence"?: boolean;
 	"live-reload"?: boolean;
@@ -129,7 +132,6 @@ export function devOptions(yargs: Argv): Argv<DevArgs> {
 			.option("ip", {
 				describe: "IP address to listen on",
 				type: "string",
-				default: "0.0.0.0",
 			})
 			.option("port", {
 				describe: "Port to listen on",
@@ -196,6 +198,19 @@ export function devOptions(yargs: Argv): Argv<DevArgs> {
 				describe: "Protocol to forward requests to host on, defaults to https.",
 				choices: ["http", "https"] as const,
 			})
+			.option("var", {
+				describe:
+					"A key-value pair to be injected into the script as a variable",
+				type: "string",
+				requiresArg: true,
+				array: true,
+			})
+			.option("define", {
+				describe: "A key-value pair to be substituted in the script",
+				type: "string",
+				requiresArg: true,
+				array: true,
+			})
 			.option("jsx-factory", {
 				describe: "The function that is called for each JSX element",
 				type: "string",
@@ -319,11 +334,17 @@ export async function startDev(args: StartDevOptions) {
 			});
 		}
 
-		const entry = await getEntry(
-			{ assets: args.assets, script: args.script },
-			config,
-			"dev"
-		);
+		const {
+			entry,
+			nodeCompat,
+			upstreamProtocol,
+			zoneId,
+			host,
+			routes,
+			getLocalPort,
+			getInspectorPort,
+			cliDefines,
+		} = await validateDevServerSettings(args, config);
 
 		await metrics.sendMetricsEvent(
 			"run dev",
@@ -334,182 +355,60 @@ export async function startDev(args: StartDevOptions) {
 			{ sendMetrics: config.send_metrics, offline: args.local }
 		);
 
-		if (config.services && config.services.length > 0) {
-			logger.warn(
-				`This worker is bound to live services: ${config.services
-					.map(
-						(service) =>
-							`${service.binding} (${service.service}${
-								service.environment ? `@${service.environment}` : ""
-							})`
-					)
-					.join(", ")}`
-			);
-		}
-
-		if (args.inspect) {
-			//devtools are enabled by default, but we still need to disable them if the caller doesn't want them
-			logger.warn(
-				"Passing --inspect is unnecessary, now you can always connect to devtools."
-			);
-		}
-
-		if (args["experimental-public"]) {
-			throw new Error(
-				"The --experimental-public field has been renamed to --assets"
-			);
-		}
-
-		if (args.public) {
-			throw new Error("The --public field has been renamed to --assets");
-		}
-
-		if ((args.assets || config.assets) && (args.site || config.site)) {
-			throw new Error(
-				"Cannot use Assets and Workers Sites in the same Worker."
-			);
-		}
-
-		if (args.assets) {
-			logger.warn(
-				"The --assets argument is experimental and may change or break at any time"
-			);
-		}
-
-		const upstreamProtocol =
-			args["upstream-protocol"] || config.dev.upstream_protocol;
-		if (upstreamProtocol === "http") {
-			logger.warn(
-				"Setting upstream-protocol to http is not currently implemented.\n" +
-					"If this is required in your project, please add your use case to the following issue:\n" +
-					"https://github.com/cloudflare/wrangler2/issues/583."
-			);
-		}
-
-		// TODO: if worker_dev = false and no routes, then error (only for dev)
-
-		// Compute zone info from the `host` and `route` args and config;
-		let host = args.host || config.dev.host;
-		let zoneId: string | undefined;
-		const routes: Route[] | undefined =
-			args.routes || (config.route && [config.route]) || config.routes;
-
-		if (args.forceLocal) {
-			args.local = true;
-		}
-
-		if (!args.local) {
-			if (host) {
-				zoneId = await getZoneIdFromHost(host);
-			}
-			if (!zoneId && routes) {
-				const firstRoute = routes[0];
-				const zone = await getZoneForRoute(firstRoute);
-				if (zone) {
-					zoneId = zone.id;
-					host = zone.host;
-				}
-			}
-		} else if (!host) {
-			if (routes) {
-				const firstRoute = routes[0];
-				host = getHostFromRoute(firstRoute);
-			}
-		}
-
-		const nodeCompat = args.nodeCompat ?? config.node_compat;
-		if (nodeCompat) {
-			logger.warn(
-				"Enabling node.js compatibility mode for built-ins and globals. This is experimental and has serious tradeoffs. Please see https://github.com/ionic-team/rollup-plugin-node-polyfills/ for more details."
-			);
-		}
-
-		const getLocalPort = memoizeGetPort(DEFAULT_LOCAL_PORT);
-		const getInspectorPort = memoizeGetPort(DEFAULT_INSPECTOR_PORT);
-
 		// eslint-disable-next-line no-inner-declarations
 		async function getDevReactElement(configParam: Config) {
-			// now log all available bindings into the terminal
-			const bindings = await getBindings(configParam, {
-				kv: args.kv,
-				vars: args.vars,
-				durableObjects: args.durableObjects,
-				r2: args.r2,
-			});
-
-			// mask anything that was overridden in .dev.vars
-			// so that we don't log potential secrets into the terminal
-			const maskedVars = { ...bindings.vars };
-			for (const key of Object.keys(maskedVars)) {
-				if (maskedVars[key] !== configParam.vars[key]) {
-					// This means it was overridden in .dev.vars
-					// so let's mask it
-					maskedVars[key] = "(hidden)";
-				}
-			}
-
-			printBindings({
-				...bindings,
-				vars: maskedVars,
-			});
-
-			const assetPaths =
-				args.assets || config.assets
-					? getAssetPaths(config, args.assets)
-					: getSiteAssetPaths(
-							config,
-							args.site,
-							args.siteInclude,
-							args.siteExclude
-					  );
+			const { assetPaths, bindings } = await getBindingsAndAssetPaths(
+				args,
+				configParam
+			);
 
 			return (
 				<Dev
-					name={getScriptName({ name: args.name, env: args.env }, config)}
-					noBundle={!(args.bundle ?? !config.no_bundle)}
+					name={getScriptName({ name: args.name, env: args.env }, configParam)}
+					noBundle={!(args.bundle ?? !configParam.no_bundle)}
 					entry={entry}
 					env={args.env}
 					zone={zoneId}
 					host={host}
 					routes={routes}
-					rules={getRules(config)}
-					legacyEnv={isLegacyEnv(config)}
-					minify={args.minify ?? config.minify}
+					rules={getRules(configParam)}
+					legacyEnv={isLegacyEnv(configParam)}
+					minify={args.minify ?? configParam.minify}
 					nodeCompat={nodeCompat}
-					build={config.build || {}}
-					define={config.define}
+					build={configParam.build || {}}
+					define={{ ...configParam.define, ...cliDefines }}
 					initialMode={args.local ? "local" : "remote"}
-					jsxFactory={args["jsx-factory"] || config.jsx_factory}
-					jsxFragment={args["jsx-fragment"] || config.jsx_fragment}
-					tsconfig={args.tsconfig ?? config.tsconfig}
+					jsxFactory={args["jsx-factory"] || configParam.jsx_factory}
+					jsxFragment={args["jsx-fragment"] || configParam.jsx_fragment}
+					tsconfig={args.tsconfig ?? configParam.tsconfig}
 					upstreamProtocol={upstreamProtocol}
-					localProtocol={args.localProtocol || config.dev.local_protocol}
+					localProtocol={args.localProtocol || configParam.dev.local_protocol}
 					localUpstream={args["local-upstream"] || host}
 					enableLocalPersistence={
 						args.experimentalEnableLocalPersistence || false
 					}
 					liveReload={args.liveReload || false}
-					accountId={config.account_id || getAccountFromCache()?.id}
+					accountId={configParam.account_id || getAccountFromCache()?.id}
 					assetPaths={assetPaths}
-					assetsConfig={config.assets}
-					port={args.port || config.dev.port || (await getLocalPort())}
-					ip={args.ip || config.dev.ip}
+					assetsConfig={configParam.assets}
+					port={args.port || configParam.dev.port || (await getLocalPort())}
+					ip={args.ip || configParam.dev.ip}
 					inspectorPort={
 						args.inspectorPort ||
-						config.dev.inspector_port ||
+						configParam.dev.inspector_port ||
 						(await getInspectorPort())
 					}
-					isWorkersSite={Boolean(args.site || config.site)}
+					isWorkersSite={Boolean(args.site || configParam.site)}
 					compatibilityDate={getDevCompatibilityDate(
-						config,
+						configParam,
 						args.compatibilityDate
 					)}
 					compatibilityFlags={
-						args.compatibilityFlags || config.compatibility_flags
+						args.compatibilityFlags || configParam.compatibility_flags
 					}
-					usageModel={config.usage_model}
+					usageModel={configParam.usage_model}
 					bindings={bindings}
-					crons={config.triggers.crons}
+					crons={configParam.triggers.crons}
 					logLevel={args.logLevel}
 					logPrefix={args.logPrefix}
 					onReady={args.onReady}
@@ -517,8 +416,8 @@ export async function startDev(args: StartDevOptions) {
 					showInteractiveDevSession={args.showInteractiveDevSession}
 					forceLocal={args.forceLocal}
 					enablePagesAssetsServiceBinding={args.enablePagesAssetsServiceBinding}
-					firstPartyWorker={config.first_party_worker}
-					sendMetrics={config.send_metrics}
+					firstPartyWorker={configParam.first_party_worker}
+					sendMetrics={configParam.send_metrics}
 				/>
 			);
 		}
@@ -532,7 +431,6 @@ export async function startDev(args: StartDevOptions) {
 				await watcher?.close();
 			},
 			fetch: async (init?: RequestInit) => {
-				//TODO: we are not guaranteed to be assigned this port, we should fix this ASAP
 				const port = args.port || config.dev.port || (await getLocalPort());
 				const address = args.ip || config.dev.ip || "localhost";
 
@@ -544,6 +442,116 @@ export async function startDev(args: StartDevOptions) {
 	}
 }
 
+export async function startApiDev(args: StartDevOptions) {
+	if (args.logLevel) {
+		// we don't define a "none" logLevel, so "error" will do for now.
+		logger.loggerLevel = args.logLevel === "none" ? "error" : args.logLevel;
+	}
+	await printWranglerBanner();
+
+	const configPath =
+		(args.config as ConfigPath) ||
+		((args.script &&
+			findWranglerToml(path.dirname(args.script))) as ConfigPath);
+	const config = readConfig(configPath, args);
+
+	const {
+		entry,
+		nodeCompat,
+		upstreamProtocol,
+		zoneId,
+		host,
+		routes,
+		getLocalPort,
+		getInspectorPort,
+		cliDefines,
+	} = await validateDevServerSettings(args, config);
+
+	await metrics.sendMetricsEvent(
+		"run dev (api)",
+		{ local: args.local },
+		{ sendMetrics: config.send_metrics, offline: args.local }
+	);
+
+	// eslint-disable-next-line no-inner-declarations
+	async function getDevServer(configParam: Config) {
+		const { assetPaths, bindings } = await getBindingsAndAssetPaths(
+			args,
+			configParam
+		);
+
+		return await startDevServer({
+			name: getScriptName({ name: args.name, env: args.env }, configParam),
+			noBundle: !(args.bundle ?? !configParam.no_bundle),
+			entry: entry,
+			env: args.env,
+			zone: zoneId,
+			host: host,
+			routes: routes,
+			rules: getRules(configParam),
+			legacyEnv: isLegacyEnv(configParam),
+			minify: args.minify ?? configParam.minify,
+			nodeCompat: nodeCompat,
+			build: configParam.build || {},
+			define: { ...config.define, ...cliDefines },
+			initialMode: args.local ? "local" : "remote",
+			jsxFactory: args["jsx-factory"] || configParam.jsx_factory,
+			jsxFragment: args["jsx-fragment"] || configParam.jsx_fragment,
+			tsconfig: args.tsconfig ?? configParam.tsconfig,
+			upstreamProtocol: upstreamProtocol,
+			localProtocol: args.localProtocol || configParam.dev.local_protocol,
+			localUpstream: args["local-upstream"] || host,
+			enableLocalPersistence: args.experimentalEnableLocalPersistence || false,
+			liveReload: args.liveReload || false,
+			accountId: configParam.account_id || getAccountFromCache()?.id,
+			assetPaths: assetPaths,
+			assetsConfig: configParam.assets,
+			port: args.port || configParam.dev.port || (await getLocalPort()),
+			ip: args.ip || configParam.dev.ip,
+			inspectorPort:
+				args["inspector-port"] ||
+				configParam.dev.inspector_port ||
+				(await getInspectorPort()),
+			isWorkersSite: Boolean(args.site || configParam.site),
+			compatibilityDate: getDevCompatibilityDate(
+				config,
+				args["compatibility-date"]
+			),
+			compatibilityFlags:
+				args["compatibility-flags"] || configParam.compatibility_flags,
+			usageModel: configParam.usage_model,
+			bindings: bindings,
+			crons: configParam.triggers.crons,
+			logLevel: args.logLevel,
+			logPrefix: args.logPrefix,
+			onReady: args.onReady,
+			inspect: args.inspect ?? true,
+			showInteractiveDevSession: args.showInteractiveDevSession,
+			forceLocal: args.forceLocal,
+			enablePagesAssetsServiceBinding: args.enablePagesAssetsServiceBinding,
+			local: true,
+			firstPartyWorker: undefined,
+			sendMetrics: undefined,
+		});
+	}
+
+	const devServer = await getDevServer(config);
+	if (!devServer) {
+		throw logger.error("Failed to start dev server.");
+	}
+
+	return {
+		stop: async () => {
+			await devServer.stop();
+		},
+		fetch: async (init?: RequestInit) => {
+			const port = args.port || config.dev.port || (await getLocalPort());
+			const address = args.ip || config.dev.ip || "localhost";
+
+			return await fetch(`http://${address}:${port}/`, init);
+		},
+	};
+}
 /**
  * Avoiding calling `getPort()` multiple times by memoizing the first result.
  */
@@ -553,6 +561,182 @@ function memoizeGetPort(defaultPort: number) {
 		return portValue || (portValue = await getPort({ port: defaultPort }));
 	};
 }
+/**
+ * mask anything that was overridden in .dev.vars
+ * so that we don't log potential secrets into the terminal
+ */
+function maskVars(bindings: CfWorkerInit["bindings"], configParam: Config) {
+	const maskedVars = { ...bindings.vars };
+	for (const key of Object.keys(maskedVars)) {
+		if (maskedVars[key] !== configParam.vars[key]) {
+			// This means it was overridden in .dev.vars
+			// so let's mask it
+			maskedVars[key] = "(hidden)";
+		}
+	}
+	return maskedVars;
+}
+
+async function getZoneIdHostAndRoutes(args: StartDevOptions, config: Config) {
+	// TODO: if worker_dev = false and no routes, then error (only for dev)
+	// Compute zone info from the `host` and `route` args and config;
+	let host = args.host || config.dev.host;
+	let zoneId: string | undefined;
+	const routes: Route[] | undefined =
+		args.routes || (config.route && [config.route]) || config.routes;
+
+	if (args.forceLocal) {
+		args.local = true;
+	}
+
+	if (!args.local) {
+		if (host) {
+			zoneId = await getZoneIdFromHost(host);
+		}
+		if (!zoneId && routes) {
+			const firstRoute = routes[0];
+			const zone = await getZoneForRoute(firstRoute);
+			if (zone) {
+				zoneId = zone.id;
+				host = zone.host;
+			}
+		}
+	} else if (!host) {
+		if (routes) {
+			const firstRoute = routes[0];
+			host = getHostFromRoute(firstRoute);
+		}
+	}
+	return { host, routes, zoneId };
+}
+
+async function validateDevServerSettings(
+	args: StartDevOptions,
+	config: Config
+) {
+	const entry = await getEntry(
+		{ assets: args.assets, script: args.script },
+		config,
+		"dev"
+	);
+
+	const { zoneId, host, routes } = await getZoneIdHostAndRoutes(args, config);
+	const getLocalPort = memoizeGetPort(DEFAULT_LOCAL_PORT);
+	const getInspectorPort = memoizeGetPort(DEFAULT_INSPECTOR_PORT);
+
+	if (config.services && config.services.length > 0) {
+		logger.warn(
+			`This worker is bound to live services: ${config.services
+				.map(
+					(service) =>
+						`${service.binding} (${service.service}${
+							service.environment ? `@${service.environment}` : ""
+						})`
+				)
+				.join(", ")}`
+		);
+	}
+
+	if (args.inspect) {
+		//devtools are enabled by default, but we still need to disable them if the caller doesn't want them
+		logger.warn(
+			"Passing --inspect is unnecessary, now you can always connect to devtools."
+		);
+	}
+
+	if (args["experimental-public"]) {
+		throw new Error(
+			"The --experimental-public field has been renamed to --assets"
+		);
+	}
+
+	if (args.public) {
+		throw new Error("The --public field has been renamed to --assets");
+	}
+
+	if ((args.assets || config.assets) && (args.site || config.site)) {
+		throw new Error("Cannot use Assets and Workers Sites in the same Worker.");
+	}
+
+	if (args.assets) {
+		logger.warn(
+			"The --assets argument is experimental and may change or break at any time"
+		);
+	}
+
+	const upstreamProtocol =
+		args["upstream-protocol"] || config.dev.upstream_protocol;
+	if (upstreamProtocol === "http") {
+		logger.warn(
+			"Setting upstream-protocol to http is not currently implemented.\n" +
+				"If this is required in your project, please add your use case to the following issue:\n" +
+				"https://github.com/cloudflare/wrangler2/issues/583."
+		);
+	}
+	const nodeCompat = args.nodeCompat ?? config.node_compat;
+	if (nodeCompat) {
+		logger.warn(
+			"Enabling node.js compatibility mode for built-ins and globals. This is experimental and has serious tradeoffs. Please see https://github.com/ionic-team/rollup-plugin-node-polyfills/ for more details."
+		);
+	}
+
+	const cliDefines =
+		args.define?.reduce<Record<string, string>>((collectDefines, d) => {
+			const [key, ...value] = d.split(":");
+			collectDefines[key] = value.join("");
+			return collectDefines;
+		}, {}) || {};
+
+	return {
+		entry,
+		upstreamProtocol,
+		nodeCompat,
+		getLocalPort,
+		getInspectorPort,
+		zoneId,
+		host,
+		routes,
+		cliDefines,
+	};
+}
+
+async function getBindingsAndAssetPaths(
+	args: StartDevOptions,
+	configParam: Config
+) {
+	const cliVars =
+		args.var?.reduce<Record<string, string>>((collectVars, v) => {
+			const [key, ...value] = v.split(":");
+			collectVars[key] = value.join("");
+			return collectVars;
+		}, {}) || {};
+
+	// now log all available bindings into the terminal
+	const bindings = await getBindings(configParam, {
+		kv: args.kv,
+		vars: { ...args.vars, ...cliVars },
+		durableObjects: args.durableObjects,
+		r2: args.r2,
+	});
+
+	const maskedVars = maskVars(bindings, configParam);
+
+	printBindings({
+		...bindings,
+		vars: maskedVars,
+	});
+
+	const assetPaths =
+		args.assets || configParam.assets
+			? getAssetPaths(configParam, args.assets)
+			: getSiteAssetPaths(
+					configParam,
+					args.site,
+					args.siteInclude,
+					args.siteExclude
+			  );
+	return { assetPaths, bindings };
+}
 
 async function getBindings(
 	configParam: Config,
@@ -615,7 +799,7 @@ async function getBindings(
 			) || []),
 			...(args.r2 || []),
 		],
-		worker_namespaces: configParam.worker_namespaces,
+		dispatch_namespaces: configParam.dispatch_namespaces,
 		services: configParam.services,
 		unsafe: configParam.unsafe?.bindings,
 		logfwdr: configParam.logfwdr,