more error telemetry (#10003)

Author: emily-shen

.changeset/gold-shirts-wash.md

@@ -0,0 +1,7 @@
+---
+"wrangler": patch
+---
+
+Include more (sanitised) user errors in telemetry.
+
+We manually vet and sanitised error messages before including them in our telemetry collection - this PR just includes a couple more.

packages/wrangler/src/assets.ts

@@ -520,7 +520,8 @@ export function validateAssetsArgsAndConfig(
 	) {
 		throw new UserError(
 			"Cannot use assets and Workers Sites in the same Worker.\n" +
-				"Please remove either the `site` or `assets` field from your configuration file."
+				"Please remove either the `site` or `assets` field from your configuration file.",
+			{ telemetryMessage: true }
 		);
 	}
 

packages/wrangler/src/deploy/deploy.ts

@@ -395,12 +395,15 @@ export default async function deploy(props: Props): Promise<{
 			""
 		).padStart(2, "0")}-${(new Date().getDate() + "").padStart(2, "0")}`;
 
-		throw new UserError(`A compatibility_date is required when publishing. Add the following to your ${configFileName(config.configPath)} file:
+		throw new UserError(
+			`A compatibility_date is required when publishing. Add the following to your ${configFileName(config.configPath)} file:
     \`\`\`
     ${formatConfigSnippet({ compatibility_date: compatibilityDateStr }, config.configPath, false)}
     \`\`\`
     Or you could pass it in your terminal as \`--compatibility-date ${compatibilityDateStr}\`
-See https://developers.cloudflare.com/workers/platform/compatibility-dates for more information.`);
+See https://developers.cloudflare.com/workers/platform/compatibility-dates for more information.`,
+			{ telemetryMessage: "missing compatibiltiy date when deploying" }
+		);
 	}
 
 	const routes =
@@ -482,25 +485,29 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 		format === "service-worker"
 	) {
 		throw new UserError(
-			"You cannot use the service-worker format with an `assets` directory yet. For information on how to migrate to the module-worker format, see: https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/"
+			"You cannot use the service-worker format with an `assets` directory yet. For information on how to migrate to the module-worker format, see: https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/",
+			{ telemetryMessage: true }
 		);
 	}
 
 	if (config.wasm_modules && format === "modules") {
 		throw new UserError(
-			"You cannot configure [wasm_modules] with an ES module worker. Instead, import the .wasm module directly in your code"
+			"You cannot configure [wasm_modules] with an ES module worker. Instead, import the .wasm module directly in your code",
+			{ telemetryMessage: true }
 		);
 	}
 
 	if (config.text_blobs && format === "modules") {
 		throw new UserError(
-			`You cannot configure [text_blobs] with an ES module worker. Instead, import the file directly in your code, and optionally configure \`[rules]\` in your ${configFileName(config.configPath)} file`
+			`You cannot configure [text_blobs] with an ES module worker. Instead, import the file directly in your code, and optionally configure \`[rules]\` in your ${configFileName(config.configPath)} file`,
+			{ telemetryMessage: "[text_blobs] with an ES module worker" }
 		);
 	}
 
 	if (config.data_blobs && format === "modules") {
 		throw new UserError(
-			`You cannot configure [data_blobs] with an ES module worker. Instead, import the file directly in your code, and optionally configure \`[rules]\` in your ${configFileName(config.configPath)} file`
+			`You cannot configure [data_blobs] with an ES module worker. Instead, import the file directly in your code, and optionally configure \`[rules]\` in your ${configFileName(config.configPath)} file`,
+			{ telemetryMessage: "[data_blobs] with an ES module worker" }
 		);
 	}
 
@@ -902,7 +909,8 @@ See https://developers.cloudflare.com/workers/platform/compatibility-dates for m
 						"binding DB of type d1 must have a valid `id` specified [code: 10021]"
 					) {
 						throw new UserError(
-							"You must use a real database in the database_id configuration. You can find your databases using 'wrangler d1 list', or read how to develop locally with D1 here: https://developers.cloudflare.com/d1/configuration/local-development"
+							"You must use a real database in the database_id configuration. You can find your databases using 'wrangler d1 list', or read how to develop locally with D1 here: https://developers.cloudflare.com/d1/configuration/local-development",
+							{ telemetryMessage: true }
 						);
 					}
 
@@ -1054,7 +1062,8 @@ async function publishRoutesFallback(
 	if (notProd) {
 		throw new UserError(
 			"Service environments combined with an API token that doesn't have 'All Zones' permissions is not supported.\n" +
-				"Either turn off service environments by setting `legacy_env = true`, creating an API token with 'All Zones' permissions, or logging in via OAuth"
+				"Either turn off service environments by setting `legacy_env = true`, creating an API token with 'All Zones' permissions, or logging in via OAuth",
+			{ telemetryMessage: true }
 		);
 	}
 	logger.warn(
@@ -1130,7 +1139,8 @@ async function publishRoutesFallback(
 				continue;
 			} else {
 				throw new UserError(
-					`The route with pattern "${routePattern}" is already associated with another worker called "${knownScript}".`
+					`The route with pattern "${routePattern}" is already associated with another worker called "${knownScript}".`,
+					{ telemetryMessage: "route already associated with another worker" }
 				);
 			}
 		}
@@ -1234,7 +1244,8 @@ export async function updateQueueConsumers(
 			if (scriptName === undefined) {
 				// TODO: how can we reliably get the current script name?
 				throw new UserError(
-					"Script name is required to update queue consumers"
+					"Script name is required to update queue consumers",
+					{ telemetryMessage: true }
 				);
 			}
 

packages/wrangler/src/deployment-bundle/entry.ts

@@ -77,7 +77,8 @@ export async function getEntry(
 		if (config.pages_build_output_dir && command === "dev") {
 			throw new UserError(
 				"It looks like you've run a Workers-specific command in a Pages project.\n" +
-					"For Pages, please run `wrangler pages dev` instead."
+					"For Pages, please run `wrangler pages dev` instead.",
+				{ telemetryMessage: true }
 			);
 		}
 
@@ -151,7 +152,8 @@ export async function getEntry(
 		const migrateUrl =
 			"https://developers.cloudflare.com/workers/learning/migrating-to-module-workers/";
 		throw new UserError(
-			`${errorMessage}\n${addScriptName}\n${addScriptNameExamples}\n${migrateText}\n${migrateUrl}`
+			`${errorMessage}\n${addScriptName}\n${addScriptNameExamples}\n${migrateText}\n${migrateUrl}`,
+			{ telemetryMessage: "tried to use DO with service worker" }
 		);
 	}
 

packages/wrangler/src/dev.ts

@@ -1005,7 +1005,10 @@ export function getBindings(
 				// same copy-on-write TODO
 				if (!preview_bucket_name && !local) {
 					throw new UserError(
-						`In development, you should use a separate r2 bucket than the one you'd use in production. Please create a new r2 bucket with "wrangler r2 bucket create <name>" and add its name as preview_bucket_name to the r2_buckets "${binding}" in your ${configFileName(configParam.configPath)} file`
+						`In development, you should use a separate r2 bucket than the one you'd use in production. Please create a new r2 bucket with "wrangler r2 bucket create <name>" and add its name as preview_bucket_name to the r2_buckets "${binding}" in your ${configFileName(configParam.configPath)} file`,
+						{
+							telemetryMessage: "no preview r2 bucket configured in remote dev",
+						}
 					);
 				}
 				return {
@@ -1040,7 +1043,8 @@ export function getBindings(
 			hyperdrive.localConnectionString === undefined
 		) {
 			throw new UserError(
-				`When developing locally, you should use a local Postgres connection string to emulate Hyperdrive functionality. Please setup Postgres locally and set the value of the 'WRANGLER_HYPERDRIVE_LOCAL_CONNECTION_STRING_${hyperdrive.binding}' variable or "${hyperdrive.binding}"'s "localConnectionString" to the Postgres connection string.`
+				`When developing locally, you should use a local Postgres connection string to emulate Hyperdrive functionality. Please setup Postgres locally and set the value of the 'WRANGLER_HYPERDRIVE_LOCAL_CONNECTION_STRING_${hyperdrive.binding}' variable or "${hyperdrive.binding}"'s "localConnectionString" to the Postgres connection string.`,
+				{ telemetryMessage: "no local hyperdrive connection string" }
 			);
 		}
 

packages/wrangler/src/package-manager.ts

@@ -88,7 +88,10 @@ export async function getPackageManager(cwd: string): Promise<PackageManager> {
 		return { ...PnpmPackageManager, cwd };
 	} else {
 		throw new UserError(
-			"Unable to find a package manager. Supported managers are: npm, yarn, and pnpm."
+			"Unable to find a package manager. Supported managers are: npm, yarn, and pnpm.",
+			{
+				telemetryMessage: true,
+			}
 		);
 	}
 }