Improve potential errors thrown by startRemoteProxySession by including more information (#11018)

dario-piotrowicz · web-flow · commit 512481809fe5 · 2025-10-20T15:25:04.000+01:00
diff --git a/.changeset/afraid-sloths-begin.md b/.changeset/afraid-sloths-begin.md
@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+Improve potential errors thrown by `startRemoteProxySession` by including more information
diff --git a/packages/wrangler/src/__tests__/dev/remote-bindings-errors.test.ts b/packages/wrangler/src/__tests__/dev/remote-bindings-errors.test.ts
@@ -0,0 +1,43 @@
+import { beforeEach, describe, it } from "vitest";
+import { startRemoteProxySession } from "../../api";
+import { mockApiToken } from "../helpers/mock-account-id";
+import { msw, mswSuccessUserHandlers } from "../helpers/msw";
+import { runInTempDir } from "../helpers/run-in-tmp";
+
+describe("errors during dev with remote bindings", () => {
+	mockApiToken();
+	runInTempDir();
+
+	beforeEach(() => {
+		msw.use(...mswSuccessUserHandlers);
+	});
+
+	it("errors when starting the remote proxy session are appropriately surfaced", async () => {
+		let thrownError: Error | undefined;
+
+		try {
+			await startRemoteProxySession({
+				MY_WORKER: {
+					type: "service",
+					service: "my-worker",
+					remote: true,
+				},
+			});
+		} catch (e) {
+			assert(e instanceof Error);
+			thrownError = e;
+		}
+
+		assert(thrownError);
+
+		expect(thrownError.message).toContain(
+			"Failed to start the remote proxy session"
+		);
+
+		// The issue here is that with the test setup there is more than one account available (but we're
+		// in non-interactive mode). Here we make sure that this information is presented in the thrown error
+		expect(thrownError.message).toContain(
+			"More than one account available but unable to select one in non-interactive mode."
+		);
+	});
+});
diff --git a/packages/wrangler/src/api/remoteBindings/start-remote-proxy-session.ts b/packages/wrangler/src/api/remoteBindings/start-remote-proxy-session.ts
@@ -46,6 +46,18 @@ export async function startRemoteProxySession(
 			logLevel: "error",
 		},
 		bindings: rawBindings,
+	}).catch((startWorkerError) => {
+		let errorMessage = startWorkerError;
+		if (startWorkerError instanceof Error) {
+			if (startWorkerError.cause instanceof Error) {
+				errorMessage = startWorkerError.cause.message;
+			} else {
+				errorMessage = startWorkerError.message;
+			}
+		}
+		throw new Error(
+			`Failed to start the remote proxy session, see the error details below:\n\n${errorMessage}`
+		);
 	});
 
 	const remoteProxyConnectionString =
