Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: ensure executor doesn't deadlock when closure errors #152

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
result*
/tests/*/gomod2nix.toml
/tests/*/go.mod
.idea
4 changes: 2 additions & 2 deletions internal/generate/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ func ImportPkgs(directory string, numWorkers int) error {
return err
}

executor := lib.NewParallellExecutor(numWorkers)
executor := lib.NewParallelExecutor(numWorkers)
for _, dl := range modDownloads {
dl := dl
executor.Add(func() error {
Expand Down Expand Up @@ -146,7 +146,7 @@ func GeneratePkgs(directory string, goMod2NixPath string, numWorkers int) ([]*sc
return nil, err
}

executor := lib.NewParallellExecutor(numWorkers)
executor := lib.NewParallelExecutor(numWorkers)
var mux sync.Mutex

cache := schema.ReadCache(goMod2NixPath)
Expand Down
15 changes: 7 additions & 8 deletions internal/lib/executor.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import (
"sync"
)

// ParallellExecutor - Execute callback functions in parallell
type ParallellExecutor struct {
// ParallelExecutor - Execute callback functions in parallel
type ParallelExecutor struct {
errChan chan error
wg *sync.WaitGroup
mux *sync.Mutex
Expand All @@ -16,8 +16,8 @@ type ParallellExecutor struct {
done bool
}

func NewParallellExecutor(maxWorkers int) *ParallellExecutor {
return &ParallellExecutor{
func NewParallelExecutor(maxWorkers int) *ParallelExecutor {
return &ParallelExecutor{
errChan: make(chan error),
mux: new(sync.Mutex),
wg: new(sync.WaitGroup),
Expand All @@ -28,12 +28,11 @@ func NewParallellExecutor(maxWorkers int) *ParallellExecutor {
}
}

func (e *ParallellExecutor) Add(fn func() error) {
func (e *ParallelExecutor) Add(fn func() error) {
e.wg.Add(1)

e.guard <- struct{}{} // Block until a worker is available

go func() {
e.guard <- struct{}{} // Block until a worker is available
defer e.wg.Done()
defer func() {
<-e.guard
Expand All @@ -46,7 +45,7 @@ func (e *ParallellExecutor) Add(fn func() error) {
}()
}

func (e *ParallellExecutor) Wait() error {
func (e *ParallelExecutor) Wait() error {
e.mux.Lock()
defer e.mux.Unlock()

Expand Down
36 changes: 36 additions & 0 deletions internal/lib/executor_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
package lib

import (
"errors"
"testing"
"time"
)

// TestParallelExecutor_fnAlwaysErrors ensures that the executor does not block
// forever when there are more erroring functions than workers. This is a
// regression test.
func TestParallelExecutor_fnAlwaysErrors(t *testing.T) {
const maxWorkers = 1
executor := NewParallelExecutor(1)

for i := 0; i < maxWorkers+1; i++ {
executor.Add(func() error {
return errors.New("testerror")
})
}

errCh := make(chan error)
go func() {
defer close(errCh)
errCh <- executor.Wait()
}()

select {
case err := <-errCh:
if err == nil {
t.Error("Expected error, got nil")
}
case <-time.After(10 * time.Second):
t.Error("Timed out waiting for executor to finish: deadlock")
}
}