dojoengine / dojo

Dojo is a toolchain for building provable games and autonomous worlds with Cairo
https://dojoengine.org
Apache License 2.0
407 stars 164 forks source link

feat(torii-core): optimistically broadcast entity update #2466

Open Larkooo opened 5 days ago

Larkooo commented 5 days ago

Summary by CodeRabbit

coderabbitai[bot] commented 5 days ago

Walkthrough

Ohayo, sensei! This pull request introduces the OptimisticEntityUpdate structure, which is integrated into the Sql implementation and the Service struct in the entity.rs file. The new structure facilitates the handling of entity updates, allowing for a more optimistic concurrency model. Changes include the creation of instances of OptimisticEntityUpdate in SQL methods and updates to the service's methods to accommodate this new type, enhancing the entity update mechanism across the codebase.

Changes

Files Change Summary
crates/torii/core/src/sql.rs Introduced OptimisticEntityUpdate structure; integrated into Sql methods, updating entity handling.
crates/torii/core/src/types.rs Added public struct OptimisticEntityUpdate with fields for id, keys, event_id, updated_model, and deleted.
crates/torii/grpc/src/server/subscriptions/entity.rs Updated Service struct to use OptimisticEntityUpdate instead of Entity in method signatures and broker initialization.

Possibly related PRs

Suggested reviewers


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. ### 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.