- Notifications
You must be signed in to change notification settings - Fork929
feat: send native system notification on scheduled workspace shutdown#1414
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
6 commits Select commitHold shift + click to select a range
125584c feat: send native system notification on scheduled workspace shutdown
johnstcn8313a52 notifier: refactor, add more unit tests
johnstcn67516c7 address PR comments
johnstcn55a1de2 fixup! address PR comments
johnstcne830baf use gofrs/flock instead to handle file locking
johnstcn4f39908 notify only once at most five minutes before shutdown
johnstcnFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
67 changes: 67 additions & 0 deletionscli/ssh.go
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 |
|---|---|---|
| @@ -2,10 +2,15 @@ package cli | ||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
| "time" | ||
| "github.com/gen2brain/beeep" | ||
| "github.com/gofrs/flock" | ||
| "github.com/google/uuid" | ||
| "github.com/mattn/go-isatty" | ||
| "github.com/spf13/cobra" | ||
| @@ -15,10 +20,15 @@ import ( | ||
| "github.com/coder/coder/cli/cliflag" | ||
| "github.com/coder/coder/cli/cliui" | ||
| "github.com/coder/coder/coderd/autobuild/notify" | ||
| "github.com/coder/coder/coderd/autobuild/schedule" | ||
| "github.com/coder/coder/coderd/database" | ||
| "github.com/coder/coder/codersdk" | ||
| ) | ||
| var autostopPollInterval = 30 * time.Second | ||
| var autostopNotifyCountdown = []time.Duration{5 * time.Minute} | ||
| func ssh() *cobra.Command { | ||
| var ( | ||
| stdio bool | ||
| @@ -108,6 +118,9 @@ func ssh() *cobra.Command { | ||
| } | ||
| defer conn.Close() | ||
| stopPolling := tryPollWorkspaceAutostop(cmd.Context(), client, workspace) | ||
| defer stopPolling() | ||
| if stdio { | ||
| rawSSH, err := conn.SSH() | ||
| if err != nil { | ||
| @@ -179,3 +192,57 @@ func ssh() *cobra.Command { | ||
| return cmd | ||
| } | ||
| // Attempt to poll workspace autostop. We write a per-workspace lockfile to | ||
| // avoid spamming the user with notifications in case of multiple instances | ||
| // of the CLI running simultaneously. | ||
| func tryPollWorkspaceAutostop(ctx context.Context, client *codersdk.Client, workspace codersdk.Workspace) (stop func()) { | ||
| lock := flock.New(filepath.Join(os.TempDir(), "coder-autostop-notify-"+workspace.ID.String())) | ||
| condition := notifyCondition(ctx, client, workspace.ID, lock) | ||
| return notify.Notify(condition, autostopPollInterval, autostopNotifyCountdown...) | ||
| } | ||
| // Notify the user if the workspace is due to shutdown. | ||
| func notifyCondition(ctx context.Context, client *codersdk.Client, workspaceID uuid.UUID, lock *flock.Flock) notify.Condition { | ||
| return func(now time.Time) (deadline time.Time, callback func()) { | ||
| // Keep trying to regain the lock. | ||
| locked, err := lock.TryLockContext(ctx, autostopPollInterval) | ||
| if err != nil || !locked { | ||
| return time.Time{}, nil | ||
| } | ||
Comment on lines +196 to +212 There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 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 commentThe 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. | ||
| ws, err := client.Workspace(ctx, workspaceID) | ||
| if err != nil { | ||
| return time.Time{}, nil | ||
| } | ||
| if ws.AutostopSchedule == "" { | ||
| return time.Time{}, nil | ||
| } | ||
| sched, err := schedule.Weekly(ws.AutostopSchedule) | ||
| if err != nil { | ||
| return time.Time{}, nil | ||
| } | ||
| deadline = sched.Next(now) | ||
| callback = func() { | ||
| ttl := deadline.Sub(now) | ||
| var title, body string | ||
| if ttl > time.Minute { | ||
| title = fmt.Sprintf(`Workspace %s stopping in %.0f mins`, ws.Name, ttl.Minutes()) | ||
| body = fmt.Sprintf( | ||
| `Your Coder workspace %s is scheduled to stop at %s.`, | ||
| ws.Name, | ||
| deadline.Format(time.Kitchen), | ||
| ) | ||
| } else { | ||
| title = fmt.Sprintf("Workspace %s stopping!", ws.Name) | ||
| body = fmt.Sprintf("Your Coder workspace %s is stopping any time now!", ws.Name) | ||
| } | ||
| // notify user with a native system notification (best effort) | ||
| _ = beeep.Notify(title, body, "") | ||
| } | ||
| return deadline.Truncate(time.Minute), callback | ||
| } | ||
| } | ||
100 changes: 100 additions & 0 deletionscoderd/autobuild/notify/notifier.go
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Would it make sense to move this into There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. We could move into There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. 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 resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| 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 | ||
| } | ||
123 changes: 123 additions & 0 deletionscoderd/autobuild/notify/notifier_test.go
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. 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 resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| 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) | ||
| } | ||
6 changes: 6 additions & 0 deletionsgo.mod
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.
Uh oh!
There was an error while loading.Please reload this page.
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.