Skip to content

progress: avoid panic when closing printer #3873

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lohitkolluri wants to merge 1 commit into
base: master
Choose a base branch
from
+19 −5
Open

progress: avoid panic when closing printer #3873

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions util/progress/printer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@ type Printer struct {
mode progressui.DisplayMode
opt *printerOpts

status chan *client.SolveStatus
interrupt chan interruptRequest
state printerState
status chan *client.SolveStatus
statusMu sync.Mutex
statusClosed bool
interrupt chan interruptRequest
state printerState

done chan struct{}
closeOnce sync.Once
Expand All @@ -50,7 +52,10 @@ type Printer struct {

func (p *Printer) Wait() error {
p.closeOnce.Do(func() {
p.statusMu.Lock()
p.statusClosed = true
close(p.status)
p.statusMu.Unlock()
})
<-p.done
return p.err
Expand Down Expand Up @@ -86,7 +91,16 @@ func (p *Printer) Resume() {
}

func (p *Printer) Write(s *client.SolveStatus) {
p.status <- s
p.statusMu.Lock()
if !p.statusClosed {
// Progress updates are best-effort; dropping updates is preferred over blocking
// or panicking when the printer is shutting down.
select {
case p.status <- s:
default:
}
}
p.statusMu.Unlock()
if p.metrics != nil {
p.metrics.Write(s)
}
Expand Down Expand Up @@ -140,7 +154,7 @@ func NewPrinter(ctx context.Context, out io.Writer, mode progressui.DisplayMode,
out: out,
mode: mode,
opt: opt,
status: make(chan *client.SolveStatus),
status: make(chan *client.SolveStatus, 32),
interrupt: make(chan interruptRequest),
state: printerStateRunning,
done: make(chan struct{}),
Expand Down
Loading