wrangler 2.0.18 → 2.0.22

package/src/config/validation.ts

@@ -94,6 +94,14 @@ export function normalizeAndValidateConfig(
 		"boolean"
 	);
 
+	validateOptionalProperty(
+		diagnostics,
+		"",
+		"send_metrics",
+		rawConfig.send_metrics,
+		"boolean"
+	);
+
 	// TODO: set the default to false to turn on service environments as the default
 	const isLegacyEnv =
 		(args as { "legacy-env": boolean | undefined })["legacy-env"] ??
@@ -173,6 +181,7 @@ export function normalizeAndValidateConfig(
 	const config: Config = {
 		configPath,
 		legacy_env: isLegacyEnv,
+		send_metrics: rawConfig.send_metrics,
 		...activeEnv,
 		dev: normalizeAndValidateDev(diagnostics, rawConfig.dev ?? {}),
 		migrations: normalizeAndValidateMigrations(

package/src/config-cache.ts

@@ -6,7 +6,7 @@ import { logger } from "./logger";
 
 let cacheMessageShown = false;
 
-let __cacheFolder: string | null;
+let __cacheFolder: string | null | undefined;
 function getCacheFolder() {
 	if (__cacheFolder || __cacheFolder === null) return __cacheFolder;
 
@@ -80,4 +80,5 @@ export function purgeConfigCaches() {
 	if (cacheFolder) {
 		rmSync(cacheFolder, { recursive: true, force: true });
 	}
+	__cacheFolder = undefined;
 }

package/src/dev/dev.tsx

@@ -55,7 +55,7 @@ export type DevProps = {
 	zone: string | undefined;
 	host: string | undefined;
 	routes: Route[] | undefined;
-	inspect: boolean | undefined;
+	inspect: boolean;
 	logLevel: "none" | "error" | "log" | "warn" | "debug" | undefined;
 	onReady: (() => void) | undefined;
 	showInteractiveDevSession: boolean | undefined;
@@ -101,16 +101,17 @@ export function DevImplementation(props: DevProps): JSX.Element {
 }
 
 function InteractiveDevSession(props: DevProps) {
-	const toggles = useHotkeys(
-		{
+	const toggles = useHotkeys({
+		initial: {
 			local: props.initialMode === "local",
 			tunnel: false,
 		},
-		props.port,
-		props.ip,
-		props.inspectorPort,
-		props.localProtocol
-	);
+		port: props.port,
+		ip: props.ip,
+		inspectorPort: props.inspectorPort,
+		inspect: props.inspect,
+		localProtocol: props.localProtocol,
+	});
 
 	useTunnel(toggles.tunnel);
 
@@ -120,8 +121,12 @@ function InteractiveDevSession(props: DevProps) {
 			<Box borderStyle="round" paddingLeft={1} paddingRight={1}>
 				<Text bold={true}>[b]</Text>
 				<Text> open a browser, </Text>
-				<Text bold={true}>[d]</Text>
-				<Text> open Devtools, </Text>
+				{props.inspect ? (
+					<>
+						<Text bold={true}>[d]</Text>
+						<Text> open Devtools, </Text>
+					</>
+				) : null}
 				<Text bold={true}>[l]</Text>
 				<Text> {toggles.local ? "turn off" : "turn on"} local mode, </Text>
 				<Text bold={true}>[c]</Text>
@@ -193,6 +198,7 @@ function DevSession(props: DevSessionProps) {
 			ip={props.ip}
 			localProtocol={props.localProtocol}
 			inspectorPort={props.inspectorPort}
+			inspect={props.inspect}
 			compatibilityDate={props.compatibilityDate}
 			compatibilityFlags={props.compatibilityFlags}
 			usageModel={props.usageModel}
@@ -346,13 +352,15 @@ type useHotkeysInitialState = {
 	local: boolean;
 	tunnel: boolean;
 };
-function useHotkeys(
-	initial: useHotkeysInitialState,
-	port: number,
-	ip: string,
-	inspectorPort: number,
-	localProtocol: "http" | "https"
-) {
+function useHotkeys(props: {
+	initial: useHotkeysInitialState;
+	port: number;
+	ip: string;
+	inspectorPort: number;
+	inspect: boolean;
+	localProtocol: "http" | "https";
+}) {
+	const { initial, port, ip, inspectorPort, inspect, localProtocol } = props;
 	// UGH, we should put port in context instead
 	const [toggles, setToggles] = useState(initial);
 	const { exit } = useApp();
@@ -377,7 +385,9 @@ function useHotkeys(
 				}
 				// toggle inspector
 				case "d": {
-					await openInspector(inspectorPort);
+					if (inspect) {
+						await openInspector(inspectorPort);
+					}
 					break;
 				}
 				// toggle local

package/src/dev/local.tsx

@@ -31,7 +31,7 @@ interface LocalProps {
 	crons: Config["triggers"]["crons"];
 	localProtocol: "http" | "https";
 	localUpstream: string | undefined;
-	inspect: boolean | undefined;
+	inspect: boolean;
 	onReady: (() => void) | undefined;
 	logLevel: "none" | "error" | "log" | "warn" | "debug" | undefined;
 }
@@ -195,9 +195,10 @@ function useLocalWorker({
 				),
 				...(localPersistencePath
 					? {
-							kvPersist: path.join(localPersistencePath, "kv"),
-							durableObjectsPersist: path.join(localPersistencePath, "do"),
 							cachePersist: path.join(localPersistencePath, "cache"),
+							durableObjectsPersist: path.join(localPersistencePath, "do"),
+							kvPersist: path.join(localPersistencePath, "kv"),
+							r2Persist: path.join(localPersistencePath, "r2"),
 					  }
 					: {
 							// We mark these as true, so that they'll
@@ -205,9 +206,10 @@ function useLocalWorker({
 							// This means they'll persist across a dev session,
 							// even if we change source and reload,
 							// and be deleted when the dev session ends
-							durableObjectsPersist: true,
 							cachePersist: true,
+							durableObjectsPersist: true,
 							kvPersist: true,
+							r2Persist: true,
 					  }),
 
 				sitePath: assetPaths?.assetDirectory
@@ -254,6 +256,7 @@ function useLocalWorker({
 				{
 					cwd: path.dirname(scriptPath),
 					execArgv: nodeOptions,
+					stdio: "pipe",
 				}
 			));
 			child.on("message", (message) => {

package/src/dev/remote.tsx

@@ -42,6 +42,7 @@ export function Remote(props: {
 	port: number;
 	ip: string;
 	localProtocol: "https" | "http";
+	inspect: boolean;
 	inspectorPort: number;
 	accountId: string | undefined;
 	bindings: CfWorkerInit["bindings"];
@@ -91,7 +92,10 @@ export function Remote(props: {
 	});
 
 	useInspector({
-		inspectorUrl: previewToken ? previewToken.inspectorUrl.href : undefined,
+		inspectorUrl:
+			props.inspect && previewToken
+				? previewToken.inspectorUrl.href
+				: undefined,
 		port: props.inspectorPort,
 		logToTerminal: true,
 	});

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);
+		await metrics.sendMetricsEvent(
+			"run dev",
+			{ local: args.local },
+			{ sendMetrics: config.send_metrics, offline: args.local }
+		);
 
 		if (config.configPath) {
 			watcher = watch(config.configPath, {
@@ -500,7 +506,7 @@ export async function startDev(args: ArgumentsCamelCase<DevArgs>) {
 					crons={config.triggers.crons}
 					logLevel={args.logLevel}
 					onReady={args.onReady}
-					inspect={args.inspect}
+					inspect={args.inspect ?? true}
 					showInteractiveDevSession={args.showInteractiveDevSession}
 				/>
 			);

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,
@@ -500,6 +501,9 @@ function createCLIParser(argv: string[]) {
 				(args.config as ConfigPath) ||
 				(args.script && findWranglerToml(path.dirname(args.script)));
 			const config = readConfig(configPath, args);
+			await metrics.sendMetricsEvent("deploy worker script", {
+				sendMetrics: config.send_metrics,
+			});
 			const entry = await getEntry(args, config, "publish");
 
 			if (args.public) {
@@ -640,6 +644,9 @@ function createCLIParser(argv: string[]) {
 				await printWranglerBanner();
 			}
 			const config = readConfig(args.config as ConfigPath, args);
+			await metrics.sendMetricsEvent("begin log stream", {
+				sendMetrics: config.send_metrics,
+			});
 
 			const scriptName = getLegacyScriptName(args, config);
 
@@ -685,6 +692,9 @@ function createCLIParser(argv: string[]) {
 			onExit(async () => {
 				tail.terminate();
 				await deleteTail();
+				await metrics.sendMetricsEvent("end log stream", {
+					sendMetrics: config.send_metrics,
+				});
 			});
 
 			const printLog: (data: RawData) => void =
@@ -701,6 +711,9 @@ function createCLIParser(argv: string[]) {
 						await setTimeout(100);
 						break;
 					case tail.CLOSED:
+						await metrics.sendMetricsEvent("end log stream", {
+							sendMetrics: config.send_metrics,
+						});
 						throw new Error(
 							`Connection to ${scriptDisplayName} closed unexpectedly.`
 						);
@@ -714,6 +727,9 @@ function createCLIParser(argv: string[]) {
 			tail.on("close", async () => {
 				tail.terminate();
 				await deleteTail();
+				await metrics.sendMetricsEvent("end log stream", {
+					sendMetrics: config.send_metrics,
+				});
 			});
 		}
 	);
@@ -944,6 +960,9 @@ function createCLIParser(argv: string[]) {
 
 						try {
 							await submitSecret();
+							await metrics.sendMetricsEvent("create encrypted variable", {
+								sendMetrics: config.send_metrics,
+							});
 						} catch (e) {
 							if (isMissingWorkerError(e)) {
 								// create a draft worker and try again
@@ -1016,6 +1035,9 @@ function createCLIParser(argv: string[]) {
 									: `/accounts/${accountId}/workers/services/${scriptName}/environments/${args.env}/secrets`;
 
 							await fetchResult(`${url}/${args.key}`, { method: "DELETE" });
+							await metrics.sendMetricsEvent("delete encrypted variable", {
+								sendMetrics: config.send_metrics,
+							});
 							logger.log(`✨ Success! Deleted secret ${args.key}`);
 						}
 					}
@@ -1056,6 +1078,9 @@ function createCLIParser(argv: string[]) {
 								: `/accounts/${accountId}/workers/services/${scriptName}/environments/${args.env}/secrets`;
 
 						logger.log(JSON.stringify(await fetchResult(url), null, "  "));
+						await metrics.sendMetricsEvent("list encrypted variables", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				);
 		}
@@ -1117,6 +1142,9 @@ function createCLIParser(argv: string[]) {
 
 						logger.log(`🌀 Creating namespace with title "${title}"`);
 						const namespaceId = await createKVNamespace(accountId, title);
+						await metrics.sendMetricsEvent("create kv namespace", {
+							sendMetrics: config.send_metrics,
+						});
 
 						logger.log("✨ Success!");
 						const envString = args.env ? ` under [env.${args.env}]` : "";
@@ -1145,6 +1173,9 @@ function createCLIParser(argv: string[]) {
 						logger.log(
 							JSON.stringify(await listKVNamespaces(accountId), null, "  ")
 						);
+						await metrics.sendMetricsEvent("list kv namespaces", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				)
 				.command(
@@ -1190,6 +1221,9 @@ function createCLIParser(argv: string[]) {
 						const accountId = await requireAuth(config);
 
 						await deleteKVNamespace(accountId, id);
+						await metrics.sendMetricsEvent("delete kv namespace", {
+							sendMetrics: config.send_metrics,
+						});
 
 						// TODO: recommend they remove it from wrangler.toml
 
@@ -1313,6 +1347,9 @@ function createCLIParser(argv: string[]) {
 							expiration_ttl: ttl,
 							metadata: metadata as KeyValue["metadata"],
 						});
+						await metrics.sendMetricsEvent("write kv key-value", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				)
 				.command(
@@ -1362,6 +1399,9 @@ function createCLIParser(argv: string[]) {
 							prefix
 						);
 						logger.log(JSON.stringify(results, undefined, 2));
+						await metrics.sendMetricsEvent("list kv keys", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				)
 				.command(
@@ -1422,6 +1462,9 @@ function createCLIParser(argv: string[]) {
 						} else {
 							process.stdout.write(bufferKVValue);
 						}
+						await metrics.sendMetricsEvent("read kv value", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				)
 				.command(
@@ -1468,6 +1511,9 @@ function createCLIParser(argv: string[]) {
 						const accountId = await requireAuth(config);
 
 						await deleteKVKeyValue(accountId, namespaceId, key);
+						await metrics.sendMetricsEvent("delete kv key-value", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				);
 		}
@@ -1572,6 +1618,9 @@ function createCLIParser(argv: string[]) {
 
 						const accountId = await requireAuth(config);
 						await putKVBulkKeyValue(accountId, namespaceId, content);
+						await metrics.sendMetricsEvent("write kv key-values (bulk)", {
+							sendMetrics: config.send_metrics,
+						});
 
 						logger.log("Success!");
 					}
@@ -1662,6 +1711,9 @@ function createCLIParser(argv: string[]) {
 						const accountId = await requireAuth(config);
 
 						await deleteKVBulkKeyValue(accountId, namespaceId, content);
+						await metrics.sendMetricsEvent("delete kv key-values (bulk)", {
+							sendMetrics: config.send_metrics,
+						});
 
 						logger.log("Success!");
 					}
@@ -1701,6 +1753,9 @@ function createCLIParser(argv: string[]) {
 						logger.log(`Creating bucket ${args.name}.`);
 						await createR2Bucket(accountId, args.name);
 						logger.log(`Created bucket ${args.name}.`);
+						await metrics.sendMetricsEvent("create r2 bucket", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				);
 
@@ -1710,6 +1765,9 @@ function createCLIParser(argv: string[]) {
 					const accountId = await requireAuth(config);
 
 					logger.log(JSON.stringify(await listR2Buckets(accountId), null, 2));
+					await metrics.sendMetricsEvent("list r2 buckets", {
+						sendMetrics: config.send_metrics,
+					});
 				});
 
 				r2BucketYargs.command(
@@ -1732,6 +1790,9 @@ function createCLIParser(argv: string[]) {
 						logger.log(`Deleting bucket ${args.name}.`);
 						await deleteR2Bucket(accountId, args.name);
 						logger.log(`Deleted bucket ${args.name}.`);
+						await metrics.sendMetricsEvent("delete r2 bucket", {
+							sendMetrics: config.send_metrics,
+						});
 					}
 				);
 				return r2BucketYargs;
@@ -1800,6 +1861,10 @@ function createCLIParser(argv: string[]) {
 				return;
 			}
 			await login();
+			const config = readConfig(args.config as ConfigPath, args);
+			await metrics.sendMetricsEvent("login user", {
+				sendMetrics: config.send_metrics,
+			});
 
 			// TODO: would be nice if it optionally saved login
 			// credentials inside node_modules/.cache or something
@@ -1816,6 +1881,10 @@ function createCLIParser(argv: string[]) {
 		async () => {
 			await printWranglerBanner();
 			await logout();
+			const config = readConfig(undefined, {});
+			await metrics.sendMetricsEvent("logout user", {
+				sendMetrics: config.send_metrics,
+			});
 		}
 	);
 
@@ -1827,6 +1896,10 @@ function createCLIParser(argv: string[]) {
 		async () => {
 			await printWranglerBanner();
 			await whoami();
+			const config = readConfig(undefined, {});
+			await metrics.sendMetricsEvent("view accounts", {
+				sendMetrics: config.send_metrics,
+			});
 		}
 	);
 

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";

package/src/metrics/is-ci.ts

@@ -0,0 +1,14 @@
+import isCI from "is-ci";
+
+/**
+ * Use this object to find out if we are currently running in a continuous integration environment.
+ *
+ * The isCI constant imported above cannot be easily mocked for testing.
+ * By wrapping this up in a method on an object, it results in clean and testable code.
+ */
+export const CI = {
+	/** Is Wrangler currently running in a CI? */
+	isCI() {
+		return isCI;
+	},
+};