doc(ISocketDataPropertyConverter): add ISocketDataPropertyConverter documentation #6425
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 hardens the socket data property converters by adding data length guards before binary parsing, corrects an attribute reference in the converter base class comment, refines the demo menu entries, and provides comprehensive documentation examples for ISocketDataPropertyConverter usage. Class diagram for SocketDataProperty converters with data length guardclassDiagram
class ISocketDataPropertyConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataInt32BigEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataInt32LittleEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataInt64BigEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataInt64LittleEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataDoubleBigEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataDoubleLittleEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataInt16BigEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataInt16LittleEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataSingleBigEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataSingleLittleEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataUInt16BigEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataUInt16LittleEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataUInt32BigEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataUInt32LittleEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataUInt64BigEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
class SocketDataUInt64LittleEndianConverter {
+object? Convert(ReadOnlyMemory<byte> data)
}
ISocketDataPropertyConverter <|.. SocketDataInt32BigEndianConverter
ISocketDataPropertyConverter <|.. SocketDataInt32LittleEndianConverter
ISocketDataPropertyConverter <|.. SocketDataInt64BigEndianConverter
ISocketDataPropertyConverter <|.. SocketDataInt64LittleEndianConverter
ISocketDataPropertyConverter <|.. SocketDataDoubleBigEndianConverter
ISocketDataPropertyConverter <|.. SocketDataDoubleLittleEndianConverter
ISocketDataPropertyConverter <|.. SocketDataInt16BigEndianConverter
ISocketDataPropertyConverter <|.. SocketDataInt16LittleEndianConverter
ISocketDataPropertyConverter <|.. SocketDataSingleBigEndianConverter
ISocketDataPropertyConverter <|.. SocketDataSingleLittleEndianConverter
ISocketDataPropertyConverter <|.. SocketDataUInt16BigEndianConverter
ISocketDataPropertyConverter <|.. SocketDataUInt16LittleEndianConverter
ISocketDataPropertyConverter <|.. SocketDataUInt32BigEndianConverter
ISocketDataPropertyConverter <|.. SocketDataUInt32LittleEndianConverter
ISocketDataPropertyConverter <|.. SocketDataUInt64BigEndianConverter
ISocketDataPropertyConverter <|.. SocketDataUInt64LittleEndianConverter
Class diagram for SocketDataConverterBase and attribute usageclassDiagram
class SocketDataConverterBase~TEntity~ {
+bool TryConvertTo(ReadOnlyMemory<byte> data, out TEntity? entity)
#bool Parse(ReadOnlyMemory<byte> data, TEntity entity)
}
class SocketDataConverterAttribute {
+Type Type
}
class SocketDataPropertyAttribute {
+Type Type
+int Offset
+int Length
+string EncodingName
+Type ConverterType
+object[] ConverterParameters
+object? ConvertTo(ReadOnlyMemory<byte> data)
}
SocketDataConverterBase~TEntity~ <.. SocketDataConverterAttribute : uses
SocketDataPropertyAttribute <.. SocketDataConverterBase~TEntity~ : used for property parsing
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:
- The paddedSpan and TryRead… logic is duplicated across all converters; consider extracting it into a shared helper or base implementation to reduce boilerplate.
- I don’t see localization entries for DataEntityTitle, DataEntityDescription, etc., in the en-US.json/zh-CN.json files—please add those keys so the sample page renders correctly.
- Currently inputs longer than the expected length silently return the default value; it may be helpful to log or throw an error in those cases to avoid hidden data truncation issues.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The paddedSpan and TryRead… logic is duplicated across all converters; consider extracting it into a shared helper or base implementation to reduce boilerplate.
- I don’t see localization entries for DataEntityTitle, DataEntityDescription, etc., in the en-US.json/zh-CN.json files—please add those keys so the sample page renders correctly.
- Currently inputs longer than the expected length silently return the default value; it may be helpful to log or throw an error in those cases to avoid hidden data truncation issues.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6425 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 746 746
Lines 32177 32225 +48
Branches 4538 4554 +16
=========================================
+ Hits 32177 32225 +48
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 #6424
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Add comprehensive documentation and sample for ISocketDataPropertyConverter, update related menu entries, and enhance converters with data length validation before parsing.
Enhancements:
Documentation: