Provide more informative error messages for Workers CI tag validation (#8625)

Author: WalshyDev

packages/wrangler/src/__tests__/match-tag.test.ts

@@ -44,6 +44,19 @@ describe("match-tag", () => {
 						);
 					} else if (params.workerName === "network-error-worker") {
 						return HttpResponse.error();
+					} else if (params.workerName === "auth-error-worker") {
+						return HttpResponse.json(
+							{
+								success: false,
+								errors: [
+									{
+										code: 10000,
+										message: "Authentication error",
+									},
+								],
+							},
+							{ status: 401 }
+						);
 					} else {
 						return HttpResponse.json(
 							{
@@ -92,13 +105,27 @@ describe("match-tag", () => {
 			);
 		});
 
-		it("catches all other API errors and throws generic validation error", async () => {
+		it("catches all other API errors and throws proper error", async () => {
+			vi.stubEnv("WRANGLER_CI_MATCH_TAG", "abc123");
+			mockWorker("a-worker", "abc123");
+			await expect(
+				verifyWorkerMatchesCITag("some-account-id", "auth-error-worker")
+			).rejects.toMatchInlineSnapshot(
+				`
+				[Error: An error occurred while trying to validate that the Worker name matches what is expected by the build system.
+				A request to the Cloudflare API (/accounts/some-account-id/workers/services/auth-error-worker) failed.
+				Authentication error [code: 10000]]
+			`
+			);
+		});
+
+		it("catches all other errors and throws generic error", async () => {
 			vi.stubEnv("WRANGLER_CI_MATCH_TAG", "abc123");
 			mockWorker("a-worker", "abc123");
 			await expect(
 				verifyWorkerMatchesCITag("some-account-id", "network-error-worker")
 			).rejects.toMatchInlineSnapshot(
-				`[Error: Wrangler cannot validate that your Worker name matches what is expected by the build system. Please retry the build.]`
+				`[Error: Wrangler cannot validate that your Worker name matches what is expected by the build system. Please retry the build. If the problem persists, please contact support.]`
 			);
 		});
 
@@ -143,11 +170,15 @@ describe("match-tag", () => {
 			it("catches all other API errors and throws generic validation error", async () => {
 				vi.stubEnv("WRANGLER_CI_MATCH_TAG", "abc123");
 				mockWorker("a-worker", "abc123");
-				writeWranglerConfig({ name: "network-error-worker" });
+				writeWranglerConfig({ name: "auth-error-worker" });
 				await expect(
 					runWrangler("deploy ./index.js")
 				).rejects.toMatchInlineSnapshot(
-					`[Error: Wrangler cannot validate that your Worker name matches what is expected by the build system. Please retry the build.]`
+					`
+					[Error: An error occurred while trying to validate that the Worker name matches what is expected by the build system.
+					A request to the Cloudflare API (/accounts/some-account-id/workers/services/auth-error-worker) failed.
+					Authentication error [code: 10000]]
+				`
 				);
 			});
 

packages/wrangler/src/environment-variables/misc-variables.ts

@@ -93,18 +93,18 @@ export const getOutputFilePathFromEnv = getEnvironmentVariableFactory({
 });
 
 /**
- * `WRANGLER_CI_MATCH_TAG` specifies a worker tag
+ * `WRANGLER_CI_MATCH_TAG` specifies a Worker tag
  *
- * If this is set, Wrangler will ensure the worker being targeted has this tag
+ * If this is set, Wrangler will ensure the Worker being targeted has this tag
  */
 export const getCIMatchTag = getEnvironmentVariableFactory({
 	variableName: "WRANGLER_CI_MATCH_TAG",
 });
 
 /**
- * `WRANGLER_CI_OVERRIDE_TAG` specifies a worker tag
+ * `WRANGLER_CI_OVERRIDE_NAME` specifies a Worker name
  *
- * If this is set, Wrangler will override the worker name with this tag
+ * If this is set, Wrangler will override the Worker name with this one
  */
 export const getCIOverrideName = getEnvironmentVariableFactory({
 	variableName: "WRANGLER_CI_OVERRIDE_NAME",

packages/wrangler/src/match-tag.ts

@@ -3,6 +3,7 @@ import { configFileName, formatConfigSnippet } from "./config";
 import { getCIMatchTag } from "./environment-variables/misc-variables";
 import { FatalError } from "./errors";
 import { logger } from "./logger";
+import { APIError } from "./parse";
 import { getCloudflareAccountIdFromEnv } from "./user/auth-variables";
 import type { ServiceMetadataRes } from "./init";
 
@@ -48,9 +49,17 @@ export async function verifyWorkerMatchesCITag(
 			throw new FatalError(
 				`The name in your ${configFileName(configPath)} file (${workerName}) must match the name of your Worker. Please update the name field in your ${configFileName(configPath)} file.`
 			);
+		} else if (e instanceof APIError) {
+			throw new FatalError(
+				"An error occurred while trying to validate that the Worker name matches what is expected by the build system.\n" +
+					e.message +
+					"\n" +
+					e.notes.map((note) => note.text).join("\n")
+			);
 		} else {
 			throw new FatalError(
-				"Wrangler cannot validate that your Worker name matches what is expected by the build system. Please retry the build."
+				"Wrangler cannot validate that your Worker name matches what is expected by the build system. Please retry the build. " +
+					"If the problem persists, please contact support."
 			);
 		}
 	}