feat: send native system notification on scheduled workspace shutdown #1414
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| package notify | ||
|
|
||
| import ( | ||
| "sort" | ||
| "sync" | ||
| "time" | ||
| ) | ||
|
|
||
| // Notifier calls a Condition at most once for each count in countdown. | ||
| type Notifier struct { | ||
| lock sync.Mutex | ||
| condition Condition | ||
| notifiedAt map[time.Duration]bool | ||
|
There was a problem hiding this comment. Would it make sense to move this into There was a problem hiding this comment. We could move into There was a problem hiding this comment. Ok that makes sense. I guess it's mostly a question of how the package is to be used and what the user (might) expect to happen. I imagine this will not be a problem for |
||
| countdown []time.Duration | ||
| } | ||
|
|
||
| // Condition is a function that gets executed with a certain time. | ||
| // - It should return the deadline for the notification, as well as a | ||
| // callback function to execute once the time to the deadline is | ||
| // less than one of the notify attempts. If deadline is the zero | ||
| // time, callback will not be executed. | ||
| // - Callback is executed once for every time the difference between deadline | ||
| // and the current time is less than an element of countdown. | ||
| // - To enforce a minimum interval between consecutive callbacks, truncate | ||
| // the returned deadline to the minimum interval. | ||
johnstcn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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()) { | ||
| notifier := New(cond, countdown...) | ||
| ticker := time.NewTicker(interval) | ||
| go notifier.Poll(ticker.C) | ||
| return ticker.Stop | ||
| } | ||
|
|
||
| // New returns a Notifier that calls cond once every time it polls. | ||
| // - Duplicate values are removed from countdown, and it is sorted in | ||
| // descending order. | ||
| func New(cond Condition, countdown ...time.Duration) *Notifier { | ||
| // Ensure countdown is sorted in descending order and contains no duplicates. | ||
| ct := unique(countdown) | ||
| sort.Slice(ct, func(i, j int) bool { | ||
| return ct[i] < ct[j] | ||
| }) | ||
|
|
||
| n := &Notifier{ | ||
| countdown: ct, | ||
| condition: cond, | ||
| notifiedAt: make(map[time.Duration]bool), | ||
| } | ||
|
|
||
| return n | ||
| } | ||
|
|
||
| // 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) { | ||
| // poll once immediately | ||
| n.pollOnce(time.Now()) | ||
| for t := range ticker { | ||
| n.pollOnce(t) | ||
| } | ||
| } | ||
|
|
||
| func (n *Notifier) pollOnce(tick time.Time) { | ||
| n.lock.Lock() | ||
| defer n.lock.Unlock() | ||
|
|
||
| deadline, callback := n.condition(tick) | ||
| if deadline.IsZero() { | ||
| return | ||
| } | ||
|
|
||
| timeRemaining := deadline.Sub(tick) | ||
| for _, tock := range n.countdown { | ||
| if n.notifiedAt[tock] { | ||
| continue | ||
| } | ||
| if timeRemaining > tock { | ||
| continue | ||
| } | ||
| callback() | ||
| n.notifiedAt[tock] = true | ||
| return | ||
| } | ||
| } | ||
|
|
||
| func unique(ds []time.Duration) []time.Duration { | ||
| m := make(map[time.Duration]bool) | ||
| for _, d := range ds { | ||
| m[d] = true | ||
| } | ||
| var ks []time.Duration | ||
| for k := range m { | ||
| ks = append(ks, k) | ||
| } | ||
| return ks | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| package notify_test | ||
|
|
||
| import ( | ||
| "sync" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| "go.uber.org/atomic" | ||
| "go.uber.org/goleak" | ||
|
|
||
| "github.com/coder/coder/coderd/autobuild/notify" | ||
| ) | ||
|
|
||
| func TestNotifier(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| now := time.Now() | ||
|
|
||
| testCases := []struct { | ||
| Name string | ||
| Countdown []time.Duration | ||
| Ticks []time.Time | ||
| ConditionDeadline time.Time | ||
| NumConditions int64 | ||
| NumCallbacks int64 | ||
| }{ | ||
| { | ||
| Name: "zero deadline", | ||
| Countdown: durations(), | ||
| Ticks: fakeTicker(now, time.Second, 0), | ||
| ConditionDeadline: time.Time{}, | ||
| NumConditions: 1, | ||
| NumCallbacks: 0, | ||
| }, | ||
| { | ||
| Name: "no calls", | ||
| Countdown: durations(), | ||
| Ticks: fakeTicker(now, time.Second, 0), | ||
| ConditionDeadline: now, | ||
| NumConditions: 1, | ||
| NumCallbacks: 0, | ||
| }, | ||
| { | ||
| Name: "exactly one call", | ||
| Countdown: durations(time.Second), | ||
| Ticks: fakeTicker(now, time.Second, 1), | ||
| ConditionDeadline: now.Add(time.Second), | ||
| NumConditions: 2, | ||
| NumCallbacks: 1, | ||
| }, | ||
| { | ||
| Name: "two calls", | ||
| Countdown: durations(4*time.Second, 2*time.Second), | ||
| Ticks: fakeTicker(now, time.Second, 5), | ||
| ConditionDeadline: now.Add(5 * time.Second), | ||
| NumConditions: 6, | ||
| NumCallbacks: 2, | ||
| }, | ||
| { | ||
| Name: "wrong order should not matter", | ||
| Countdown: durations(2*time.Second, 4*time.Second), | ||
| Ticks: fakeTicker(now, time.Second, 5), | ||
| ConditionDeadline: now.Add(5 * time.Second), | ||
| NumConditions: 6, | ||
| NumCallbacks: 2, | ||
| }, | ||
| { | ||
| Name: "ssh autostop notify", | ||
| Countdown: durations(5*time.Minute, time.Minute), | ||
| Ticks: fakeTicker(now, 30*time.Second, 120), | ||
| ConditionDeadline: now.Add(30 * time.Minute), | ||
| NumConditions: 121, | ||
| NumCallbacks: 2, | ||
| }, | ||
| } | ||
|
|
||
| for _, testCase := range testCases { | ||
| testCase := testCase | ||
| t.Run(testCase.Name, func(t *testing.T) { | ||
| t.Parallel() | ||
| ch := make(chan time.Time) | ||
| numConditions := atomic.NewInt64(0) | ||
| numCalls := atomic.NewInt64(0) | ||
|
There was a problem hiding this comment. Cool use of |
||
| cond := func(time.Time) (time.Time, func()) { | ||
| numConditions.Inc() | ||
| return testCase.ConditionDeadline, func() { | ||
| numCalls.Inc() | ||
| } | ||
| } | ||
| var wg sync.WaitGroup | ||
| go func() { | ||
| n := notify.New(cond, testCase.Countdown...) | ||
| n.Poll(ch) | ||
| wg.Done() | ||
| }() | ||
| wg.Add(1) | ||
| for _, tick := range testCase.Ticks { | ||
| ch <- tick | ||
| } | ||
| close(ch) | ||
johnstcn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| wg.Wait() | ||
| require.Equal(t, testCase.NumCallbacks, numCalls.Load()) | ||
| require.Equal(t, testCase.NumConditions, numConditions.Load()) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func durations(ds ...time.Duration) []time.Duration { | ||
| return ds | ||
| } | ||
|
|
||
| func fakeTicker(t time.Time, d time.Duration, n int) []time.Time { | ||
| var ts []time.Time | ||
| for i := 1; i <= n; i++ { | ||
| ts = append(ts, t.Add(time.Duration(n)*d)) | ||
| } | ||
| return ts | ||
| } | ||
|
|
||
| func TestMain(m *testing.M) { | ||
| goleak.VerifyTestMain(m) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if it'd be best to place as much of this as possible in the
notifypackage. eg. forcoder port-forwardwe'd probably want to do the exact same type of thing.I could imagine for the frontend too, we would send a notification via WebSocket or something!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That could be a good idea when we have a better idea of what different use-cases crop up.
I fear I've already over-engineered this enough as it is!