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: check for 0 before division #3914

Merged
merged 3 commits into from
Oct 29, 2024
Merged

Fix: check for 0 before division #3914

merged 3 commits into from
Oct 29, 2024

Conversation

jonator
Copy link
Member

@jonator jonator commented Oct 25, 2024

What is the purpose of the change:

Linear Task

Not the end of the world, as it only affects wallets connected with 0 balance. And is caught by error boundary. This is why I'm merging to stage.

Checks for 0 before calculating portfolio %.

Brief Changelog

  • Check for div 0.

Testing and Verifying

Added test case for 0 balance allocation.

Copy link

vercel bot commented Oct 25, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
osmosis-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 29, 2024 9:52am
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
osmosis-frontend-datadog ⬜️ Ignored (Inspect) Visit Preview Oct 29, 2024 9:52am
osmosis-frontend-dev ⬜️ Ignored (Inspect) Visit Preview Oct 29, 2024 9:52am
osmosis-frontend-edgenet ⬜️ Ignored (Inspect) Oct 29, 2024 9:52am
osmosis-testnet ⬜️ Ignored (Inspect) Visit Preview Oct 29, 2024 9:52am

Copy link
Contributor

coderabbitai bot commented Oct 25, 2024

Walkthrough

The changes made in this pull request focus on improving the handling of percentage calculations within the getAll and calculatePercentAndFiatValues functions. Specifically, the modifications ensure that when the totalCap is zero, the calculations assign a RatePretty(0) instead of attempting a division, which could lead to errors. This adjustment is applied consistently across three locations in the code to enhance error handling related to division by zero scenarios. Additionally, test cases have been updated to reflect these changes.

Changes

File Path Change Summary
packages/server/src/queries/complex/portfolio/allocation.ts Updated percentage calculations in getAll and calculatePercentAndFiatValues functions to check for zero totalCap before division, assigning RatePretty(0) when applicable.
packages/server/src/queries/complex/portfolio/tests/allocation.spec.ts Modified tests for calculatePercentAndFiatValues to remove asynchronous calls and added a new test case for zero asset balances.

Possibly related PRs

Suggested reviewers

  • p0mvn
  • MaxMillington
  • JoseRFelix

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

🧹 Outside diff range and nitpick comments (1)
packages/server/src/queries/complex/portfolio/allocation.ts (1)

129-131: Consider simplifying the otherPercentage calculation.

While the current implementation is correct, it could be more concise and consistent with the pattern used in other locations.

Consider this simplified version:

-  const otherPercentage = totalCap.isZero()
-    ? new RatePretty(0)
-    : new RatePretty(otherAmount).quo(totalCap);
+  const otherPercentage = totalCap.isZero()
+    ? new RatePretty(0)
+    : new RatePretty(otherAmount.quo(totalCap));
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 223dd1e and af92854.

📒 Files selected for processing (1)
  • packages/server/src/queries/complex/portfolio/allocation.ts (3 hunks)
🔇 Additional comments (3)
packages/server/src/queries/complex/portfolio/allocation.ts (3)

114-116: LGTM! Consistent zero check implementation.

The zero check implementation is consistent with the pattern used elsewhere in the file and correctly protects the asset percentage calculations.


Line range hint 71-131: Consider adding comprehensive test coverage.

While the zero check implementations are correct, it would be valuable to add test cases that verify:

  1. Zero total balance scenarios
  2. Mixed scenarios with some zero and some non-zero allocations
  3. Edge cases where only "Other" category has value

Let's check for existing test coverage:

#!/bin/bash
# Look for test files related to allocation
fd -e test.ts -e spec.ts allocation

Would you like me to help generate comprehensive test cases for these scenarios?


71-73: LGTM! Zero check properly implemented.

The implementation correctly handles the division by zero case by returning RatePretty(0) when totalCap is zero.

Let's verify that all division operations in the file are protected:

✅ Verification successful

All division operations are properly protected against zero division

The verification shows that there are three instances of division operations using quo in the file:

  1. Line 73: Protected by totalCap.isZero() check
  2. Line 116: Protected by similar zero check pattern
  3. Line 131: Also protected by zero check pattern

The test file confirms proper handling of zero cases and various allocation scenarios, including edge cases.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for potential division operations that might need zero checks
rg -n 'quo\(' packages/server/src/queries/complex/portfolio/allocation.ts

Length of output: 206


Script:

#!/bin/bash
# Let's try a different approach to search for division operations
rg -n "quo|div" packages/server/src/queries/complex/portfolio/allocation.ts

# Also search for RatePretty to understand the context better
rg -n "RatePretty" packages/server/src/queries/complex/portfolio/allocation.ts

# Let's also check the test file to understand the test coverage
cat packages/server/src/queries/complex/portfolio/__tests__/allocation.spec.ts

Length of output: 11862

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

🧹 Outside diff range and nitpick comments (1)
packages/server/src/queries/complex/portfolio/__tests__/allocation.spec.ts (1)

190-245: Good test coverage for zero balance scenario!

The test case effectively validates the division by zero fix by ensuring that:

  1. Zero balances are handled gracefully
  2. All assets return 0% percentage and $0 fiat value
  3. The behavior is consistent across different assets

Consider enhancing the test coverage with:

  1. Mixed scenarios where some assets have zero balance while others don't
  2. Explicit assertions that no errors are thrown

Example addition:

it("should handle mixed zero and non-zero balances correctly", () => {
  const mixedBalanceData = {
    ...MOCK_DATA.categories,
    "total-assets": {
      capitalization: "10.000000000000000000",
      account_coins_result: [
        {
          coin: {
            denom: "factory/osmo1pfyxruwvtwk00y8z06dh2lqjdj82ldvy74wzm3/WOSMO",
            amount: "0",
          },
          cap_value: "0",
        },
        {
          coin: {
            denom: "factory/osmo1rckme96ptawr4zwexxj5g5gej9s2dmud8r2t9j0k0prn5mch5g4snzzwjv/sail",
            amount: "100",
          },
          cap_value: "10.000000000000000000",
        },
      ],
      is_best_effort: false,
    },
  };

  expect(() => 
    calculatePercentAndFiatValues(mixedBalanceData, assetLists, "total-assets", 5)
  ).not.toThrow();
});
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between af92854 and 6b6ee0c.

📒 Files selected for processing (1)
  • packages/server/src/queries/complex/portfolio/tests/allocation.spec.ts (3 hunks)

@yury-dubinin yury-dubinin merged commit 15f2180 into stage Oct 29, 2024
34 checks passed
@yury-dubinin yury-dubinin deleted the jon/div-0 branch October 29, 2024 10:10
yury-dubinin added a commit that referenced this pull request Oct 29, 2024
* Increase order amounts (#3921)

* Fix: check for 0 before division (#3914)

* check for 0 in tests

* Updated Prod E2E tests workflow (#3923)

---------

Co-authored-by: Jon Ator <jonathanator0@gmail.com>
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.

3 participants