fix(timingwheel): add missing Wait() call and improve code clarity #5315
Conversation
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
8a6eb61 to
5aea2d3
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a critical bug in the TimingWheel's drainAll function and improves code clarity in the runTasks function. The main issue was that drainAll returned immediately without waiting for scheduled tasks to complete, potentially causing race conditions.
- Added missing
runner.Wait()call indrainAllto ensure all drain tasks complete before returning - Improved code clarity in
runTasksby copying the loop variable to follow Go best practices - Added comprehensive test suite to verify drain operations and task execution under various conditions
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| core/collection/timingwheel.go | Fixed critical bug by adding runner.Wait() in drainAll function; improved loop variable capture pattern in runTasks for better code clarity |
| core/collection/timingwheel_issue5314_test.go | Added comprehensive test suite with three tests covering drain wait behavior, multiple task execution, and concurrent stress testing scenarios |
Fixes zeromicro#5314 Changes: - Add runner.Wait() in drainAll to ensure all scheduled tasks complete before returning - Copy loop variable in runTasks for better defensive programming and code clarity The missing Wait() call was a real bug that could cause race conditions when drainAll returned before all scheduled tasks completed. The loop variable copy in runTasks follows Go best practices and makes the code more resilient to future changes. All existing tests pass with these changes. Signed-off-by: kevin <[email protected]>
5aea2d3 to
e29febc
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Fixes #5314
This PR addresses the issues reported in the TimingWheel implementation:
Changes Made
Added
runner.Wait()indrainAll- This is the critical bug fixCopy loop variable in
runTasks- Code quality improvementtasks[i].key, tasks[i].valuetotask.key, task.valuewith a local copyRunSafeexecutes synchronously), this change:Testing
timingwheel_issue5314_test.goto verify:Analysis Summary
The closure variable captures themselves were not causing bugs in the current implementation (task is redeclared in loop body, RunSafe executes synchronously), but the missing
runner.Wait()was a real bug that needed fixing. The suggested improvements enhance code quality and follow Go idioms.