feat(logging): unify HTTP/WS handling and logging (#580)

- Add Axios interceptor with per-request UUID, timing, and status
- Centralize net logging; introduce `coder.httpClientLogLevel` (none|basic|headers|body)
- Standardize WebSocket creation via OneWayWebSocket (ws in VS Code); add connect/error/close logs
- Replace SSE watchers with one-way WebSockets for consistency and performance
- Refactor client API into `CoderApi` for both REST and WS requests
- Default log levels: trace for non-error logs, error for failures; isolate logging utilities

Fixes #532

Author: EhabY

CHANGELOG.md

@@ -10,6 +10,9 @@
 ### Added
 
 - Add support for CLI global flag configurations through the `coder.globalFlags` setting.
+- Add logging for all REST traffic. Verbosity is configurable via `coder.httpClientLogLevel` (`none`, `basic`, `headers`, `body`).
+- Add lifecycle logs for WebSocket creation, errors, and closures.
+- Include UUIDs in REST and WebSocket logs to correlate events and measure duration.
 
 ## [1.10.1](https://github.com/coder/vscode-coder/releases/tag/v1.10.1) 2025-08-13
 

package.json

@@ -126,6 +126,23 @@
 					"items": {
 						"type": "string"
 					}
+				},
+				"coder.httpClientLogLevel": {
+					"markdownDescription": "Controls the verbosity of HTTP client logging. This affects what details are logged for each HTTP request and response.",
+					"type": "string",
+					"enum": [
+						"none",
+						"basic",
+						"headers",
+						"body"
+					],
+					"markdownEnumDescriptions": [
+						"Disables all HTTP client logging",
+						"Logs the request method, URL, length, and the response status code",
+						"Logs everything from *basic* plus sanitized request and response headers",
+						"Logs everything from *headers* plus request and response bodies (may include sensitive data)"
+					],
+					"default": "basic"
 				}
 			}
 		},

src/agentMetadataHelper.ts

@@ -1,13 +1,11 @@
-import { Api } from "coder/site/src/api/api";
 import { WorkspaceAgent } from "coder/site/src/api/typesGenerated";
-import { EventSource } from "eventsource";
 import * as vscode from "vscode";
-import { createStreamingFetchAdapter } from "./api";
 import {
 	AgentMetadataEvent,
 	AgentMetadataEventSchemaArray,
 	errToStr,
-} from "./api-helper";
+} from "./api/api-helper";
+import { CoderApi } from "./api/coderApi";
 
 export type AgentMetadataWatcher = {
 	onChange: vscode.EventEmitter<null>["event"];
@@ -17,47 +15,62 @@ export type AgentMetadataWatcher = {
 };
 
 /**
- * Opens an SSE connection to watch metadata for a given workspace agent.
+ * Opens a websocket connection to watch metadata for a given workspace agent.
  * Emits onChange when metadata updates or an error occurs.
  */
 export function createAgentMetadataWatcher(
 	agentId: WorkspaceAgent["id"],
-	restClient: Api,
+	client: CoderApi,
 ): AgentMetadataWatcher {
-	// TODO: Is there a better way to grab the url and token?
-	const url = restClient.getAxiosInstance().defaults.baseURL;
-	const metadataUrl = new URL(
-		`${url}/api/v2/workspaceagents/${agentId}/watch-metadata`,
-	);
-	const eventSource = new EventSource(metadataUrl.toString(), {
-		fetch: createStreamingFetchAdapter(restClient.getAxiosInstance()),
-	});
+	const socket = client.watchAgentMetadata(agentId);
 
 	let disposed = false;
 	const onChange = new vscode.EventEmitter<null>();
 	const watcher: AgentMetadataWatcher = {
 		onChange: onChange.event,
 		dispose: () => {
 			if (!disposed) {
-				eventSource.close();
+				socket.close();
 				disposed = true;
 			}
 		},
 	};
 
-	eventSource.addEventListener("data", (event) => {
+	const handleError = (error: unknown) => {
+		watcher.error = error;
+		onChange.fire(null);
+	};
+
+	socket.addEventListener("message", (event) => {
 		try {
-			const dataEvent = JSON.parse(event.data);
-			const metadata = AgentMetadataEventSchemaArray.parse(dataEvent);
+			if (event.parseError) {
+				handleError(event.parseError);
+				return;
+			}
+
+			const metadata = AgentMetadataEventSchemaArray.parse(
+				event.parsedMessage.data,
+			);
 
 			// Overwrite metadata if it changed.
 			if (JSON.stringify(watcher.metadata) !== JSON.stringify(metadata)) {
 				watcher.metadata = metadata;
 				onChange.fire(null);
 			}
 		} catch (error) {
-			watcher.error = error;
-			onChange.fire(null);
+			handleError(error);
+		}
+	});
+
+	socket.addEventListener("error", handleError);
+
+	socket.addEventListener("close", (event) => {
+		if (event.code !== 1000) {
+			handleError(
+				new Error(
+					`WebSocket closed unexpectedly: ${event.code} ${event.reason}`,
+				),
+			);
 		}
 	});