refactor(ffi): Make get_schema_subtree_bitmap a public method of KeyValuePairLogEvent.

[LinZhihao-723]

Description

After realizing get_schema_subtree_bitmap is also useful in language-specific ffi layer, we decided to extract it from the anon-namespace as a member method of KeyValuePairLogEvent in this PR.

Validation performed

• Ensure unit tests all passed locally

Summary by CodeRabbit

• New Features

  • Introduced a new method to obtain a bitmap representing the schema subtree in the KeyValuePairLogEvent class.
  • Enhanced error handling for cases where a node ID does not exist in the schema tree.

• Bug Fixes

  • Streamlined the process of obtaining the schema subtree bitmap, improving overall functionality.

[coderabbitai]

Walkthrough

The changes introduce a new method, get_schema_subtree_bitmap, to the KeyValuePairLogEvent class, which computes a bitmap representing the schema subtree based on stored node ID-value pairs. This method replaces a previously standalone function and now operates within the class context, utilizing member variables. The serialize_to_json method has been updated to call this new method. Additionally, documentation comments for the removed standalone function have been eliminated, and a necessary header inclusion has been added.

Changes

File Path	Change Summary
components/core/src/clp/ffi/KeyValuePairLogEvent.cpp	- Added method get_schema_subtree_bitmap() to compute a bitmap within the class context. - Removed standalone function get_schema_subtree_bitmap(). - Updated serialize_to_json to call the new method. - Streamlined destructor logic.
components/core/src/clp/ffi/KeyValuePairLogEvent.hpp	- Added method declaration get_schema_subtree_bitmap() with error handling. - Included <vector> header.

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

components/core/src/clp/ffi/KeyValuePairLogEvent.hpp (1)

64-73: LGTM: Well-documented method with appropriate design

The method declaration is well-designed with proper const qualification and error handling. The documentation clearly explains the purpose and error conditions.

Consider adding a brief example in the documentation to illustrate the bitmap's structure, making it more intuitive for users.

Add this to the documentation:

     * @return A result containing a bitmap where every bit corresponds to the ID of a node in the
     * schema tree, and the set bits correspond to the nodes in the subtree defined by all paths
     * from the root node to the nodes in `node_id_value_pairs`; or an error code indicating a
+    * failure. For example, if node IDs 1, 3, and 4 are in the path, the bitmap would be
+    * [1,1,0,1,1] (assuming 5 total nodes).
     * - std::errc::result_out_of_range if a node ID in `node_id_value_pairs` doesn't exist in the
     *   schema tree.

components/core/src/clp/ffi/KeyValuePairLogEvent.cpp (1)

350-378: Implementation looks good with room for optimization.

The method correctly implements the bitmap generation logic with proper error handling. However, consider caching the parent traversal results to optimize cases where multiple nodes share common ancestors.

