@metamask-previews/bridge-controller 79.2.0-preview-e81fe8853 → 79.2.0-preview-f7d67b054

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add Sentry quote-fetch and provider first-result performance traces ([#9899](https://github.com/MetaMask/core/pull/9899))
+
 ### Changed
 
 - Bump `@metamask/assets-controller` from `^13.1.2` to `^13.1.4` ([#9873](https://github.com/MetaMask/core/pull/9873), [#9886](https://github.com/MetaMask/core/pull/9886))

package/dist/bridge-controller.cjs

@@ -19,6 +19,7 @@ const contracts_1 = require("@ethersproject/contracts");
 const providers_1 = require("@ethersproject/providers");
 const metamask_eth_abis_1 = require("@metamask/metamask-eth-abis");
 const polling_controller_1 = require("@metamask/polling-controller");
+const uuid_1 = require("uuid");
 const quote_response_v1_to_v2_js_1 = require("./coercers/quote-response-v1-to-v2.cjs");
 const bridge_js_1 = require("./constants/bridge.cjs");
 const chains_js_1 = require("./constants/chains.cjs");
@@ -129,6 +130,18 @@ const metadata = {
         usedInUi: true,
     },
 };
+const QUOTE_ABORT_REASONS = new Set(Object.values(constants_js_1.AbortReason));
+const isExpectedQuoteAbort = (error, signal) => {
+    if (signal?.aborted) {
+        return true;
+    }
+    if (QUOTE_ABORT_REASONS.has(String(error))) {
+        return true;
+    }
+    const errorText = error instanceof Error ? `${error.name} ${error.message}` : String(error);
+    return (errorText.includes('AbortError') ||
+        errorText.includes('FetchRequestCanceledException'));
+};
 const MESSENGER_EXPOSED_METHODS = [
     'updateBridgeQuoteRequestParams',
     'fetchQuotes',
@@ -504,6 +517,9 @@ class BridgeController extends (0, polling_controller_1.StaticIntervalPollingCon
             __classPrivateFieldGet(this, _BridgeController_abortController, "f")?.abort(constants_js_1.AbortReason.NewQuoteRequest);
             __classPrivateFieldGet(this, _BridgeController_batchSellTradesAbortController, "f")?.abort(constants_js_1.AbortReason.NewQuoteRequest);
             __classPrivateFieldSet(this, _BridgeController_abortController, new AbortController(), "f");
+            const quoteTraceStartTime = Date.now();
+            const quoteTraceRequestId = (0, uuid_1.v4)();
+            const quoteAbortSignal = __classPrivateFieldGet(this, _BridgeController_abortController, "f").signal;
             __classPrivateFieldGet(this, _BridgeController_fetchAssetExchangeRates, "f").call(this, quoteRequests).catch((error) => console.warn('Failed to fetch asset exchange rates', error));
             this.trackUnifiedSwapBridgeEvent(constants_js_1.UnifiedSwapBridgeEventName.QuotesRequested, context);
             const { sse, maxRefreshCount } = (0, feature_flags_js_1.getBridgeFeatureFlags)(this.messenger);
@@ -524,43 +540,84 @@ class BridgeController extends (0, polling_controller_1.StaticIntervalPollingCon
                 }
             });
             const jwt = await __classPrivateFieldGet(this, _BridgeController_getJwt, "f").call(this);
-            try {
-                const [firstQuoteRequest] = quoteRequests;
-                const unifiedSwapTraceName = (0, bridge_js_2.isCrossChain)(firstQuoteRequest.srcChainId, firstQuoteRequest.destChainId)
+            const [firstQuoteRequest] = quoteRequests;
+            let traceResult = 'error';
+            let traceName = traces_js_1.TraceName.BatchSellQuotesFetched;
+            if (!isBatchSellRequest) {
+                traceName = (0, bridge_js_2.isCrossChain)(firstQuoteRequest.srcChainId, firstQuoteRequest.destChainId)
                     ? traces_js_1.TraceName.BridgeQuotesFetched
                     : traces_js_1.TraceName.SwapQuotesFetched;
-                await __classPrivateFieldGet(this, _BridgeController_trace, "f").call(this, {
-                    name: isBatchSellRequest
-                        ? traces_js_1.TraceName.BatchSellQuotesFetched
-                        : unifiedSwapTraceName,
+            }
+            const tracedProviders = new Set();
+            const traceWithoutImpact = async (request) => {
+                try {
+                    await __classPrivateFieldGet(this, _BridgeController_trace, "f").call(this, request, () => undefined);
+                }
+                catch {
+                    // Telemetry failures must not affect quote fetching or state updates.
+                }
+            };
+            const traceProviderFirstResult = (providerData) => {
+                const provider = (0, properties_js_1.formatProviderLabel)(providerData);
+                if (isBatchSellRequest || tracedProviders.has(provider)) {
+                    return;
+                }
+                tracedProviders.add(provider);
+                // Provider telemetry must not delay quote processing.
+                // eslint-disable-next-line @typescript-eslint/no-floating-promises
+                traceWithoutImpact({
+                    name: traces_js_1.TraceName.QuoteProviderFirstResult,
+                    startTime: quoteTraceStartTime,
                     data: {
+                        provider,
+                        feature_id: context.feature_id,
+                        request_id: quoteTraceRequestId,
+                        swap_type: (0, properties_js_1.getSwapType)(firstQuoteRequest.srcChainId, firstQuoteRequest.destChainId),
                         srcChainId: (0, caip_formatters_js_1.formatChainIdToCaip)(firstQuoteRequest.srcChainId),
                         destChainId: (0, caip_formatters_js_1.formatChainIdToCaip)(firstQuoteRequest.destChainId),
+                        result: 'success',
                     },
-                }, async () => {
-                    const selectedAccount = __classPrivateFieldGet(this, _BridgeController_instances, "m", _BridgeController_getMultichainSelectedAccount).call(this, firstQuoteRequest.walletAddress);
-                    // This call is not awaited to prevent blocking quote fetching if the snap takes too long to respond
-                    // eslint-disable-next-line @typescript-eslint/no-floating-promises
-                    __classPrivateFieldGet(this, _BridgeController_setMinimumBalanceForRentExemptionInLamports, "f").call(this, firstQuoteRequest.srcChainId, selectedAccount?.metadata?.snap?.id);
-                    // Use SSE if enabled and return early
-                    if (shouldStream || isBatchSellRequest) {
-                        await __classPrivateFieldGet(this, _BridgeController_handleQuoteStreaming, "f").call(this, quoteRequests, context.feature_id, jwt, selectedAccount);
+                });
+            };
+            try {
+                const selectedAccount = __classPrivateFieldGet(this, _BridgeController_instances, "m", _BridgeController_getMultichainSelectedAccount).call(this, firstQuoteRequest.walletAddress);
+                // This call is not awaited to prevent blocking quote fetching if the snap takes too long to respond
+                // eslint-disable-next-line @typescript-eslint/no-floating-promises
+                __classPrivateFieldGet(this, _BridgeController_setMinimumBalanceForRentExemptionInLamports, "f").call(this, firstQuoteRequest.srcChainId, selectedAccount?.metadata?.snap?.id);
+                // Use SSE if enabled and return early
+                if (shouldStream || isBatchSellRequest) {
+                    const quoteCount = await __classPrivateFieldGet(this, _BridgeController_handleQuoteStreaming, "f").call(this, {
+                        quoteRequests,
+                        featureId: context.feature_id,
+                        jwt,
+                        selectedAccount,
+                        signal: quoteAbortSignal,
+                        traceProviderFirstResult,
+                    });
+                    if (quoteAbortSignal.aborted) {
+                        traceResult = 'cancelled';
                         return;
                     }
+                    traceResult = quoteCount > 0 ? 'success' : 'no_quotes';
+                }
+                else {
                     // Otherwise use regular fetch
-                    const quotes = await this.fetchQuotes(firstQuoteRequest, context.feature_id, __classPrivateFieldGet(this, _BridgeController_abortController, "f")?.signal);
+                    const quotes = await this.fetchQuotes(firstQuoteRequest, context.feature_id, quoteAbortSignal);
+                    for (const quote of quotes) {
+                        traceProviderFirstResult(quote.quote);
+                    }
                     this.update((state) => {
                         // Set the initial load time if this is the first fetch
                         if (state.quotesRefreshCount ===
                             bridge_js_1.DEFAULT_BRIDGE_CONTROLLER_STATE.quotesRefreshCount &&
                             __classPrivateFieldGet(this, _BridgeController_quotesFirstFetched, "f")) {
-                            state.quotesInitialLoadTime =
-                                Date.now() - __classPrivateFieldGet(this, _BridgeController_quotesFirstFetched, "f");
+                            state.quotesInitialLoadTime = Date.now() - __classPrivateFieldGet(this, _BridgeController_quotesFirstFetched, "f");
                         }
                         state.quotes = quotes.map(quote_response_v1_to_v2_js_1.toQuoteResponseV2);
                         state.quotesLoadingStatus = types_js_1.RequestStatus.FETCHED;
                     });
-                });
+                    traceResult = quotes.length > 0 ? 'success' : 'no_quotes';
+                }
             }
             catch (error) {
                 // Reset the quotes list if the fetch fails to avoid showing stale quotes
@@ -568,14 +625,8 @@ class BridgeController extends (0, polling_controller_1.StaticIntervalPollingCon
                     state.quotes = bridge_js_1.DEFAULT_BRIDGE_CONTROLLER_STATE.quotes;
                 });
                 // Ignore abort errors
-                if (error.toString().includes('AbortError') ||
-                    error.toString().includes('FetchRequestCanceledException') ||
-                    [
-                        constants_js_1.AbortReason.ResetState,
-                        constants_js_1.AbortReason.NewQuoteRequest,
-                        constants_js_1.AbortReason.QuoteRequestUpdated,
-                        constants_js_1.AbortReason.TransactionSubmitted,
-                    ].includes(error)) {
+                if (isExpectedQuoteAbort(error, quoteAbortSignal)) {
+                    traceResult = 'cancelled';
                     // Exit the function early to prevent other state updates
                     return;
                 }
@@ -600,6 +651,21 @@ class BridgeController extends (0, polling_controller_1.StaticIntervalPollingCon
                 this.trackUnifiedSwapBridgeEvent(constants_js_1.UnifiedSwapBridgeEventName.QuotesError, context);
                 console.log(`Failed to ${shouldStream ? 'stream' : 'fetch'} bridge quotes`, error);
             }
+            finally {
+                await traceWithoutImpact({
+                    name: traceName,
+                    startTime: quoteTraceStartTime,
+                    data: {
+                        srcChainId: (0, caip_formatters_js_1.formatChainIdToCaip)(firstQuoteRequest.srcChainId),
+                        destChainId: (0, caip_formatters_js_1.formatChainIdToCaip)(firstQuoteRequest.destChainId),
+                        ...(!isBatchSellRequest && {
+                            request_id: quoteTraceRequestId,
+                            feature_id: context.feature_id,
+                            result: traceResult,
+                        }),
+                    },
+                });
+            }
             // Update refresh count after fetching, validation and fee calculation have completed
             this.update((state) => {
                 state.quotesRefreshCount += 1;
@@ -614,7 +680,7 @@ class BridgeController extends (0, polling_controller_1.StaticIntervalPollingCon
                 this.stopAllPolling();
             }
         });
-        _BridgeController_handleQuoteStreaming.set(this, async (quoteRequests, featureId, jwt, selectedAccount) => {
+        _BridgeController_handleQuoteStreaming.set(this, async ({ quoteRequests, featureId, jwt, selectedAccount, signal, traceProviderFirstResult, }) => {
             /**
              * Tracks the number of valid quotes received from the current stream, which is used
              * to determine when to clear the quotes list and set the initial load time
@@ -625,13 +691,14 @@ class BridgeController extends (0, polling_controller_1.StaticIntervalPollingCon
              * before setting quotesLoadingStatus to FETCHED
              */
             const pendingFeeAppendPromises = new Set();
-            await (0, fetch_js_1.fetchBridgeQuoteStream)(__classPrivateFieldGet(this, _BridgeController_fetchFn, "f"), quoteRequests, __classPrivateFieldGet(this, _BridgeController_abortController, "f")?.signal, featureId, __classPrivateFieldGet(this, _BridgeController_clientId, "f"), jwt, __classPrivateFieldGet(this, _BridgeController_config, "f").customBridgeApiBaseUrl ?? bridge_js_1.BRIDGE_PROD_API_BASE_URL, {
+            await (0, fetch_js_1.fetchBridgeQuoteStream)(__classPrivateFieldGet(this, _BridgeController_fetchFn, "f"), quoteRequests, signal, featureId, __classPrivateFieldGet(this, _BridgeController_clientId, "f"), jwt, __classPrivateFieldGet(this, _BridgeController_config, "f").customBridgeApiBaseUrl ?? bridge_js_1.BRIDGE_PROD_API_BASE_URL, {
                 onQuoteValidationFailure: (validationFailures) => __classPrivateFieldGet(this, _BridgeController_trackQuoteValidationFailures, "f").call(this, validationFailures, featureId),
                 onValidQuoteReceived: async (quote) => {
                     const feeAppendPromise = (async () => {
                         const quotesWithFees = await (0, quote_fees_js_1.appendFeesToQuotes)(quote.chainId, [quote], this.messenger, __classPrivateFieldGet(this, _BridgeController_getLayer1GasFee, "f"), selectedAccount);
                         if (quotesWithFees.length > 0) {
                             validQuotesCounter += 1;
+                            traceProviderFirstResult(quote.quote);
                         }
                         this.update((state) => {
                             // Clear previous quotes and quotes load time when first quote in the current
@@ -691,6 +758,7 @@ class BridgeController extends (0, polling_controller_1.StaticIntervalPollingCon
                     });
                 },
             }, __classPrivateFieldGet(this, _BridgeController_clientVersion, "f"));
+            return validQuotesCounter;
         });
         _BridgeController_setMinimumBalanceForRentExemptionInLamports.set(this, async (srcChainId, snapId) => {
             if (!(0, bridge_js_2.isSolanaChainId)(srcChainId) || !snapId) {