File: rungroup.go

package info (click to toggle)
golang-github-bep-helpers 0.6.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 148 kB
  • sloc: makefile: 2
file content (83 lines) | stat: -rw-r--r-- 1,551 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
// Copyright 2024 Bjørn Erik Pedersen
// SPDX-License-Identifier: MIT

package parahelpers

import (
	"context"

	"golang.org/x/sync/errgroup"
)

// Group is a group of workers that can be used to enqueue work and wait for
// them to finish.
type Group[T any] interface {
	Enqueue(T) error
	Wait() error
}

type runGroup[T any] struct {
	ctx context.Context
	g   *errgroup.Group
	ch  chan T
}

// GroupConfig is the configuration for a new Group.
type GroupConfig[T any] struct {
	NumWorkers int
	Handle     func(context.Context, T) error
}

// RunGroup creates a new Group with the given configuration.
func RunGroup[T any](ctx context.Context, cfg GroupConfig[T]) Group[T] {
	if cfg.NumWorkers <= 0 {
		cfg.NumWorkers = 1
	}
	if cfg.Handle == nil {
		panic("Handle must be set")
	}

	g, ctx := errgroup.WithContext(ctx)
	// Buffered for performance.
	ch := make(chan T, cfg.NumWorkers)

	for i := 0; i < cfg.NumWorkers; i++ {
		g.Go(func() error {
			for {
				select {
				case <-ctx.Done():
					return nil
				case v, ok := <-ch:
					if !ok {
						return nil
					}
					if err := cfg.Handle(ctx, v); err != nil {
						return err
					}
				}
			}
		})
	}

	return &runGroup[T]{
		ctx: ctx,
		g:   g,
		ch:  ch,
	}
}

// Enqueue enqueues a new item to be handled by the workers.
func (r *runGroup[T]) Enqueue(t T) error {
	select {
	case <-r.ctx.Done():
		return nil
	case r.ch <- t:
	}
	return nil
}

// Wait waits for all workers to finish and returns the first error.
func (r *runGroup[T]) Wait() error {
	close(r.ch)
	return r.g.Wait()
}