... to work around some of the "unexpected EOF" failures.

Signed-off-by: Miloslav Trmač <mitr@redhat.com>
This commit is contained in:
Miloslav Trmač
2023-02-09 20:21:50 +01:00
parent e9f30e5b65
commit 643a2359e4
294 changed files with 6816 additions and 4797 deletions

474
vendor/github.com/vbauerster/mpb/v8/progress.go generated vendored Normal file
View File

@@ -0,0 +1,474 @@
package mpb
import (
"bytes"
"container/heap"
"context"
"fmt"
"io"
"math"
"os"
"sync"
"time"
"github.com/vbauerster/mpb/v8/cwriter"
)
const (
defaultRefreshRate = 150 * time.Millisecond
)
// DoneError represents an error when `*mpb.Progress` is done but its functionality is requested.
var DoneError = fmt.Errorf("%T instance can't be reused after it's done!", (*Progress)(nil))
// Progress represents a container that renders one or more progress bars.
type Progress struct {
ctx context.Context
uwg *sync.WaitGroup
bwg *sync.WaitGroup
operateState chan func(*pState)
interceptIo chan func(io.Writer)
done chan struct{}
shutdown chan struct{}
cancel func()
}
// pState holds bars in its priorityQueue, it gets passed to (*Progress).serve monitor goroutine.
type pState struct {
bHeap priorityQueue
heapUpdated bool
pMatrix map[int][]chan int
aMatrix map[int][]chan int
rows []io.Reader
// following are provided/overrided by user
refreshRate time.Duration
idCount int
reqWidth int
popPriority int
popCompleted bool
outputDiscarded bool
disableAutoRefresh bool
manualRefresh chan interface{}
renderDelay <-chan struct{}
shutdownNotifier chan struct{}
queueBars map[*Bar]*Bar
output io.Writer
debugOut io.Writer
uwg *sync.WaitGroup
}
// New creates new Progress container instance. It's not possible to
// reuse instance after (*Progress).Wait method has been called.
func New(options ...ContainerOption) *Progress {
return NewWithContext(context.Background(), options...)
}
// NewWithContext creates new Progress container instance with provided
// context. It's not possible to reuse instance after (*Progress).Wait
// method has been called.
func NewWithContext(ctx context.Context, options ...ContainerOption) *Progress {
s := &pState{
rows: make([]io.Reader, 32),
refreshRate: defaultRefreshRate,
popPriority: math.MinInt32,
manualRefresh: make(chan interface{}),
queueBars: make(map[*Bar]*Bar),
output: os.Stdout,
debugOut: io.Discard,
}
for _, opt := range options {
if opt != nil {
opt(s)
}
}
ctx, cancel := context.WithCancel(ctx)
p := &Progress{
ctx: ctx,
uwg: s.uwg,
bwg: new(sync.WaitGroup),
operateState: make(chan func(*pState)),
interceptIo: make(chan func(io.Writer)),
done: make(chan struct{}),
cancel: cancel,
}
if s.shutdownNotifier != nil {
p.shutdown = s.shutdownNotifier
s.shutdownNotifier = nil
} else {
p.shutdown = make(chan struct{})
}
go p.serve(s, cwriter.New(s.output))
return p
}
// AddBar creates a bar with default bar filler.
func (p *Progress) AddBar(total int64, options ...BarOption) *Bar {
return p.New(total, BarStyle(), options...)
}
// AddSpinner creates a bar with default spinner filler.
func (p *Progress) AddSpinner(total int64, options ...BarOption) *Bar {
return p.New(total, SpinnerStyle(), options...)
}
// New creates a bar by calling `Build` method on provided `BarFillerBuilder`.
func (p *Progress) New(total int64, builder BarFillerBuilder, options ...BarOption) *Bar {
return p.AddFiller(total, builder.Build(), options...)
}
// AddFiller creates a bar which renders itself by provided filler.
// If `total <= 0` triggering complete event by increment methods is disabled.
// Panics if *Progress instance is done, i.e. called after (*Progress).Wait().
func (p *Progress) AddFiller(total int64, filler BarFiller, options ...BarOption) *Bar {
if filler == nil {
filler = NopStyle().Build()
}
p.bwg.Add(1)
result := make(chan *Bar)
select {
case p.operateState <- func(ps *pState) {
bs := ps.makeBarState(total, filler, options...)
bar := newBar(p, bs)
if bs.wait.bar != nil {
ps.queueBars[bs.wait.bar] = bar
} else {
heap.Push(&ps.bHeap, bar)
ps.heapUpdated = true
}
ps.idCount++
result <- bar
}:
bar := <-result
return bar
case <-p.done:
p.bwg.Done()
panic(DoneError)
}
}
func (p *Progress) traverseBars(cb func(b *Bar) bool) {
sync := make(chan struct{})
select {
case p.operateState <- func(s *pState) {
defer close(sync)
for i := 0; i < s.bHeap.Len(); i++ {
bar := s.bHeap[i]
if !cb(bar) {
break
}
}
}:
<-sync
case <-p.done:
}
}
// UpdateBarPriority same as *Bar.SetPriority(int).
func (p *Progress) UpdateBarPriority(b *Bar, priority int) {
select {
case p.operateState <- func(s *pState) {
if b.index < 0 {
return
}
b.priority = priority
heap.Fix(&s.bHeap, b.index)
}:
case <-p.done:
}
}
// BarCount returns bars count.
func (p *Progress) BarCount() int {
result := make(chan int)
select {
case p.operateState <- func(s *pState) { result <- s.bHeap.Len() }:
return <-result
case <-p.done:
return 0
}
}
// Write is implementation of io.Writer.
// Writing to `*mpb.Progress` will print lines above a running bar.
// Writes aren't flushed immediately, but at next refresh cycle.
// If Write is called after `*mpb.Progress` is done, `mpb.DoneError`
// is returned.
func (p *Progress) Write(b []byte) (int, error) {
type result struct {
n int
err error
}
ch := make(chan *result)
select {
case p.interceptIo <- func(w io.Writer) {
n, err := w.Write(b)
ch <- &result{n, err}
}:
res := <-ch
return res.n, res.err
case <-p.done:
return 0, DoneError
}
}
// Wait waits for all bars to complete and finally shutdowns container. After
// this method has been called, there is no way to reuse (*Progress) instance.
func (p *Progress) Wait() {
// wait for user wg, if any
if p.uwg != nil {
p.uwg.Wait()
}
p.bwg.Wait()
p.Shutdown()
}
// Shutdown cancels any running bar immediately and then shutdowns (*Progress)
// instance. Normally this method shouldn't be called unless you know what you
// are doing. Proper way to shutdown is to call (*Progress).Wait() instead.
func (p *Progress) Shutdown() {
p.cancel()
<-p.shutdown
}
func (p *Progress) newTicker(s *pState) chan time.Time {
ch := make(chan time.Time)
go func() {
var autoRefresh <-chan time.Time
if !s.disableAutoRefresh && !s.outputDiscarded {
if s.renderDelay != nil {
<-s.renderDelay
}
ticker := time.NewTicker(s.refreshRate)
defer ticker.Stop()
autoRefresh = ticker.C
}
for {
select {
case t := <-autoRefresh:
ch <- t
case x := <-s.manualRefresh:
if t, ok := x.(time.Time); ok {
ch <- t
} else {
ch <- time.Now()
}
case <-p.ctx.Done():
close(p.done)
return
}
}
}()
return ch
}
func (p *Progress) serve(s *pState, cw *cwriter.Writer) {
defer close(p.shutdown)
render := func() error {
return s.render(cw)
}
refreshCh := p.newTicker(s)
for {
select {
case op := <-p.operateState:
op(s)
case fn := <-p.interceptIo:
fn(cw)
case <-refreshCh:
err := render()
if err != nil {
s.heapUpdated = false
render = func() error { return nil }
_, _ = fmt.Fprintln(s.debugOut, err.Error())
p.cancel() // cancel all bars
}
case <-p.done:
for s.heapUpdated {
err := render()
if err != nil {
_, _ = fmt.Fprintln(s.debugOut, err.Error())
return
}
}
return
}
}
}
func (s *pState) render(cw *cwriter.Writer) error {
var wg sync.WaitGroup
if s.heapUpdated {
s.updateSyncMatrix()
s.heapUpdated = false
}
syncWidth(&wg, s.pMatrix)
syncWidth(&wg, s.aMatrix)
width, height, err := cw.GetTermSize()
if err != nil {
width = s.reqWidth
height = s.bHeap.Len()
}
for i := 0; i < s.bHeap.Len(); i++ {
bar := s.bHeap[i]
go bar.render(width)
}
err = s.flush(&wg, cw, height)
wg.Wait()
return err
}
func (s *pState) flush(wg *sync.WaitGroup, cw *cwriter.Writer, height int) error {
var popCount int
pool := make([]*Bar, 0, s.bHeap.Len())
s.rows = s.rows[:0]
for s.bHeap.Len() > 0 {
b := heap.Pop(&s.bHeap).(*Bar)
frame := <-b.frameCh
if frame.err != nil {
// b.frameCh is buffered it's ok to return here
return frame.err
}
var usedRows int
for i := len(frame.rows) - 1; i >= 0; i-- {
if row := frame.rows[i]; len(s.rows) < height {
s.rows = append(s.rows, row)
usedRows++
} else {
wg.Add(1)
go func() {
_, _ = io.Copy(io.Discard, row)
wg.Done()
}()
}
}
if frame.shutdown {
b.Wait() // waiting for b.done, so it's safe to read b.bs
if qb, ok := s.queueBars[b]; ok {
delete(s.queueBars, b)
qb.priority = b.priority
pool = append(pool, qb)
s.heapUpdated = true
continue
}
if s.popCompleted && !b.bs.noPop {
switch b.bs.shutdown++; b.bs.shutdown {
case 1:
b.priority = s.popPriority
s.popPriority++
default:
if b.bs.dropOnComplete {
popCount += usedRows
s.heapUpdated = true
continue
}
}
} else if b.bs.dropOnComplete {
s.heapUpdated = true
continue
}
}
pool = append(pool, b)
}
if len(pool) != 0 {
wg.Add(1)
go func() {
for _, b := range pool {
heap.Push(&s.bHeap, b)
}
wg.Done()
}()
}
for i := len(s.rows) - 1; i >= 0; i-- {
_, err := cw.ReadFrom(s.rows[i])
if err != nil {
return err
}
}
err := cw.Flush(len(s.rows) - popCount)
return err
}
func (s *pState) updateSyncMatrix() {
s.pMatrix = make(map[int][]chan int)
s.aMatrix = make(map[int][]chan int)
for i := 0; i < s.bHeap.Len(); i++ {
bar := s.bHeap[i]
table := bar.wSyncTable()
for i, ch := range table[0] {
s.pMatrix[i] = append(s.pMatrix[i], ch)
}
for i, ch := range table[1] {
s.aMatrix[i] = append(s.aMatrix[i], ch)
}
}
}
func (s *pState) makeBarState(total int64, filler BarFiller, options ...BarOption) *bState {
bs := &bState{
id: s.idCount,
priority: s.idCount,
reqWidth: s.reqWidth,
total: total,
filler: filler,
manualRefresh: s.manualRefresh,
}
if total > 0 {
bs.triggerComplete = true
}
for _, opt := range options {
if opt != nil {
opt(bs)
}
}
if bs.middleware != nil {
bs.filler = bs.middleware(filler)
bs.middleware = nil
}
for i := 0; i < len(bs.buffers); i++ {
bs.buffers[i] = bytes.NewBuffer(make([]byte, 0, 512))
}
bs.subscribeDecorators()
return bs
}
func syncWidth(wg *sync.WaitGroup, matrix map[int][]chan int) {
for _, column := range matrix {
wg.Add(1)
go maxWidthDistributor(wg, column)
}
}
func maxWidthDistributor(wg *sync.WaitGroup, column []chan int) {
var maxWidth int
for _, ch := range column {
if w := <-ch; w > maxWidth {
maxWidth = w
}
}
for _, ch := range column {
ch <- maxWidth
}
wg.Done()
}