wrangler 2.0.27 → 2.0.28

package/src/{worker-namespace.ts → dispatch-namespace.ts}

@@ -34,7 +34,7 @@ async function createWorkerNamespace(accountId: string, name: string) {
 		}
 	);
 	logger.log(
-		`Created Worker namespace "${name}" with ID "${namespace.namespace_id}"`
+		`Created dispatch namespace "${name}" with ID "${namespace.namespace_id}"`
 	);
 }
 
@@ -46,7 +46,7 @@ async function deleteWorkerNamespace(accountId: string, name: string) {
 		`/accounts/${accountId}/workers/dispatch/namespaces/${name}`,
 		{ method: "DELETE" }
 	);
-	logger.log(`Deleted Worker namespace "${name}"`);
+	logger.log(`Deleted dispatch namespace "${name}"`);
 }
 
 /**
@@ -101,7 +101,7 @@ async function renameWorkerNamespace(
 			body: JSON.stringify({ name: newName }),
 		}
 	);
-	logger.log(`Renamed Worker namespace "${oldName}" to "${newName}"`);
+	logger.log(`Renamed dispatch namespace "${oldName}" to "${newName}"`);
 }
 
 export function workerNamespaceCommands(
@@ -110,20 +110,20 @@ export function workerNamespaceCommands(
 ): Argv {
 	return workerNamespaceYargs
 		.command(subHelp)
-		.command("list", "List all Worker namespaces", {}, async (args) => {
+		.command("list", "List all dispatch namespaces", {}, async (args) => {
 			const config = readConfig(args.config as ConfigPath, args);
 			const accountId = await requireAuth(config);
 			await listWorkerNamespaces(accountId);
-			await metrics.sendMetricsEvent("list worker namespaces", {
+			await metrics.sendMetricsEvent("list dispatch namespaces", {
 				sendMetrics: config.send_metrics,
 			});
 		})
 		.command(
 			"get <name>",
-			"Get information about a Worker namespace",
+			"Get information about a dispatch namespace",
 			(yargs) => {
 				return yargs.positional("name", {
-					describe: "Name of the Worker namespace",
+					describe: "Name of the dispatch namespace",
 					type: "string",
 					demandOption: true,
 				});
@@ -132,17 +132,17 @@ export function workerNamespaceCommands(
 				const config = readConfig(args.config as ConfigPath, args);
 				const accountId = await requireAuth(config);
 				await getWorkerNamespaceInfo(accountId, args.name);
-				await metrics.sendMetricsEvent("view worker namespace", {
+				await metrics.sendMetricsEvent("view dispatch namespace", {
 					sendMetrics: config.send_metrics,
 				});
 			}
 		)
 		.command(
 			"create <name>",
-			"Create a Worker namespace",
+			"Create a dispatch namespace",
 			(yargs) => {
 				return yargs.positional("name", {
-					describe: "Name of the Worker namespace",
+					describe: "Name of the dispatch namespace",
 					type: "string",
 					demandOption: true,
 				});
@@ -152,17 +152,17 @@ export function workerNamespaceCommands(
 				const config = readConfig(args.config as ConfigPath, args);
 				const accountId = await requireAuth(config);
 				await createWorkerNamespace(accountId, args.name);
-				await metrics.sendMetricsEvent("create worker namespace", {
+				await metrics.sendMetricsEvent("create dispatch namespace", {
 					sendMetrics: config.send_metrics,
 				});
 			}
 		)
 		.command(
 			"delete <name>",
-			"Delete a Worker namespace",
+			"Delete a dispatch namespace",
 			(yargs) => {
 				return yargs.positional("name", {
-					describe: "Name of the Worker namespace",
+					describe: "Name of the dispatch namespace",
 					type: "string",
 					demandOption: true,
 				});
@@ -172,23 +172,23 @@ export function workerNamespaceCommands(
 				const config = readConfig(args.config as ConfigPath, args);
 				const accountId = await requireAuth(config);
 				await deleteWorkerNamespace(accountId, args.name);
-				await metrics.sendMetricsEvent("delete worker namespace", {
+				await metrics.sendMetricsEvent("delete dispatch namespace", {
 					sendMetrics: config.send_metrics,
 				});
 			}
 		)
 		.command(
 			"rename <old-name> <new-name>",
-			"Rename a Worker namespace",
+			"Rename a dispatch namespace",
 			(yargs) => {
 				return yargs
 					.positional("old-name", {
-						describe: "Name of the Worker namespace",
+						describe: "Name of the dispatch namespace",
 						type: "string",
 						demandOption: true,
 					})
 					.positional("new-name", {
-						describe: "New name of the Worker namespace",
+						describe: "New name of the dispatch namespace",
 						type: "string",
 						demandOption: true,
 					});
@@ -198,7 +198,7 @@ export function workerNamespaceCommands(
 				const config = readConfig(args.config as ConfigPath, args);
 				const accountId = await requireAuth(config);
 				await renameWorkerNamespace(accountId, args.oldName, args.newName);
-				await metrics.sendMetricsEvent("rename worker namespace", {
+				await metrics.sendMetricsEvent("rename dispatch namespace", {
 					sendMetrics: config.send_metrics,
 				});
 			}

package/src/index.tsx

@@ -15,6 +15,7 @@ import { findWranglerToml, readConfig } from "./config";
 import { createWorkerUploadForm } from "./create-worker-upload-form";
 import { devHandler, devOptions } from "./dev";
 import { confirm, prompt } from "./dialogs";
+import { workerNamespaceCommands } from "./dispatch-namespace";
 import { getEntry } from "./entry";
 import { DeprecationError } from "./errors";
 import { generateHandler, generateOptions } from "./generate";
@@ -73,7 +74,7 @@ import {
 } from "./user";
 import { whoami } from "./whoami";
 
-import { workerNamespaceCommands } from "./worker-namespace";
+import { getWorkerForZone } from "./zones";
 import type { Config } from "./config";
 import type { KeyValue } from "./kv";
 import type { TailCLIFilters } from "./tail";
@@ -469,6 +470,19 @@ function createCLIParser(argv: string[]) {
 						requiresArg: true,
 						array: true,
 					})
+					.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("triggers", {
 						describe: "cron schedules to attach",
 						alias: ["schedule", "schedules"],
@@ -562,6 +576,20 @@ function createCLIParser(argv: string[]) {
 				);
 			}
 
+			const cliVars =
+				args.var?.reduce<Record<string, string>>((collectVars, v) => {
+					const [key, ...value] = v.split(":");
+					collectVars[key] = value.join("");
+					return collectVars;
+				}, {}) || {};
+
+			const cliDefines =
+				args.define?.reduce<Record<string, string>>((collectDefines, d) => {
+					const [key, ...value] = d.split(":");
+					collectDefines[key] = value.join("");
+					return collectDefines;
+				}, {}) || {};
+
 			const accountId = args.dryRun ? undefined : await requireAuth(config);
 
 			const assetPaths =
@@ -585,6 +613,8 @@ function createCLIParser(argv: string[]) {
 					? new Date().toISOString().substring(0, 10)
 					: args["compatibility-date"],
 				compatibilityFlags: args["compatibility-flags"],
+				vars: cliVars,
+				defines: cliDefines,
 				triggers: args.triggers,
 				jsxFactory: args["jsx-factory"],
 				jsxFragment: args["jsx-fragment"],
@@ -604,12 +634,12 @@ function createCLIParser(argv: string[]) {
 
 	// tail
 	wrangler.command(
-		"tail [name]",
+		"tail [worker]",
 		"🦚 Starts a log tailing session for a published Worker.",
 		(yargs) => {
 			return yargs
-				.positional("name", {
-					describe: "Name of the worker",
+				.positional("worker", {
+					describe: "Name or route of the worker to tail",
 					type: "string",
 				})
 				.option("format", {
@@ -677,7 +707,22 @@ function createCLIParser(argv: string[]) {
 				sendMetrics: config.send_metrics,
 			});
 
-			const scriptName = getLegacyScriptName(args, config);
+			let scriptName;
+
+			// Worker names can't contain "." (and most routes should), so use that as a discriminator
+			if (args.worker?.includes(".")) {
+				scriptName = await getWorkerForZone(args.worker);
+				if (args.format === "pretty") {
+					logger.log(
+						`Connecting to worker ${scriptName} at route ${args.worker}`
+					);
+				}
+			} else {
+				scriptName = getLegacyScriptName(
+					{ name: args.worker, ...args },
+					config
+				);
+			}
 
 			if (!scriptName) {
 				throw new Error(
@@ -966,7 +1011,7 @@ function createCLIParser(argv: string[]) {
 											wasm_modules: {},
 											text_blobs: {},
 											data_blobs: {},
-											worker_namespaces: [],
+											dispatch_namespaces: [],
 											logfwdr: { schema: undefined, bindings: [] },
 											unsafe: [],
 										},
@@ -975,6 +1020,7 @@ function createCLIParser(argv: string[]) {
 										compatibility_date: undefined,
 										compatibility_flags: undefined,
 										usage_model: undefined,
+										keep_bindings: false, // this doesn't matter since it's a new script anyway
 									}),
 								}
 							);
@@ -2022,8 +2068,8 @@ function createCLIParser(argv: string[]) {
 	});
 
 	wrangler.command(
-		"worker-namespace",
-		"📦 Interact with a worker namespace",
+		"dispatch-namespace",
+		"📦 Interact with a dispatch namespace",
 		(workerNamespaceYargs) => {
 			return workerNamespaceCommands(workerNamespaceYargs, subHelp);
 		}

package/src/metrics/send-event.ts

@@ -40,11 +40,11 @@ export type EventNames =
 	| "unrevoke pubsub broker credentials"
 	| "list pubsub broker revoked credentials"
 	| "list pubsub broker public-keys"
-	| "list worker namespaces"
-	| "view worker namespace"
-	| "create worker namespace"
-	| "delete worker namespace"
-	| "rename worker namespace"
+	| "list dispatch namespaces"
+	| "view dispatch namespace"
+	| "create dispatch namespace"
+	| "delete dispatch namespace"
+	| "rename dispatch namespace"
 	| "create pages project"
 	| "list pages projects"
 	| "create pages deployment"

package/src/publish.ts

@@ -36,6 +36,8 @@ type Props = {
 	compatibilityDate: string | undefined;
 	compatibilityFlags: string[] | undefined;
 	assetPaths: AssetPaths | undefined;
+	vars: Record<string, string> | undefined;
+	defines: Record<string, string> | undefined;
 	triggers: string[] | undefined;
 	routes: string[] | undefined;
 	legacyEnv: boolean | undefined;
@@ -382,7 +384,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 						tsconfig: props.tsconfig ?? config.tsconfig,
 						minify,
 						nodeCompat,
-						define: config.define,
+						define: { ...config.define, ...props.defines },
 						checkFetch: false,
 						assets: config.assets && {
 							...config.assets,
@@ -430,7 +432,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 					? { binding: "__STATIC_CONTENT", id: assets.namespace }
 					: []
 			),
-			vars: config.vars,
+			vars: { ...config.vars, ...props.vars },
 			wasm_modules: config.wasm_modules,
 			text_blobs: {
 				...config.text_blobs,
@@ -443,7 +445,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 			durable_objects: config.durable_objects,
 			r2_buckets: config.r2_buckets,
 			services: config.services,
-			worker_namespaces: config.worker_namespaces,
+			dispatch_namespaces: config.dispatch_namespaces,
 			logfwdr: config.logfwdr,
 			unsafe: config.unsafe?.bindings,
 		};
@@ -470,6 +472,7 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 			compatibility_flags:
 				props.compatibilityFlags ?? config.compatibility_flags,
 			usage_model: config.usage_model,
+			keep_bindings: true,
 		};
 
 		void printBundleSize(
@@ -482,7 +485,19 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 			kv_namespaces: config.kv_namespaces,
 			text_blobs: config.text_blobs,
 		};
-		printBindings(withoutStaticAssets);
+
+		// mask anything that was overridden in cli args
+		// so that we don't log potential secrets into the terminal
+		const maskedVars = { ...withoutStaticAssets.vars };
+		for (const key of Object.keys(maskedVars)) {
+			if (maskedVars[key] !== config.vars[key]) {
+				// This means it was overridden in cli args
+				// so let's mask it
+				maskedVars[key] = "(hidden)";
+			}
+		}
+
+		printBindings({ ...withoutStaticAssets, vars: maskedVars });
 
 		if (!props.dryRun) {
 			// Upload the script so it has time to propagate.

package/src/worker.ts

@@ -122,7 +122,7 @@ interface CfService {
 	environment?: string;
 }
 
-interface CfWorkerNamespace {
+interface CfDispatchNamespace {
 	binding: string;
 	namespace: string;
 }
@@ -183,7 +183,7 @@ export interface CfWorkerInit {
 		durable_objects: { bindings: CfDurableObject[] } | undefined;
 		r2_buckets: CfR2Bucket[] | undefined;
 		services: CfService[] | undefined;
-		worker_namespaces: CfWorkerNamespace[] | undefined;
+		dispatch_namespaces: CfDispatchNamespace[] | undefined;
 		logfwdr: CfLogfwdr | undefined;
 		unsafe: CfUnsafeBinding[] | undefined;
 	};
@@ -191,6 +191,7 @@ export interface CfWorkerInit {
 	compatibility_date: string | undefined;
 	compatibility_flags: string[] | undefined;
 	usage_model: "bundled" | "unbound" | undefined;
+	keep_bindings: boolean | undefined;
 }
 
 export interface CfWorkerContext {

package/src/zones.ts

@@ -74,3 +74,94 @@ export async function getZoneIdFromHost(host: string): Promise<string> {
 
 	throw new Error(`Could not find zone for ${host}`);
 }
+
+/**
+ * An object holding information about an assigned worker route, returned from the API
+ */
+interface WorkerRoute {
+	id: string;
+	pattern: string;
+	script: string;
+}
+
+/**
+ * Given a zone within the user's account, return a list of all assigned worker routes
+ */
+export async function getRoutesForZone(zone: string): Promise<WorkerRoute[]> {
+	const routes = await fetchListResult<WorkerRoute>(
+		`/zones/${zone}/workers/routes`
+	);
+	return routes;
+}
+
+/**
+ * Given two strings, return the levenshtein distance between them as a simple text match heuristic
+ */
+function distanceBetween(a: string, b: string, cache = new Map()): number {
+	if (cache.has(`${a}|${b}`)) {
+		return cache.get(`${a}|${b}`);
+	}
+	let result;
+	if (b == "") {
+		result = a.length;
+	} else if (a == "") {
+		result = b.length;
+	} else if (a[0] === b[0]) {
+		result = distanceBetween(a.slice(1), b.slice(1), cache);
+	} else {
+		result =
+			1 +
+			Math.min(
+				distanceBetween(a.slice(1), b, cache),
+				distanceBetween(a, b.slice(1), cache),
+				distanceBetween(a.slice(1), b.slice(1), cache)
+			);
+	}
+	cache.set(`${a}|${b}`, result);
+	return result;
+}
+
+/**
+ * Given an invalid route, sort the valid routes by closeness to the invalid route (levenstein distance)
+ */
+export function findClosestRoute(
+	providedRoute: string,
+	assignedRoutes: WorkerRoute[]
+): WorkerRoute[] {
+	return assignedRoutes.sort((a, b) => {
+		const distanceA = distanceBetween(providedRoute, a.pattern);
+		const distanceB = distanceBetween(providedRoute, b.pattern);
+		return distanceA - distanceB;
+	});
+}
+
+/**
+ * Given a route (must be assigned and within the correct zone), return the name of the worker assigned to it
+ */
+export async function getWorkerForZone(worker: string) {
+	const zone = await getZoneForRoute(worker);
+	if (!zone) {
+		throw new Error(
+			`The route '${worker}' is not part of one of your zones. Either add this zone from the Cloudflare dashboard, or try using a route within one of your existing zones.`
+		);
+	}
+	const routes = await getRoutesForZone(zone.id);
+
+	const scriptName = routes.find((route) => route.pattern === worker)?.script;
+
+	if (!scriptName) {
+		const closestRoute = findClosestRoute(worker, routes)?.[0];
+
+		if (!closestRoute) {
+			throw new Error(
+				`The route '${worker}' has no workers assigned. You can assign a worker to it from wrangler.toml or the Cloudflare dashboard`
+			);
+		} else {
+			throw new Error(
+				`The route '${worker}' has no workers assigned. Did you mean to tail the route '${closestRoute.pattern}'?`
+			);
+		}
+	}
+
+	return scriptName;
+}

