From e718c3ab2f22575dedbdf018078e9c64b6c3a71d Mon Sep 17 00:00:00 2001
From: Jaayden Halko <jaayden.halko@gmail.com>
Date: Fri, 2 May 2025 00:02:34 +0100
Subject: [PATCH] fix: improve WebSocket error handling in
 CreateWorkspacePageExperimental (#17647)

Refactor WebSocket error handling to ensure that errors are only set
when the current socket ref matches the active one. This prevents
unnecessary error messages when the WebSocket connection closes
unexpectedly

This solves the problem of showing error messages because of React
Strict mode rendering the page twice and opening 2 websocket
connections.
---
 .../CreateWorkspacePageExperimental.tsx       | 23 ++++++++++---------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/site/src/pages/CreateWorkspacePage/CreateWorkspacePageExperimental.tsx b/site/src/pages/CreateWorkspacePage/CreateWorkspacePageExperimental.tsx
index e52a50dda0..ae31ab2503 100644
--- a/site/src/pages/CreateWorkspacePage/CreateWorkspacePageExperimental.tsx
+++ b/site/src/pages/CreateWorkspacePage/CreateWorkspacePageExperimental.tsx
@@ -95,9 +95,7 @@ const CreateWorkspacePageExperimental: FC = () => {
 
 	// Initialize the WebSocket connection when there is a valid template version ID
 	useEffect(() => {
-		if (!realizedVersionId) {
-			return;
-		}
+		if (!realizedVersionId) return;
 
 		const socket = API.templateVersionDynamicParameters(
 			owner.id,
@@ -105,16 +103,19 @@ const CreateWorkspacePageExperimental: FC = () => {
 			{
 				onMessage,
 				onError: (error) => {
-					setWsError(error);
+					if (ws.current === socket) {
+						setWsError(error);
+					}
 				},
 				onClose: () => {
-					// There is no reason for the websocket to close while a user is on the page
-					setWsError(
-						new DetailedError(
-							"Websocket connection for dynamic parameters unexpectedly closed.",
-							"Refresh the page to reset the form.",
-						),
-					);
+					if (ws.current === socket) {
+						setWsError(
+							new DetailedError(
+								"Websocket connection for dynamic parameters unexpectedly closed.",
+								"Refresh the page to reset the form.",
+							),
+						);
+					}
 				},
 			},
 		);