chore: add test stubs

Parkreiner · Parkreiner · commit 387affac0a71 · 2025-02-27T16:42:54.000Z
diff --git a/coderd/httpapi/httpapi.go b/coderd/httpapi/httpapi.go
@@ -289,8 +289,8 @@ func WebsocketCloseSprintf(format string, vars ...any) string {
 // open a workspace in multiple tabs, the entire UI can start to lock up.
 // WebSockets have no such limitation, no matter what HTTP protocol was used to
 // establish the connection.
-func OneWayWebSocket[T any](rw http.ResponseWriter, r *http.Request) (
-	sendEvent func(wsEvent T) error,
+func OneWayWebSocket[JsonSerializable any](rw http.ResponseWriter, r *http.Request) (
+	sendEvent func(event JsonSerializable) error,
 	closed chan struct{},
 	err error,
 ) {
@@ -307,7 +307,7 @@ func OneWayWebSocket[T any](rw http.ResponseWriter, r *http.Request) (
 		Code   websocket.StatusCode
 		Reason string
 	}
-	eventC := make(chan T)
+	eventC := make(chan JsonSerializable)
 	socketErrC := make(chan SocketError, 1)
 	closed = make(chan struct{})
 	go func() {
@@ -354,7 +354,7 @@ func OneWayWebSocket[T any](rw http.ResponseWriter, r *http.Request) (
 		}
 	}()
 
-	sendEvent = func(event T) error {
+	sendEvent = func(event JsonSerializable) error {
 		select {
 		case eventC <- event:
 		case <-ctx.Done():
diff --git a/coderd/httpapi/httpapi_test.go b/coderd/httpapi/httpapi_test.go
@@ -155,3 +155,35 @@ func TestWebsocketCloseMsg(t *testing.T) {
 		assert.Equal(t, len(trunc), 123)
 	})
 }
+
+func TestOneWayWebSocket(t *testing.T) {
+	t.Parallel()
+
+	t.Run("Produces an error if the socket connection could not be established", func(t *testing.T) {
+		t.Parallel()
+	})
+
+	t.Run("Returned callback can publish a new event to the WebSocket connection", func(t *testing.T) {
+		t.Parallel()
+	})
+
+	t.Run("Signals to an outside consumer when the socket has been closed", func(t *testing.T) {
+		t.Parallel()
+	})
+
+	t.Run("Socket will automatically close if client sends a single message", func(t *testing.T) {
+		t.Parallel()
+	})
+
+	t.Run("Returned callback returns error if called after socket has been closed", func(t *testing.T) {
+		t.Parallel()
+	})
+
+	t.Run("Sends a heartbeat to the socket on a fixed internal of time to keep connections alive", func(t *testing.T) {
+		t.Parallel()
+	})
+
+	t.Run("Renders the socket inert if the parent context cancels", func(t *testing.T) {
+		t.Parallel()
+	})
+}
