feat(ffi): Validate the type of user-defined metadata when deserializing the new IR format. #695
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
WalkthroughThe pull request focuses on enhancing error handling in the Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (11)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
components/core/src/clp/ffi/ir_stream/Deserializer.hpp (1)
173-178: Consider improving readability of the validation check.While the implementation correctly validates the user-defined metadata, the condition could be more readable.
Consider this more concise version:
- if (metadata_json.contains(cProtocol::Metadata::UserDefinedMetadataKey) - && false == metadata_json.at(cProtocol::Metadata::UserDefinedMetadataKey).is_object()) - { - return std::errc::protocol_not_supported; - } + if (auto it = metadata_json.find(cProtocol::Metadata::UserDefinedMetadataKey); + it != metadata_json.end() && !it->is_object()) + { + return std::errc::protocol_not_supported; + }This version:
- Uses a single find() instead of contains() + at()
- Maintains the same validation logic
- Improves readability while keeping the same functionality
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/core/src/clp/ffi/ir_stream/Deserializer.hpp(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
components/core/src/clp/ffi/ir_stream/Deserializer.hpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
📓 Learnings (1)
components/core/src/clp/ffi/ir_stream/Deserializer.hpp (1)
Learnt from: LinZhihao-723
PR: y-scope/clp#549
File: components/core/src/clp/ffi/ir_stream/Deserializer.hpp:209-210
Timestamp: 2024-11-10T16:46:53.300Z
Learning: Until #486 is merged with customized error code support, introducing a layer from `IRErrorCode` to `std::errc` is unnecessary.
⏰ Context from checks skipped due to timeout of 90000ms (11)
- GitHub Check: ubuntu-jammy-static-linked-bins
- GitHub Check: ubuntu-focal-static-linked-bins
- GitHub Check: centos-stream-9-static-linked-bins
- GitHub Check: ubuntu-jammy-dynamic-linked-bins
- GitHub Check: ubuntu-focal-dynamic-linked-bins
- GitHub Check: centos-stream-9-dynamic-linked-bins
- GitHub Check: build-macos (macos-14, false)
- GitHub Check: build-macos (macos-14, true)
- GitHub Check: build-macos (macos-13, false)
- GitHub Check: lint-check (ubuntu-latest)
- GitHub Check: build-macos (macos-13, true)
🔇 Additional comments (1)
components/core/src/clp/ffi/ir_stream/Deserializer.hpp (1)
47-50: LGTM! Documentation clearly specifies the new error condition.The updated documentation accurately reflects the new validation for user-defined metadata format.
|
For the PR title, how about: |
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
LinZhihao-723
changed the title
kirkrodrigues
approved these changes
Jan 26, 2025
This was referenced Jan 26, 2025
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
We've added type checking in #691 to ensure only JSON objects can be serialized as user-defined metadata.
As discussed in clp-ffi-py implementation here, we realized we should also add type checking in the deserialization end to raise invalid typed user-defined metadata.
This PR adds the check to return an error if the user-defined metadata is not a JSON object.
Validation performed
Summary by CodeRabbit
Bug Fixes
Documentation