feat: Add more state props from controllers to Sentry mask (#20595)

* feat: update sentry mask adding  controller props to improve error monitoring

* fix:remove changes in chrome-driver dependency

* Remove properties from mask

* Add more values to mask

* Sort the mask alphabetically

* Add termsOfUseLastAgreed to mask

* Fix test imports

* Update policy gap test to compare UI mask

* Reorganize tests under one describe block

* Update snapshots

* Mask another timestamp in state snapshots

* Mask browser environment properties

* Add missing UI field mask, and refactor field masking/removal

* Eliminate remaining policy gaps

* Simplify ganache options

* Eliminate extra mask properties

* Update mask to capture dynamic keys

The mask now supports dynamic keys. This lets set more fine-grained rules
for which data to include within dynamic data structures.

The mask has been updated to include just top-level keys for various
token-related data collections in state. This lets us see the chain IDs
that users have tokens on. This will be useful in debugging Sentry
reports of invalid keys in these data structures.

* Add additional 'expected missing state' entries

* Remove unnecessary properties from state snapshot

* Add providerConfig.chainId to state snapshot

* Update error state snapshots

---------

Co-authored-by: Danica Shen <zhaodanica@gmail.com>
Co-authored-by: Mark Stacey <markjstacey@gmail.com>

app/scripts/lib/setupSentry.js

@@ -1,6 +1,7 @@
 import * as Sentry from '@sentry/browser';
 import { Dedupe, ExtraErrorData } from '@sentry/integrations';
 
+import { AllProperties } from '../../../shared/modules/object.utils';
 import { FilterEvents } from './sentry-filter-events';
 import extractEthjsErrorMessage from './extractEthjsErrorMessage';
 
@@ -28,72 +29,269 @@ export const ERROR_URL_ALLOWLIST = {
 // debugging, and they do not contain any identifiable information.
 export const SENTRY_BACKGROUND_STATE = {
   AccountTracker: {
+    accounts: false,
     currentBlockGasLimit: true,
   },
+  AddressBookController: {
+    addressBook: false,
+  },
   AlertController: {
     alertEnabledness: true,
+    unconnectedAccountAlertShownOrigins: false,
+    web3ShimUsageOrigins: false,
+  },
+  AnnouncementController: {
+    announcements: false,
   },
   AppMetadataController: {
     currentAppVersion: true,
+    currentMigrationVersion: true,
     previousAppVersion: true,
     previousMigrationVersion: true,
-    currentMigrationVersion: true,
+  },
+  ApprovalController: {
+    approvalFlows: false,
+    pendingApprovals: false,
+    pendingApprovalCount: false,
   },
   AppStateController: {
+    browserEnvironment: true,
     connectedStatusPopoverHasBeenShown: true,
+    currentPopupId: false,
     defaultHomeActiveTabName: true,
+    fullScreenGasPollTokens: true,
+    hadAdvancedGasFeesSetPriorToMigration92_3: true,
+    nftsDetectionNoticeDismissed: true,
+    nftsDropdownState: true,
+    notificationGasPollTokens: true,
+    outdatedBrowserWarningLastShown: true,
+    popupGasPollTokens: true,
+    qrHardware: true,
+    recoveryPhraseReminderHasBeenShown: true,
+    recoveryPhraseReminderLastShown: true,
+    serviceWorkerLastActiveTime: true,
+    showBetaHeader: true,
+    showProductTour: true,
+    showTestnetMessageInDropdown: true,
+    snapsInstallPrivacyWarningShown: true,
+    termsOfUseLastAgreed: true,
+    timeoutMinutes: true,
+    trezorModel: true,
+    usedNetworks: true,
+  },
+  CachedBalancesController: {
+    cachedBalances: false,
+  },
+  CronjobController: {
+    jobs: false,
   },
   CurrencyController: {
     conversionDate: true,
     conversionRate: true,
     currentCurrency: true,
     nativeCurrency: true,
+    pendingCurrentCurrency: true,
+    pendingNativeCurrency: true,
+    usdConversionRate: true,
   },
   DecryptMessageController: {
+    unapprovedDecryptMsgs: false,
     unapprovedDecryptMsgCount: true,
   },
-  DesktopController: {
-    desktopEnabled: true,
-  },
   EncryptionPublicKeyController: {
+    unapprovedEncryptionPublicKeyMsgs: false,
     unapprovedEncryptionPublicKeyMsgCount: true,
   },
+  EnsController: {
+    ensResolutionsByAddress: false,
+  },
+  GasFeeController: {
+    estimatedGasFeeTimeBounds: true,
+    gasEstimateType: true,
+    gasFeeEstimates: true,
+  },
   KeyringController: {
     isUnlocked: true,
+    keyrings: false,
+    keyringTypes: false,
   },
   MetaMetricsController: {
+    eventsBeforeMetricsOptIn: false,
+    fragments: false,
     metaMetricsId: true,
     participateInMetaMetrics: true,
+    previousUserTraits: false,
+    segmentApiCalls: false,
+    traits: false,
   },
   NetworkController: {
+    networkConfigurations: false,
     networkId: true,
-    networkStatus: true,
+    networksMetadata: true,
     providerConfig: {
+      chainId: true,
+      id: true,
       nickname: true,
+      rpcPrefs: false,
+      rpcUrl: false,
       ticker: true,
       type: true,
     },
+    selectedNetworkClientId: false,
+  },
+  NftController: {
+    allNftContracts: false,
+    allNfts: false,
+    ignoredNfts: false,
+  },
+  NotificationController: {
+    notifications: false,
   },
   OnboardingController: {
     completedOnboarding: true,
     firstTimeFlowType: true,
+    onboardingTabs: false,
     seedPhraseBackedUp: true,
   },
+  PermissionController: {
+    subjects: false,
+  },
+  PermissionLogController: {
+    permissionActivityLog: false,
+    permissionHistory: false,
+  },
+  PhishingController: {},
   PreferencesController: {
+    advancedGasFee: true,
     currentLocale: true,
+    disabledRpcMethodPreferences: true,
+    dismissSeedBackUpReminder: true,
     featureFlags: true,
     forgottenPassword: true,
-    ipfsGateway: true,
+    identities: false,
-    preferences: true,
+    incomingTransactionsPreferences: true,
+    infuraBlocked: true,
+    ipfsGateway: false,
+    isLineaMainnetReleased: true,
+    knownMethodData: false,
+    ledgerTransportType: true,
+    lostIdentities: false,
+    openSeaEnabled: true,
+    preferences: {
+      autoLockTimeLimit: true,
+      hideZeroBalanceTokens: true,
+      showFiatInTestnets: true,
+      showTestNetworks: true,
+      useNativeCurrencyAsPrimaryCurrency: true,
+    },
+    selectedAddress: false,
+    snapRegistryList: false,
+    theme: true,
+    transactionSecurityCheckEnabled: true,
+    use4ByteResolution: true,
+    useAddressBarEnsResolution: true,
     useBlockie: true,
+    useCurrencyRateCheck: true,
+    useMultiAccountBalanceChecker: true,
+    useNftDetection: true,
     useNonceField: true,
     usePhishDetect: true,
+    useTokenDetection: true,
   },
   SignatureController: {
     unapprovedMsgCount: true,
+    unapprovedMsgs: false,
     unapprovedPersonalMsgCount: true,
+    unapprovedPersonalMsgs: false,
+    unapprovedTypedMessages: false,
     unapprovedTypedMessagesCount: true,
   },
+  SmartTransactionsController: {
+    smartTransactionsState: {
+      fees: {
+        approvalTxFees: true,
+        tradeTxFees: true,
+      },
+      liveness: true,
+      smartTransactions: false,
+      userOptIn: true,
+    },
+  },
+  SnapController: {
+    snapErrors: false,
+    snapStates: false,
+    snaps: false,
+  },
+  SnapsRegistry: {
+    database: false,
+    lastUpdated: false,
+  },
+  SubjectMetadataController: {
+    subjectMetadata: false,
+  },
+  SwapsController: {
+    swapsState: {
+      approveTxId: false,
+      customApproveTxData: false,
+      customGasPrice: true,
+      customMaxFeePerGas: true,
+      customMaxGas: true,
+      customMaxPriorityFeePerGas: true,
+      errorKey: true,
+      fetchParams: true,
+      quotes: false,
+      quotesLastFetched: true,
+      quotesPollingLimitEnabled: true,
+      routeState: true,
+      saveFetchedQuotes: true,
+      selectedAggId: true,
+      swapsFeatureFlags: true,
+      swapsFeatureIsLive: true,
+      swapsQuotePrefetchingRefreshTime: true,
+      swapsQuoteRefreshTime: true,
+      swapsStxBatchStatusRefreshTime: true,
+      swapsStxGetTransactionsRefreshTime: true,
+      swapsStxMaxFeeMultiplier: true,
+      swapsUserFeeLevel: true,
+      tokens: false,
+      topAggId: false,
+      tradeTxId: false,
+    },
+  },
+  TokenListController: {
+    preventPollingOnNetworkRestart: true,
+    tokenList: false,
+    tokensChainsCache: {
+      [AllProperties]: false,
+    },
+  },
+  TokenRatesController: {
+    contractExchangeRates: false,
+  },
+  TokensController: {
+    allDetectedTokens: {
+      [AllProperties]: false,
+    },
+    allIgnoredTokens: {
+      [AllProperties]: false,
+    },
+    allTokens: {
+      [AllProperties]: false,
+    },
+    detectedTokens: false,
+    ignoredTokens: false,
+    tokens: false,
+  },
+  TransactionController: {
+    currentNetworkTxList: false,
+    transactions: false,
+    lastFetchedBlockNumbers: false,
+  },
+  TxController: {
+    currentNetworkTxList: false,
+    transactions: false,
+    unapprovedTxs: false,
+  },
 };
 
 const flattenedBackgroundStateMask = Object.values(
@@ -118,7 +316,9 @@ export const SENTRY_UI_STATE = {
     // These properties are in the `metamask` slice but not in the background state
     customNonceValue: true,
     isAccountMenuOpen: true,
+    isNetworkMenuOpen: true,
     nextNonce: true,
+    pendingTokens: false,
     welcomeScreenSeen: true,
   },
   unconnectedAccount: true,

shared/modules/object.utils.js

@@ -1,25 +1,43 @@
 /**
- * Return a "masked" copy of the given object.
+ * This symbol matches all object properties when used in a mask
+ */
+export const AllProperties = Symbol('*');
+
+/**
+ * Return a "masked" copy of the given object. The returned object includes
+ * only the properties present in the mask.
  *
- * The returned object includes only the properties present in the mask. The
+ * The mask is an object that mirrors the structure of the given object, except
- * mask is an object that mirrors the structure of the given object, except
+ * the only values are `true`, `false, a sub-mask, or the 'AllProperties"
- * the only values are `true` or a sub-mask. `true` implies the property
+ * symbol. `true` implies the property should be included, and `false` will
- * should be included, and a sub-mask implies the property should be further
+ * exclude it. A sub-mask implies the property should be further masked
- * masked according to that sub-mask.
+ * according to that sub-mask. The "AllProperties" symbol is used for objects
+ * with dynamic keys, and applies a rule (either `true`, `false`, or a
+ * sub-mask`) to every property in that object.
  *
- * If a property is not found in the last, its type is included instead.
+ * If a property is excluded, its type is included instead.
  *
  * @param {object} object - The object to mask
  * @param {Object<object | boolean>} mask - The mask to apply to the object
  */
 export function maskObject(object, mask) {
+  let maskAllProperties = false;
+  if (Object.keys(mask).includes(AllProperties)) {
+    if (Object.keys(mask).length > 1) {
+      throw new Error('AllProperties mask key does not support sibling keys');
+    }
+    maskAllProperties = true;
+  }
   return Object.keys(object).reduce((state, key) => {
-    if (mask[key] === true) {
+    const maskKey = maskAllProperties ? mask[AllProperties] : mask[key];
+    if (maskKey === true) {
       state[key] = object[key];
-    } else if (mask[key]) {
+    } else if (maskKey && typeof maskKey === 'object') {
-      state[key] = maskObject(object[key], mask[key]);
+      state[key] = maskObject(object[key], maskKey);
-    } else {
+    } else if (maskKey === undefined || maskKey === false) {
       state[key] = typeof object[key];
+    } else {
+      throw new Error(`Unsupported mask entry: ${maskKey}`);
     }
     return state;
   }, {});

test/e2e/tests/errors.spec.js

@@ -4,8 +4,24 @@ const { strict: assert } = require('assert');
 const { get, has, set, unset } = require('lodash');
 const { Browser } = require('selenium-webdriver');
 const { format } = require('prettier');
-const { convertToHexValue, withFixtures } = require('../helpers');
+const { isObject } = require('@metamask/utils');
+const { SENTRY_UI_STATE } = require('../../../app/scripts/lib/setupSentry');
 const FixtureBuilder = require('../fixture-builder');
+const { convertToHexValue, withFixtures } = require('../helpers');
+
+/**
+ * Derive a UI state field from a background state field.
+ *
+ * @param {string} backgroundField - The path of a background field.
+ * @returns {string} The path for the corresponding UI field.
+ */
+function backgroundToUiField(backgroundField) {
+  // The controller name is lost in the UI due to state flattening
+  const [, ...rest] = backgroundField.split('.');
+  const flattenedBackgroundField = rest.join('.');
+  // Controller state is under the 'metamask' slice in the UI
+  return `metamask.${flattenedBackgroundField}`;
+}
 
 const maskedBackgroundFields = [
   'CurrencyController.conversionDate', // This is a timestamp that changes each run
@@ -13,14 +29,13 @@ const maskedBackgroundFields = [
   // part of the release process
   'AppMetadataController.currentAppVersion',
   'AppMetadataController.currentMigrationVersion',
+  'AppStateController.browserEnvironment.browser',
+  'AppStateController.browserEnvironment.os',
+  'AppStateController.outdatedBrowserWarningLastShown',
+  'AppStateController.recoveryPhraseReminderLastShown',
+  'AppStateController.termsOfUseLastAgreed',
 ];
-const maskedUiFields = [
+const maskedUiFields = maskedBackgroundFields.map(backgroundToUiField);
-  'metamask.conversionDate', // This is a timestamp that changes each run
-  // App metadata is masked so that we don't have to update the snapshot as
-  // part of the release process
-  'metamask.currentAppVersion',
-  'metamask.currentMigrationVersion',
-];
 
 const removedBackgroundFields = [
   // This property is timing-dependent
@@ -30,13 +45,7 @@ const removedBackgroundFields = [
   'AppStateController.timeoutMinutes',
 ];
 
-const removedUiFields = [
+const removedUiFields = removedBackgroundFields.map(backgroundToUiField);
-  // This property is timing-dependent
-  'metamask.currentBlockGasLimit',
-  // These properties are set to undefined, causing inconsistencies between Chrome and Firefox
-  'metamask.currentPopupId',
-  'metamask.timeoutMinutes',
-];
 
 /**
  * Transform background state to make it consistent between test runs.
@@ -115,6 +124,38 @@ async function matchesSnapshot({
   }
 }
 
+/**
+ * Get an object consisting of all properties in the complete
+ * object that are missing from the given object.
+ *
+ * @param {object} complete - The complete object to compare to.
+ * @param {object} object - The object to test for missing properties.
+ */
+function getMissingProperties(complete, object) {
+  const missing = {};
+  for (const [key, value] of Object.entries(complete)) {
+    if (key in object) {
+      if (isObject(value) && isObject(object[key])) {
+        const missingNestedProperties = getMissingProperties(
+          value,
+          object[key],
+        );
+        if (Object.keys(missingNestedProperties).length > 0) {
+          missing[key] = missingNestedProperties;
+        } else {
+          // no missing nested properties
+        }
+      } else {
+        // Skip non-object values, they are considered as present
+        // even if they represent masked data structures
+      }
+    } else {
+      missing[key] = value;
+    }
+  }
+  return missing;
+}
+
 describe('Sentry errors', function () {
   const migrationError =
     process.env.SELENIUM_BROWSER === Browser.CHROME
@@ -320,7 +361,10 @@ describe('Sentry errors', function () {
             'Invalid version state',
           );
           await matchesSnapshot({
-            data: transformBackgroundState(appState.persistedState),
+            data: {
+              ...appState.persistedState,
+              data: transformBackgroundState(appState.persistedState.data),
+            },
             snapshot: 'errors-before-init-opt-in-background-state',
           });
         },
@@ -468,7 +512,10 @@ describe('Sentry errors', function () {
             'Invalid version state',
           );
           await matchesSnapshot({
-            data: transformBackgroundState(appState.persistedState),
+            data: {
+              ...appState.persistedState,
+              data: transformBackgroundState(appState.persistedState.data),
+            },
             snapshot: 'errors-before-init-opt-in-ui-state',
           });
         },
@@ -736,4 +783,80 @@ describe('Sentry errors', function () {
       );
     });
   });
+
+  it('should have no policy gaps for UI controller state', async function () {
+    await withFixtures(
+      {
+        fixtures: new FixtureBuilder().build(),
+        ganacheOptions,
+        title: this.test.title,
+      },
+      async ({ driver }) => {
+        await driver.navigate();
+        await driver.findElement('#password');
+
+        const fullUiState = await driver.executeScript(() =>
+          window.stateHooks?.getCleanAppState?.(),
+        );
+
+        const missingState = getMissingProperties(
+          fullUiState.metamask,
+          SENTRY_UI_STATE.metamask,
+        );
+        assert.deepEqual(missingState, {});
+      },
+    );
+  });
+
+  it('should not have extra properties in UI state mask', async function () {
+    const expectedMissingState = {
+      currentPopupId: false, // Initialized as undefined
+      // Part of transaction controller store, but missing from the initial
+      // state
+      lastFetchedBlockNumbers: false,
+      preferences: {
+        autoLockTimeLimit: true, // Initialized as undefined
+      },
+      smartTransactionsState: {
+        fees: {
+          approvalTxFees: true, // Initialized as undefined
+          tradeTxFees: true, // Initialized as undefined
+        },
+        userOptIn: true, // Initialized as undefined
+      },
+      swapsState: {
+        // This can get wiped out during initialization due to a bug in
+        // the "resetState" method
+        swapsFeatureFlags: true,
+      },
+      // This can get erased due to a bug in the app state controller's
+      // preferences state change handler
+      timeoutMinutes: true,
+    };
+    await withFixtures(
+      {
+        fixtures: new FixtureBuilder().build(),
+        ganacheOptions,
+        title: this.test.title,
+      },
+      async ({ driver }) => {
+        await driver.navigate();
+        await driver.findElement('#password');
+
+        const fullUiState = await driver.executeScript(() =>
+          window.stateHooks?.getCleanAppState?.(),
+        );
+
+        const extraMaskProperties = getMissingProperties(
+          SENTRY_UI_STATE.metamask,
+          fullUiState.metamask,
+        );
+        const unexpectedExtraMaskProperties = getMissingProperties(
+          extraMaskProperties,
+          expectedMissingState,
+        );
+        assert.deepEqual(unexpectedExtraMaskProperties, {});
+      },
+    );
+  });
 });

test/e2e/tests/state-snapshots/errors-after-init-opt-in-background-state.json

@@ -1,12 +1,12 @@
 {
   "AccountTracker": { "accounts": "object" },
-  "AddressBookController": "object",
+  "AddressBookController": { "addressBook": "object" },
   "AlertController": {
     "alertEnabledness": { "unconnectedAccount": true, "web3ShimUsage": true },
     "unconnectedAccountAlertShownOrigins": "object",
     "web3ShimUsageOrigins": "object"
   },
-  "AnnouncementController": "object",
+  "AnnouncementController": { "announcements": "object" },
   "AppMetadataController": {
     "currentAppVersion": "string",
     "previousAppVersion": "",
@@ -16,37 +16,41 @@
   "AppStateController": {
     "connectedStatusPopoverHasBeenShown": true,
     "defaultHomeActiveTabName": null,
-    "browserEnvironment": "object",
+    "browserEnvironment": { "os": "string", "browser": "string" },
-    "popupGasPollTokens": "object",
+    "popupGasPollTokens": [],
-    "notificationGasPollTokens": "object",
+    "notificationGasPollTokens": [],
-    "fullScreenGasPollTokens": "object",
+    "fullScreenGasPollTokens": [],
-    "recoveryPhraseReminderHasBeenShown": "boolean",
+    "recoveryPhraseReminderHasBeenShown": true,
     "recoveryPhraseReminderLastShown": "number",
     "outdatedBrowserWarningLastShown": "number",
-    "nftsDetectionNoticeDismissed": "boolean",
+    "nftsDetectionNoticeDismissed": false,
-    "showTestnetMessageInDropdown": "boolean",
+    "showTestnetMessageInDropdown": true,
-    "showBetaHeader": "boolean",
+    "showBetaHeader": false,
-    "showProductTour": "boolean",
+    "showProductTour": true,
-    "trezorModel": "object",
+    "trezorModel": null,
-    "nftsDropdownState": "object",
+    "nftsDropdownState": {},
     "termsOfUseLastAgreed": "number",
-    "qrHardware": "object",
+    "qrHardware": {},
-    "usedNetworks": "object",
+    "usedNetworks": { "0x1": true, "0x5": true, "0x539": true },
-    "snapsInstallPrivacyWarningShown": "boolean",
+    "snapsInstallPrivacyWarningShown": true,
-    "hadAdvancedGasFeesSetPriorToMigration92_3": "boolean",
+    "hadAdvancedGasFeesSetPriorToMigration92_3": false,
-    "serviceWorkerLastActiveTime": "number"
+    "serviceWorkerLastActiveTime": 0
   },
-  "ApprovalController": "object",
+  "ApprovalController": {
-  "CachedBalancesController": "object",
+    "pendingApprovals": "object",
-  "CronjobController": "object",
+    "pendingApprovalCount": "number",
+    "approvalFlows": "object"
+  },
+  "CachedBalancesController": { "cachedBalances": "object" },
+  "CronjobController": { "jobs": "object" },
   "CurrencyController": {
     "conversionDate": "number",
     "conversionRate": 1700,
     "nativeCurrency": "ETH",
     "currentCurrency": "usd",
-    "pendingCurrentCurrency": "object",
+    "pendingCurrentCurrency": null,
-    "pendingNativeCurrency": "object",
+    "pendingNativeCurrency": null,
-    "usdConversionRate": "number"
+    "usdConversionRate": 1700
   },
   "DecryptMessageController": {
     "unapprovedDecryptMsgs": "object",
@@ -56,8 +60,12 @@
     "unapprovedEncryptionPublicKeyMsgs": "object",
     "unapprovedEncryptionPublicKeyMsgCount": 0
   },
-  "EnsController": "object",
+  "EnsController": { "ensResolutionsByAddress": "object" },
-  "GasFeeController": "object",
+  "GasFeeController": {
+    "gasFeeEstimates": {},
+    "estimatedGasFeeTimeBounds": {},
+    "gasEstimateType": "none"
+  },
   "KeyringController": {
     "isUnlocked": false,
     "keyringTypes": "object",
@@ -76,42 +84,54 @@
     "selectedNetworkClientId": "string",
     "networkId": "1337",
     "providerConfig": {
-      "chainId": "string",
+      "chainId": "0x539",
       "nickname": "Localhost 8545",
       "rpcPrefs": "object",
       "rpcUrl": "string",
       "ticker": "ETH",
       "type": "rpc",
-      "id": "string"
+      "id": "networkConfigurationId"
+    },
+    "networksMetadata": {
+      "networkConfigurationId": {
+        "EIPS": { "1559": false },
+        "status": "available"
+      }
     },
-    "networksMetadata": "object",
     "networkConfigurations": "object"
   },
-  "NftController": "object",
+  "NftController": {
-  "NotificationController": "object",
+    "allNftContracts": "object",
+    "allNfts": "object",
+    "ignoredNfts": "object"
+  },
+  "NotificationController": { "notifications": "object" },
   "OnboardingController": {
     "seedPhraseBackedUp": true,
     "firstTimeFlowType": "import",
     "completedOnboarding": true,
     "onboardingTabs": "object"
   },
-  "PermissionController": "object",
+  "PermissionController": { "subjects": "object" },
-  "PermissionLogController": "object",
+  "PermissionLogController": {
+    "permissionHistory": "object",
+    "permissionActivityLog": "object"
+  },
   "PreferencesController": {
     "useBlockie": false,
     "useNonceField": false,
     "usePhishDetect": true,
-    "dismissSeedBackUpReminder": "boolean",
+    "dismissSeedBackUpReminder": true,
-    "disabledRpcMethodPreferences": "object",
+    "disabledRpcMethodPreferences": { "eth_sign": false },
-    "useMultiAccountBalanceChecker": "boolean",
+    "useMultiAccountBalanceChecker": true,
-    "useTokenDetection": "boolean",
+    "useTokenDetection": false,
-    "useNftDetection": "boolean",
+    "useNftDetection": false,
-    "use4ByteResolution": "boolean",
+    "use4ByteResolution": true,
-    "useCurrencyRateCheck": "boolean",
+    "useCurrencyRateCheck": true,
-    "openSeaEnabled": "boolean",
+    "openSeaEnabled": false,
-    "advancedGasFee": "object",
+    "advancedGasFee": {},
     "featureFlags": {},
-    "incomingTransactionsPreferences": "object",
+    "incomingTransactionsPreferences": {},
     "knownMethodData": "object",
     "currentLocale": "en",
     "identities": "object",
@@ -123,14 +143,14 @@
       "showTestNetworks": false,
       "useNativeCurrencyAsPrimaryCurrency": true
     },
-    "ipfsGateway": "dweb.link",
+    "ipfsGateway": "string",
-    "useAddressBarEnsResolution": "boolean",
+    "useAddressBarEnsResolution": true,
-    "infuraBlocked": "boolean",
+    "infuraBlocked": false,
-    "ledgerTransportType": "string",
+    "ledgerTransportType": "webhid",
     "snapRegistryList": "object",
-    "transactionSecurityCheckEnabled": "boolean",
+    "transactionSecurityCheckEnabled": false,
-    "theme": "string",
+    "theme": "light",
-    "isLineaMainnetReleased": "boolean",
+    "isLineaMainnetReleased": true,
     "selectedAddress": "string"
   },
   "SignatureController": {
@@ -141,13 +161,65 @@
     "unapprovedPersonalMsgCount": 0,
     "unapprovedTypedMessagesCount": 0
   },
-  "SmartTransactionsController": "object",
+  "SmartTransactionsController": {
-  "SnapController": "object",
+    "smartTransactionsState": {
-  "SnapsRegistry": "object",
+      "fees": {},
-  "SubjectMetadataController": "object",
+      "liveness": true,
-  "SwapsController": "object",
+      "smartTransactions": "object"
-  "TokenListController": "object",
+    }
-  "TokenRatesController": "object",
+  },
-  "TokensController": "object",
+  "SnapController": {
-  "TxController": "object"
+    "snapErrors": "object",
+    "snaps": "object",
+    "snapStates": "object"
+  },
+  "SnapsRegistry": { "database": "object", "lastUpdated": "object" },
+  "SubjectMetadataController": { "subjectMetadata": "object" },
+  "SwapsController": {
+    "swapsState": {
+      "quotes": "object",
+      "quotesPollingLimitEnabled": false,
+      "fetchParams": null,
+      "tokens": "object",
+      "tradeTxId": "object",
+      "approveTxId": "object",
+      "quotesLastFetched": null,
+      "customMaxGas": "",
+      "customGasPrice": null,
+      "customMaxFeePerGas": null,
+      "customMaxPriorityFeePerGas": null,
+      "swapsUserFeeLevel": "",
+      "selectedAggId": null,
+      "customApproveTxData": "string",
+      "errorKey": "",
+      "topAggId": "object",
+      "routeState": "",
+      "swapsFeatureIsLive": true,
+      "saveFetchedQuotes": false,
+      "swapsQuoteRefreshTime": 60000,
+      "swapsQuotePrefetchingRefreshTime": 60000,
+      "swapsStxBatchStatusRefreshTime": 10000,
+      "swapsStxGetTransactionsRefreshTime": 10000,
+      "swapsStxMaxFeeMultiplier": 2
+    }
+  },
+  "TokenListController": {
+    "tokenList": "object",
+    "tokensChainsCache": {},
+    "preventPollingOnNetworkRestart": true
+  },
+  "TokenRatesController": { "contractExchangeRates": "object" },
+  "TokensController": {
+    "tokens": "object",
+    "ignoredTokens": "object",
+    "detectedTokens": "object",
+    "allTokens": {},
+    "allIgnoredTokens": {},
+    "allDetectedTokens": {}
+  },
+  "TxController": {
+    "unapprovedTxs": "object",
+    "currentNetworkTxList": "object",
+    "transactions": "object"
+  }
 }

test/e2e/tests/state-snapshots/errors-after-init-opt-in-ui-state.json

@@ -11,7 +11,7 @@
     "isInitialized": true,
     "isUnlocked": false,
     "isAccountMenuOpen": false,
-    "isNetworkMenuOpen": "boolean",
+    "isNetworkMenuOpen": false,
     "identities": "object",
     "unapprovedTxs": "object",
     "networkConfigurations": "object",
@@ -32,32 +32,32 @@
     "firstTimeFlowType": "import",
     "completedOnboarding": true,
     "knownMethodData": "object",
-    "use4ByteResolution": "boolean",
+    "use4ByteResolution": true,
     "participateInMetaMetrics": true,
     "nextNonce": null,
     "conversionRate": 1300,
     "nativeCurrency": "ETH",
     "connectedStatusPopoverHasBeenShown": true,
     "defaultHomeActiveTabName": null,
-    "browserEnvironment": "object",
+    "browserEnvironment": { "os": "string", "browser": "string" },
-    "popupGasPollTokens": "object",
+    "popupGasPollTokens": [],
-    "notificationGasPollTokens": "object",
+    "notificationGasPollTokens": [],
-    "fullScreenGasPollTokens": "object",
+    "fullScreenGasPollTokens": [],
-    "recoveryPhraseReminderHasBeenShown": "boolean",
+    "recoveryPhraseReminderHasBeenShown": true,
     "recoveryPhraseReminderLastShown": "number",
     "outdatedBrowserWarningLastShown": "number",
-    "nftsDetectionNoticeDismissed": "boolean",
+    "nftsDetectionNoticeDismissed": false,
-    "showTestnetMessageInDropdown": "boolean",
+    "showTestnetMessageInDropdown": true,
-    "showBetaHeader": "boolean",
+    "showBetaHeader": false,
-    "showProductTour": "boolean",
+    "showProductTour": true,
-    "trezorModel": "object",
+    "trezorModel": null,
-    "nftsDropdownState": "object",
+    "nftsDropdownState": {},
     "termsOfUseLastAgreed": "number",
-    "qrHardware": "object",
+    "qrHardware": {},
-    "usedNetworks": "object",
+    "usedNetworks": { "0x1": true, "0x5": true, "0x539": true },
-    "snapsInstallPrivacyWarningShown": "boolean",
+    "snapsInstallPrivacyWarningShown": true,
-    "hadAdvancedGasFeesSetPriorToMigration92_3": "boolean",
+    "hadAdvancedGasFeesSetPriorToMigration92_3": false,
-    "serviceWorkerLastActiveTime": "number",
+    "serviceWorkerLastActiveTime": 0,
     "currentAppVersion": "string",
     "previousAppVersion": "",
     "previousMigrationVersion": 0,
@@ -65,39 +65,44 @@
     "selectedNetworkClientId": "string",
     "networkId": "1337",
     "providerConfig": {
-      "chainId": "string",
+      "chainId": "0x539",
       "nickname": "Localhost 8545",
       "rpcPrefs": "object",
       "rpcUrl": "string",
       "ticker": "ETH",
       "type": "rpc",
-      "id": "string"
+      "id": "networkConfigurationId"
+    },
+    "networksMetadata": {
+      "networkConfigurationId": {
+        "EIPS": { "1559": false },
+        "status": "available"
+      }
     },
-    "networksMetadata": "object",
     "cachedBalances": "object",
     "keyringTypes": "object",
     "keyrings": "object",
     "useNonceField": false,
     "usePhishDetect": true,
-    "dismissSeedBackUpReminder": "boolean",
+    "dismissSeedBackUpReminder": true,
-    "disabledRpcMethodPreferences": "object",
+    "disabledRpcMethodPreferences": { "eth_sign": false },
-    "useMultiAccountBalanceChecker": "boolean",
+    "useMultiAccountBalanceChecker": true,
-    "useTokenDetection": "boolean",
+    "useTokenDetection": false,
-    "useNftDetection": "boolean",
+    "useNftDetection": false,
-    "useCurrencyRateCheck": "boolean",
+    "useCurrencyRateCheck": true,
-    "openSeaEnabled": "boolean",
+    "openSeaEnabled": false,
-    "advancedGasFee": "object",
+    "advancedGasFee": {},
-    "incomingTransactionsPreferences": "object",
+    "incomingTransactionsPreferences": {},
     "lostIdentities": "object",
     "forgottenPassword": false,
-    "ipfsGateway": "dweb.link",
+    "ipfsGateway": "string",
-    "useAddressBarEnsResolution": "boolean",
+    "useAddressBarEnsResolution": true,
-    "infuraBlocked": "boolean",
+    "infuraBlocked": false,
-    "ledgerTransportType": "string",
+    "ledgerTransportType": "webhid",
     "snapRegistryList": "object",
-    "transactionSecurityCheckEnabled": "boolean",
+    "transactionSecurityCheckEnabled": false,
-    "theme": "string",
+    "theme": "light",
-    "isLineaMainnetReleased": "boolean",
+    "isLineaMainnetReleased": true,
     "selectedAddress": "string",
     "metaMetricsId": "fake-metrics-id",
     "eventsBeforeMetricsOptIn": "object",
@@ -107,9 +112,9 @@
     "previousUserTraits": "object",
     "conversionDate": "number",
     "currentCurrency": "usd",
-    "pendingCurrentCurrency": "object",
+    "pendingCurrentCurrency": null,
-    "pendingNativeCurrency": "object",
+    "pendingNativeCurrency": null,
-    "usdConversionRate": "number",
+    "usdConversionRate": 1300,
     "alertEnabledness": { "unconnectedAccount": true, "web3ShimUsage": true },
     "unconnectedAccountAlertShownOrigins": "object",
     "web3ShimUsageOrigins": "object",
@@ -120,19 +125,23 @@
     "permissionActivityLog": "object",
     "subjectMetadata": "object",
     "announcements": "object",
-    "gasFeeEstimates": "object",
+    "gasFeeEstimates": {},
-    "estimatedGasFeeTimeBounds": "object",
+    "estimatedGasFeeTimeBounds": {},
-    "gasEstimateType": "string",
+    "gasEstimateType": "none",
     "tokenList": "object",
-    "tokensChainsCache": "object",
+    "tokensChainsCache": {},
-    "preventPollingOnNetworkRestart": "boolean",
+    "preventPollingOnNetworkRestart": true,
     "tokens": "object",
     "ignoredTokens": "object",
     "detectedTokens": "object",
-    "allTokens": "object",
+    "allTokens": {},
-    "allIgnoredTokens": "object",
+    "allIgnoredTokens": {},
-    "allDetectedTokens": "object",
+    "allDetectedTokens": {},
-    "smartTransactionsState": "object",
+    "smartTransactionsState": {
+      "fees": {},
+      "liveness": true,
+      "smartTransactions": "object"
+    },
     "allNftContracts": "object",
     "allNfts": "object",
     "ignoredNfts": "object",
@@ -156,7 +165,32 @@
     "unapprovedMsgCount": 0,
     "unapprovedPersonalMsgCount": 0,
     "unapprovedTypedMessagesCount": 0,
-    "swapsState": "object",
+    "swapsState": {
+      "quotes": "object",
+      "quotesPollingLimitEnabled": false,
+      "fetchParams": null,
+      "tokens": "object",
+      "tradeTxId": "object",
+      "approveTxId": "object",
+      "quotesLastFetched": null,
+      "customMaxGas": "",
+      "customGasPrice": null,
+      "customMaxFeePerGas": null,
+      "customMaxPriorityFeePerGas": null,
+      "swapsUserFeeLevel": "",
+      "selectedAggId": null,
+      "customApproveTxData": "string",
+      "errorKey": "",
+      "topAggId": "object",
+      "routeState": "",
+      "swapsFeatureIsLive": true,
+      "saveFetchedQuotes": false,
+      "swapsQuoteRefreshTime": 60000,
+      "swapsQuotePrefetchingRefreshTime": 60000,
+      "swapsStxBatchStatusRefreshTime": 10000,
+      "swapsStxGetTransactionsRefreshTime": 10000,
+      "swapsStxMaxFeeMultiplier": 2
+    },
     "ensResolutionsByAddress": "object",
     "pendingApprovals": "object",
     "pendingApprovalCount": "number",

test/e2e/tests/state-snapshots/errors-before-init-opt-in-background-state.json

@@ -5,33 +5,42 @@
       "unconnectedAccountAlertShownOrigins": "object",
       "web3ShimUsageOrigins": "object"
     },
-    "AnnouncementController": "object",
+    "AnnouncementController": { "announcements": "object" },
     "AppStateController": {
-      "browserEnvironment": "object",
+      "browserEnvironment": {},
-      "nftsDropdownState": "object",
+      "nftsDropdownState": {},
       "connectedStatusPopoverHasBeenShown": true,
       "termsOfUseLastAgreed": "number",
       "defaultHomeActiveTabName": null,
-      "fullScreenGasPollTokens": "object",
+      "fullScreenGasPollTokens": [],
-      "notificationGasPollTokens": "object",
+      "notificationGasPollTokens": [],
-      "popupGasPollTokens": "object",
+      "popupGasPollTokens": [],
-      "qrHardware": "object",
+      "qrHardware": {},
-      "recoveryPhraseReminderHasBeenShown": "boolean",
+      "recoveryPhraseReminderHasBeenShown": true,
       "recoveryPhraseReminderLastShown": "number",
-      "showTestnetMessageInDropdown": "boolean",
+      "showTestnetMessageInDropdown": true,
-      "trezorModel": "object",
+      "trezorModel": null,
-      "usedNetworks": "object",
+      "usedNetworks": {
-      "snapsInstallPrivacyWarningShown": "boolean"
+        "0x1": true,
+        "0xe708": true,
+        "0x5": true,
+        "0x539": true
+      },
+      "snapsInstallPrivacyWarningShown": true
     },
-    "CachedBalancesController": "object",
+    "CachedBalancesController": { "cachedBalances": "object" },
     "CurrencyController": {
-      "conversionDate": 1665507600,
+      "conversionDate": "number",
       "conversionRate": 1300,
       "currentCurrency": "usd",
       "nativeCurrency": "ETH",
-      "usdConversionRate": "number"
+      "usdConversionRate": 1300
+    },
+    "GasFeeController": {
+      "estimatedGasFeeTimeBounds": {},
+      "gasEstimateType": "none",
+      "gasFeeEstimates": {}
     },
-    "GasFeeController": "object",
     "KeyringController": { "vault": "string" },
     "MetaMetricsController": {
       "eventsBeforeMetricsOptIn": "object",
@@ -43,15 +52,17 @@
     "NetworkController": {
       "networkId": "1337",
       "selectedNetworkClientId": "string",
-      "networksMetadata": "object",
+      "networksMetadata": {
+        "networkConfigurationId": { "EIPS": {}, "status": "available" }
+      },
       "providerConfig": {
-        "chainId": "string",
+        "chainId": "0x539",
         "nickname": "Localhost 8545",
         "rpcPrefs": "object",
         "rpcUrl": "string",
         "ticker": "ETH",
         "type": "rpc",
-        "id": "string"
+        "id": "networkConfigurationId"
       },
       "networkConfigurations": "object"
     },
@@ -61,20 +72,20 @@
       "onboardingTabs": "object",
       "seedPhraseBackedUp": true
     },
-    "PermissionController": "object",
+    "PermissionController": { "subjects": "object" },
     "PreferencesController": {
-      "advancedGasFee": "object",
+      "advancedGasFee": null,
       "currentLocale": "en",
-      "dismissSeedBackUpReminder": "boolean",
+      "dismissSeedBackUpReminder": true,
       "featureFlags": {},
       "forgottenPassword": false,
       "identities": "object",
-      "infuraBlocked": "boolean",
+      "infuraBlocked": false,
-      "ipfsGateway": "dweb.link",
+      "ipfsGateway": "string",
       "knownMethodData": "object",
-      "ledgerTransportType": "string",
+      "ledgerTransportType": "webhid",
       "lostIdentities": "object",
-      "openSeaEnabled": "boolean",
+      "openSeaEnabled": false,
       "preferences": {
         "hideZeroBalanceTokens": false,
         "showFiatInTestnets": false,
@@ -82,19 +93,32 @@
         "useNativeCurrencyAsPrimaryCurrency": true
       },
       "selectedAddress": "string",
-      "theme": "string",
+      "theme": "light",
       "useBlockie": false,
-      "useNftDetection": "boolean",
+      "useNftDetection": false,
       "useNonceField": false,
       "usePhishDetect": true,
-      "useTokenDetection": "boolean",
+      "useTokenDetection": false,
-      "useCurrencyRateCheck": "boolean",
+      "useCurrencyRateCheck": true,
-      "useMultiAccountBalanceChecker": "boolean"
+      "useMultiAccountBalanceChecker": true
     },
-    "SmartTransactionsController": "object",
+    "SmartTransactionsController": {
-    "SubjectMetadataController": "object",
+      "smartTransactionsState": {
-    "TokensController": "object",
+        "fees": {},
-    "TransactionController": "object",
+        "liveness": true,
+        "smartTransactions": "object"
+      }
+    },
+    "SubjectMetadataController": { "subjectMetadata": "object" },
+    "TokensController": {
+      "allDetectedTokens": {},
+      "allIgnoredTokens": {},
+      "allTokens": {},
+      "detectedTokens": "object",
+      "ignoredTokens": "object",
+      "tokens": "object"
+    },
+    "TransactionController": { "transactions": "object" },
     "config": "object",
     "firstTimeInfo": "object"
   }

test/e2e/tests/state-snapshots/errors-before-init-opt-in-ui-state.json

@@ -5,33 +5,42 @@
       "unconnectedAccountAlertShownOrigins": "object",
       "web3ShimUsageOrigins": "object"
     },
-    "AnnouncementController": "object",
+    "AnnouncementController": { "announcements": "object" },
     "AppStateController": {
-      "browserEnvironment": "object",
+      "browserEnvironment": {},
-      "nftsDropdownState": "object",
+      "nftsDropdownState": {},
       "connectedStatusPopoverHasBeenShown": true,
       "termsOfUseLastAgreed": "number",
       "defaultHomeActiveTabName": null,
-      "fullScreenGasPollTokens": "object",
+      "fullScreenGasPollTokens": [],
-      "notificationGasPollTokens": "object",
+      "notificationGasPollTokens": [],
-      "popupGasPollTokens": "object",
+      "popupGasPollTokens": [],
-      "qrHardware": "object",
+      "qrHardware": {},
-      "recoveryPhraseReminderHasBeenShown": "boolean",
+      "recoveryPhraseReminderHasBeenShown": true,
       "recoveryPhraseReminderLastShown": "number",
-      "showTestnetMessageInDropdown": "boolean",
+      "showTestnetMessageInDropdown": true,
-      "trezorModel": "object",
+      "trezorModel": null,
-      "usedNetworks": "object",
+      "usedNetworks": {
-      "snapsInstallPrivacyWarningShown": "boolean"
+        "0x1": true,
+        "0xe708": true,
+        "0x5": true,
+        "0x539": true
+      },
+      "snapsInstallPrivacyWarningShown": true
     },
-    "CachedBalancesController": "object",
+    "CachedBalancesController": { "cachedBalances": "object" },
     "CurrencyController": {
-      "conversionDate": 1665507600,
+      "conversionDate": "number",
       "conversionRate": 1300,
       "currentCurrency": "usd",
       "nativeCurrency": "ETH",
-      "usdConversionRate": "number"
+      "usdConversionRate": 1300
+    },
+    "GasFeeController": {
+      "estimatedGasFeeTimeBounds": {},
+      "gasEstimateType": "none",
+      "gasFeeEstimates": {}
     },
-    "GasFeeController": "object",
     "KeyringController": { "vault": "string" },
     "MetaMetricsController": {
       "eventsBeforeMetricsOptIn": "object",
@@ -43,15 +52,17 @@
     "NetworkController": {
       "networkId": "1337",
       "selectedNetworkClientId": "string",
-      "networksMetadata": "object",
+      "networksMetadata": {
+        "networkConfigurationId": { "EIPS": {}, "status": "available" }
+      },
       "providerConfig": {
-        "chainId": "string",
+        "chainId": "0x539",
         "nickname": "Localhost 8545",
         "rpcPrefs": "object",
         "rpcUrl": "string",
         "ticker": "ETH",
         "type": "rpc",
-        "id": "string"
+        "id": "networkConfigurationId"
       },
       "networkConfigurations": "object"
     },
@@ -61,20 +72,20 @@
       "onboardingTabs": "object",
       "seedPhraseBackedUp": true
     },
-    "PermissionController": "object",
+    "PermissionController": { "subjects": "object" },
     "PreferencesController": {
-      "advancedGasFee": "object",
+      "advancedGasFee": null,
       "currentLocale": "en",
-      "dismissSeedBackUpReminder": "boolean",
+      "dismissSeedBackUpReminder": true,
       "featureFlags": {},
       "forgottenPassword": false,
       "identities": "object",
-      "infuraBlocked": "boolean",
+      "infuraBlocked": false,
-      "ipfsGateway": "dweb.link",
+      "ipfsGateway": "string",
       "knownMethodData": "object",
-      "ledgerTransportType": "string",
+      "ledgerTransportType": "webhid",
       "lostIdentities": "object",
-      "openSeaEnabled": "boolean",
+      "openSeaEnabled": false,
       "preferences": {
         "hideZeroBalanceTokens": false,
         "showFiatInTestnets": false,
@@ -82,19 +93,32 @@
         "useNativeCurrencyAsPrimaryCurrency": true
       },
       "selectedAddress": "string",
-      "theme": "string",
+      "theme": "light",
       "useBlockie": false,
-      "useNftDetection": "boolean",
+      "useNftDetection": false,
       "useNonceField": false,
       "usePhishDetect": true,
-      "useTokenDetection": "boolean",
+      "useTokenDetection": false,
-      "useCurrencyRateCheck": "boolean",
+      "useCurrencyRateCheck": true,
-      "useMultiAccountBalanceChecker": "boolean"
+      "useMultiAccountBalanceChecker": true
     },
-    "SmartTransactionsController": "object",
+    "SmartTransactionsController": {
-    "SubjectMetadataController": "object",
+      "smartTransactionsState": {
-    "TokensController": "object",
+        "fees": {},
-    "TransactionController": "object",
+        "liveness": true,
+        "smartTransactions": "object"
+      }
+    },
+    "SubjectMetadataController": { "subjectMetadata": "object" },
+    "TokensController": {
+      "allDetectedTokens": {},
+      "allIgnoredTokens": {},
+      "allTokens": {},
+      "detectedTokens": "object",
+      "ignoredTokens": "object",
+      "tokens": "object"
+    },
+    "TransactionController": { "transactions": "object" },
     "config": "object",
     "firstTimeInfo": "object"
   },