improve InspectorProxyWorker debug logs

cloudflare · Nov 3, 2023 · b55a13a · b55a13a
1 parent 42fcf89
commit b55a13a
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 9 deletions.
diff --git a/packages/wrangler/src/api/startDevWorker/ProxyController.ts b/packages/wrangler/src/api/startDevWorker/ProxyController.ts
@@ -389,7 +389,10 @@ export class ProxyController extends EventEmitter {
 		switch (message.type) {
 			case "runtime-websocket-error":
 				// TODO: consider sending proxyData again to trigger the InspectorProxyWorker to reconnect to the runtime
-				logger.error(message.error);
+				logger.error(
+					"[InspectorProxyWorker] 'runtime websocket' error",
+					message.error
+				);
 
 				break;
 			case "error":

diff --git a/packages/wrangler/src/api/startDevWorker/events.ts b/packages/wrangler/src/api/startDevWorker/events.ts
@@ -119,7 +119,7 @@ export function serialiseError(e: unknown): SerializedError {
 			message: e.message,
 			name: e.name,
 			stack: e.stack,
-			cause: serialiseError(e.cause),
+			cause: e.cause && serialiseError(e.cause),
 		};
 	} else {
 		return { message: String(e) };

diff --git a/packages/wrangler/templates/startDevWorker/InspectorProxyWorker.ts b/packages/wrangler/templates/startDevWorker/InspectorProxyWorker.ts
@@ -96,18 +96,27 @@ export class InspectorProxyWorker implements DurableObject {
 
 		const { 0: response, 1: proxyController } = new WebSocketPair();
 		proxyController.accept();
-		proxyController.addEventListener("close", () => {
+		proxyController.addEventListener("close", (event) => {
 			// don't reconnect the proxyController websocket
 			// ProxyController can detect this event and reconnect itself
 
+			this.sendDebugLog(
+				"PROXY CONTROLLER WEBSOCKET CLOSED",
+				event.code,
+				event.reason
+			);
+
 			if (this.websockets.proxyController === proxyController) {
 				this.websockets.proxyController = undefined;
 			}
 		});
-		proxyController.addEventListener("error", () => {
+		proxyController.addEventListener("error", (event) => {
 			// don't reconnect the proxyController websocket
 			// ProxyController can detect this event and reconnect itself
 
+			const error = serialiseError(event.error);
+			this.sendDebugLog("PROXY CONTROLLER WEBSOCKET ERROR", error);
+
 			if (this.websockets.proxyController === proxyController) {
 				this.websockets.proxyController = undefined;
 			}
@@ -310,6 +319,9 @@ export class InspectorProxyWorker implements DurableObject {
 		});
 
 		runtime.addEventListener("error", (event) => {
+			const error = serialiseError(event.error);
+			this.sendDebugLog("RUNTIME WEBSOCKET ERROR", error);
+
 			clearInterval(this.runtimeKeepAliveInterval);
 
 			if (this.websockets.runtime === runtime) {
@@ -318,10 +330,7 @@ export class InspectorProxyWorker implements DurableObject {
 
 			this.sendProxyControllerRequest({
 				type: "runtime-websocket-error",
-				error: {
-					message: event.message,
-					cause: event.error,
-				},
+				error,
 			});
 
 			// don't reconnect the runtime websocket
@@ -452,12 +461,21 @@ export class InspectorProxyWorker implements DurableObject {
 			);
 		} else {
 			devtools.addEventListener("message", this.handleDevToolsIncomingMessage);
-			devtools.addEventListener("close", () => {
+			devtools.addEventListener("close", (event) => {
+				this.sendDebugLog(
+					"DEVTOOLS WEBSOCKET CLOSED",
+					event.code,
+					event.reason
+				);
+
 				if (this.websockets.devtools === devtools) {
 					this.websockets.devtools = undefined;
 				}
 			});
 			devtools.addEventListener("error", (event) => {
+				const error = serialiseError(event.error);
+				this.sendDebugLog("DEVTOOLS WEBSOCKET ERROR", error);
+
 				if (this.websockets.devtools === devtools) {
 					this.websockets.devtools = undefined;
 				}
@@ -546,6 +564,11 @@ export class InspectorProxyWorker implements DurableObject {
 			url: message.params.url,
 		});
 		if (response === undefined) {
+			this.sendDebugLog(
+				`ProxyController could not resolve Network.loadNetworkResource for "${message.params.url}"`
+			);
+
+			// When the ProxyController cannot resolve a resource, let the runtime handle the request
 			this.sendRuntimeMessage(JSON.stringify(message));
 		} else {
 			// this.websockets.devtools can be undefined here