Merge pull request #5008 from oasisprotocol/peternose/fix/workpool-leak

go/common/workerpool: Fix memory leak when workerpool is stopped early
oasisprotocol · Oct 30, 2022 · f8b22e2 · f8b22e2
2 parents 978ea30 + a888835
commit f8b22e2
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/.changelog/5008.bugfix.md b/.changelog/5008.bugfix.md
@@ -0,0 +1,5 @@
+go/common/workerpool: Fix memory leak when workerpool is stopped early
+
+When workerpool si stopped, the job channel might still contain jobs which
+haven't been processed. Therefore, the channel never closes and leaves one
+go routine hanging.
diff --git a/go/common/workerpool/workerpool.go b/go/common/workerpool/workerpool.go
@@ -79,6 +79,10 @@ func (p *Pool) Stop() {
 	p.stopOnce.Do(func() {
 		close(p.stopCh)
 	})
+
+	for range p.jobCh.Out() {
+		// Clear the channel to close all go routines and prevent memory leaks.
+	}
 }
 
 // Quit returns a channel that will be closed when the pool stops.