feat(ITcpSocketClient): add SendAsync extensions method #6269
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
Contributor
Reviewer's GuideAdds a new string-based SendAsync extension on ITcpSocketClient that wraps the existing byte-array overload with encoding and cancellation support, updates unit tests to leverage the new overload, and refines sample documentation to clarify sticky-packet and fragmentation handling. Class diagram for ITcpSocketClientExtensions and SendAsync methodclassDiagram
class ITcpSocketClient {
<<interface>>
SendAsync(byte[] buffer, CancellationToken token) ValueTask<bool>
}
class ITcpSocketClientExtensions {
<<static>>
+SendAsync(client: ITcpSocketClient, content: string, encoding: Encoding = null, token: CancellationToken = default) ValueTask<bool>
}
ITcpSocketClientExtensions ..> ITcpSocketClient : extends
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}
Contributor
There was a problem hiding this comment.
Hey @ArgoZhang - I've reviewed your changes - here's some feedback:
- Add argument validation in the SendAsync extension (e.g. throw ArgumentNullException for null client or content) to match your XML docs contract.
- Add unit tests for the new string-overload SendAsync covering different encodings, empty-string edge cases, and null‐encoding fallback to verify correct byte conversion.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Add argument validation in the SendAsync extension (e.g. throw ArgumentNullException for null client or content) to match your XML docs contract.
- Add unit tests for the new string-overload SendAsync covering different encodings, empty-string edge cases, and null‐encoding fallback to verify correct byte conversion.
## Individual Comments
### Comment 1
<location> `src/BootstrapBlazor/Extensions/ITcpSocketClientExtensions.cs:30` </location>
<code_context>
+ /// langword="true"/> if the content was sent successfully; otherwise, <see langword="false"/>.</returns>
+ public static ValueTask<bool> SendAsync(this ITcpSocketClient client, string content, Encoding? encoding = null, CancellationToken token = default)
+ {
+ var buffer = encoding?.GetBytes(content) ?? Encoding.UTF8.GetBytes(content);
+ return client.SendAsync(buffer, token);
+ }
</code_context>
<issue_to_address>
No null or empty check for 'content' parameter.
Since the XML docs specify 'content' must not be null or empty, add a guard clause to throw an exception if this condition is violated to prevent unintended behavior.
</issue_to_address>
### Comment 2
<location> `test/UnitTest/Services/TcpSocketFactoryTest.cs:98` </location>
<code_context>
- var data = new ReadOnlyMemory<byte>([1, 2, 3, 4, 5]);
- var result = await client.SendAsync(data, cst.Token);
+ var result = await client.SendAsync("test", null, cst.Token);
Assert.False(result);
</code_context>
<issue_to_address>
Consider adding tests for edge cases in the new SendAsync extension method.
Please add tests for cases like empty string content, different encodings, very large strings, client not connected or disposed, and exception handling to ensure robustness.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6269 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 711 712 +1
Lines 31379 31383 +4
Branches 4432 4433 +1
=========================================
+ Hits 31379 31383 +4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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 #6267
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Introduce a string-based SendAsync extension for ITcpSocketClient and update tests and sample docs to demonstrate and explain its usage.
New Features:
Enhancements:
Documentation:
Tests: