Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix: Close notifier Poll goroutine on stop #3252

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 27, 2022
Merged

fix: Close notifier Poll goroutine on stop #3252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f9f183
fix: Close notifier Poll goroutine on stop
mafredri Jul 27, 2022
117ed09
fix: Handle closed ticker in notifier Poll
mafredri Jul 27, 2022
6c6b949
fix: Clean up Notifier resources via Close
mafredri Jul 27, 2022
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
36 changes: 32 additions & 4 deletions coderd/autobuild/notify/notifier.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
package notify

import (
"context"
"sort"
"sync"
"time"
)

// Notifier calls a Condition at most once for each count in countdown.
type Notifier struct {
ctx context.Context
cancel context.CancelFunc
pollDone chan struct{}

lock sync.Mutex
condition Condition
notifiedAt map[time.Duration]bool
Expand All @@ -28,11 +33,14 @@ type Condition func(now time.Time) (deadline time.Time, callback func())
// Notify is a convenience function that initializes a new Notifier
// with the given condition, interval, and countdown.
// It is the responsibility of the caller to call close to stop polling.
func Notify(cond Condition, interval time.Duration, countdown ...time.Duration) (close func()) {
func Notify(cond Condition, interval time.Duration, countdown ...time.Duration) (closeFunc func()) {
notifier := New(cond, countdown...)
ticker := time.NewTicker(interval)
go notifier.Poll(ticker.C)
return ticker.Stop
return func() {
ticker.Stop()
_ = notifier.Close()
}
}

// New returns a Notifier that calls cond once every time it polls.
Expand All @@ -45,7 +53,11 @@ func New(cond Condition, countdown ...time.Duration) *Notifier {
return ct[i] < ct[j]
})

ctx, cancel := context.WithCancel(context.Background())
n := &Notifier{
ctx: ctx,
cancel: cancel,
pollDone: make(chan struct{}),
countdown: ct,
condition: cond,
notifiedAt: make(map[time.Duration]bool),
Expand All @@ -57,13 +69,29 @@ func New(cond Condition, countdown ...time.Duration) *Notifier {
// Poll polls once immediately, and then once for every value from ticker.
// Poll exits when ticker is closed.
func (n *Notifier) Poll(ticker <-chan time.Time) {
defer close(n.pollDone)

// poll once immediately
n.pollOnce(time.Now())
for t := range ticker {
n.pollOnce(t)
for {
select {
case <-n.ctx.Done():
return
case t, ok := <-ticker:
if !ok {
return
}
n.pollOnce(t)
}
}
}

func (n *Notifier) Close() error {
n.cancel()
<-n.pollDone
return nil
}

func (n *Notifier) pollOnce(tick time.Time) {
n.lock.Lock()
defer n.lock.Unlock()
Expand Down
3 changes: 2 additions & 1 deletion coderd/autobuild/notify/notifier_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,10 @@ func TestNotifier(t *testing.T) {
}
var wg sync.WaitGroup
go func() {
defer wg.Done()
n := notify.New(cond, testCase.Countdown...)
defer n.Close()
n.Poll(ch)
wg.Done()
}()
wg.Add(1)
for _, tick := range testCase.Ticks {
Expand Down