wrangler 2.0.22 → 2.0.25

package/src/dev.tsx

@@ -22,10 +22,12 @@ import {
 	getDevCompatibilityDate,
 	getRules,
 	isLegacyEnv,
+	DEFAULT_INSPECTOR_PORT,
 } from "./index";
 
 import type { Config } from "./config";
 import type { Route } from "./config/environment";
+import type { EnablePagesAssetsServiceBindingOptions } from "./miniflare-cli";
 import type { CfWorkerInit } from "./worker";
 import type { RequestInit } from "undici";
 import type { Argv, ArgumentsCamelCase } from "yargs";
@@ -63,8 +65,10 @@ interface DevArgs {
 	minify?: boolean;
 	"node-compat"?: boolean;
 	"experimental-enable-local-persistence"?: boolean;
+	"live-reload"?: boolean;
 	onReady?: () => void;
 	logLevel?: "none" | "error" | "log" | "warn" | "debug";
+	logPrefix?: string;
 	showInteractiveDevSession?: boolean;
 }
 
@@ -123,9 +127,9 @@ export function devOptions(yargs: Argv): Argv<DevArgs> {
 				default: true,
 			})
 			.option("ip", {
-				describe: "IP address to listen on, defaults to `localhost`",
+				describe: "IP address to listen on",
 				type: "string",
-				requiresArg: true,
+				default: "0.0.0.0",
 			})
 			.option("port", {
 				describe: "Port to listen on",
@@ -225,6 +229,12 @@ export function devOptions(yargs: Argv): Argv<DevArgs> {
 				describe: "Enable persistence for this session (only for local mode)",
 				type: "boolean",
 			})
+			.option("live-reload", {
+				// TODO: Add back in once we have remote `--live-reload`
+				hidden: true,
+				// describe: "Auto reload HTML pages when change is detected",
+				type: "boolean",
+			})
 			.option("inspect", {
 				describe: "Enable dev tools",
 				type: "boolean",
@@ -250,7 +260,36 @@ export async function devHandler(args: ArgumentsCamelCase<DevArgs>) {
 	}
 }
 
-export async function startDev(args: ArgumentsCamelCase<DevArgs>) {
+export type AdditionalDevProps = {
+	vars?: {
+		[key: string]: unknown;
+	};
+	kv?: {
+		binding: string;
+		id: string;
+		preview_id?: string;
+	}[];
+	durableObjects?: {
+		name: string;
+		class_name: string;
+		script_name?: string | undefined;
+		environment?: string | undefined;
+	}[];
+	r2?: {
+		binding: string;
+		bucket_name: string;
+		preview_bucket_name?: string;
+	}[];
+};
+type StartDevOptions = ArgumentsCamelCase<DevArgs> &
+	// These options can be passed in directly when called with the `wrangler.dev()` API.
+	// They aren't exposed as CLI arguments.
+	AdditionalDevProps & {
+		forceLocal?: boolean;
+		enablePagesAssetsServiceBinding?: EnablePagesAssetsServiceBindingOptions;
+	};
+
+export async function startDev(args: StartDevOptions) {
 	let watcher: ReturnType<typeof watch> | undefined;
 	let rerender: (node: React.ReactNode) => void | undefined;
 	try {
@@ -265,11 +304,6 @@ export async function startDev(args: ArgumentsCamelCase<DevArgs>) {
 			((args.script &&
 				findWranglerToml(path.dirname(args.script))) as ConfigPath);
 		let config = readConfig(configPath, args);
-		await metrics.sendMetricsEvent(
-			"run dev",
-			{ local: args.local },
-			{ sendMetrics: config.send_metrics, offline: args.local }
-		);
 
 		if (config.configPath) {
 			watcher = watch(config.configPath, {
@@ -291,6 +325,15 @@ export async function startDev(args: ArgumentsCamelCase<DevArgs>) {
 			"dev"
 		);
 
+		await metrics.sendMetricsEvent(
+			"run dev",
+			{
+				local: args.local,
+				usesTypeScript: /\.tsx?$/.test(entry.file),
+			},
+			{ 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
@@ -351,6 +394,10 @@ export async function startDev(args: ArgumentsCamelCase<DevArgs>) {
 		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);
@@ -370,73 +417,26 @@ export async function startDev(args: ArgumentsCamelCase<DevArgs>) {
 			}
 		}
 
-		const nodeCompat = args["node-compat"] ?? config.node_compat;
+		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."
 			);
 		}
 
-		// 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);
+		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);
+			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 };
@@ -483,16 +483,22 @@ export async function startDev(args: ArgumentsCamelCase<DevArgs>) {
 					jsxFragment={args["jsx-fragment"] || config.jsx_fragment}
 					tsconfig={args.tsconfig ?? config.tsconfig}
 					upstreamProtocol={upstreamProtocol}
-					localProtocol={args["local-protocol"] || config.dev.local_protocol}
+					localProtocol={args.localProtocol || config.dev.local_protocol}
 					localUpstream={args["local-upstream"] || host}
 					enableLocalPersistence={
-						args["experimental-enable-local-persistence"] || false
+						args.experimentalEnableLocalPersistence || false
 					}
+					liveReload={args.liveReload || false}
 					accountId={config.account_id || getAccountFromCache()?.id}
 					assetPaths={assetPaths}
+					assetsConfig={config.assets}
 					port={args.port || config.dev.port || (await getLocalPort())}
 					ip={args.ip || config.dev.ip}
-					inspectorPort={args["inspector-port"] ?? (await getInspectorPort())}
+					inspectorPort={
+						args.inspectorPort ||
+						config.dev.inspector_port ||
+						(await getInspectorPort())
+					}
 					isWorkersSite={Boolean(args.site || config.site)}
 					compatibilityDate={getDevCompatibilityDate(
 						config,
@@ -505,9 +511,14 @@ export async function startDev(args: ArgumentsCamelCase<DevArgs>) {
 					bindings={bindings}
 					crons={config.triggers.crons}
 					logLevel={args.logLevel}
+					logPrefix={args.logPrefix}
 					onReady={args.onReady}
 					inspect={args.inspect ?? true}
 					showInteractiveDevSession={args.showInteractiveDevSession}
+					forceLocal={args.forceLocal}
+					enablePagesAssetsServiceBinding={args.enablePagesAssetsServiceBinding}
+					firstPartyWorker={config.first_party_worker}
+					sendMetrics={config.send_metrics}
 				/>
 			);
 		}
@@ -542,3 +553,73 @@ function memoizeGetPort(defaultPort: number) {
 		return portValue || (portValue = await getPort({ port: defaultPort }));
 	};
 }
+
+async function getBindings(
+	configParam: Config,
+	args: AdditionalDevProps
+): Promise<CfWorkerInit["bindings"]> {
+	const bindings = {
+		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,
+					};
+				}
+			),
+			...(args.kv || []),
+		],
+		// Use a copy of combinedVars since we're modifying it later
+		vars: {
+			...getVarsForDev(configParam),
+			...args.vars,
+		},
+		wasm_modules: configParam.wasm_modules,
+		text_blobs: configParam.text_blobs,
+		data_blobs: configParam.data_blobs,
+		durable_objects: {
+			bindings: [
+				...(configParam.durable_objects || { bindings: [] }).bindings,
+				...(args.durableObjects || []),
+			],
+		},
+		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,
+					};
+				}
+			) || []),
+			...(args.r2 || []),
+		],
+		worker_namespaces: configParam.worker_namespaces,
+		services: configParam.services,
+		unsafe: configParam.unsafe?.bindings,
+		logfwdr: configParam.logfwdr,
+	};
+
+	return bindings;
+}

