petabi / review-database

Storage subsystem for REview
Apache License 2.0
1 stars 7 forks source link

Return an error if the time argument is empty #370

Closed atyoshioka closed 2 weeks ago

atyoshioka commented 2 weeks ago

This PR is to return an error if time is empty. The columnStatistics is defined as follows and time must not be empty.

columnStatistics(
  cluster: ID!
  time: [NaiveDateTime!]!
  ): JSON!

(I'm not sure why the return type is still JSON)

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The pull request introduces modifications to the get_column_statistics method in the Database implementation located in src/column_statistics/load.rs. Key changes include an early return for empty time arguments that raises an InvalidInput error, streamlining the query construction by integrating filtering directly into the query, and updating the Diesel import statement to include BoolExpressionMethods. These changes enhance error handling and simplify the query logic while preserving the method's existing functionality.

Changes

File Path Change Summary
src/column_statistics/load.rs - Modified get_column_statistics method to return InvalidInput for empty time argument.
- Streamlined query construction by removing separate conditional check for time.is_empty().
- Updated import statement to include BoolExpressionMethods.

Poem

In the code where rabbits hop,
An empty time now makes us stop.
With queries sleek and errors caught,
Our statistics dance, a joyful thought!
Hooray for changes, swift and bright,
In the database, all feels right! 🐇✨


📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between aaab9e78601275fe71b00b697748e1ca87cfe634 and 6b1d71e5ea7aab9b062135c423ce6aebd7bb9c8d.
📒 Files selected for processing (1) * `src/column_statistics/load.rs` (2 hunks)
🔇 Additional comments (4)
src/column_statistics/load.rs (4) `12-12`: **LGTM: Required import for query boolean operations.** The addition of `BoolExpressionMethods` is necessary for the `.and()` operation used in the query construction. --- `72-76`: **LGTM: Appropriate error handling for empty time argument.** The error handling correctly enforces the GraphQL schema requirement of a non-nullable time list with a clear error message. --- `78-88`: **LGTM: Query construction is clean and type-safe.** The query effectively combines cluster and time filtering conditions using diesel's type-safe query builder. --- `81-85`: **Consider adding an index for batch_ts filtering.** The `eq_any` operation on `batch_ts` could benefit from an index to improve query performance, especially with large time vectors. Let's check if an index exists:

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 2 weeks ago

Codecov Report

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

Project coverage is 67.69%. Comparing base (aaab9e7) to head (6b1d71e).

Files with missing lines Patch % Lines
src/column_statistics/load.rs 0.00% 14 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #370 +/- ## ========================================== - Coverage 67.71% 67.69% -0.03% ========================================== Files 95 95 Lines 20050 20056 +6 ========================================== Hits 13577 13577 - Misses 6473 6479 +6 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

msk commented 2 weeks ago

As far as I understand, [NaiveDateTime!]! typically means it can be an empty list (though not null, and each element if present must not be null). Can you help me understand why time must not be empty in this case?

atyoshioka commented 2 weeks ago

Thanks! My understanding about GraphQL schema was wrong. Will be closing this.