-
Notifications
You must be signed in to change notification settings - Fork 461
fix(orchestrator): stop Checks health-loop leaking #2739
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 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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,50 @@ | ||
| //go:build linux | ||
|
|
||
| package sandbox | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
| "time" | ||
| ) | ||
|
|
||
| // TestChecks_StopBeforeStart_DoesNotStartHealthLoop is a regression test for | ||
| // the Checks start/stop race. | ||
| // | ||
| // Checks.Start is launched in its own goroutine (go sbx.Checks.Start(execCtx)), | ||
| // so the sandbox teardown path can run Checks.Stop before that goroutine is | ||
| // scheduled. execCtx is derived via context.WithoutCancel and never | ||
| // auto-cancels, so the logHealth ticker loop is only ever ended by Stop | ||
| // cancelling the context Start installs. If Start enters logHealth after Stop | ||
| // already ran, the loop — and the per-tick health-check HTTP dials it spawns — | ||
| // leak for the process lifetime. | ||
| // | ||
| // Start must observe the prior Stop and return without entering logHealth. | ||
| func TestChecks_StopBeforeStart_DoesNotStartHealthLoop(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| c := &Checks{} | ||
|
|
||
| // Teardown wins the race: Stop runs before the Start goroutine. | ||
| c.Stop() | ||
|
|
||
| returned := make(chan struct{}) | ||
| go func() { | ||
| c.Start(context.Background()) | ||
| close(returned) | ||
| }() | ||
|
|
||
| select { | ||
| case <-returned: | ||
| // Start observed the prior Stop and skipped logHealth. | ||
| case <-time.After(2 * time.Second): | ||
| t.Fatal("Checks.Start entered the health loop after a prior Stop — goroutine leak") | ||
| } | ||
|
|
||
| c.mu.Lock() | ||
| cancelCtx := c.cancelCtx | ||
| c.mu.Unlock() | ||
| if cancelCtx != nil { | ||
| t.Fatal("Checks.Start installed a health-loop context despite a prior Stop") | ||
| } | ||
| } |
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.
While the current change correctly handles the race between
StartandStop, theStartfunction is not idempotent. IfStartis called more than once, it will overwritec.cancelCtx, leaking the previously started health-check goroutine as its context can no longer be cancelled. To prevent this potential resource leak,Startshould also check if it has already been started by verifying thatc.cancelCtxis nil.