package/src/generate.ts

@@ -1,33 +1,131 @@
-import { DeprecationError } from "./errors";
+import fs from "node:fs";
+import path from "node:path";
+import { setup as createCloudflare } from "create-cloudflare";
+import { initHandler } from "./init";
+import { logger } from "./logger";
+import { CommandLineArgsError, printWranglerBanner } from ".";
 import type { Argv, ArgumentsCamelCase } from "yargs";
 
+// https://github.com/cloudflare/wrangler/blob/master/src/cli/mod.rs#L106-L123
 interface GenerateArgs {
-	name: string;
-	template: string;
+	name?: string;
+	template?: string;
+	type?: string;
+	site?: boolean;
 }
 
 export function generateOptions(yargs: Argv) {
 	return yargs
 		.positional("name", {
 			describe: "Name of the Workers project",
-			default: "worker",
+			type: "string",
 		})
 		.positional("template", {
+			type: "string",
 			describe: "The URL of a GitHub template",
-			default: "https://github.com/cloudflare/worker-template",
+		})
+		.option("type", {
+			alias: "t",
+			type: "string",
+			hidden: true,
+			deprecated: true,
+		})
+		.option("site", {
+			alias: "s",
+			type: "boolean",
+			hidden: true,
+			deprecated: true,
 		});
 }
 
