Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jul 11, 2025

Link issues

fixes #6391

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

Add OnConnecting and OnConnected callbacks around the TCP client connection process, refine auto-reconnect and resource cleanup logic, update logging behavior, introduce an auto-reconnect sample with mock disconnect server, and extend unit tests accordingly.

New Features:

  • Expose OnConnecting and OnConnected lifecycle hooks in ITcpSocketClient and DefaultTcpSocketClient
  • Add an auto-reconnect demo component and mock disconnect server service for showcasing automatic reconnection
  • Add menu localization entry for the new auto-connect sample

Bug Fixes:

  • Close the underlying socket when a zero-length read occurs in DefaultSocketClientProvider

Enhancements:

  • Unify resource cleanup by extracting CloseCoreAsync and cancel auto-reconnect tokens in CloseAsync
  • Move log gating into the Log method and always log send/receive operations unconditionally

Documentation:

  • Clarify adapter example description and update sample UI in Adapters.razor
  • Add localization and routing for auto-reconnect sample in MenusLocalizerExtensions

Tests:

  • Add unit tests for OnConnecting and OnConnected callbacks
  • Add receive behavior tests for DefaultSocketClientProvider and DefaultTcpSocketClient

@bb-auto bb-auto bot added the enhancement New feature or request label Jul 11, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jul 11, 2025

Reviewer's Guide

This PR introduces OnConnecting and OnConnected hooks to the TCP client API, refactors connection cleanup and auto-reconnect flows in DefaultTcpSocketClient, enhances disconnection detection and logging, adds a Blazor auto-reconnect demo with a mock disconnect server, and expands unit tests to cover the new callbacks and disconnect scenarios.

Sequence diagram for TCP client connection with OnConnecting and OnConnected hooks

sequenceDiagram
    participant User as actor User
    participant Client as DefaultTcpSocketClient
    participant Server as TcpServer
    User->>Client: ConnectAsync()
    alt OnConnecting callback set
        Client->>Client: await OnConnecting()
    end
    Client->>Server: Establish TCP connection
    alt OnConnected callback set
        Client->>Client: await OnConnected()
    end
    Server-->>Client: Connection established
Loading

Class diagram for ITcpSocketClient and DefaultTcpSocketClient with new connection callbacks

classDiagram
    class ITcpSocketClient {
        +Func<ReadOnlyMemory<byte>, ValueTask>? ReceivedCallBack
        +Func<Task>? OnConnecting
        +Func<Task>? OnConnected
        +ValueTask<bool> ConnectAsync(IPEndPoint, CancellationToken)
        +ValueTask CloseAsync()
    }
    class DefaultTcpSocketClient {
        +Func<ReadOnlyMemory<byte>, ValueTask>? ReceivedCallBack
        +Func<Task>? OnConnecting
        +Func<Task>? OnConnected
        +ValueTask<bool> ConnectAsync(IPEndPoint, CancellationToken)
        +ValueTask CloseAsync()
        -ValueTask CloseCoreAsync()
        -void Reconnect()
        -void Log(LogLevel, Exception?, string?)
    }
    ITcpSocketClient <|.. DefaultTcpSocketClient
Loading

File-Level Changes

Change Details Files
Introduce OnConnecting and OnConnected callbacks
  • Add OnConnecting and OnConnected properties to ITcpSocketClient
  • Invoke OnConnecting/OnConnected in DefaultTcpSocketClient.ConnectAsync
  • Assert callback invocation in TcpSocketFactoryTest
src/BootstrapBlazor/Services/TcpSocket/ITcpSocketClient.cs
src/BootstrapBlazor/Services/TcpSocket/DefaultTcpSocketClient.cs
test/UnitTest/Services/TcpSocketFactoryTest.cs
Refactor connection cleanup and auto-reconnect logic
  • Extract CloseCoreAsync and update CloseAsync to cancel/dispose reconnect token
  • Ensure _autoConnectTokenSource is initialized before reconnect
  • Use CloseCoreAsync in ConnectCoreAsync to release resources
src/BootstrapBlazor/Services/TcpSocket/DefaultTcpSocketClient.cs
Detect disconnections on zero-length reads
  • Close underlying TcpClient when ReceiveAsync returns zero bytes
  • Trigger auto-reconnect on zero-length reads in ReceiveCoreAsync
src/BootstrapBlazor/Services/TcpSocket/DefaultSocketClientProvider.cs
src/BootstrapBlazor/Services/TcpSocket/DefaultTcpSocketClient.cs
Enhance logging behavior based on EnableLog setting
  • Wrap Log calls under options.EnableLog in DefaultTcpSocketClient
  • Always log send/receive when logging is enabled
src/BootstrapBlazor/Services/TcpSocket/DefaultTcpSocketClient.cs
Add Blazor auto-reconnect demo and mock server
  • Create AutoReconnects Razor component and code-behind
  • Register MockDisconnectServerService in ServiceCollectionExtensions
  • Add SocketAutoConnect menu entry in MenusLocalizerExtensions
src/BootstrapBlazor.Server/Components/Samples/Sockets/AutoReconnects.razor
src/BootstrapBlazor.Server/Components/Samples/Sockets/AutoReconnects.razor.cs
src/BootstrapBlazor.Server/Extensions/ServiceCollectionExtensions.cs
src/BootstrapBlazor.Server/Extensions/MenusLocalizerExtensions.cs
src/BootstrapBlazor.Server/Services/MockDisconnectServerService.cs
Expand unit tests for disconnect scenarios
  • Add test for ReceiveAsync behavior when server disconnects
  • Start and manage a mock TCP server in DefaultSocketClientProviderTest
test/UnitTest/Services/DefaultSocketClientProviderTest.cs
Update sample description for Adapters.razor
  • Enhance list items and punctuation in the data adapter example description
src/BootstrapBlazor.Server/Components/Samples/Sockets/Adapters.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#6391 Add an OnConnecting callback to ITcpSocketClient that is executed before a connection attempt.
#6391 Add an OnConnected callback to ITcpSocketClient that is executed after a connection is successfully established.

Possibly linked issues


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

@bb-auto bb-auto bot added this to the 9.8.0 milestone Jul 11, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) July 11, 2025 08:16
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

  • Ensure existing _autoConnectTokenSource is cancelled and disposed before reassigning a new one in ConnectAsync to avoid leaking cancellation tokens.
  • Wrap invocations of OnConnecting and OnConnected in try/catch blocks so that exceptions in user callbacks don’t break the connection flow.
  • Move MockDisconnectServerService under the BootstrapBlazor.Server.Services namespace (instead of Longbow.Tasks.Services) to keep project namespace consistency.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Ensure existing _autoConnectTokenSource is cancelled and disposed before reassigning a new one in ConnectAsync to avoid leaking cancellation tokens.
- Wrap invocations of OnConnecting and OnConnected in try/catch blocks so that exceptions in user callbacks don’t break the connection flow.
- Move MockDisconnectServerService under the BootstrapBlazor.Server.Services namespace (instead of Longbow.Tasks.Services) to keep project namespace consistency.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Jul 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (39578ed) to head (c9c7ec0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6392   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          718       718           
  Lines        31712     31729   +17     
  Branches      4473      4477    +4     
=========================================
+ Hits         31712     31729   +17     
Flag Coverage Δ
BB 100.00% <100.00%> (?)

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.

@ArgoZhang ArgoZhang merged commit 5d2ed31 into main Jul 11, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the doc-socket branch July 11, 2025 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(ITcpSocketClient): add OnConnecting callback

2 participants