chore: swap API calls to OWWS

Parkreiner · Parkreiner · commit da96d231457b · 2025-02-24T19:57:22.000Z
diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -25,6 +25,7 @@ import userAgentParser from "ua-parser-js";
 import { delay } from "../utils/delay";
 import * as TypesGen from "./typesGenerated";
 import type { PostWorkspaceUsageRequest } from "./typesGenerated";
+import { OneWayWebSocket } from "utils/OneWayWebSocket";
 
 const getMissingParameters = (
 	oldBuildParameters: TypesGen.WorkspaceBuildParameter[],
@@ -101,26 +102,22 @@ const getMissingParameters = (
 };
 
 /**
- *
  * @param agentId
- * @returns An EventSource that emits agent metadata event objects
- * (ServerSentEvent)
+ * @returns A one-way WebSocket that receives agent metadata events
  */
-export const watchAgentMetadata = (agentId: string): EventSource => {
-	return new EventSource(
+export const watchAgentMetadata = (agentId: string): OneWayWebSocket => {
+	return new OneWayWebSocket(
 		`${location.protocol}//${location.host}/api/v2/workspaceagents/${agentId}/watch-metadata`,
-		{ withCredentials: true },
 	);
 };
 
 /**
- * @returns {EventSource} An EventSource that emits workspace event objects
- * (ServerSentEvent)
+ * @param workspaceId
+ * @returns A one-way WebSocket that receives workspace events
  */
-export const watchWorkspace = (workspaceId: string): EventSource => {
-	return new EventSource(
+export const watchWorkspace = (workspaceId: string): OneWayWebSocket => {
+	return new OneWayWebSocket(
 		`${location.protocol}//${location.host}/api/v2/workspaces/${workspaceId}/watch`,
-		{ withCredentials: true },
 	);
 };
 
diff --git a/site/src/utils/OneWayWebSocket.test.ts b/site/src/utils/OneWayWebSocket.test.ts
@@ -0,0 +1,13 @@
+/**
+ * Should probably bring in MSW to test the communication
+ *
+ * Qualities to test:
+ * 1. When an event (open, close, error, message) triggers, any registered
+ *    callbacks are called with a new event payload
+ * 2. Lets user remove event listeners, as long as they provide a callback
+ * 3. Is able to register multiple listeners for the same event type
+ * 4. Lets user close a connection from the client side
+ *
+ * These aren't super high-priority right now, but if the definition ever
+ * changes, it'd be good to have these as safety nets
+ */
