@metamask-previews/bridge-status-controller 66.0.2-preview-254d7df → 66.0.2-preview-b32f1a3ca

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Added `location` property to `BridgeHistoryItem` to persist the entry point across the transaction lifecycle ([#7931](https://github.com/MetaMask/core/pull/7931))
+- Added `location` parameter to `StartPollingForBridgeTxStatusArgs` ([#7931](https://github.com/MetaMask/core/pull/7931))
+- Added optional `location` parameter to `submitTx` method ([#7931](https://github.com/MetaMask/core/pull/7931))
+
+### Changed
+
+- All post-submission events (`Submitted`, `Completed`, `Failed`, `PollingStatusUpdated`, `StatusValidationFailed`) now include the `location` property from `BridgeHistoryItem` ([#7931](https://github.com/MetaMask/core/pull/7931))
+
 ## [66.0.2]
 
 ### Changed

package/dist/bridge-status-controller.cjs

@@ -159,6 +159,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                             action_type: bridge_controller_1.MetricsActionType.SWAPBRIDGE_V1,
                             polling_status: bridge_controller_1.PollingStatus.ManuallyRestarted,
                             retry_attempts: previousAttempts,
+                            location: historyItem.location ?? bridge_controller_1.MetaMetricsSwapsEventSource.MainView,
                         });
                     }
                 }
@@ -207,7 +208,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
             });
         });
         _BridgeStatusController_addTxToHistory.set(this, (startPollingForBridgeTxStatusArgs, actionId) => {
-            const { bridgeTxMeta, statusRequest, quoteResponse, startTime, slippagePercentage, initialDestAssetBalance, targetContractAddress, approvalTxId, isStxEnabled, accountAddress: selectedAddress, } = startPollingForBridgeTxStatusArgs;
+            const { bridgeTxMeta, statusRequest, quoteResponse, startTime, slippagePercentage, initialDestAssetBalance, targetContractAddress, approvalTxId, isStxEnabled, location, accountAddress: selectedAddress, } = startPollingForBridgeTxStatusArgs;
             // Determine the key for this history item:
             // - For pre-submission (non-batch EVM): use actionId
             // - For post-submission or other cases: use bridgeTxMeta.id
@@ -247,6 +248,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 approvalTxId,
                 isStxEnabled: isStxEnabled ?? false,
                 featureId: quoteResponse.featureId,
+                location,
             };
             this.update((state) => {
                 // Use actionId as key for pre-submission, or txMeta.id for post-submission
@@ -355,6 +357,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                         action_type: bridge_controller_1.MetricsActionType.SWAPBRIDGE_V1,
                         polling_status: bridge_controller_1.PollingStatus.MaxPollingReached,
                         retry_attempts: newAttempts.counter,
+                        location: historyItem.location ?? bridge_controller_1.MetaMetricsSwapsEventSource.MainView,
                     });
                 }
             }
@@ -406,6 +409,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 if (validationFailures.length > 0) {
                     __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.StatusValidationFailed, bridgeTxMetaId, {
                         failures: validationFailures,
+                        location: historyItem.location ?? bridge_controller_1.MetaMetricsSwapsEventSource.MainView,
                     });
                     throw new Error(`Bridge status validation failed: ${validationFailures.join(', ')}`);
                 }
@@ -701,9 +705,10 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
          * @param quoteResponse - The quote response
          * @param isStxEnabledOnClient - Whether smart transactions are enabled on the client, for example the getSmartTransactionsEnabled selector value from the extension
          * @param quotesReceivedContext - The context for the QuotesReceived event
+         * @param location - The entry point from which the user initiated the swap or bridge (e.g. Main View, Token View, trending_explore)
          * @returns The transaction meta
          */
-        this.submitTx = async (accountAddress, quoteResponse, isStxEnabledOnClient, quotesReceivedContext) => {
+        this.submitTx = async (accountAddress, quoteResponse, isStxEnabledOnClient, quotesReceivedContext, location) => {
             this.messenger.call('BridgeController:stopPollingForQuotes', bridge_controller_1.AbortReason.TransactionSubmitted, 
             // If trade is submitted before all quotes are loaded, the QuotesReceived event is published
             // If the trade has a featureId, it means it was submitted outside of the Unified Swap and Bridge experience, so no QuotesReceived event is published
@@ -716,7 +721,10 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
             const preConfirmationProperties = (0, metrics_1.getPreConfirmationPropertiesFromQuote)(quoteResponse, isStxEnabledOnClient, isHardwareAccount);
             // Emit Submitted event after submit button is clicked
             !quoteResponse.featureId &&
-                __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Submitted, undefined, preConfirmationProperties);
+                __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Submitted, undefined, {
+                    ...preConfirmationProperties,
+                    location: location ?? bridge_controller_1.MetaMetricsSwapsEventSource.MainView,
+                });
             let txMeta;
             let approvalTxId;
             const startTime = Date.now();
@@ -746,6 +754,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                                 __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Failed, undefined, {
                                     error_message: error?.message,
                                     ...preConfirmationProperties,
+                                    location: location ?? bridge_controller_1.MetaMetricsSwapsEventSource.MainView,
                                 });
                             throw error;
                         }
@@ -776,6 +785,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                             __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Failed, txMeta?.id, {
                                 error_message: error?.message,
                                 ...preConfirmationProperties,
+                                location: location ?? bridge_controller_1.MetaMetricsSwapsEventSource.MainView,
                             });
                         throw error;
                     }
@@ -834,6 +844,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                         isStxEnabled: isStxEnabledOnClient,
                         startTime,
                         approvalTxId,
