feat: add wrangler metrics as an alias for wrangler telemetry (#7284)

* add metrics alias

* tests

* use each to test alias

Author: emily-shen

packages/wrangler/src/__tests__/metrics.test.ts

@@ -393,49 +393,33 @@ describe("metrics", () => {
 		});
 	});
 
-	describe("telemetry commands", () => {
+	describe.each(["metrics", "telemetry"])("%s commands", (cmd) => {
 		beforeEach(() => {
 			vi.useFakeTimers();
 			vi.setSystemTime(new Date(2024, 11, 12));
 		});
 		afterEach(() => {
 			vi.useRealTimers();
 		});
-		describe("wrangler telemetry status", () => {
+		describe(`${cmd} status`, () => {
 			it("prints the current telemetry status based on the cached metrics config", async () => {
 				writeMetricsConfig({
 					permission: {
 						enabled: true,
 						date: new Date(2022, 6, 4),
 					},
 				});
-				await runWrangler("telemetry status");
-				expect(std.out).toMatchInlineSnapshot(`
-					"Status: Enabled
-
-					To configure telemetry globally on this machine, you can run \`wrangler telemetry disable / enable\`.
-					You can override this for individual projects with the environment variable \`WRANGLER_SEND_METRICS=true/false\`.
-					"
-				`);
+				await runWrangler(`${cmd} status`);
+				expect(std.out).toContain("Status: Enabled");
+				expect(std.out).not.toContain("Status: Disabled");
 				writeMetricsConfig({
 					permission: {
 						enabled: false,
 						date: new Date(2022, 6, 4),
 					},
 				});
 				await runWrangler("telemetry status");
-				expect(std.out).toMatchInlineSnapshot(`
-					"Status: Enabled
-
-					To configure telemetry globally on this machine, you can run \`wrangler telemetry disable / enable\`.
-					You can override this for individual projects with the environment variable \`WRANGLER_SEND_METRICS=true/false\`.
-
-					Status: Disabled
-
-					To configure telemetry globally on this machine, you can run \`wrangler telemetry disable / enable\`.
-					You can override this for individual projects with the environment variable \`WRANGLER_SEND_METRICS=true/false\`.
-					"
-				`);
+				expect(std.out).toContain("Status: Disabled");
 			});
 
 			it("shows wrangler.toml as the source with send_metrics is present", async () => {
@@ -446,14 +430,8 @@ describe("metrics", () => {
 					},
 				});
 				writeWranglerToml({ send_metrics: false });
-				await runWrangler("telemetry status");
-				expect(std.out).toMatchInlineSnapshot(`
-					"Status: Disabled (set by wrangler.toml)
-
-					To configure telemetry globally on this machine, you can run \`wrangler telemetry disable / enable\`.
-					You can override this for individual projects with the environment variable \`WRANGLER_SEND_METRICS=true/false\`.
-					"
-				`);
+				await runWrangler(`${cmd} status`);
+				expect(std.out).toContain("Status: Disabled (set by wrangler.toml)");
 			});
 
 			it("shows environment variable as the source if used", async () => {
@@ -464,26 +442,16 @@ describe("metrics", () => {
 					},
 				});
 				vi.stubEnv("WRANGLER_SEND_METRICS", "false");
-				await runWrangler("telemetry status");
-				expect(std.out).toMatchInlineSnapshot(`
-					"Status: Disabled (set by environment variable)
-
-					To configure telemetry globally on this machine, you can run \`wrangler telemetry disable / enable\`.
-					You can override this for individual projects with the environment variable \`WRANGLER_SEND_METRICS=true/false\`.
-					"
-				`);
+				await runWrangler(`${cmd} status`);
+				expect(std.out).toContain(
+					"Status: Disabled (set by environment variable)"
+				);
 			});
 
 			it("defaults to enabled if metrics config is not set", async () => {
 				writeMetricsConfig({});
-				await runWrangler("telemetry status");
-				expect(std.out).toMatchInlineSnapshot(`
-					"Status: Enabled
-
-					To configure telemetry globally on this machine, you can run \`wrangler telemetry disable / enable\`.
-					You can override this for individual projects with the environment variable \`WRANGLER_SEND_METRICS=true/false\`.
-					"
-				`);
+				await runWrangler(`${cmd} status`);
+				expect(std.out).toContain("Status: Enabled");
 			});
 
 			it("prioritises environment variable over send_metrics", async () => {
@@ -495,31 +463,24 @@ describe("metrics", () => {
 				});
 				writeWranglerToml({ send_metrics: true });
 				vi.stubEnv("WRANGLER_SEND_METRICS", "false");
-				await runWrangler("telemetry status");
-				expect(std.out).toMatchInlineSnapshot(`
-					"Status: Disabled (set by environment variable)
-
-					To configure telemetry globally on this machine, you can run \`wrangler telemetry disable / enable\`.
-					You can override this for individual projects with the environment variable \`WRANGLER_SEND_METRICS=true/false\`.
-					"
-				`);
+				await runWrangler(`${cmd} status`);
+				expect(std.out).toContain(
+					"Status: Disabled (set by environment variable)"
+				);
 			});
 		});
 
-		it("disables telemetry when `wrangler telemetry disable` is run", async () => {
+		it(`disables telemetry when "wrangler ${cmd} disable" is run`, async () => {
 			writeMetricsConfig({
 				permission: {
 					enabled: true,
 					date: new Date(2022, 6, 4),
 				},
 			});
-			await runWrangler("telemetry disable");
-			expect(std.out).toMatchInlineSnapshot(`
-				"Status: Disabled
+			await runWrangler(`${cmd} disable`);
+			expect(std.out).toContain(`Status: Disabled
 
-				Wrangler is no longer collecting telemetry about your usage.
-				"
-			`);
+Wrangler is no longer collecting telemetry about your usage.`);
 			expect(readMetricsConfig()).toMatchObject({
 				permission: {
 					enabled: false,
@@ -528,20 +489,17 @@ describe("metrics", () => {
 			});
 		});
 
-		it("enables telemetry when `wrangler telemetry enable` is run", async () => {
+		it(`enables telemetry when "wrangler ${cmd} enable" is run`, async () => {
 			writeMetricsConfig({
 				permission: {
 					enabled: false,
 					date: new Date(2022, 6, 4),
 				},
 			});
-			await runWrangler("telemetry enable");
-			expect(std.out).toMatchInlineSnapshot(`
-				"Status: Enabled
+			await runWrangler(`${cmd} enable`);
+			expect(std.out).toContain(`Status: Enabled
 
-				Wrangler is now collecting telemetry about your usage. Thank you for helping make Wrangler better 🧡
-				"
-			`);
+Wrangler is now collecting telemetry about your usage. Thank you for helping make Wrangler better 🧡`);
 			expect(readMetricsConfig()).toMatchObject({
 				permission: {
 					enabled: true,
@@ -557,13 +515,10 @@ describe("metrics", () => {
 					date: new Date(2022, 6, 4),
 				},
 			});
-			await runWrangler("telemetry enable");
-			expect(std.out).toMatchInlineSnapshot(`
-				"Status: Enabled
+			await runWrangler(`${cmd} enable`);
+			expect(std.out).toContain(`Status: Enabled
 
-				Wrangler is now collecting telemetry about your usage. Thank you for helping make Wrangler better 🧡
-				"
-			`);
+Wrangler is now collecting telemetry about your usage. Thank you for helping make Wrangler better 🧡`);
 			const config = readMetricsConfig();
 			expect(config).toMatchObject({
 				c3permission: {

packages/wrangler/src/metrics/commands.ts

@@ -1,5 +1,5 @@
 import chalk from "chalk";
-import { defineCommand, defineNamespace } from "../core";
+import { defineAlias, defineCommand, defineNamespace } from "../core";
 import { getWranglerSendMetricsFromEnv } from "../environment-variables/misc-variables";
 import { logger } from "../logger";
 import { readMetricsConfig, updateMetricsPermission } from "./metrics-config";
@@ -14,6 +14,11 @@ defineNamespace({
 	},
 });
 
+defineAlias({
+	command: "wrangler metrics",
+	aliasOf: "wrangler telemetry",
+});
+
 defineCommand({
 	command: "wrangler telemetry disable",
 	metadata: {