Skip to content

doc(TcpSocket): update TcpSokcet sample code #6477

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 5 commits into from
Jul 23, 2025
Merged

Conversation

ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jul 23, 2025

Link issues

fixes #6476

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

Update TcpSocket sample documentation to reflect renamed converter API and include missing package tips

Documentation:

  • Replace outdated SocketData* converter attributes and classes with Data*Converter counterparts in sample code
  • Update method names in samples from ConfigureSocketDataConverters to ConfigureDataConverters
  • Add PackageTips component for BootstrapBlazor.TcpSocket in SocketFactories and Notice samples

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Jul 23, 2025
Copy link
Contributor

sourcery-ai bot commented Jul 23, 2025

Reviewer's Guide

This PR revises TCP socket sample code to use the new generic data converter API by renaming attributes, types, interfaces, and configuration methods, and adds package usage tips for the BootstrapBlazor.TcpSocket library.

Class diagram for configuration API changes in data converters

classDiagram
    class DataConvertersOptions {
        +AddTypeConverter<T>()
        +AddPropertyConverter<T>(property, DataPropertyConverterAttribute)
    }
    class IServiceCollection {
        +ConfigureDataConverters(Action<DataConvertersOptions> options)
    }
    IServiceCollection --> DataConvertersOptions : configures
    DataConvertersOptions --> DataPropertyConverterAttribute : uses
Loading

File-Level Changes

Change Details Files
Renamed converter attributes and interfaces in samples
  • Replaced SocketDataTypeConverterAttribute with DataTypeConverterAttribute
  • Replaced SocketDataPropertyConverterAttribute with DataPropertyConverterAttribute
  • Updated generic converter type from SocketDataConverter to DataConverter
  • Replaced ISocketDataPropertyConverter/ISocketDataConverter interfaces with IDataPropertyConverter/IDataConverter
src/BootstrapBlazor.Server/Components/Samples/Sockets/DataEntities.razor
src/BootstrapBlazor.Server/Components/Samples/SocketFactories.razor
src/BootstrapBlazor.Server/Components/Samples/Sockets/Notice.razor
Updated built-in converter list naming
  • Renamed all SocketDataXXXConverter entries to DataXXXConverter in converter list
src/BootstrapBlazor.Server/Components/Samples/Sockets/DataEntities.razor
Adjusted configuration API in factory sample
  • Changed ConfigureSocketDataConverters to ConfigureDataConverters
  • Updated AddPropertyConverter attribute instantiation to use DataPropertyConverterAttribute
src/BootstrapBlazor.Server/Components/Samples/SocketFactories.razor
Added package usage tip component
  • Inserted in samples
src/BootstrapBlazor.Server/Components/Samples/SocketFactories.razor
src/BootstrapBlazor.Server/Components/Samples/Sockets/Notice.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#6476 Update the TcpSocket sample code in the documentation to use the new Data* naming conventions (e.g., DataTypeConverterAttribute, DataPropertyConverterAttribute) instead of the old SocketData* names.

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 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 and they look great!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor.Server/Components/Samples/Sockets/DataEntities.razor:66` </location>
<code_context>
     </ul>
     <p>自定义数据类型转化器示例</p>
-    <Pre>[SocketTypeDataConverter(Type = typeof(SocketDataConverter&lt;MockEntity&gt;))]
+    <Pre>[SocketTypeDataConverter(Type = typeof(DataConverter&lt;MockEntity&gt;))]
 class MockEntity
 {
</code_context>

<issue_to_address>
Check for consistency in attribute naming.

If the difference in naming is intentional, please document the distinction; otherwise, consider using consistent attribute names throughout.
</issue_to_address>

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 (ca862b0) to head (2f0b07f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6477   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          714       714           
  Lines        31383     31383           
  Branches      4431      4431           
=========================================
  Hits         31383     31383           
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 4ea6624 into main Jul 23, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the refactor-socket branch July 23, 2025 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc(TcpSocket): update TcpSokcet sample code
1 participant