fix: fallback to recommendedQuote when selectedQuote is stale (#8154)

## Explanation

Fixing a bug which causes the UI to get a nonexistent `activeQuote` on
refresh. This updates the selector so it checks whether the
`selectedQuote` exists in the sorted quotes list first, and falls back
on the `recommendedQuote` otherwise

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/processes/updating-changelogs.md)
- [ ] I've introduced [breaking
changes](https://github.com/MetaMask/core/tree/main/docs/processes/breaking-changes.md)
in this PR and have prepared draft pull requests for clients and
consumer packages to resolve them


<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Small, well-tested change to quote selection logic; primary risk is
minor behavior change in how `activeQuote` is chosen when quotes
refresh.
> 
> **Overview**
> Fixes stale quote selection by updating `selectActiveQuote` (used by
`selectBridgeQuotes`) to only return `selectedQuote` if its `requestId`
still exists in `sortedQuotes`, otherwise falling back to the
`recommendedQuote`.
> 
> Updates unit tests to cover both the valid-selected-quote case and the
stale-selected-quote fallback, and adds a changelog entry plus minor
JSDoc punctuation/clarifications in `QuoteMetadata`.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
517219a. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: micaelae

packages/bridge-controller/CHANGELOG.md

@@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Add optional `active_ab_tests` property in Unified SwapBridge metrics event context and payload types, alongside existing `ab_tests`. ([#8152](https://github.com/MetaMask/core/pull/8152))
 
+### Fixed
+
+- Check whether `selectedQuote` exists in `selectBridgeQuotes.sortedQuotes` before returning it as the `activeQuote`. Fall back on the `recommendedQuote` if selectedQuote is stale ([#8154](https://github.com/MetaMask/core/pull/8154))
+
 ## [69.0.1]
 
 ### Changed

packages/bridge-controller/src/selectors.test.ts

@@ -1256,12 +1256,37 @@ describe('Bridge Selectors', () => {
     });
 
     it('should handle selected quote', () => {
+      const selectedQuote = {
+        ...mockState.quotes[0],
+        quote: { ...mockState.quotes[0].quote, requestId: '123' },
+      } as never;
       const result = selectBridgeQuotes(mockState, {
         ...mockClientParams,
-        selectedQuote: mockQuote as never,
+        selectedQuote,
       });
 
-      expect(result.activeQuote).toStrictEqual(mockQuote);
+      expect(result.recommendedQuote).toStrictEqual(
+        expect.objectContaining(mockState.quotes[1]),
+      );
+      expect(result.activeQuote).toStrictEqual(
+        expect.objectContaining(selectedQuote),
+      );
+    });
+
+    it('should set recommendedQuote as activeQuote when selected quote is not found', () => {
+      const selectedQuote = {
+        ...mockState.quotes[0],
+        quote: { ...mockState.quotes[0].quote, requestId: 'abc' },
+      } as never;
+      const result = selectBridgeQuotes(mockState, {
+        ...mockClientParams,
+        selectedQuote,
+      });
+
+      expect(result.recommendedQuote).toStrictEqual(
+        expect.objectContaining(mockState.quotes[1]),
+      );
+      expect(result.activeQuote).toStrictEqual(result.recommendedQuote);
     });
 
     it('should handle quote refresh state', () => {

packages/bridge-controller/src/selectors.ts

@@ -414,15 +414,15 @@ const selectBridgeQuotesWithMetadata = createBridgeSelector(
         minToTokenAmount,
         swapRate: calcSwapRate(sentAmount.amount, toTokenAmount.amount),
         /**
-        This is the amount required to submit the transactions
-        Includes the relayer fee or other native fees
+        This is the amount required to submit all the transactions.
+        Includes the relayer fee or other native fees.
         Should be used for balance checks and tx submission.
          */
         totalNetworkFee: totalEstimatedNetworkFee,
         totalMaxNetworkFee,
         /**
         This contains gas fee estimates for the bridge transaction
-        Does not include the relayer fee (if needed), just the gasLimit and effectiveGas returned by the bridge API
+        Does not include the relayer fee (if needed), just the gasLimit and effectiveGas returned by the bridge API.
         Should only be used for display purposes.
          */
         gasFee,
@@ -485,9 +485,13 @@ const selectRecommendedQuote = createBridgeSelector(
 const selectActiveQuote = createBridgeSelector(
   [
     selectRecommendedQuote,
-    (_, { selectedQuote }: BridgeQuotesClientParams) => selectedQuote,
+    selectSortedBridgeQuotes,
+    (_, { selectedQuote }) => selectedQuote,
   ],
-  (recommendedQuote, selectedQuote) => selectedQuote ?? recommendedQuote,
+  (recommendedQuote, sortedQuotes, selectedQuote) =>
+    sortedQuotes.find(
+      (quote) => quote.quote.requestId === selectedQuote?.quote.requestId,
+    ) ?? recommendedQuote,
 );
 
 const selectIsQuoteGoingToRefresh = createBridgeSelector(

packages/bridge-controller/src/types.ts

@@ -114,7 +114,8 @@ export type ExchangeRate = { exchangeRate?: string; usdExchangeRate?: string };
  */
 export type QuoteMetadata = {
   /**
-   * If gas is included, this is the value of the src or dest token that was used to pay for the gas
+   * If gas is included, this is the value of the src or dest token that was used to pay for the gas.
+   * Show this value to indicate transaction fees for gasless quotes.
    */
   includedTxFees?: TokenAmountValues | null;
   /**
@@ -125,6 +126,12 @@ export type QuoteMetadata = {
    * max is the max gas fee that will be used by the transaction.
    */
   gasFee: Record<'effective' | 'total' | 'max', TokenAmountValues>;
+  /**
+   * The total network fee required to submit the trade and any approvals. This includes
+   * the relayer fee or other native fees. Should be used for balance checks and tx submission.
+   * Note: This is only accurate for non-gasless transactions. Use {@link QuoteMetadata.includedTxFees} to
+   * get the total network fee for gasless transactions.
+   */
   totalNetworkFee: TokenAmountValues; // estimatedGasFees + relayerFees
   totalMaxNetworkFee: TokenAmountValues; // maxGasFees + relayerFees
   /**
@@ -136,16 +143,24 @@ export type QuoteMetadata = {
    */
   minToTokenAmount: TokenAmountValues;
   /**
-   * If gas is included: toTokenAmount
-   * Otherwise: toTokenAmount - totalNetworkFee
+   * If gas is included: {@link QuoteMetadata.toTokenAmount} - {@link QuoteMetadata.includedTxFees}.
+   * Otherwise: {@link QuoteMetadata.toTokenAmount} - {@link QuoteMetadata.totalNetworkFee}.
    */
   adjustedReturn: Omit<TokenAmountValues, 'amount'>;
   /**
-   * The amount that the user will send, including fees
-   * srcTokenAmount + metabridgeFee + txFee
+   * The amount that the user will send, including fees that are paid in the src token
+   * {@link Quote.srcTokenAmount} + {@link Quote.feeData[FeeType.METABRIDGE].amount} + {@link Quote.feeData[FeeType.TX_FEE].amount}
    */
   sentAmount: TokenAmountValues;
-  swapRate: string; // destTokenAmount / sentAmount
+  /**
+   * The swap rate is the amount that the user will receive per amount sent. Accounts for fees paid in the src or dest token.
+   * This is calculated as {@link QuoteMetadata.toTokenAmount} / {@link QuoteMetadata.sentAmount}.
+   */
+  swapRate: string;
+  /**
+   * The cost of the trade, which is the difference between the amount sent and the adjusted return.
+   * This is calculated as {@link QuoteMetadata.sentAmount} - {@link QuoteMetadata.adjustedReturn}.
+   */
   cost: Omit<TokenAmountValues, 'amount'>; // sentAmount - adjustedReturn
 };