wrangler 2.0.12 → 2.0.16

package/src/dev.tsx

@@ -0,0 +1,538 @@
+import path from "node:path";
+import { watch } from "chokidar";
+import getPort from "get-port";
+import { render } from "ink";
+import React from "react";
+import { fetch } from "undici";
+import { findWranglerToml, printBindings, readConfig } from "./config";
+import Dev from "./dev/dev";
+import { getVarsForDev } from "./dev/dev-vars";
+
+import { getEntry } from "./entry";
+import { logger } from "./logger";
+import { getAssetPaths, getSiteAssetPaths } from "./sites";
+import { getAccountFromCache } from "./user";
+import { getZoneIdFromHost, getZoneForRoute, getHostFromRoute } from "./zones";
+import {
+	printWranglerBanner,
+	DEFAULT_LOCAL_PORT,
+	type ConfigPath,
+	getScriptName,
+	getDevCompatibilityDate,
+	getRules,
+	isLegacyEnv,
+} from "./index";
+
+import type { Config } from "./config";
+import type { Route } from "./config/environment";
+import type { CfWorkerInit } from "./worker";
+import type { RequestInit } from "undici";
+import type { Argv, ArgumentsCamelCase } from "yargs";
+
+interface DevArgs {
+	config?: string;
+	script?: string;
+	name?: string;
+	bundle?: boolean;
+	build?: boolean;
+	format?: string;
+	env?: string;
+	"compatibility-date"?: string;
+	"compatibility-flags"?: string[];
+	latest?: boolean;
+	ip?: string;
+	inspect?: boolean;
+	port?: number;
+	"inspector-port"?: number;
+	routes?: string[];
+	host?: string;
+	"local-protocol"?: "http" | "https";
+	"local-upstream"?: string | undefined;
+	"experimental-public"?: string;
+	public?: string;
+	assets?: string;
+	site?: string;
+	"site-include"?: string[];
+	"site-exclude"?: string[];
+	"upstream-protocol"?: "http" | "https";
+	"jsx-factory"?: string;
+	"jsx-fragment"?: string;
+	tsconfig?: string;
+	local?: boolean;
+	minify?: boolean;
+	"node-compat"?: boolean;
+	"experimental-enable-local-persistence"?: boolean;
+	onReady?: () => void;
+	logLevel?: "none" | "error" | "log" | "warn" | "debug";
+	showInteractiveDevSession?: boolean;
+}
+
+export function devOptions(yargs: Argv): Argv<DevArgs> {
+	return (
+		yargs
+			.positional("script", {
+				describe: "The path to an entry point for your worker",
+				type: "string",
+			})
+			.option("name", {
+				describe: "Name of the worker",
+				type: "string",
+				requiresArg: true,
+			})
+			// We want to have a --no-bundle flag, but yargs requires that
+			// we also have a --bundle flag (that it adds the --no to by itself)
+			// So we make a --bundle flag, but hide it, and then add a --no-bundle flag
+			// that's visible to the user but doesn't "do" anything.
+			.option("bundle", {
+				describe: "Run wrangler's compilation step before publishing",
+				type: "boolean",
+				hidden: true,
+			})
+			.option("no-bundle", {
+				describe: "Skip internal build steps and directly publish script",
+				type: "boolean",
+				default: false,
+			})
+			.option("format", {
+				choices: ["modules", "service-worker"] as const,
+				describe: "Choose an entry type",
+				deprecated: true,
+			})
+			.option("env", {
+				describe: "Perform on a specific environment",
+				type: "string",
+				requiresArg: true,
+				alias: "e",
+			})
+			.option("compatibility-date", {
+				describe: "Date to use for compatibility checks",
+				type: "string",
+				requiresArg: true,
+			})
+			.option("compatibility-flags", {
+				describe: "Flags to use for compatibility checks",
+				alias: "compatibility-flag",
+				type: "string",
+				requiresArg: true,
+				array: true,
+			})
+			.option("latest", {
+				describe: "Use the latest version of the worker runtime",
+				type: "boolean",
+				default: true,
+			})
+			.option("ip", {
+				describe: "IP address to listen on, defaults to `localhost`",
+				type: "string",
+				requiresArg: true,
+			})
+			.option("port", {
+				describe: "Port to listen on",
+				type: "number",
+			})
+			.option("inspector-port", {
+				describe: "Port for devtools to connect to",
+				type: "number",
+			})
+			.option("routes", {
+				describe: "Routes to upload",
+				alias: "route",
+				type: "string",
+				requiresArg: true,
+				array: true,
+			})
+			.option("host", {
+				type: "string",
+				requiresArg: true,
+				describe:
+					"Host to forward requests to, defaults to the zone of project",
+			})
+			.option("local-protocol", {
+				describe: "Protocol to listen to requests on, defaults to http.",
+				choices: ["http", "https"] as const,
+			})
+			.options("local-upstream", {
+				type: "string",
+				describe:
+					"Host to act as origin in local mode, defaults to dev.host or route",
+			})
+			.option("experimental-public", {
+				describe: "Static assets to be served",
+				type: "string",
+				requiresArg: true,
+				deprecated: true,
+				hidden: true,
+			})
+			.option("assets", {
+				describe: "Static assets to be served",
+				type: "string",
+				requiresArg: true,
+			})
+			.option("site", {
+				describe: "Root folder of static assets for Workers Sites",
+				type: "string",
+				requiresArg: true,
+			})
+			.option("site-include", {
+				describe:
+					"Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded.",
+				type: "string",
+				requiresArg: true,
+				array: true,
+			})
+			.option("site-exclude", {
+				describe:
+					"Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded.",
+				type: "string",
+				requiresArg: true,
+				array: true,
+			})
+			.option("upstream-protocol", {
+				describe: "Protocol to forward requests to host on, defaults to https.",
+				choices: ["http", "https"] as const,
+			})
+			.option("jsx-factory", {
+				describe: "The function that is called for each JSX element",
+				type: "string",
+				requiresArg: true,
+			})
+			.option("jsx-fragment", {
+				describe: "The function that is called for each JSX fragment",
+				type: "string",
+				requiresArg: true,
+			})
+			.option("tsconfig", {
+				describe: "Path to a custom tsconfig.json file",
+				type: "string",
+				requiresArg: true,
+			})
+			.option("local", {
+				alias: "l",
+				describe: "Run on my machine",
+				type: "boolean",
+				default: false, // I bet this will a point of contention. We'll revisit it.
+			})
+			.option("minify", {
+				describe: "Minify the script",
+				type: "boolean",
+			})
+			.option("node-compat", {
+				describe: "Enable node.js compatibility",
+				type: "boolean",
+			})
+			.option("experimental-enable-local-persistence", {
+				describe: "Enable persistence for this session (only for local mode)",
+				type: "boolean",
+			})
+			.option("inspect", {
+				describe: "Enable dev tools",
+				type: "boolean",
+				deprecated: true,
+			})
+			.option("legacy-env", {
+				type: "boolean",
+				describe: "Use legacy environments",
+				hidden: true,
+			})
+	);
+}
+
+export async function devHandler(args: ArgumentsCamelCase<DevArgs>) {
+	let watcher;
+	try {
+		const devInstance = await startDev(args);
+		watcher = devInstance.watcher;
+		const { waitUntilExit } = devInstance.devReactElement;
+		await waitUntilExit();
+	} finally {
+		await watcher?.close();
+	}
+}
+
+export async function startDev(args: ArgumentsCamelCase<DevArgs>) {
+	let watcher: ReturnType<typeof watch> | undefined;
+	let rerender: (node: React.ReactNode) => void | undefined;
+	try {
+		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);
+		let config = readConfig(configPath, args);
+
+		if (config.configPath) {
+			watcher = watch(config.configPath, {
+				persistent: true,
+			}).on("change", async (_event) => {
+				// TODO: Do we need to handle different `_event` types differently?
+				//       e.g. what if the file is deleted, or added?
+				config = readConfig(configPath, args);
+				if (config.configPath) {
+					logger.log(`${path.basename(config.configPath)} changed...`);
+					rerender(await getDevReactElement(config));
+				}
+			});
+		}
+
+		const entry = await getEntry(
+			{ assets: args.assets, script: args.script },
+			config,
+			"dev"
+		);
+
+		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.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["node-compat"] ?? 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."
+			);
+		}
+
+		// eslint-disable-next-line no-inner-declarations
+		async function getBindings(
+			configParam: Config
+		): Promise<CfWorkerInit["bindings"]> {
+			return {
+				kv_namespaces: configParam.kv_namespaces?.map(
+					({ binding, preview_id, id: _id }) => {
+						// In `dev`, we make folks use a separate kv namespace called
+						// `preview_id` instead of `id` so that they don't
+						// break production data. So here we check that a `preview_id`
+						// has actually been configured.
+						// This whole block of code will be obsoleted in the future
+						// when we have copy-on-write for previews on edge workers.
+						if (!preview_id) {
+							// TODO: This error has to be a _lot_ better, ideally just asking
+							// to create a preview namespace for the user automatically
+							throw new Error(
+								`In development, you should use a separate kv namespace than the one you'd use in production. Please create a new kv namespace with "wrangler kv:namespace create <name> --preview" and add its id as preview_id to the kv_namespace "${binding}" in your wrangler.toml`
+							); // Ugh, I really don't like this message very much
+						}
+						return {
+							binding,
+							id: preview_id,
+						};
+					}
+				),
+				// Use a copy of combinedVars since we're modifying it later
+				vars: getVarsForDev(configParam),
+				wasm_modules: configParam.wasm_modules,
+				text_blobs: configParam.text_blobs,
+				data_blobs: configParam.data_blobs,
+				durable_objects: configParam.durable_objects,
+				r2_buckets: configParam.r2_buckets?.map(
+					({ binding, preview_bucket_name, bucket_name: _bucket_name }) => {
+						// same idea as kv namespace preview id,
+						// same copy-on-write TODO
+						if (!preview_bucket_name) {
+							throw new Error(
+								`In development, you should use a separate r2 bucket than the one you'd use in production. Please create a new r2 bucket with "wrangler r2 bucket create <name>" and add its name as preview_bucket_name to the r2_buckets "${binding}" in your wrangler.toml`
+							);
+						}
+						return {
+							binding,
+							bucket_name: preview_bucket_name,
+						};
+					}
+				),
+				worker_namespaces: configParam.worker_namespaces,
+				services: configParam.services,
+				unsafe: configParam.unsafe?.bindings,
+			};
+		}
+
+		const getLocalPort = memoizeGetPort(DEFAULT_LOCAL_PORT);
+		const getInspectorPort = memoizeGetPort(9229);
+
+		// 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);
+			// 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
+					  );
+
+			return (
+				<Dev
+					name={getScriptName({ name: args.name, env: args.env }, config)}
+					noBundle={!(args.bundle ?? !config.no_bundle)}
+					entry={entry}
+					env={args.env}
+					zone={zoneId}
+					host={host}
+					routes={routes}
+					rules={getRules(config)}
+					legacyEnv={isLegacyEnv(config)}
+					minify={args.minify ?? config.minify}
+					nodeCompat={nodeCompat}
+					build={config.build || {}}
+					define={config.define}
+					initialMode={args.local ? "local" : "remote"}
+					jsxFactory={args["jsx-factory"] || config.jsx_factory}
+					jsxFragment={args["jsx-fragment"] || config.jsx_fragment}
+					tsconfig={args.tsconfig ?? config.tsconfig}
+					upstreamProtocol={upstreamProtocol}
+					localProtocol={args["local-protocol"] || config.dev.local_protocol}
+					localUpstream={args["local-upstream"] || host}
+					enableLocalPersistence={
+						args["experimental-enable-local-persistence"] || false
+					}
+					accountId={config.account_id || getAccountFromCache()?.id}
+					assetPaths={assetPaths}
+					port={args.port || config.dev.port || (await getLocalPort())}
+					ip={args.ip || config.dev.ip}
+					inspectorPort={args["inspector-port"] ?? (await getInspectorPort())}
+					isWorkersSite={Boolean(args.site || config.site)}
+					compatibilityDate={getDevCompatibilityDate(
+						config,
+						args["compatibility-date"]
+					)}
+					compatibilityFlags={
+						args["compatibility-flags"] || config.compatibility_flags
+					}
+					usageModel={config.usage_model}
+					bindings={bindings}
+					crons={config.triggers.crons}
+					logLevel={args.logLevel}
+					onReady={args.onReady}
+					inspect={args.inspect}
+					showInteractiveDevSession={args.showInteractiveDevSession}
+				/>
+			);
+		}
+		const devReactElement = render(await getDevReactElement(config));
+		rerender = devReactElement.rerender;
+		return {
+			devReactElement,
+			watcher,
+			stop: async () => {
+				devReactElement.unmount();
+				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";
+
+				return await fetch(`http://${address}:${port}/`, init);
+			},
+		};
+	} finally {
+		await watcher?.close();
+	}
+}
+
+/**
+ * Avoiding calling `getPort()` multiple times by memoizing the first result.
+ */
+function memoizeGetPort(defaultPort: number) {
+	let portValue: number;
+	return async () => {
+		return portValue || (portValue = await getPort({ port: defaultPort }));
+	};
+}