@metamask-previews/profile-metrics-controller 0.0.0-preview-d6fe4594 → 1.0.0-preview-84f90603

package/CHANGELOG.md

@@ -7,8 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0]
+
 ### Added
 
-- Initial release ([#7194](https://github.com/MetaMask/core/pull/7194))
+- Initial release ([#7194](https://github.com/MetaMask/core/pull/7194), [#7196](https://github.com/MetaMask/core/pull/7196), [#7263](https://github.com/MetaMask/core/pull/7263))
 
-[Unreleased]: https://github.com/MetaMask/core/
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/profile-metrics-controller@1.0.0...HEAD
+[1.0.0]: https://github.com/MetaMask/core/releases/tag/@metamask/profile-metrics-controller@1.0.0

package/dist/ProfileMetricsController.cjs

@@ -0,0 +1,234 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ProfileMetricsController_instances, _ProfileMetricsController_mutex, _ProfileMetricsController_assertUserOptedIn, _ProfileMetricsController_getMetaMetricsId, _ProfileMetricsController_queueFirstSyncIfNeeded, _ProfileMetricsController_addAccountToQueue, _ProfileMetricsController_removeAccountFromQueue;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProfileMetricsController = exports.getDefaultProfileMetricsControllerState = exports.controllerName = void 0;
+const polling_controller_1 = require("@metamask/polling-controller");
+const async_mutex_1 = require("async-mutex");
+/**
+ * The name of the {@link ProfileMetricsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+exports.controllerName = 'ProfileMetricsController';
+/**
+ * The metadata for each property in {@link ProfileMetricsControllerState}.
+ */
+const profileMetricsControllerMetadata = {
+    initialEnqueueCompleted: {
+        persist: true,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: false,
+    },
+    syncQueue: {
+        persist: true,
+        includeInDebugSnapshot: false,
+        includeInStateLogs: true,
+        usedInUi: false,
+    },
+};
+/**
+ * Constructs the default {@link ProfileMetricsController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link ProfileMetricsController} state.
+ */
+function getDefaultProfileMetricsControllerState() {
+    return {
+        initialEnqueueCompleted: false,
+        syncQueue: {},
+    };
+}
+exports.getDefaultProfileMetricsControllerState = getDefaultProfileMetricsControllerState;
+const MESSENGER_EXPOSED_METHODS = [];
+class ProfileMetricsController extends (0, polling_controller_1.StaticIntervalPollingController)() {
+    /**
+     * Constructs a new {@link ProfileMetricsController}.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this controller.
+     * @param args.state - The desired state with which to initialize this
+     * controller. Missing properties will be filled in with defaults.
+     * @param args.assertUserOptedIn - A function that asserts whether the user has
+     * opted in to user profile features. If the user has not opted in, sync
+     * operations will be no-ops.
+     * @param args.getMetaMetricsId - A function that returns the MetaMetrics ID
+     * of the user.
+     * @param args.interval - The interval, in milliseconds, at which the controller will
+     * attempt to send user profile data. Defaults to 10 seconds.
+     */
+    constructor({ messenger, state, assertUserOptedIn, getMetaMetricsId, interval = 10 * 1000, }) {
+        super({
+            messenger,
+            metadata: profileMetricsControllerMetadata,
+            name: exports.controllerName,
+            state: {
+                ...getDefaultProfileMetricsControllerState(),
+                ...state,
+            },
+        });
+        _ProfileMetricsController_instances.add(this);
+        _ProfileMetricsController_mutex.set(this, new async_mutex_1.Mutex());
+        _ProfileMetricsController_assertUserOptedIn.set(this, void 0);
+        _ProfileMetricsController_getMetaMetricsId.set(this, void 0);
+        __classPrivateFieldSet(this, _ProfileMetricsController_assertUserOptedIn, assertUserOptedIn, "f");
+        __classPrivateFieldSet(this, _ProfileMetricsController_getMetaMetricsId, getMetaMetricsId, "f");
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+        this.messenger.subscribe('KeyringController:unlock', () => {
+            this.startPolling(null);
+            __classPrivateFieldGet(this, _ProfileMetricsController_instances, "m", _ProfileMetricsController_queueFirstSyncIfNeeded).call(this).catch(console.error);
+        });
+        this.messenger.subscribe('KeyringController:lock', () => {
+            this.stopAllPolling();
+        });
+        this.messenger.subscribe('AccountsController:accountAdded', (account) => {
+            __classPrivateFieldGet(this, _ProfileMetricsController_instances, "m", _ProfileMetricsController_addAccountToQueue).call(this, account).catch(console.error);
+        });
+        this.messenger.subscribe('AccountsController:accountRemoved', (account) => {
+            __classPrivateFieldGet(this, _ProfileMetricsController_instances, "m", _ProfileMetricsController_removeAccountFromQueue).call(this, account).catch(console.error);
+        });
+        this.setIntervalLength(interval);
+    }
+    /**
+     * Execute a single poll to sync user profile data.
+     *
+     * The queued accounts are sent to the ProfileMetricsService, and the sync
+     * queue is cleared. This operation is mutexed to prevent concurrent
+     * executions.
+     *
+     * @returns A promise that resolves when the poll is complete.
+     */
+    async _executePoll() {
+        await __classPrivateFieldGet(this, _ProfileMetricsController_mutex, "f").runExclusive(async () => {
+            if (!__classPrivateFieldGet(this, _ProfileMetricsController_assertUserOptedIn, "f").call(this)) {
+                return;
+            }
+            for (const [entropySourceId, accounts] of Object.entries(this.state.syncQueue)) {
+                try {
+                    await this.messenger.call('ProfileMetricsService:submitMetrics', {
+                        metametricsId: __classPrivateFieldGet(this, _ProfileMetricsController_getMetaMetricsId, "f").call(this),
+                        entropySourceId: entropySourceId === 'null' ? null : entropySourceId,
+                        accounts,
+                    });
+                    this.update((state) => {
+                        delete state.syncQueue[entropySourceId];
+                    });
+                }
+                catch (error) {
+                    // We want to log the error but continue processing other batches.
+                    console.error(`Failed to submit profile metrics for entropy source ID ${entropySourceId}:`, error);
+                }
+            }
+        });
+    }
+}
+exports.ProfileMetricsController = ProfileMetricsController;
+_ProfileMetricsController_mutex = new WeakMap(), _ProfileMetricsController_assertUserOptedIn = new WeakMap(), _ProfileMetricsController_getMetaMetricsId = new WeakMap(), _ProfileMetricsController_instances = new WeakSet(), _ProfileMetricsController_queueFirstSyncIfNeeded = 
+/**
+ * Add existing accounts to the sync queue if it has not been done yet.
+ *
+ * This method ensures that the first sync is only executed once,
+ * and only if the user has opted in to user profile features.
+ */
+async function _ProfileMetricsController_queueFirstSyncIfNeeded() {
+    await __classPrivateFieldGet(this, _ProfileMetricsController_mutex, "f").runExclusive(async () => {
+        if (this.state.initialEnqueueCompleted) {
+            return;
+        }
+        const newGroupedAccounts = groupAccountsByEntropySourceId(this.messenger.call('AccountsController:listAccounts'));
+        this.update((state) => {
+            for (const key of Object.keys(newGroupedAccounts)) {
+                if (!state.syncQueue[key]) {
+                    state.syncQueue[key] = [];
+                }
+                state.syncQueue[key].push(...newGroupedAccounts[key]);
+            }
+            state.initialEnqueueCompleted = true;
+        });
+    });
+}, _ProfileMetricsController_addAccountToQueue = 
+/**
+ * Queue the given account to be synced at the next poll.
+ *
+ * @param account - The account to sync.
+ */
+async function _ProfileMetricsController_addAccountToQueue(account) {
+    await __classPrivateFieldGet(this, _ProfileMetricsController_mutex, "f").runExclusive(async () => {
+        this.update((state) => {
+            const entropySourceId = getAccountEntropySourceId(account) || 'null';
+            if (!state.syncQueue[entropySourceId]) {
+                state.syncQueue[entropySourceId] = [];
+            }
+            state.syncQueue[entropySourceId].push({
+                address: account.address,
+                scopes: account.scopes,
+            });
+        });
+    });
+}, _ProfileMetricsController_removeAccountFromQueue = 
+/**
+ * Remove the given account from the sync queue.
+ *
+ * @param account - The account address to remove.
+ */
+async function _ProfileMetricsController_removeAccountFromQueue(account) {
+    await __classPrivateFieldGet(this, _ProfileMetricsController_mutex, "f").runExclusive(async () => {
+        this.update((state) => {
+            for (const [entropySourceId, groupedAddresses] of Object.entries(state.syncQueue)) {
+                const index = groupedAddresses.findIndex(({ address }) => address === account);
+                if (index === -1) {
+                    continue;
+                }
+                groupedAddresses.splice(index, 1);
+                if (groupedAddresses.length === 0) {
+                    delete state.syncQueue[entropySourceId];
+                }
+                break;
+            }
+        });
+    });
+};
+/**
+ * Retrieves the entropy source ID from the given account, if it exists.
+ *
+ * @param account - The account from which to retrieve the entropy source ID.
+ * @returns The entropy source ID, or null if it does not exist.
+ */
+function getAccountEntropySourceId(account) {
+    if (account.options.entropy && account.options.entropy.type === 'mnemonic') {
+        return account.options.entropy.id;
+    }
+    return null;
+}
+/**
+ * Groups accounts by their entropy source ID.
+ *
+ * @param accounts - The accounts to group.
+ * @returns An object where each key is an entropy source ID and each value is
+ * an array of account addresses associated with that entropy source ID.
+ */
+function groupAccountsByEntropySourceId(accounts) {
+    return accounts.reduce((result, account) => {
+        const entropySourceId = getAccountEntropySourceId(account);
+        const key = entropySourceId || 'null';
+        if (!result[key]) {
+            result[key] = [];
+        }
+        result[key].push({ address: account.address, scopes: account.scopes });
+        return result;
+    }, {});
+}
+//# sourceMappingURL=ProfileMetricsController.cjs.map

package/dist/ProfileMetricsController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileMetricsController.cjs","sourceRoot":"","sources":["../src/ProfileMetricsController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAgBA,qEAA+E;AAC/E,6CAAoC;AAKpC;;;;GAIG;AACU,QAAA,cAAc,GAAG,0BAA0B,CAAC;AAoBzD;;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;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,EAAW,CAAC;AA2D9C,MAAa,wBAAyB,SAAQ,IAAA,oDAA+B,GAI5E;IAOC;;;;;;;;;;;;;;OAcG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,GAAG,EAAE,GAAG,IAAI,GAOrB;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;;QA1CI,0CAAS,IAAI,mBAAK,EAAE,EAAC;QAErB,8DAAkC;QAElC,6DAAgC;QAwCvC,uBAAA,IAAI,+CAAsB,iBAAiB,MAAA,CAAC;QAC5C,uBAAA,IAAI,8CAAqB,gBAAgB,MAAA,CAAC;QAE1C,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;YACxD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YACxB,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE;YACtD,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,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;;;;;;;;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,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;CA0EF;AA3LD,4DA2LC;;AAxEC;;;;;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,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CACvD,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;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,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC3E,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  AccountsControllerListAccountsAction,\n  AccountsControllerAccountRemovedEvent,\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 { Mutex } from 'async-mutex';\n\nimport type { ProfileMetricsServiceMethodActions } 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 * 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\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} 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 = [] 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  | ProfileMetricsServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link ProfileMetricsControllerMessenger} calls.\n */\ntype AllowedActions =\n  | ProfileMetricsServiceMethodActions\n  | AccountsControllerListAccountsAction;\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\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  /**\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   */\n  constructor({\n    messenger,\n    state,\n    assertUserOptedIn,\n    getMetaMetricsId,\n    interval = 10 * 1000,\n  }: {\n    messenger: ProfileMetricsControllerMessenger;\n    state?: Partial<ProfileMetricsControllerState>;\n    interval?: number;\n    assertUserOptedIn: () => boolean;\n    getMetaMetricsId: () => string;\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\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    this.messenger.subscribe('KeyringController:unlock', () => {\n      this.startPolling(null);\n      this.#queueFirstSyncIfNeeded().catch(console.error);\n    });\n\n    this.messenger.subscribe('KeyringController:lock', () => {\n      this.stopAllPolling();\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   * 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      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() {\n    await this.#mutex.runExclusive(async () => {\n      if (this.state.initialEnqueueCompleted) {\n        return;\n      }\n      const newGroupedAccounts = groupAccountsByEntropySourceId(\n        this.messenger.call('AccountsController:listAccounts'),\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   * 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) {\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) {\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 && 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

@@ -0,0 +1,121 @@
+/// <reference types="node" />
+import type { AccountsControllerAccountAddedEvent, AccountsControllerListAccountsAction, AccountsControllerAccountRemovedEvent } from "@metamask/accounts-controller";
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
+import type { Messenger } from "@metamask/messenger";
+import type { ProfileMetricsServiceMethodActions } from "./index.cjs";
+import type { AccountWithScopes } from "./ProfileMetricsService.cjs";
+/**
+ * The name of the {@link ProfileMetricsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export declare const controllerName = "ProfileMetricsController";
+/**
+ * Describes the shape of the state object for {@link ProfileMetricsController}.
+ */
+export type ProfileMetricsControllerState = {
+    /**
+     * Whether existing accounts have been added
+     * to the queue.
+     */
+    initialEnqueueCompleted: boolean;
+    /**
+     * The queue of accounts to be synced.
+     * Each key is an entropy source ID, and each value is an array of account
+     * addresses associated with that entropy source. Accounts with no entropy
+     * source ID are grouped under the key "null".
+     */
+    syncQueue: Record<string, AccountWithScopes[]>;
+};
+/**
+ * Constructs the default {@link ProfileMetricsController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link ProfileMetricsController} state.
+ */
+export declare function getDefaultProfileMetricsControllerState(): ProfileMetricsControllerState;
+/**
+ * Retrieves the state of the {@link ProfileMetricsController}.
+ */
+export type ProfileMetricsControllerGetStateAction = ControllerGetStateAction<typeof controllerName, ProfileMetricsControllerState>;
+/**
+ * Actions that {@link ProfileMetricsControllerMessenger} exposes to other consumers.
+ */
+export type ProfileMetricsControllerActions = ProfileMetricsControllerGetStateAction | ProfileMetricsServiceMethodActions;
+/**
+ * Actions from other messengers that {@link ProfileMetricsControllerMessenger} calls.
+ */
+type AllowedActions = ProfileMetricsServiceMethodActions | AccountsControllerListAccountsAction;
+/**
+ * Published when the state of {@link ProfileMetricsController} changes.
+ */
+export type ProfileMetricsControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, ProfileMetricsControllerState>;
+/**
+ * Events that {@link ProfileMetricsControllerMessenger} exposes to other consumers.
+ */
+export type ProfileMetricsControllerEvents = ProfileMetricsControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link ProfileMetricsControllerMessenger} subscribes
+ * to.
+ */
+type AllowedEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent | AccountsControllerAccountAddedEvent | AccountsControllerAccountRemovedEvent;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link ProfileMetricsController}.
+ */
+export type ProfileMetricsControllerMessenger = Messenger<typeof controllerName, ProfileMetricsControllerActions | AllowedActions, ProfileMetricsControllerEvents | AllowedEvents>;
+declare const ProfileMetricsController_base: (abstract new (...args: any[]) => {
+    readonly "__#15@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#15@#intervalLength": number | undefined;
+    setIntervalLength(intervalLength: number): void;
+    getIntervalLength(): number | undefined;
+    _startPolling(input: import("@metamask/utils").Json): void;
+    _stopPollingByPollingTokenSetId(key: string): void;
+    readonly "__#3@#pollingTokenSets": Map<string, Set<string>>;
+    readonly "__#3@#callbacks": Map<string, Set<(input: import("@metamask/utils").Json) => void>>;
+    _executePoll(input: import("@metamask/utils").Json): Promise<void>;
+    startPolling(input: import("@metamask/utils").Json): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingComplete(input: import("@metamask/utils").Json, callback: (input: import("@metamask/utils").Json) => void): void;
+}) & typeof import("@metamask/base-controller").BaseController;
+export declare class ProfileMetricsController extends ProfileMetricsController_base<typeof controllerName, ProfileMetricsControllerState, ProfileMetricsControllerMessenger> {
+    #private;
+    /**
+     * Constructs a new {@link ProfileMetricsController}.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this controller.
+     * @param args.state - The desired state with which to initialize this
+     * controller. Missing properties will be filled in with defaults.
+     * @param args.assertUserOptedIn - A function that asserts whether the user has
+     * opted in to user profile features. If the user has not opted in, sync
+     * operations will be no-ops.
+     * @param args.getMetaMetricsId - A function that returns the MetaMetrics ID
+     * of the user.
+     * @param args.interval - The interval, in milliseconds, at which the controller will
+     * attempt to send user profile data. Defaults to 10 seconds.
+     */
+    constructor({ messenger, state, assertUserOptedIn, getMetaMetricsId, interval, }: {
+        messenger: ProfileMetricsControllerMessenger;
+        state?: Partial<ProfileMetricsControllerState>;
+        interval?: number;
+        assertUserOptedIn: () => boolean;
+        getMetaMetricsId: () => string;
+    });
+    /**
+     * Execute a single poll to sync user profile data.
+     *
+     * The queued accounts are sent to the ProfileMetricsService, and the sync
+     * queue is cleared. This operation is mutexed to prevent concurrent
+     * executions.
+     *
+     * @returns A promise that resolves when the poll is complete.
+     */
+    _executePoll(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=ProfileMetricsController.d.cts.map

package/dist/ProfileMetricsController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileMetricsController.d.cts","sourceRoot":"","sources":["../src/ProfileMetricsController.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EACV,mCAAmC,EACnC,oCAAoC,EACpC,qCAAqC,EACtC,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;AAIrD,OAAO,KAAK,EAAE,kCAAkC,EAAE,oBAAU;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAgC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,cAAc,6BAA6B,CAAC;AAEzD;;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;CAChD,CAAC;AAoBF;;;;;;;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,kCAAkC,CAAC;AAEvC;;GAEG;AACH,KAAK,cAAc,GACf,kCAAkC,GAClC,oCAAoC,CAAC;AAEzC;;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,CAAC;AAE1C;;;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;;IAOC;;;;;;;;;;;;;;OAcG;gBACS,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,QAAoB,GACrB,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;KAChC;IAuCD;;;;;;;;OAQG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAqGpC"}

package/dist/ProfileMetricsController.d.mts

@@ -0,0 +1,121 @@
+/// <reference types="node" />
+import type { AccountsControllerAccountAddedEvent, AccountsControllerListAccountsAction, AccountsControllerAccountRemovedEvent } from "@metamask/accounts-controller";
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
+import type { Messenger } from "@metamask/messenger";
+import type { ProfileMetricsServiceMethodActions } from "./index.mjs";
+import type { AccountWithScopes } from "./ProfileMetricsService.mjs";
+/**
+ * The name of the {@link ProfileMetricsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export declare const controllerName = "ProfileMetricsController";
+/**
+ * Describes the shape of the state object for {@link ProfileMetricsController}.
+ */
+export type ProfileMetricsControllerState = {
+    /**
+     * Whether existing accounts have been added
+     * to the queue.
+     */
+    initialEnqueueCompleted: boolean;
+    /**
+     * The queue of accounts to be synced.
+     * Each key is an entropy source ID, and each value is an array of account
+     * addresses associated with that entropy source. Accounts with no entropy
+     * source ID are grouped under the key "null".
+     */
+    syncQueue: Record<string, AccountWithScopes[]>;
+};
+/**
+ * Constructs the default {@link ProfileMetricsController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link ProfileMetricsController} state.
+ */
+export declare function getDefaultProfileMetricsControllerState(): ProfileMetricsControllerState;
+/**
+ * Retrieves the state of the {@link ProfileMetricsController}.
+ */
+export type ProfileMetricsControllerGetStateAction = ControllerGetStateAction<typeof controllerName, ProfileMetricsControllerState>;
+/**
+ * Actions that {@link ProfileMetricsControllerMessenger} exposes to other consumers.
+ */
+export type ProfileMetricsControllerActions = ProfileMetricsControllerGetStateAction | ProfileMetricsServiceMethodActions;
+/**
+ * Actions from other messengers that {@link ProfileMetricsControllerMessenger} calls.
+ */
+type AllowedActions = ProfileMetricsServiceMethodActions | AccountsControllerListAccountsAction;
+/**
+ * Published when the state of {@link ProfileMetricsController} changes.
+ */
+export type ProfileMetricsControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, ProfileMetricsControllerState>;
+/**
+ * Events that {@link ProfileMetricsControllerMessenger} exposes to other consumers.
+ */
+export type ProfileMetricsControllerEvents = ProfileMetricsControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link ProfileMetricsControllerMessenger} subscribes
+ * to.
+ */
+type AllowedEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent | AccountsControllerAccountAddedEvent | AccountsControllerAccountRemovedEvent;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link ProfileMetricsController}.
+ */
+export type ProfileMetricsControllerMessenger = Messenger<typeof controllerName, ProfileMetricsControllerActions | AllowedActions, ProfileMetricsControllerEvents | AllowedEvents>;
+declare const ProfileMetricsController_base: (abstract new (...args: any[]) => {
+    readonly "__#15@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#15@#intervalLength": number | undefined;
+    setIntervalLength(intervalLength: number): void;
+    getIntervalLength(): number | undefined;
+    _startPolling(input: import("@metamask/utils").Json): void;
+    _stopPollingByPollingTokenSetId(key: string): void;
+    readonly "__#3@#pollingTokenSets": Map<string, Set<string>>;
+    readonly "__#3@#callbacks": Map<string, Set<(input: import("@metamask/utils").Json) => void>>;
+    _executePoll(input: import("@metamask/utils").Json): Promise<void>;
+    startPolling(input: import("@metamask/utils").Json): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingComplete(input: import("@metamask/utils").Json, callback: (input: import("@metamask/utils").Json) => void): void;
+}) & typeof import("@metamask/base-controller").BaseController;
+export declare class ProfileMetricsController extends ProfileMetricsController_base<typeof controllerName, ProfileMetricsControllerState, ProfileMetricsControllerMessenger> {
+    #private;
+    /**
+     * Constructs a new {@link ProfileMetricsController}.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this controller.
+     * @param args.state - The desired state with which to initialize this
+     * controller. Missing properties will be filled in with defaults.
+     * @param args.assertUserOptedIn - A function that asserts whether the user has
+     * opted in to user profile features. If the user has not opted in, sync
+     * operations will be no-ops.
+     * @param args.getMetaMetricsId - A function that returns the MetaMetrics ID
+     * of the user.
+     * @param args.interval - The interval, in milliseconds, at which the controller will
+     * attempt to send user profile data. Defaults to 10 seconds.
+     */
+    constructor({ messenger, state, assertUserOptedIn, getMetaMetricsId, interval, }: {
+        messenger: ProfileMetricsControllerMessenger;
+        state?: Partial<ProfileMetricsControllerState>;
+        interval?: number;
+        assertUserOptedIn: () => boolean;
+        getMetaMetricsId: () => string;
+    });
+    /**
+     * Execute a single poll to sync user profile data.
+     *
+     * The queued accounts are sent to the ProfileMetricsService, and the sync
+     * queue is cleared. This operation is mutexed to prevent concurrent
+     * executions.
+     *
+     * @returns A promise that resolves when the poll is complete.
+     */
+    _executePoll(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=ProfileMetricsController.d.mts.map

package/dist/ProfileMetricsController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileMetricsController.d.mts","sourceRoot":"","sources":["../src/ProfileMetricsController.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EACV,mCAAmC,EACnC,oCAAoC,EACpC,qCAAqC,EACtC,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;AAIrD,OAAO,KAAK,EAAE,kCAAkC,EAAE,oBAAU;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAgC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,cAAc,6BAA6B,CAAC;AAEzD;;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;CAChD,CAAC;AAoBF;;;;;;;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,kCAAkC,CAAC;AAEvC;;GAEG;AACH,KAAK,cAAc,GACf,kCAAkC,GAClC,oCAAoC,CAAC;AAEzC;;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,CAAC;AAE1C;;;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;;IAOC;;;;;;;;;;;;;;OAcG;gBACS,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,QAAoB,GACrB,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;KAChC;IAuCD;;;;;;;;OAQG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAqGpC"}

package/dist/ProfileMetricsController.mjs

@@ -0,0 +1,229 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ProfileMetricsController_instances, _ProfileMetricsController_mutex, _ProfileMetricsController_assertUserOptedIn, _ProfileMetricsController_getMetaMetricsId, _ProfileMetricsController_queueFirstSyncIfNeeded, _ProfileMetricsController_addAccountToQueue, _ProfileMetricsController_removeAccountFromQueue;
+import { StaticIntervalPollingController } from "@metamask/polling-controller";
+import { Mutex } from "async-mutex";
+/**
+ * The name of the {@link ProfileMetricsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export const controllerName = 'ProfileMetricsController';
+/**
+ * The metadata for each property in {@link ProfileMetricsControllerState}.
+ */
+const profileMetricsControllerMetadata = {
+    initialEnqueueCompleted: {
+        persist: true,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: false,
+    },
+    syncQueue: {
+        persist: true,
+        includeInDebugSnapshot: false,
+        includeInStateLogs: true,
+        usedInUi: false,
+    },
+};
+/**
+ * Constructs the default {@link ProfileMetricsController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link ProfileMetricsController} state.
+ */
+export function getDefaultProfileMetricsControllerState() {
+    return {
+        initialEnqueueCompleted: false,
+        syncQueue: {},
+    };
+}
+const MESSENGER_EXPOSED_METHODS = [];
+export class ProfileMetricsController extends StaticIntervalPollingController() {
+    /**
+     * Constructs a new {@link ProfileMetricsController}.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this controller.
+     * @param args.state - The desired state with which to initialize this
+     * controller. Missing properties will be filled in with defaults.
+     * @param args.assertUserOptedIn - A function that asserts whether the user has
+     * opted in to user profile features. If the user has not opted in, sync
+     * operations will be no-ops.
+     * @param args.getMetaMetricsId - A function that returns the MetaMetrics ID
+     * of the user.
+     * @param args.interval - The interval, in milliseconds, at which the controller will
+     * attempt to send user profile data. Defaults to 10 seconds.
+     */
+    constructor({ messenger, state, assertUserOptedIn, getMetaMetricsId, interval = 10 * 1000, }) {
+        super({
+            messenger,
+            metadata: profileMetricsControllerMetadata,
+            name: controllerName,
+            state: {
+                ...getDefaultProfileMetricsControllerState(),
+                ...state,
+            },
+        });
+        _ProfileMetricsController_instances.add(this);
+        _ProfileMetricsController_mutex.set(this, new Mutex());
+        _ProfileMetricsController_assertUserOptedIn.set(this, void 0);
+        _ProfileMetricsController_getMetaMetricsId.set(this, void 0);
+        __classPrivateFieldSet(this, _ProfileMetricsController_assertUserOptedIn, assertUserOptedIn, "f");
+        __classPrivateFieldSet(this, _ProfileMetricsController_getMetaMetricsId, getMetaMetricsId, "f");
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+        this.messenger.subscribe('KeyringController:unlock', () => {
+            this.startPolling(null);
+            __classPrivateFieldGet(this, _ProfileMetricsController_instances, "m", _ProfileMetricsController_queueFirstSyncIfNeeded).call(this).catch(console.error);
+        });
+        this.messenger.subscribe('KeyringController:lock', () => {
+            this.stopAllPolling();
+        });
+        this.messenger.subscribe('AccountsController:accountAdded', (account) => {
+            __classPrivateFieldGet(this, _ProfileMetricsController_instances, "m", _ProfileMetricsController_addAccountToQueue).call(this, account).catch(console.error);
+        });
+        this.messenger.subscribe('AccountsController:accountRemoved', (account) => {
+            __classPrivateFieldGet(this, _ProfileMetricsController_instances, "m", _ProfileMetricsController_removeAccountFromQueue).call(this, account).catch(console.error);
+        });
+        this.setIntervalLength(interval);
+    }
+    /**
+     * Execute a single poll to sync user profile data.
+     *
+     * The queued accounts are sent to the ProfileMetricsService, and the sync
+     * queue is cleared. This operation is mutexed to prevent concurrent
+     * executions.
+     *
+     * @returns A promise that resolves when the poll is complete.
+     */
+    async _executePoll() {
+        await __classPrivateFieldGet(this, _ProfileMetricsController_mutex, "f").runExclusive(async () => {
+            if (!__classPrivateFieldGet(this, _ProfileMetricsController_assertUserOptedIn, "f").call(this)) {
+                return;
+            }
+            for (const [entropySourceId, accounts] of Object.entries(this.state.syncQueue)) {
+                try {
+                    await this.messenger.call('ProfileMetricsService:submitMetrics', {
+                        metametricsId: __classPrivateFieldGet(this, _ProfileMetricsController_getMetaMetricsId, "f").call(this),
+                        entropySourceId: entropySourceId === 'null' ? null : entropySourceId,
+                        accounts,
+                    });
+                    this.update((state) => {
+                        delete state.syncQueue[entropySourceId];
+                    });
+                }
+                catch (error) {
+                    // We want to log the error but continue processing other batches.
+                    console.error(`Failed to submit profile metrics for entropy source ID ${entropySourceId}:`, error);
+                }
+            }
+        });
+    }
+}
+_ProfileMetricsController_mutex = new WeakMap(), _ProfileMetricsController_assertUserOptedIn = new WeakMap(), _ProfileMetricsController_getMetaMetricsId = new WeakMap(), _ProfileMetricsController_instances = new WeakSet(), _ProfileMetricsController_queueFirstSyncIfNeeded = 
+/**
+ * Add existing accounts to the sync queue if it has not been done yet.
+ *
+ * This method ensures that the first sync is only executed once,
+ * and only if the user has opted in to user profile features.
+ */
+async function _ProfileMetricsController_queueFirstSyncIfNeeded() {
+    await __classPrivateFieldGet(this, _ProfileMetricsController_mutex, "f").runExclusive(async () => {
+        if (this.state.initialEnqueueCompleted) {
+            return;
+        }
+        const newGroupedAccounts = groupAccountsByEntropySourceId(this.messenger.call('AccountsController:listAccounts'));
+        this.update((state) => {
+            for (const key of Object.keys(newGroupedAccounts)) {
+                if (!state.syncQueue[key]) {
+                    state.syncQueue[key] = [];
+                }
+                state.syncQueue[key].push(...newGroupedAccounts[key]);
+            }
+            state.initialEnqueueCompleted = true;
+        });
+    });
+}, _ProfileMetricsController_addAccountToQueue = 
+/**
+ * Queue the given account to be synced at the next poll.
+ *
+ * @param account - The account to sync.
+ */
+async function _ProfileMetricsController_addAccountToQueue(account) {
+    await __classPrivateFieldGet(this, _ProfileMetricsController_mutex, "f").runExclusive(async () => {
+        this.update((state) => {
+            const entropySourceId = getAccountEntropySourceId(account) || 'null';
+            if (!state.syncQueue[entropySourceId]) {
+                state.syncQueue[entropySourceId] = [];
+            }
+            state.syncQueue[entropySourceId].push({
+                address: account.address,
+                scopes: account.scopes,
+            });
+        });
+    });
+}, _ProfileMetricsController_removeAccountFromQueue = 
+/**
+ * Remove the given account from the sync queue.
+ *
+ * @param account - The account address to remove.
+ */
+async function _ProfileMetricsController_removeAccountFromQueue(account) {
+    await __classPrivateFieldGet(this, _ProfileMetricsController_mutex, "f").runExclusive(async () => {
+        this.update((state) => {
+            for (const [entropySourceId, groupedAddresses] of Object.entries(state.syncQueue)) {
+                const index = groupedAddresses.findIndex(({ address }) => address === account);
+                if (index === -1) {
+                    continue;
+                }
+                groupedAddresses.splice(index, 1);
+                if (groupedAddresses.length === 0) {
+                    delete state.syncQueue[entropySourceId];
+                }
+                break;
+            }
+        });
+    });
+};
+/**
+ * Retrieves the entropy source ID from the given account, if it exists.
+ *
+ * @param account - The account from which to retrieve the entropy source ID.
+ * @returns The entropy source ID, or null if it does not exist.
+ */
+function getAccountEntropySourceId(account) {
+    if (account.options.entropy && account.options.entropy.type === 'mnemonic') {
+        return account.options.entropy.id;
+    }
+    return null;
+}
+/**
+ * Groups accounts by their entropy source ID.
+ *
+ * @param accounts - The accounts to group.
+ * @returns An object where each key is an entropy source ID and each value is
+ * an array of account addresses associated with that entropy source ID.
+ */
+function groupAccountsByEntropySourceId(accounts) {
+    return accounts.reduce((result, account) => {
+        const entropySourceId = getAccountEntropySourceId(account);
+        const key = entropySourceId || 'null';
+        if (!result[key]) {
+            result[key] = [];
+        }
+        result[key].push({ address: account.address, scopes: account.scopes });
+        return result;
+    }, {});
+}
+//# sourceMappingURL=ProfileMetricsController.mjs.map

package/dist/ProfileMetricsController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileMetricsController.mjs","sourceRoot":"","sources":["../src/ProfileMetricsController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAgBA,OAAO,EAAE,+BAA+B,EAAE,qCAAqC;AAC/E,OAAO,EAAE,KAAK,EAAE,oBAAoB;AAKpC;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAoBzD;;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;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,EAAW,CAAC;AA2D9C,MAAM,OAAO,wBAAyB,SAAQ,+BAA+B,EAI5E;IAOC;;;;;;;;;;;;;;OAcG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,GAAG,EAAE,GAAG,IAAI,GAOrB;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;;QA1CI,0CAAS,IAAI,KAAK,EAAE,EAAC;QAErB,8DAAkC;QAElC,6DAAgC;QAwCvC,uBAAA,IAAI,+CAAsB,iBAAiB,MAAA,CAAC;QAC5C,uBAAA,IAAI,8CAAqB,gBAAgB,MAAA,CAAC;QAE1C,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;YACxD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YACxB,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE;YACtD,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,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;;;;;;;;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,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;CA0EF;;AAxEC;;;;;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,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CACvD,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;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,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC3E,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  AccountsControllerListAccountsAction,\n  AccountsControllerAccountRemovedEvent,\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 { Mutex } from 'async-mutex';\n\nimport type { ProfileMetricsServiceMethodActions } 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 * 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\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} 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 = [] 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  | ProfileMetricsServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link ProfileMetricsControllerMessenger} calls.\n */\ntype AllowedActions =\n  | ProfileMetricsServiceMethodActions\n  | AccountsControllerListAccountsAction;\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\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  /**\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   */\n  constructor({\n    messenger,\n    state,\n    assertUserOptedIn,\n    getMetaMetricsId,\n    interval = 10 * 1000,\n  }: {\n    messenger: ProfileMetricsControllerMessenger;\n    state?: Partial<ProfileMetricsControllerState>;\n    interval?: number;\n    assertUserOptedIn: () => boolean;\n    getMetaMetricsId: () => string;\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\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    this.messenger.subscribe('KeyringController:unlock', () => {\n      this.startPolling(null);\n      this.#queueFirstSyncIfNeeded().catch(console.error);\n    });\n\n    this.messenger.subscribe('KeyringController:lock', () => {\n      this.stopAllPolling();\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   * 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      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() {\n    await this.#mutex.runExclusive(async () => {\n      if (this.state.initialEnqueueCompleted) {\n        return;\n      }\n      const newGroupedAccounts = groupAccountsByEntropySourceId(\n        this.messenger.call('AccountsController:listAccounts'),\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   * 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) {\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) {\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 && 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/index.cjs

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serviceName = exports.ProfileMetricsService = void 0;
+exports.serviceName = exports.ProfileMetricsService = exports.getDefaultProfileMetricsControllerState = exports.ProfileMetricsController = void 0;
+var ProfileMetricsController_1 = require("./ProfileMetricsController.cjs");
+Object.defineProperty(exports, "ProfileMetricsController", { enumerable: true, get: function () { return ProfileMetricsController_1.ProfileMetricsController; } });
+Object.defineProperty(exports, "getDefaultProfileMetricsControllerState", { enumerable: true, get: function () { return ProfileMetricsController_1.getDefaultProfileMetricsControllerState; } });
 var ProfileMetricsService_1 = require("./ProfileMetricsService.cjs");
 Object.defineProperty(exports, "ProfileMetricsService", { enumerable: true, get: function () { return ProfileMetricsService_1.ProfileMetricsService; } });
 Object.defineProperty(exports, "serviceName", { enumerable: true, get: function () { return ProfileMetricsService_1.serviceName; } });

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAMA,qEAA6E;AAApE,8HAAA,qBAAqB,OAAA;AAAE,oHAAA,WAAW,OAAA","sourcesContent":["export type {\n  ProfileMetricsServiceActions,\n  ProfileMetricsServiceEvents,\n  ProfileMetricsServiceMessenger,\n  ProfileMetricsSubmitMetricsRequest,\n} from './ProfileMetricsService';\nexport { ProfileMetricsService, serviceName } from './ProfileMetricsService';\nexport type { ProfileMetricsServiceMethodActions } from './ProfileMetricsService-method-action-types';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAQA,2EAGoC;AAFlC,oIAAA,wBAAwB,OAAA;AACxB,mJAAA,uCAAuC,OAAA;AAQzC,qEAA6E;AAApE,8HAAA,qBAAqB,OAAA;AAAE,oHAAA,WAAW,OAAA","sourcesContent":["export type {\n  ProfileMetricsControllerActions,\n  ProfileMetricsControllerEvents,\n  ProfileMetricsControllerGetStateAction,\n  ProfileMetricsControllerMessenger,\n  ProfileMetricsControllerState,\n  ProfileMetricsControllerStateChangeEvent,\n} from './ProfileMetricsController';\nexport {\n  ProfileMetricsController,\n  getDefaultProfileMetricsControllerState,\n} from './ProfileMetricsController';\nexport type {\n  ProfileMetricsServiceActions,\n  ProfileMetricsServiceEvents,\n  ProfileMetricsServiceMessenger,\n  ProfileMetricsSubmitMetricsRequest,\n} from './ProfileMetricsService';\nexport { ProfileMetricsService, serviceName } from './ProfileMetricsService';\nexport type { ProfileMetricsServiceMethodActions } from './ProfileMetricsService-method-action-types';\n"]}

package/dist/index.d.cts

@@ -1,3 +1,5 @@
+export type { ProfileMetricsControllerActions, ProfileMetricsControllerEvents, ProfileMetricsControllerGetStateAction, ProfileMetricsControllerMessenger, ProfileMetricsControllerState, ProfileMetricsControllerStateChangeEvent, } from "./ProfileMetricsController.cjs";
+export { ProfileMetricsController, getDefaultProfileMetricsControllerState, } from "./ProfileMetricsController.cjs";
 export type { ProfileMetricsServiceActions, ProfileMetricsServiceEvents, ProfileMetricsServiceMessenger, ProfileMetricsSubmitMetricsRequest, } from "./ProfileMetricsService.cjs";
 export { ProfileMetricsService, serviceName } from "./ProfileMetricsService.cjs";
 export type { ProfileMetricsServiceMethodActions } from "./ProfileMetricsService-method-action-types.cjs";

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,4BAA4B,EAC5B,2BAA2B,EAC3B,8BAA8B,EAC9B,kCAAkC,GACnC,oCAAgC;AACjC,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,oCAAgC;AAC7E,YAAY,EAAE,kCAAkC,EAAE,wDAAoD"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,uCAAmC;AACpC,OAAO,EACL,wBAAwB,EACxB,uCAAuC,GACxC,uCAAmC;AACpC,YAAY,EACV,4BAA4B,EAC5B,2BAA2B,EAC3B,8BAA8B,EAC9B,kCAAkC,GACnC,oCAAgC;AACjC,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,oCAAgC;AAC7E,YAAY,EAAE,kCAAkC,EAAE,wDAAoD"}

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+export type { ProfileMetricsControllerActions, ProfileMetricsControllerEvents, ProfileMetricsControllerGetStateAction, ProfileMetricsControllerMessenger, ProfileMetricsControllerState, ProfileMetricsControllerStateChangeEvent, } from "./ProfileMetricsController.mjs";
+export { ProfileMetricsController, getDefaultProfileMetricsControllerState, } from "./ProfileMetricsController.mjs";
 export type { ProfileMetricsServiceActions, ProfileMetricsServiceEvents, ProfileMetricsServiceMessenger, ProfileMetricsSubmitMetricsRequest, } from "./ProfileMetricsService.mjs";
 export { ProfileMetricsService, serviceName } from "./ProfileMetricsService.mjs";
 export type { ProfileMetricsServiceMethodActions } from "./ProfileMetricsService-method-action-types.mjs";

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,4BAA4B,EAC5B,2BAA2B,EAC3B,8BAA8B,EAC9B,kCAAkC,GACnC,oCAAgC;AACjC,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,oCAAgC;AAC7E,YAAY,EAAE,kCAAkC,EAAE,wDAAoD"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,uCAAmC;AACpC,OAAO,EACL,wBAAwB,EACxB,uCAAuC,GACxC,uCAAmC;AACpC,YAAY,EACV,4BAA4B,EAC5B,2BAA2B,EAC3B,8BAA8B,EAC9B,kCAAkC,GACnC,oCAAgC;AACjC,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,oCAAgC;AAC7E,YAAY,EAAE,kCAAkC,EAAE,wDAAoD"}

package/dist/index.mjs

@@ -1,2 +1,3 @@
+export { ProfileMetricsController, getDefaultProfileMetricsControllerState } from "./ProfileMetricsController.mjs";
 export { ProfileMetricsService, serviceName } from "./ProfileMetricsService.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,oCAAgC","sourcesContent":["export type {\n  ProfileMetricsServiceActions,\n  ProfileMetricsServiceEvents,\n  ProfileMetricsServiceMessenger,\n  ProfileMetricsSubmitMetricsRequest,\n} from './ProfileMetricsService';\nexport { ProfileMetricsService, serviceName } from './ProfileMetricsService';\nexport type { ProfileMetricsServiceMethodActions } from './ProfileMetricsService-method-action-types';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,wBAAwB,EACxB,uCAAuC,EACxC,uCAAmC;AAOpC,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,oCAAgC","sourcesContent":["export type {\n  ProfileMetricsControllerActions,\n  ProfileMetricsControllerEvents,\n  ProfileMetricsControllerGetStateAction,\n  ProfileMetricsControllerMessenger,\n  ProfileMetricsControllerState,\n  ProfileMetricsControllerStateChangeEvent,\n} from './ProfileMetricsController';\nexport {\n  ProfileMetricsController,\n  getDefaultProfileMetricsControllerState,\n} from './ProfileMetricsController';\nexport type {\n  ProfileMetricsServiceActions,\n  ProfileMetricsServiceEvents,\n  ProfileMetricsServiceMessenger,\n  ProfileMetricsSubmitMetricsRequest,\n} from './ProfileMetricsService';\nexport { ProfileMetricsService, serviceName } from './ProfileMetricsService';\nexport type { ProfileMetricsServiceMethodActions } from './ProfileMetricsService-method-action-types';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/profile-metrics-controller",
-  "version": "0.0.0-preview-d6fe4594",
+  "version": "1.0.0-preview-84f90603",
   "description": "Sample package to illustrate best practices for controllers",
   "keywords": [
     "MetaMask",
@@ -48,14 +48,19 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
+    "@metamask/accounts-controller": "^35.0.0",
     "@metamask/base-controller": "^9.0.0",
     "@metamask/controller-utils": "^11.16.0",
+    "@metamask/keyring-controller": "^25.0.0",
     "@metamask/messenger": "^0.3.0",
+    "@metamask/polling-controller": "^16.0.0",
     "@metamask/profile-sync-controller": "^27.0.0",
-    "@metamask/utils": "^11.8.1"
+    "@metamask/utils": "^11.8.1",
+    "async-mutex": "^0.5.0"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/keyring-internal-api": "^9.0.0",
     "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",