package/wrangler-dist/cli.d.ts

@@ -1,12 +1,16 @@
 /// <reference types="node" />
 
 import { Blob as Blob_2 } from 'buffer';
-import { BlobOptions } from 'buffer';
 import Dispatcher = require('./dispatcher');
 import { ReadableStream } from 'stream/web';
 import { URL as URL_2 } from 'url';
 import { URLSearchParams as URLSearchParams_2 } from 'url';
 
+declare interface BlobPropertyBag {
+    type?: string
+    endings?: 'native' | 'transparent'
+}
+
 declare type BodyInit =
 | ArrayBuffer
 | AsyncIterable<Uint8Array>
@@ -87,7 +91,7 @@ declare class File extends Blob_2 {
      * @param fileName The name of the file.
      * @param options An options object containing optional attributes for the file.
      */
-    constructor(fileBits: ReadonlyArray<string | NodeJS.ArrayBufferView | Blob_2>, fileName: string, options?: FileOptions)
+    constructor(fileBits: ReadonlyArray<string | NodeJS.ArrayBufferView | Blob_2>, fileName: string, options?: FilePropertyBag)
 
     /**
      * Name of the file referenced by the File object.
@@ -102,7 +106,7 @@ declare class File extends Blob_2 {
     readonly [Symbol.toStringTag]: string
 }
 
-declare interface FileOptions extends BlobOptions {
+declare interface FilePropertyBag extends BlobPropertyBag {
     /**
      * The last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). Files without a known last modified date return the current date.
      */