add config type

Author: emily-shen

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

@@ -6,6 +6,7 @@ import { UserError } from "../errors";
 import { CI } from "../is-ci";
 import { logger } from "../logger";
 import {
+	getConfigFileType,
 	getNodeVersion,
 	getOS,
 	getOSVersion,
@@ -58,6 +59,7 @@ describe("metrics", () => {
 			vi.mocked(getOSVersion).mockReturnValue("mock os version");
 			vi.mocked(getNodeVersion).mockReturnValue("1.1.1");
 			vi.mocked(getPlatform).mockReturnValue("mock platform");
+			vi.mocked(getConfigFileType).mockReturnValue("toml");
 			vi.useFakeTimers({
 				now: new Date(2024, 11, 12),
 			});
@@ -245,6 +247,7 @@ describe("metrics", () => {
 				osVersion: "mock os version",
 				nodeVersion: "1.1.1",
 				isFirstUsage: false,
+				configFileType: "toml",
 				isCI: false,
 				isInteractive: true,
 			};

packages/wrangler/src/index.ts

@@ -690,9 +690,10 @@ export async function main(argv: string[]): Promise<void> {
 		// key to fetch) or flags
 
 		try {
-			const { rawConfig } = parseConfig(args.config, args, false);
+			const { rawConfig, configPath } = parseConfig(args.config, args, false);
 			dispatcher = getMetricsDispatcher({
 				sendMetrics: rawConfig.send_metrics,
+				configPath,
 			});
 		} catch (e) {
 			// If we can't parse the config, we can't send metrics

packages/wrangler/src/metrics/helpers.ts

@@ -38,3 +38,20 @@ export function getOSVersion() {
 export function getNodeVersion() {
 	return process.version;
 }
+
+export function getConfigFileType(configPath: string | undefined) {
+	if (configPath === undefined) {
+		return "none";
+	}
+	if (configPath.endsWith(".toml")) {
+		return "toml";
+	}
+	if (configPath.endsWith(".json")) {
+		return "json";
+	}
+	if (configPath.endsWith(".jsonc")) {
+		return "jsonc";
+	}
+	/** shouldn't ever get here */
+	return "invalid";
+}

packages/wrangler/src/metrics/metrics-config.ts

@@ -23,6 +23,10 @@ export interface MetricsConfigOptions {
 	 * Otherwise, infer the enabled value from the user configuration.
 	 */
 	sendMetrics?: boolean;
+	/**
+	 * Path to wrangler configuration file, if it exists. Used for configFileType property
+	 */
+	configPath?: string | undefined;
 }
 
 /**

packages/wrangler/src/metrics/metrics-dispatcher.ts

@@ -4,6 +4,7 @@ import _isInteractive from "../is-interactive";
 import { logger } from "../logger";
 import { CI } from "./../is-ci";
 import {
+	getConfigFileType,
 	getNodeVersion,
 	getOS,
 	getOSVersion,
@@ -35,6 +36,7 @@ export function getMetricsDispatcher(options: MetricsConfigOptions) {
 	const isCI = CI.isCI();
 	const isInteractive = _isInteractive();
 	const amplitude_session_id = Date.now();
+	const configFileType = getConfigFileType(options.configPath);
 	let amplitude_event_id = 0;
 	/** We redact strings in arg values, unless they are named here */
 	const allowList = {
@@ -95,6 +97,7 @@ export function getMetricsDispatcher(options: MetricsConfigOptions) {
 				nodeVersion,
 				packageManager,
 				isFirstUsage,
+				configFileType,
 				isCI,
 				isInteractive,
 				argsUsed,

packages/wrangler/src/metrics/send-event.ts

@@ -138,6 +138,10 @@ export type CommonEventProperties = {
 	 * Whether this is the first time the user has used the wrangler client.
 	 */
 	isFirstUsage: boolean;
+	/**
+	 * What format is the configuration file?
+	 */
+	configFileType: "toml" | "json" | "jsonc" | "none" | "invalid";
 
 	amplitude_session_id: number;
 	amplitude_event_id: number;