Skip to content

chore: fix race in cron close behavior (TestAgent_WriteVSCodeConfigs) #11243

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
Dec 18, 2023
Merged

chore: fix race in cron close behavior (TestAgent_WriteVSCodeConfigs) #11243

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2782521
chore: add unit test to excercise flake
Emyrk Dec 15, 2023
9b343c4
Implement a *fix for cron stop() before run()
Emyrk Dec 15, 2023
687f7f6
Add comment to protect order
Emyrk Dec 15, 2023
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
Prev Previous commit
Next Next commit
Implement a *fix for cron stop() before run() 
This fix still has a race condition. I do not see a clean solution
without modifying the cron libary. The cron library uses a boolean
to indicate running, and that boolean needs to be set to "true"
before we call "Close()". Or "Close()" should prevent "Run()"
from doing anything.

In either case, this solves the issue for a niche unit test bug
in which the test finishes, calling Close(), before there was
an oppertunity to start the go routine. It probably isn't worth
a lot of time investment, and this fix will suffice
  • Loading branch information
@Emyrk
Emyrk committed Dec 15, 2023
commit 9b343c49578400cb6c60aa5e92ee0825e9575f91
13 changes: 12 additions & 1 deletion agent/agentscripts/agentscripts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,18 @@ func (r *Runner) StartCron() {
// has exited by the time the `cron.Stop()` context returns, so we need to
// track it manually.
err := r.trackCommandGoroutine(func() {
r.cron.Run()
// Since this is run async, in quick unit tests, it is possible the
// Close() function gets called before we even start the cron.
// In these cases, the Run() will never end.
// So if we are closed, we just return, and skip the Run() entirely.
select {
case <-r.cronCtx.Done():
default:
// There is still a chance the Close() happens right here before we'
// r.cron.Run(). Fixing this requires modifying the cron package
// to add a hook for when the cron "running" flag is set.
r.cron.Run()
}
})
if err != nil {
r.Logger.Warn(context.Background(), "start cron failed", slog.Error(err))
Expand Down