search

satoren / y_ex

Yjs port for Elixir
MIT License
56 stars 2 forks source link

feat: transaction origin accept any types #86

Closed satoren closed 1 month ago

satoren commented 1 month ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces several modifications across multiple modules, primarily focusing on enhancing the handling of the origin parameter in various functions. Key changes include updates to the transaction function in the Yex.Doc module to accept an origin parameter, adjustments in the handle_info functions in Yex.Managed.SharedDoc, and modifications to the awareness functions in the Yex.Awareness module. Additionally, utility functions for converting between Origin types and terms are introduced in a new utils module. Test cases are also expanded to ensure proper functionality with the new parameters.

Changes

File Change Summary
lib/doc.ex Updated transaction function to include an origin parameter; modified implementation to use origin.
lib/managed/shared_doc.ex Adjusted handle_info functions to pass from directly instead of using inspect(from).
lib/managed/shared_doc_supervisor.ex Changed argument in monitor/1 to pass self() instead of inspect(self()).
lib/protocols/awareness.ex Updated apply_update function to change origin parameter type from String.t() | nil to term() | nil.
lib/protocols/shared_doc.ex Altered message handling to pass from directly; updated broadcast_to_users to compare pid directly.
native/yex/src/awareness.rs Changed origin type in awareness_apply_update_v1 from Option<&str> to Term<'_>; introduced utility functions.
native/yex/src/doc.rs Modified doc_begin_transaction to accept Term<'_> for origin instead of Option<&str>.
native/yex/src/lib.rs Added a new module utils.
native/yex/src/utils.rs Introduced origin_to_term and term_to_origin_binary functions for handling conversions.
test/doc_test.exs Added test for Doc.transaction/3 to check various types for origin.
test/managed/shared_doc_supervisor_test.exs Changed argument in receive_and_handle_reply_with_timeout to pass proc directly; added persistence test.
test/managed/shared_doc_test.exs Simplified argument handling in receive_and_handle_reply_with_timeout/2; removed redundant setup.
test/protocols/shared_doc_test.exs Updated receive_and_handle_reply_with_timeout/2 to pass proc directly; no new tests added.

Possibly related PRs

Poem

🐇 In the meadow, changes bloom,
With origins to chase away gloom.
Transactions now hold a tale,
From every type, they will prevail.
With tests to guard, we hop and play,
Enhancing code in a joyful way! 🌼

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 1 month ago

Coverage Status

coverage: 87.205%. remained the same when pulling b4c2a83784262a3aa99dd22c2c7b9fa9cc817f44 on any_origin into f4b4cfb92d03b9b87f9c339ffe005757edb9646e on main.