feat(ThrottleDispatcher): refine code improve readability #6379
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
Reviewer's GuideRefines the ThrottleDispatcher implementation by removing redundant synchronization fields, unifying and simplifying throttling logic with async/await and timestamp updates, streamlining the synchronous Throttle method’s flow, and updating unit tests to align with the new behavior. Class diagram for updated ThrottleDispatcherclassDiagram
class ThrottleDispatcher {
- DateTime? _invokeTime
+ ThrottleDispatcher(ThrottleOptions options)
+ bool ShouldWait()
+ void Throttle(Action action, CancellationToken token = default)
- async Task InternalThrottleAsync(Func<Task> function, CancellationToken cancellationToken = default)
}
class ThrottleOptions {
+ TimeSpan Interval
+ bool DelayAfterExecution
+ bool ResetIntervalOnException
}
ThrottleDispatcher --> ThrottleOptions
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @ArgoZhang - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `src/BootstrapBlazor/Services/ThrottleDispatcher.cs:19` </location>
<code_context>
/// </summary>
/// <returns></returns>
- protected virtual bool ShouldWait() => _busy || _invokeTime.HasValue && (DateTime.UtcNow - _invokeTime.Value) < options.Interval;
+ protected virtual bool ShouldWait() => _invokeTime.HasValue && (DateTime.UtcNow - _invokeTime.Value) < options.Interval;
/// <summary>
</code_context>
<issue_to_address>
Removal of the _busy flag may introduce concurrency issues.
Without the _busy flag and lock, concurrent calls may bypass throttling. If thread safety is required, add appropriate synchronization to avoid race conditions.
</issue_to_address>
### Comment 2
<location> `src/BootstrapBlazor/Services/ThrottleDispatcher.cs:63` </location>
<code_context>
}
- lock (_locker)
+ _invokeTime = DateTime.UtcNow;
+
+ try
{
- if (ShouldWait())
+ await function();
+ if (options.DelayAfterExecution)
{
- return LastTask;
+ _invokeTime = DateTime.UtcNow;
}
-
</code_context>
<issue_to_address>
Setting _invokeTime before and after function execution may not be necessary.
Clarify whether throttling should be based on the start or end of execution, and update _invokeTime in only one place to reflect that.
</issue_to_address>
### Comment 3
<location> `test/UnitTest/Services/ThrottleTest.cs:91` </location>
<code_context>
+ Assert.Equal(1, count);
- Assert.ThrowsAny<InvalidOperationException>(() => dispatcher.Throttle(() => throw new InvalidOperationException()));
+ dispatcher.Throttle(() => throw new InvalidOperationException());
// 发生错误后可以立即执行下一次任务，不限流
</code_context>
<issue_to_address>
Missing assertion for expected exception in sync Throttle after async exception.
Please reintroduce an assertion (e.g., Assert.Throws) to verify that the sync Throttle call throws as expected, or clarify if this change is intentional.
</issue_to_address>
<suggested_fix>
<<<<<<< SEARCH
dispatcher.Throttle(() => throw new InvalidOperationException());
// 发生错误后可以立即执行下一次任务，不限流
=======
Assert.ThrowsAny<InvalidOperationException>(() => dispatcher.Throttle(() => throw new InvalidOperationException()));
// 发生错误后可以立即执行下一次任务，不限流
>>>>>>> REPLACE
</suggested_fix>
### Comment 4
<location> `test/UnitTest/Services/ThrottleTest.cs:120` </location>
<code_context>
cts = new CancellationTokenSource(100);
- await Assert.ThrowsAnyAsync<OperationCanceledException>(() => dispatcher.ThrottleAsync(async () =>
+ await dispatcher.ThrottleAsync(async () =>
{
await Task.Delay(300);
- }, cts.Token));
+ }, cts.Token);
}
</code_context>
<issue_to_address>
Missing assertion for OperationCanceledException in ThrottleAsync with cancellation.
Restoring the assertion ensures that cancellation is properly handled and exceptions are surfaced as expected.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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 #6378
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Refine ThrottleDispatcher to simplify its implementation and improve readability by removing unnecessary locks and flags, unify sync/async paths with async/await, and update tests to align with corrected reset-on-exception and cancellation behaviors
Bug Fixes:
Enhancements:
Tests: