synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-18 14:17:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: select on context to avoid leak in logFollower (#7792)

Browse Source 
Signed-off-by: Spike Curtis <spike@coder.com>
This commit is contained in:
Spike Curtis
2023-06-02 20:25:46 +04:00
committed by GitHub
parent 004ad1755f
commit 078926f612
1 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
coderd/provisionerjobs.go
View File

@ -300,6 +300,9 @@ func newLogFollower(
} }
func (f *logFollower) follow() { func (f *logFollower) follow() {
var cancel context.CancelFunc
f.ctx, cancel = context.WithCancel(f.ctx)
defer cancel()
// note that we only need to subscribe to updates if the job is not yet // note that we only need to subscribe to updates if the job is not yet
// complete. // complete.
if !f.complete { if !f.complete {
@ -405,17 +408,28 @@ func (f *logFollower) follow() {
} }
func (f *logFollower) listener(_ context.Context, message []byte, err error) { func (f *logFollower) listener(_ context.Context, message []byte, err error) {
// in this function we always pair writes to channels with a select on the context
// otherwise we could block a goroutine if the follow() method exits.
if err != nil { if err != nil {
f.errors <- err select {
case <-f.ctx.Done():
case f.errors <- err:
}
return return
} }
var n provisionersdk.ProvisionerJobLogsNotifyMessage var n provisionersdk.ProvisionerJobLogsNotifyMessage
err = json.Unmarshal(message, &n) err = json.Unmarshal(message, &n)
if err != nil { if err != nil {
f.errors <- err select {
case <-f.ctx.Done():
case f.errors <- err:
}
return return
} }
f.notifications <- n select {
case <-f.ctx.Done():
case f.notifications <- n:
}
} }
// query fetches the latest job logs from the database and writes them to the // query fetches the latest job logs from the database and writes them to the