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

remove panic when getting quantums from zero position #1964

Merged
merged 4 commits into from
Jul 26, 2024

Conversation

jayy04
Copy link
Contributor

@jayy04 jayy04 commented Jul 24, 2024

Changelist

[Describe or list the changes made in this PR]

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • New Features

    • Enhanced functionality to manage perpetual positions with the addition of a QuoteBalance attribute.
  • Bug Fixes

    • Improved error handling in the GetBigQuantums method to prevent abrupt terminations, enhancing system robustness.
    • Updated GetIsLong method to provide a boolean return value for zero quantum positions instead of causing a panic.
    • Modified validation logic in test cases to handle errors without triggering panic, indicating improved error handling.

Copy link
Contributor

coderabbitai bot commented Jul 24, 2024

Walkthrough

The recent changes enhance error handling in the GetBigQuantums methods of the AssetPosition and PerpetualPosition structs by removing panic conditions for zero quantum sizes. The GetIsLong method's tests have been simplified to return boolean values instead of panicking. Additionally, a new QuoteBalance field has been introduced in the PerpetualPosition struct, expanding its functionality and improving robustness while simplifying control flow.

Changes

Files Change Summary
protocol/x/subaccounts/types/position_size.go
protocol/x/subaccounts/types/position_size_test.go
Enhanced error handling in GetBigQuantums methods by eliminating panic conditions. Updated GetIsLong tests to return booleans instead of expecting panics.
protocol/x/subaccounts/lib/updates.go Introduced QuoteBalance field in PerpetualPosition struct within GetSettledSubaccountWithPerpetuals.
protocol/x/subaccounts/types/genesis_test.go Adjusted validation tests to no longer expect panics, simplifying expected error handling and improving robustness.

Poem

In fields of code, where bunnies play,
No more panics to lead us astray.
With gentle checks, our paths are clear,
Robust and safe, we frolic with cheer! 🐇✨
A leap of logic, a hop of grace,
In every function, we find our place!


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
Contributor

@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 aac4e49 and ad83868.

Files selected for processing (2)
  • protocol/x/subaccounts/types/position_size.go (3 hunks)
  • protocol/x/subaccounts/types/position_size_test.go (3 hunks)
Additional comments not posted (17)
protocol/x/subaccounts/types/position_size_test.go (5)

Line range hint 10-20:
LGTM!

The TestGetBigQuantums function covers positive, negative, and nil positions effectively.


45-46: LGTM!

The changes to TestPerpetualPosition_GetIsLong align with the updated behavior of the GetIsLong method, ensuring it returns False for zeroPosition instead of panicking.


71-72: LGTM!

The changes to TestAssetPosition_GetIsLong align with the updated behavior of the GetIsLong method, ensuring it returns False for zeroPosition instead of panicking.


Line range hint 78-87:
LGTM!

The TestAssetUpdate_GetIsLong function is well-written and covers edge cases effectively.


Line range hint 92-101:
LGTM!

The TestPerpetualUpdate_GetIsLong function is well-written and covers edge cases effectively.

protocol/x/subaccounts/types/position_size.go (12)

42-44: LGTM!

The GetId function for AssetPosition is straightforward and correct.


44-48: LGTM!

The changes to GetBigQuantums for AssetPosition enhance robustness by handling nil positions and nil quantums gracefully.


Line range hint 50-54:
LGTM!

The GetIsLong function for AssetPosition is straightforward and correct.


Line range hint 56-58:
LGTM!

The GetId function for PerpetualPosition is straightforward and correct.


Line range hint 60-62:
LGTM!

The SetQuantums function for PerpetualPosition is straightforward and correct.


68-72: LGTM!

The changes to GetBigQuantums for PerpetualPosition enhance robustness by handling nil positions and nil quantums gracefully.


Line range hint 74-78:
LGTM!

The GetQuoteBalance function for PerpetualPosition is straightforward and correct.


Line range hint 80-84:
LGTM!

The GetIsLong function for PerpetualPosition is straightforward and correct.


Line range hint 86-88:
LGTM!

The GetIsLong function for AssetUpdate is straightforward and correct.


Line range hint 90-92:
LGTM!

The GetBigQuantums function for AssetUpdate is straightforward and correct.


Line range hint 94-98:
LGTM!

The GetBigQuoteBalance function for PerpetualUpdate is straightforward and correct.


Line range hint 106-108:
LGTM!

The GetIsLong function for PerpetualUpdate is straightforward and correct.

Copy link
Contributor

@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 ad83868 and 03ef4fb.

Files selected for processing (1)
  • protocol/x/subaccounts/lib/updates.go (1 hunks)
Additional comments not posted (1)
protocol/x/subaccounts/lib/updates.go (1)

61-61: Ensure the QuoteBalance field is correctly handled.

The new QuoteBalance field has been added to the PerpetualPosition struct. Ensure that this field is correctly populated and used in downstream logic.

Copy link
Contributor

@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 03ef4fb and 04b94d3.

Files selected for processing (1)
  • protocol/x/subaccounts/types/genesis_test.go (3 hunks)
Additional comments not posted (2)
protocol/x/subaccounts/types/genesis_test.go (2)

174-175: LGTM! The change aligns with the PR objective.

The shouldPanic flag is correctly set to false for the test case "invalid: asset position quantum == 0", indicating that the function should handle this case without panicking.


223-224: LGTM! The change aligns with the PR objective.

The shouldPanic flag is correctly set to false for the test case "invalid: perpetual position quantum == 0", indicating that the function should handle this case without panicking.

@jayy04 jayy04 merged commit cd9380f into main Jul 26, 2024
18 checks passed
@jayy04 jayy04 deleted the jy/remove-position-panic branch July 26, 2024 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants