satoren / y_ex

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

Thread safe #49

Closed satoren closed 3 months ago

satoren commented 3 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes involve significant enhancements to transaction management across various modules in the Yex system. Key updates include the addition of transaction parameters to multiple functions, the introduction of new private functions for streamlined transaction handling, and modifications to existing function signatures to operate within a transactional context. These adjustments improve error handling and concurrency, fostering a more robust and maintainable codebase.

Changes

Files Change Summary
lib/doc.ex, lib/nif.ex, lib/shared_type/array.ex, lib/shared_type/map.ex, lib/shared_type/text.ex, lib/shared_type/xml_element.ex, lib/shared_type/xml_fragment.ex, lib/shared_type/xml_text.ex, lib/y_ex.ex Introduced transaction parameters to functions, added new private functions for transaction handling, and modified function signatures for improved transaction management.
native/yex/Cargo.toml, native/yex/src/array.rs, native/yex/src/awareness.rs, native/yex/src/doc.rs, native/yex/src/map.rs, native/yex/src/subscription.rs Enhanced transaction handling by adding current_transaction parameters, transitioning to Mutex for shared access, and integrating transaction context into various functions.
test/doc_test.exs Updated the expected error type in Yex.DocTest from ErlangError to RuntimeError during transaction assertions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Doc
    participant Nif
    participant Transaction

    User->>Doc: initiate transaction(origin)
    Doc->>Transaction: check for existing transaction
    alt no existing transaction
        Transaction-->>Doc: begin new transaction
        Doc->>Nif: perform operations with cur_txn
        Nif-->>Doc: return results
        Doc->>Transaction: commit transaction
    else existing transaction
        Doc-->>User: raise error (RuntimeError)
    end

🐰 In fields of green, where bunnies play,
New changes hop in, brightening the day!
Transactions now dance in the code's gentle flow,
With cur_txn guiding where data should go.
Hooray for the tweaks that make things so neat,
Let's celebrate coding, oh what a treat! 🌼


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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
coveralls commented 3 months ago

Coverage Status

coverage: 80.233% (+0.7%) from 79.518% when pulling 42837fd466347dc622b9dda349c0547268bc3688 on thread_safe into 463368ccb3940aa424ab7c889ec5f7b2fec93c82 on main.

satoren commented 3 months ago

@coderabbitai review

coderabbitai[bot] commented 3 months ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.