wrangler 2.0.16 → 2.0.19

package/src/dev.tsx

@@ -10,6 +10,7 @@ import { getVarsForDev } from "./dev/dev-vars";
 
 import { getEntry } from "./entry";
 import { logger } from "./logger";
+import * as metrics from "./metrics";
 import { getAssetPaths, getSiteAssetPaths } from "./sites";
 import { getAccountFromCache } from "./user";
 import { getZoneIdFromHost, getZoneForRoute, getHostFromRoute } from "./zones";
@@ -264,6 +265,11 @@ export async function startDev(args: ArgumentsCamelCase<DevArgs>) {
 			((args.script &&
 				findWranglerToml(path.dirname(args.script))) as ConfigPath);
 		let config = readConfig(configPath, args);
+		metrics.sendMetricsEvent(
+			"run dev",
+			{ local: args.local },
+			{ sendMetrics: config.send_metrics, offline: args.local }
+		);
 
 		if (config.configPath) {
 			watcher = watch(config.configPath, {

package/src/entry.ts

@@ -39,7 +39,7 @@ export async function getEntry(
 				? path.resolve(config.site?.["entry-point"])
 				: // site.entry-point could be a directory
 				  path.resolve(config.site?.["entry-point"], "index.js");
-		} else if (args.assets) {
+		} else if (args.assets || config.assets) {
 			file = path.resolve(__dirname, "../templates/no-op-worker.js");
 		} else {
 			throw new Error(

package/src/global-wrangler-config-path.ts

@@ -0,0 +1,26 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+import xdgAppPaths from "xdg-app-paths";
+
+function isDirectory(configPath: string) {
+	try {
+		return fs.statSync(configPath).isDirectory();
+	} catch (error) {
+		// ignore error
+		return false;
+	}
+}
+
+export function getGlobalWranglerConfigPath() {
+	//TODO: We should implement a custom path --global-config and/or the WRANGLER_HOME type environment variable
+	const configDir = xdgAppPaths(".wrangler").config(); // New XDG compliant config path
+	const legacyConfigDir = path.join(os.homedir(), ".wrangler"); // Legacy config in user's home directory
+
+	// Check for the .wrangler directory in root if it is not there then use the XDG compliant path.
+	if (isDirectory(legacyConfigDir)) {
+		return legacyConfigDir;
+	} else {
+		return configDir;
+	}
+}

package/src/https-options.ts

@@ -1,7 +1,8 @@
 import * as fs from "node:fs";
-import { homedir, networkInterfaces } from "node:os";
+import os from "node:os";
 import * as path from "node:path";
 import { promisify } from "node:util";
+import { getGlobalWranglerConfigPath } from "./global-wrangler-config-path";
 import { logger } from "./logger";
 import type { Attributes, Options } from "selfsigned";
 
@@ -17,7 +18,7 @@ const ONE_DAY_IN_MS = 86400000;
  * The certificates are self-signed and generated locally, and cached in the `CERT_ROOT` directory.
  */
 export async function getHttpsOptions() {
-	const certDirectory = path.join(homedir(), ".wrangler/local-cert");
+	const certDirectory = path.join(getGlobalWranglerConfigPath(), "local-cert");
 	const keyPath = path.join(certDirectory, "key.pem");
 	const certPath = path.join(certDirectory, "cert.pem");
 
@@ -37,7 +38,10 @@ export async function getHttpsOptions() {
 		} catch (e) {
 			const message = e instanceof Error ? e.message : `${e}`;
 			logger.warn(
-				`Unable to cache generated self-signed certificate in ${certDirectory}.\n${message}`
+				`Unable to cache generated self-signed certificate in ${path.relative(
+					process.cwd(),
+					certDirectory
+				)}.\n${message}`
 			);
 		}
 		return { key, cert };
@@ -114,7 +118,7 @@ async function generateCertificate() {
  */
 function getAccessibleHosts(ipv4 = false): string[] {
 	const hosts: string[] = [];
-	Object.values(networkInterfaces()).forEach((net) =>
+	Object.values(os.networkInterfaces()).forEach((net) =>
 		net?.forEach(({ family, address }) => {
 			if (!ipv4 || family === "IPv4") hosts.push(address);
 		})

package/src/index.tsx

@@ -33,6 +33,7 @@ import {
 	deleteKVKeyValue,
 } from "./kv";
 import { logger } from "./logger";
+import * as metrics from "./metrics";
 import { pages } from "./pages";
 import {
 	formatMessage,
@@ -64,6 +65,7 @@ import { whoami } from "./whoami";
 
 import { workerNamespaceCommands } from "./worker-namespace";
 import type { Config } from "./config";
+import type { KeyValue } from "./kv";
 import type { TailCLIFilters } from "./tail";
 import type { RawData } from "ws";
 import type { CommandModule } from "yargs";
@@ -382,7 +384,7 @@ function createCLIParser(argv: string[]) {
 						hidden: true,
 					})
 					.option("no-bundle", {
-						describe: "Skip internal build steps and directly publish script",
+						describe: "Skip internal build steps and directly publish Worker",
 						type: "boolean",
 						default: false,
 					})
@@ -474,7 +476,7 @@ function createCLIParser(argv: string[]) {
 						requiresArg: true,
 					})
 					.option("minify", {
-						describe: "Minify the script",
+						describe: "Minify the Worker",
 						type: "boolean",
 					})
 					.option("node-compat", {
@@ -499,6 +501,9 @@ function createCLIParser(argv: string[]) {
 				(args.config as ConfigPath) ||
 				(args.script && findWranglerToml(path.dirname(args.script)));
 			const config = readConfig(configPath, args);
+			metrics.sendMetricsEvent("deploy worker script", {
+				sendMetrics: config.send_metrics,
+			});
 			const entry = await getEntry(args, config, "publish");
 
 			if (args.public) {
@@ -639,11 +644,16 @@ function createCLIParser(argv: string[]) {
 				await printWranglerBanner();
 			}
 			const config = readConfig(args.config as ConfigPath, args);
+			metrics.sendMetricsEvent("begin log stream", {
+				sendMetrics: config.send_metrics,
+			});
 
 			const scriptName = getLegacyScriptName(args, config);
 
 			if (!scriptName) {
-				throw new Error("Missing script name");
+				throw new Error(
+					"Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with `wrangler tail <worker-name>`"
+				);
 			}
 
 			const accountId = await requireAuth(config);
@@ -682,6 +692,9 @@ function createCLIParser(argv: string[]) {
 			onExit(async () => {
 				tail.terminate();
 				await deleteTail();
+				metrics.sendMetricsEvent("end log stream", {
+					sendMetrics: config.send_metrics,
+				});
 			});
 
 			const printLog: (data: RawData) => void =
@@ -698,6 +711,9 @@ function createCLIParser(argv: string[]) {
 						await setTimeout(100);
 						break;
 					case tail.CLOSED:
+						metrics.sendMetricsEvent("end log stream", {
+							sendMetrics: config.send_metrics,
+						});
 						throw new Error(
 							`Connection to ${scriptDisplayName} closed unexpectedly.`
 						);
@@ -711,6 +727,9 @@ function createCLIParser(argv: string[]) {
 			tail.on("close", async () => {
 				tail.terminate();
 				await deleteTail();
+				metrics.sendMetricsEvent("end log stream", {
+					sendMetrics: config.send_metrics,
+				});
 			});
 		}
 	);
@@ -820,7 +839,7 @@ function createCLIParser(argv: string[]) {
 	// secret
 	wrangler.command(
 		"secret",
-		"🤫 Generate a secret that can be referenced in the worker script",
+		"🤫 Generate a secret that can be referenced in a Worker",
 		(secretYargs) => {
 			return secretYargs
 				.command(subHelp)
@@ -831,15 +850,15 @@ function createCLIParser(argv: string[]) {
 				})
 				.command(
 					"put <key>",
-					"Create or update a secret variable for a script",
+					"Create or update a secret variable for a Worker",
 					(yargs) => {
 						return yargs
 							.positional("key", {
-								describe: "The variable name to be accessible in the script",
+								describe: "The variable name to be accessible in the Worker",
 								type: "string",
 							})
 							.option("name", {
-								describe: "Name of the worker",
+								describe: "Name of the Worker",
 								type: "string",
 								requiresArg: true,
 							})
@@ -857,7 +876,9 @@ function createCLIParser(argv: string[]) {
 
 						const scriptName = getLegacyScriptName(args, config);
 						if (!scriptName) {
-							throw new Error("Missing script name");
+							throw new Error(
+								"Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with `--name <worker-name>`"
+							);
 						}
 
 						const accountId = await requireAuth(config);
@@ -870,7 +891,7 @@ function createCLIParser(argv: string[]) {
 						);
 
 						logger.log(
-							`🌀 Creating the secret for script ${scriptName} ${
+							`🌀 Creating the secret for the Worker "${scriptName}" ${
 								args.env && !isLegacyEnv(config) ? `(${args.env})` : ""
 							}`
 						);
@@ -939,6 +960,9 @@ function createCLIParser(argv: string[]) {
 
 						try {
 							await submitSecret();
+							metrics.sendMetricsEvent("create encrypted variable", {
+								sendMetrics: config.send_metrics,
+							});
 						} catch (e) {
 							if (isMissingWorkerError(e)) {
 								// create a draft worker and try again
@@ -955,16 +979,16 @@ function createCLIParser(argv: string[]) {
 				)
 				.command(
 					"delete <key>",
-					"Delete a secret variable from a script",
+					"Delete a secret variable from a Worker",
 					async (yargs) => {
 						await printWranglerBanner();
 						return yargs
 							.positional("key", {
-								describe: "The variable name to be accessible in the script",
+								describe: "The variable name to be accessible in the Worker",
 								type: "string",
 							})
 							.option("name", {
-								describe: "Name of the worker",
+								describe: "Name of the Worker",
 								type: "string",
 								requiresArg: true,
 							})
@@ -981,22 +1005,26 @@ function createCLIParser(argv: string[]) {
 
 						const scriptName = getLegacyScriptName(args, config);
 						if (!scriptName) {
-							throw new Error("Missing script name");
+							throw new Error(
+								"Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with `--name <worker-name>`"
+							);
 						}
 
 						const accountId = await requireAuth(config);
 
 						if (
 							await confirm(
-								`Are you sure you want to permanently delete the variable ${
+								`Are you sure you want to permanently delete the secret ${
 									args.key
-								} on the script ${scriptName}${
+								} on the Worker ${scriptName}${
 									args.env && !isLegacyEnv(config) ? ` (${args.env})` : ""
 								}?`
 							)
 						) {
 							logger.log(
-								`🌀 Deleting the secret ${args.key} on script ${scriptName}${
+								`🌀 Deleting the secret ${
+									args.key
+								} on the Worker ${scriptName}${
 									args.env && !isLegacyEnv(config) ? ` (${args.env})` : ""
 								}`
 							);
@@ -1007,17 +1035,20 @@ function createCLIParser(argv: string[]) {
 									: `/accounts/${accountId}/workers/services/${scriptName}/environments/${args.env}/secrets`;
 
 							await fetchResult(`${url}/${args.key}`, { method: "DELETE" });
+							metrics.sendMetricsEvent("delete encrypted variable", {
+								sendMetrics: config.send_metrics,
+							});
 							logger.log(`✨ Success! Deleted secret ${args.key}`);
 						}
 					}
 				)
 				.command(
 					"list",
-					"List all secrets for a script",
+					"List all secrets for a Worker",
 					(yargs) => {
 						return yargs
 							.option("name", {
-								describe: "Name of the worker",
+								describe: "Name of the Worker",
 								type: "string",
 								requiresArg: true,
 							})
@@ -1034,7 +1065,9 @@ function createCLIParser(argv: string[]) {
 
 						const scriptName = getLegacyScriptName(args, config);
 						if (!scriptName) {
-							throw new Error("Missing script name");
+							throw new Error(
+								"Required Worker name missing. Please specify the Worker name in wrangler.toml, or pass it as an argument with `--name <worker-name>`"
+							);
 						}
 
 						const accountId = await requireAuth(config);
@@ -1045,6 +1078,9 @@ function createCLIParser(argv: string[]) {
 								: `/accounts/${accountId}/workers/services/${scriptName}/environments/${args.env}/secrets`;
 
 						logger.log(JSON.stringify(await fetchResult(url), null, "  "));
+						metrics.sendMetricsEvent("list encrypted variables", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				);
 		}
@@ -1106,6 +1142,9 @@ function createCLIParser(argv: string[]) {
 
 						logger.log(`🌀 Creating namespace with title "${title}"`);
 						const namespaceId = await createKVNamespace(accountId, title);
+						metrics.sendMetricsEvent("create kv namespace", {
+							sendMetrics: config.send_metrics,
+						});
 
 						logger.log("✨ Success!");
 						const envString = args.env ? ` under [env.${args.env}]` : "";
@@ -1134,6 +1173,9 @@ function createCLIParser(argv: string[]) {
 						logger.log(
 							JSON.stringify(await listKVNamespaces(accountId), null, "  ")
 						);
+						metrics.sendMetricsEvent("list kv namespaces", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				)
 				.command(
@@ -1179,6 +1221,9 @@ function createCLIParser(argv: string[]) {
 						const accountId = await requireAuth(config);
 
 						await deleteKVNamespace(accountId, id);
+						metrics.sendMetricsEvent("delete kv namespace", {
+							sendMetrics: config.send_metrics,
+						});
 
 						// TODO: recommend they remove it from wrangler.toml
 
@@ -1253,6 +1298,15 @@ function createCLIParser(argv: string[]) {
 								describe:
 									"Time since the UNIX epoch after which the entry expires",
 							})
+							.option("metadata", {
+								type: "string",
+								describe: "Arbitrary JSON that is associated with a key",
+								coerce: (jsonStr: string): KeyValue["metadata"] => {
+									try {
+										return JSON.parse(jsonStr);
+									} catch (_) {}
+								},
+							})
 							.option("path", {
 								type: "string",
 								requiresArg: true,
@@ -1260,7 +1314,7 @@ function createCLIParser(argv: string[]) {
 							})
 							.check(demandOneOfOption("value", "path"));
 					},
-					async ({ key, ttl, expiration, ...args }) => {
+					async ({ key, ttl, expiration, metadata, ...args }) => {
 						await printWranglerBanner();
 						const config = readConfig(args.config as ConfigPath, args);
 						const namespaceId = getKVNamespaceId(args, config);
@@ -1270,13 +1324,17 @@ function createCLIParser(argv: string[]) {
 							: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 							  args.value!;
 
+						const metadataLog = metadata
+							? ` with metadata "${JSON.stringify(metadata)}"`
+							: "";
+
 						if (args.path) {
 							logger.log(
-								`Writing the contents of ${args.path} to the key "${key}" on namespace ${namespaceId}.`
+								`Writing the contents of ${args.path} to the key "${key}" on namespace ${namespaceId}${metadataLog}.`
 							);
 						} else {
 							logger.log(
-								`Writing the value "${value}" to key "${key}" on namespace ${namespaceId}.`
+								`Writing the value "${value}" to key "${key}" on namespace ${namespaceId}${metadataLog}.`
 							);
 						}
 
@@ -1287,6 +1345,10 @@ function createCLIParser(argv: string[]) {
 							value,
 							expiration,
 							expiration_ttl: ttl,
+							metadata: metadata as KeyValue["metadata"],
+						});
+						metrics.sendMetricsEvent("write kv key-value", {
+							sendMetrics: config.send_metrics,
 						});
 					}
 				)
@@ -1337,6 +1399,9 @@ function createCLIParser(argv: string[]) {
 							prefix
 						);
 						logger.log(JSON.stringify(results, undefined, 2));
+						metrics.sendMetricsEvent("list kv keys", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				)
 				.command(
@@ -1397,6 +1462,9 @@ function createCLIParser(argv: string[]) {
 						} else {
 							process.stdout.write(bufferKVValue);
 						}
+						metrics.sendMetricsEvent("read kv value", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				)
 				.command(
@@ -1443,6 +1511,9 @@ function createCLIParser(argv: string[]) {
 						const accountId = await requireAuth(config);
 
 						await deleteKVKeyValue(accountId, namespaceId, key);
+						metrics.sendMetricsEvent("delete kv key-value", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				);
 		}
@@ -1547,6 +1618,9 @@ function createCLIParser(argv: string[]) {
 
 						const accountId = await requireAuth(config);
 						await putKVBulkKeyValue(accountId, namespaceId, content);
+						metrics.sendMetricsEvent("write kv key-values (bulk)", {
+							sendMetrics: config.send_metrics,
+						});
 
 						logger.log("Success!");
 					}
@@ -1637,6 +1711,9 @@ function createCLIParser(argv: string[]) {
 						const accountId = await requireAuth(config);
 
 						await deleteKVBulkKeyValue(accountId, namespaceId, content);
+						metrics.sendMetricsEvent("delete kv key-values (bulk)", {
+							sendMetrics: config.send_metrics,
+						});
 
 						logger.log("Success!");
 					}
@@ -1676,6 +1753,9 @@ function createCLIParser(argv: string[]) {
 						logger.log(`Creating bucket ${args.name}.`);
 						await createR2Bucket(accountId, args.name);
 						logger.log(`Created bucket ${args.name}.`);
+						metrics.sendMetricsEvent("create r2 bucket", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				);
 
@@ -1685,6 +1765,9 @@ function createCLIParser(argv: string[]) {
 					const accountId = await requireAuth(config);
 
 					logger.log(JSON.stringify(await listR2Buckets(accountId), null, 2));
+					metrics.sendMetricsEvent("list r2 buckets", {
+						sendMetrics: config.send_metrics,
+					});
 				});
 
 				r2BucketYargs.command(
@@ -1707,6 +1790,9 @@ function createCLIParser(argv: string[]) {
 						logger.log(`Deleting bucket ${args.name}.`);
 						await deleteR2Bucket(accountId, args.name);
 						logger.log(`Deleted bucket ${args.name}.`);
+						metrics.sendMetricsEvent("delete r2 bucket", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				);
 				return r2BucketYargs;
@@ -1775,6 +1861,10 @@ function createCLIParser(argv: string[]) {
 				return;
 			}
 			await login();
+			const config = readConfig(args.config as ConfigPath, args);
+			metrics.sendMetricsEvent("login user", {
+				sendMetrics: config.send_metrics,
+			});
 
 			// TODO: would be nice if it optionally saved login
 			// credentials inside node_modules/.cache or something
@@ -1791,6 +1881,10 @@ function createCLIParser(argv: string[]) {
 		async () => {
 			await printWranglerBanner();
 			await logout();
+			const config = readConfig(undefined, {});
+			metrics.sendMetricsEvent("logout user", {
+				sendMetrics: config.send_metrics,
+			});
 		}
 	);
 
@@ -1802,6 +1896,10 @@ function createCLIParser(argv: string[]) {
 		async () => {
 			await printWranglerBanner();
 			await whoami();
+			const config = readConfig(undefined, {});
+			metrics.sendMetricsEvent("view accounts", {
+				sendMetrics: config.send_metrics,
+			});
 		}
 	);
 

package/src/kv.ts

@@ -1,4 +1,5 @@
 import { URLSearchParams } from "node:url";
+import { FormData } from "undici";
 import { fetchListResult, fetchResult, fetchKVGetValue } from "./cfetch";
 import { logger } from "./logger";
 import type { Config } from "./config";
@@ -186,6 +187,19 @@ export function unexpectedKVKeyValueProps(keyValue: KeyValue): string[] {
 	return props.filter((prop) => !KeyValueKeys.has(prop));
 }
 
+/**
+ * Turn object with fields into FormData
+ */
+function asFormData(fields: Record<string, unknown>): FormData {
+	const formData = new FormData();
+
+	for (const [name, value] of Object.entries(fields)) {
+		formData.append(name, value);
+	}
+
+	return formData;
+}
+
 export async function putKVKeyValue(
 	accountId: string,
 	namespaceId: string,
@@ -205,7 +219,15 @@ export async function putKVKeyValue(
 		`/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
 			keyValue.key
 		)}`,
-		{ method: "PUT", body: keyValue.value },
+		{
+			method: "PUT",
+			body: keyValue.metadata
+				? asFormData({
+						value: keyValue.value,
+						metadata: JSON.stringify(keyValue.metadata),
+				  })
+				: keyValue.value,
+		},
 		searchParams
 	);
 }

package/src/metrics/index.ts

@@ -0,0 +1,4 @@
+export { getMetricsDispatcher } from "./metrics-dispatcher";
+export type { Properties } from "./metrics-dispatcher";
+export { getMetricsConfig } from "./metrics-config";
+export * from "./send-event";