@metamask-previews/assets-controller 3.1.1-preview-27e0999e0 → 3.1.1-preview-55f19615e

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ### Added
11
+
12
+ - Add Sentry traces for Assets Health dashboard ([#8310](https://github.com/MetaMask/core/pull/8310))
13
+ - `Assets Data Source Timing` — per-source latency for each middleware in the fetch pipeline
14
+ - `Assets Data Source Error` — tracks middleware failures with source names and error counts
15
+ - `Assets Full Fetch` — end-to-end fetch timing with asset/price/chain/account counts
16
+ - `Assets Update Pipeline` — enrichment pipeline timing for pushed data source updates
17
+ - `Assets Subscription Error` — subscription failure tracking per data source
18
+ - `Assets State Size` — entry counts for balances, metadata, prices, and custom assets (once on app start)
19
+ - `Aggregated Balance Selector` — balance selector computation time with asset/network/account counts
20
+ - Add optional `trace` parameter to `getAggregatedBalanceForAccount` selector
21
+
10
22
  ### Changed
11
23
 
12
24
  - Bump `@metamask/transaction-controller` from `^63.1.0` to `^63.2.0` ([#8301](https://github.com/MetaMask/core/pull/8301))
@@ -13,7 +13,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
13
13
  var __importDefault = (this && this.__importDefault) || function (mod) {
14
14
  return (mod && mod.__esModule) ? mod : { "default": mod };
15
15
  };
16
- 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;
16
+ 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;
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
18
  exports.AssetsController = exports.getDefaultAssetsControllerState = void 0;
19
19
  const base_controller_1 = require("@metamask/base-controller");
@@ -53,6 +53,16 @@ const MESSENGER_EXPOSED_METHODS = [
53
53
  ];
54
54
  /** Default polling interval hint for data sources (30 seconds) */
55
55
  const DEFAULT_POLLING_INTERVAL_MS = 30000;
56
+ // ============================================================================
57
+ // TRACE NAMES — used in Sentry spans (search these strings in Discover)
58
+ // ============================================================================
59
+ const TRACE_FIRST_INIT_FETCH = 'AssetsController First Init Fetch';
60
+ const TRACE_FULL_FETCH = 'Assets Full Fetch';
61
+ const TRACE_DATA_SOURCE_TIMING = 'Assets Data Source Timing';
62
+ const TRACE_DATA_SOURCE_ERROR = 'Assets Data Source Error';
63
+ const TRACE_UPDATE_PIPELINE = 'Assets Update Pipeline';
64
+ const TRACE_SUBSCRIPTION_ERROR = 'Assets Subscription Error';
65
+ const TRACE_STATE_SIZE = 'Assets State Size';
56
66
  const log = (0, logger_1.createModuleLogger)(logger_1.projectLogger, CONTROLLER_NAME);
57
67
  /**
58
68
  * Returns the default state for AssetsController.
@@ -220,6 +230,8 @@ class AssetsController extends base_controller_1.BaseController {
220
230
  _AssetsController_trace.set(this, void 0);
221
231
  /** Whether we have already reported first init fetch for this session (reset on #stop). */
222
232
  _AssetsController_firstInitFetchReported.set(this, false);
233
+ /** Whether we have already reported state size for this session (reset on #stop). */
234
+ _AssetsController_stateSizeReported.set(this, false);
223
235
  /** Whether the client (UI) is open. Combined with #keyringUnlocked for #updateActive. */
224
236
  _AssetsController_uiOpen.set(this, false);
225
237
  /** Whether the keyring is unlocked. Combined with #uiOpen for #updateActive. */
@@ -369,23 +381,28 @@ class AssetsController extends base_controller_1.BaseController {
369
381
  options.chainIds.length < __classPrivateFieldGet(this, _AssetsController_enabledChains, "f").size;
370
382
  const updateMode = options?.updateMode ?? (isPartialChainFetch ? 'merge' : 'full');
371
383
  await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, { ...response, updateMode });
372
- if (__classPrivateFieldGet(this, _AssetsController_trace, "f") && !__classPrivateFieldGet(this, _AssetsController_firstInitFetchReported, "f")) {
384
+ const durationMs = Date.now() - startTime;
385
+ // Emit trace for every full fetch (Assets Health dashboard)
386
+ __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_FULL_FETCH, {
387
+ duration_ms: durationMs,
388
+ chain_count: chainIds.length,
389
+ account_count: accounts.length,
390
+ basic_functionality: __classPrivateFieldGet(this, _AssetsController_isBasicFunctionality, "f").call(this),
391
+ asset_count: response.assetsBalance
392
+ ? Object.values(response.assetsBalance).reduce((sum, acct) => sum + Object.keys(acct).length, 0)
393
+ : 0,
394
+ price_count: response.assetsPrice
395
+ ? Object.keys(response.assetsPrice).length
396
+ : 0,
397
+ ...durationByDataSource,
398
+ });
399
+ if (!__classPrivateFieldGet(this, _AssetsController_firstInitFetchReported, "f")) {
373
400
  __classPrivateFieldSet(this, _AssetsController_firstInitFetchReported, true, "f");
374
- const durationMs = Date.now() - startTime;
375
- try {
376
- await __classPrivateFieldGet(this, _AssetsController_trace, "f").call(this, {
377
- name: 'AssetsController First Init Fetch',
378
- data: {
379
- duration_ms: durationMs,
380
- chain_ids: JSON.stringify(chainIds),
381
- ...durationByDataSource,
382
- },
383
- tags: { controller: 'AssetsController' },
384
- }, () => undefined);
385
- }
386
- catch {
387
- // Telemetry failure must not break.
388
- }
401
+ __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_FIRST_INIT_FETCH, {
402
+ duration_ms: durationMs,
403
+ chain_ids: JSON.stringify(chainIds),
404
+ ...durationByDataSource,
405
+ });
389
406
  }
390
407
  }
391
408
  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 {
711
728
  * @param request - Optional original request for context when enriching
712
729
  */
713
730
  async handleAssetsUpdate(response, sourceId, request) {
731
+ const updateStart = Date.now();
714
732
  log('Assets updated from data source', {
715
733
  sourceId,
716
734
  hasBalance: Boolean(response.assetsBalance),
@@ -730,6 +748,16 @@ class AssetsController extends base_controller_1.BaseController {
730
748
  dataTypes: ['balance', 'metadata', 'price'],
731
749
  }, response);
732
750
  await __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_updateState).call(this, enrichedResponse);
751
+ __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_UPDATE_PIPELINE, {
752
+ source: sourceId,
753
+ duration_ms: Date.now() - updateStart,
754
+ has_balance: Boolean(response.assetsBalance),
755
+ has_price: Boolean(response.assetsPrice),
756
+ has_metadata: Boolean(enrichedResponse.assetsInfo),
757
+ balance_account_count: response.assetsBalance
758
+ ? Object.keys(response.assetsBalance).length
759
+ : 0,
760
+ });
733
761
  }
734
762
  // ============================================================================
735
763
  // CLEANUP
@@ -766,7 +794,44 @@ class AssetsController extends base_controller_1.BaseController {
766
794
  }
767
795
  }
768
796
  exports.AssetsController = AssetsController;
769
- _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() {
797
+ _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 = {
798
+ controller: 'AssetsController',
799
+ }) {
800
+ if (!__classPrivateFieldGet(this, _AssetsController_trace, "f")) {
801
+ return;
802
+ }
803
+ try {
804
+ __classPrivateFieldGet(this, _AssetsController_trace, "f").call(this, { name, data, tags }, () => undefined).catch(() => {
805
+ // Telemetry failure must not break.
806
+ });
807
+ }
808
+ catch {
809
+ // Telemetry failure must not break.
810
+ }
811
+ }, _AssetsController_emitStateSizeTrace = function _AssetsController_emitStateSizeTrace() {
812
+ if (!__classPrivateFieldGet(this, _AssetsController_trace, "f") || __classPrivateFieldGet(this, _AssetsController_stateSizeReported, "f")) {
813
+ return;
814
+ }
815
+ __classPrivateFieldSet(this, _AssetsController_stateSizeReported, true, "f");
816
+ const { assetsBalance: balances, customAssets, assetsInfo, assetsPrice, } = this.state;
817
+ let balanceEntries = 0;
818
+ for (const acct of Object.values(balances)) {
819
+ balanceEntries += Object.keys(acct).length;
820
+ }
821
+ let customAssetEntries = 0;
822
+ for (const ids of Object.values(customAssets)) {
823
+ if (Array.isArray(ids)) {
824
+ customAssetEntries += ids.length;
825
+ }
826
+ }
827
+ __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_STATE_SIZE, {
828
+ balance_entries: balanceEntries,
829
+ balance_accounts: Object.keys(balances).length,
830
+ metadata_entries: Object.keys(assetsInfo).length,
831
+ price_entries: Object.keys(assetsPrice).length,
832
+ custom_asset_entries: customAssetEntries,
833
+ });
834
+ }, _AssetsController_selectedAccounts_get = function _AssetsController_selectedAccounts_get() {
770
835
  return this.messenger.call('AccountTreeController:getAccountsFromSelectedAccountGroup');
771
836
  }, _AssetsController_allBalanceDataSources_get = function _AssetsController_allBalanceDataSources_get() {
772
837
  return [
@@ -896,11 +961,14 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
896
961
  inclusive[i] = Date.now() - start;
897
962
  }
898
963
  }));
