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

fix(torii-grpc): deser from db for grpc enums #2259

Merged
merged 6 commits into from
Aug 5, 2024

Conversation

Larkooo
Copy link
Collaborator

@Larkooo Larkooo commented Aug 2, 2024

Fixes an issue with the deserialization of enums and optional primitives that occurred due to the new felt update

Summary by CodeRabbit

  • New Features

    • Improved clarity and logic in data handling with enhanced variable naming and refined control flow.
    • Simplified processing of primitive types, ensuring default values are used when options are empty.
    • Streamlined construction of enum type names, enhancing readability and maintainability through a more concise implementation.
    • Enhanced comments for better understanding of the schema parsing logic.
  • Bug Fixes

    • Addressed potential issues in type conversion through improved robustness in handling primitive data types.

Copy link

coderabbitai bot commented Aug 2, 2024

Walkthrough

Ohayo, sensei! The recent changes bring improvements in clarity and efficiency across several files, particularly in the model.rs and schema.rs. Key modifications include renaming variables for better conceptual alignment, simplifying the handling of Option types, and refining logic in enum processing. These updates enhance readability and maintainability while ensuring robust data management throughout the affected components.

Changes

Files Change Summary
crates/torii/core/src/model.rs Renamed contract_address to class_hash for clarity. Enhanced handling in Ty::Enum with an intermediate option_name variable and added conditional checks.
crates/torii/grpc/src/types/schema.rs Simplified From<Primitive> implementation by using unwrap_or_default() for Option types, enhancing clarity. Consolidated handling of Felt252, ClassHash, and ContractAddress into a single case.
crates/dojo-types/src/schema.rs Updated name method in Ty enum to streamline type name construction, replacing <T> with a direct reference to e.name, improving readability and maintainability.
crates/dojo-world/src/contracts/model.rs Clarified comments in parse_schema function to enhance understanding of type stripping operations without altering the existing logic.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Model
    participant Schema

    Client->>Model: Request data
    Model->>Model: Process request
    Model->>Schema: Convert types
    Schema->>Model: Return converted types
    Model->>Client: Send response
Loading

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bce64e4 and d350ea4.

Files selected for processing (1)
  • crates/dojo-world/src/contracts/model.rs (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • crates/dojo-world/src/contracts/model.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

codecov bot commented Aug 2, 2024

Codecov Report

Attention: Patch coverage is 58.82353% with 14 lines in your changes missing coverage. Please review.

Project coverage is 70.29%. Comparing base (58ad13f) to head (d350ea4).

Files Patch % Lines
crates/torii/grpc/src/types/schema.rs 23.52% 13 Missing ⚠️
crates/torii/core/src/model.rs 87.50% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2259      +/-   ##
==========================================
- Coverage   70.29%   70.29%   -0.01%     
==========================================
  Files         345      345              
  Lines       45430    45424       -6     
==========================================
- Hits        31935    31930       -5     
+ Misses      13495    13494       -1     

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

@glihm glihm merged commit 8d077cc into dojoengine:main Aug 5, 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