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: disable rango from ui on unsupported networks #590

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

NickKelly1
Copy link
Contributor

@NickKelly1 NickKelly1 commented Jan 3, 2025

Summary by CodeRabbit

  • New Features

    • Enhanced error handling for ParaSwap and Rango providers
    • Added network support validation for Rango provider
  • Bug Fixes

    • Improved error logging for swap and quote operations
    • Added checks for API response completeness
  • Refactor

    • Renamed network support method in Rango class
    • Simplified test case syntax in Changelly test suite

@NickKelly1 NickKelly1 requested a review from kvhnuke January 3, 2025 19:30
Copy link

coderabbitai bot commented Jan 3, 2025

Walkthrough

This pull request introduces improvements to error handling and network support validation across multiple files in the swap providers. The changes focus on enhancing error logging in the ParaSwap provider, refining network support checks in the Rango provider, and making minor code cleanup in the test suite. The modifications aim to provide more informative error messages and improve the robustness of network validation logic.

Changes

File Change Summary
packages/swap/src/providers/paraswap/index.ts Enhanced error logging in getParaswapSwap and getQuote methods with more descriptive error messages. Added checks for priceRoute property in getQuote method.
packages/swap/src/providers/rango/index.ts Added isNetworkSupportedByEnkrypt static method. Renamed isNetworkSupported to isNetworkSupportedByEnkryptAndRango. Updated init method to validate network support.
packages/swap/src/providers/rango/supported.ts Changed import statement from single quotes to double quotes.
packages/swap/tests/changelly.test.ts Removed unnecessary parentheses in getStatusObject method call.

Suggested reviewers

  • gamalielhere
  • kvhnuke

Possibly related PRs


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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

github-actions bot commented Jan 3, 2025

💼 Build Files
chrome: enkrypt-chrome-5a31c561.zip
firefox: enkrypt-firefox-5a31c561.zip

💉 Virus total analysis
chrome: 5a31c561
firefox: 5a31c561

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

🧹 Nitpick comments (5)
packages/swap/src/providers/paraswap/index.ts (3)

201-201: Use structured error logging.
Rather than printing the entire error object, consider including a structured mapping (e.g., error code, message) to facilitate potential automatic handling or metrics capturing.


248-248: Avoid swallowing rejection reasons.
If you suppress promise rejections here, debugging becomes more challenging. Consider rethrowing or returning a meaningful error that can be handled upstream or by the caller.


335-335: Handle partial fallback for quotes.
While logging an error is helpful for debugging, returning null from the catch block ends the flow silently. Consider providing a fallback result or user notification if partial data is acceptable.

packages/swap/src/providers/rango/index.ts (2)

314-320: Add user feedback for unsupported networks.
Currently, the method logs a message and returns early, which is a good start. For better UX, consider providing a user-visible notification or an explicit error so that clients can gracefully handle unsupported networks.


439-444: Ensure real-time tracking of newly supported networks.
You're using a static map (supportedNetworkInfoByName) to check Enkrypt's support. If your system supports dynamic updates, consider refreshing this map periodically or at runtime to handle newly supported networks without redeployment.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eec3ed6 and 5a31c56.

📒 Files selected for processing (4)
  • packages/swap/src/providers/paraswap/index.ts (4 hunks)
  • packages/swap/src/providers/rango/index.ts (2 hunks)
  • packages/swap/src/providers/rango/supported.ts (1 hunks)
  • packages/swap/tests/changelly.test.ts (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • packages/swap/tests/changelly.test.ts
  • packages/swap/src/providers/rango/supported.ts
🔇 Additional comments (2)
packages/swap/src/providers/paraswap/index.ts (1)

286-297: Validate priceRoute behavior.
The added checks for priceRoute help clarify different error paths, which is good. Ensure any upstream logic handles these throws, or you'll encounter unhandled promise rejections in some frameworks.
[approve]

packages/swap/src/providers/rango/index.ts (1)

448-448: Keep naming consistent across providers.
Renaming this method to isNetworkSupportedByEnkryptAndRango clarifies its purpose. Ensure the code references, config, and docs across the repo reflect the new nomenclature to avoid confusion.

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.

2 participants