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-grpc): correct pagination logic for grpc query member #2256

Merged
merged 6 commits into from
Aug 9, 2024

Conversation

Larkooo
Copy link
Collaborator

@Larkooo Larkooo commented Aug 2, 2024

Fixes pagination logic for query by member on GRPC

Summary by CodeRabbit

  • New Features

    • Enhanced SQL query generation with added support for pagination through limit and offset parameters.
    • Introduced a count query feature to retrieve the total number of records alongside the main query results.
  • Improvements

    • Refinement of existing query construction to better integrate new optional parameters, allowing for more flexible data retrieval options.

Copy link

coderabbitai bot commented Aug 2, 2024

Walkthrough

Ohayo, sensei! The recent updates enhance the build_sql_query function across multiple files by introducing optional limit and offset parameters for seamless pagination in SQL queries. Additionally, the function now returns a count query alongside the main SQL query, significantly improving data management and efficiency when handling large datasets. These changes streamline the query construction process and enhance flexibility in database interactions.

Changes

Files Change Summary
crates/torii/core/src/model.rs Added limit and offset parameters to build_sql_query, enabling pagination; updated return type to include a count query.
crates/torii/grpc/src/server/mod.rs, crates/torii/grpc/src/server/subscriptions/... Modified build_sql_query calls to accommodate the new return type with the count query and added limit and offset parameters in various implementations.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant Database

    Client->>Server: Request data with pagination
    Server->>Database: Build SQL query with limit and offset
    Database-->>Server: Return paginated results
    Server-->>Client: Send paginated data and count query
Loading

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7e42534 and 70f9fd7.

Files selected for processing (4)
  • crates/torii/core/src/model.rs (5 hunks)
  • crates/torii/grpc/src/server/mod.rs (5 hunks)
  • crates/torii/grpc/src/server/subscriptions/entity.rs (1 hunks)
  • crates/torii/grpc/src/server/subscriptions/event_message.rs (1 hunks)
Files skipped from review as they are similar to previous changes (4)
  • crates/torii/core/src/model.rs
  • crates/torii/grpc/src/server/mod.rs
  • crates/torii/grpc/src/server/subscriptions/entity.rs
  • crates/torii/grpc/src/server/subscriptions/event_message.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/grpc/src/server/subscriptions/event_message.rs (1)

199-206: Ohayo sensei! The build_sql_query function definition does not include the additional parameters.

The build_sql_query function call has been updated to include two additional None parameters, but the function definition does not reflect these changes. Please update the function signature to handle the new parameters.

  • File: crates/torii/core/src/model.rs
  • Function: build_sql_query
Analysis chain

Ohayo sensei! Verify the new function call parameters.

The build_sql_query function call has been updated to include two additional None parameters. Ensure that the build_sql_query function handles these parameters correctly and that all necessary adjustments have been made.


Ohayo sensei! Let's verify the build_sql_query function parameters to ensure the new None parameters are correctly handled.


Ohayo sensei! Let's refine our search to ensure we capture the build_sql_query function definition correctly.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the new parameters in the `build_sql_query` function call.

# Test: Search for the `build_sql_query` function definition. Expect: Parameters include `extra_param1` and `extra_param2`.
rg --type rust 'fn build_sql_query'

Length of output: 92


Script:

#!/bin/bash
# Extract the `build_sql_query` function definition and its parameters.
ast-grep --lang rust --pattern 'fn build_sql_query($_, $_, $_, $_, $_, $_, $_, $_, $_) { $$$ }'

Length of output: 97


Script:

#!/bin/bash
# Search for the `build_sql_query` function definition and include surrounding lines for context.
rg --type rust 'fn build_sql_query' -A 10

Length of output: 712

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 (2)
crates/torii/core/src/model.rs (2)

234-235: Ohayo, sensei! Ensure that the new parameters are documented.

The limit and offset parameters are added to the function signature. Ensure that these new parameters are well-documented to maintain clarity for future developers.

/// Optional limit for the number of rows to fetch.
limit: Option<u32>,
/// Optional offset for the rows to fetch.
offset: Option<u32>,

236-236: Ohayo, sensei! Ensure the return type is documented.

The return type now includes a count query string. Ensure this change is reflected in the function documentation.

/// Returns a tuple containing the main query, a hashmap of formatted array queries, and a count query.

Copy link

codecov bot commented Aug 7, 2024

Codecov Report

Attention: Patch coverage is 55.10204% with 22 lines in your changes missing coverage. Please review.

Project coverage is 70.28%. Comparing base (f1c5214) to head (70f9fd7).

Files Patch % Lines
crates/torii/grpc/src/server/mod.rs 17.64% 14 Missing ⚠️
...ates/torii/grpc/src/server/subscriptions/entity.rs 0.00% 3 Missing ⚠️
...rii/grpc/src/server/subscriptions/event_message.rs 0.00% 3 Missing ⚠️
crates/torii/core/src/model.rs 92.30% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2256      +/-   ##
==========================================
- Coverage   70.29%   70.28%   -0.01%     
==========================================
  Files         342      342              
  Lines       45094    45125      +31     
==========================================
+ Hits        31698    31718      +20     
- Misses      13396    13407      +11     

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

@glihm glihm merged commit dc46e9c into dojoengine:main Aug 9, 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