fix: close trace file after program run (#1844)

Co-authored-by: Drew Smirnoff <drew@charm.land>
Signed-off-by: Drew Smirnoff <drew@charm.land>
This commit is contained in:
Ahmet Kamer Çivi 2026-11-12 16:36:39 +03:00 committed by GitHub
parent 1b8005fc10
commit 18d6fa3b34
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 38 additions and 10 deletions

23
tea.go
View file

@ -545,7 +545,8 @@ type Program struct {
// the environment variables for the program, defaults to os.Environ().
environ uv.Environ
// the program's logger for debugging.
logger uv.Logger
logger uv.Logger
tracePath string
// where to read inputs from, this will usually be os.Stdin.
input io.Reader
@ -662,10 +663,7 @@ func NewProgram(model Model, opts ...ProgramOption) *Program {
tracePath, traceOk := os.LookupEnv("TEA_TRACE")
if traceOk && len(tracePath) > 0 {
// We have a trace filepath.
if f, err := os.OpenFile(tracePath, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0o600); err == nil {
p.logger = log.New(f, "bubbletea: ", log.LstdFlags|log.Lshortfile)
}
p.tracePath = tracePath
}
return p
@ -1055,6 +1053,16 @@ func (p *Program) Run() (returnModel Model, returnErr error) {
}
}()
p.finished = make(chan struct{})
defer close(p.finished)
if p.tracePath != "" {
if f, err := os.OpenFile(p.tracePath, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0o600); err == nil {
defer f.Close() //nolint:errcheck
p.logger = log.New(f, "bubbletea: ", log.LstdFlags|log.Lshortfile)
}
}
// Initialize context and teardown channel.
//
// When a previous run already tore down its per-run state, recreate it so
@ -1072,11 +1080,6 @@ func (p *Program) Run() (returnModel Model, returnErr error) {
p.handlers = channelHandlers{}
cmds := make(chan Cmd)
p.finished = make(chan struct{})
defer func() {
close(p.finished)
}()
defer p.cancel()
p.started.Store(true)

View file

@ -6,6 +6,9 @@ import (
"errors"
"fmt"
"io"
"log"
"os"
"path/filepath"
"strings"
"sync"
"sync/atomic"
@ -91,6 +94,28 @@ func TestTeaModel(t *testing.T) {
}
}
func TestProgramClosesTraceFile(t *testing.T) {
tracePath := filepath.Join(t.TempDir(), "trace.log")
t.Setenv("TEA_TRACE", tracePath)
p := NewProgram(quitModel{}, WithInput(nil), WithOutput(io.Discard), WithoutRenderer())
if _, err := p.Run(); err != nil {
t.Fatal(err)
}
logger, ok := p.logger.(*log.Logger)
if !ok {
t.Fatalf("logger has type %T, want *log.Logger", p.logger)
}
traceFile, ok := logger.Writer().(*os.File)
if !ok {
t.Fatalf("trace writer has type %T, want *os.File", logger.Writer())
}
if _, err := traceFile.Write([]byte("x")); !errors.Is(err, os.ErrClosed) {
t.Fatalf("trace file remains open after Run: Write error = %v", err)
}
}
func TestTeaQuit(t *testing.T) {
t.Parallel()
var buf bytes.Buffer