-export function generateHandler(
-	generateArgs: ArgumentsCamelCase<GenerateArgs>
-) {
-	// "👯 [DEPRECATED]. Scaffold a Cloudflare Workers project from a public GitHub repository.",
-	throw new DeprecationError(
-		"`wrangler generate` has been deprecated.\n" +
-			"Try running `wrangler init` to generate a basic Worker, or cloning the template repository instead:\n\n" +
+export async function generateHandler({
+	// somehow, `init` marks name as required but then also runs fine
+	// with the name omitted, and then substitutes it at runtime with ""
+	name = "",
+	template,
+	type,
+	site,
+	...args
+}: ArgumentsCamelCase<GenerateArgs>) {
+	// delegate to `wrangler init` if no template is specified
+	if (template === undefined) {
+		return initHandler({ name, ...args });
+	}
+
+	// print down here cuz `init` prints it own its own
+	printWranglerBanner();
+
+	if (type) {
+		let message = "The --type option is no longer supported.";
+		if (args.type === "webpack") {
+			message +=
+				"\nIf you wish to use webpack then you will need to create a custom build.";
+			// TODO: Add a link to docs
+		}
+		throw new CommandLineArgsError(message);
+	}
+
+	const creationDirectory = generateWorkerDirectoryName(name);
+
+	if (site) {
+		const gitDirectory =
+			creationDirectory !== process.cwd()
+				? path.basename(creationDirectory)
+				: "my-site";
+		const message =
+			"The --site option is no longer supported.\n" +
+			"If you wish to create a brand new Worker Sites project then clone the `worker-sites-template` starter repository:\n\n" +
 			"```\n" +
-			`git clone ${generateArgs.template}\n` +
+			`git clone --depth=1 --branch=wrangler2 https://github.com/cloudflare/worker-sites-template ${gitDirectory}\n` +
+			`cd ${gitDirectory}\n` +
 			"```\n\n" +
-			"Please refer to https://developers.cloudflare.com/workers/wrangler/deprecations/#generate for more information."
+			"Find out more about how to create and maintain Sites projects at https://developers.cloudflare.com/workers/platform/sites.\n" +
+			"Have you considered using Cloudflare Pages instead? See https://pages.cloudflare.com/.";
+		throw new CommandLineArgsError(message);
+	}
+
+	logger.log(
+		`Creating a worker in ${path.basename(creationDirectory)} from ${template}`
 	);
+
+	await createCloudflare(creationDirectory, template, {
+		init: true, // initialize a git repository
+		debug: logger.loggerLevel === "debug",
+		force: false, // do not overwrite an existing directory
+	});
+}
+
+/**
+ * Creates a path based on the current working directory and a worker name.
+ * Automatically increments a counter when searching for an available directory.
+ *
+ * Running `wrangler generate worker https://some-git-repo` in a directory
+ * with the structure:
+ * ```
+ * - workers
+ * |
+ * | - worker
+ * | | - wrangler.toml
+ * | | ...
+ * |
+ * | - worker-1
+ * | | - wrangler.toml
+ * | | ...
+ * ```
+ *
+ * will result in a new worker called `worker-2` being generated.
+ *
+ * @param workerName the name of the generated worker
+ * @returns an absolute path to the directory to generate the worker into
+ */
+function generateWorkerDirectoryName(workerName: string): string {
+	let workerDirectoryPath = path.resolve(process.cwd(), workerName);
+	let i = 1;
+
+	while (fs.existsSync(workerDirectoryPath)) {
+		workerDirectoryPath = path.resolve(process.cwd(), `${workerName}-${i}`);
+		i++;
+	}
+
+	return workerDirectoryPath;
 }