wrangler 2.1.14 → 2.2.0

package/src/d1/execute.tsx

@@ -1,7 +1,6 @@
 import { existsSync } from "node:fs";
 import { mkdir } from "node:fs/promises";
 import path from "node:path";
-import chalk from "chalk";
 import { render, Static, Text } from "ink";
 import Table from "ink-table";
 import { npxImport } from "npx-import";
@@ -52,7 +51,7 @@ type QueryResult = {
 	query?: string;
 };
 // Max number of bytes to send in a single /execute call
-const QUERY_LIMIT = 1_000_000; // 1MB
+const QUERY_LIMIT = 10_000;
 
 export function Options(yargs: Argv): Argv<ExecuteArgs> {
 	return Name(yargs)
@@ -119,28 +118,23 @@ export const Handler = withConfig<ExecuteArgs>(
 		if (!response) return;
 
 		if (isInteractive) {
+			// Render table if single result
 			render(
 				<Static items={response}>
 					{(result) => {
-						const { results, duration, query } = result;
+						// batch results
+						if (!Array.isArray(result)) {
+							const { results, query } = result;
 
-						if (Array.isArray(results) && results.length > 0) {
-							const shortQuery = shorten(query, 48);
-							return (
-								<>
-									{shortQuery ? <Text dimColor>{shortQuery}</Text> : null}
-									<Table data={results}></Table>
-								</>
-							);
-						} else {
-							const shortQuery = shorten(query, 24);
-							return (
-								<Text>
-									Executed{" "}
-									{shortQuery ? <Text dimColor>{shortQuery}</Text> : "command"}{" "}
-									in {duration}ms.
-								</Text>
-							);
+							if (Array.isArray(results) && results.length > 0) {
+								const shortQuery = shorten(query, 48);
+								return (
+									<>
+										{shortQuery ? <Text dimColor>{shortQuery}</Text> : null}
+										<Table data={results}></Table>
+									</>
+								);
+							}
 						}
 					}}
 				</Static>
@@ -187,7 +181,7 @@ async function executeLocally(
 		await mkdir(dbDir, { recursive: true });
 	}
 
-	console.log(`Loading DB at ${readableRelative(dbPath)}`);
+	logger.log(`🌀 Loading DB at ${readableRelative(dbPath)}`);
 	const db = await createSQLiteDB(dbPath);
 
 	const results: QueryResult[] = [];
@@ -206,17 +200,14 @@ async function executeRemotely(
 	batches: string[]
 ) {
 	if (batches.length > 1) {
-		const warning =
-			chalk.red(`WARNING! `) +
-			`Too much SQL to send at once, this execution will be sent as ${batches.length} batches.`;
+		const warning = `⚠️  Too much SQL to send at once, this execution will be sent as ${batches.length} batches.`;
 
 		if (isInteractive) {
 			const ok = await confirm(
-				`${warning}\nNOTE: each batch is sent individually and may leave your DB in an unexpected state if a later batch fails.\n${chalk.green(
-					`Make sure you have a recent backup.`
-				)}\nOk to proceed?`
+				`${warning}\nℹ️  Each batch is sent individually and may leave your DB in an unexpected state if a later batch fails.\n⚠️  Make sure you have a recent backup. Ok to proceed?`
 			);
 			if (!ok) return null;
+			logger.log(`🌀 Let's go`);
 		} else {
 			console.error(warning);
 		}
@@ -230,7 +221,7 @@ async function executeRemotely(
 	);
 
 	if (isInteractive) {
-		console.log(`Executing on ${name} (${db.uuid}):`);
+		logger.log(`🌀 Executing on ${name} (${db.uuid}):`);
 	} else {
 		// Pipe to error so we don't break jq
 		console.error(`Executing on ${name} (${db.uuid}):`);
@@ -238,24 +229,37 @@ async function executeRemotely(
 
 	const results: QueryResult[] = [];
 	for (const sql of batches) {
-		results.push(
-			...(await fetchResult<QueryResult[]>(
-				`/accounts/${accountId}/d1/database/${db.uuid}/query`,
-				{
-					method: "POST",
-					headers: {
-						"Content-Type": "application/json",
-					},
-					body: JSON.stringify({ sql }),
-				}
-			))
+		const result = await fetchResult<QueryResult[]>(
+			`/accounts/${accountId}/d1/database/${db.uuid}/query`,
+			{
+				method: "POST",
+				headers: {
+					"Content-Type": "application/json",
+				},
+				body: JSON.stringify({ sql }),
+			}
 		);
+		result.map(logResult);
+		results.push(...result);
 	}
 	return results;
 }
 
+function logResult(r: QueryResult | QueryResult[]) {
+	logger.log(
+		`🚣 Executed ${Array.isArray(r) ? r.length : "1"} command(s) in ${
+			Array.isArray(r)
+				? r
+						.map((d: QueryResult) => d.duration)
+						.reduce((a: number, b: number) => a + b, 0)
+				: r.duration
+		}ms`
+	);
+}
+
 function splitSql(splitter: (query: SQLQuery) => SQLQuery[], sql: SQLQuery) {
 	// We have no interpolations, so convert everything to text
+	logger.log(`🌀 Mapping SQL input into an array of statements`);
 	return splitter(sql).map(
 		(q) =>
 			q.format({
@@ -267,16 +271,17 @@ function splitSql(splitter: (query: SQLQuery) => SQLQuery[], sql: SQLQuery) {
 
 function batchSplit(splitter: typeof splitSqlQuery, sql: SQLQuery) {
 	const queries = splitSql(splitter, sql);
-
+	logger.log(`🌀 Parsing ${queries.length} statements`);
 	const batches: string[] = [];
-	for (const query of queries) {
-		const last = batches.at(-1);
-		if (!last || last.length + query.length > QUERY_LIMIT) {
-			batches.push(query);
-		} else {
-			batches.splice(-1, 1, [last, query].join("; "));
-		}
+	const nbatches = Math.floor(queries.length / QUERY_LIMIT);
+	for (let i = 0; i <= nbatches; i++) {
+		batches.push(
+			queries.slice(i * QUERY_LIMIT, (i + 1) * QUERY_LIMIT).join("; ")
+		);
 	}
+	logger.log(
+		`🌀 We are sending ${batches.length} batch(es) to D1 (limited to ${QUERY_LIMIT} statements per batch)`
+	);
 	return batches;
 }
 

package/src/d1/index.ts

@@ -4,9 +4,10 @@ import * as Delete from "./delete";
 import * as Execute from "./execute";
 import * as List from "./list";
 import { d1BetaWarning } from "./utils";
+import type { CommonYargsOptions } from "../yargs-types";
 import type { Argv } from "yargs";
 
-export const d1 = (yargs: Argv) => {
+export const d1 = (yargs: Argv<CommonYargsOptions>) => {
 	return (
 		yargs
 			.command("list", "List D1 databases", List.Options, List.Handler)

package/src/delete.ts

@@ -11,17 +11,14 @@ import * as metrics from "./metrics";
 import { requireAuth } from "./user";
 import { getScriptName, printWranglerBanner } from "./index";
 import type { ConfigPath } from "./index";
-import type { YargsOptionsToInterface } from "./yargs-types";
-import type { Argv, ArgumentsCamelCase } from "yargs";
+import type {
+	CommonYargsOptions,
+	YargsOptionsToInterface,
+} from "./yargs-types";
+import type { Argv } from "yargs";
 
-export function deleteOptions(yargs: Argv) {
+export function deleteOptions(yargs: Argv<CommonYargsOptions>) {
 	return yargs
-		.option("env", {
-			type: "string",
-			requiresArg: true,
-			describe: "Perform on a specific environment",
-			alias: "e",
-		})
 		.positional("script", {
 			describe: "The path to an entry point for your worker",
 			type: "string",
@@ -45,7 +42,7 @@ export function deleteOptions(yargs: Argv) {
 
 type DeleteArgs = YargsOptionsToInterface<typeof deleteOptions>;
 
-export async function deleteHandler(args: ArgumentsCamelCase<DeleteArgs>) {
+export async function deleteHandler(args: DeleteArgs) {
 	await printWranglerBanner();
 
 	const configPath =

package/src/deployments.ts

@@ -0,0 +1,73 @@
+import { fetchResult } from "./cfetch";
+import { logger } from "./logger";
+import type { ServiceMetadataRes } from "./init";
+
+export type DeploymentListRes = {
+	latest: {
+		id: string;
+		number: string;
+		metadata: {
+			author_id: string;
+			author_email: string;
+			source: "api" | "dash" | "wrangler" | "terraform" | "other";
+			created_on: string;
+			modified_on: string;
+		};
+		resources: {
+			script: string;
+			bindings: unknown[];
+		};
+	};
+	items: {
+		id: string;
+		number: string;
+		metadata: {
+			author_id: string;
+			author_email: string;
+			source: "api" | "dash" | "wrangler" | "terraform" | "other";
+			created_on: string;
+			modified_on: string;
+		};
+	}[];
+};
+
+export async function deployments(
+	accountId: string,
+	scriptName: string | undefined
+) {
+	const scriptMetadata = await fetchResult<ServiceMetadataRes>(
+		`/accounts/${accountId}/workers/services/${scriptName}`
+	);
+
+	const scriptTag = scriptMetadata.default_environment.script.tag;
+	const { items: deploys } = await fetchResult<DeploymentListRes>(
+		`/accounts/${accountId}/workers/versions/by-script/${scriptTag}`
+	);
+
+	const versionMessages = deploys.map(
+		(versions) =>
+			`\nDeployment ID: ${versions.id}
+Created on: ${versions.metadata.created_on}
+Author: ${versions.metadata.author_email}
+Source: ${sourceStr(versions.metadata.source)}\n`
+	);
+
+	versionMessages[0] += "🟩Active";
+	logger.log(...versionMessages.reverse());
+}
+
+// TODO Include emoji/icon for each source
+function sourceStr(source: string): string {
+	switch (source) {
+		case "api":
+			return "API";
+		case "dash":
+			return "Dashboard";
+		case "wrangler":
+			return "Wrangler";
+		case "terraform":
+			return "Terraform";
+		default:
+			return "Other";
+	}
+}

package/src/deprecated/index.ts

@@ -10,7 +10,10 @@ import {
 import { initHandler } from "../init";
 import { logger } from "../logger";
 import { formatMessage } from "../parse";
-import type { YargsOptionsToInterface } from "../yargs-types";
+import type {
+	CommonYargsOptions,
+	YargsOptionsToInterface,
+} from "../yargs-types";
 import type { Argv, ArgumentsCamelCase, BuilderCallback } from "yargs";
 
 // https://github.com/cloudflare/wrangler/blob/master/src/cli/mod.rs#L106-L123
@@ -21,7 +24,7 @@ interface GenerateArgs {
 	site?: boolean;
 }
 
-export function generateOptions(yargs: Argv) {
+export function generateOptions(yargs: Argv<CommonYargsOptions>) {
 	return yargs
 		.positional("name", {
 			describe: "Name of the Workers project",
@@ -298,11 +301,8 @@ function parseTemplatePath(templatePath: string): {
 	return { remote, subdirectory };
 }
 
-export function buildOptions(yargs: Argv) {
-	return yargs.option("env", {
-		describe: "Perform on a specific environment",
-		type: "string",
-	});
+export function buildOptions(yargs: Argv<CommonYargsOptions>) {
+	return yargs;
 }
 type BuildArgs = YargsOptionsToInterface<typeof buildOptions>;
 export async function buildHandler(buildArgs: BuildArgs) {
@@ -340,7 +340,7 @@ export const configHandler = () => {
 	);
 };
 
-export function previewOptions(yargs: Argv) {
+export function previewOptions(yargs: Argv<CommonYargsOptions>) {
 	return yargs
 		.positional("method", {
 			type: "string",
@@ -350,11 +350,6 @@ export function previewOptions(yargs: Argv) {
 			type: "string",
 			describe: "Body string to post to your preview worker request.",
 		})
-		.option("env", {
-			type: "string",
-			requiresArg: true,
-			describe: "Perform on a specific environment",
-		})
 		.option("watch", {
 			default: true,
 			describe: "Enable live preview",
@@ -376,11 +371,6 @@ export const route: BuilderCallback<unknown, unknown> = (routeYargs: Argv) => {
 			"List the routes associated with a zone",
 			(yargs) => {
 				return yargs
-					.option("env", {
-						type: "string",
-						requiresArg: true,
-						describe: "Perform on a specific environment",
-					})
 					.option("zone", {
 						type: "string",
 						requiresArg: true,
@@ -416,11 +406,6 @@ export const route: BuilderCallback<unknown, unknown> = (routeYargs: Argv) => {
 						type: "string",
 						requiresArg: true,
 						describe: "zone id",
-					})
-					.option("env", {
-						type: "string",
-						requiresArg: true,
-						describe: "Perform on a specific environment",
 					});
 			},
 			() => {
@@ -442,7 +427,7 @@ export const routeHandler = () => {
 	throw new DeprecationError(`${deprecationNotice}\n${shouldDo}`);
 };
 
-export const subdomainOptions = (yargs: Argv) => {
+export const subdomainOptions = (yargs: Argv<CommonYargsOptions>) => {
 	return yargs.positional("name", { type: "string" });
 };
 

package/src/dev/dev-vars.ts

@@ -1,6 +1,5 @@
-import * as fs from "node:fs";
 import * as path from "node:path";
-import dotenv from "dotenv";
+import { loadDotEnv } from "../config";
 import { logger } from "../logger";
 import type { Config } from "../config";
 
@@ -14,21 +13,25 @@ import type { Config } from "../config";
  * It is useful during development, to provide these types of variable locally.
  * When running `wrangler dev` we will look for a file called `.dev.vars`, situated
  * next to the `wrangler.toml` file (or in the current working directory if there is no
- * `wrangler.toml`).
+ * `wrangler.toml`). If the `--env <env>` option is set, we'll first look for
+ * `.dev.vars.<env>`.
  *
  * Any values in this file, formatted like a `dotenv` file, will add to or override `vars`
  * bindings provided in the `wrangler.toml`.
  */
-export function getVarsForDev(config: Config): Config["vars"] {
+export function getVarsForDev(
+	config: Config,
+	env: string | undefined
+): Config["vars"] {
 	const configDir = path.resolve(path.dirname(config.configPath ?? "."));
 	const devVarsPath = path.resolve(configDir, ".dev.vars");
-	if (fs.existsSync(devVarsPath)) {
-		const devVarsRelativePath = path.relative(process.cwd(), devVarsPath);
+	const loaded = loadDotEnv(devVarsPath, env);
+	if (loaded !== undefined) {
+		const devVarsRelativePath = path.relative(process.cwd(), loaded.path);
 		logger.log(`Using vars defined in ${devVarsRelativePath}`);
-		const devVars = dotenv.parse(fs.readFileSync(devVarsPath, "utf8"));
 		return {
 			...config.vars,
-			...devVars,
+			...loaded.parsed,
 		};
 	} else {
 		return config.vars;

package/src/dev/dev.tsx

@@ -130,6 +130,7 @@ export type DevProps = {
 	bindings: CfWorkerInit["bindings"];
 	define: Config["define"];
 	crons: Config["triggers"]["crons"];
+	queueConsumers: Config["queues"]["consumers"];
 	isWorkersSite: boolean;
 	assetPaths: AssetPaths | undefined;
 	assetsConfig: Config["assets"];
@@ -289,6 +290,16 @@ function DevSession(props: DevSessionProps) {
 		experimentalLocalStubCache: props.local && props.experimentalLocal,
 	});
 
+	// TODO(queues) support remote wrangler dev
+	if (
+		!props.local &&
+		(props.bindings.queues?.length || props.queueConsumers?.length)
+	) {
+		logger.warn(
+			"Queues are currently in Beta and are not supported in wrangler dev remote mode."
+		);
+	}
+
 	return props.local ? (
 		<Local
 			name={props.name}
@@ -307,6 +318,7 @@ function DevSession(props: DevSessionProps) {
 			localPersistencePath={props.localPersistencePath}
 			liveReload={props.liveReload}
 			crons={props.crons}
+			queueConsumers={props.queueConsumers}
 			localProtocol={props.localProtocol}
 			localUpstream={props.localUpstream}
 			logPrefix={props.logPrefix}

package/src/dev/local.tsx

@@ -30,6 +30,7 @@ import type {
 	CfKvNamespace,
 	CfR2Bucket,
 	CfVars,
+	CfQueue,
 	CfD1Database,
 } from "../worker";
 import type { EsbuildBundle } from "./use-esbuild";
@@ -57,6 +58,7 @@ export interface LocalProps {
 	localPersistencePath: string | null;
 	liveReload: boolean;
 	crons: Config["triggers"]["crons"];
+	queueConsumers: Config["queues"]["consumers"];
 	localProtocol: "http" | "https";
 	localUpstream: string | undefined;
 	inspect: boolean;
@@ -94,6 +96,7 @@ function useLocalWorker({
 	liveReload,
 	ip,
 	crons,
+	queueConsumers,
 	localProtocol,
 	localUpstream,
 	inspect,
@@ -184,6 +187,8 @@ function useLocalWorker({
 				usageModel,
 				kv_namespaces: bindings?.kv_namespaces,
 				r2_buckets: bindings?.r2_buckets,
+				queueBindings: bindings?.queues,
+				queueConsumers: queueConsumers,
 				d1_databases: bindings?.d1_databases,
 				internalDurableObjects,
 				externalDurableObjects,
@@ -329,6 +334,8 @@ function useLocalWorker({
 		port,
 		inspectorPort,
 		ip,
+		queueConsumers,
+		bindings.queues,
 		bindings.durable_objects,
 		bindings.kv_namespaces,
 		bindings.r2_buckets,
@@ -452,6 +459,8 @@ interface SetupMiniflareOptionsProps {
 	compatibilityFlags: string[] | undefined;
 	usageModel: "bundled" | "unbound" | undefined;
 	kv_namespaces: CfKvNamespace[] | undefined;
+	queueBindings: CfQueue[] | undefined;
+	queueConsumers: Config["queues"]["consumers"];
 	r2_buckets: CfR2Bucket[] | undefined;
 	d1_databases: CfD1Database[] | undefined;
 	internalDurableObjects: CfDurableObject[];
@@ -482,6 +491,8 @@ export function setupMiniflareOptions({
 	compatibilityFlags,
 	usageModel,
 	kv_namespaces,
+	queueBindings,
+	queueConsumers,
 	r2_buckets,
 	d1_databases,
 	internalDurableObjects,
@@ -521,6 +532,21 @@ export function setupMiniflareOptions({
 		compatibilityFlags,
 		usageModel,
 		kvNamespaces: kv_namespaces?.map((kv) => kv.binding),
+		queueBindings: queueBindings?.map((queue) => {
+			return { name: queue.binding, queueName: queue.queue_name };
+		}),
+		queueConsumers: queueConsumers?.map((consumer) => {
+			const waitMs = consumer.max_batch_timeout
+				? 1000 * consumer.max_batch_timeout
+				: undefined;
+			return {
+				queueName: consumer.queue,
+				maxBatchSize: consumer.max_batch_size,
+				maxWaitMs: waitMs,
+				maxRetries: consumer.max_retries,
+				deadLetterQueue: consumer.dead_letter_queue,
+			};
+		}),
 		r2Buckets: r2_buckets?.map((r2) => r2.binding),
 		durableObjects: Object.fromEntries(
 			internalDurableObjects.map((binding) => [

package/src/dev/remote.tsx

@@ -104,6 +104,7 @@ export function Remote(props: RemoteProps) {
 		port: props.inspectorPort,
 		logToTerminal: true,
 		sourceMapPath: props.sourceMapPath,
+		host: previewToken?.host,
 	});
 
 	const errorHandler = useErrorHandler();
@@ -569,6 +570,7 @@ async function createRemoteWorkerInit(props: {
 		compatibility_flags: props.compatibilityFlags,
 		usage_model: props.usageModel,
 		keepVars: true,
+		logpush: false,
 	};
 
 	return init;

package/src/dev/start-server.ts

@@ -114,6 +114,7 @@ export async function startDevServer(
 				localPersistencePath: props.localPersistencePath,
 				liveReload: props.liveReload,
 				crons: props.crons,
+				queueConsumers: props.queueConsumers,
 				localProtocol: props.localProtocol,
 				localUpstream: props.localUpstream,
 				logPrefix: props.logPrefix,
@@ -225,10 +226,12 @@ async function runEsbuild({
 		resolvedEntryPointPath,
 		bundleType,
 		modules,
+		dependencies,
 		sourceMapPath,
 	}: Awaited<ReturnType<typeof bundleWorker>> = noBundle
 		? {
 				modules: [],
+				dependencies: {},
 				resolvedEntryPointPath: entry.file,
 				bundleType: entry.format === "modules" ? "esm" : "commonjs",
 				stop: undefined,
@@ -264,6 +267,7 @@ async function runEsbuild({
 		path: resolvedEntryPointPath,
 		type: bundleType,
 		modules,
+		dependencies,
 		sourceMapPath,
 	};
 }
@@ -285,6 +289,7 @@ export async function startLocalServer({
 	liveReload,
 	ip,
 	crons,
+	queueConsumers,
 	localProtocol,
 	localUpstream,
 	inspect,
@@ -364,6 +369,8 @@ export async function startLocalServer({
 			compatibilityFlags,
 			usageModel,
 			kv_namespaces: bindings?.kv_namespaces,
+			queueBindings: bindings?.queues,
+			queueConsumers,
 			r2_buckets: bindings?.r2_buckets,
 			d1_databases: bindings?.d1_databases,
 			internalDurableObjects,

package/src/dev/use-esbuild.ts

@@ -2,13 +2,13 @@ import assert from "node:assert";
 import { watch } from "chokidar";
 import { useApp } from "ink";
 import { useState, useEffect } from "react";
-import { bundleWorker } from "../bundle";
-import { logger } from "../logger";
+import { bundleWorker, rewriteNodeCompatBuildFailure } from "../bundle";
+import { logBuildFailure, logger } from "../logger";
 import type { Config } from "../config";
 import type { WorkerRegistry } from "../dev-registry";
 import type { Entry } from "../entry";
 import type { CfModule } from "../worker";
-import type { WatchMode } from "esbuild";
+import type { WatchMode, Metafile } from "esbuild";
 
 export type EsbuildBundle = {
 	id: number;
@@ -16,6 +16,7 @@ export type EsbuildBundle = {
 	entry: Entry;
 	type: "esm" | "commonjs";
 	modules: CfModule[];
+	dependencies: Metafile["outputs"][string]["inputs"];
 	sourceMapPath: string | undefined;
 };
 
@@ -83,8 +84,11 @@ export function useEsbuild({
 
 		const watchMode: WatchMode = {
 			async onRebuild(error) {
-				if (error) logger.error("Watch build failed:", error);
-				else {
+				if (error !== null) {
+					if (!nodeCompat) rewriteNodeCompatBuildFailure(error);
+					logBuildFailure(error);
+					logger.error("Watch build failed:", error.message);
+				} else {
 					updateBundle();
 				}
 			},
@@ -97,11 +101,13 @@ export function useEsbuild({
 				resolvedEntryPointPath,
 				bundleType,
 				modules,
+				dependencies,
 				stop,
 				sourceMapPath,
 			}: Awaited<ReturnType<typeof bundleWorker>> = noBundle
 				? {
 						modules: [],
+						dependencies: {},
 						resolvedEntryPointPath: entry.file,
 						bundleType: entry.format === "modules" ? "esm" : "commonjs",
 						stop: undefined,
@@ -155,6 +161,7 @@ export function useEsbuild({
 				path: resolvedEntryPointPath,
 				type: bundleType,
 				modules,
+				dependencies,
 				sourceMapPath,
 			});
 		}