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

fix: add next price negativity check #3

Merged
merged 2 commits into from
Aug 7, 2024
Merged

fix: add next price negativity check #3

merged 2 commits into from
Aug 7, 2024

Conversation

g-luca
Copy link
Contributor

@g-luca g-luca commented Aug 7, 2024

This PR ensure that the NextPrice in the ReportBalance is not negative.

Closes #1 .

Summary by CodeRabbit

  • New Features

    • Enhanced validation for the next price input in the balance reporting functionality, ensuring that only positive values are accepted.
  • Bug Fixes

    • Improved error handling for scenarios where a negative next price is provided, ensuring invalid inputs are correctly flagged.
  • Tests

    • Added a new test case to verify the error handling for negative next price values, strengthening the testing suite's coverage.

@g-luca g-luca requested a review from johnletey August 7, 2024 08:58
Copy link

coderabbitai bot commented Aug 7, 2024

Walkthrough

The recent code changes enhance the ReportBalance method in the aggregatorMsgServer by refining the validation logic for the NextPrice parameter, ensuring it must be positive. This adjustment explicitly flags zero and negative prices as invalid, strengthening the robustness of the pricing validation. Correspondingly, a new test case was introduced to verify that the method rejects negative inputs, further enhancing error handling in the balance reporting process.

Changes

Files Change Summary
x/halo/keeper/msg_server_aggregator.go, x/halo/keeper/msg_server_aggregator_test.go Modified the ReportBalance method to check if NextPrice is positive, and added a test case to validate error handling for negative inputs.

Assessment against linked issues

Objective Addressed Explanation
HAL-02: Missing NextPrice negativity check (#1)

🐰 In the meadow, where prices bloom,
A check was added to stave off gloom.
No more will negatives creep in sly,
Valid values now reach for the sky!
With tests in place, we hop with glee,
Ensuring our prices are fair, you see! 🌼


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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 55c81de and 4456c33.

Files selected for processing (2)
  • x/halo/keeper/msg_server_aggregator.go (1 hunks)
  • x/halo/keeper/msg_server_aggregator_test.go (1 hunks)
Additional comments not posted (2)
x/halo/keeper/msg_server_aggregator.go (1)

51-51: LGTM! The addition of the negativity check is correct.

The explicit check for negative values enhances the validation logic, ensuring that NextPrice is not negative.

x/halo/keeper/msg_server_aggregator_test.go (1)

59-69: LGTM! The addition of the test case is correct.

The test case ensures that the system correctly handles and rejects negative values for NextPrice, improving the robustness of the error handling.

Copy link
Member

@johnletey johnletey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks for working on this! Just one minor cleanup.

x/halo/keeper/msg_server_aggregator.go Outdated Show resolved Hide resolved
@johnletey johnletey changed the title fix: ensure NextPrice negativity check fix: add next price negativity check Aug 7, 2024
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4456c33 and d388dbd.

Files selected for processing (1)
  • x/halo/keeper/msg_server_aggregator.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/halo/keeper/msg_server_aggregator.go

@johnletey johnletey merged commit 98a4948 into main Aug 7, 2024
2 checks passed
@johnletey johnletey deleted the hal-02 branch August 7, 2024 13:45
g-luca added a commit that referenced this pull request Aug 8, 2024
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.

HAL-02: Missing NextPrice negativity check
2 participants