Files
moby/distribution/utils/progress.go
Sebastiaan van Stijn 6b5f14a7bb distribution/utils: WriteDistributionProgress simplify check for broken pipe
The isBrokenPipe utility was added in 3d86b0c79b
to unwrap the error returned to detect if it was a broken pipe error.
`net.OpError` now implements Unwrap(), so we can simplify this check
using `errors.Is`.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2025-01-18 16:20:49 +01:00

35 lines
1.1 KiB
Go

package utils // import "github.com/docker/docker/distribution/utils"
import (
"context"
"errors"
"io"
"syscall"
"github.com/containerd/log"
"github.com/docker/docker/pkg/progress"
"github.com/docker/docker/pkg/streamformatter"
)
// WriteDistributionProgress is a helper for writing progress from chan to JSON
// stream with an optional cancel function.
func WriteDistributionProgress(cancelFunc func(), outStream io.Writer, progressChan <-chan progress.Progress) {
progressOutput := streamformatter.NewJSONProgressOutput(outStream, false)
operationCancelled := false
for prog := range progressChan {
if err := progressOutput.WriteProgress(prog); err != nil && !operationCancelled {
// don't log broken pipe errors as this is the normal case when a client aborts
if errors.Is(err, syscall.EPIPE) {
log.G(context.TODO()).Info("Pull session cancelled")
} else {
log.G(context.TODO()).Errorf("error writing progress to client: %v", err)
}
cancelFunc()
operationCancelled = true
// Don't return, because we need to continue draining
// progressChan until it's closed to avoid a deadlock.
}
}
}