feat(kv-ir): Add a function signature C++ concept for the callback called when a new projected schema-tree node is read. #859
+34
−0
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
WalkthroughA new header file, Changes
Sequence Diagram(s)sequenceDiagram
participant UserCode as User Callback
participant IRStream as IR Stream Search
participant SchemaTree as Schema Tree
IRStream->>UserCode: Invoke callback (is_auto_generated, node_id, key_path)
UserCode-->>IRStream: Returns outcome_v2::std_result<void>
IRStream->>SchemaTree: Process new projected schema-tree node (if callback succeeds)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (6)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 (
|
LinZhihao-723
commented
Apr 26, 2025
Comment on lines
16
to
23
| * Callback parameters: | ||
| * - `bool is_auto_generated`: Whether the schema tree node is auto-generated. | ||
| * - `SchemaTree::Node::id_t schema_tree_node_id`: The ID of the resolved schema tree node. | ||
| * - `std::string_view key_path`: The key path of the resolved projection. | ||
| * | ||
| * Callback return values: | ||
| * - A void result on success. | ||
| * - A user-defined error code indicating the failure. |
There was a problem hiding this comment.
@kirkrodrigues Do u have any suggestions on how to document such a signature?
kirkrodrigues
requested changes
Apr 27, 2025
components/core/src/clp/ffi/ir_stream/search/ProjectionResolutionCallbackReq.hpp
Outdated
Show resolved
Hide resolved
| * - A user-defined error code indicating the failure. | ||
| */ | ||
| template <typename ProjectionResolutionCallbackType> | ||
| concept ProjectionResolutionCallbackReq = std::is_invocable_r_v< |
There was a problem hiding this comment.
How about NewSchemaTreeProjectionNodeCallbackReq?
There was a problem hiding this comment.
As discussed offline, we decided to use NewProjectedSchemaTreeNodeCallbackReq.
…ionCallbackReq.hpp Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
kirkrodrigues
approved these changes
Apr 27, 2025
LinZhihao-723
changed the title
5 tasks
3 tasks
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.
Description
This PR is one of the series #840.
This PR implements the projection resolution callback's signature as a concept. Unlike the prototype implementation, this callback signature is defined as a standalone concept instead of inside
IrUnitHandlerInterface, since it is not designed to handle any IR unit.The signature is documented in the docstring.
Checklist
breaking change.
Validation performed
Summary by CodeRabbit