Add metadata to the monitor methods

satoren commented 2 weeks ago

Summary by CodeRabbit

Release Notes

New Features
- Enhanced monitoring functions now accept optional metadata parameters for improved flexibility during document and awareness updates.
- Introduced a new TermBox struct for safe term management across different environments.
Bug Fixes
- Improved error handling in the sub_unsubscribe function to handle mutex poisoning scenarios effectively.
Tests
- Added new test cases to validate the functionality of monitoring updates with metadata in both document and awareness modules.

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The pull request implements significant modifications across multiple modules in the Yex library, focusing on enhancing the monitor_update and related functions to accept optional metadata parameters. The changes include updating function signatures, adjusting implementations to utilize the new parameters, and ensuring that metadata can be passed and correctly processed. New test cases are added to verify the functionality of these enhancements, ensuring that the metadata is included in update messages. A new module, term_box, is introduced to facilitate the handling of terms in a thread-safe manner.

Changes

File	Change Summary
lib/doc.ex	Updated `monitor_update`, `monitor_update_v1`, and `monitor_update_v2` to accept an optional `keyword` argument for metadata.
lib/nif.ex	Modified `doc_monitor_update_v1`, `doc_monitor_update_v2`, `awareness_monitor_update`, and `awareness_monitor_change` to include a `_metadata` parameter.
lib/protocols/awareness.ex	Enhanced `monitor_update` and `monitor_change` to accept an optional `metadata` parameter.
native/yex/src/awareness.rs	Updated `awareness_monitor_update` and `awareness_monitor_change` to include a `metadata` parameter, simplifying access to it.
native/yex/src/doc.rs	Refactored `doc_monitor_update_v1` and `doc_monitor_update_v2` to use `observe_update_v1` and `observe_update_v2`, adding a `metadata` parameter.
native/yex/src/lib.rs	Added a new module `term_box`.
native/yex/src/term_box.rs	Introduced `TermBox` struct for encapsulating terms in a thread-safe environment, including methods for initialization and retrieval.
test/doc_test.exs	Added tests for `monitor_update` and `monitor_update_v2` with metadata handling.
test/protocols/awareness_test.exs	Added tests for `monitor_update` and `monitor_change` with metadata handling.

Possibly related PRs

#86: The modification of the transaction function in the Yex.Doc module to accept an origin parameter aligns with the main PR's focus on enhancing function signatures to include additional parameters for metadata handling.

🐇 In the code where updates reside,
A new metadata we now provide.
Functions enhanced, tests added too,
With TermBox to safely ensue.
In Yex we hop, with joy we sing,
For the changes that this PR brings! 🎉

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.

coveralls commented 2 weeks ago

coverage: 87.205%. remained the same when pulling 4456780e417689a0919453d74b280801224d077d on monitor_metadata into 60644f56b3ca79134833b4a7ebd4d92a48fe9f5a on main.

satoren / y_ex