+                        location,
                     }, actionId);
                     // Pass txFee when gasIncluded is true to use the quote's gas fees
                     // instead of re-estimating (which would fail for max native token swaps)
@@ -873,6 +884,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                         isStxEnabled: isStxEnabledOnClient,
                         startTime,
                         approvalTxId,
+                        location,
                     });
                 }
                 if ((0, bridge_controller_1.isNonEvmChainId)(quoteResponse.quote.srcChainId)) {
@@ -897,10 +909,11 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
          * @param params.quoteResponse - Quote carrying intent data
          * @param params.signature - Hex signature produced by eth_signTypedData_v4
          * @param params.accountAddress - The EOA submitting the order
+         * @param params.location - The entry point from which the user initiated the swap or bridge
          * @returns A lightweight TransactionMeta-like object for history linking
          */
         this.submitIntent = async (params) => {
-            const { quoteResponse, signature, accountAddress } = params;
+            const { quoteResponse, signature, accountAddress, location } = params;
             this.messenger.call('BridgeController:stopPollingForQuotes', bridge_controller_1.AbortReason.TransactionSubmitted);
             // Build pre-confirmation properties for error tracking parity with submitTx
             const account = __classPrivateFieldGet(this, _BridgeStatusController_instances, "m", _BridgeStatusController_getMultichainSelectedAccount).call(this, accountAddress);
@@ -1000,6 +1013,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                         isStxEnabled: false,
                         approvalTxId,
                         startTime,
+                        location,
                     });
                     // Start polling using the orderId key to route to intent manager
                     __classPrivateFieldGet(this, _BridgeStatusController_startPollingForTxId, "f").call(this, bridgeHistoryKey);
@@ -1014,6 +1028,7 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Failed, undefined, {
                     error_message: error?.message,
                     ...preConfirmationProperties,
+                    location: location ?? bridge_controller_1.MetaMetricsSwapsEventSource.MainView,
                 });
                 throw error;
             }
@@ -1030,26 +1045,32 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 action_type: bridge_controller_1.MetricsActionType.SWAPBRIDGE_V1,
                 ...(eventProperties ?? {}),
             };
+            // The messenger.call for trackUnifiedSwapBridgeEvent is generic but TypeScript
+            // can't narrow EventName within this method's body, so we use `any` for the
+            // properties argument. The real type safety comes from the external call sites.
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const callTrack = (properties) => this.messenger.call('BridgeController:trackUnifiedSwapBridgeEvent', eventName, properties);
             // This will publish events for PERPS dropped tx failures as well
             if (!txMetaId) {
-                this.messenger.call('BridgeController:trackUnifiedSwapBridgeEvent', eventName, baseProperties);
+                callTrack(baseProperties);
                 return;
             }
             const historyItem = this.state.txHistory[txMetaId];
             if (!historyItem) {
-                this.messenger.call('BridgeController:trackUnifiedSwapBridgeEvent', eventName, eventProperties ?? {});
+                callTrack(eventProperties ?? {});
                 return;
             }
             const requestParamProperties = (0, metrics_1.getRequestParamFromHistory)(historyItem);
             // Always publish StatusValidationFailed event, regardless of featureId
             if (eventName === bridge_controller_1.UnifiedSwapBridgeEventName.StatusValidationFailed) {
-                this.messenger.call('BridgeController:trackUnifiedSwapBridgeEvent', eventName, {
+                callTrack({
                     ...baseProperties,
                     chain_id_source: requestParamProperties.chain_id_source,
                     chain_id_destination: requestParamProperties.chain_id_destination,
                     token_address_source: requestParamProperties.token_address_source,
                     token_address_destination: requestParamProperties.token_address_destination,
                     refresh_count: historyItem.attempts?.counter ?? 0,
+                    location: historyItem.location ?? bridge_controller_1.MetaMetricsSwapsEventSource.MainView,
                 });
                 return;
             }
@@ -1069,8 +1090,9 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                 ...(0, metrics_1.getTxStatusesFromHistory)(historyItem),
                 ...(0, metrics_1.getFinalizedTxProperties)(historyItem, txMeta, approvalTxMeta),
                 ...(0, metrics_1.getPriceImpactFromQuote)(historyItem.quote),
+                location: historyItem.location ?? bridge_controller_1.MetaMetricsSwapsEventSource.MainView,
             };
-            this.messenger.call('BridgeController:trackUnifiedSwapBridgeEvent', eventName, requiredEventProperties);
+            callTrack(requiredEventProperties);
         });
         __classPrivateFieldSet(this, _BridgeStatusController_clientId, clientId, "f");
         __classPrivateFieldSet(this, _BridgeStatusController_fetchFn, fetchFn, "f");
@@ -1122,7 +1144,11 @@ class BridgeStatusController extends (0, polling_controller_1.StaticIntervalPoll
                     else if (actionId && this.state.txHistory[actionId]) {
                         historyKey = actionId;
                     }
-                    __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Failed, historyKey ?? txMetaId, (0, metrics_1.getEVMTxPropertiesFromTransactionMeta)(transactionMeta));
+                    const historyLocation = this.state.txHistory[historyKey ?? txMetaId]?.location;
+                    __classPrivateFieldGet(this, _BridgeStatusController_trackUnifiedSwapBridgeEvent, "f").call(this, bridge_controller_1.UnifiedSwapBridgeEventName.Failed, historyKey ?? txMetaId, {
+                        ...(0, metrics_1.getEVMTxPropertiesFromTransactionMeta)(transactionMeta),
+                        location: historyLocation ?? bridge_controller_1.MetaMetricsSwapsEventSource.MainView,
+                    });
                 }
             }
         });