Consider this optimization to reduce repeated parent traversals:

 auto KeyValuePairLogEvent::get_schema_subtree_bitmap() const
     -> OUTCOME_V2_NAMESPACE::std_result<vector<bool>> {
     auto schema_subtree_bitmap{vector<bool>(m_schema_tree->get_size(), false)};
+    std::unordered_set<SchemaTree::Node::id_t> processed_parents;
     
     for (auto const& [node_id, val] : m_node_id_value_pairs) {
         if (node_id >= schema_subtree_bitmap.size()) {
             return std::errc::result_out_of_range;
         }
         schema_subtree_bitmap[node_id] = true;
 
         auto optional_parent_id{m_schema_tree->get_node(node_id).get_parent_id()};
         while (true) {
             if (false == optional_parent_id.has_value()) {
                 break;
             }
             auto const parent_id{optional_parent_id.value()};
-            if (schema_subtree_bitmap[parent_id]) {
+            if (processed_parents.contains(parent_id)) {
                 break;
             }
             schema_subtree_bitmap[parent_id] = true;
+            processed_parents.insert(parent_id);
             optional_parent_id = m_schema_tree->get_node(parent_id).get_parent_id();
         }
     }
     return schema_subtree_bitmap;
 }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7ea3941 and 2c48b48.

📒 Files selected for processing (2)

• components/core/src/clp/ffi/KeyValuePairLogEvent.cpp (2 hunks)
• components/core/src/clp/ffi/KeyValuePairLogEvent.hpp (2 hunks)

🧰 Additional context used

📓 Learnings (1)

components/core/src/clp/ffi/KeyValuePairLogEvent.cpp (3)

Learnt from: LinZhihao-723
PR: y-scope/clp#554
File: components/core/src/clp/ffi/KeyValuePairLogEvent.cpp:109-111
Timestamp: 2024-10-10T15:19:52.408Z
Learning: In `KeyValuePairLogEvent.cpp`, for the class `JsonSerializationIterator`, it's acceptable to use raw pointers for member variables like `m_schema_tree_node`, and there's no need to replace them with references or smart pointers in this use case.

Learnt from: LinZhihao-723
PR: y-scope/clp#558
File: components/core/src/clp/ffi/KeyValuePairLogEvent.hpp:62-68
Timestamp: 2024-10-14T03:38:57.921Z
Learning: In `KeyValuePairLogEvent.hpp`, the methods `get_auto_generated_schema_tree()` and `get_user_generated_schema_tree()` do not need to check for null shared pointers because the factory function ensures they are not null.

Learnt from: LinZhihao-723
PR: y-scope/clp#554
File: components/core/src/clp/ffi/KeyValuePairLogEvent.cpp:102-102
Timestamp: 2024-10-10T15:21:14.506Z
Learning: In `KeyValuePairLogEvent.cpp`, the `get_next_child_schema_tree_node()` method in `JsonSerializationIterator` is always called after checking `has_next_child_schema_tree_node()`, ensuring proper iterator usage.

🔇 Additional comments (3)

components/core/src/clp/ffi/KeyValuePairLogEvent.hpp (2)

8-8: LGTM: Necessary header inclusion

The addition of header is appropriate for the new method's return type and follows proper include ordering.

---

72-73: Verify integration with serialize_to_json method

The method has access to necessary member variables. Let's verify its integration with serialize_to_json.

✅ Verification successful

The results show that get_schema_subtree_bitmap is properly integrated with serialize_to_json. The implementation shows that:

1. get_schema_subtree_bitmap uses the member variables (m_schema_tree, m_node_id_value_pairs)
2. serialize_to_json calls get_schema_subtree_bitmap and handles its return value appropriately
3. The error handling is consistent between both methods using OUTCOME_V2_NAMESPACE::std_result

Let me verify one more aspect - if there are any other usages of this method:

---

Integration verified successfully

The method get_schema_subtree_bitmap is properly integrated with serialize_to_json and:

• Correctly uses the class member variables
• Has proper error handling using OUTCOME_V2_NAMESPACE::std_result
• Is only used within its own class implementation as expected
• Serves its intended purpose in supporting JSON serialization

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the implementation and usage of get_schema_subtree_bitmap

# Search for the implementation and usage in the corresponding cpp file
rg -A 5 "get_schema_subtree_bitmap|serialize_to_json" components/core/src/clp/ffi/KeyValuePairLogEvent.cpp

Length of output: 1430

---

Script:

#!/bin/bash
# Search for other usages of get_schema_subtree_bitmap
rg "get_schema_subtree_bitmap" --type cpp --type hpp

Length of output: 80

---

Script:

#!/bin/bash
# Search for other usages of get_schema_subtree_bitmap without file type restrictions
rg "get_schema_subtree_bitmap" -l

Length of output: 139

components/core/src/clp/ffi/KeyValuePairLogEvent.cpp (1)

Line range hint 396-400: Changes to serialize_to_json look good.

The method correctly uses the new member function while maintaining proper error handling and existing functionality.

[kirkrodrigues]

For the PR title, how about:

refactor(ffi): Make `get_schema_subtree_bitmap` a public member method of `KeyValuePairLogEvent`.