feat(ISocketDataConverter): add ConfigureSocketDataConverters method #6463
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's GuideThis PR introduces a new ConfigureSocketDataConverters extension on IServiceCollection for centralized registration of socket data converters, simplifies the SocketDataConverterCollections API by renaming methods (and adding a default overload), and updates sample usage and unit tests to align with the new API. Class diagram for updated SocketDataConverterCollections APIclassDiagram
class SocketDataConverterCollections {
+AddTypeConverter<TEntity>(ISocketDataConverter<TEntity> converter)
+AddTypeConverter<TEntity>()
+AddPropertyConverter<TEntity>(Expression<Func<TEntity, object?>> propertyExpression, SocketDataPropertyConverterAttribute attribute)
}
class ISocketDataConverter {
<<interface>>
}
class ISocketDataConverter~TEntity~ {
<<interface>>
}
class SocketDataConverter~TEntity~ {
+SocketDataConverter(SocketDataConverterCollections parent)
}
class SocketDataPropertyConverterAttribute {
+Type
+Offset
+Length
}
SocketDataConverterCollections o-- ISocketDataConverter
SocketDataConverterCollections o-- SocketDataPropertyConverterAttribute
SocketDataConverter~TEntity~ ..|> ISocketDataConverter~TEntity~
SocketDataConverter~TEntity~ --|> ISocketDataConverter
Class diagram for new ConfigureSocketDataConverters extensionclassDiagram
class IServiceCollection {
}
class SocketDataConverterCollections {
}
class SocketDataConverterOptions {
+AddTypeConverter<TEntity>()
+AddPropertyConverter<TEntity>(...)
}
IServiceCollection <.. ConfigureSocketDataConverters
ConfigureSocketDataConverters : +ConfigureSocketDataConverters(Action<SocketDataConverterOptions> options)
ConfigureSocketDataConverters ..> SocketDataConverterOptions
SocketDataConverterOptions o-- SocketDataConverterCollections
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @ArgoZhang - I've reviewed your changes - here's some feedback:
- Consider adding obsolete wrappers for the removed AddOrUpdateTypeConverter and AddOrUpdatePropertyConverter methods to maintain backward compatibility and ease upgrades.
- Sealing SocketDataConverterCollections may break existing extension scenarios—verify consumers don’t rely on subclassing or remove the sealed modifier if not necessary.
- The sample Razor markup has an empty
tag—populate it with the actual ConfigureSocketDataConverters call to improve clarity.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider adding obsolete wrappers for the removed AddOrUpdateTypeConverter and AddOrUpdatePropertyConverter methods to maintain backward compatibility and ease upgrades.
- Sealing SocketDataConverterCollections may break existing extension scenarios—verify consumers don’t rely on subclassing or remove the sealed modifier if not necessary.
- The sample Razor markup has an empty <code> tag—populate it with the actual ConfigureSocketDataConverters call to improve clarity.
## Individual Comments
### Comment 1
<location> `src/BootstrapBlazor/Services/TcpSocket/DataConverter/SocketDataConverterCollections.cs:25` </location>
<code_context>
/// </summary>
/// <typeparam name="TEntity"></typeparam>
/// <param name="converter"></param>
- public void AddOrUpdateTypeConverter<TEntity>(ISocketDataConverter<TEntity> converter)
+ public void AddTypeConverter<TEntity>(ISocketDataConverter<TEntity> converter)
{
var type = typeof(TEntity);
</code_context>
<issue_to_address>
Renaming method removes 'OrUpdate', which may reduce clarity.
Since the method still updates existing converters, omitting 'OrUpdate' may mislead users into thinking it only adds. Please ensure the name clearly indicates its behavior.
</issue_to_address>
### Comment 2
<location> `src/BootstrapBlazor/Services/TcpSocket/DataConverter/SocketDataConverterCollections.cs:37` </location>
<code_context>
/// <typeparam name="TEntity"></typeparam>
/// <param name="propertyExpression"></param>
/// <param name="attribute"></param>
- public void AddOrUpdatePropertyConverter<TEntity>(Expression<Func<TEntity, object?>> propertyExpression, SocketDataPropertyConverterAttribute attribute)
+ public void AddPropertyConverter<TEntity>(Expression<Func<TEntity, object?>> propertyExpression, SocketDataPropertyConverterAttribute attribute)
{
if (propertyExpression.Body is MemberExpression memberExpression)
</code_context>
<issue_to_address>
Renaming method removes 'OrUpdate', which may reduce clarity.
The new method name may mislead users into thinking it only adds converters, when it also updates existing ones.
</issue_to_address>
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
src/BootstrapBlazor/Services/TcpSocket/DataConverter/SocketDataConverterCollections.cs
Show resolved
Hide resolved
src/BootstrapBlazor/Services/TcpSocket/DataConverter/SocketDataConverterCollections.cs
Show resolved
Hide resolved
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6463 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 749 749
Lines 32361 32362 +1
Branches 4572 4572
=========================================
+ Hits 32361 32362 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link issues
fixes #6462
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Add a new ConfigureSocketDataConverters extension and streamline the socket data converter API by renaming methods, adding a default overload, sealing the collections class, and updating samples and tests.
New Features:
Enhancements:
Documentation:
Tests: