doc(ITcpSocketClient): add Receive documentation

[ArgoZhang]

Link issues

fixes #6321

Summary By Copilot

Regression?

• Yes
• No

Risk

• High
• Medium
• Low

Verification

• Manual (required)
• Automated

Packaging changes reviewed?

• Yes
• No
• N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

• Doc is updated/provided or not needed
• Demo is updated/provided or not needed
• Merge the latest code from the main branch

Summary by Sourcery

Refactor DefaultTcpSocketClient to optimize connection setup and data reception by improving endpoint assignments, simplifying connection checks, and fixing buffer length assignment.

Bug Fixes:

• Set ConnectAsync return value based on actual client connection state
• Ensure buffer length variable is correctly assigned after data reception

Enhancements:

• Assign remote endpoint earlier in ConnectAsync
• Only start AutoReceiveAsync when the client is connected and auto-receive is enabled
• Use pattern matching for null and connection checks in ReceiveAsync
• Conditionally assign local endpoint after successful connection

[sourcery-ai]

Reviewer's Guide

This PR refactors DefaultTcpSocketClient by streamlining the ConnectAsync workflow (early endpoint assignment, conditional auto-receive, return-value logic), simplifying connection checks in ReceiveAsync, and correcting the buffer-length assignment in ReceiveCoreAsync.

Sequence diagram for updated ConnectAsync workflow in DefaultTcpSocketClient

sequenceDiagram
    participant Caller
    participant DefaultTcpSocketClient
    participant TcpClient

    Caller->>DefaultTcpSocketClient: ConnectAsync(endPoint, token)
    DefaultTcpSocketClient->>TcpClient: new TcpClient(localEndPoint)
    DefaultTcpSocketClient->>TcpClient: ConnectAsync(endPoint, connectionToken)
    alt _client.Connected
        DefaultTcpSocketClient->>DefaultTcpSocketClient: Set LocalEndPoint
        alt IsAutoReceive
            DefaultTcpSocketClient->>DefaultTcpSocketClient: Task.Run(AutoReceiveAsync)
        end
        DefaultTcpSocketClient-->>Caller: return true
    else not connected
        DefaultTcpSocketClient-->>Caller: return false
    end

Loading

Class diagram for refactored DefaultTcpSocketClient methods

classDiagram
    class DefaultTcpSocketClient {
        +ValueTask<bool> ConnectAsync(IPEndPoint endPoint, CancellationToken token)
        +ValueTask<Memory<byte>> ReceiveAsync(CancellationToken token = default)
        -ValueTask<int> ReceiveCoreAsync(TcpClient client, Memory<byte> buffer, CancellationToken receiveToken)
        LocalEndPoint : IPEndPoint
        _remoteEndPoint : IPEndPoint
        _client : TcpClient
        IsAutoReceive : bool
        ConnectTimeout : int
        DataPackageHandler
    }

    DefaultTcpSocketClient --> TcpClient
    DefaultTcpSocketClient --> IPEndPoint
    DefaultTcpSocketClient --> DataPackageHandler

Loading

File-Level Changes

Change	Details	Files
Restructure ConnectAsync logic for endpoint setup and return status	Assign _remoteEndPoint before attempting connection Guard auto-receive and LocalEndPoint assignment on _client.Connected Initialize LocalEndPoint only if Client.LocalEndPoint is IPEndPoint Set return flag based on _client.Connected instead of a hardcoded true	src/BootstrapBlazor/Services/TcpSocket/DefaultTcpSocketClient.cs
Simplify connection check in ReceiveAsync	Replace null-or-!Connected check with pattern matching (_client is not { Connected: true }) Maintain InvalidOperationException on disconnected client	src/BootstrapBlazor/Services/TcpSocket/DefaultTcpSocketClient.cs
Ensure correct buffer length in ReceiveCoreAsync	Set len = buffer.Length after receiving data	src/BootstrapBlazor/Services/TcpSocket/DefaultTcpSocketClient.cs

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#6321	Optimize the code in the ITcpSocketClient implementation.	✅

Possibly linked issues

• doc(ITcpSocketClient): add Receive documentation #6321: The PR refactors and optimizes TcpSocketClient code, addressing the issue's goal.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[Copilot]

Pull Request Overview

This PR refactors the ITcpSocketClient connection and data receiving logic to optimize code structure and improve clarity in endpoint management and asynchronous operations.

• Moves remote endpoint assignment before initiating connection.
• Utilizes pattern matching for client connection checking.
• Adjusts buffer length handling and background task invocation for auto-receive.

Comments suppressed due to low confidence (1)

src/BootstrapBlazor/Services/TcpSocket/DefaultTcpSocketClient.cs:196

• Assigning 'len' directly to 'buffer.Length' may not reflect the actual number of bytes received by DataPackageHandler.ReceiveAsync. Please verify that this assignment is correct and aligns with the intended packet handling logic.

                len = buffer.Length;

[sourcery-ai]

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

• Consider moving the _remoteEndPoint = endPoint assignment to after you’ve verified the connection succeeded so you don’t store an endpoint on failed connects.
• In ReceiveCoreAsync, setting len = buffer.Length may not reflect the actual bytes received—use the actual count returned by the receive call instead of the buffer’s capacity.
• When you fire off AutoReceiveAsync with Task.Run, wrap it in a try/catch or attach a continuation to log exceptions so you don’t end up with unobserved task faults.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- Consider moving the `_remoteEndPoint = endPoint` assignment to after you’ve verified the connection succeeded so you don’t store an endpoint on failed connects.
- In `ReceiveCoreAsync`, setting `len = buffer.Length` may not reflect the actual bytes received—use the actual count returned by the receive call instead of the buffer’s capacity.
- When you fire off `AutoReceiveAsync` with `Task.Run`, wrap it in a try/catch or attach a continuation to log exceptions so you don’t end up with unobserved task faults.

## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor/Services/TcpSocket/DefaultTcpSocketClient.cs:36` </location>
<code_context>

             // 创建新的 TcpClient 实例
             _client ??= new TcpClient(localEndPoint);
+            _remoteEndPoint = endPoint;

             var connectionToken = token;
</code_context>

<issue_to_address>
Assigning _remoteEndPoint before connection may not reflect the actual remote endpoint.

Assign _remoteEndPoint after confirming a successful connection to ensure it accurately reflects the connected endpoint.
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codecov]

Codecov Report

Attention: Patch coverage is 96.15385% with 1 line in your changes missing coverage. Please review.

Project coverage is 99.99%. Comparing base (2abfb68) to head (2e4cb28).

Files with missing lines	Patch %	Lines
...lazor/Services/TcpSocket/DefaultTcpSocketClient.cs	96.15%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6322   +/-   ##
=======================================
  Coverage   99.98%   99.99%           
=======================================
  Files         715      715           
  Lines       31519    31514    -5     
  Branches     4447     4449    +2     
=======================================
- Hits        31515    31513    -2     
+ Misses          3        0    -3     
  Partials        1        1           

Flag	Coverage Δ
BB	99.99% <96.15%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.