watch: timeout path leaks one goroutine per kill and races on the shared output buffer
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 74/100
Direzione di ricerca
Inizia in command/watch.go, in doWatch ed evalCmdOutput, quindi esegui la riproduzione gotify watch fornita sotto il race detector. L’issue è completata quando tick di timeout ripetuti non accumulano più goroutine e l’output viene letto solo dopo che il processo figlio e il lavoro di copia del suo output sono terminati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Summary
In watch mode, when the watched command exceeds the interval and is killed via the timeout path, evalCmdOutput leaks a goroutine per timeout occurrence and reads the shared output buffer concurrently with the still-running child pipeline, which is a data race.
Location
- File:
command/watch.go - Function:
doWatch→evalCmdOutput(lines ~86–108)
done := make(chan error) // unbuffered
go func() {
err := cmd.Wait()
if err != nil {
done <- fmt.Errorf("command failed to invoke: %v", err)
}
done <- nil
}()
select {
case err := <-done:
return outputBuf.String(), err
case <-timeOut:
cmd.Process.Kill()
return outputBuf.String(), errors.New("command timed out")
}
Problem
Two defects on the timeout path:
-
Goroutine leak.
doneis unbuffered, and theselectabandons it whentimeOutfires. The spawned goroutine callscmd.Wait(); once the killed process is reaped,Waitreturns and the goroutine attemptsdone <- ...with no receiver ever coming, so it blocks forever. Every interval tick that times out leaks one goroutine (plus the reaped-process bookkeeping), for as long asgotify watchruns — which is by design unbounded (for range time.NewTicker(...).C). -
Data race on
outputBuf. WhenStdout/Stderrare non-*os.Filewriters (here a*bytes.Buffer),os/execspawns internal copy goroutines that write intooutputBuf, and normally onlycmd.Wait()provides the happens-before edge that makes reading the buffer safe. On the timeout pathProcess.Kill()is called withoutWait(), andoutputBuf.String()runs concurrently with those copy goroutines, which may still be draining buffered pipe data from the dying child. ConcurrentBuffer.WriteandBuffer.Stringare not safe.
Trigger / Reproduction
Static analysis finding — not confirmed by execution. Run:
gotify watch -n 1 -- sh -c 'sleep 5; echo done'
Every tick kills sleep 5 after 1 s, taking the case <-timeOut: branch each time: one blocked-forever goroutine per tick, plus an unsynchronized read of outputBuf.
Expected Behavior
The timeout path should reap the child (e.g. call cmd.Wait() after Kill() in a separate goroutine, or use exec.CommandContext with a per-run context so cancellation/reaping is handled by the stdlib) and only then read outputBuf; the completion goroutine should never block on an unreceived channel send (e.g. done := make(chan error, 1)).
Actual Behavior
Goroutines accumulate indefinitely across ticks, and outputBuf can be read while exec's copy goroutines are still writing to it.
Impact
Long-running gotify watch deployments that monitor slow commands accumulate leaked goroutines over time (unbounded memory growth). The unsynchronized buffer access is undefined behavior under the Go memory model and can, under -race, flag crashes/misreads; practically it can observe torn/partial output.
Suggested Direction
Minimal fix: make done buffered (make(chan error, 1)), and after cmd.Process.Kill() call <-done (or cmd.Wait()) before returning outputBuf.String() so the child is fully reaped before its output is read. A cleaner alternative is switching to exec.CommandContext(ctx, ...) per run.
Related but distinct: issue #44 asks for a way to disable the timeout entirely; this report concerns the correctness of the existing timeout implementation itself.
- Lingua principale
- Go
- Stelle
- 588
- Fork
- 73
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di gotify/cli
-
a:feature
-
Package for Ubuntu Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
-
Distribute as a snap? Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
-
a:feature
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
-
a:feature
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
Issue simili
-
area/dev-productivity area/disaster-recovery area/ipcei kind/enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
kind/bug status/0-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
🤔 refinement needed
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
equinor/radix-operator#1979 ·