Description

As planned in #556, we want to differentiate key-value pairs into two categories: auto-generated key-value pairs and user-generated key-value pairs. This PR adds support for auto/user-generated key-value pairs in KeyValuePairLogEvent, where each set of key-value pairs is stored as a set of node-ID-value pairs with a reference to the associated schema tree. However, this PR does not yet support auto/user-generated kv pairs serialization/deserialization. The deserializer will output new KeyValuePairLogEvent instances, but with all kv-pairs as user-generated ones, leaving auto-generated pairs empty.

This PR also fixes a bug where duplicated keys are not correctly detected. Consider the following schema tree:

 <0:root:Obj>
      |
      |------------> <1:a:Obj>
      |                  |
      |--> <2:a:Str>     |--> <3:b:Str>

Node annotation: <nodeID:keyName:valueType>

Before this PR, if we have node-ID-value pairs [<2:"Value0">, <3:"Value1">], it will be considered valid with the schema tree above. However, it is actually invalid since there is an implicit duplicated key under the root node: both node 1 and node 2 have the key `"a". The previous implementation doesn't check key duplications among non-leaf nodes' siblings. This PR fixes this bug by checking key duplications among siblings for all the nodes from the leaf up to the root.

Validation performed

Ensure all workflow passed.
Ensure existing unit tests all passed with the new KeyValuePairLogEvent that supports auto/user-generated kv pairs.
Enhance the current unit tests to verify:
- Valid inputs can successfully construct an instance of KeyValuePairLogEvent
- Invalid auto-generated or user-generated node-ID-value pair inputs will be properly captured
- Both auto-generated and user-generated kv pairs can be correctly serialized
- The bug mentioned in the Description section is correctly fixed

Summary by CodeRabbit

New Features
- Enhanced serialization of key-value pairs into JSON format.
- Added validation for uniqueness of node keys among siblings.
- Improved handling of auto-generated and user-generated schema trees.
Bug Fixes
- Resolved issues with key duplication checks in ancestor nodes.
Tests
- Updated test cases to validate new functionalities and error handling for log event creation.

Walkthrough

The pull request introduces significant changes to the KeyValuePairLogEvent class and related components to enhance the serialization of key-value pairs into JSON format and improve the validation of node-ID value pairs within a schema tree. Key updates include the addition of new methods for serialization and key uniqueness checks, modifications to existing methods to accommodate new parameters, and updates to the test files to ensure proper functionality and validation of these changes.

Changes

File	Change Summary
components/core/src/clp/ffi/KeyValuePairLogEvent.cpp	- Added `serialize_node_id_value_pairs_to_json` and `check_key_uniqueness_among_sibling_nodes` methods. - Updated `validate_node_id_value_pairs` to use a bitmap for key duplication checks. - Modified `create` and `serialize_to_json` methods for new parameters and return types.
components/core/src/clp/ffi/KeyValuePairLogEvent.hpp	- Updated constructor and `create` method to accept two schema trees and two collections of node-ID value pairs. - Changed method names to distinguish between auto-generated and user-generated pairs. - Updated documentation comments.
components/core/tests/test-ffi_KeyValuePairLogEvent.cpp	- Added `assert_kv_pair_log_event_creation_failure` method. - Updated test cases for JSON serialization and key duplication checks.

Possibly related PRs

#554: This PR modifies the KeyValuePairLogEvent.cpp file to transition from SchemaTreeNode to SchemaTree::Node, which is directly related to the changes made in the main PR regarding the serialization and validation of node-ID value pairs.

Suggested reviewers

kirkrodrigues

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

y-scope / clp

ffi: Add support for auto/user-generated key-value pairs and fix duplicated key detection issues on non-leaf nodes in `KeyValuePairLogEvent`. #558