Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(torii): include model in entity deletion for filter & update member broadcast #2299

Merged
merged 2 commits into from
Aug 15, 2024

Conversation

Larkooo
Copy link
Collaborator

@Larkooo Larkooo commented Aug 15, 2024

We now include the model within the Entity struct to be used with clauses on subscriptions to also receive entity deletions and now broadcast update member to subscriptions

Summary by CodeRabbit

  • New Features

    • Introduced enhanced SQL handling for entity updates, managing timestamps for better data integrity.
    • Added a new field to track deletion status in the Entity structure.
    • Improved entity deletion logic to provide more context during event handling.
  • Bug Fixes

    • Corrected entity processing logic to focus on deletion status rather than the presence of an updated model.
  • Documentation

    • Clarified comments related to entity state management and event messages.

Copy link

coderabbitai bot commented Aug 15, 2024

Walkthrough

Ohayo, sensei! The recent changes significantly enhance the SQL handling and data structures for entity management. Key updates include the addition of an executed_at field in the SQL insertions to improve timestamp handling, a new operation for updating entities, and refined deletion logic to track the deletion status of entities. Furthermore, the Entity struct now features a deleted field, streamlining state management and ensuring robust entity handling across the system.

Changes

Files Change Summary
crates/torii/core/src/sql.rs Updated SQL insertions to manage executed_at, added new entity update logic, and refined deletion handling.
crates/torii/core/src/types.rs Added deleted: bool field to the Entity struct for improved state tracking. Clarified comments in EventMessage.
crates/torii/grpc/src/server/subscriptions/entity.rs Adjusted subscription processing to focus on the entity.deleted status instead of updated_model.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Service
    participant Database

    Client->>Service: Request to insert entity
    Service->>Database: Execute insert query with executed_at
    alt conflict
        Database-->>Service: Return updated entity
    end
    Service-->>Client: Respond with entity details

    Client->>Service: Request to update entity
    Service->>Database: Execute update query for entity
    Database-->>Service: Return updated entity
    Service-->>Client: Respond with updated entity details

    Client->>Service: Request to delete entity
    Service->>Database: Execute delete operation
    Database-->>Service: Return deletion status
    Service-->>Client: Acknowledge deletion
Loading

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6ac4c3e and c42824c.

Files selected for processing (1)
  • crates/torii/core/src/types.rs (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • crates/torii/core/src/types.rs

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
crates/torii/core/src/types.rs (1)

41-45: Add a comment for the deleted field.

The deleted field in the Entity struct is a significant addition. Consider adding a comment to explain its purpose and usage, similar to the comment for updated_model.

+    // indicates if the entity has been marked as deleted

Copy link

codecov bot commented Aug 15, 2024

Codecov Report

Attention: Patch coverage is 0% with 20 lines in your changes missing coverage. Please review.

Project coverage is 69.58%. Comparing base (00770bd) to head (c42824c).
Report is 2 commits behind head on main.

Files Patch % Lines
crates/torii/core/src/sql.rs 0.00% 19 Missing ⚠️
...ates/torii/grpc/src/server/subscriptions/entity.rs 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2299      +/-   ##
==========================================
- Coverage   69.60%   69.58%   -0.03%     
==========================================
  Files         352      352              
  Lines       46031    46047      +16     
==========================================
  Hits        32040    32040              
- Misses      13991    14007      +16     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@glihm glihm merged commit c5c277e into dojoengine:main Aug 15, 2024
13 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants