watch: timeout path leaks one goroutine per kill and races on the shared output buffer
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 74/100
Línea de trabajo
Comienza en command/watch.go, en doWatch y evalCmdOutput, y luego ejecuta la reproducción proporcionada de gotify watch bajo el race detector. El issue estará resuelto cuando los ticks de timeout repetidos ya no acumulen goroutines y la salida se lea únicamente después de que el proceso hijo y el trabajo de copia de su salida hayan terminado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Go
- Estrellas
- 588
- Forks
- 73
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de gotify/cli
-
a:feature
-
Package for Ubuntu Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
-
Distribute as a snap? Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
-
watch without command timeout Abiertoa:feature
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
-
a:feature
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
Todos los issues de gotify/cli
Issues similares
-
textual definition
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
geneontology/go-ontology#32653 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 75/100
-
needs design
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Priority/High ready-for-agent Severity/Major Type/Bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100