Align params behavior for unlimited limits

bdeneux commented 1 month ago

Following this comment, this PR aligns the behavior for all parameters regarding the unlimited case. Most parameters are now configured to be considered unlimited if either a nil value or a zero value is set. I chose to align the behavior of the max_size and max_result_count parameters with this approach, as they previously did not follow the same behavior.

Summary by CodeRabbit

New Features
- Added a new function for improved handling of pointer values in the logic module.
Bug Fixes
- Enhanced limit checks to ensure maximum size and result count values are non-zero, preventing unintended behaviors in queries.
Tests
- Introduced new test scenarios to validate the behavior of the updated limit checks and the new utility function, enhancing overall test coverage.

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes streamline limit checks and enhance documentation in the codebase. Notably, the params.proto file clarifies the behavior of size limits, while the grpc_query_ask.go file strengthens logic to prevent zero values for parameters. New utility functions and corresponding tests improve robustness and type safety. Overall, these updates aim to optimize query processing and error handling, ensuring clearer expectations for developers.

Changes

File	Change Summary
proto/logic/v1beta2/params.proto	Clarified comments for `max_size` and `max_result_count` to state both nil and zero values remove limitations.
x/logic/keeper/grpc_query_ask.go	Modified `checkLimits` function to use `NonZeroOrDefaultUInt`, preventing zero values for maximum size and result count.
x/logic/keeper/grpc_query_ask_test.go	Updated `maxResultCount` and `maxSize` types from `int` to `uint64`. Added tests for zero values. Refined error messages for clarity.
x/logic/util/pointer.go	Added `NonZeroOrDefaultUInt` function to handle pointers of `sdkmath.Uint`, returning default if nil or zero. Updated imports.
x/logic/util/pointer_test.go	Introduced `TestNonZeroOrDefaultUInt` to validate new function behavior with various input scenarios.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant LimitChecker
    participant QueryProcessor

    Client->>LimitChecker: Request query with maxSize and maxResultCount
    LimitChecker->>LimitChecker: Check if values are nil or zero
    LimitChecker->>QueryProcessor: Pass valid limits
    QueryProcessor->>Client: Return query results

🐰 In the code burrow, changes take flight,
With limits clarified, all feels just right.
Type safety blooms, errors refined,
Robustness grows, leaving doubts behind.
Hopping through code, we joyfully cheer,
For clearer logic, let’s give a great cheer! 🎉

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 .` - `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](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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

@@            Coverage Diff             @@
##             main     #713      +/-   ##
==========================================
+ Coverage   54.42%   54.49%   +0.06%     
==========================================
  Files          73       73              
  Lines        2901     2905       +4     
==========================================
+ Hits         1579     1583       +4     
  Misses       1228     1228              
  Partials       94       94

Files	Coverage Δ
x/logic/keeper/grpc_query_ask.go	`91.17% <100.00%> (ø)`
x/logic/util/pointer.go	`86.66% <100.00%> (+4.84%)`	:arrow_up:

axone-protocol / axoned