Skip to content

Bug: Goroutine leak in coderd.(*api).workspaceAgentTurn #1508

@mafredri

Description

@mafredri

There seems to be a goroutine leak in coderd.(*api).workspaceAgentTurn.

This could be seen as two bugs:

  1. Goroutine leak
  2. Use of (*http.Request).Context() after Hijack in more than one place

Steps to Reproduce

  1. Enable pprof for coder server
  2. coder ssh dev
  3. ctlr+d
  4. Goto 1
  5. Check pprof (go tool pprof -http=:8080 http://localhost:6060/debug/pprof/goroutine)

The leak is in part due to reliance on the http.Request context and use of websockets. The underlying websocket library calls (*http.Request).Hijack which disables context propagation.

This happens here:

wsConn, err := websocket.Accept(rw, r, &websocket.AcceptOptions{

And the following contexts will not cancel until the http handler completes:

netConn := websocket.NetConn(r.Context(), wsConn, websocket.MessageBinary)

case <-r.Context().Done():

We must avoid using r.Context() after hijack, unless we are using it with the expectation that the http handler will exit (at which point the context will complete).

I'm unfamiliar with the pion/turn package, but another factor could be wrt how it handles connection closure, perhaps it does not propagate as we expect since we're not calling wsConn.Close() due to context reliance?


Similar reliance on request context after hijack is done elsewhere, we should rethink all of them. Example:

resource, err := api.Database.GetWorkspaceResourceByID(r.Context(), workspaceAgent.ResourceID)

Metadata

Metadata

Assignees

Labels

apiArea: HTTP API

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    pFad - Phonifier reborn

    Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

    Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


    Alternative Proxies:

    Alternative Proxy

    pFad Proxy

    pFad v3 Proxy

    pFad v4 Proxy