899
- const chain = wrapped.reduceRight((next, middleware) => async (ctx) => {
964
+ const middlewareErrors = [];
965
+ const chain = wrapped.reduceRight((next, middleware, index) => async (ctx) => {
900
966
  try {
901
967
  return await middleware(ctx, next);
902
968
  }
903
969
  catch (error) {
970
+ const sourceName = names[index] ?? `middleware_${index}`;
971
+ middlewareErrors.push(sourceName);
904
972
  console.error('[AssetsController] Middleware failed:', error);
905
973
  return next(ctx);
906
974
  }
@@ -924,6 +992,23 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
924
992
  durationByDataSource[key] = ms;
925
993
  }
926
994
  }
995
+ // Emit per-source timing traces for the Assets Health dashboard
996
+ for (const [sourceName, durationMs] of Object.entries(durationByDataSource)) {
997
+ __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_DATA_SOURCE_TIMING, {
998
+ source: sourceName,
999
+ duration_ms: durationMs,
1000
+ chain_count: request.chainIds.length,
1001
+ account_count: request.accountsWithSupportedChains.length,
1002
+ });
1003
+ }
1004
+ // Emit error traces for failed middlewares
1005
+ if (middlewareErrors.length > 0) {
1006
+ __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_DATA_SOURCE_ERROR, {
1007
+ failed_sources: middlewareErrors.join(','),
1008
+ error_count: middlewareErrors.length,
1009
+ chain_count: request.chainIds.length,
1010
+ });
1011
+ }
927
1012
  return { response: result.response, durationByDataSource };
