8000 fix(explorer): handle limit price is infinite by alfetopito · Pull Request #5886 · cowprotocol/cowswap · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix(explorer): handle limit price is infinite #5886

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

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jun 25, 2025
Merged

fix(explorer): handle limit price is infinite #5886

merged 2 commits into from
Jun 25, 2025

Conversation

alfetopito
Copy link
Collaborator
@alfetopito alfetopito commented Jun 25, 2025 •
edited by coderabbitai bot
Loading

Summary

Fixes a divide by zero crash caused by the buy amount being zero, causing a infinite limit price

To Test

  1. Open the order 0xfcbd64398f0a03405b4c37f356a36bc0acc538fa144f67a9471bafd905712d62ba3cb449bd2b4adddbc894d8697f5170800eadecffffffff
  • It should not crash
  • The price should be 0

Summary by CodeRabbit

  • Bug Fixes
    • Improved price display reliability by ensuring only valid numeric values are shown. Non-finite prices now default to '0' to prevent display issues.
  • New Features
    • Simplified order price display with clearer formatting showing limit price followed by the base symbol.
  • Chores
    • Updated utility functions for better input handling and export organization.

@vercel Vercel
Copy link
vercel bot commented Jun 25, 2025 •
edited
Loading

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

Name Status Preview Updated (UTC)
cowfi ✅ Ready (Inspect) Visit Preview Jun 25, 2025 10:39am
explorer-dev ✅ Ready (Inspect) Visit Preview Jun 25, 2025 10:39am
swap-dev ✅ Ready (Inspect) Visit Preview Jun 25, 2025 10:39am
3 Skipped Deployments
Name Status Preview Updated (UTC)
cosmos ⬜️ Ignored (Inspect) Visit Preview Jun 25, 2025 10:39am
sdk-tools ⬜️ Ignored (Inspect) Visit Preview Jun 25, 2025 10:39am
widget-configurator ⬜️ Ignored (Inspect) Visit Preview Jun 25, 2025 10:39am

@alfetopito alfetopito self-assigned this Jun 25, 2025
@alfetopito alfetopito requested review from a team June 25, 2025 09:46
@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Jun 25, 2025 •
edited
Loading

Walkthrough

The OrderPriceDisplay component was refactored to use a new utility function getLimitPrice for price calculation and formatting, with stricter typing for amounts as BigNumber. Utility functions in format.ts were reordered and improved to handle non-finite values safely. The getLimitPrice function was updated to accept a narrower input type containing only necessary order fields.

Changes

File Change Summary
apps/explorer/src/components/orders/OrderPriceDisplay/index.tsx Replaced manual price calculation and formatting with getLimitPrice; changed buyAmount and sellAmount types to BigNumber; simplified base symbol logic; updated imports accordingly.
apps/explorer/src/utils/format.ts Reordered exports; added formatPrice export; improved price formatting functions to handle non-finite values safely; minor code style adjustments.
apps/explorer/src/utils/getLimitPrice.ts Updated getLimitPrice parameter type to accept only required order fields (buyToken, sellToken, buyAmount, sellAmount); logic unchanged.

Suggested labels

RELEASE

Suggested reviewers

  • elena-zh

Poem

🐇 Hopping through code, so fresh and so bright,
Prices now clearer, displayed just right.
BigNumbers aligned, no strings in the race,
Functions trimmed down, with style and with grace.
A rabbit’s small cheer for this tidy new place! 🎉🐰

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

yarn install v1.22.22
[1/4] Resolving packages...
(node:7358) [DEP0169] DeprecationWarning: url.parse() behavior is not standardized and prone to errors that have security implications. Use the WHATWG URL API instead. CVEs are not issued for url.parse() vulnerabilities.
(Use node --trace-deprecation ... to show where the warning was created)
[2/4] Fetching packages...
error nx@21.0.3: The engine "node" is incompatible with this module. Expected version "^20.19.0 || ^22.12.0". Got "24.2.0"
error Found incompatible module.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e8db0c and 04e880d.

📒 Files selected for processing (3)
  • apps/explorer/src/components/orders/OrderPriceDisplay/index.tsx (2 hunks)
  • apps/explorer/src/utils/format.ts (6 hunks)
  • apps/explorer/src/utils/getLimitPrice.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
apps/explorer/src/components/orders/OrderPriceDisplay/index.tsx (2)
apps/explorer/src/utils/getLimitPrice.ts (1)
  • getLimitPrice (6-21)
apps/explorer/src/utils/format.ts (1)
  • safeTokenName (24-24)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Cypress
  • GitHub Check: Setup
🔇 Additional comments (8)
apps/explorer/src/utils/getLimitPrice.ts (1)

6-9: ```shell
#!/bin/bash

Locate calculatePrice implementation

rg -n "function calculatePrice" --type ts

Show context around calculatePrice definition

rg -A 5 -B 5 "function calculatePrice" --type ts


</details>
<details>
<summary>apps/explorer/src/components/orders/OrderPriceDisplay/index.tsx (3)</summary>

`39-46`: **LGTM! Good refactoring to centralize price calculation.**

The refactoring to use `getLimitPrice` utility function centralizes the price calculation logic and removes manual calculations from the component, improving maintainability.

---

`55-55`: **Simplified display logic improves readability.**

The display format was simplified to show just the limit price and base symbol, removing the quote symbol. This makes the display cleaner and easier to understand.

---

`13-16`: Let’s verify how `BigNumber` is imported in the component
8000
 to match it in the stories update:


```shell
#!/bin/bash
# Inspect the imports in OrderPriceDisplay to see the BigNumber source
sed -n '1,30p' apps/explorer/src/components/orders/OrderPriceDisplay/index.tsx
apps/explorer/src/utils/format.ts (4)

16-25: LGTM! Export reorganization improves code organization.

The reordering of exports and addition of formatPrice to the exported utilities improves the organization of the module.

238-238: Excellent fix for the divide-by-zero issue!

This change directly addresses the PR objective by handling infinite limit prices. When calculatedPrice is not finite (due to divide-by-zero when buy amount is zero), it now defaults to '0' instead of attempting to convert the infinite value to string, which would cause crashes.

259-259: Consistent handling of infinite values in executed price display.

This applies the same infinite value protection as in formatCalculatedPriceToDisplay, ensuring consistent behavior across both price display functions.

236-236: Good practice: Adding trailing commas to optional parameters.

The addition of trailing commas in function parameters follows TypeScript best practices and makes future parameter additions cleaner.

Also applies to: 257-257, 280-280

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@elena-zh
Copy link
Contributor

Hey @alfetopito , great, the order is no longer crashed.
However, the app is still srashed when navigate to this user's order history
image
Could you please fix it?

elena-zh
elena-zh approved these changes Jun 25, 2025
View reviewed changes
Copy link
Contributor
@elena-zh elena-zh left a comment

Choose a reason for hiding this comment

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

LGTM!

@alfetopito alfetopito merged commit 9c333cc into develop Jun 25, 2025
14 of 15 checks passed
@alfetopito alfetopito deleted the fix/explorer-display-price branch June 25, 2025 11:01
@github-actions github-actions bot locked and limited conversation to collaborators Jun 25, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@shoom3301 shoom3301 shoom3301 approved these changes

@elena-zh elena-zh elena-zh approved these changes

@cowdan cowdan cowdan approved these changes

Assignees

@alfetopito alfetopito

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@alfetopito @elena-zh @shoom3301 @cowdan
0