Skip to content

refactor(ITcpSocketFactory): move socket to extension package #6475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 23, 2025

Conversation

ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jul 23, 2025

Link issues

fixes #6474

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 the core library by relocating TCP socket factory, client implementations, data converters, and utilities to a separate extension package, removing all related code and tests from the main repository

Enhancements:

  • Extract built-in TCP socket services, data converters, and related infrastructure into an external extension package
  • Remove IP address and endpoint conversion utilities from the core Utility class
  • Clean up service registration by dropping default socket data converter methods from BootstrapBlazorServiceCollectionExtensions
  • Delete associated unit tests for the removed socket functionality

Copy link
Contributor

sourcery-ai bot commented Jul 23, 2025

Reviewer's Guide

This PR refactors the core library by extracting all TCP socket functionality into an extension package, removing related utilities, DI registrations, interfaces, implementations, converters and tests from the core.

Class diagram for removed TCP socket types

classDiagram
    class ITcpSocketFactory
    class ITcpSocketClient
    class ISocketClientProvider
    class DefaultTcpSocketFactory
    class DefaultTcpSocketClient
    class DefaultSocketClientProvider
    class ISocketDataConverter
    class SocketDataConverter
    class SocketDataConverterCollections
    class IDataPackageAdapter
    class DataPackageAdapter
    class IDataPackageHandler
    class DataPackageHandlerBase
    class DelimiterDataPackageHandler
    class FixLengthDataPackageHandler
    class ISocketDataPropertyConverter
    class SocketDataBoolConverter
    class SocketDataByteArrayConverter
    class SocketDataDoubleBigEndianConverter
    class SocketDataDoubleLittleEndianConverter
    class SocketDataEnumConverter
    class SocketDataInt16BigEndianConverter
    class SocketDataInt16LittleEndianConverter
    class SocketDataInt32BigEndianConverter
    class SocketDataInt32LittleEndianConverter
    class SocketDataInt64BigEndianConverter
    class SocketDataInt64LittleEndianConverter
    class SocketDataSingleBigEndianConverter
    class SocketDataSingleLittleEndianConverter
    class SocketDataStringConverter
    class SocketDataUInt16BigEndianConverter
    class SocketDataUInt16LittleEndianConverter
    class SocketDataUInt32BigEndianConverter
    class SocketDataUInt32LittleEndianConverter
    class SocketDataUInt64BigEndianConverter
    class SocketDataUInt64LittleEndianConverter
    class SocketClientOptions
    class SocketDataPropertyConverterAttribute
    class SocketDataTypeConverterAttribute
    class ITcpSocketClientExtensions
    class TcpSocketExtensions
    class SocketDataPropertyExtensions

    ITcpSocketFactory <|.. DefaultTcpSocketFactory
    ITcpSocketClient <|.. DefaultTcpSocketClient
    ISocketClientProvider <|.. DefaultSocketClientProvider
    ISocketDataConverter <|.. SocketDataConverter
    SocketDataConverterCollections o-- ISocketDataConverter
    IDataPackageAdapter <|.. DataPackageAdapter
    IDataPackageHandler <|.. DataPackageHandlerBase
    DataPackageHandlerBase <|-- DelimiterDataPackageHandler
    DataPackageHandlerBase <|-- FixLengthDataPackageHandler
    ISocketDataPropertyConverter <|.. SocketDataBoolConverter
    ISocketDataPropertyConverter <|.. SocketDataByteArrayConverter
    ISocketDataPropertyConverter <|.. SocketDataDoubleBigEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataDoubleLittleEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataEnumConverter
    ISocketDataPropertyConverter <|.. SocketDataInt16BigEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataInt16LittleEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataInt32BigEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataInt32LittleEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataInt64BigEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataInt64LittleEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataSingleBigEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataSingleLittleEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataStringConverter
    ISocketDataPropertyConverter <|.. SocketDataUInt16BigEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataUInt16LittleEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataUInt32BigEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataUInt32LittleEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataUInt64BigEndianConverter
    ISocketDataPropertyConverter <|.. SocketDataUInt64LittleEndianConverter
Loading

Class diagram for Utility class after TCP socket removal

classDiagram
    class Utility {
        +static IStringLocalizer? CreateLocalizer(Type type)
    }
    %% Note: ConvertToIPAddress and ConvertToIpEndPoint methods have been removed from Utility
Loading

File-Level Changes

Change Details Files
Remove TCP socket services, interfaces and implementations from core
  • Deleted ITcpSocketClientExtensions and all Services/TcpSocket modules
  • Removed DataConverter, DataPackageAdapter and DataPackageHandler components
  • Deleted default socket client provider, factory and related classes
src/BootstrapBlazor/Extensions/ITcpSocketClientExtensions.cs
src/BootstrapBlazor/Services/TcpSocket/*
Clean up socket-related DI extension methods
  • Removed AddSocketDataConverters call from AddBootstrapBlazor
  • Deleted AddSocketDataConverters and ConfigureSocketDataConverters methods
src/BootstrapBlazor/Extensions/BootstrapBlazorServiceCollectionExtensions.cs
Remove IP conversion utilities and related tests
  • Deleted ConvertToIPAddress and ConvertToIpEndPoint methods and related imports
  • Removed unit tests covering IP conversion methods
src/BootstrapBlazor/Utils/Utility.cs
test/UnitTest/Utils/UtilityTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6474 Move all socket-related code (including ITcpSocketFactory and related classes, extensions, and tests) from the main package to an extension package.

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 the enhancement New feature or request label Jul 23, 2025
@bb-auto bb-auto bot added this to the 9.8.0 milestone Jul 23, 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:

  • Consider adding Obsolete shims or aliases for the removed Utility.ConvertToIPAddress/ConvertToIpEndPoint methods so consumers get compile‐time guidance to the new extension package implementations.
  • Ensure the new extension package provides an AddTcpSocket (or similarly named) extension method that registers ITcpSocketFactory, SocketDataConverterCollections, and related services with appropriate lifetimes to fully replace the deleted AddSocketDataConverters call.
  • Verify that any codepaths or configuration that depended on SocketDataConverterCollections registration now point to the extension package equivalent to prevent missing DI registrations at runtime.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider adding Obsolete shims or aliases for the removed Utility.ConvertToIPAddress/ConvertToIpEndPoint methods so consumers get compile‐time guidance to the new extension package implementations.
- Ensure the new extension package provides an AddTcpSocket (or similarly named) extension method that registers ITcpSocketFactory, SocketDataConverterCollections, and related services with appropriate lifetimes to fully replace the deleted AddSocketDataConverters call.
- Verify that any codepaths or configuration that depended on SocketDataConverterCollections registration now point to the extension package equivalent to prevent missing DI registrations at runtime.

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.

Copy link

codecov bot commented Jul 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (54342ac) to head (7d97b0f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##              main     #6475    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files          749       714    -35     
  Lines        32366     31383   -983     
  Branches      4573      4431   -142     
==========================================
- Hits         32366     31383   -983     
Flag Coverage Δ
BB 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 ca862b0 into main Jul 23, 2025
7 checks passed
@ArgoZhang ArgoZhang deleted the refactor-socket branch July 23, 2025 08:15
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.

refactor(ITcpSocketFactory): move socket to extension package
1 participant