Introduce internal isWorkerNotFoundError utility and avoid worker-not-found error code magic numbers in wrangler (#11519)

Author: dario-piotrowicz

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

@@ -5,6 +5,10 @@ import * as TOML from "@iarna/toml";
 import { http, HttpResponse } from "msw";
 import { vi } from "vitest";
 import { VERSION_NOT_DEPLOYED_ERR_CODE } from "../secret";
+import {
+	WORKER_NOT_FOUND_ERR_CODE,
+	workerNotFoundErrorMessage,
+} from "../utils/worker-not-found-error";
 import { mockAccountId, mockApiToken } from "./helpers/mock-account-id";
 import { mockConsoleMethods } from "./helpers/mock-console";
 import { clearDialogs, mockConfirm, mockPrompt } from "./helpers/mock-dialogs";
@@ -52,8 +56,8 @@ function mockNoWorkerFound(isBulk = false) {
 					return HttpResponse.json(
 						createFetchResult(null, false, [
 							{
-								code: 10007,
-								message: "This Worker does not exist on your account.",
+								code: WORKER_NOT_FOUND_ERR_CODE,
+								message: workerNotFoundErrorMessage,
 							},
 						])
 					);
@@ -69,8 +73,8 @@ function mockNoWorkerFound(isBulk = false) {
 					return HttpResponse.json(
 						createFetchResult(null, false, [
 							{
-								code: 10007,
-								message: "This Worker does not exist on your account.",
+								code: WORKER_NOT_FOUND_ERR_CODE,
+								message: workerNotFoundErrorMessage,
 							},
 						])
 					);

packages/wrangler/src/deploy/deploy.ts

@@ -45,6 +45,7 @@ import triggersDeploy from "../triggers/deploy";
 import { helpIfErrorIsSizeOrScriptStartup } from "../utils/friendly-validator-errors";
 import { printBindings } from "../utils/print-bindings";
 import { retryOnAPIFailure } from "../utils/retry";
+import { isWorkerNotFoundError } from "../utils/worker-not-found-error";
 import {
 	createDeployment,
 	patchNonVersionedScriptSettings,
@@ -377,12 +378,10 @@ export default async function deploy(props: Props): Promise<{
 				}
 			}
 		} catch (e) {
-			// code: 10090, message: workers.api.error.service_not_found
-			// is thrown from the above fetchResult on the first deploy of a Worker
-			if ((e as { code?: number }).code !== 10090) {
-				throw e;
-			} else {
+			if (isWorkerNotFoundError(e)) {
 				workerExists = false;
+			} else {
+				throw e;
 			}
 		}
 	}

packages/wrangler/src/durable.ts

@@ -2,6 +2,7 @@ import assert from "node:assert";
 import { fetchResult } from "./cfetch";
 import { configFileName } from "./config";
 import { logger } from "./logger";
+import { isWorkerNotFoundError } from "./utils/worker-not-found-error";
 import type { Config } from "./config";
 import type { CfWorkerInit } from "./deployment-bundle/worker";
 
@@ -108,10 +109,8 @@ export async function getMigrationsToUpload(
 
 const suppressNotFoundError = (err: unknown) => {
 	if (
-		![
-			10090, // corresponds to workers.api.error.service_not_found, so the script wasn't previously published at all
-			10092, // workers.api.error.environment_not_found, so the script wasn't published to this environment yet
-		].includes((err as { code: number }).code)
+		!isWorkerNotFoundError(err) &&
+		(err as { code: number }).code !== 10092 // workers.api.error.environment_not_found, so the script wasn't published to this environment yet
 	) {
 		throw err;
 	}

packages/wrangler/src/init.ts

@@ -22,6 +22,7 @@ import { getBasePath } from "./paths";
 import { requireAuth } from "./user";
 import { createBatches } from "./utils/create-batches";
 import * as shellquote from "./utils/shell-quote";
+import { isWorkerNotFoundError } from "./utils/worker-not-found-error";
 import { printWranglerBanner } from "./wrangler-banner";
 import type { RawConfig } from "./config";
 import type {
@@ -226,7 +227,7 @@ export async function initHandler(args: InitArgs) {
 					`/accounts/${accountId}/workers/services/${fromDashWorkerName}`
 				);
 			} catch (err) {
-				if ((err as { code?: number }).code === 10090) {
+				if (isWorkerNotFoundError(err)) {
 					throw new UserError(
 						"wrangler couldn't find a Worker script with that name in your account.\nRun `wrangler whoami` to confirm you're logged into the correct account."
 					);

packages/wrangler/src/match-tag.ts

@@ -4,6 +4,7 @@ import { getCIMatchTag } from "./environment-variables/misc-variables";
 import { FatalError } from "./errors";
 import { logger } from "./logger";
 import { getCloudflareAccountIdFromEnv } from "./user/auth-variables";
+import { isWorkerNotFoundError } from "./utils/worker-not-found-error";
 import type { ServiceMetadataRes } from "./init";
 
 export async function verifyWorkerMatchesCITag(
@@ -43,8 +44,7 @@ export async function verifyWorkerMatchesCITag(
 		logger.debug(`API returned with tag: ${tag} for worker: ${workerName}`);
 	} catch (e) {
 		logger.debug(e);
-		// code: 10090, message: workers.api.error.service_not_found
-		if ((e as { code?: number }).code === 10090) {
+		if (isWorkerNotFoundError(e)) {
 			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.`
 			);

packages/wrangler/src/secret/index.ts

@@ -19,6 +19,7 @@ import { requireAuth } from "../user";
 import { getLegacyScriptName } from "../utils/getLegacyScriptName";
 import { isLegacyEnv } from "../utils/isLegacyEnv";
 import { readFromStdin, trimTrailingWhitespace } from "../utils/std";
+import { isWorkerNotFoundError } from "../utils/worker-not-found-error";
 import type { Config } from "../config";
 import type { WorkerMetadataBinding } from "../deployment-bundle/create-worker-upload-form";
 
@@ -37,14 +38,6 @@ type InheritBindingUpload = {
 
 type SecretBindingRedacted = Omit<SecretBindingUpload, "text">;
 
-function isMissingWorkerError(e: unknown): e is { code: 10007 } {
-	return (
-		typeof e === "object" &&
-		e !== null &&
-		(e as { code: number }).code === 10007
-	);
-}
-
 async function createDraftWorker({
 	config,
 	args,
@@ -227,7 +220,7 @@ export const secretPutCommand = createCommand({
 				sendMetrics: config.send_metrics,
 			});
 		} catch (e) {
-			if (isMissingWorkerError(e)) {
+			if (isWorkerNotFoundError(e)) {
 				// create a draft worker and try again
 				const result = await createDraftWorker({
 					config,
@@ -474,7 +467,7 @@ export const secretBulkCommand = createCommand({
 			const settings = await getSettings();
 			existingBindings = settings.bindings;
 		} catch (e) {
-			if (isMissingWorkerError(e)) {
+			if (isWorkerNotFoundError(e)) {
 				// create a draft worker before patching
 				const result = await createDraftWorker({
 					config,

packages/wrangler/src/utils/worker-not-found-error.ts

@@ -0,0 +1,30 @@
+/**
+ This is the error code from the Cloudflare API signaling that a worker could not be found on the target account
+ */
+export const WORKER_NOT_FOUND_ERR_CODE = 10007 as const;
+
+/**
+ This is the error code from the Cloudflare API signaling that a worker environment (legacy) could not be found on the target account
+ */
+export const WORKER_LEGACY_ENVIRONMENT_NOT_FOUND_ERR_CODE = 10090 as const;
+
+/**
+ This is the error message from the Cloudflare API signaling that a worker could not be found on the target account
+ */
+export const workerNotFoundErrorMessage =
+	"This Worker does not exist on your account.";
+
+/**
+ * Given an error from the Cloudflare API discerns wether it is caused by a worker that could not be found on the target account
+ *
+ * @param error The error object
+ * @returns true is the object represents an error from the Cloudflare API caused by a not found worker, false otherwise
+ */
+export function isWorkerNotFoundError(error: unknown): boolean {
+	return (
+		error instanceof Object &&
+		"code" in error &&
+		(error.code === WORKER_NOT_FOUND_ERR_CODE ||
+			error.code === WORKER_LEGACY_ENVIRONMENT_NOT_FOUND_ERR_CODE)
+	);
+}

packages/wrangler/src/versions/deploy.ts

@@ -14,9 +14,9 @@ import { isNonInteractiveOrCI } from "../is-interactive";
 import { logger } from "../logger";
 import * as metrics from "../metrics";
 import { writeOutput } from "../output";
-import { APIError } from "../parse";
 import { requireAuth } from "../user";
 import formatLabelledValues from "../utils/render-labelled-values";
+import { isWorkerNotFoundError } from "../utils/worker-not-found-error";
 import {
 	createDeployment,
 	fetchDeployableVersions,
@@ -268,8 +268,7 @@ export async function confirmLatestDeploymentOverwrite(
 			});
 		}
 	} catch (e) {
-		const isNotFound = e instanceof APIError && e.code == 10007;
-		if (!isNotFound) {
+		if (!isWorkerNotFoundError(e)) {
 			throw e;
 		}
 	}

packages/wrangler/src/versions/upload.ts

@@ -50,6 +50,7 @@ import { getScriptName } from "../utils/getScriptName";
 import { isLegacyEnv } from "../utils/isLegacyEnv";
 import { printBindings } from "../utils/print-bindings";
 import { retryOnAPIFailure } from "../utils/retry";
+import { isWorkerNotFoundError } from "../utils/worker-not-found-error";
 import type { AssetsOptions } from "../assets";
 import type { Config } from "../config";
 import type { Entry } from "../deployment-bundle/entry";
@@ -451,9 +452,7 @@ export default async function versionsUpload(props: Props): Promise<{
 				}
 			}
 		} catch (e) {
-			// code: 10090, message: workers.api.error.service_not_found
-			// is thrown from the above fetchResult on the first deploy of a Worker
-			if ((e as { code?: number }).code !== 10090) {
+			if (!isWorkerNotFoundError(e)) {
 				throw e;
 			}
 		}