Conversation
Contributor
Reviewer's GuideRefactors ChangeDetectionCleanTask to replace the cancellation-token-based loop with a PeriodicTimer-managed loop, introduces deterministic timer lifecycle handling under a lock, and adds more focused unit tests that validate timer creation, disposal, and the clean loop behavior using a dynamic-assembly type. Sequence diagram for ChangeDetectionCleanTask refactor to PeriodicTimersequenceDiagram
participant Caller
participant ChangeDetectionCleanTask
participant CacheManager
participant PeriodicTimer
Caller->>ChangeDetectionCleanTask: Run()
activate ChangeDetectionCleanTask
ChangeDetectionCleanTask->>CacheManager: Options
CacheManager-->>ChangeDetectionCleanTask: ChangeDetectionTaskInterval
ChangeDetectionCleanTask->>PeriodicTimer: new PeriodicTimer(interval)
ChangeDetectionCleanTask->>ChangeDetectionCleanTask: _timer = timer
ChangeDetectionCleanTask->>ChangeDetectionCleanTask: Task.Run(() => Clean(timer))
deactivate ChangeDetectionCleanTask
loop until WaitForNextTickAsync returns false
ChangeDetectionCleanTask->>PeriodicTimer: WaitForNextTickAsync()
PeriodicTimer-->>ChangeDetectionCleanTask: true
ChangeDetectionCleanTask->>ChangeDetectionCleanTask: DoTask()
end
Caller->>ChangeDetectionCleanTask: Stop()
activate ChangeDetectionCleanTask
ChangeDetectionCleanTask->>PeriodicTimer: Dispose()
ChangeDetectionCleanTask->>ChangeDetectionCleanTask: _timer = null
deactivate ChangeDetectionCleanTask
PeriodicTimer-->>ChangeDetectionCleanTask: WaitForNextTickAsync() returns false
ChangeDetectionCleanTask-->>Caller: Clean loop exits
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- In
Clean, disposing_timerfromStopwhile the loop is awaitingWaitForNextTickAsynccan result in an unhandledObjectDisposedException; consider catching this (or using a cancellation token) so the loop exits cleanly rather than faulting_cleanTask. - The new
CleanLoop_Oktest relies on the privateClean(PeriodicTimer)signature and the use ofPeriodicTimeritself, tightly coupling the test to implementation details; consider driving the clean loop via a higher-level trigger (e.g., a cancellation token or a public hook) to make future refactors easier.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In `Clean`, disposing `_timer` from `Stop` while the loop is awaiting `WaitForNextTickAsync` can result in an unhandled `ObjectDisposedException`; consider catching this (or using a cancellation token) so the loop exits cleanly rather than faulting `_cleanTask`.
- The new `CleanLoop_Ok` test relies on the private `Clean(PeriodicTimer)` signature and the use of `PeriodicTimer` itself, tightly coupling the test to implementation details; consider driving the clean loop via a higher-level trigger (e.g., a cancellation token or a public hook) to make future refactors easier.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8166 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 766 766
Lines 34234 34225 -9
Branches 4701 4699 -2
=========================================
- Hits 34234 34225 -9
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Link issues
fixes #8165
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Refine the change detection cleanup task to use a timer-driven loop and strengthen its test coverage.
Enhancements:
Tests: