(Hotfix) Avoid computing overspend if 1CT session is disabled

[JoseRFelix]

No description provided.

[vercel]

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	Dec 2, 2024 0:42am

4 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
osmosis-frontend-datadog	⬜️ Ignored (Inspect)			Dec 2, 2024 0:42am
osmosis-frontend-dev	⬜️ Ignored (Inspect)			Dec 2, 2024 0:42am
osmosis-frontend-edgenet	⬜️ Ignored (Inspect)			Dec 2, 2024 0:42am
osmosis-testnet	⬜️ Ignored (Inspect)			Dec 2, 2024 0:42am

[coderabbitai]

Walkthrough

The pull request introduces modifications to the one-click trading functionality within the use-one-click-trading-swap-review.ts and review-order.tsx files. Key changes include updates to the wouldExceedSpendLimit function, which now incorporates checks for the enabled state of one-click trading, affecting how transaction parameters and spend limits are handled. Additionally, refinements to memoization and dependency management enhance the clarity and efficiency of the logic, particularly regarding slippage handling and error rendering.

Changes

File Path	Change Summary
packages/web/hooks/one-click-trading/use-one-click-trading-swap-review.ts	Updated wouldExceedSpendLimit to check enabled state; refined dependency array; updated function signatures for useOneClickRemainingSpendLimit and formatSpendLimit.
packages/web/modals/review-order.tsx	Modified ReviewOrder component to enhance wouldExceedSpendLimit logic with is1CTEnabled check; refined memoization and dependency management; adjusted handleManualSlippageChange function.

Possibly related PRs

• 🤗 Embrace the 1-Click: Add 1-Click enable and modify to swap review #3954: Integrates one-click trading functionality into the review order modal, directly related to the main PR's enhancements.
• 👻 Who Ya Gonna Call?: Fix referential instability in useSwap to stop continuous rerenders and high CPU usage #3956: Addresses performance issues in the useSwap hook, relevant to the trading functionality and interaction with the main PR.
• (1CT) Enable other fee tokens for 1-Click Trading #3969: Enhances one-click trading by allowing alternative fee tokens, relating to overall improvements in trading logic.
• (1CT) Create single tx to activate 1-Click Trading from swap review modal #3970: Consolidates activation of one-click trading into a single transaction, aligning with the main PR's focus on transaction parameters.
• (1CT) Add events when creating 1CT session in swap review #3971: Implements event logging for one-click trading sessions during the swap review, directly connected to enhancements in transaction management.

Suggested reviewers

• jonator
• CryptoAssassin1

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.

packages/web/hooks/one-click-trading/use-one-click-trading-swap-review.ts

Oops! Something went wrong! :(

ESLint: 8.50.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/packages/web/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c787085 and f1a1a7b.

📒 Files selected for processing (2)

• packages/web/hooks/one-click-trading/use-one-click-trading-swap-review.ts (2 hunks)
• packages/web/modals/review-order.tsx (1 hunks)

🧰 Additional context used

📓 Learnings (1)

packages/web/modals/review-order.tsx (1)

Learnt from: greg-nagy
PR: osmosis-labs/osmosis-frontend#3954
File: packages/web/modals/review-order.tsx:132-136
Timestamp: 2024-11-15T10:08:23.742Z
Learning: In `packages/web/modals/review-order.tsx`, the calculation of `wouldExceedSpendLimit` in the `ReviewOrder` component handles optional chaining and null values correctly, and does not require providing default values to avoid potential `NaN` results.

🔇 Additional comments (3)

packages/web/hooks/one-click-trading/use-one-click-trading-swap-review.ts (1)

Line range hint 299-313: LGTM! The changes correctly implement the hotfix.

The modification to wouldExceedSpendLimit now properly handles the disabled state of one-click trading by:

1. Early returning false when the feature is disabled
2. Early returning false when the spend amount is zero
3. Adding enabled to the dependency array for proper memoization

This aligns with the PR objective of avoiding unnecessary overspend computations when 1CT is disabled.

packages/web/modals/review-order.tsx (2)

135-146: LGTM! UI changes are consistent with the core logic.

The changes to wouldExceedSpendLimit in the UI layer:

1. Early return false when one-click trading is disabled
2. Update dependency array to include all required dependencies
3. Simplify the dependency on overspendErrorParams by only including the needed wouldSpendTotal property

This ensures the UI behaves consistently with the core logic changes.

---

Line range hint 135-313: Verify consistent implementation across the codebase.

Let's verify that the disabled state check is consistently implemented across all related code.

✅ Verification successful

Based on the search results, I can now generate the final response as I have sufficient information to verify the implementation consistency.

Implementation is consistent across the codebase

The disabled state check is properly implemented:

• In use-one-click-trading-swap-review.ts, the wouldExceedSpendLimit hook is only used when enabled: isEnabled is passed to useOneClickRemainingSpendLimit
• In review-order.tsx, the wouldExceedSpendLimit memo properly guards the calculation with if (!is1CTEnabled) return false
• All other usages of wouldExceedSpendLimit are properly consuming these values, particularly in UI components where it's used for disabling buttons and showing warnings

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any other instances where overspend is calculated without checking the enabled state.

# Search for functions that might calculate overspend
ast-grep --pattern 'function $name($params) {
  $$$
  wouldSpend$$$
  $$$
}'

# Search for usages of wouldExceedSpendLimit without enabled check
rg -A 5 'wouldExceedSpendLimit'

Length of output: 5816

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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