opt(torii-grpc): optimize number of queries for entities

[Larkooo]

Summary by CodeRabbit

• New Features

  • Enhanced querying logic for improved performance in retrieving entities.
  • Introduced efficient grouping of entities based on model IDs for batch processing.

• Bug Fixes

  • Improved error handling for parsing model IDs and managing empty results.

• Documentation

  • Updated SQL query structure for better readability and maintainability.

[coderabbitai]

Ohayo, sensei! Here’s the detailed analysis of the changes in the pull request:

Walkthrough

The changes enhance the querying logic in the DojoWorld implementation, focusing on efficient retrieval of entities from the database. A HashMap is introduced for grouping entities by model IDs, reducing database calls. The SQL query construction is made more dynamic with a conditional model_filter, improving flexibility. Additionally, the structure of SQL statements is refined for better readability and maintainability, while error handling related to model IDs and empty results has been improved.

Changes

Files	Change Summary
crates/torii/grpc/src/server/mod.rs	Enhanced querying logic, introduced grouping by model IDs, refined SQL query construction, optimized error handling.

Assessment against linked issues

Objective	Addressed	Explanation
Improve error handling in querying logic (none)	❌	No linked issues provided.

Possibly related issues

• None identified as relevant.

Possibly related PRs

• fix(torii-grpc): member clause should never error out if no entities #2418: This PR also enhances error handling in the DojoWorld implementation, which aligns with the improvements made in this pull request.

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ebb3b70 and efb188b.

Files selected for processing (1)

• crates/torii/grpc/src/server/mod.rs (11 hunks)

Additional comments not posted (12)

crates/torii/grpc/src/server/mod.rs (12)

Line range hint 267-290: Ohayo sensei! The query construction looks great.

The dynamic query construction based on filter_ids is well-implemented and follows best practices. The use of GROUP_CONCAT to aggregate the model IDs is a nice approach. Keep up the good work!

---

290-300: Ohayo sensei! The entity grouping logic is on point.

The way you've grouped entities by their models using a HashMap is efficient and well-implemented. Parsing the model IDs string and handling errors is done correctly. The use of or_default() is a nice touch. Great job!

---

301-322: Ohayo sensei! The entity retrieval logic is well-structured.

The way you iterate over the grouped entities and retrieve their schemas using the model_cache is efficient and well-organized. The SQL query construction using build_sql_query is clear and handles the necessary conditions. Nice work!

---

327-332: Ohayo sensei! The query execution is spot-on.

Executing the constructed SQL query and binding the entity IDs to the query parameters is the right approach. It ensures proper escaping and prevents SQL injection vulnerabilities. Storing the results in rows is perfect for further processing. Excellent work!

---

334-342: Ohayo sensei! The array data retrieval is handled beautifully.

Fetching the array data separately using additional SQL queries is a smart approach to handle complex entity structures. Binding the entity IDs to the queries ensures data consistency. Storing the results in the arrays_rows HashMap provides convenient access during entity mapping. Fantastic job!

---

343-345: Ohayo sensei! The entity mapping is clean and efficient.

Iterating over the fetched rows and mapping them to entities using the map_row_to_entity function is a clean and readable approach. It promotes code reusability and maintainability. Pushing the mapped entities into the entities vector is perfect for returning the results. Great work!

---

362-378: Ohayo sensei! The model filtering logic is top-notch.

Dynamically building the WHERE clause for model filtering based on the provided keys_clause is a flexible and efficient approach. Checking for empty keys_clause.models before constructing the model IDs list is a nice optimization. Computing the model IDs using compute_selector_from_names ensures consistency. Defaulting to an empty string for model_filter when no models are provided is a safe choice. Excellent work!

---

Line range hint 379-398: Ohayo sensei! The COUNT query construction is on point.

Building a separate COUNT query to get the total count of entities is a great practice for pagination and performance. Using the model_filter and keys_pattern in the WHERE clause ensures consistency. Executing the query using sqlx::query_scalar is the right choice for retrieving a single scalar value. Checking for a zero total_count and returning early is a smart optimization. Well done!

---

400-427: Ohayo sensei! The main query construction is comprehensive and well-structured.

The main query for entity retrieval includes all the necessary components and filters. Using GROUP_CONCAT to retrieve the model IDs is an efficient approach. The JOINs and WHERE clauses based on model_filter and keys_pattern ensure accurate filtering. Ordering by event_id in descending order provides a logical ordering. The conditional LIMIT and OFFSET clauses allow for flexible pagination. Executing the query using sqlx::query_as with bound parameters is a safe and efficient technique. Fantastic work!

---

428-439: Ohayo sensei! The entity grouping logic is on point.

The way you've grouped entities by their models using a HashMap is efficient and well-implemented. Parsing the model IDs string and handling errors is done correctly. The use of or_default() is a nice touch. Great job!

---

440-462: Ohayo sensei! The entity retrieval logic is well-structured.

The way you iterate over the grouped entities and retrieve their schemas using the model_cache is efficient and well-organized. The SQL query construction using build_sql_query is clear and handles the necessary conditions. Nice work!

---

467-472: Ohayo sensei! The query execution is spot-on.

Executing the constructed SQL query and binding the entity IDs to the query parameters is the right approach. It ensures proper escaping and prevents SQL injection vulnerabilities. Storing the results in rows is

---

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

[glihm]

Replaced by #2443.