@metamask/assets-controller 3.1.1 → 3.2.0

package/CHANGELOG.md

@@ -7,6 +7,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.2.0]
+
+### Added
+
+- Add Sentry traces for Assets Health dashboard ([#8310](https://github.com/MetaMask/core/pull/8310))
+  - `AssetsDataSourceTiming` — per-source latency for each middleware in the fetch pipeline
+  - `AssetsDataSourceError` — tracks middleware failures with source names and error counts
+  - `AssetsFullFetch` — end-to-end fetch timing with asset/price/chain/account counts
+  - `AssetsUpdatePipeline` — enrichment pipeline timing for pushed data source updates
+  - `AssetsSubscriptionError` — subscription failure tracking per data source
+  - `AssetsStateSize` — entry counts for balances, metadata, prices, custom assets, unique assets, and network count (once on app start)
+  - `AggregatedBalanceSelector` — balance selector computation time with asset/network/account counts
+  - Add optional `trace` parameter to `getAggregatedBalanceForAccount` selector
+
+### Changed
+
+- Bump `@metamask/account-tree-controller` from `^5.0.1` to `^6.0.0` ([#8317](https://github.com/MetaMask/core/pull/8317))
+- Bump `@metamask/assets-controllers` from `^101.0.1` to `^102.0.0` ([#8317](https://github.com/MetaMask/core/pull/8317))
+- Bump `@metamask/base-controller` from `^9.0.0` to `^9.0.1` ([#8317](https://github.com/MetaMask/core/pull/8317))
+- Bump `@metamask/client-controller` from `^1.0.0` to `^1.0.1` ([#8317](https://github.com/MetaMask/core/pull/8317))
+- Bump `@metamask/core-backend` from `^6.2.0` to `^6.2.1` ([#8317](https://github.com/MetaMask/core/pull/8317))
+- Bump `@metamask/keyring-controller` from `^25.1.0` to `^25.1.1` ([#8317](https://github.com/MetaMask/core/pull/8317))
+- Bump `@metamask/messenger` from `^0.3.0` to `^1.0.0` ([#8317](https://github.com/MetaMask/core/pull/8317))
+- Bump `@metamask/network-controller` from `^30.0.0` to `^30.0.1` ([#8317](https://github.com/MetaMask/core/pull/8317))
+- Bump `@metamask/network-enablement-controller` from `^5.0.0` to `^5.0.1` ([#8317](https://github.com/MetaMask/core/pull/8317))
+- Bump `@metamask/permission-controller` from `^12.2.1` to `^12.3.0` ([#8317](https://github.com/MetaMask/core/pull/8317))
+- Bump `@metamask/polling-controller` from `^16.0.3` to `^16.0.4` ([#8317](https://github.com/MetaMask/core/pull/8317))
+- Bump `@metamask/preferences-controller` from `^23.0.0` to `^23.1.0` ([#8317](https://github.com/MetaMask/core/pull/8317))
+- Bump `@metamask/transaction-controller` from `^63.1.0` to `^63.3.1` ([#8301](https://github.com/MetaMask/core/pull/8301), [#8313](https://github.com/MetaMask/core/pull/8313), [#8317](https://github.com/MetaMask/core/pull/8317))
+
 ## [3.1.1]
 
 ### Fixed
@@ -208,7 +238,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Refactor `RpcDataSource` to delegate polling to `BalanceFetcher` and `TokenDetector` services ([#7709](https://github.com/MetaMask/core/pull/7709))
 - Refactor `BalanceFetcher` and `TokenDetector` to extend `StaticIntervalPollingControllerOnly` for independent polling management ([#7709](https://github.com/MetaMask/core/pull/7709))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/assets-controller@3.1.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/assets-controller@3.2.0...HEAD
+[3.2.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controller@3.1.1...@metamask/assets-controller@3.2.0
 [3.1.1]: https://github.com/MetaMask/core/compare/@metamask/assets-controller@3.1.0...@metamask/assets-controller@3.1.1
 [3.1.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controller@3.0.0...@metamask/assets-controller@3.1.0
 [3.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controller@2.4.0...@metamask/assets-controller@3.0.0

package/dist/AssetsController.cjs

@@ -13,7 +13,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _AssetsController_instances, _AssetsController_isEnabled, _AssetsController_isBasicFunctionality, _AssetsController_defaultUpdateInterval, _AssetsController_trace, _AssetsController_firstInitFetchReported, _AssetsController_uiOpen, _AssetsController_keyringUnlocked, _AssetsController_controllerMutex, _AssetsController_activeSubscriptions, _AssetsController_enabledChains, _AssetsController_selectedAccounts_get, _AssetsController_backendWebsocketDataSource, _AssetsController_accountsApiDataSource, _AssetsController_snapDataSource, _AssetsController_rpcDataSource, _AssetsController_stakedBalanceDataSource, _AssetsController_allBalanceDataSources_get, _AssetsController_priceDataSource, _AssetsController_detectionMiddleware, _AssetsController_tokenDataSource, _AssetsController_unsubscribeBasicFunctionality, _AssetsController_onActiveChainsUpdated, _AssetsController_initializeState, _AssetsController_extractEnabledChains, _AssetsController_normalizeChainReference, _AssetsController_subscribeToEvents, _AssetsController_updateActive, _AssetsController_registerActionHandlers, _AssetsController_handleActiveChainsUpdate, _AssetsController_executeMiddlewares, _AssetsController_resolveNativeAssetIds, _AssetsController_getNativeAssetIdsForEnabledChains, _AssetsController_getNativeAssetIdsForAccount, _AssetsController_ensureNativeBalancesDefaultZero, _AssetsController_updateState, _AssetsController_getAssetsFromState, _AssetsController_tokenStandardToAssetType, _AssetsController_start, _AssetsController_stop, _AssetsController_subscribeAssets, _AssetsController_subscribeAssetsBalance, _AssetsController_subscribeStakedBalance, _AssetsController_buildChainToAccountsMap, _AssetsController_subscribeDataSource, _AssetsController_unsubscribeDataSource, _AssetsController_buildDataRequest, _AssetsController_getEnabledChainsForAccount, _AssetsController_handleAccountGroupChanged, _AssetsController_handleEnabledNetworksChanged;
+var _AssetsController_instances, _AssetsController_isEnabled, _AssetsController_isBasicFunctionality, _AssetsController_defaultUpdateInterval, _AssetsController_trace, _AssetsController_firstInitFetchReported, _AssetsController_stateSizeReported, _AssetsController_emitTrace, _AssetsController_emitStateSizeTrace, _AssetsController_uiOpen, _AssetsController_keyringUnlocked, _AssetsController_controllerMutex, _AssetsController_activeSubscriptions, _AssetsController_enabledChains, _AssetsController_selectedAccounts_get, _AssetsController_backendWebsocketDataSource, _AssetsController_accountsApiDataSource, _AssetsController_snapDataSource, _AssetsController_rpcDataSource, _AssetsController_stakedBalanceDataSource, _AssetsController_allBalanceDataSources_get, _AssetsController_priceDataSource, _AssetsController_detectionMiddleware, _AssetsController_tokenDataSource, _AssetsController_unsubscribeBasicFunctionality, _AssetsController_onActiveChainsUpdated, _AssetsController_initializeState, _AssetsController_extractEnabledChains, _AssetsController_normalizeChainReference, _AssetsController_subscribeToEvents, _AssetsController_updateActive, _AssetsController_registerActionHandlers, _AssetsController_handleActiveChainsUpdate, _AssetsController_executeMiddlewares, _AssetsController_resolveNativeAssetIds, _AssetsController_getNativeAssetIdsForEnabledChains, _AssetsController_getNativeAssetIdsForAccount, _AssetsController_ensureNativeBalancesDefaultZero, _AssetsController_updateState, _AssetsController_getAssetsFromState, _AssetsController_tokenStandardToAssetType, _AssetsController_start, _AssetsController_stop, _AssetsController_subscribeAssets, _AssetsController_subscribeAssetsBalance, _AssetsController_subscribeStakedBalance, _AssetsController_buildChainToAccountsMap, _AssetsController_subscribeDataSource, _AssetsController_unsubscribeDataSource, _AssetsController_buildDataRequest, _AssetsController_getEnabledChainsForAccount, _AssetsController_handleAccountGroupChanged, _AssetsController_handleEnabledNetworksChanged;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetsController = exports.getDefaultAssetsControllerState = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -53,6 +53,16 @@ const MESSENGER_EXPOSED_METHODS = [
 ];
 /** Default polling interval hint for data sources (30 seconds) */
 const DEFAULT_POLLING_INTERVAL_MS = 30000;
+// ============================================================================
+// TRACE NAMES — used in Sentry spans (search these strings in Discover)
+// ============================================================================
+const TRACE_FIRST_INIT_FETCH = 'AssetsControllerFirstInitFetch';
+const TRACE_FULL_FETCH = 'AssetsFullFetch';
+const TRACE_DATA_SOURCE_TIMING = 'AssetsDataSourceTiming';
+const TRACE_DATA_SOURCE_ERROR = 'AssetsDataSourceError';
+const TRACE_UPDATE_PIPELINE = 'AssetsUpdatePipeline';
+const TRACE_SUBSCRIPTION_ERROR = 'AssetsSubscriptionError';
+const TRACE_STATE_SIZE = 'AssetsStateSize';
 const log = (0, logger_1.createModuleLogger)(logger_1.projectLogger, CONTROLLER_NAME);
 /**
  * Returns the default state for AssetsController.
@@ -220,6 +230,8 @@ class AssetsController extends base_controller_1.BaseController {
         _AssetsController_trace.set(this, void 0);
         /** Whether we have already reported first init fetch for this session (reset on #stop). */
         _AssetsController_firstInitFetchReported.set(this, false);
+        /** Whether we have already reported state size for this session (reset on #stop). */
+        _AssetsController_stateSizeReported.set(this, false);
         /** Whether the client (UI) is open. Combined with #keyringUnlocked for #updateActive. */
         _AssetsController_uiOpen.set(this, false);
         /** Whether the keyring is unlocked. Combined with #uiOpen for #updateActive. */
@@ -335,7 +347,7 @@ class AssetsController extends base_controller_1.BaseController {
             customAssets.push(...accountCustomAssets);
         }
         if (options?.forceUpdate) {
-            const startTime = Date.now();
+            const startTime = performance.now();
             const request = __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_buildDataRequest).call(this, accounts, chainIds, {
                 assetTypes,
                 dataTypes,
@@ -369,23 +381,28 @@ class AssetsController extends base_controller_1.BaseController {
                 options.chainIds.length < __classPrivateFieldGet(this, _AssetsController_enabledChains, "f").size;
             const updateMode = options?.updateMode ?? (isPartialChainFetch ? 'merge' : 'full');
             await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...response, updateMode });
-            if (__classPrivateFieldGet(this, _AssetsController_trace, "f") && !__classPrivateFieldGet(this, _AssetsController_firstInitFetchReported, "f")) {
+            const durationMs = performance.now() - startTime;
+            // Emit trace for every full fetch (Assets Health dashboard)
+            __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_FULL_FETCH, {
+                duration_ms: durationMs,
+                chain_count: chainIds.length,
+                account_count: accounts.length,
+                basic_functionality: __classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this),
+                asset_count: response.assetsBalance
+                    ? Object.values(response.assetsBalance).reduce((sum, acct) => sum + Object.keys(acct).length, 0)
+                    : 0,
+                price_count: response.assetsPrice
+                    ? Object.keys(response.assetsPrice).length
+                    : 0,
+                ...durationByDataSource,
+            });
+            if (!__classPrivateFieldGet(this, _AssetsController_firstInitFetchReported, "f")) {
                 __classPrivateFieldSet(this, _AssetsController_firstInitFetchReported, true, "f");
-                const durationMs = Date.now() - startTime;
-                try {
-                    await __classPrivateFieldGet(this, _AssetsController_trace, "f").call(this, {
-                        name: 'AssetsController First Init Fetch',
-                        data: {
-                            duration_ms: durationMs,
-                            chain_ids: JSON.stringify(chainIds),
-                            ...durationByDataSource,
-                        },
-                        tags: { controller: 'AssetsController' },
-                    }, () => undefined);
-                }
-                catch {
-                    // Telemetry failure must not break.
-                }
+                __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_FIRST_INIT_FETCH, {
+                    duration_ms: durationMs,
+                    chain_ids: JSON.stringify(chainIds),
+                    ...durationByDataSource,
+                });
             }
         }
         const result = __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_getAssetsFromState).call(this, accounts, chainIds, assetTypes);
@@ -711,6 +728,7 @@ class AssetsController extends base_controller_1.BaseController {
      * @param request - Optional original request for context when enriching
      */
     async handleAssetsUpdate(response, sourceId, request) {
+        const updateStart = performance.now();
         log('Assets updated from data source', {
             sourceId,
             hasBalance: Boolean(response.assetsBalance),
@@ -730,6 +748,16 @@ class AssetsController extends base_controller_1.BaseController {
             dataTypes: ['balance', 'metadata', 'price'],
         }, response);
         await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, enrichedResponse);
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_UPDATE_PIPELINE, {
+            source: sourceId,
+            duration_ms: performance.now() - updateStart,
+            has_balance: Boolean(response.assetsBalance),
+            has_price: Boolean(response.assetsPrice),
+            has_metadata: Boolean(enrichedResponse.assetsInfo),
+            balance_account_count: response.assetsBalance
+                ? Object.keys(response.assetsBalance).length
+                : 0,
+        });
     }
     // ============================================================================
     // CLEANUP
@@ -766,7 +794,53 @@ class AssetsController extends base_controller_1.BaseController {
     }
 }
 exports.AssetsController = AssetsController;
-_AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctionality = new WeakMap(), _AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_trace = new WeakMap(), _AssetsController_firstInitFetchReported = new WeakMap(), _AssetsController_uiOpen = new WeakMap(), _AssetsController_keyringUnlocked = new WeakMap(), _AssetsController_controllerMutex = new WeakMap(), _AssetsController_activeSubscriptions = new WeakMap(), _AssetsController_enabledChains = new WeakMap(), _AssetsController_backendWebsocketDataSource = new WeakMap(), _AssetsController_accountsApiDataSource = new WeakMap(), _AssetsController_snapDataSource = new WeakMap(), _AssetsController_rpcDataSource = new WeakMap(), _AssetsController_stakedBalanceDataSource = new WeakMap(), _AssetsController_priceDataSource = new WeakMap(), _AssetsController_detectionMiddleware = new WeakMap(), _AssetsController_tokenDataSource = new WeakMap(), _AssetsController_unsubscribeBasicFunctionality = new WeakMap(), _AssetsController_onActiveChainsUpdated = new WeakMap(), _AssetsController_instances = new WeakSet(), _AssetsController_selectedAccounts_get = function _AssetsController_selectedAccounts_get() {
+_AssetsController_isEnabled = new WeakMap(), _AssetsController_isBasicFunctionality = new WeakMap(), _AssetsController_defaultUpdateInterval = new WeakMap(), _AssetsController_trace = new WeakMap(), _AssetsController_firstInitFetchReported = new WeakMap(), _AssetsController_stateSizeReported = new WeakMap(), _AssetsController_uiOpen = new WeakMap(), _AssetsController_keyringUnlocked = new WeakMap(), _AssetsController_controllerMutex = new WeakMap(), _AssetsController_activeSubscriptions = new WeakMap(), _AssetsController_enabledChains = new WeakMap(), _AssetsController_backendWebsocketDataSource = new WeakMap(), _AssetsController_accountsApiDataSource = new WeakMap(), _AssetsController_snapDataSource = new WeakMap(), _AssetsController_rpcDataSource = new WeakMap(), _AssetsController_stakedBalanceDataSource = new WeakMap(), _AssetsController_priceDataSource = new WeakMap(), _AssetsController_detectionMiddleware = new WeakMap(), _AssetsController_tokenDataSource = new WeakMap(), _AssetsController_unsubscribeBasicFunctionality = new WeakMap(), _AssetsController_onActiveChainsUpdated = new WeakMap(), _AssetsController_instances = new WeakSet(), _AssetsController_emitTrace = function _AssetsController_emitTrace(name, data, tags = {
+    controller: 'AssetsController',
+}) {
+    if (!__classPrivateFieldGet(this, _AssetsController_trace, "f")) {
+        return;
+    }
+    __classPrivateFieldGet(this, _AssetsController_trace, "f").call(this, { name, data, tags }, () => undefined).catch(() => {
+        // Telemetry failure must not break.
+    });
+}, _AssetsController_emitStateSizeTrace = function _AssetsController_emitStateSizeTrace() {
+    if (!__classPrivateFieldGet(this, _AssetsController_trace, "f") || __classPrivateFieldGet(this, _AssetsController_stateSizeReported, "f")) {
+        return;
+    }
+    __classPrivateFieldSet(this, _AssetsController_stateSizeReported, true, "f");
+    const { assetsBalance: balances, customAssets, assetsInfo, assetsPrice, } = this.state;
+    // Count balance entries and collect unique asset IDs / chain IDs in one pass.
+    let balanceEntries = 0;
+    const uniqueAssets = new Set();
+    const uniqueNetworks = new Set();
+    for (const acct of Object.values(balances)) {
+        const assetIds = Object.keys(acct);
+        balanceEntries += assetIds.length;
+        for (const assetId of assetIds) {
+            uniqueAssets.add(assetId);
+            // CAIP-19 format: "eip155:1/slip44:60" — chainId is everything before "/"
+            const slash = assetId.indexOf('/');
+            if (slash > 0) {
+                uniqueNetworks.add(assetId.slice(0, slash));
+            }
+        }
+    }
+    let customAssetEntries = 0;
+    for (const ids of Object.values(customAssets)) {
+        if (Array.isArray(ids)) {
+            customAssetEntries += ids.length;
+        }
+    }
+    __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_STATE_SIZE, {
+        balance_entries: balanceEntries,
+        balance_accounts: Object.keys(balances).length,
+        unique_asset_count: uniqueAssets.size,
+        network_count: uniqueNetworks.size,
+        metadata_entries: Object.keys(assetsInfo).length,
+        price_entries: Object.keys(assetsPrice).length,
+        custom_asset_entries: customAssetEntries,
+    });
+}, _AssetsController_selectedAccounts_get = function _AssetsController_selectedAccounts_get() {
     return this.messenger.call('AccountTreeController:getAccountsFromSelectedAccountGroup');
 }, _AssetsController_allBalanceDataSources_get = function _AssetsController_allBalanceDataSources_get() {
     return [
@@ -888,19 +962,22 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
     const middlewares = sources.map((source) => source.assetsMiddleware);
     const inclusive = [];
     const wrapped = middlewares.map((middleware, i) => (async (ctx, next) => {
-        const start = Date.now();
+        const start = performance.now();
         try {
             return await middleware(ctx, next);
         }
         finally {
-            inclusive[i] = Date.now() - start;
+            inclusive[i] = performance.now() - start;
         }
     }));
-    const chain = wrapped.reduceRight((next, middleware) => async (ctx) => {
+    const middlewareErrors = [];
+    const chain = wrapped.reduceRight((next, middleware, index) => async (ctx) => {
         try {
             return await middleware(ctx, next);
         }
         catch (error) {
+            const sourceName = names[index] ?? `middleware_${index}`;
+            middlewareErrors.push(sourceName);
             console.error('[AssetsController] Middleware failed:', error);
             return next(ctx);
         }
@@ -924,6 +1001,23 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
             durationByDataSource[key] = ms;
         }
     }
+    // Emit per-source timing traces for the Assets Health dashboard
+    for (const [sourceName, durationMs] of Object.entries(durationByDataSource)) {
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_DATA_SOURCE_TIMING, {
+            source: sourceName,
+            duration_ms: durationMs,
+            chain_count: request.chainIds.length,
+            account_count: request.accountsWithSupportedChains.length,
+        });
+    }
+    // Emit error traces for failed middlewares
+    if (middlewareErrors.length > 0) {
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_DATA_SOURCE_ERROR, {
+            failed_sources: middlewareErrors.join(','),
+            error_count: middlewareErrors.length,
+            chain_count: request.chainIds.length,
+        });
+    }
     return { response: result.response, durationByDataSource };
 }, _AssetsController_resolveNativeAssetIds = function _AssetsController_resolveNativeAssetIds(chains) {
     const { nativeAssetIdentifiers } = this.messenger.call('NetworkEnablementController:getState');
@@ -1064,6 +1158,8 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
                 }
             }
         });
+        // Emit state size trace (throttled to avoid JSON.stringify on every update)
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitStateSizeTrace).call(this);
         // Calculate changed prices
         const changedPriceAssets = normalizedResponse.assetsPrice
             ? Object.keys(normalizedResponse.assetsPrice).filter((assetId) => !(0, lodash_1.isEqual)(previousPrices[assetId], normalizedResponse.assetsPrice?.[assetId]))
@@ -1211,6 +1307,7 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
         hasPriceSubscription: __classPrivateFieldGet(this, _AssetsController_activeSubscriptions, "f").has('ds:PriceDataSource'),
     });
     __classPrivateFieldSet(this, _AssetsController_firstInitFetchReported, false, "f");
+    __classPrivateFieldSet(this, _AssetsController_stateSizeReported, false, "f");
     // Stop price subscription first (uses direct messenger call)
     this.unsubscribeAssetsPrice();
     // Stop balance subscriptions by properly notifying data sources via messenger
@@ -1327,6 +1424,10 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
     };
     source.subscribe(subscribeReq).catch((error) => {
         console.error(`[AssetsController] Failed to subscribe to '${sourceId}':`, error);
+        __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_SUBSCRIPTION_ERROR, {
+            source: sourceId,
+            error_message: String(error),
+        });
     });
     // Track subscription
     const subscription = {