Source File
	log_group.go

Belonging Package
	github.com/gotd/td/internal/tdsync

package tdsync

import (
	"context"

	"github.com/go-faster/errors"
	"go.uber.org/zap"

	"github.com/gotd/td/clock"
)

// LogGroup is simple wrapper around CancellableGroup to log task state.
// Unlike WaitGroup and errgroup.Group this is not allowed to use zero value.
type LogGroup struct {
	group CancellableGroup

	log   *zap.Logger
	clock clock.Clock
}

// NewLogGroup creates new LogGroup.
func NewLogGroup(parent context.Context, log *zap.Logger) *LogGroup {
	return &LogGroup{
		group: *NewCancellableGroup(parent),
		log:   log,
		clock: clock.System,
	}
}

// SetClock sets Clock to use.
func (g *LogGroup) SetClock(c clock.Clock) {
	g.clock = c
}

// Go calls the given function in a new goroutine.
//
// The first call to return a non-nil error cancels the group; its error will be
// returned by Wait.
func (g *LogGroup) Go(taskName string, f func(groupCtx context.Context) error) {
	g.group.Go(func(ctx context.Context) error {
		start := g.clock.Now()
		l := g.log.With(zap.String("task", taskName)).WithOptions(zap.AddCallerSkip(1))
		l.Debug("Task started")

		if err := f(ctx); err != nil {
			elapsed := g.clock.Now().Sub(start)
			l.Debug("Task stopped", zap.Error(err), zap.Duration("elapsed", elapsed))
			return errors.Wrapf(err, "task %s", taskName)
		}

		elapsed := g.clock.Now().Sub(start)
		l.Debug("Task complete", zap.Duration("elapsed", elapsed))
		return nil
	})
}

// Cancel cancels all goroutines in group.
//
// Note: context cancellation error will be returned by Wait().
func (g *LogGroup) Cancel() {
	g.group.Cancel()
}

// Wait blocks until all function calls from the Go method have returned, then
// returns the first non-nil error (if any) from them.
func (g *LogGroup) Wait() error {
	return g.group.Wait()
}

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.