summary.go

package progress

import (
	"context"
	"fmt"
	"io"
	"os"
	"sync"
)

// SummaryReporter writes only the start/end of the reportable activity and errors / warnings are printed as
// encountered.
type SummaryReporter struct {
	DefaultWriter  io.Writer
	ErrorWriter    io.Writer
	Prefix         string
	mu             sync.RWMutex
	errorsReported uint
	maxErrors      uint
}

func NewSummaryReporter(prefix string) *SummaryReporter {
	result := new(SummaryReporter)
	result.DefaultWriter = os.Stdout
	result.ErrorWriter = os.Stderr
	result.Prefix = prefix
	return result
}

func (pr *SummaryReporter) StartReportableActivity(ctx context.Context, summary string, expectedItems int) {
	fmt.Fprintf(pr.DefaultWriter, "%s%s\n", pr.Prefix, summary)
}

func (pr *SummaryReporter) StartReportableReaderActivityInBytes(ctx context.Context, summary string, exepectedBytes int64, inputReader io.Reader) io.Reader {
	fmt.Fprintf(pr.DefaultWriter, "%s%s\n", pr.Prefix, summary)
	return inputReader
}

func (pr *SummaryReporter) IncrementReportableActivityProgress(ctx context.Context, incrementBy int) {
}

func (pr *SummaryReporter) CompleteReportableActivityProgress(ctx context.Context, summary string) {
	fmt.Fprintf(pr.DefaultWriter, "%s%s\n", pr.Prefix, summary)
}

func (pr *SummaryReporter) CollectError(ctx context.Context, err error) bool {
	pr.mu.Lock()
	pr.errorsReported++
	pr.mu.Unlock()
	fmt.Fprintf(pr.ErrorWriter, "%s%v\n", pr.Prefix, err.Error())
	return !pr.MaxErrorsCollected(ctx)
}

func (pr *SummaryReporter) MaxErrorsCollected(context.Context) bool {
	pr.mu.RLock()
	defer pr.mu.RUnlock()
	return pr.maxErrors > 0 && pr.errorsReported > pr.maxErrors
}

func (pr *SummaryReporter) CollectWarning(ctx context.Context, code, message string) bool {
	fmt.Fprintf(pr.DefaultWriter, "%s%s %s\n", pr.Prefix, code, message)
	return true
}