@metamask-previews/profile-metrics-controller 2.0.0-preview-c72fc191 → 2.0.0-preview-fa81dffb

package/CHANGELOG.md

@@ -20,8 +20,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Set time-based delay for first `ProfileMetricsController` data collection after opt-in ([#7624](https://github.com/MetaMask/core/pull/7624))
 - Upgrade `@metamask/utils` from `^11.8.1` to `^11.9.0` ([#7511](https://github.com/MetaMask/core/pull/7511))
 - Bump `@metamask/controller-utils` from `^11.16.0` to `^11.18.0` ([#7534](https://github.com/MetaMask/core/pull/7534), [#7583](https://github.com/MetaMask/core/pull/7583))
-- Bump `@metamask/accounts-controller` from `^35.0.0` to `^35.0.1` ([#7604](https://github.com/MetaMask/core/pull/7604))
-- Bump `@metamask/polling-controller` from `^16.0.0` to `^16.0.1` ([#7604](https://github.com/MetaMask/core/pull/7604))
+- Bump `@metamask/accounts-controller` from `^35.0.0` to `^35.0.2` ([#7604](https://github.com/MetaMask/core/pull/7604), [#7642](https://github.com/MetaMask/core/pull/7642))
+- Bump `@metamask/polling-controller` from `^16.0.0` to `^16.0.2` ([#7604](https://github.com/MetaMask/core/pull/7604), [#7642](https://github.com/MetaMask/core/pull/7642))
 
 ## [2.0.0]
 

package/dist/ProfileMetricsController.cjs

@@ -14,6 +14,7 @@ var _ProfileMetricsController_instances, _ProfileMetricsController_mutex, _Profi
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProfileMetricsController = exports.getDefaultProfileMetricsControllerState = exports.DEFAULT_INITIAL_DELAY_DURATION = exports.controllerName = void 0;
 const polling_controller_1 = require("@metamask/polling-controller");
+const utils_1 = require("@metamask/utils");
 const async_mutex_1 = require("async-mutex");
 /**
  * The name of the {@link ProfileMetricsController}, used to namespace the
@@ -22,9 +23,9 @@ const async_mutex_1 = require("async-mutex");
  */
 exports.controllerName = 'ProfileMetricsController';
 /**
- * The default delay duration before data is sent for the first time, in milliseconds.
+ * The default delay duration before data is sent for the first time.
  */
-exports.DEFAULT_INITIAL_DELAY_DURATION = 10 * 60 * 1000; // 10 minutes
+exports.DEFAULT_INITIAL_DELAY_DURATION = (0, utils_1.inMilliseconds)(10, utils_1.Duration.Minute);
 /**
  * The metadata for each property in {@link ProfileMetricsControllerState}.
  */
@@ -107,7 +108,7 @@ class ProfileMetricsController extends (0, polling_controller_1.StaticIntervalPo
                 // it must have opted in during onboarding, or during a previous session.
                 this.skipInitialDelay();
             }
-            __classPrivateFieldGet(this, _ProfileMetricsController_instances, "m", _ProfileMetricsController_queueFirstSyncIfNeeded).call(this).catch(console.error);
+            __classPrivateFieldGet(this, _ProfileMetricsController_instances, "m", _ProfileMetricsController_queueFirstSyncIfNeeded).call(this).catch(this.messenger.captureException ?? console.error);
             this.startPolling(null);
         });
         this.messenger.subscribe('KeyringController:lock', () => this.stopAllPolling());
@@ -196,14 +197,8 @@ async function _ProfileMetricsController_queueFirstSyncIfNeeded() {
         state.initialDelayEndTimestamp ?? (state.initialDelayEndTimestamp = Date.now() + __classPrivateFieldGet(this, _ProfileMetricsController_initialDelayDuration, "f"));
     });
 }, _ProfileMetricsController_isInitialDelayComplete = function _ProfileMetricsController_isInitialDelayComplete() {
-    // The following check should never be true due to the initialization logic,
-    // as the `initialDelayEndTimestamp` is always set in the constructor,
-    // but is included for type safety. Ignoring for code coverage purposes.
-    // istanbul ignore if
-    if (this.state.initialDelayEndTimestamp === undefined) {
-        return false;
-    }
-    return Date.now() >= this.state.initialDelayEndTimestamp;
+    return (this.state.initialDelayEndTimestamp !== undefined &&
+        Date.now() >= this.state.initialDelayEndTimestamp);
 }, _ProfileMetricsController_addAccountToQueue = 
 /**
  * Queue the given account to be synced at the next poll.

package/dist/ProfileMetricsController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"ProfileMetricsController.cjs","sourceRoot":"","sources":["../src/ProfileMetricsController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAgBA,qEAA+E;AAE/E,6CAAoC;AAMpC;;;;GAIG;AACU,QAAA,cAAc,GAAG,0BAA0B,CAAC;AAEzD;;GAEG;AACU,QAAA,8BAA8B,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;AAwB3E;;GAEG;AACH,MAAM,gCAAgC,GAAG;IACvC,uBAAuB,EAAE;QACvB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;IACD,SAAS,EAAE;QACT,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;IACD,wBAAwB,EAAE;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;CACqD,CAAC;AAEzD;;;;;;;GAOG;AACH,SAAgB,uCAAuC;IACrD,OAAO;QACL,uBAAuB,EAAE,KAAK;QAC9B,SAAS,EAAE,EAAE;KACd,CAAC;AACJ,CAAC;AALD,0FAKC;AAED,MAAM,yBAAyB,GAAG,CAAC,kBAAkB,CAAU,CAAC;AA4DhE,MAAa,wBAAyB,SAAQ,IAAA,oDAA+B,GAI5E;IASC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,GAAG,EAAE,GAAG,IAAI,EACpB,oBAAoB,GAAG,sCAA8B,GAQtD;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,gCAAgC;YAC1C,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE;gBACL,GAAG,uCAAuC,EAAE;gBAC5C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAhDI,0CAAS,IAAI,mBAAK,EAAE,EAAC;QAErB,8DAAkC;QAElC,6DAAgC;QAEhC,iEAA8B;QA4CrC,uBAAA,IAAI,+CAAsB,iBAAiB,MAAA,CAAC;QAC5C,uBAAA,IAAI,8CAAqB,gBAAgB,MAAA,CAAC;QAC1C,uBAAA,IAAI,kDAAyB,oBAAoB,MAAA,CAAC;QAElD,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;YACxD,IAAI,uBAAA,IAAI,mDAAmB,MAAvB,IAAI,CAAqB,EAAE,CAAC;gBAC9B,gEAAgE;gBAChE,yEAAyE;gBACzE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,CAAC;YACD,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACpD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE,CACtD,IAAI,CAAC,cAAc,EAAE,CACtB,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,4CAA4C,EAAE,GAAG,EAAE,CAC1E,IAAI,CAAC,gBAAgB,EAAE,CACxB,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,iCAAiC,EAAE,CAAC,OAAO,EAAE,EAAE;YACtE,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,mCAAmC,EAAE,CAAC,OAAO,EAAE,EAAE;YACxE,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,EAAyB,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,gBAAgB;QACd,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,wBAAwB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACxC,IAAI,CAAC,uBAAA,IAAI,mDAAmB,MAAvB,IAAI,CAAqB,EAAE,CAAC;gBAC/B,OAAO;YACT,CAAC;YACD,uBAAA,IAAI,wGAAmC,MAAvC,IAAI,CAAqC,CAAC;YAC1C,IAAI,CAAC,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,EAAE,CAAC;gBACpC,OAAO;YACT,CAAC;YACD,KAAK,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CACtD,IAAI,CAAC,KAAK,CAAC,SAAS,CACrB,EAAE,CAAC;gBACF,IAAI,CAAC;oBACH,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,qCAAqC,EAAE;wBAC/D,aAAa,EAAE,uBAAA,IAAI,kDAAkB,MAAtB,IAAI,CAAoB;wBACvC,eAAe,EACb,eAAe,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,eAAe;wBACrD,QAAQ;qBACT,CAAC,CAAC;oBACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,OAAO,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;oBAC1C,CAAC,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,kEAAkE;oBAClE,OAAO,CAAC,KAAK,CACX,0DAA0D,eAAe,GAAG,EAC5E,KAAK,CACN,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CAuGF;AAtPD,4DAsPC;;AArGC;;;;;GAKG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,IAAI,CAAC,KAAK,CAAC,uBAAuB,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QACD,MAAM,kBAAkB,GAAG,8BAA8B,CACvD,MAAM,CAAC,MAAM,CACX,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,gBAAgB;aAChE,QAAQ,CACZ,CACF,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBAClD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC1B,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;gBAC5B,CAAC;gBACD,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;YACxD,CAAC;YACD,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;IAMC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,wBAAwB,KAA9B,KAAK,CAAC,wBAAwB,GAC5B,IAAI,CAAC,GAAG,EAAE,GAAG,uBAAA,IAAI,sDAAsB,EAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC;IAQC,4EAA4E;IAC5E,sEAAsE;IACtE,wEAAwE;IACxE,qBAAqB;IACrB,IAAI,IAAI,CAAC,KAAK,CAAC,wBAAwB,KAAK,SAAS,EAAE,CAAC;QACtD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC;AAC3D,CAAC;AAED;;;;GAIG;AACH,KAAK,sDAAoB,OAAwB;IAC/C,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,eAAe,GAAG,yBAAyB,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC;YACrE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC;gBACtC,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC;YACxC,CAAC;YACD,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC;gBACpC,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,KAAK,2DAAyB,OAAe;IAC3C,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAC9D,KAAK,CAAC,SAAS,CAChB,EAAE,CAAC;gBACF,MAAM,KAAK,GAAG,gBAAgB,CAAC,SAAS,CACtC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,KAAK,OAAO,CACrC,CAAC;gBACF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;oBACjB,SAAS;gBACX,CAAC;gBACD,gBAAgB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBAClC,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAClC,OAAO,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;gBAC1C,CAAC;gBACD,MAAM;YACR,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAGH;;;;;GAKG;AACH,SAAS,yBAAyB,CAAC,OAAwB;IACzD,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,KAAK,UAAU,EAAE,CAAC;QACjD,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;IACpC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAS,8BAA8B,CACrC,QAA2B;IAE3B,OAAO,QAAQ,CAAC,MAAM,CACpB,CAAC,MAA2C,EAAE,OAAO,EAAE,EAAE;QACvD,MAAM,eAAe,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;QAC3D,MAAM,GAAG,GAAG,eAAe,IAAI,MAAM,CAAC;QACtC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACjB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;QACnB,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACvE,OAAO,MAAM,CAAC;IAChB,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC","sourcesContent":["import type {\n  AccountsControllerAccountAddedEvent,\n  AccountsControllerAccountRemovedEvent,\n  AccountsControllerGetStateAction,\n} from '@metamask/accounts-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport type {\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { Messenger } from '@metamask/messenger';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport { TransactionControllerTransactionSubmittedEvent } from '@metamask/transaction-controller';\nimport { Mutex } from 'async-mutex';\n\nimport type { ProfileMetricsServiceMethodActions } from '.';\nimport type { ProfileMetricsControllerMethodActions } from '.';\nimport type { AccountWithScopes } from './ProfileMetricsService';\n\n/**\n * The name of the {@link ProfileMetricsController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'ProfileMetricsController';\n\n/**\n * The default delay duration before data is sent for the first time, in milliseconds.\n */\nexport const DEFAULT_INITIAL_DELAY_DURATION = 10 * 60 * 1000; // 10 minutes\n\n/**\n * Describes the shape of the state object for {@link ProfileMetricsController}.\n */\nexport type ProfileMetricsControllerState = {\n  /**\n   * Whether existing accounts have been added\n   * to the queue.\n   */\n  initialEnqueueCompleted: boolean;\n  /**\n   * The queue of accounts to be synced.\n   * Each key is an entropy source ID, and each value is an array of account\n   * addresses associated with that entropy source. Accounts with no entropy\n   * source ID are grouped under the key \"null\".\n   */\n  syncQueue: Record<string, AccountWithScopes[]>;\n  /**\n   * The timestamp when the first data sending can be attempted.\n   */\n  initialDelayEndTimestamp?: number;\n};\n\n/**\n * The metadata for each property in {@link ProfileMetricsControllerState}.\n */\nconst profileMetricsControllerMetadata = {\n  initialEnqueueCompleted: {\n    persist: true,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n  syncQueue: {\n    persist: true,\n    includeInDebugSnapshot: false,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n  initialDelayEndTimestamp: {\n    persist: true,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n} satisfies StateMetadata<ProfileMetricsControllerState>;\n\n/**\n * Constructs the default {@link ProfileMetricsController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link ProfileMetricsController} state.\n */\nexport function getDefaultProfileMetricsControllerState(): ProfileMetricsControllerState {\n  return {\n    initialEnqueueCompleted: false,\n    syncQueue: {},\n  };\n}\n\nconst MESSENGER_EXPOSED_METHODS = ['skipInitialDelay'] as const;\n\n/**\n * Retrieves the state of the {@link ProfileMetricsController}.\n */\nexport type ProfileMetricsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  ProfileMetricsControllerState\n>;\n\n/**\n * Actions that {@link ProfileMetricsControllerMessenger} exposes to other consumers.\n */\nexport type ProfileMetricsControllerActions =\n  | ProfileMetricsControllerGetStateAction\n  | ProfileMetricsControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link ProfileMetricsControllerMessenger} calls.\n */\ntype AllowedActions =\n  | ProfileMetricsServiceMethodActions\n  | AccountsControllerGetStateAction;\n\n/**\n * Published when the state of {@link ProfileMetricsController} changes.\n */\nexport type ProfileMetricsControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    ProfileMetricsControllerState\n  >;\n\n/**\n * Events that {@link ProfileMetricsControllerMessenger} exposes to other consumers.\n */\nexport type ProfileMetricsControllerEvents =\n  ProfileMetricsControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link ProfileMetricsControllerMessenger} subscribes\n * to.\n */\ntype AllowedEvents =\n  | KeyringControllerUnlockEvent\n  | KeyringControllerLockEvent\n  | AccountsControllerAccountAddedEvent\n  | AccountsControllerAccountRemovedEvent\n  | TransactionControllerTransactionSubmittedEvent;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link ProfileMetricsController}.\n */\nexport type ProfileMetricsControllerMessenger = Messenger<\n  typeof controllerName,\n  ProfileMetricsControllerActions | AllowedActions,\n  ProfileMetricsControllerEvents | AllowedEvents\n>;\n\nexport class ProfileMetricsController extends StaticIntervalPollingController()<\n  typeof controllerName,\n  ProfileMetricsControllerState,\n  ProfileMetricsControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  readonly #assertUserOptedIn: () => boolean;\n\n  readonly #getMetaMetricsId: () => string;\n\n  readonly #initialDelayDuration: number;\n\n  /**\n   * Constructs a new {@link ProfileMetricsController}.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.state - The desired state with which to initialize this\n   * controller. Missing properties will be filled in with defaults.\n   * @param args.assertUserOptedIn - A function that asserts whether the user has\n   * opted in to user profile features. If the user has not opted in, sync\n   * operations will be no-ops.\n   * @param args.getMetaMetricsId - A function that returns the MetaMetrics ID\n   * of the user.\n   * @param args.interval - The interval, in milliseconds, at which the controller will\n   * attempt to send user profile data. Defaults to 10 seconds.\n   * @param args.initialDelayDuration - The delay duration before data is sent\n   * for the first time, in milliseconds. Defaults to 10 minutes.\n   */\n  constructor({\n    messenger,\n    state,\n    assertUserOptedIn,\n    getMetaMetricsId,\n    interval = 10 * 1000,\n    initialDelayDuration = DEFAULT_INITIAL_DELAY_DURATION,\n  }: {\n    messenger: ProfileMetricsControllerMessenger;\n    state?: Partial<ProfileMetricsControllerState>;\n    interval?: number;\n    assertUserOptedIn: () => boolean;\n    getMetaMetricsId: () => string;\n    initialDelayDuration?: number;\n  }) {\n    super({\n      messenger,\n      metadata: profileMetricsControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultProfileMetricsControllerState(),\n        ...state,\n      },\n    });\n\n    this.#assertUserOptedIn = assertUserOptedIn;\n    this.#getMetaMetricsId = getMetaMetricsId;\n    this.#initialDelayDuration = initialDelayDuration;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    this.messenger.subscribe('KeyringController:unlock', () => {\n      if (this.#assertUserOptedIn()) {\n        // If the user has already opted in at the start of the session,\n        // it must have opted in during onboarding, or during a previous session.\n        this.skipInitialDelay();\n      }\n      this.#queueFirstSyncIfNeeded().catch(console.error);\n      this.startPolling(null);\n    });\n\n    this.messenger.subscribe('KeyringController:lock', () =>\n      this.stopAllPolling(),\n    );\n\n    this.messenger.subscribe('TransactionController:transactionSubmitted', () =>\n      this.skipInitialDelay(),\n    );\n\n    this.messenger.subscribe('AccountsController:accountAdded', (account) => {\n      this.#addAccountToQueue(account).catch(console.error);\n    });\n\n    this.messenger.subscribe('AccountsController:accountRemoved', (account) => {\n      this.#removeAccountFromQueue(account).catch(console.error);\n    });\n\n    this.setIntervalLength(interval);\n  }\n\n  /**\n   * Skip the initial delay period by setting the end timestamp to the current time.\n   * Metrics will be sent on the next poll.\n   */\n  skipInitialDelay(): void {\n    this.update((state) => {\n      state.initialDelayEndTimestamp = Date.now();\n    });\n  }\n\n  /**\n   * Execute a single poll to sync user profile data.\n   *\n   * The queued accounts are sent to the ProfileMetricsService, and the sync\n   * queue is cleared. This operation is mutexed to prevent concurrent\n   * executions.\n   *\n   * @returns A promise that resolves when the poll is complete.\n   */\n  async _executePoll(): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      if (!this.#assertUserOptedIn()) {\n        return;\n      }\n      this.#setInitialDelayEndTimestampIfNull();\n      if (!this.#isInitialDelayComplete()) {\n        return;\n      }\n      for (const [entropySourceId, accounts] of Object.entries(\n        this.state.syncQueue,\n      )) {\n        try {\n          await this.messenger.call('ProfileMetricsService:submitMetrics', {\n            metametricsId: this.#getMetaMetricsId(),\n            entropySourceId:\n              entropySourceId === 'null' ? null : entropySourceId,\n            accounts,\n          });\n          this.update((state) => {\n            delete state.syncQueue[entropySourceId];\n          });\n        } catch (error) {\n          // We want to log the error but continue processing other batches.\n          console.error(\n            `Failed to submit profile metrics for entropy source ID ${entropySourceId}:`,\n            error,\n          );\n        }\n      }\n    });\n  }\n\n  /**\n   * Add existing accounts to the sync queue if it has not been done yet.\n   *\n   * This method ensures that the first sync is only executed once,\n   * and only if the user has opted in to user profile features.\n   */\n  async #queueFirstSyncIfNeeded(): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      if (this.state.initialEnqueueCompleted) {\n        return;\n      }\n      const newGroupedAccounts = groupAccountsByEntropySourceId(\n        Object.values(\n          this.messenger.call('AccountsController:getState').internalAccounts\n            .accounts,\n        ),\n      );\n      this.update((state) => {\n        for (const key of Object.keys(newGroupedAccounts)) {\n          if (!state.syncQueue[key]) {\n            state.syncQueue[key] = [];\n          }\n          state.syncQueue[key].push(...newGroupedAccounts[key]);\n        }\n        state.initialEnqueueCompleted = true;\n      });\n    });\n  }\n\n  /**\n   * Set the initial delay end timestamp if it is not already set.\n   */\n  #setInitialDelayEndTimestampIfNull(): void {\n    this.update((state) => {\n      state.initialDelayEndTimestamp ??=\n        Date.now() + this.#initialDelayDuration;\n    });\n  }\n\n  /**\n   * Check if the initial delay end timestamp is in the past.\n   *\n   * @returns True if the initial delay period has completed, false otherwise.\n   */\n  #isInitialDelayComplete(): boolean {\n    // The following check should never be true due to the initialization logic,\n    // as the `initialDelayEndTimestamp` is always set in the constructor,\n    // but is included for type safety. Ignoring for code coverage purposes.\n    // istanbul ignore if\n    if (this.state.initialDelayEndTimestamp === undefined) {\n      return false;\n    }\n    return Date.now() >= this.state.initialDelayEndTimestamp;\n  }\n\n  /**\n   * Queue the given account to be synced at the next poll.\n   *\n   * @param account - The account to sync.\n   */\n  async #addAccountToQueue(account: InternalAccount): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      this.update((state) => {\n        const entropySourceId = getAccountEntropySourceId(account) ?? 'null';\n        if (!state.syncQueue[entropySourceId]) {\n          state.syncQueue[entropySourceId] = [];\n        }\n        state.syncQueue[entropySourceId].push({\n          address: account.address,\n          scopes: account.scopes,\n        });\n      });\n    });\n  }\n\n  /**\n   * Remove the given account from the sync queue.\n   *\n   * @param account - The account address to remove.\n   */\n  async #removeAccountFromQueue(account: string): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      this.update((state) => {\n        for (const [entropySourceId, groupedAddresses] of Object.entries(\n          state.syncQueue,\n        )) {\n          const index = groupedAddresses.findIndex(\n            ({ address }) => address === account,\n          );\n          if (index === -1) {\n            continue;\n          }\n          groupedAddresses.splice(index, 1);\n          if (groupedAddresses.length === 0) {\n            delete state.syncQueue[entropySourceId];\n          }\n          break;\n        }\n      });\n    });\n  }\n}\n\n/**\n * Retrieves the entropy source ID from the given account, if it exists.\n *\n * @param account - The account from which to retrieve the entropy source ID.\n * @returns The entropy source ID, or null if it does not exist.\n */\nfunction getAccountEntropySourceId(account: InternalAccount): string | null {\n  if (account.options.entropy?.type === 'mnemonic') {\n    return account.options.entropy.id;\n  }\n  return null;\n}\n\n/**\n * Groups accounts by their entropy source ID.\n *\n * @param accounts - The accounts to group.\n * @returns An object where each key is an entropy source ID and each value is\n * an array of account addresses associated with that entropy source ID.\n */\nfunction groupAccountsByEntropySourceId(\n  accounts: InternalAccount[],\n): Record<string, AccountWithScopes[]> {\n  return accounts.reduce(\n    (result: Record<string, AccountWithScopes[]>, account) => {\n      const entropySourceId = getAccountEntropySourceId(account);\n      const key = entropySourceId ?? 'null';\n      if (!result[key]) {\n        result[key] = [];\n      }\n      result[key].push({ address: account.address, scopes: account.scopes });\n      return result;\n    },\n    {},\n  );\n}\n"]}
+{"version":3,"file":"ProfileMetricsController.cjs","sourceRoot":"","sources":["../src/ProfileMetricsController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAgBA,qEAA+E;AAE/E,2CAA2D;AAC3D,6CAAoC;AAMpC;;;;GAIG;AACU,QAAA,cAAc,GAAG,0BAA0B,CAAC;AAEzD;;GAEG;AACU,QAAA,8BAA8B,GAAG,IAAA,sBAAc,EAC1D,EAAE,EACF,gBAAQ,CAAC,MAAM,CAChB,CAAC;AAwBF;;GAEG;AACH,MAAM,gCAAgC,GAAG;IACvC,uBAAuB,EAAE;QACvB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;IACD,SAAS,EAAE;QACT,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;IACD,wBAAwB,EAAE;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;CACqD,CAAC;AAEzD;;;;;;;GAOG;AACH,SAAgB,uCAAuC;IACrD,OAAO;QACL,uBAAuB,EAAE,KAAK;QAC9B,SAAS,EAAE,EAAE;KACd,CAAC;AACJ,CAAC;AALD,0FAKC;AAED,MAAM,yBAAyB,GAAG,CAAC,kBAAkB,CAAU,CAAC;AA4DhE,MAAa,wBAAyB,SAAQ,IAAA,oDAA+B,GAI5E;IASC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,GAAG,EAAE,GAAG,IAAI,EACpB,oBAAoB,GAAG,sCAA8B,GAQtD;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,gCAAgC;YAC1C,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE;gBACL,GAAG,uCAAuC,EAAE;gBAC5C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAhDI,0CAAS,IAAI,mBAAK,EAAE,EAAC;QAErB,8DAAkC;QAElC,6DAAgC;QAEhC,iEAA8B;QA4CrC,uBAAA,IAAI,+CAAsB,iBAAiB,MAAA,CAAC;QAC5C,uBAAA,IAAI,8CAAqB,gBAAgB,MAAA,CAAC;QAC1C,uBAAA,IAAI,kDAAyB,oBAAoB,MAAA,CAAC;QAElD,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;YACxD,IAAI,uBAAA,IAAI,mDAAmB,MAAvB,IAAI,CAAqB,EAAE,CAAC;gBAC9B,gEAAgE;gBAChE,yEAAyE;gBACzE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,CAAC;YACD,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,CAAC,KAAK,CAClC,IAAI,CAAC,SAAS,CAAC,gBAAgB,IAAI,OAAO,CAAC,KAAK,CACjD,CAAC;YACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE,CACtD,IAAI,CAAC,cAAc,EAAE,CACtB,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,4CAA4C,EAAE,GAAG,EAAE,CAC1E,IAAI,CAAC,gBAAgB,EAAE,CACxB,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,iCAAiC,EAAE,CAAC,OAAO,EAAE,EAAE;YACtE,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,mCAAmC,EAAE,CAAC,OAAO,EAAE,EAAE;YACxE,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,EAAyB,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,gBAAgB;QACd,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,wBAAwB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACxC,IAAI,CAAC,uBAAA,IAAI,mDAAmB,MAAvB,IAAI,CAAqB,EAAE,CAAC;gBAC/B,OAAO;YACT,CAAC;YACD,uBAAA,IAAI,wGAAmC,MAAvC,IAAI,CAAqC,CAAC;YAC1C,IAAI,CAAC,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,EAAE,CAAC;gBACpC,OAAO;YACT,CAAC;YACD,KAAK,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CACtD,IAAI,CAAC,KAAK,CAAC,SAAS,CACrB,EAAE,CAAC;gBACF,IAAI,CAAC;oBACH,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,qCAAqC,EAAE;wBAC/D,aAAa,EAAE,uBAAA,IAAI,kDAAkB,MAAtB,IAAI,CAAoB;wBACvC,eAAe,EACb,eAAe,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,eAAe;wBACrD,QAAQ;qBACT,CAAC,CAAC;oBACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,OAAO,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;oBAC1C,CAAC,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,kEAAkE;oBAClE,OAAO,CAAC,KAAK,CACX,0DAA0D,eAAe,GAAG,EAC5E,KAAK,CACN,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CAmGF;AApPD,4DAoPC;;AAjGC;;;;;GAKG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,IAAI,CAAC,KAAK,CAAC,uBAAuB,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QACD,MAAM,kBAAkB,GAAG,8BAA8B,CACvD,MAAM,CAAC,MAAM,CACX,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,gBAAgB;aAChE,QAAQ,CACZ,CACF,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBAClD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC1B,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;gBAC5B,CAAC;gBACD,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;YACxD,CAAC;YACD,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;IAMC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,wBAAwB,KAA9B,KAAK,CAAC,wBAAwB,GAC5B,IAAI,CAAC,GAAG,EAAE,GAAG,uBAAA,IAAI,sDAAsB,EAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC;IAQC,OAAO,CACL,IAAI,CAAC,KAAK,CAAC,wBAAwB,KAAK,SAAS;QACjD,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAClD,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,KAAK,sDAAoB,OAAwB;IAC/C,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,eAAe,GAAG,yBAAyB,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC;YACrE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC;gBACtC,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC;YACxC,CAAC;YACD,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC;gBACpC,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,KAAK,2DAAyB,OAAe;IAC3C,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAC9D,KAAK,CAAC,SAAS,CAChB,EAAE,CAAC;gBACF,MAAM,KAAK,GAAG,gBAAgB,CAAC,SAAS,CACtC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,KAAK,OAAO,CACrC,CAAC;gBACF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;oBACjB,SAAS;gBACX,CAAC;gBACD,gBAAgB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBAClC,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAClC,OAAO,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;gBAC1C,CAAC;gBACD,MAAM;YACR,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAGH;;;;;GAKG;AACH,SAAS,yBAAyB,CAAC,OAAwB;IACzD,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,KAAK,UAAU,EAAE,CAAC;QACjD,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;IACpC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAS,8BAA8B,CACrC,QAA2B;IAE3B,OAAO,QAAQ,CAAC,MAAM,CACpB,CAAC,MAA2C,EAAE,OAAO,EAAE,EAAE;QACvD,MAAM,eAAe,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;QAC3D,MAAM,GAAG,GAAG,eAAe,IAAI,MAAM,CAAC;QACtC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACjB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;QACnB,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACvE,OAAO,MAAM,CAAC;IAChB,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC","sourcesContent":["import type {\n  AccountsControllerAccountAddedEvent,\n  AccountsControllerAccountRemovedEvent,\n  AccountsControllerGetStateAction,\n} from '@metamask/accounts-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport type {\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { Messenger } from '@metamask/messenger';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport { TransactionControllerTransactionSubmittedEvent } from '@metamask/transaction-controller';\nimport { Duration, inMilliseconds } from '@metamask/utils';\nimport { Mutex } from 'async-mutex';\n\nimport type { ProfileMetricsServiceMethodActions } from '.';\nimport type { ProfileMetricsControllerMethodActions } from '.';\nimport type { AccountWithScopes } from './ProfileMetricsService';\n\n/**\n * The name of the {@link ProfileMetricsController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'ProfileMetricsController';\n\n/**\n * The default delay duration before data is sent for the first time.\n */\nexport const DEFAULT_INITIAL_DELAY_DURATION = inMilliseconds(\n  10,\n  Duration.Minute,\n);\n\n/**\n * Describes the shape of the state object for {@link ProfileMetricsController}.\n */\nexport type ProfileMetricsControllerState = {\n  /**\n   * Whether existing accounts have been added\n   * to the queue.\n   */\n  initialEnqueueCompleted: boolean;\n  /**\n   * The queue of accounts to be synced.\n   * Each key is an entropy source ID, and each value is an array of account\n   * addresses associated with that entropy source. Accounts with no entropy\n   * source ID are grouped under the key \"null\".\n   */\n  syncQueue: Record<string, AccountWithScopes[]>;\n  /**\n   * The timestamp when the first data sending can be attempted.\n   */\n  initialDelayEndTimestamp?: number;\n};\n\n/**\n * The metadata for each property in {@link ProfileMetricsControllerState}.\n */\nconst profileMetricsControllerMetadata = {\n  initialEnqueueCompleted: {\n    persist: true,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n  syncQueue: {\n    persist: true,\n    includeInDebugSnapshot: false,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n  initialDelayEndTimestamp: {\n    persist: true,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n} satisfies StateMetadata<ProfileMetricsControllerState>;\n\n/**\n * Constructs the default {@link ProfileMetricsController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link ProfileMetricsController} state.\n */\nexport function getDefaultProfileMetricsControllerState(): ProfileMetricsControllerState {\n  return {\n    initialEnqueueCompleted: false,\n    syncQueue: {},\n  };\n}\n\nconst MESSENGER_EXPOSED_METHODS = ['skipInitialDelay'] as const;\n\n/**\n * Retrieves the state of the {@link ProfileMetricsController}.\n */\nexport type ProfileMetricsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  ProfileMetricsControllerState\n>;\n\n/**\n * Actions that {@link ProfileMetricsControllerMessenger} exposes to other consumers.\n */\nexport type ProfileMetricsControllerActions =\n  | ProfileMetricsControllerGetStateAction\n  | ProfileMetricsControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link ProfileMetricsControllerMessenger} calls.\n */\ntype AllowedActions =\n  | ProfileMetricsServiceMethodActions\n  | AccountsControllerGetStateAction;\n\n/**\n * Published when the state of {@link ProfileMetricsController} changes.\n */\nexport type ProfileMetricsControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    ProfileMetricsControllerState\n  >;\n\n/**\n * Events that {@link ProfileMetricsControllerMessenger} exposes to other consumers.\n */\nexport type ProfileMetricsControllerEvents =\n  ProfileMetricsControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link ProfileMetricsControllerMessenger} subscribes\n * to.\n */\ntype AllowedEvents =\n  | KeyringControllerUnlockEvent\n  | KeyringControllerLockEvent\n  | AccountsControllerAccountAddedEvent\n  | AccountsControllerAccountRemovedEvent\n  | TransactionControllerTransactionSubmittedEvent;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link ProfileMetricsController}.\n */\nexport type ProfileMetricsControllerMessenger = Messenger<\n  typeof controllerName,\n  ProfileMetricsControllerActions | AllowedActions,\n  ProfileMetricsControllerEvents | AllowedEvents\n>;\n\nexport class ProfileMetricsController extends StaticIntervalPollingController()<\n  typeof controllerName,\n  ProfileMetricsControllerState,\n  ProfileMetricsControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  readonly #assertUserOptedIn: () => boolean;\n\n  readonly #getMetaMetricsId: () => string;\n\n  readonly #initialDelayDuration: number;\n\n  /**\n   * Constructs a new {@link ProfileMetricsController}.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.state - The desired state with which to initialize this\n   * controller. Missing properties will be filled in with defaults.\n   * @param args.assertUserOptedIn - A function that asserts whether the user has\n   * opted in to user profile features. If the user has not opted in, sync\n   * operations will be no-ops.\n   * @param args.getMetaMetricsId - A function that returns the MetaMetrics ID\n   * of the user.\n   * @param args.interval - The interval, in milliseconds, at which the controller will\n   * attempt to send user profile data. Defaults to 10 seconds.\n   * @param args.initialDelayDuration - The delay duration before data is sent\n   * for the first time, in milliseconds. Defaults to 10 minutes.\n   */\n  constructor({\n    messenger,\n    state,\n    assertUserOptedIn,\n    getMetaMetricsId,\n    interval = 10 * 1000,\n    initialDelayDuration = DEFAULT_INITIAL_DELAY_DURATION,\n  }: {\n    messenger: ProfileMetricsControllerMessenger;\n    state?: Partial<ProfileMetricsControllerState>;\n    interval?: number;\n    assertUserOptedIn: () => boolean;\n    getMetaMetricsId: () => string;\n    initialDelayDuration?: number;\n  }) {\n    super({\n      messenger,\n      metadata: profileMetricsControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultProfileMetricsControllerState(),\n        ...state,\n      },\n    });\n\n    this.#assertUserOptedIn = assertUserOptedIn;\n    this.#getMetaMetricsId = getMetaMetricsId;\n    this.#initialDelayDuration = initialDelayDuration;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    this.messenger.subscribe('KeyringController:unlock', () => {\n      if (this.#assertUserOptedIn()) {\n        // If the user has already opted in at the start of the session,\n        // it must have opted in during onboarding, or during a previous session.\n        this.skipInitialDelay();\n      }\n      this.#queueFirstSyncIfNeeded().catch(\n        this.messenger.captureException ?? console.error,\n      );\n      this.startPolling(null);\n    });\n\n    this.messenger.subscribe('KeyringController:lock', () =>\n      this.stopAllPolling(),\n    );\n\n    this.messenger.subscribe('TransactionController:transactionSubmitted', () =>\n      this.skipInitialDelay(),\n    );\n\n    this.messenger.subscribe('AccountsController:accountAdded', (account) => {\n      this.#addAccountToQueue(account).catch(console.error);\n    });\n\n    this.messenger.subscribe('AccountsController:accountRemoved', (account) => {\n      this.#removeAccountFromQueue(account).catch(console.error);\n    });\n\n    this.setIntervalLength(interval);\n  }\n\n  /**\n   * Skip the initial delay period by setting the end timestamp to the current time.\n   * Metrics will be sent on the next poll.\n   */\n  skipInitialDelay(): void {\n    this.update((state) => {\n      state.initialDelayEndTimestamp = Date.now();\n    });\n  }\n\n  /**\n   * Execute a single poll to sync user profile data.\n   *\n   * The queued accounts are sent to the ProfileMetricsService, and the sync\n   * queue is cleared. This operation is mutexed to prevent concurrent\n   * executions.\n   *\n   * @returns A promise that resolves when the poll is complete.\n   */\n  async _executePoll(): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      if (!this.#assertUserOptedIn()) {\n        return;\n      }\n      this.#setInitialDelayEndTimestampIfNull();\n      if (!this.#isInitialDelayComplete()) {\n        return;\n      }\n      for (const [entropySourceId, accounts] of Object.entries(\n        this.state.syncQueue,\n      )) {\n        try {\n          await this.messenger.call('ProfileMetricsService:submitMetrics', {\n            metametricsId: this.#getMetaMetricsId(),\n            entropySourceId:\n              entropySourceId === 'null' ? null : entropySourceId,\n            accounts,\n          });\n          this.update((state) => {\n            delete state.syncQueue[entropySourceId];\n          });\n        } catch (error) {\n          // We want to log the error but continue processing other batches.\n          console.error(\n            `Failed to submit profile metrics for entropy source ID ${entropySourceId}:`,\n            error,\n          );\n        }\n      }\n    });\n  }\n\n  /**\n   * Add existing accounts to the sync queue if it has not been done yet.\n   *\n   * This method ensures that the first sync is only executed once,\n   * and only if the user has opted in to user profile features.\n   */\n  async #queueFirstSyncIfNeeded(): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      if (this.state.initialEnqueueCompleted) {\n        return;\n      }\n      const newGroupedAccounts = groupAccountsByEntropySourceId(\n        Object.values(\n          this.messenger.call('AccountsController:getState').internalAccounts\n            .accounts,\n        ),\n      );\n      this.update((state) => {\n        for (const key of Object.keys(newGroupedAccounts)) {\n          if (!state.syncQueue[key]) {\n            state.syncQueue[key] = [];\n          }\n          state.syncQueue[key].push(...newGroupedAccounts[key]);\n        }\n        state.initialEnqueueCompleted = true;\n      });\n    });\n  }\n\n  /**\n   * Set the initial delay end timestamp if it is not already set.\n   */\n  #setInitialDelayEndTimestampIfNull(): void {\n    this.update((state) => {\n      state.initialDelayEndTimestamp ??=\n        Date.now() + this.#initialDelayDuration;\n    });\n  }\n\n  /**\n   * Check if the initial delay end timestamp is in the past.\n   *\n   * @returns True if the initial delay period has completed, false otherwise.\n   */\n  #isInitialDelayComplete(): boolean {\n    return (\n      this.state.initialDelayEndTimestamp !== undefined &&\n      Date.now() >= this.state.initialDelayEndTimestamp\n    );\n  }\n\n  /**\n   * Queue the given account to be synced at the next poll.\n   *\n   * @param account - The account to sync.\n   */\n  async #addAccountToQueue(account: InternalAccount): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      this.update((state) => {\n        const entropySourceId = getAccountEntropySourceId(account) ?? 'null';\n        if (!state.syncQueue[entropySourceId]) {\n          state.syncQueue[entropySourceId] = [];\n        }\n        state.syncQueue[entropySourceId].push({\n          address: account.address,\n          scopes: account.scopes,\n        });\n      });\n    });\n  }\n\n  /**\n   * Remove the given account from the sync queue.\n   *\n   * @param account - The account address to remove.\n   */\n  async #removeAccountFromQueue(account: string): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      this.update((state) => {\n        for (const [entropySourceId, groupedAddresses] of Object.entries(\n          state.syncQueue,\n        )) {\n          const index = groupedAddresses.findIndex(\n            ({ address }) => address === account,\n          );\n          if (index === -1) {\n            continue;\n          }\n          groupedAddresses.splice(index, 1);\n          if (groupedAddresses.length === 0) {\n            delete state.syncQueue[entropySourceId];\n          }\n          break;\n        }\n      });\n    });\n  }\n}\n\n/**\n * Retrieves the entropy source ID from the given account, if it exists.\n *\n * @param account - The account from which to retrieve the entropy source ID.\n * @returns The entropy source ID, or null if it does not exist.\n */\nfunction getAccountEntropySourceId(account: InternalAccount): string | null {\n  if (account.options.entropy?.type === 'mnemonic') {\n    return account.options.entropy.id;\n  }\n  return null;\n}\n\n/**\n * Groups accounts by their entropy source ID.\n *\n * @param accounts - The accounts to group.\n * @returns An object where each key is an entropy source ID and each value is\n * an array of account addresses associated with that entropy source ID.\n */\nfunction groupAccountsByEntropySourceId(\n  accounts: InternalAccount[],\n): Record<string, AccountWithScopes[]> {\n  return accounts.reduce(\n    (result: Record<string, AccountWithScopes[]>, account) => {\n      const entropySourceId = getAccountEntropySourceId(account);\n      const key = entropySourceId ?? 'null';\n      if (!result[key]) {\n        result[key] = [];\n      }\n      result[key].push({ address: account.address, scopes: account.scopes });\n      return result;\n    },\n    {},\n  );\n}\n"]}

package/dist/ProfileMetricsController.d.cts

@@ -14,7 +14,7 @@ import type { AccountWithScopes } from "./ProfileMetricsService.cjs";
  */
 export declare const controllerName = "ProfileMetricsController";
 /**
- * The default delay duration before data is sent for the first time, in milliseconds.
+ * The default delay duration before data is sent for the first time.
  */
 export declare const DEFAULT_INITIAL_DELAY_DURATION: number;
 /**

package/dist/ProfileMetricsController.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"ProfileMetricsController.d.cts","sourceRoot":"","sources":["../src/ProfileMetricsController.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EACV,mCAAmC,EACnC,qCAAqC,EACrC,gCAAgC,EACjC,sCAAsC;AACvC,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AAEtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,8CAA8C,EAAE,yCAAyC;AAGlG,OAAO,KAAK,EAAE,kCAAkC,EAAE,oBAAU;AAC5D,OAAO,KAAK,EAAE,qCAAqC,EAAE,oBAAU;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAgC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,cAAc,6BAA6B,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,8BAA8B,QAAiB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC/C;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AA0BF;;;;;;;GAOG;AACH,wBAAgB,uCAAuC,IAAI,6BAA6B,CAKvF;AAID;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,sCAAsC,GACtC,qCAAqC,CAAC;AAE1C;;GAEG;AACH,KAAK,cAAc,GACf,kCAAkC,GAClC,gCAAgC,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;;GAGG;AACH,KAAK,aAAa,GACd,4BAA4B,GAC5B,0BAA0B,GAC1B,mCAAmC,GACnC,qCAAqC,GACrC,8CAA8C,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;;;;;;;;;;;;;;;;AAEF,qBAAa,wBAAyB,SAAQ,8BAC5C,OAAO,cAAc,EACrB,6BAA6B,EAC7B,iCAAiC,CAClC;;IASC;;;;;;;;;;;;;;;;OAgBG;gBACS,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,QAAoB,EACpB,oBAAqD,GACtD,EAAE;QACD,SAAS,EAAE,iCAAiC,CAAC;QAC7C,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;QAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,iBAAiB,EAAE,MAAM,OAAO,CAAC;QACjC,gBAAgB,EAAE,MAAM,MAAM,CAAC;QAC/B,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC/B;IAiDD;;;OAGG;IACH,gBAAgB,IAAI,IAAI;IAMxB;;;;;;;;OAQG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAsIpC"}
+{"version":3,"file":"ProfileMetricsController.d.cts","sourceRoot":"","sources":["../src/ProfileMetricsController.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EACV,mCAAmC,EACnC,qCAAqC,EACrC,gCAAgC,EACjC,sCAAsC;AACvC,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AAEtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,8CAA8C,EAAE,yCAAyC;AAIlG,OAAO,KAAK,EAAE,kCAAkC,EAAE,oBAAU;AAC5D,OAAO,KAAK,EAAE,qCAAqC,EAAE,oBAAU;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAgC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,cAAc,6BAA6B,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,8BAA8B,QAG1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC/C;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AA0BF;;;;;;;GAOG;AACH,wBAAgB,uCAAuC,IAAI,6BAA6B,CAKvF;AAID;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,sCAAsC,GACtC,qCAAqC,CAAC;AAE1C;;GAEG;AACH,KAAK,cAAc,GACf,kCAAkC,GAClC,gCAAgC,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;;GAGG;AACH,KAAK,aAAa,GACd,4BAA4B,GAC5B,0BAA0B,GAC1B,mCAAmC,GACnC,qCAAqC,GACrC,8CAA8C,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;;;;;;;;;;;;;;;;AAEF,qBAAa,wBAAyB,SAAQ,8BAC5C,OAAO,cAAc,EACrB,6BAA6B,EAC7B,iCAAiC,CAClC;;IASC;;;;;;;;;;;;;;;;OAgBG;gBACS,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,QAAoB,EACpB,oBAAqD,GACtD,EAAE;QACD,SAAS,EAAE,iCAAiC,CAAC;QAC7C,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;QAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,iBAAiB,EAAE,MAAM,OAAO,CAAC;QACjC,gBAAgB,EAAE,MAAM,MAAM,CAAC;QAC/B,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC/B;IAmDD;;;OAGG;IACH,gBAAgB,IAAI,IAAI;IAMxB;;;;;;;;OAQG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAkIpC"}

package/dist/ProfileMetricsController.d.mts

@@ -14,7 +14,7 @@ import type { AccountWithScopes } from "./ProfileMetricsService.mjs";
  */
 export declare const controllerName = "ProfileMetricsController";
 /**
- * The default delay duration before data is sent for the first time, in milliseconds.
+ * The default delay duration before data is sent for the first time.
  */
 export declare const DEFAULT_INITIAL_DELAY_DURATION: number;
 /**

package/dist/ProfileMetricsController.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"ProfileMetricsController.d.mts","sourceRoot":"","sources":["../src/ProfileMetricsController.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EACV,mCAAmC,EACnC,qCAAqC,EACrC,gCAAgC,EACjC,sCAAsC;AACvC,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AAEtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,8CAA8C,EAAE,yCAAyC;AAGlG,OAAO,KAAK,EAAE,kCAAkC,EAAE,oBAAU;AAC5D,OAAO,KAAK,EAAE,qCAAqC,EAAE,oBAAU;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAgC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,cAAc,6BAA6B,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,8BAA8B,QAAiB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC/C;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AA0BF;;;;;;;GAOG;AACH,wBAAgB,uCAAuC,IAAI,6BAA6B,CAKvF;AAID;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,sCAAsC,GACtC,qCAAqC,CAAC;AAE1C;;GAEG;AACH,KAAK,cAAc,GACf,kCAAkC,GAClC,gCAAgC,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;;GAGG;AACH,KAAK,aAAa,GACd,4BAA4B,GAC5B,0BAA0B,GAC1B,mCAAmC,GACnC,qCAAqC,GACrC,8CAA8C,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;;;;;;;;;;;;;;;;AAEF,qBAAa,wBAAyB,SAAQ,8BAC5C,OAAO,cAAc,EACrB,6BAA6B,EAC7B,iCAAiC,CAClC;;IASC;;;;;;;;;;;;;;;;OAgBG;gBACS,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,QAAoB,EACpB,oBAAqD,GACtD,EAAE;QACD,SAAS,EAAE,iCAAiC,CAAC;QAC7C,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;QAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,iBAAiB,EAAE,MAAM,OAAO,CAAC;QACjC,gBAAgB,EAAE,MAAM,MAAM,CAAC;QAC/B,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC/B;IAiDD;;;OAGG;IACH,gBAAgB,IAAI,IAAI;IAMxB;;;;;;;;OAQG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAsIpC"}
+{"version":3,"file":"ProfileMetricsController.d.mts","sourceRoot":"","sources":["../src/ProfileMetricsController.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EACV,mCAAmC,EACnC,qCAAqC,EACrC,gCAAgC,EACjC,sCAAsC;AACvC,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AAEtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,8CAA8C,EAAE,yCAAyC;AAIlG,OAAO,KAAK,EAAE,kCAAkC,EAAE,oBAAU;AAC5D,OAAO,KAAK,EAAE,qCAAqC,EAAE,oBAAU;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAgC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,cAAc,6BAA6B,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,8BAA8B,QAG1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;OAGG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC/C;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AA0BF;;;;;;;GAOG;AACH,wBAAgB,uCAAuC,IAAI,6BAA6B,CAKvF;AAID;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,sCAAsC,GACtC,qCAAqC,CAAC;AAE1C;;GAEG;AACH,KAAK,cAAc,GACf,kCAAkC,GAClC,gCAAgC,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;;GAGG;AACH,KAAK,aAAa,GACd,4BAA4B,GAC5B,0BAA0B,GAC1B,mCAAmC,GACnC,qCAAqC,GACrC,8CAA8C,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;;;;;;;;;;;;;;;;AAEF,qBAAa,wBAAyB,SAAQ,8BAC5C,OAAO,cAAc,EACrB,6BAA6B,EAC7B,iCAAiC,CAClC;;IASC;;;;;;;;;;;;;;;;OAgBG;gBACS,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,QAAoB,EACpB,oBAAqD,GACtD,EAAE;QACD,SAAS,EAAE,iCAAiC,CAAC;QAC7C,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;QAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,iBAAiB,EAAE,MAAM,OAAO,CAAC;QACjC,gBAAgB,EAAE,MAAM,MAAM,CAAC;QAC/B,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC/B;IAmDD;;;OAGG;IACH,gBAAgB,IAAI,IAAI;IAMxB;;;;;;;;OAQG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAkIpC"}

package/dist/ProfileMetricsController.mjs

@@ -11,6 +11,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _ProfileMetricsController_instances, _ProfileMetricsController_mutex, _ProfileMetricsController_assertUserOptedIn, _ProfileMetricsController_getMetaMetricsId, _ProfileMetricsController_initialDelayDuration, _ProfileMetricsController_queueFirstSyncIfNeeded, _ProfileMetricsController_setInitialDelayEndTimestampIfNull, _ProfileMetricsController_isInitialDelayComplete, _ProfileMetricsController_addAccountToQueue, _ProfileMetricsController_removeAccountFromQueue;
 import { StaticIntervalPollingController } from "@metamask/polling-controller";
+import { Duration, inMilliseconds } from "@metamask/utils";
 import { Mutex } from "async-mutex";
 /**
  * The name of the {@link ProfileMetricsController}, used to namespace the
@@ -19,9 +20,9 @@ import { Mutex } from "async-mutex";
  */
 export const controllerName = 'ProfileMetricsController';
 /**
- * The default delay duration before data is sent for the first time, in milliseconds.
+ * The default delay duration before data is sent for the first time.
  */
-export const DEFAULT_INITIAL_DELAY_DURATION = 10 * 60 * 1000; // 10 minutes
+export const DEFAULT_INITIAL_DELAY_DURATION = inMilliseconds(10, Duration.Minute);
 /**
  * The metadata for each property in {@link ProfileMetricsControllerState}.
  */
@@ -103,7 +104,7 @@ export class ProfileMetricsController extends StaticIntervalPollingController()
                 // it must have opted in during onboarding, or during a previous session.
                 this.skipInitialDelay();
             }
-            __classPrivateFieldGet(this, _ProfileMetricsController_instances, "m", _ProfileMetricsController_queueFirstSyncIfNeeded).call(this).catch(console.error);
+            __classPrivateFieldGet(this, _ProfileMetricsController_instances, "m", _ProfileMetricsController_queueFirstSyncIfNeeded).call(this).catch(this.messenger.captureException ?? console.error);
             this.startPolling(null);
         });
         this.messenger.subscribe('KeyringController:lock', () => this.stopAllPolling());
@@ -191,14 +192,8 @@ async function _ProfileMetricsController_queueFirstSyncIfNeeded() {
         state.initialDelayEndTimestamp ?? (state.initialDelayEndTimestamp = Date.now() + __classPrivateFieldGet(this, _ProfileMetricsController_initialDelayDuration, "f"));
     });
 }, _ProfileMetricsController_isInitialDelayComplete = function _ProfileMetricsController_isInitialDelayComplete() {
-    // The following check should never be true due to the initialization logic,
-    // as the `initialDelayEndTimestamp` is always set in the constructor,
-    // but is included for type safety. Ignoring for code coverage purposes.
-    // istanbul ignore if
-    if (this.state.initialDelayEndTimestamp === undefined) {
-        return false;
-    }
-    return Date.now() >= this.state.initialDelayEndTimestamp;
+    return (this.state.initialDelayEndTimestamp !== undefined &&
+        Date.now() >= this.state.initialDelayEndTimestamp);
 }, _ProfileMetricsController_addAccountToQueue = 
 /**
  * Queue the given account to be synced at the next poll.

package/dist/ProfileMetricsController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ProfileMetricsController.mjs","sourceRoot":"","sources":["../src/ProfileMetricsController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAgBA,OAAO,EAAE,+BAA+B,EAAE,qCAAqC;AAE/E,OAAO,EAAE,KAAK,EAAE,oBAAoB;AAMpC;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAEzD;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;AAwB3E;;GAEG;AACH,MAAM,gCAAgC,GAAG;IACvC,uBAAuB,EAAE;QACvB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;IACD,SAAS,EAAE;QACT,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;IACD,wBAAwB,EAAE;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;CACqD,CAAC;AAEzD;;;;;;;GAOG;AACH,MAAM,UAAU,uCAAuC;IACrD,OAAO;QACL,uBAAuB,EAAE,KAAK;QAC9B,SAAS,EAAE,EAAE;KACd,CAAC;AACJ,CAAC;AAED,MAAM,yBAAyB,GAAG,CAAC,kBAAkB,CAAU,CAAC;AA4DhE,MAAM,OAAO,wBAAyB,SAAQ,+BAA+B,EAI5E;IASC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,GAAG,EAAE,GAAG,IAAI,EACpB,oBAAoB,GAAG,8BAA8B,GAQtD;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,gCAAgC;YAC1C,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,GAAG,uCAAuC,EAAE;gBAC5C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAhDI,0CAAS,IAAI,KAAK,EAAE,EAAC;QAErB,8DAAkC;QAElC,6DAAgC;QAEhC,iEAA8B;QA4CrC,uBAAA,IAAI,+CAAsB,iBAAiB,MAAA,CAAC;QAC5C,uBAAA,IAAI,8CAAqB,gBAAgB,MAAA,CAAC;QAC1C,uBAAA,IAAI,kDAAyB,oBAAoB,MAAA,CAAC;QAElD,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;YACxD,IAAI,uBAAA,IAAI,mDAAmB,MAAvB,IAAI,CAAqB,EAAE,CAAC;gBAC9B,gEAAgE;gBAChE,yEAAyE;gBACzE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,CAAC;YACD,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACpD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE,CACtD,IAAI,CAAC,cAAc,EAAE,CACtB,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,4CAA4C,EAAE,GAAG,EAAE,CAC1E,IAAI,CAAC,gBAAgB,EAAE,CACxB,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,iCAAiC,EAAE,CAAC,OAAO,EAAE,EAAE;YACtE,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,mCAAmC,EAAE,CAAC,OAAO,EAAE,EAAE;YACxE,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,EAAyB,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,gBAAgB;QACd,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,wBAAwB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACxC,IAAI,CAAC,uBAAA,IAAI,mDAAmB,MAAvB,IAAI,CAAqB,EAAE,CAAC;gBAC/B,OAAO;YACT,CAAC;YACD,uBAAA,IAAI,wGAAmC,MAAvC,IAAI,CAAqC,CAAC;YAC1C,IAAI,CAAC,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,EAAE,CAAC;gBACpC,OAAO;YACT,CAAC;YACD,KAAK,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CACtD,IAAI,CAAC,KAAK,CAAC,SAAS,CACrB,EAAE,CAAC;gBACF,IAAI,CAAC;oBACH,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,qCAAqC,EAAE;wBAC/D,aAAa,EAAE,uBAAA,IAAI,kDAAkB,MAAtB,IAAI,CAAoB;wBACvC,eAAe,EACb,eAAe,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,eAAe;wBACrD,QAAQ;qBACT,CAAC,CAAC;oBACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,OAAO,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;oBAC1C,CAAC,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,kEAAkE;oBAClE,OAAO,CAAC,KAAK,CACX,0DAA0D,eAAe,GAAG,EAC5E,KAAK,CACN,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CAuGF;;AArGC;;;;;GAKG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,IAAI,CAAC,KAAK,CAAC,uBAAuB,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QACD,MAAM,kBAAkB,GAAG,8BAA8B,CACvD,MAAM,CAAC,MAAM,CACX,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,gBAAgB;aAChE,QAAQ,CACZ,CACF,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBAClD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC1B,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;gBAC5B,CAAC;gBACD,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;YACxD,CAAC;YACD,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;IAMC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,wBAAwB,KAA9B,KAAK,CAAC,wBAAwB,GAC5B,IAAI,CAAC,GAAG,EAAE,GAAG,uBAAA,IAAI,sDAAsB,EAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC;IAQC,4EAA4E;IAC5E,sEAAsE;IACtE,wEAAwE;IACxE,qBAAqB;IACrB,IAAI,IAAI,CAAC,KAAK,CAAC,wBAAwB,KAAK,SAAS,EAAE,CAAC;QACtD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC;AAC3D,CAAC;AAED;;;;GAIG;AACH,KAAK,sDAAoB,OAAwB;IAC/C,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,eAAe,GAAG,yBAAyB,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC;YACrE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC;gBACtC,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC;YACxC,CAAC;YACD,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC;gBACpC,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,KAAK,2DAAyB,OAAe;IAC3C,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAC9D,KAAK,CAAC,SAAS,CAChB,EAAE,CAAC;gBACF,MAAM,KAAK,GAAG,gBAAgB,CAAC,SAAS,CACtC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,KAAK,OAAO,CACrC,CAAC;gBACF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;oBACjB,SAAS;gBACX,CAAC;gBACD,gBAAgB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBAClC,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAClC,OAAO,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;gBAC1C,CAAC;gBACD,MAAM;YACR,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAGH;;;;;GAKG;AACH,SAAS,yBAAyB,CAAC,OAAwB;IACzD,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,KAAK,UAAU,EAAE,CAAC;QACjD,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;IACpC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAS,8BAA8B,CACrC,QAA2B;IAE3B,OAAO,QAAQ,CAAC,MAAM,CACpB,CAAC,MAA2C,EAAE,OAAO,EAAE,EAAE;QACvD,MAAM,eAAe,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;QAC3D,MAAM,GAAG,GAAG,eAAe,IAAI,MAAM,CAAC;QACtC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACjB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;QACnB,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACvE,OAAO,MAAM,CAAC;IAChB,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC","sourcesContent":["import type {\n  AccountsControllerAccountAddedEvent,\n  AccountsControllerAccountRemovedEvent,\n  AccountsControllerGetStateAction,\n} from '@metamask/accounts-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport type {\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { Messenger } from '@metamask/messenger';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport { TransactionControllerTransactionSubmittedEvent } from '@metamask/transaction-controller';\nimport { Mutex } from 'async-mutex';\n\nimport type { ProfileMetricsServiceMethodActions } from '.';\nimport type { ProfileMetricsControllerMethodActions } from '.';\nimport type { AccountWithScopes } from './ProfileMetricsService';\n\n/**\n * The name of the {@link ProfileMetricsController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'ProfileMetricsController';\n\n/**\n * The default delay duration before data is sent for the first time, in milliseconds.\n */\nexport const DEFAULT_INITIAL_DELAY_DURATION = 10 * 60 * 1000; // 10 minutes\n\n/**\n * Describes the shape of the state object for {@link ProfileMetricsController}.\n */\nexport type ProfileMetricsControllerState = {\n  /**\n   * Whether existing accounts have been added\n   * to the queue.\n   */\n  initialEnqueueCompleted: boolean;\n  /**\n   * The queue of accounts to be synced.\n   * Each key is an entropy source ID, and each value is an array of account\n   * addresses associated with that entropy source. Accounts with no entropy\n   * source ID are grouped under the key \"null\".\n   */\n  syncQueue: Record<string, AccountWithScopes[]>;\n  /**\n   * The timestamp when the first data sending can be attempted.\n   */\n  initialDelayEndTimestamp?: number;\n};\n\n/**\n * The metadata for each property in {@link ProfileMetricsControllerState}.\n */\nconst profileMetricsControllerMetadata = {\n  initialEnqueueCompleted: {\n    persist: true,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n  syncQueue: {\n    persist: true,\n    includeInDebugSnapshot: false,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n  initialDelayEndTimestamp: {\n    persist: true,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n} satisfies StateMetadata<ProfileMetricsControllerState>;\n\n/**\n * Constructs the default {@link ProfileMetricsController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link ProfileMetricsController} state.\n */\nexport function getDefaultProfileMetricsControllerState(): ProfileMetricsControllerState {\n  return {\n    initialEnqueueCompleted: false,\n    syncQueue: {},\n  };\n}\n\nconst MESSENGER_EXPOSED_METHODS = ['skipInitialDelay'] as const;\n\n/**\n * Retrieves the state of the {@link ProfileMetricsController}.\n */\nexport type ProfileMetricsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  ProfileMetricsControllerState\n>;\n\n/**\n * Actions that {@link ProfileMetricsControllerMessenger} exposes to other consumers.\n */\nexport type ProfileMetricsControllerActions =\n  | ProfileMetricsControllerGetStateAction\n  | ProfileMetricsControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link ProfileMetricsControllerMessenger} calls.\n */\ntype AllowedActions =\n  | ProfileMetricsServiceMethodActions\n  | AccountsControllerGetStateAction;\n\n/**\n * Published when the state of {@link ProfileMetricsController} changes.\n */\nexport type ProfileMetricsControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    ProfileMetricsControllerState\n  >;\n\n/**\n * Events that {@link ProfileMetricsControllerMessenger} exposes to other consumers.\n */\nexport type ProfileMetricsControllerEvents =\n  ProfileMetricsControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link ProfileMetricsControllerMessenger} subscribes\n * to.\n */\ntype AllowedEvents =\n  | KeyringControllerUnlockEvent\n  | KeyringControllerLockEvent\n  | AccountsControllerAccountAddedEvent\n  | AccountsControllerAccountRemovedEvent\n  | TransactionControllerTransactionSubmittedEvent;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link ProfileMetricsController}.\n */\nexport type ProfileMetricsControllerMessenger = Messenger<\n  typeof controllerName,\n  ProfileMetricsControllerActions | AllowedActions,\n  ProfileMetricsControllerEvents | AllowedEvents\n>;\n\nexport class ProfileMetricsController extends StaticIntervalPollingController()<\n  typeof controllerName,\n  ProfileMetricsControllerState,\n  ProfileMetricsControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  readonly #assertUserOptedIn: () => boolean;\n\n  readonly #getMetaMetricsId: () => string;\n\n  readonly #initialDelayDuration: number;\n\n  /**\n   * Constructs a new {@link ProfileMetricsController}.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.state - The desired state with which to initialize this\n   * controller. Missing properties will be filled in with defaults.\n   * @param args.assertUserOptedIn - A function that asserts whether the user has\n   * opted in to user profile features. If the user has not opted in, sync\n   * operations will be no-ops.\n   * @param args.getMetaMetricsId - A function that returns the MetaMetrics ID\n   * of the user.\n   * @param args.interval - The interval, in milliseconds, at which the controller will\n   * attempt to send user profile data. Defaults to 10 seconds.\n   * @param args.initialDelayDuration - The delay duration before data is sent\n   * for the first time, in milliseconds. Defaults to 10 minutes.\n   */\n  constructor({\n    messenger,\n    state,\n    assertUserOptedIn,\n    getMetaMetricsId,\n    interval = 10 * 1000,\n    initialDelayDuration = DEFAULT_INITIAL_DELAY_DURATION,\n  }: {\n    messenger: ProfileMetricsControllerMessenger;\n    state?: Partial<ProfileMetricsControllerState>;\n    interval?: number;\n    assertUserOptedIn: () => boolean;\n    getMetaMetricsId: () => string;\n    initialDelayDuration?: number;\n  }) {\n    super({\n      messenger,\n      metadata: profileMetricsControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultProfileMetricsControllerState(),\n        ...state,\n      },\n    });\n\n    this.#assertUserOptedIn = assertUserOptedIn;\n    this.#getMetaMetricsId = getMetaMetricsId;\n    this.#initialDelayDuration = initialDelayDuration;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    this.messenger.subscribe('KeyringController:unlock', () => {\n      if (this.#assertUserOptedIn()) {\n        // If the user has already opted in at the start of the session,\n        // it must have opted in during onboarding, or during a previous session.\n        this.skipInitialDelay();\n      }\n      this.#queueFirstSyncIfNeeded().catch(console.error);\n      this.startPolling(null);\n    });\n\n    this.messenger.subscribe('KeyringController:lock', () =>\n      this.stopAllPolling(),\n    );\n\n    this.messenger.subscribe('TransactionController:transactionSubmitted', () =>\n      this.skipInitialDelay(),\n    );\n\n    this.messenger.subscribe('AccountsController:accountAdded', (account) => {\n      this.#addAccountToQueue(account).catch(console.error);\n    });\n\n    this.messenger.subscribe('AccountsController:accountRemoved', (account) => {\n      this.#removeAccountFromQueue(account).catch(console.error);\n    });\n\n    this.setIntervalLength(interval);\n  }\n\n  /**\n   * Skip the initial delay period by setting the end timestamp to the current time.\n   * Metrics will be sent on the next poll.\n   */\n  skipInitialDelay(): void {\n    this.update((state) => {\n      state.initialDelayEndTimestamp = Date.now();\n    });\n  }\n\n  /**\n   * Execute a single poll to sync user profile data.\n   *\n   * The queued accounts are sent to the ProfileMetricsService, and the sync\n   * queue is cleared. This operation is mutexed to prevent concurrent\n   * executions.\n   *\n   * @returns A promise that resolves when the poll is complete.\n   */\n  async _executePoll(): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      if (!this.#assertUserOptedIn()) {\n        return;\n      }\n      this.#setInitialDelayEndTimestampIfNull();\n      if (!this.#isInitialDelayComplete()) {\n        return;\n      }\n      for (const [entropySourceId, accounts] of Object.entries(\n        this.state.syncQueue,\n      )) {\n        try {\n          await this.messenger.call('ProfileMetricsService:submitMetrics', {\n            metametricsId: this.#getMetaMetricsId(),\n            entropySourceId:\n              entropySourceId === 'null' ? null : entropySourceId,\n            accounts,\n          });\n          this.update((state) => {\n            delete state.syncQueue[entropySourceId];\n          });\n        } catch (error) {\n          // We want to log the error but continue processing other batches.\n          console.error(\n            `Failed to submit profile metrics for entropy source ID ${entropySourceId}:`,\n            error,\n          );\n        }\n      }\n    });\n  }\n\n  /**\n   * Add existing accounts to the sync queue if it has not been done yet.\n   *\n   * This method ensures that the first sync is only executed once,\n   * and only if the user has opted in to user profile features.\n   */\n  async #queueFirstSyncIfNeeded(): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      if (this.state.initialEnqueueCompleted) {\n        return;\n      }\n      const newGroupedAccounts = groupAccountsByEntropySourceId(\n        Object.values(\n          this.messenger.call('AccountsController:getState').internalAccounts\n            .accounts,\n        ),\n      );\n      this.update((state) => {\n        for (const key of Object.keys(newGroupedAccounts)) {\n          if (!state.syncQueue[key]) {\n            state.syncQueue[key] = [];\n          }\n          state.syncQueue[key].push(...newGroupedAccounts[key]);\n        }\n        state.initialEnqueueCompleted = true;\n      });\n    });\n  }\n\n  /**\n   * Set the initial delay end timestamp if it is not already set.\n   */\n  #setInitialDelayEndTimestampIfNull(): void {\n    this.update((state) => {\n      state.initialDelayEndTimestamp ??=\n        Date.now() + this.#initialDelayDuration;\n    });\n  }\n\n  /**\n   * Check if the initial delay end timestamp is in the past.\n   *\n   * @returns True if the initial delay period has completed, false otherwise.\n   */\n  #isInitialDelayComplete(): boolean {\n    // The following check should never be true due to the initialization logic,\n    // as the `initialDelayEndTimestamp` is always set in the constructor,\n    // but is included for type safety. Ignoring for code coverage purposes.\n    // istanbul ignore if\n    if (this.state.initialDelayEndTimestamp === undefined) {\n      return false;\n    }\n    return Date.now() >= this.state.initialDelayEndTimestamp;\n  }\n\n  /**\n   * Queue the given account to be synced at the next poll.\n   *\n   * @param account - The account to sync.\n   */\n  async #addAccountToQueue(account: InternalAccount): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      this.update((state) => {\n        const entropySourceId = getAccountEntropySourceId(account) ?? 'null';\n        if (!state.syncQueue[entropySourceId]) {\n          state.syncQueue[entropySourceId] = [];\n        }\n        state.syncQueue[entropySourceId].push({\n          address: account.address,\n          scopes: account.scopes,\n        });\n      });\n    });\n  }\n\n  /**\n   * Remove the given account from the sync queue.\n   *\n   * @param account - The account address to remove.\n   */\n  async #removeAccountFromQueue(account: string): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      this.update((state) => {\n        for (const [entropySourceId, groupedAddresses] of Object.entries(\n          state.syncQueue,\n        )) {\n          const index = groupedAddresses.findIndex(\n            ({ address }) => address === account,\n          );\n          if (index === -1) {\n            continue;\n          }\n          groupedAddresses.splice(index, 1);\n          if (groupedAddresses.length === 0) {\n            delete state.syncQueue[entropySourceId];\n          }\n          break;\n        }\n      });\n    });\n  }\n}\n\n/**\n * Retrieves the entropy source ID from the given account, if it exists.\n *\n * @param account - The account from which to retrieve the entropy source ID.\n * @returns The entropy source ID, or null if it does not exist.\n */\nfunction getAccountEntropySourceId(account: InternalAccount): string | null {\n  if (account.options.entropy?.type === 'mnemonic') {\n    return account.options.entropy.id;\n  }\n  return null;\n}\n\n/**\n * Groups accounts by their entropy source ID.\n *\n * @param accounts - The accounts to group.\n * @returns An object where each key is an entropy source ID and each value is\n * an array of account addresses associated with that entropy source ID.\n */\nfunction groupAccountsByEntropySourceId(\n  accounts: InternalAccount[],\n): Record<string, AccountWithScopes[]> {\n  return accounts.reduce(\n    (result: Record<string, AccountWithScopes[]>, account) => {\n      const entropySourceId = getAccountEntropySourceId(account);\n      const key = entropySourceId ?? 'null';\n      if (!result[key]) {\n        result[key] = [];\n      }\n      result[key].push({ address: account.address, scopes: account.scopes });\n      return result;\n    },\n    {},\n  );\n}\n"]}
+{"version":3,"file":"ProfileMetricsController.mjs","sourceRoot":"","sources":["../src/ProfileMetricsController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAgBA,OAAO,EAAE,+BAA+B,EAAE,qCAAqC;AAE/E,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,wBAAwB;AAC3D,OAAO,EAAE,KAAK,EAAE,oBAAoB;AAMpC;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAEzD;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,cAAc,CAC1D,EAAE,EACF,QAAQ,CAAC,MAAM,CAChB,CAAC;AAwBF;;GAEG;AACH,MAAM,gCAAgC,GAAG;IACvC,uBAAuB,EAAE;QACvB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;IACD,SAAS,EAAE;QACT,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;IACD,wBAAwB,EAAE;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;CACqD,CAAC;AAEzD;;;;;;;GAOG;AACH,MAAM,UAAU,uCAAuC;IACrD,OAAO;QACL,uBAAuB,EAAE,KAAK;QAC9B,SAAS,EAAE,EAAE;KACd,CAAC;AACJ,CAAC;AAED,MAAM,yBAAyB,GAAG,CAAC,kBAAkB,CAAU,CAAC;AA4DhE,MAAM,OAAO,wBAAyB,SAAQ,+BAA+B,EAI5E;IASC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,GAAG,EAAE,GAAG,IAAI,EACpB,oBAAoB,GAAG,8BAA8B,GAQtD;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,gCAAgC;YAC1C,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,GAAG,uCAAuC,EAAE;gBAC5C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAhDI,0CAAS,IAAI,KAAK,EAAE,EAAC;QAErB,8DAAkC;QAElC,6DAAgC;QAEhC,iEAA8B;QA4CrC,uBAAA,IAAI,+CAAsB,iBAAiB,MAAA,CAAC;QAC5C,uBAAA,IAAI,8CAAqB,gBAAgB,MAAA,CAAC;QAC1C,uBAAA,IAAI,kDAAyB,oBAAoB,MAAA,CAAC;QAElD,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;YACxD,IAAI,uBAAA,IAAI,mDAAmB,MAAvB,IAAI,CAAqB,EAAE,CAAC;gBAC9B,gEAAgE;gBAChE,yEAAyE;gBACzE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,CAAC;YACD,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,CAAC,KAAK,CAClC,IAAI,CAAC,SAAS,CAAC,gBAAgB,IAAI,OAAO,CAAC,KAAK,CACjD,CAAC;YACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE,CACtD,IAAI,CAAC,cAAc,EAAE,CACtB,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,4CAA4C,EAAE,GAAG,EAAE,CAC1E,IAAI,CAAC,gBAAgB,EAAE,CACxB,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,iCAAiC,EAAE,CAAC,OAAO,EAAE,EAAE;YACtE,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,mCAAmC,EAAE,CAAC,OAAO,EAAE,EAAE;YACxE,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,EAAyB,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,gBAAgB;QACd,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,wBAAwB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACxC,IAAI,CAAC,uBAAA,IAAI,mDAAmB,MAAvB,IAAI,CAAqB,EAAE,CAAC;gBAC/B,OAAO;YACT,CAAC;YACD,uBAAA,IAAI,wGAAmC,MAAvC,IAAI,CAAqC,CAAC;YAC1C,IAAI,CAAC,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,EAAE,CAAC;gBACpC,OAAO;YACT,CAAC;YACD,KAAK,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CACtD,IAAI,CAAC,KAAK,CAAC,SAAS,CACrB,EAAE,CAAC;gBACF,IAAI,CAAC;oBACH,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,qCAAqC,EAAE;wBAC/D,aAAa,EAAE,uBAAA,IAAI,kDAAkB,MAAtB,IAAI,CAAoB;wBACvC,eAAe,EACb,eAAe,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,eAAe;wBACrD,QAAQ;qBACT,CAAC,CAAC;oBACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,OAAO,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;oBAC1C,CAAC,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,kEAAkE;oBAClE,OAAO,CAAC,KAAK,CACX,0DAA0D,eAAe,GAAG,EAC5E,KAAK,CACN,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CAmGF;;AAjGC;;;;;GAKG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,IAAI,CAAC,KAAK,CAAC,uBAAuB,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QACD,MAAM,kBAAkB,GAAG,8BAA8B,CACvD,MAAM,CAAC,MAAM,CACX,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,gBAAgB;aAChE,QAAQ,CACZ,CACF,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBAClD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC1B,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;gBAC5B,CAAC;gBACD,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;YACxD,CAAC;YACD,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;IAMC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,wBAAwB,KAA9B,KAAK,CAAC,wBAAwB,GAC5B,IAAI,CAAC,GAAG,EAAE,GAAG,uBAAA,IAAI,sDAAsB,EAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC;IAQC,OAAO,CACL,IAAI,CAAC,KAAK,CAAC,wBAAwB,KAAK,SAAS;QACjD,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAClD,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,KAAK,sDAAoB,OAAwB;IAC/C,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,eAAe,GAAG,yBAAyB,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC;YACrE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC;gBACtC,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC;YACxC,CAAC;YACD,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC;gBACpC,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,KAAK,2DAAyB,OAAe;IAC3C,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAC9D,KAAK,CAAC,SAAS,CAChB,EAAE,CAAC;gBACF,MAAM,KAAK,GAAG,gBAAgB,CAAC,SAAS,CACtC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,KAAK,OAAO,CACrC,CAAC;gBACF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;oBACjB,SAAS;gBACX,CAAC;gBACD,gBAAgB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBAClC,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAClC,OAAO,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;gBAC1C,CAAC;gBACD,MAAM;YACR,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAGH;;;;;GAKG;AACH,SAAS,yBAAyB,CAAC,OAAwB;IACzD,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,KAAK,UAAU,EAAE,CAAC;QACjD,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;IACpC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAS,8BAA8B,CACrC,QAA2B;IAE3B,OAAO,QAAQ,CAAC,MAAM,CACpB,CAAC,MAA2C,EAAE,OAAO,EAAE,EAAE;QACvD,MAAM,eAAe,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;QAC3D,MAAM,GAAG,GAAG,eAAe,IAAI,MAAM,CAAC;QACtC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACjB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;QACnB,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACvE,OAAO,MAAM,CAAC;IAChB,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC","sourcesContent":["import type {\n  AccountsControllerAccountAddedEvent,\n  AccountsControllerAccountRemovedEvent,\n  AccountsControllerGetStateAction,\n} from '@metamask/accounts-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport type {\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport type { Messenger } from '@metamask/messenger';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport { TransactionControllerTransactionSubmittedEvent } from '@metamask/transaction-controller';\nimport { Duration, inMilliseconds } from '@metamask/utils';\nimport { Mutex } from 'async-mutex';\n\nimport type { ProfileMetricsServiceMethodActions } from '.';\nimport type { ProfileMetricsControllerMethodActions } from '.';\nimport type { AccountWithScopes } from './ProfileMetricsService';\n\n/**\n * The name of the {@link ProfileMetricsController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'ProfileMetricsController';\n\n/**\n * The default delay duration before data is sent for the first time.\n */\nexport const DEFAULT_INITIAL_DELAY_DURATION = inMilliseconds(\n  10,\n  Duration.Minute,\n);\n\n/**\n * Describes the shape of the state object for {@link ProfileMetricsController}.\n */\nexport type ProfileMetricsControllerState = {\n  /**\n   * Whether existing accounts have been added\n   * to the queue.\n   */\n  initialEnqueueCompleted: boolean;\n  /**\n   * The queue of accounts to be synced.\n   * Each key is an entropy source ID, and each value is an array of account\n   * addresses associated with that entropy source. Accounts with no entropy\n   * source ID are grouped under the key \"null\".\n   */\n  syncQueue: Record<string, AccountWithScopes[]>;\n  /**\n   * The timestamp when the first data sending can be attempted.\n   */\n  initialDelayEndTimestamp?: number;\n};\n\n/**\n * The metadata for each property in {@link ProfileMetricsControllerState}.\n */\nconst profileMetricsControllerMetadata = {\n  initialEnqueueCompleted: {\n    persist: true,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n  syncQueue: {\n    persist: true,\n    includeInDebugSnapshot: false,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n  initialDelayEndTimestamp: {\n    persist: true,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n} satisfies StateMetadata<ProfileMetricsControllerState>;\n\n/**\n * Constructs the default {@link ProfileMetricsController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link ProfileMetricsController} state.\n */\nexport function getDefaultProfileMetricsControllerState(): ProfileMetricsControllerState {\n  return {\n    initialEnqueueCompleted: false,\n    syncQueue: {},\n  };\n}\n\nconst MESSENGER_EXPOSED_METHODS = ['skipInitialDelay'] as const;\n\n/**\n * Retrieves the state of the {@link ProfileMetricsController}.\n */\nexport type ProfileMetricsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  ProfileMetricsControllerState\n>;\n\n/**\n * Actions that {@link ProfileMetricsControllerMessenger} exposes to other consumers.\n */\nexport type ProfileMetricsControllerActions =\n  | ProfileMetricsControllerGetStateAction\n  | ProfileMetricsControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link ProfileMetricsControllerMessenger} calls.\n */\ntype AllowedActions =\n  | ProfileMetricsServiceMethodActions\n  | AccountsControllerGetStateAction;\n\n/**\n * Published when the state of {@link ProfileMetricsController} changes.\n */\nexport type ProfileMetricsControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    ProfileMetricsControllerState\n  >;\n\n/**\n * Events that {@link ProfileMetricsControllerMessenger} exposes to other consumers.\n */\nexport type ProfileMetricsControllerEvents =\n  ProfileMetricsControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link ProfileMetricsControllerMessenger} subscribes\n * to.\n */\ntype AllowedEvents =\n  | KeyringControllerUnlockEvent\n  | KeyringControllerLockEvent\n  | AccountsControllerAccountAddedEvent\n  | AccountsControllerAccountRemovedEvent\n  | TransactionControllerTransactionSubmittedEvent;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link ProfileMetricsController}.\n */\nexport type ProfileMetricsControllerMessenger = Messenger<\n  typeof controllerName,\n  ProfileMetricsControllerActions | AllowedActions,\n  ProfileMetricsControllerEvents | AllowedEvents\n>;\n\nexport class ProfileMetricsController extends StaticIntervalPollingController()<\n  typeof controllerName,\n  ProfileMetricsControllerState,\n  ProfileMetricsControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  readonly #assertUserOptedIn: () => boolean;\n\n  readonly #getMetaMetricsId: () => string;\n\n  readonly #initialDelayDuration: number;\n\n  /**\n   * Constructs a new {@link ProfileMetricsController}.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.state - The desired state with which to initialize this\n   * controller. Missing properties will be filled in with defaults.\n   * @param args.assertUserOptedIn - A function that asserts whether the user has\n   * opted in to user profile features. If the user has not opted in, sync\n   * operations will be no-ops.\n   * @param args.getMetaMetricsId - A function that returns the MetaMetrics ID\n   * of the user.\n   * @param args.interval - The interval, in milliseconds, at which the controller will\n   * attempt to send user profile data. Defaults to 10 seconds.\n   * @param args.initialDelayDuration - The delay duration before data is sent\n   * for the first time, in milliseconds. Defaults to 10 minutes.\n   */\n  constructor({\n    messenger,\n    state,\n    assertUserOptedIn,\n    getMetaMetricsId,\n    interval = 10 * 1000,\n    initialDelayDuration = DEFAULT_INITIAL_DELAY_DURATION,\n  }: {\n    messenger: ProfileMetricsControllerMessenger;\n    state?: Partial<ProfileMetricsControllerState>;\n    interval?: number;\n    assertUserOptedIn: () => boolean;\n    getMetaMetricsId: () => string;\n    initialDelayDuration?: number;\n  }) {\n    super({\n      messenger,\n      metadata: profileMetricsControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultProfileMetricsControllerState(),\n        ...state,\n      },\n    });\n\n    this.#assertUserOptedIn = assertUserOptedIn;\n    this.#getMetaMetricsId = getMetaMetricsId;\n    this.#initialDelayDuration = initialDelayDuration;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    this.messenger.subscribe('KeyringController:unlock', () => {\n      if (this.#assertUserOptedIn()) {\n        // If the user has already opted in at the start of the session,\n        // it must have opted in during onboarding, or during a previous session.\n        this.skipInitialDelay();\n      }\n      this.#queueFirstSyncIfNeeded().catch(\n        this.messenger.captureException ?? console.error,\n      );\n      this.startPolling(null);\n    });\n\n    this.messenger.subscribe('KeyringController:lock', () =>\n      this.stopAllPolling(),\n    );\n\n    this.messenger.subscribe('TransactionController:transactionSubmitted', () =>\n      this.skipInitialDelay(),\n    );\n\n    this.messenger.subscribe('AccountsController:accountAdded', (account) => {\n      this.#addAccountToQueue(account).catch(console.error);\n    });\n\n    this.messenger.subscribe('AccountsController:accountRemoved', (account) => {\n      this.#removeAccountFromQueue(account).catch(console.error);\n    });\n\n    this.setIntervalLength(interval);\n  }\n\n  /**\n   * Skip the initial delay period by setting the end timestamp to the current time.\n   * Metrics will be sent on the next poll.\n   */\n  skipInitialDelay(): void {\n    this.update((state) => {\n      state.initialDelayEndTimestamp = Date.now();\n    });\n  }\n\n  /**\n   * Execute a single poll to sync user profile data.\n   *\n   * The queued accounts are sent to the ProfileMetricsService, and the sync\n   * queue is cleared. This operation is mutexed to prevent concurrent\n   * executions.\n   *\n   * @returns A promise that resolves when the poll is complete.\n   */\n  async _executePoll(): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      if (!this.#assertUserOptedIn()) {\n        return;\n      }\n      this.#setInitialDelayEndTimestampIfNull();\n      if (!this.#isInitialDelayComplete()) {\n        return;\n      }\n      for (const [entropySourceId, accounts] of Object.entries(\n        this.state.syncQueue,\n      )) {\n        try {\n          await this.messenger.call('ProfileMetricsService:submitMetrics', {\n            metametricsId: this.#getMetaMetricsId(),\n            entropySourceId:\n              entropySourceId === 'null' ? null : entropySourceId,\n            accounts,\n          });\n          this.update((state) => {\n            delete state.syncQueue[entropySourceId];\n          });\n        } catch (error) {\n          // We want to log the error but continue processing other batches.\n          console.error(\n            `Failed to submit profile metrics for entropy source ID ${entropySourceId}:`,\n            error,\n          );\n        }\n      }\n    });\n  }\n\n  /**\n   * Add existing accounts to the sync queue if it has not been done yet.\n   *\n   * This method ensures that the first sync is only executed once,\n   * and only if the user has opted in to user profile features.\n   */\n  async #queueFirstSyncIfNeeded(): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      if (this.state.initialEnqueueCompleted) {\n        return;\n      }\n      const newGroupedAccounts = groupAccountsByEntropySourceId(\n        Object.values(\n          this.messenger.call('AccountsController:getState').internalAccounts\n            .accounts,\n        ),\n      );\n      this.update((state) => {\n        for (const key of Object.keys(newGroupedAccounts)) {\n          if (!state.syncQueue[key]) {\n            state.syncQueue[key] = [];\n          }\n          state.syncQueue[key].push(...newGroupedAccounts[key]);\n        }\n        state.initialEnqueueCompleted = true;\n      });\n    });\n  }\n\n  /**\n   * Set the initial delay end timestamp if it is not already set.\n   */\n  #setInitialDelayEndTimestampIfNull(): void {\n    this.update((state) => {\n      state.initialDelayEndTimestamp ??=\n        Date.now() + this.#initialDelayDuration;\n    });\n  }\n\n  /**\n   * Check if the initial delay end timestamp is in the past.\n   *\n   * @returns True if the initial delay period has completed, false otherwise.\n   */\n  #isInitialDelayComplete(): boolean {\n    return (\n      this.state.initialDelayEndTimestamp !== undefined &&\n      Date.now() >= this.state.initialDelayEndTimestamp\n    );\n  }\n\n  /**\n   * Queue the given account to be synced at the next poll.\n   *\n   * @param account - The account to sync.\n   */\n  async #addAccountToQueue(account: InternalAccount): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      this.update((state) => {\n        const entropySourceId = getAccountEntropySourceId(account) ?? 'null';\n        if (!state.syncQueue[entropySourceId]) {\n          state.syncQueue[entropySourceId] = [];\n        }\n        state.syncQueue[entropySourceId].push({\n          address: account.address,\n          scopes: account.scopes,\n        });\n      });\n    });\n  }\n\n  /**\n   * Remove the given account from the sync queue.\n   *\n   * @param account - The account address to remove.\n   */\n  async #removeAccountFromQueue(account: string): Promise<void> {\n    await this.#mutex.runExclusive(async () => {\n      this.update((state) => {\n        for (const [entropySourceId, groupedAddresses] of Object.entries(\n          state.syncQueue,\n        )) {\n          const index = groupedAddresses.findIndex(\n            ({ address }) => address === account,\n          );\n          if (index === -1) {\n            continue;\n          }\n          groupedAddresses.splice(index, 1);\n          if (groupedAddresses.length === 0) {\n            delete state.syncQueue[entropySourceId];\n          }\n          break;\n        }\n      });\n    });\n  }\n}\n\n/**\n * Retrieves the entropy source ID from the given account, if it exists.\n *\n * @param account - The account from which to retrieve the entropy source ID.\n * @returns The entropy source ID, or null if it does not exist.\n */\nfunction getAccountEntropySourceId(account: InternalAccount): string | null {\n  if (account.options.entropy?.type === 'mnemonic') {\n    return account.options.entropy.id;\n  }\n  return null;\n}\n\n/**\n * Groups accounts by their entropy source ID.\n *\n * @param accounts - The accounts to group.\n * @returns An object where each key is an entropy source ID and each value is\n * an array of account addresses associated with that entropy source ID.\n */\nfunction groupAccountsByEntropySourceId(\n  accounts: InternalAccount[],\n): Record<string, AccountWithScopes[]> {\n  return accounts.reduce(\n    (result: Record<string, AccountWithScopes[]>, account) => {\n      const entropySourceId = getAccountEntropySourceId(account);\n      const key = entropySourceId ?? 'null';\n      if (!result[key]) {\n        result[key] = [];\n      }\n      result[key].push({ address: account.address, scopes: account.scopes });\n      return result;\n    },\n    {},\n  );\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/profile-metrics-controller",
-  "version": "2.0.0-preview-c72fc191",
+  "version": "2.0.0-preview-fa81dffb",
   "description": "Sample package to illustrate best practices for controllers",
   "keywords": [
     "MetaMask",
@@ -48,14 +48,14 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/accounts-controller": "^35.0.1",
+    "@metamask/accounts-controller": "^35.0.2",
     "@metamask/base-controller": "^9.0.0",
     "@metamask/controller-utils": "^11.18.0",
     "@metamask/keyring-controller": "^25.0.0",
     "@metamask/messenger": "^0.3.0",
-    "@metamask/polling-controller": "^16.0.1",
+    "@metamask/polling-controller": "^16.0.2",
     "@metamask/profile-sync-controller": "^27.0.0",
-    "@metamask/transaction-controller": "^62.9.1",
+    "@metamask/transaction-controller": "^62.9.2",
     "@metamask/utils": "^11.9.0",
     "async-mutex": "^0.5.0"
   },