watch: timeout path leaks one goroutine per kill and races on the shared output buffer
还没有人认领这个 Issue。
评估
调研方向
从 command/watch.go 中的 doWatch 和 evalCmdOutput 开始,然后在 race detector 下运行提供的 gotify watch 复现。重复的 timeout tick 不再累积 goroutine,并且只有在 child 及其输出复制工作完成后才读取输出时,该 issue 才算完成。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- Go
- 星标
- 588
- 派生
- 73
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
gotify/cli 的其他 Issue
-
a:feature
-
难度 4/5 3-5 天 新手友好度 25/100
-
难度 4/5 3-5 天 新手友好度 45/100
-
a:feature
难度 3/5 1-2 天 新手友好度 35/100
-
a:feature
难度 4/5 3-5 天 新手友好度 25/100
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 60/100
github/gh-aw-mcpg#13748 ·
-
agentic-workflows
难度 2/5 1-3 小时 新手友好度 65/100
-
needs-triage
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 75/100
googleapis/librarian#7670 · 2 条评论 ·