-
Notifications
You must be signed in to change notification settings - Fork 647
bug: Fixes some correctness bug with ContextWatchdog #1688
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
4 commits
Select commit
Hold shift + click to select a range
ee01ff0
bug: Fixes some correctness bug with ContextWatchdog
kavirajk 260636b
skip the synctest tests for Go versions less than 1.24
kavirajk 3c6277d
replace skip test with build tags.
kavirajk 0f4bf5b
chore: Fix missin imports after removing skip helper
kavirajk 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,89 @@ | ||
| //go:build go1.25 | ||
|
|
||
| package clickhouse | ||
|
|
||
| import ( | ||
| "context" | ||
| "sync/atomic" | ||
| "testing" | ||
| "testing/synctest" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestContextWatchdog(t *testing.T) { | ||
| t.Run("callback should be called once", func(t *testing.T) { | ||
| called := atomic.Int32{} | ||
| ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond) | ||
| defer cancel() | ||
|
|
||
| stopCW := contextWatchdog(ctx, func() { | ||
| called.Add(1) | ||
| }) | ||
|
|
||
| <-ctx.Done() | ||
|
|
||
| // Give it some more time to make sure watch dog has enough time to | ||
| // call callback multiple times | ||
| time.Sleep(100 * time.Millisecond) | ||
| assert.Equal(t, int32(1), called.Load(), "callback should be called only once") | ||
|
|
||
| stopCW() | ||
| assert.Equal(t, int32(1), called.Load(), "callback should be called only once even after stopping watchdog") | ||
| }) | ||
|
|
||
| t.Run("callback should not be called during normal exit before context cancellation", func(t *testing.T) { | ||
| called := atomic.Int32{} | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| defer cancel() | ||
|
|
||
| stopCW := contextWatchdog(ctx, func() { | ||
| called.Add(1) | ||
| }) | ||
| stopCW() // normal exit | ||
|
|
||
| assert.Equal(t, int32(0), called.Load(), "callback should not be called during normal exit") | ||
| }) | ||
|
|
||
| t.Run("No goroutines should be left out after stopping ContextWatchdog", func(t *testing.T) { | ||
| synctest.Test(t, func(t *testing.T) { | ||
| // when context is cancelled | ||
| called := atomic.Int32{} | ||
| ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond) | ||
| defer cancel() | ||
|
|
||
| stopCW := contextWatchdog(ctx, func() { | ||
| called.Add(1) | ||
| }) | ||
|
|
||
| <-ctx.Done() | ||
|
|
||
| // Give it some more time to make sure watch dog has enough time to | ||
| // call callback multiple times | ||
| time.Sleep(100 * time.Millisecond) | ||
| assert.Equal(t, int32(1), called.Load(), "callback should be called only once") | ||
|
|
||
| stopCW() | ||
| assert.Equal(t, int32(1), called.Load(), "callback should be called only once even after stopping watchdog") | ||
|
|
||
| synctest.Wait() | ||
| }) | ||
|
|
||
| synctest.Test(t, func(t *testing.T) { | ||
| // during normal exit | ||
| called := atomic.Int32{} | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| defer cancel() | ||
|
|
||
| stopCW := contextWatchdog(ctx, func() { | ||
| called.Add(1) | ||
| }) | ||
| stopCW() // normal exit | ||
|
|
||
| assert.Equal(t, int32(0), called.Load(), "callback should not be called during normal exit") | ||
|
|
||
| synctest.Wait() | ||
| }) | ||
| }) | ||
| } | ||
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.
Can we removed once we upgrade the Go tool chain to v1.25.
#1689