wrangler 2.1.15 → 2.2.1

package/src/dev.tsx

@@ -31,6 +31,7 @@ import type { Config, Environment } from "./config";
 import type { Route } from "./config/environment";
 import type { EnablePagesAssetsServiceBindingOptions } from "./miniflare-cli";
 import type { CfWorkerInit } from "./worker";
+import type { CommonYargsOptions } from "./yargs-types";
 import type { Argv, ArgumentsCamelCase } from "yargs";
 
 interface DevArgs {
@@ -79,7 +80,7 @@ interface DevArgs {
 	"test-scheduled"?: boolean;
 }
 
-export function devOptions(yargs: Argv): Argv<DevArgs> {
+export function devOptions(yargs: Argv<CommonYargsOptions>): Argv<DevArgs> {
 	return (
 		yargs
 			.positional("script", {
@@ -111,12 +112,6 @@ export function devOptions(yargs: Argv): Argv<DevArgs> {
 				hidden: true,
 				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",
@@ -455,6 +450,7 @@ export async function startDev(args: StartDevOptions) {
 					usageModel={configParam.usage_model}
 					bindings={bindings}
 					crons={configParam.triggers.crons}
+					queueConsumers={configParam.queues.consumers}
 					logPrefix={args.logPrefix}
 					onReady={args.onReady}
 					inspect={args.inspect ?? true}
@@ -574,6 +570,7 @@ export async function startApiDev(args: StartDevOptions) {
 			usageModel: configParam.usage_model,
 			bindings: bindings,
 			crons: configParam.triggers.crons,
+			queueConsumers: configParam.queues.consumers,
 			logPrefix: args.logPrefix,
 			onReady: args.onReady,
 			inspect: args.inspect ?? true,
@@ -763,7 +760,7 @@ async function getBindingsAndAssetPaths(
 	const cliVars = collectKeyValues(args.var);
 
 	// now log all available bindings into the terminal
-	const bindings = await getBindings(configParam, {
+	const bindings = await getBindings(configParam, args.env, {
 		kv: args.kv,
 		vars: { ...args.vars, ...cliVars },
 		durableObjects: args.durableObjects,
@@ -792,6 +789,7 @@ async function getBindingsAndAssetPaths(
 
 async function getBindings(
 	configParam: Config,
+	env: string | undefined,
 	args: AdditionalDevProps
 ): Promise<CfWorkerInit["bindings"]> {
 	const bindings = {
@@ -821,7 +819,7 @@ async function getBindings(
 		],
 		// Use a copy of combinedVars since we're modifying it later
 		vars: {
-			...getVarsForDev(configParam),
+			...getVarsForDev(configParam, env),
 			...args.vars,
 		},
 		wasm_modules: configParam.wasm_modules,
@@ -833,6 +831,11 @@ async function getBindings(
 				...(args.durableObjects || []),
 			],
 		},
+		queues: [
+			...(configParam.queues.producers || []).map((queue) => {
+				return { binding: queue.binding, queue_name: queue.queue };
+			}),
+		],
 		r2_buckets: [
 			...(configParam.r2_buckets?.map(
 				({ binding, preview_bucket_name, bucket_name: _bucket_name }) => {

package/src/dispatch-namespace.ts

@@ -5,6 +5,7 @@ import * as metrics from "./metrics";
 import { requireAuth } from "./user";
 import { printWranglerBanner } from ".";
 import type { ConfigPath } from ".";
+import type { CommonYargsOptions } from "./yargs-types";
 import type { Argv, CommandModule } from "yargs";
 
 type Namespace = {
@@ -105,9 +106,9 @@ async function renameWorkerNamespace(
 }
 
 export function workerNamespaceCommands(
-	workerNamespaceYargs: Argv,
-	subHelp: CommandModule
-): Argv {
+	workerNamespaceYargs: Argv<CommonYargsOptions>,
+	subHelp: CommandModule<CommonYargsOptions, CommonYargsOptions>
+) {
 	return workerNamespaceYargs
 		.command(subHelp)
 		.command("list", "List all dispatch namespaces", {}, async (args) => {

package/src/index.tsx

@@ -5,10 +5,11 @@ import supportsColor from "supports-color";
 import { ProxyAgent, setGlobalDispatcher } from "undici";
 import makeCLI from "yargs";
 import { version as wranglerVersion } from "../package.json";
-import { fetchResult } from "./cfetch";
-import { readConfig } from "./config";
+import { isBuildFailure } from "./bundle";
+import { loadDotEnv, readConfig } from "./config";
 import { d1 } from "./d1";
 import { deleteHandler, deleteOptions } from "./delete";
+import { deployments } from "./deployments";
 import {
 	buildHandler,
 	buildOptions,
@@ -27,12 +28,13 @@ import { devHandler, devOptions } from "./dev";
 import { workerNamespaceCommands } from "./dispatch-namespace";
 import { initHandler, initOptions } from "./init";
 import { kvNamespace, kvKey, kvBulk } from "./kv";
-import { logger } from "./logger";
+import { logBuildFailure, logger } from "./logger";
 import * as metrics from "./metrics";
 import { pages } from "./pages";
 import { formatMessage, ParseError } from "./parse";
 import { publishOptions, publishHandler } from "./publish";
 import { pubSubCommands } from "./pubsub/pubsub-commands";
+import { queues } from "./queues/cli/commands";
 import { r2 } from "./r2";
 import { secret, secretBulkHandler, secretBulkOptions } from "./secret";
 import { tailOptions, tailHandler } from "./tail";
@@ -47,10 +49,9 @@ import {
 } from "./user";
 import { whoami } from "./whoami";
 
-import type { DeploymentListRes } from "./__tests__/helpers/msw/handlers/deployments";
 import type { Config } from "./config";
-import type { ServiceMetadataRes } from "./init";
 import type { PartialConfigToDTS } from "./type-generation";
+import type { CommonYargsOptions } from "./yargs-types";
 import type { ArgumentsCamelCase } from "yargs";
 import type Yargs from "yargs";
 
@@ -174,7 +175,9 @@ export function demandOneOfOption(...options: string[]) {
 export class CommandLineArgsError extends Error {}
 
 export function createCLIParser(argv: string[]) {
-	const wrangler = makeCLI(argv)
+	// Type check result against CommonYargsOptions to make sure we've included
+	// all common options
+	const wrangler: Yargs.Argv<CommonYargsOptions> = makeCLI(argv)
 		.strict()
 		// We handle errors ourselves in a try-catch around `yargs.parse`.
 		// If you want the "help info" to be displayed then throw an instance of `CommandLineArgsError`.
@@ -189,10 +192,41 @@ export function createCLIParser(argv: string[]) {
 			throw error;
 		})
 		.scriptName("wrangler")
-		.wrap(null);
+		.wrap(null)
+		// Define global options here, so they get included in the `Argv` type of
+		// the `wrangler` variable
+		.version(false)
+		.option("v", {
+			describe: "Show version number",
+			alias: "version",
+			type: "boolean",
+		})
+		.option("config", {
+			alias: "c",
+			describe: "Path to .toml configuration file",
+			type: "string",
+			requiresArg: true,
+		})
+		.option("env", {
+			alias: "e",
+			describe: "Environment to use for operations and .env files",
+			type: "string",
+			requiresArg: true,
+		})
+		.check((args) => {
+			// Grab locally specified env params from `.env` file
+			const loaded = loadDotEnv(".env", args.env);
+			for (const [key, value] of Object.entries(loaded?.parsed ?? {})) {
+				if (!(key in process.env)) process.env[key] = value;
+			}
+			return true;
+		});
+
+	wrangler.group(["config", "env", "help", "version"], "Flags:");
+	wrangler.help().alias("h", "help");
 
 	// Default help command that supports the subcommands
-	const subHelp: Yargs.CommandModule = {
+	const subHelp: Yargs.CommandModule<CommonYargsOptions, CommonYargsOptions> = {
 		command: ["*"],
 		handler: async (args) => {
 			setImmediate(() =>
@@ -363,6 +397,11 @@ export function createCLIParser(argv: string[]) {
 		return pages(pagesYargs.command(subHelp));
 	});
 
+	// queues
+	wrangler.command("queues", "🆀 Configure Workers Queues", (queuesYargs) => {
+		return queues(queuesYargs.command(subHelp));
+	});
+
 	// r2
 	wrangler.command("r2", "📦 Interact with an R2 store", (r2Yargs) => {
 		return r2(r2Yargs.command(subHelp));
@@ -511,15 +550,20 @@ export function createCLIParser(argv: string[]) {
 		}
 	);
 
+	//deployments
+	const deploymentsWarning =
+		"🚧`wrangler deployments` is a beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose";
 	wrangler.command(
 		"deployments",
 		false,
 		// "🚢 Logs the 10 most recent deployments with 'Version ID', 'Version number','Author email', 'Created on' and 'Latest deploy'",
 		(yargs) => {
-			yargs.option("name", {
-				describe: "The name of your worker",
-				type: "string",
-			});
+			yargs
+				.option("name", {
+					describe: "The name of your worker",
+					type: "string",
+				})
+				.epilogue(deploymentsWarning);
 		},
 		async (deploymentsYargs: ArgumentsCamelCase<{ name: string }>) => {
 			await printWranglerBanner();
@@ -532,24 +576,9 @@ export function createCLIParser(argv: string[]) {
 				{ name: deploymentsYargs.name, env: undefined },
 				config
 			);
-			const scriptMetadata = await fetchResult<ServiceMetadataRes>(
-				`/accounts/${accountId}/workers/services/${scriptName}`
-			);
-
-			const scriptTag = scriptMetadata.default_environment.script.tag;
-			const deployments = await fetchResult<DeploymentListRes>(
-				`/accounts/${accountId}/workers/versions/by-script/${scriptTag}`
-			);
 
-			const versionMessages = deployments.versions.map(
-				(versions, index) =>
-					`\nVersion ID: ${versions.version_id}\nVersion number: ${
-						versions.version_number
-					}\nCreated on: ${versions.metadata.created_on}\nAuthor email: ${
-						versions.metadata.author_email
-					}\nLatest deploy: ${index === 0}\n`
-			);
-			logger.log(...versionMessages);
+			logger.log(`${deploymentsWarning}\n`);
+			await deployments(accountId, scriptName);
 		}
 	);
 
@@ -570,22 +599,6 @@ export function createCLIParser(argv: string[]) {
 		}
 	);
 
-	wrangler.option("v", {
-		describe: "Show version number",
-		alias: "version",
-		type: "boolean",
-	});
-
-	wrangler.option("config", {
-		alias: "c",
-		describe: "Path to .toml configuration file",
-		type: "string",
-		requiresArg: true,
-	});
-
-	wrangler.group(["config", "help", "version"], "Flags:");
-	wrangler.help().alias("h", "help");
-
 	wrangler.exitProcess(false);
 
 	return wrangler;
@@ -634,6 +647,9 @@ export async function main(argv: string[]): Promise<void> {
 			logger.error(
 				`${thisTerminalIsUnsupported}\n${soWranglerWontWork}\n${tryRunningItIn}${oneOfThese}`
 			);
+		} else if (isBuildFailure(e)) {
+			logBuildFailure(e);
+			logger.error(e.message);
 		} else {
 			logger.error(e instanceof Error ? e.message : e);
 			logger.log(

package/src/init.ts

@@ -22,9 +22,10 @@ import type { Route, SimpleRoute } from "./config/environment";
 import type { WorkerMetadata } from "./create-worker-upload-form";
 import type { ConfigPath } from "./index";
 import type { PackageManager } from "./package-manager";
+import type { CommonYargsOptions } from "./yargs-types";
 import type { Argv, ArgumentsCamelCase } from "yargs";
 
-export async function initOptions(yargs: Argv) {
+export async function initOptions(yargs: Argv<CommonYargsOptions>) {
 	return yargs
 		.positional("name", {
 			describe: "The name of your worker",
@@ -417,7 +418,7 @@ export async function initHandler(args: ArgumentsCamelCase<InitArgs>) {
 			);
 			instructions.push(
 				`\nTo start developing your Worker, run \`${
-					isNamedWorker ? `cd ${args.name} && ` : ""
+					isNamedWorker ? `cd ${args.name || fromDashScriptName} && ` : ""
 				}npm start\``
 			);
 			if (isAddingTestScripts) {
@@ -805,8 +806,7 @@ async function getWorkerConfig(
 					{
 						configObj.vars = {
 							...(configObj.vars ?? {}),
-							name: binding.name,
-							text: binding.text,
+							[binding.name]: binding.text,
 						};
 					}
 					break;

package/src/inspect.ts

@@ -11,6 +11,7 @@ import WebSocket, { WebSocketServer } from "ws";
 import { version } from "../package.json";
 import { logger } from "./logger";
 import { waitForPortToBeAvailable } from "./proxy";
+import { getAccessToken } from "./user/access";
 import type Protocol from "devtools-protocol";
 import type { IncomingMessage, Server, ServerResponse } from "node:http";
 import type { MessageEvent } from "ws";
@@ -58,6 +59,8 @@ interface InspectorProps {
 	 * Sourcemap path, so that stacktraces can be interpretted
 	 */
 	sourceMapPath?: string | undefined;
+
+	host?: string;
 }
 
 export default function useInspector(props: InspectorProps) {
@@ -204,14 +207,31 @@ export default function useInspector(props: InspectorProps) {
 	/** A simple incrementing id to attach to messages we send to devtools */
 	const messageCounterRef = useRef(1);
 
+	const cfAccessRef = useRef<string>();
+
+	useEffect(() => {
+		const run = async () => {
+			if (props.host && !cfAccessRef.current) {
+				const token = await getAccessToken(props.host);
+				cfAccessRef.current = token;
+			}
+		};
+		if (props.host) void run();
+	}, [props.host]);
+
 	// This effect tracks the connection to the remote websocket
 	// (stored in, no surprises here, `remoteWebSocket`)
 	useEffect(() => {
 		if (!props.inspectorUrl) {
 			return;
 		}
+
 		// The actual websocket instance
-		const ws = new WebSocket(props.inspectorUrl);
+		const ws = new WebSocket(props.inspectorUrl, {
+			headers: {
+				cookie: `CF_Authorization=${cfAccessRef.current}`,
+			},
+		});
 		setRemoteWebSocket(ws);
 
 		/**

package/src/kv/index.ts

@@ -26,12 +26,11 @@ import {
 	unexpectedKVKeyValueProps,
 } from "./helpers";
 import type { ConfigPath } from "../index";
+import type { CommonYargsOptions } from "../yargs-types";
 import type { KeyValue } from "./helpers";
-import type { BuilderCallback, Argv } from "yargs";
+import type { Argv } from "yargs";
 
-export const kvNamespace: BuilderCallback<unknown, unknown> = (
-	kvYargs: Argv
-) => {
+export const kvNamespace = (kvYargs: Argv<CommonYargsOptions>) => {
 	return kvYargs
 		.command(
 			"create <namespace>",
@@ -43,12 +42,6 @@ export const kvNamespace: BuilderCallback<unknown, unknown> = (
 						type: "string",
 						demandOption: true,
 					})
-					.option("env", {
-						type: "string",
-						requiresArg: true,
-						describe: "Perform on a specific environment",
-						alias: "e",
-					})
 					.option("preview", {
 						type: "boolean",
 						describe: "Interact with a preview namespace",
@@ -133,12 +126,6 @@ export const kvNamespace: BuilderCallback<unknown, unknown> = (
 						describe: "The id of the namespace to delete",
 					})
 					.check(demandOneOfOption("binding", "namespace-id"))
-					.option("env", {
-						type: "string",
-						requiresArg: true,
-						describe: "Perform on a specific environment",
-						alias: "e",
-					})
 					.option("preview", {
 						type: "boolean",
 						describe: "Interact with a preview namespace",
@@ -187,7 +174,7 @@ export const kvNamespace: BuilderCallback<unknown, unknown> = (
 		);
 };
 
-export const kvKey: BuilderCallback<unknown, unknown> = (kvYargs: Argv) => {
+export const kvKey = (kvYargs: Argv<CommonYargsOptions>) => {
 	return kvYargs
 		.command(
 			"put <key> [value]",
@@ -214,12 +201,6 @@ export const kvKey: BuilderCallback<unknown, unknown> = (kvYargs: Argv) => {
 						describe: "The id of the namespace to write to",
 					})
 					.check(demandOneOfOption("binding", "namespace-id"))
-					.option("env", {
-						type: "string",
-						requiresArg: true,
-						describe: "Perform on a specific environment",
-						alias: "e",
-					})
 					.option("preview", {
 						type: "boolean",
 						describe: "Interact with a preview namespace",
@@ -302,12 +283,6 @@ export const kvKey: BuilderCallback<unknown, unknown> = (kvYargs: Argv) => {
 						describe: "The id of the namespace to list",
 					})
 					.check(demandOneOfOption("binding", "namespace-id"))
-					.option("env", {
-						type: "string",
-						requiresArg: true,
-						describe: "Perform on a specific environment",
-						alias: "e",
-					})
 					.option("preview", {
 						type: "boolean",
 						// In the case of listing keys we will default to non-preview mode
@@ -359,12 +334,6 @@ export const kvKey: BuilderCallback<unknown, unknown> = (kvYargs: Argv) => {
 						describe: "The id of the namespace to get from",
 					})
 					.check(demandOneOfOption("binding", "namespace-id"))
-					.option("env", {
-						type: "string",
-						requiresArg: true,
-						describe: "Perform on a specific environment",
-						alias: "e",
-					})
 					.option("preview", {
 						type: "boolean",
 						describe: "Interact with a preview namespace",
@@ -422,12 +391,6 @@ export const kvKey: BuilderCallback<unknown, unknown> = (kvYargs: Argv) => {
 						describe: "The id of the namespace to delete from",
 					})
 					.check(demandOneOfOption("binding", "namespace-id"))
-					.option("env", {
-						type: "string",
-						requiresArg: true,
-						describe: "Perform on a specific environment",
-						alias: "e",
-					})
 					.option("preview", {
 						type: "boolean",
 						describe: "Interact with a preview namespace",
@@ -450,7 +413,7 @@ export const kvKey: BuilderCallback<unknown, unknown> = (kvYargs: Argv) => {
 		);
 };
 
-export const kvBulk: BuilderCallback<unknown, unknown> = (kvYargs: Argv) => {
+export const kvBulk = (kvYargs: Argv<CommonYargsOptions>) => {
 	return kvYargs
 		.command(
 			"put <filename>",
@@ -473,12 +436,6 @@ export const kvBulk: BuilderCallback<unknown, unknown> = (kvYargs: Argv) => {
 						describe: "The id of the namespace to insert values into",
 					})
 					.check(demandOneOfOption("binding", "namespace-id"))
-					.option("env", {
-						type: "string",
-						requiresArg: true,
-						describe: "Perform on a specific environment",
-						alias: "e",
-					})
 					.option("preview", {
 						type: "boolean",
 						describe: "Interact with a preview namespace",
@@ -572,12 +529,6 @@ export const kvBulk: BuilderCallback<unknown, unknown> = (kvYargs: Argv) => {
 						describe: "The id of the namespace to delete from",
 					})
 					.check(demandOneOfOption("binding", "namespace-id"))
-					.option("env", {
-						type: "string",
-						requiresArg: true,
-						describe: "Perform on a specific environment",
-						alias: "e",
-					})
 					.option("preview", {
 						type: "boolean",
 						describe: "Interact with a preview namespace",

package/src/logger.ts

@@ -1,6 +1,7 @@
 import { format } from "node:util";
 import { formatMessagesSync } from "esbuild";
 import { getEnvironmentVariableFactory } from "./environment-variables";
+import type { BuildFailure } from "esbuild";
 
 export const LOGGER_LEVELS = {
 	none: -1,
@@ -78,3 +79,14 @@ class Logger {
  * to filter out logging messages.
  */
 export const logger = new Logger();
+
+/**
+ * Logs all errors/warnings associated with an esbuild BuildFailure in the same
+ * style esbuild would.
+ */
+export function logBuildFailure(failure: BuildFailure) {
+	let logs = formatMessagesSync(failure.errors, { kind: "error", color: true });
+	for (const log of logs) console.error(log);
+	logs = formatMessagesSync(failure.warnings, { kind: "warning", color: true });
+	for (const log of logs) console.warn(log);
+}

package/src/pages/build.tsx

@@ -1,6 +1,6 @@
 import { writeFileSync } from "node:fs";
 import { tmpdir } from "node:os";
-import { dirname, join } from "node:path";
+import { dirname, join, resolve } from "node:path";
 import { FatalError } from "../errors";
 import { logger } from "../logger";
 import * as metrics from "../metrics";
@@ -81,6 +81,13 @@ export function Options(yargs: Argv) {
 				type: "boolean",
 				hidden: true,
 			},
+			bindings: {
+				type: "string",
+				describe:
+					"Bindings used in Functions (used to register beta product shims)",
+				deprecated: true,
+				hidden: true,
+			},
 		})
 		.epilogue(pagesBetaWarning);
 }
@@ -97,6 +104,7 @@ export const Handler = async ({
 	plugin,
 	buildOutputDirectory,
 	nodeCompat,
+	bindings,
 }: PagesBuildArgs) => {
 	if (!isInPagesCI) {
 		// Beta message for `wrangler pages <commands>` usage
@@ -109,6 +117,16 @@ export const Handler = async ({
 		);
 	}
 
+	let d1Databases: string[] | undefined = undefined;
+	if (bindings) {
+		try {
+			const decodedBindings = JSON.parse(bindings);
+			d1Databases = Object.keys(decodedBindings?.d1_databases || {});
+		} catch {
+			throw new FatalError("Could not parse a valid set of 'bindings'.", 1);
+		}
+	}
+
 	buildOutputDirectory ??= dirname(outfile);
 	try {
 		await buildFunctions({
@@ -123,6 +141,8 @@ export const Handler = async ({
 			buildOutputDirectory,
 			nodeCompat,
 			routesOutputPath,
+			local: false,
+			d1Databases,
 		});
 	} catch (e) {
 		if (e instanceof FunctionsNoRoutesError) {
@@ -154,6 +174,8 @@ export async function buildFunctions({
 	buildOutputDirectory,
 	routesOutputPath,
 	nodeCompat,
+	local,
+	d1Databases,
 }: Partial<
 	Pick<
 		PagesBuildArgs,
@@ -171,6 +193,8 @@ export async function buildFunctions({
 	onEnd?: () => void;
 	outfile: Required<PagesBuildArgs>["outfile"];
 	routesOutputPath?: PagesBuildArgs["outputRoutesPath"];
+	local: boolean;
+	d1Databases?: string[];
 }) {
 	RUNNING_BUILDERS.forEach(
 		(runningBuilder) => runningBuilder.stop && runningBuilder.stop()
@@ -208,6 +232,8 @@ export async function buildFunctions({
 		outfile: routesModule,
 	});
 
+	const absoluteFunctionsDirectory = resolve(functionsDirectory);
+
 	if (plugin) {
 		RUNNING_BUILDERS.push(
 			await buildPlugin({
@@ -217,6 +243,9 @@ export async function buildFunctions({
 				sourcemap,
 				watch,
 				nodeCompat,
+				functionsDirectory: absoluteFunctionsDirectory,
+				local,
+				betaD1Shims: d1Databases,
 				onEnd,
 			})
 		);
@@ -229,6 +258,9 @@ export async function buildFunctions({
 				sourcemap,
 				fallbackService,
 				watch,
+				functionsDirectory: absoluteFunctionsDirectory,
+				local,
+				betaD1Shims: d1Databases,
 				onEnd,
 				buildOutputDirectory,
 				nodeCompat,