Mar 28, 2025 · Mar 7, 2025 · Mar 7, 2025 · Mar 7, 2025 · Mar 7, 2025 · Mar 7, 2025
diff --git a/site/package.json b/site/package.json
 "@vitejs/plugin-react": "4.3.4",
 "autoprefixer": "10.4.20",
 "chromatic": "11.25.2",
 "eventsourcemock": "2.0.0",
 "express": "4.21.2",
 "jest": "29.7.0",
 "jest-canvas-mock": "2.5.2",
diff --git a/site/pnpm-lock.yaml b/site/pnpm-lock.yaml
diff --git a/site/src/@types/eventsourcemock.d.ts b/site/src/@types/eventsourcemock.d.ts
diff --git a/site/src/api/api.ts b/site/src/api/api.ts
 import globalAxios, { type AxiosInstance, isAxiosError } from "axios";
 import type dayjs from "dayjs";
 import userAgentParser from "ua-parser-js";
 import { OneWayWebSocket } from "utils/OneWayWebSocket";
 import { delay } from "../utils/delay";
 import * as TypesGen from "./typesGenerated";
 import type { PostWorkspaceUsageRequest } from "./typesGenerated";
 import * as TypesGen from "./typesGenerated";

 const getMissingParameters = (
 oldBuildParameters: TypesGen.WorkspaceBuildParameter[],
 };

 /**
 *
 * @param agentId
 * @returns An EventSource that emits agent metadata event objects
 * (ServerSentEvent)
 * @returns {OneWayWebSocket} A OneWayWebSocket that emits Server-Sent Events.
 */
 export const watchAgentMetadata = (agentId: string): EventSource => {
 return new EventSource(
 `${location.protocol}//${location.host}/api/v2/workspaceagents/${agentId}/watch-metadata`,
 { withCredentials: true },
 );
 export const watchAgentMetadata = (
 agentId: string,
 ): OneWayWebSocket<TypesGen.ServerSentEvent> => {
 return new OneWayWebSocket({
 apiRoute: `/api/v2/workspaceagents/${agentId}/watch-metadata-ws`,
 });
 };

 /**
 * @returns {EventSource} An EventSource that emits workspace event objects
 * (ServerSentEvent)
 * @returns {OneWayWebSocket} A OneWayWebSocket that emits Server-Sent Events.
 */
 export const watchWorkspace = (workspaceId: string): EventSource => {
 return new EventSource(
 `${location.protocol}//${location.host}/api/v2/workspaces/${workspaceId}/watch`,
 { withCredentials: true },
 );
 export const watchWorkspace = (
 workspaceId: string,
 ): OneWayWebSocket<TypesGen.ServerSentEvent> => {
 return new OneWayWebSocket({
 apiRoute: `/api/v2/workspaces/${workspaceId}/watch-ws`,
 });
 };

 type WatchInboxNotificationsParams = {
 type WatchInboxNotificationsParams =Readonly<{
 read_status?: "read" | "unread" | "all";
 };
 }>;

 export const watchInboxNotifications = (
 onNewNotification: (res: TypesGen.GetInboxNotificationResponse) => void,
 export function watchInboxNotifications(
 params?: WatchInboxNotificationsParams,
 ) => {
 const searchParams = new URLSearchParams(params);
 const socket = createWebSocket(
 "/api/v2/notifications/inbox/watch",
 searchParams,
 );

 socket.addEventListener("message", (event) => {
 try {
 const res = JSON.parse(
 event.data,
 ) as TypesGen.GetInboxNotificationResponse;
 onNewNotification(res);
 } catch (error) {
 console.warn("Error parsing inbox notification: ", error);
 }
 });

 socket.addEventListener("error", (event) => {
 console.warn("Watch inbox notifications error: ", event);
 socket.close();
 ): OneWayWebSocket<TypesGen.GetInboxNotificationResponse> {
 return new OneWayWebSocket({
 apiRoute: "/api/v2/notifications/inbox/watch",
 searchParams: params,
 });

 return socket;
 };
 }

 export const getURLWithSearchParams = (
 basePath: string,
 };

 getWorkspaceByOwnerAndName = async (
 username = "me",
 username: string,
 workspaceName: string,
 params?: TypesGen.WorkspaceOptions,
 ): Promise<TypesGen.Workspace> => {
 };

 getWorkspaceBuildByNumber = async (
 username = "me",
 username: string,
 workspaceName: string,
 buildNumber: number,
 ): Promise<TypesGen.WorkspaceBuild> => {
 };

 createWorkspace = async (
 userId = "me",
 userId: string,
 workspace: TypesGen.CreateWorkspaceRequest,
 ): Promise<TypesGen.Workspace> => {
 const response = await this.axios.post<TypesGen.Workspace>(
 ) {
 const protocol = location.protocol === "https:" ? "wss:" : "ws:";
 const socket = new WebSocket(
 `${protocol}//${location.host}${path}?${params.toString()}`,
 `${protocol}//${location.host}${path}?${params}`,
 );
 socket.binaryType = "blob";
 return socket;
diff --git a/site/src/modules/notifications/NotificationsInbox/NotificationsInbox.tsx b/site/src/modules/notifications/NotificationsInbox/NotificationsInbox.tsx
 );

 useEffect(() => {
 const socket = watchInboxNotifications(
 (res) => {
 updateNotificationsCache((prev) => {
 return {
 unread_count: res.unread_count,
 notifications: [res.notification, ...prev.notifications],
 };
 });
 },
 { read_status: "unread" },
 );
 const socket = watchInboxNotifications({ read_status: "unread" });

 return () => {
 socket.addEventListener("message", (e) => {
 if (e.parseError) {
 console.warn("Error parsing inbox notification: ", e.parseError);
 return;
 }

 const msg = e.parsedMessage;
 updateNotificationsCache((current) => {
 return {
 unread_count: msg.unread_count,
 notifications: [msg.notification, ...current.notifications],
 };
 });
 });

 socket.addEventListener("error", () => {
 displayError(
 "Unable to retrieve latest inbox notifications. Please try refreshing the browser.",
 );
 socket.close();
 };
 });

 return () => socket.close();
 }, [updateNotificationsCache]);

 const {
diff --git a/site/src/modules/resources/AgentMetadata.tsx b/site/src/modules/resources/AgentMetadata.tsx
 import Tooltip from "@mui/material/Tooltip";
 import { watchAgentMetadata } from "api/api";
 import type {
 ServerSentEvent,
 WorkspaceAgent,
 WorkspaceAgentMetadata,
 } from "api/typesGenerated";
 import { displayError } from "components/GlobalSnackbar/utils";
 import { Stack } from "components/Stack/Stack";
 import dayjs from "dayjs";
 import {
 useState,
 } from "react";
 import { MONOSPACE_FONT_FAMILY } from "theme/constants";
 import type { OneWayWebSocket } from "utils/OneWayWebSocket";

 type ItemStatus = "stale" | "valid" | "loading";

 storybookMetadata?: WorkspaceAgentMetadata[];
 }

 const maxSocketErrorRetryCount = 3;

 export const AgentMetadata: FC<AgentMetadataProps> = ({
 agent,
 storybookMetadata,
 }) => {
 const [metadata, setMetadata] = useState<
 WorkspaceAgentMetadata[] | undefined
 >(undefined);

 const [activeMetadata, setActiveMetadata] = useState(storybookMetadata);
 useEffect(() => {
 // This is an unfortunate pitfall with this component's testing setup,
 // but even though we use the value of storybookMetadata as the initial
 // value of the activeMetadata, we cannot put activeMetadata itself into
 // the dependency array. If we did, we would destroy and rebuild each
 // connection every single time a new message comes in from the socket,
 // because the socket has to be wired up to the state setter
 if (storybookMetadata !== undefined) {
 setMetadata(storybookMetadata);
 return;
 }

 let timeout: ReturnType<typeof setTimeout> | undefined = undefined;

 const connect = (): (() => void) => {
 const source = watchAgentMetadata(agent.id);
 let timeoutId: number | undefined = undefined;
 let activeSocket: OneWayWebSocket<ServerSentEvent> | null = null;
 let retries = 0;

 const createNewConnection = () => {
 const socket = watchAgentMetadata(agent.id);
 activeSocket = socket;

 socket.addEventListener("error", () => {
 setActiveMetadata(undefined);
 window.clearTimeout(timeoutId);

 // The error event is supposed to fire when an error happens
 // with the connection itself, which implies that the connection
 // would auto-close. Couldn't find a definitive answer on MDN,
 // though, so closing it manually just to be safe
 socket.close();
 activeSocket = null;

 retries++;
 if (retries >= maxSocketErrorRetryCount) {
 displayError(
 "Unexpected disconnect while watching Metadata changes. Please try refreshing the page.",
 );
 return;
 }

 source.onerror = (e) => {
 console.error("received error in watch stream", e);
 setMetadata(undefined);
 source.close();
 displayError(
 "Unexpected disconnect while watching Metadata changes. Creating new connection...",
 );
 timeoutId = window.setTimeout(() => {
 createNewConnection();
 }, 3_000);
 });

 timeout = setTimeout(() => {
 connect();
 }, 3000);
 };
 socket.addEventListener("message", (e) => {
 if (e.parseError) {
 displayError(
 "Unable to process newest response from server. Please try refreshing the page.",
 );
 return;
 }

 source.addEventListener("data", (e) => {
 const data = JSON.parse(e.data);
 setMetadata(data);
 });
 return () => {
 if (timeout !== undefined) {
 clearTimeout(timeout);
 const msg = e.parsedMessage;
 if (msg.type === "data") {
 setActiveMetadata(msg.data as WorkspaceAgentMetadata[]);
 }
 source.close();
 };
 });
 };

 createNewConnection();
 return () => {
 window.clearTimeout(timeoutId);
 activeSocket?.close();
 };
 return connect();
 }, [agent.id, storybookMetadata]);

 if (metadata === undefined) {
 if (activeMetadata === undefined) {
 return (
 <section css={styles.root}>
 <AgentMetadataSkeleton />
 </section>
 );
 }

 return <AgentMetadataView metadata={metadata} />;
 return <AgentMetadataView metadata={activeMetadata} />;
 };

 export const AgentMetadataSkeleton: FC = () => {
Original file line number	Diff line number	Diff line change
Expand Up		@@ -166,7 +166,6 @@
		"@vitejs/plugin-react": "4.3.4",
		"autoprefixer": "10.4.20",
		"chromatic": "11.25.2",
		"eventsourcemock": "2.0.0",
		"express": "4.21.2",
		"jest": "29.7.0",
		"jest-canvas-mock": "2.5.2",
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -22,9 +22,10 @@
		import globalAxios, { type AxiosInstance, isAxiosError } from "axios";
		import type dayjs from "dayjs";
		import userAgentParser from "ua-parser-js";
		import { OneWayWebSocket } from "utils/OneWayWebSocket";
		import { delay } from "../utils/delay";
		import * as TypesGen from "./typesGenerated";
		import type { PostWorkspaceUsageRequest } from "./typesGenerated";
		import * as TypesGen from "./typesGenerated";

		const getMissingParameters = (
		oldBuildParameters: TypesGen.WorkspaceBuildParameter[],
Expand DownExpand Up		@@ -101,61 +102,40 @@ const getMissingParameters = (
		};

		/**
		*
		* @param agentId
		* @returns An EventSource that emits agent metadata event objects
		* (ServerSentEvent)
		* @returns {OneWayWebSocket} A OneWayWebSocket that emits Server-Sent Events.
		*/
		export const watchAgentMetadata = (agentId: string): EventSource => {
		return new EventSource(
		`${location.protocol}//${location.host}/api/v2/workspaceagents/${agentId}/watch-metadata`,
		{ withCredentials: true },
		);
		export const watchAgentMetadata = (
		agentId: string,
		): OneWayWebSocket<TypesGen.ServerSentEvent> => {
Copy link MemberAuthor ParkreinerMar 12, 2025• edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Sadly, this is the best we can do as far as giving ourselves type-safety (without updating GUTS). It'll be less of an issue for WebSocket connections that don't send SSE-formatted events, but the ServerSentEvent type is structured like this: // From codersdk/serversentevents.goexportinterfaceServerSentEvent{readonlytype:ServerSentEventType;// empty interface{} type, falling back to unknownreadonlydata:unknown;} There's no way to pass a type parameter to the type and make`data` more specific
		return new OneWayWebSocket({
		apiRoute: `/api/v2/workspaceagents/${agentId}/watch-metadata-ws`,
		});
		};

		/**
		* @returns {EventSource} An EventSource that emits workspace event objects
		* (ServerSentEvent)
		* @returns {OneWayWebSocket} A OneWayWebSocket that emits Server-Sent Events.
		*/
		export const watchWorkspace = (workspaceId: string): EventSource => {
		return new EventSource(
		`${location.protocol}//${location.host}/api/v2/workspaces/${workspaceId}/watch`,
		{ withCredentials: true },
		);
		export const watchWorkspace = (
		workspaceId: string,
		): OneWayWebSocket<TypesGen.ServerSentEvent> => {
		return new OneWayWebSocket({
		apiRoute: `/api/v2/workspaces/${workspaceId}/watch-ws`,
		});
		};

		type WatchInboxNotificationsParams = {
		type WatchInboxNotificationsParams =Readonly<{
		read_status?: "read" \| "unread" \| "all";
		};
		}>;

		export const watchInboxNotifications = (
		onNewNotification: (res: TypesGen.GetInboxNotificationResponse) => void,
		export function watchInboxNotifications(
		params?: WatchInboxNotificationsParams,
		) => {
		const searchParams = new URLSearchParams(params);
		const socket = createWebSocket(
		"/api/v2/notifications/inbox/watch",
		searchParams,
		);

		socket.addEventListener("message", (event) => {
		try {
		const res = JSON.parse(
		event.data,
		) as TypesGen.GetInboxNotificationResponse;
		onNewNotification(res);
		} catch (error) {
		console.warn("Error parsing inbox notification: ", error);
		}
		});

		socket.addEventListener("error", (event) => {
		console.warn("Watch inbox notifications error: ", event);
		socket.close();
		): OneWayWebSocket<TypesGen.GetInboxNotificationResponse> {
		return new OneWayWebSocket({
		apiRoute: "/api/v2/notifications/inbox/watch",
		searchParams: params,
		});

		return socket;
		};
		}

		export const getURLWithSearchParams = (
		basePath: string,
Expand DownExpand Up		@@ -1125,7 +1105,7 @@ class ApiMethods {
		};

		getWorkspaceByOwnerAndName = async (
		username = "me",
		username: string,
Copy link MemberAuthor ParkreinerMar 7, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Biome was complaining about having default parameters not be at the end of the function signature, but also, we were never calling these functions with an explicit value of`undefined`
		workspaceName: string,
		params?: TypesGen.WorkspaceOptions,
		): Promise<TypesGen.Workspace> => {
Expand All		@@ -1138,7 +1118,7 @@ class ApiMethods {
		};

		getWorkspaceBuildByNumber = async (
		username = "me",
		username: string,
		workspaceName: string,
		buildNumber: number,
		): Promise<TypesGen.WorkspaceBuild> => {
Expand DownExpand Up		@@ -1324,7 +1304,7 @@ class ApiMethods {
		};

		createWorkspace = async (
		userId = "me",
		userId: string,
		workspace: TypesGen.CreateWorkspaceRequest,
		): Promise<TypesGen.Workspace> => {
		const response = await this.axios.post<TypesGen.Workspace>(
Expand DownExpand Up		@@ -2542,7 +2522,7 @@ function createWebSocket(
		) {
		const protocol = location.protocol === "https:" ? "wss:" : "ws:";
		const socket = new WebSocket(
		`${protocol}//${location.host}${path}?${params.toString()}`,
		`${protocol}//${location.host}${path}?${params}`,
		);
		socket.binaryType = "blob";
		return socket;
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -61,21 +61,31 @@ export const NotificationsInbox: FC<NotificationsInboxProps> = ({
		);

		useEffect(() => {
		const socket = watchInboxNotifications(
		(res) => {
		updateNotificationsCache((prev) => {
		return {
		unread_count: res.unread_count,
		notifications: [res.notification, ...prev.notifications],
		};
		});
		},
		{ read_status: "unread" },
		);
		const socket = watchInboxNotifications({ read_status: "unread" });

		return () => {
		socket.addEventListener("message", (e) => {
		if (e.parseError) {
		console.warn("Error parsing inbox notification: ", e.parseError);
		return;
		}

		const msg = e.parsedMessage;
		updateNotificationsCache((current) => {
		return {
		unread_count: msg.unread_count,
		notifications: [msg.notification, ...current.notifications],
		};
		});
		});

		socket.addEventListener("error", () => {
		displayError(
		"Unable to retrieve latest inbox notifications. Please try refreshing the browser.",
		);
		socket.close();
		};
		});

		return () => socket.close();
		}, [updateNotificationsCache]);

		const {
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,9 +3,11 @@ import Skeleton from "@mui/material/Skeleton";
		import Tooltip from "@mui/material/Tooltip";
		import { watchAgentMetadata } from "api/api";
		import type {
		ServerSentEvent,
		WorkspaceAgent,
		WorkspaceAgentMetadata,
		} from "api/typesGenerated";
		import { displayError } from "components/GlobalSnackbar/utils";
		import { Stack } from "components/Stack/Stack";
		import dayjs from "dayjs";
		import {
Expand All		@@ -17,6 +19,7 @@ import {
		useState,
		} from "react";
		import { MONOSPACE_FONT_FAMILY } from "theme/constants";
		import type { OneWayWebSocket } from "utils/OneWayWebSocket";

		type ItemStatus = "stale" \| "valid" \| "loading";

Expand All		@@ -42,58 +45,90 @@ interface AgentMetadataProps {
		storybookMetadata?: WorkspaceAgentMetadata[];
		}

		const maxSocketErrorRetryCount = 3;

		export const AgentMetadata: FC<AgentMetadataProps> = ({
		agent,
		storybookMetadata,
		}) => {
		const [metadata, setMetadata] = useState<
		WorkspaceAgentMetadata[] \| undefined
		>(undefined);

		const [activeMetadata, setActiveMetadata] = useState(storybookMetadata);
		useEffect(() => {
		// This is an unfortunate pitfall with this component's testing setup,
		// but even though we use the value of storybookMetadata as the initial
		// value of the activeMetadata, we cannot put activeMetadata itself into
		// the dependency array. If we did, we would destroy and rebuild each
		// connection every single time a new message comes in from the socket,
		// because the socket has to be wired up to the state setter
		if (storybookMetadata !== undefined) {
		setMetadata(storybookMetadata);
Copy link MemberAuthor ParkreinerMar 12, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. This was removed because it introduces unnecessary renders – better to just use`storybookMetadata` as the initial value for the state and avoid a bunch of state syncs
		return;
		}

		let timeout: ReturnType<typeof setTimeout> \| undefined = undefined;

		const connect = (): (() => void) => {
		const source = watchAgentMetadata(agent.id);
		let timeoutId: number \| undefined = undefined;
		let activeSocket: OneWayWebSocket<ServerSentEvent> \| null = null;
		let retries = 0;

		const createNewConnection = () => {
Copy link MemberAuthor ParkreinerMar 7, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. The previous`create` function was super weird because it was responsible for three things Creating a new WebSocket connection from the outside effect Being able to create new connections by calling itself recursively Also acting as a`useEffect` cleanup function Figured it'd be better to split up those responsibilities
		const socket = watchAgentMetadata(agent.id);
		activeSocket = socket;

		socket.addEventListener("error", () => {
		setActiveMetadata(undefined);
		window.clearTimeout(timeoutId);

		// The error event is supposed to fire when an error happens
		// with the connection itself, which implies that the connection
		// would auto-close. Couldn't find a definitive answer on MDN,
		// though, so closing it manually just to be safe
		socket.close();
		activeSocket = null;

		retries++;
		if (retries >= maxSocketErrorRetryCount) {
		displayError(
		"Unexpected disconnect while watching Metadata changes. Please try refreshing the page.",
		);
		return;
		}

		source.onerror = (e) => {
		console.error("received error in watch stream", e);
		setMetadata(undefined);
		source.close();
		displayError(
		"Unexpected disconnect while watching Metadata changes. Creating new connection...",
		);
		timeoutId = window.setTimeout(() => {
		createNewConnection();
		}, 3_000);
		});

		timeout = setTimeout(() => {
		connect();
		}, 3000);
		};
		socket.addEventListener("message", (e) => {
		if (e.parseError) {
		displayError(
		"Unable to process newest response from server. Please try refreshing the page.",
		);
		return;
		}

		source.addEventListener("data", (e) => {
		const data = JSON.parse(e.data);
		setMetadata(data);
		});
		return () => {
		if (timeout !== undefined) {
		clearTimeout(timeout);
		const msg = e.parsedMessage;
		if (msg.type === "data") {
		setActiveMetadata(msg.data as WorkspaceAgentMetadata[]);
		}
		source.close();
		};
		});
		};

		createNewConnection();
		return () => {
		window.clearTimeout(timeoutId);
		activeSocket?.close();
		};
		return connect();
		}, [agent.id, storybookMetadata]);

		if (metadata === undefined) {
		if (activeMetadata === undefined) {
		return (
		<section css={styles.root}>
		<AgentMetadataSkeleton />
		</section>
		);
		}

		return <AgentMetadataView metadata={metadata} />;
		return <AgentMetadataView metadata={activeMetadata} />;
		};

		export const AgentMetadataSkeleton: FC = () => {
Expand Down