Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jul 3, 2025

Link issues

fixes #6352

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

Enhance TcpSocketFactory unit tests by introducing DI-based mock socket providers, refactoring test adapters to use DataPackageAdapter, simplifying the package handler interface, and improving the auto-receive loop behavior.

New Features:

  • Allow injecting custom ISocketClientProvider via CreateClient overload for socket behavior simulation

Bug Fixes:

  • Ensure AutoReceiveAsync loop terminates upon remote socket closure

Enhancements:

  • Refactor tests to use DataPackageAdapter and ReceivedCallBack instead of SetDataHandler
  • Simplify IDataPackageHandler by removing default SendAsync and making ReceiveAsync abstract
  • Improve AutoReceiveAsync to run unconditionally and exit on zero-length read
  • Extend CreateClient to accept a ServiceCollection builder for DI customization

Tests:

  • Add unit tests for send timeout, error, and cancellation scenarios
  • Add tests for fixed-length, sticky, and delimiter package handlers using DataPackageAdapter
  • Remove outdated mock handlers and replace with mock socket providers

@bb-auto bb-auto bot added the test This is unit test label Jul 3, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jul 3, 2025

Reviewer's Guide

This PR enhances the TCP socket factory unit tests by refactoring the client creation to support DI-based ISocketClientProvider mocks, integrating the DataPackageAdapter into test flows, converting outdated DataPackageHandlerBase mocks into provider implementations, and updating the core DataPackageHandler abstraction and auto-receive logic to align with these patterns.

Class diagram for updated DataPackageHandler abstraction

classDiagram
    class IDataPackageHandler {
        +Func<ReadOnlyMemory<byte>, ValueTask>? ReceivedCallBack
        +ValueTask ReceiveAsync(ReadOnlyMemory<byte> data, CancellationToken token = default)
    }
    class DataPackageHandlerBase {
        <<abstract>>
        +ValueTask ReceiveAsync(ReadOnlyMemory<byte> data, CancellationToken token = default)
    }
    IDataPackageHandler <|.. DataPackageHandlerBase
Loading

Class diagram for TcpSocketClientBase auto-receive logic update

classDiagram
    class TcpSocketClientBase {
        - CancellationTokenSource? _receiveCancellationTokenSource
        +ValueTask<Memory<byte>> ReceiveAsync(CancellationToken token)
        -ValueTask AutoReceiveAsync()
    }
Loading

File-Level Changes

Change Details Files
Refactor unit tests for TcpSocketFactory to use DI-based socket providers and DataPackageAdapter
  • Add optional builder parameter to CreateClient for ISocketClientProvider injection
  • Replace client.SetDataHandler with builder.AddTransient of mock providers
  • Wire DataPackageAdapter via client.ReceivedCallBack for fix-length and delimiter package tests
  • Remove obsolete inline cancellation and DataPackageHandlerBase mock handlers
test/UnitTest/Services/TcpSocketFactoryTest.cs
Simplify DataPackageHandler abstraction by removing SendAsync method and enforcing abstract ReceiveAsync
  • Remove virtual SendAsync and concrete ReceiveAsync implementations in DataPackageHandlerBase
  • Define ReceiveAsync as abstract in DataPackageHandlerBase
  • Remove SendAsync signature from IDataPackageHandler interface
src/BootstrapBlazor/Services/TcpSocket/DataPackage/DataPackageHandlerBase.cs
src/BootstrapBlazor/Services/TcpSocket/DataPackage/IDataPackageHandler.cs
Refine automatic receive loop in TcpSocketClientBase to handle remote closures
  • Change loop condition to while(true) breaking on zero-length reads
  • Add comment clarifying exit condition when remote side closes or client is disposed
src/BootstrapBlazor/Services/TcpSocket/TcpSocketClientBase.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6352 Add unit tests for the DataPackageAdapter class.

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 3, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jul 3, 2025
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:

  • When registering mock ISocketClientProvider implementations in CreateClient, consider using ServiceCollection.Replace or removing existing registrations to ensure only your mock provider is resolved.
  • The updated AutoReceiveAsync loop now uses while(true) but drops the _receiveCancellationTokenSource.IsCancellationRequested check—re-add a cancellation check to avoid potential infinite loops.
  • You removed the abstract SendAsync from IDataPackageHandler and DataPackageHandlerBase—verify that all existing handlers are updated accordingly or provide a clear migration path for consumers.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- When registering mock ISocketClientProvider implementations in CreateClient, consider using ServiceCollection.Replace or removing existing registrations to ensure only your mock provider is resolved.
- The updated AutoReceiveAsync loop now uses `while(true)` but drops the `_receiveCancellationTokenSource.IsCancellationRequested` check—re-add a cancellation check to avoid potential infinite loops.
- You removed the abstract `SendAsync` from IDataPackageHandler and DataPackageHandlerBase—verify that all existing handlers are updated accordingly or provide a clear migration path for consumers.

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 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (37db88a) to head (df29077).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6353   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          717       718    +1     
  Lines        31573     31572    -1     
  Branches      4462      4462           
=========================================
- Hits         31573     31572    -1     
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 e755e92 into main Jul 3, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the test-socket branch July 3, 2025 06:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

test This is unit test

Projects

None yet

Development

Successfully merging this pull request may close these issues.

test(DataPackageAdapter): add unit test

2 participants