- Notifications
You must be signed in to change notification settings - Fork1k
fix(coderd): ensure agent WebSocket conn is cleaned up#19711
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
DanielleMaywood merged 4 commits intomainfromdanielle/devcontainers/handle-websocket-conn-cleanupSep 5, 2025
+144 −6
Merged
Changes from1 commit
Commits
Show all changes
4 commits Select commitHold shift + click to select a range
35a7440 fix(coderd): ensure agent WebSocket conn is cleaned up
DanielleMaywood5997a47 chore: rename the cancel functions
DanielleMaywoodc881ccb chore: move `Heartbeat` back to original position
DanielleMaywood1c4204c chore: move `context.WithCancel` call later
DanielleMaywoodFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
12 changes: 7 additions & 5 deletionscoderd/workspaceagents.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -815,10 +815,13 @@ func (api *API) workspaceAgentListeningPorts(rw http.ResponseWriter, r *http.Req | ||
| // @Router /workspaceagents/{workspaceagent}/containers/watch [get] | ||
| func (api*API)watchWorkspaceAgentContainers(rw http.ResponseWriter,r*http.Request) { | ||
| var ( | ||
| workspaceAgent=httpmw.WorkspaceAgentParam(r) | ||
| logger=api.Logger.Named("agent_container_watcher").With(slog.F("agent_id",workspaceAgent.ID)) | ||
| ) | ||
| ctx,cancelCtx:=context.WithCancel(r.Context()) | ||
| defercancelCtx() | ||
DanielleMaywood marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| // If the agent is unreachable, the request will hang. Assume that if we | ||
| // don't get a response after 30s that the agent is unreachable. | ||
| dialCtx,cancel:=context.WithTimeout(ctx,30*time.Second) | ||
| @@ -857,8 +860,7 @@ func (api *API) watchWorkspaceAgentContainers(rw http.ResponseWriter, r *http.Re | ||
| } | ||
| deferrelease() | ||
| containersCh,closer,err:=agentConn.WatchContainers(ctx,logger) | ||
| iferr!=nil { | ||
| httpapi.Write(ctx,rw,http.StatusInternalServerError, codersdk.Response{ | ||
| Message:"Internal error watching agent's containers.", | ||
| @@ -881,11 +883,11 @@ func (api *API) watchWorkspaceAgentContainers(rw http.ResponseWriter, r *http.Re | ||
| // close frames. | ||
| _=conn.CloseRead(context.Background()) | ||
| gohttpapi.HeartbeatClose(ctx,logger,cancelCtx,conn) | ||
DanielleMaywood marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| ctx,wsNetConn:=codersdk.WebsocketNetConn(ctx,conn,websocket.MessageText) | ||
| deferwsNetConn.Close() | ||
| encoder:=json.NewEncoder(wsNetConn) | ||
| for { | ||
137 changes: 136 additions & 1 deletioncoderd/workspaceagents_internal_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -59,10 +59,145 @@ func (fakeAgentProvider) Close() error { | ||
| returnnil | ||
| } | ||
| typechannelCloserstruct { | ||
| closeFnfunc() | ||
| } | ||
| func (c*channelCloser)Close()error { | ||
| c.closeFn() | ||
| returnnil | ||
| } | ||
| funcTestWatchAgentContainers(t*testing.T) { | ||
| t.Parallel() | ||
| t.Run("CoderdWebSocketCanHandleClientClosing",func(t*testing.T) { | ||
| t.Parallel() | ||
| // This test ensures that the agent containers `/watch` websocket can gracefully | ||
| // handle the client websocket closing. This test was created in | ||
| // response to this issue: https://github.com/coder/coder/issues/19449 | ||
| var ( | ||
| ctx=testutil.Context(t,testutil.WaitLong) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Unfortunately this test uses There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. That's unfortunate 😔. Perhaps we should have a There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I definitely agree although I think that is out-of-scope for this PR. Should we create an issue to track that? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. We could do something like typeHeartbeatOptionfunc(...)funcWithHeartbeatInterval(d time.Duration)HeartbeatOptionfuncHeartbeat(ctx context.Context,conn*websocket.Conn,opts...HeartbeatOption) {...} It might be worthwhile also unexporting | ||
| logger=slogtest.Make(t,&slogtest.Options{IgnoreErrors:true}).Leveled(slog.LevelDebug).Named("coderd") | ||
| mCtrl=gomock.NewController(t) | ||
| mDB=dbmock.NewMockStore(mCtrl) | ||
| mCoordinator=tailnettest.NewMockCoordinator(mCtrl) | ||
| mAgentConn=agentconnmock.NewMockAgentConn(mCtrl) | ||
| fAgentProvider=fakeAgentProvider{ | ||
| agentConn:func(ctx context.Context,agentID uuid.UUID) (_ workspacesdk.AgentConn,releasefunc(),_error) { | ||
| returnmAgentConn,func() {},nil | ||
| }, | ||
| } | ||
| workspaceID=uuid.New() | ||
| agentID=uuid.New() | ||
| resourceID=uuid.New() | ||
| jobID=uuid.New() | ||
| buildID=uuid.New() | ||
| containersCh=make(chan codersdk.WorkspaceAgentListContainersResponse) | ||
| r=chi.NewMux() | ||
| api=API{ | ||
| ctx:ctx, | ||
| Options:&Options{ | ||
| AgentInactiveDisconnectTimeout:testutil.WaitShort, | ||
| Database:mDB, | ||
| Logger:logger, | ||
| DeploymentValues:&codersdk.DeploymentValues{}, | ||
| TailnetCoordinator:tailnettest.NewFakeCoordinator(), | ||
| }, | ||
| } | ||
| ) | ||
| vartailnetCoordinator tailnet.Coordinator=mCoordinator | ||
| api.TailnetCoordinator.Store(&tailnetCoordinator) | ||
| api.agentProvider=fAgentProvider | ||
| // Setup: Allow `ExtractWorkspaceAgentParams` to complete. | ||
| mDB.EXPECT().GetWorkspaceAgentByID(gomock.Any(),agentID).Return(database.WorkspaceAgent{ | ||
| ID:agentID, | ||
| ResourceID:resourceID, | ||
| LifecycleState:database.WorkspaceAgentLifecycleStateReady, | ||
| FirstConnectedAt: sql.NullTime{Valid:true,Time:dbtime.Now()}, | ||
| LastConnectedAt: sql.NullTime{Valid:true,Time:dbtime.Now()}, | ||
| },nil) | ||
| mDB.EXPECT().GetWorkspaceResourceByID(gomock.Any(),resourceID).Return(database.WorkspaceResource{ | ||
| ID:resourceID, | ||
| JobID:jobID, | ||
| },nil) | ||
| mDB.EXPECT().GetProvisionerJobByID(gomock.Any(),jobID).Return(database.ProvisionerJob{ | ||
| ID:jobID, | ||
| Type:database.ProvisionerJobTypeWorkspaceBuild, | ||
| },nil) | ||
| mDB.EXPECT().GetWorkspaceBuildByJobID(gomock.Any(),jobID).Return(database.WorkspaceBuild{ | ||
| WorkspaceID:workspaceID, | ||
| ID:buildID, | ||
| },nil) | ||
| // And: Allow `db2dsk.WorkspaceAgent` to complete. | ||
| mCoordinator.EXPECT().Node(gomock.Any()).Return(nil) | ||
| // And: Allow `WatchContainers` to be called, returing our `containersCh` channel. | ||
| mAgentConn.EXPECT().WatchContainers(gomock.Any(),gomock.Any()). | ||
| DoAndReturn(func(_ context.Context,_ slog.Logger) (<-chan codersdk.WorkspaceAgentListContainersResponse, io.Closer,error) { | ||
| returncontainersCh,&channelCloser{closeFn:func() { | ||
| close(containersCh) | ||
| }},nil | ||
| }) | ||
| // And: We mount the HTTP Handler | ||
| r.With(httpmw.ExtractWorkspaceAgentParam(mDB)). | ||
| Get("/workspaceagents/{workspaceagent}/containers/watch",api.watchWorkspaceAgentContainers) | ||
| // Given: We create the HTTP server | ||
| srv:=httptest.NewServer(r) | ||
| defersrv.Close() | ||
| // And: Dial the WebSocket | ||
| wsURL:=strings.Replace(srv.URL,"http://","ws://",1) | ||
| conn,resp,err:=websocket.Dial(ctx,fmt.Sprintf("%s/workspaceagents/%s/containers/watch",wsURL,agentID),nil) | ||
| require.NoError(t,err) | ||
| ifresp.Body!=nil { | ||
| deferresp.Body.Close() | ||
| } | ||
| // And: Create a streaming decoder | ||
| decoder:=wsjson.NewDecoder[codersdk.WorkspaceAgentListContainersResponse](conn,websocket.MessageText,logger) | ||
| deferdecoder.Close() | ||
| decodeCh:=decoder.Chan() | ||
| // And: We can successfully send through the channel. | ||
| testutil.RequireSend(ctx,t,containersCh, codersdk.WorkspaceAgentListContainersResponse{ | ||
| Containers: []codersdk.WorkspaceAgentContainer{{ | ||
| ID:"test-container-id", | ||
| }}, | ||
| }) | ||
| // And: Receive the data. | ||
| containerResp:=testutil.RequireReceive(ctx,t,decodeCh) | ||
| require.Len(t,containerResp.Containers,1) | ||
| require.Equal(t,"test-container-id",containerResp.Containers[0].ID) | ||
| // When: We close the WebSocket | ||
| conn.Close(websocket.StatusNormalClosure,"test closing connection") | ||
| // Then: We expect `containersCh` to be closed. | ||
| select { | ||
| case<-ctx.Done(): | ||
| t.Fail() | ||
| case_,ok:=<-containersCh: | ||
| require.False(t,ok,"channel is expected to be closed") | ||
| } | ||
| }) | ||
| t.Run("CoderdWebSocketCanHandleAgentClosing",func(t*testing.T) { | ||
| t.Parallel() | ||
| // This test ensures that the agent containers `/watch` websocket can gracefully | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.