fix(torii-grpc): nullable enum array deser #2887

Larkooo · 2025-01-10T07:27:37Z

Summary by CodeRabbit

Bug Fixes
- Improved error handling for processing empty serialized arrays
Chores
- Added logging for SQL query execution to assist with debugging

coderabbitai · 2025-01-10T07:32:11Z

Pull Request Analysis

Ohayo, sensei! Let's dive into the changes with precision and clarity.

Walkthrough

The pull request introduces modifications to the crates/torii/sqlite/src/model.rs file, focusing on improving error handling for empty serialized arrays. A new conditional check is added in the map_row_to_ty function to set the ty variable to an empty vector and return early if the serialized_array string is empty. This change enhances the control flow by preventing attempts to deserialize an empty string into a JSON value. The fetch_entities function remains unchanged in logic and structure.

Changes

File	Change Summary
`crates/torii/sqlite/src/model.rs`	- Added early exit condition for empty `serialized_array` in `map_row_to_ty` function - `fetch_entities` function remains unchanged

Sequence Diagram

sequenceDiagram
    participant Func as map_row_to_ty
    participant Array as Serialized Array
    
    Func->>Array: Check array content
    alt Empty Array
        Func-->>Func: Early return with empty vector
    else Non-Empty Array
        Func->>Func: Continue normal processing
    end

The sequence diagram illustrates the new control flow for handling empty serialized arrays, showing the early return mechanism when an empty array is detected.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 928f90c and 5c74ad2.

📒 Files selected for processing (1)

crates/torii/sqlite/src/model.rs (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

crates/torii/sqlite/src/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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
@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 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.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4371331 and 928f90c.

📒 Files selected for processing (1)

crates/torii/sqlite/src/model.rs (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: build
GitHub Check: docs
GitHub Check: clippy

🔇 Additional comments (1)

crates/torii/sqlite/src/model.rs (1)

379-382: Ohayo! Nice defensive programming, sensei!

The early return for empty serialized arrays is a good addition that prevents potential deserialization errors.

coderabbitai · 2025-01-10T07:32:14Z

crates/torii/sqlite/src/model.rs

@@ -533,6 +537,7 @@ pub async fn fetch_entities(
                query += &format!(" OFFSET {}", offset);
            }

+            println!("{}", query);


🛠️ Refactor suggestion

Consider using a proper logging framework instead of println

Ohayo! While logging the SQL query is helpful for debugging, using println! in production code isn't ideal. Consider using the tracing or log crate instead, which provides structured logging with different log levels.

- println!("{}", query); + tracing::debug!(?query, "executing fetch query");

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

println!("{}", query);

tracing::debug!(?query, "executing fetch query");

codecov · 2025-01-10T07:49:36Z

Codecov Report

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

Project coverage is 55.81%. Comparing base (4371331) to head (5c74ad2).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
crates/torii/sqlite/src/model.rs	0.00%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2887      +/-   ##
==========================================
- Coverage   55.82%   55.81%   -0.02%     
==========================================
  Files         449      449              
  Lines       57693    57697       +4     
==========================================
- Hits        32206    32201       -5     
- Misses      25487    25496       +9

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

fix(torii-grpc): nullable enum array deser

928f90c

coderabbitai bot reviewed Jan 10, 2025

View reviewed changes

remove print

5c74ad2

Larkooo enabled auto-merge (squash) January 10, 2025 09:57

glihm approved these changes Jan 10, 2025

View reviewed changes

Larkooo merged commit 80ac6d1 into dojoengine:main Jan 10, 2025
13 of 15 checks passed

This was referenced Jan 10, 2025

fix(katana): genesis deprecated declared classes in state updates #2893

Merged

feat(katana): special block hash registry contract #2894

Merged

chore(katana): use workspace dep #2895

Merged

fix(katana): separate deprecated declared class #2903

Merged

kariy mentioned this pull request Jan 18, 2025

feat(katana): remove support for initializing custom settlement chain #2927

Merged

coderabbitai bot mentioned this pull request Jan 21, 2025

feat(torii-sqlite): support enum upgrade of variants #2930

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(torii-grpc): nullable enum array deser #2887

fix(torii-grpc): nullable enum array deser #2887

Larkooo commented Jan 10, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 10, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Jan 10, 2025

codecov bot commented Jan 10, 2025 •

edited

Loading

	println!("{}", query);
	tracing::debug!(?query, "executing fetch query");

fix(torii-grpc): nullable enum array deser #2887

fix(torii-grpc): nullable enum array deser #2887

Conversation

Larkooo commented Jan 10, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Jan 10, 2025 • edited Loading

Pull Request Analysis

Walkthrough

Changes

Sequence Diagram

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Jan 10, 2025

Choose a reason for hiding this comment

codecov bot commented Jan 10, 2025 • edited Loading

Codecov Report

Larkooo commented Jan 10, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 10, 2025 •

edited

Loading

codecov bot commented Jan 10, 2025 •

edited

Loading