928
1013
  }, _AssetsController_resolveNativeAssetIds = function _AssetsController_resolveNativeAssetIds(chains) {
929
1014
  const { nativeAssetIdentifiers } = this.messenger.call('NetworkEnablementController:getState');
@@ -1064,6 +1149,8 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
1064
1149
  }
1065
1150
  }
1066
1151
  });
1152
+ // Emit state size trace (throttled to avoid JSON.stringify on every update)
1153
+ __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitStateSizeTrace).call(this);
1067
1154
  // Calculate changed prices
1068
1155
  const changedPriceAssets = normalizedResponse.assetsPrice
1069
1156
  ? Object.keys(normalizedResponse.assetsPrice).filter((assetId) => !(0, lodash_1.isEqual)(previousPrices[assetId], normalizedResponse.assetsPrice?.[assetId]))
@@ -1211,6 +1298,7 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
1211
1298
  hasPriceSubscription: __classPrivateFieldGet(this, _AssetsController_activeSubscriptions, "f").has('ds:PriceDataSource'),
1212
1299
  });
1213
1300
  __classPrivateFieldSet(this, _AssetsController_firstInitFetchReported, false, "f");
1301
+ __classPrivateFieldSet(this, _AssetsController_stateSizeReported, false, "f");
1214
1302
  // Stop price subscription first (uses direct messenger call)
1215
1303
  this.unsubscribeAssetsPrice();
1216
1304
  // Stop balance subscriptions by properly notifying data sources via messenger
@@ -1327,6 +1415,10 @@ async function _AssetsController_executeMiddlewares(sources, request, initialRes
1327
1415
  };
1328
1416
  source.subscribe(subscribeReq).catch((error) => {
1329
1417
  console.error(`[AssetsController] Failed to subscribe to '${sourceId}':`, error);
1418
+ __classPrivateFieldGet(this, _AssetsController_instances, "m", _AssetsController_emitTrace).call(this, TRACE_SUBSCRIPTION_ERROR, {
1419
+ source: sourceId,
1420
+ error_message: String(error),
1421
+ });
1330
1422
  });
1331
1423
  // Track subscription
1332
1424
  const subscription = {