@metamask-previews/profile-metrics-controller 0.0.0-preview-e0d310b4

package/dist/ProfileMetricsController.mjs

@@ -0,0 +1,225 @@
+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 userProfileControllerMetadata = {
+    firstSyncCompleted: {
+        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 {
+        firstSyncCompleted: 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: userProfileControllerMetadata,
+            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 () => {
+            for (const [entropySourceId, accounts] of Object.entries(this.state.syncQueue)) {
+                await this.messenger.call('ProfileMetricsService:updateProfile', {
+                    metametricsId: __classPrivateFieldGet(this, _ProfileMetricsController_getMetaMetricsId, "f").call(this),
+                    entropySourceId: entropySourceId === 'null' ? null : entropySourceId,
+                    accounts,
+                });
+                this.update((state) => {
+                    delete state.syncQueue[entropySourceId];
+                });
+            }
+        });
+    }
+}
+_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.firstSyncCompleted || !__classPrivateFieldGet(this, _ProfileMetricsController_assertUserOptedIn, "f").call(this)) {
+            return;
+        }
+        const newGroupedAccounts = groupAccountsByEntropySourceId(this.messenger.call('AccountsController:listAccounts'));
+        const queuedAddresses = { ...this.state.syncQueue };
+        for (const key of Object.keys(newGroupedAccounts)) {
+            if (!queuedAddresses[key]) {
+                queuedAddresses[key] = [];
+            }
+            queuedAddresses[key].push(...newGroupedAccounts[key]);
+        }
+        this.update((state) => {
+            state.firstSyncCompleted = true;
+            state.syncQueue = queuedAddresses;
+        });
+    });
+}, _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 () => {
+        if (!__classPrivateFieldGet(this, _ProfileMetricsController_assertUserOptedIn, "f").call(this)) {
+            return;
+        }
+        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;AAmBzD;;GAEG;AACH,MAAM,6BAA6B,GAAG;IACpC,kBAAkB,EAAE;QAClB,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,kBAAkB,EAAE,KAAK;QACzB,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,6BAA6B;YACvC,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,KAAK,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CACtD,IAAI,CAAC,KAAK,CAAC,SAAS,CACrB,EAAE,CAAC;gBACF,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,qCAAqC,EAAE;oBAC/D,aAAa,EAAE,uBAAA,IAAI,kDAAkB,MAAtB,IAAI,CAAoB;oBACvC,eAAe,EAAE,eAAe,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,eAAe;oBACpE,QAAQ;iBACT,CAAC,CAAC;gBACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,OAAO,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;gBAC1C,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CA+EF;;AA7EC;;;;;GAKG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,uCAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;QACxC,IAAI,IAAI,CAAC,KAAK,CAAC,kBAAkB,IAAI,CAAC,uBAAA,IAAI,mDAAmB,MAAvB,IAAI,CAAqB,EAAE,CAAC;YAChE,OAAO;QACT,CAAC;QACD,MAAM,kBAAkB,GAAG,8BAA8B,CACvD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CACvD,CAAC;QACF,MAAM,eAAe,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;QACpD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAClD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;YAC5B,CAAC;YACD,eAAe,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC;YAChC,KAAK,CAAC,SAAS,GAAG,eAAe,CAAC;QACpC,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,uBAAA,IAAI,mDAAmB,MAAvB,IAAI,CAAqB,EAAE,CAAC;YAC/B,OAAO;QACT,CAAC;QACD,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 the first sync has been completed.\n   */\n  firstSyncCompleted: 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 userProfileControllerMetadata = {\n  firstSyncCompleted: {\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    firstSyncCompleted: 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: userProfileControllerMetadata,\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      for (const [entropySourceId, accounts] of Object.entries(\n        this.state.syncQueue,\n      )) {\n        await this.messenger.call('ProfileMetricsService:updateProfile', {\n          metametricsId: this.#getMetaMetricsId(),\n          entropySourceId: entropySourceId === 'null' ? null : entropySourceId,\n          accounts,\n        });\n        this.update((state) => {\n          delete state.syncQueue[entropySourceId];\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.firstSyncCompleted || !this.#assertUserOptedIn()) {\n        return;\n      }\n      const newGroupedAccounts = groupAccountsByEntropySourceId(\n        this.messenger.call('AccountsController:listAccounts'),\n      );\n      const queuedAddresses = { ...this.state.syncQueue };\n      for (const key of Object.keys(newGroupedAccounts)) {\n        if (!queuedAddresses[key]) {\n          queuedAddresses[key] = [];\n        }\n        queuedAddresses[key].push(...newGroupedAccounts[key]);\n      }\n      this.update((state) => {\n        state.firstSyncCompleted = true;\n        state.syncQueue = queuedAddresses;\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      if (!this.#assertUserOptedIn()) {\n        return;\n      }\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/ProfileMetricsService-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ProfileMetricsService-method-action-types.cjs.map

package/dist/ProfileMetricsService-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileMetricsService-method-action-types.cjs","sourceRoot":"","sources":["../src/ProfileMetricsService-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { ProfileMetricsService } from './ProfileMetricsService';\n\n/**\n * Makes a request to the API in order to update the user profile.\n *\n * @param data - The data to send in the profile update request.\n * @returns The response from the API.\n */\nexport type ProfileMetricsServiceUpdateProfileAction = {\n  type: `ProfileMetricsService:updateProfile`;\n  handler: ProfileMetricsService['updateProfile'];\n};\n\n/**\n * Union of all ProfileMetricsService action types.\n */\nexport type ProfileMetricsServiceMethodActions =\n  ProfileMetricsServiceUpdateProfileAction;\n"]}

package/dist/ProfileMetricsService-method-action-types.d.cts

@@ -0,0 +1,20 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { ProfileMetricsService } from "./ProfileMetricsService.cjs";
+/**
+ * Makes a request to the API in order to update the user profile.
+ *
+ * @param data - The data to send in the profile update request.
+ * @returns The response from the API.
+ */
+export type ProfileMetricsServiceUpdateProfileAction = {
+    type: `ProfileMetricsService:updateProfile`;
+    handler: ProfileMetricsService['updateProfile'];
+};
+/**
+ * Union of all ProfileMetricsService action types.
+ */
+export type ProfileMetricsServiceMethodActions = ProfileMetricsServiceUpdateProfileAction;
+//# sourceMappingURL=ProfileMetricsService-method-action-types.d.cts.map

package/dist/ProfileMetricsService-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileMetricsService-method-action-types.d.cts","sourceRoot":"","sources":["../src/ProfileMetricsService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,oCAAgC;AAErE;;;;;GAKG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,qBAAqB,CAAC,eAAe,CAAC,CAAC;CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAC5C,wCAAwC,CAAC"}

package/dist/ProfileMetricsService-method-action-types.d.mts

@@ -0,0 +1,20 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { ProfileMetricsService } from "./ProfileMetricsService.mjs";
+/**
+ * Makes a request to the API in order to update the user profile.
+ *
+ * @param data - The data to send in the profile update request.
+ * @returns The response from the API.
+ */
+export type ProfileMetricsServiceUpdateProfileAction = {
+    type: `ProfileMetricsService:updateProfile`;
+    handler: ProfileMetricsService['updateProfile'];
+};
+/**
+ * Union of all ProfileMetricsService action types.
+ */
+export type ProfileMetricsServiceMethodActions = ProfileMetricsServiceUpdateProfileAction;
+//# sourceMappingURL=ProfileMetricsService-method-action-types.d.mts.map

package/dist/ProfileMetricsService-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileMetricsService-method-action-types.d.mts","sourceRoot":"","sources":["../src/ProfileMetricsService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,oCAAgC;AAErE;;;;;GAKG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,qBAAqB,CAAC,eAAe,CAAC,CAAC;CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAC5C,wCAAwC,CAAC"}

package/dist/ProfileMetricsService-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=ProfileMetricsService-method-action-types.mjs.map

package/dist/ProfileMetricsService-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileMetricsService-method-action-types.mjs","sourceRoot":"","sources":["../src/ProfileMetricsService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { ProfileMetricsService } from './ProfileMetricsService';\n\n/**\n * Makes a request to the API in order to update the user profile.\n *\n * @param data - The data to send in the profile update request.\n * @returns The response from the API.\n */\nexport type ProfileMetricsServiceUpdateProfileAction = {\n  type: `ProfileMetricsService:updateProfile`;\n  handler: ProfileMetricsService['updateProfile'];\n};\n\n/**\n * Union of all ProfileMetricsService action types.\n */\nexport type ProfileMetricsServiceMethodActions =\n  ProfileMetricsServiceUpdateProfileAction;\n"]}

package/dist/ProfileMetricsService.cjs

@@ -0,0 +1,144 @@
+"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 _a, _ProfileMetricsService_messenger, _ProfileMetricsService_fetch, _ProfileMetricsService_policy, _ProfileMetricsService_baseURL;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProfileMetricsService = exports.serviceName = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+const _1 = require("./index.cjs");
+// === GENERAL ===
+/**
+ * The name of the {@link ProfileMetricsService}, used to namespace the
+ * service's actions and events.
+ */
+exports.serviceName = 'ProfileMetricsService';
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = ['updateProfile'];
+// === SERVICE DEFINITION ===
+class ProfileMetricsService {
+    /**
+     * Constructs a new ProfileMetricsService object.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this service.
+     * @param args.fetch - A function that can be used to make an HTTP request. If
+     * your JavaScript environment supports `fetch` natively, you'll probably want
+     * to pass that; otherwise you can pass an equivalent (such as `fetch` via
+     * `node-fetch`).
+     * @param args.policyOptions - Options to pass to `createServicePolicy`, which
+     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
+     * @param args.env - The environment to determine the correct API endpoints.
+     */
+    constructor({ messenger, fetch: fetchFunction, policyOptions = {}, env = _1.Env.DEV, }) {
+        /**
+         * The messenger suited for this service.
+         */
+        _ProfileMetricsService_messenger.set(this, void 0);
+        /**
+         * A function that can be used to make an HTTP request.
+         */
+        _ProfileMetricsService_fetch.set(this, void 0);
+        /**
+         * The policy that wraps the request.
+         *
+         * @see {@link createServicePolicy}
+         */
+        _ProfileMetricsService_policy.set(this, void 0);
+        /**
+         * The API base URL environment.
+         */
+        _ProfileMetricsService_baseURL.set(this, void 0);
+        this.name = exports.serviceName;
+        __classPrivateFieldSet(this, _ProfileMetricsService_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _ProfileMetricsService_fetch, fetchFunction, "f");
+        __classPrivateFieldSet(this, _ProfileMetricsService_policy, (0, controller_utils_1.createServicePolicy)(policyOptions), "f");
+        __classPrivateFieldSet(this, _ProfileMetricsService_baseURL, (0, _1.getEnvUrl)(env), "f");
+        __classPrivateFieldGet(this, _ProfileMetricsService_messenger, "f").registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Registers a handler that will be called after a request returns a non-500
+     * response, causing a retry. Primarily useful in tests where timers are being
+     * mocked.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler. See
+     * {@link CockatielEvent}.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener) {
+        return __classPrivateFieldGet(this, _ProfileMetricsService_policy, "f").onRetry(listener);
+    }
+    /**
+     * Registers a handler that will be called after a set number of retry rounds
+     * prove that requests to the API endpoint consistently return a 5xx response.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler. See
+     * {@link CockatielEvent}.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener) {
+        return __classPrivateFieldGet(this, _ProfileMetricsService_policy, "f").onBreak(listener);
+    }
+    /* eslint-disable jsdoc/check-indentation */
+    /**
+     * Registers a handler that will be called under one of two circumstances:
+     *
+     * 1. After a set number of retries prove that requests to the API
+     * consistently result in one of the following failures:
+     *    1. A connection initiation error
+     *    2. A connection reset error
+     *    3. A timeout error
+     *    4. A non-JSON response
+     *    5. A 502, 503, or 504 response
+     * 2. After a successful request is made to the API, but the response takes
+     * longer than a set duration to return.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler. See
+     * {@link CockatielEvent}.
+     */
+    /* eslint-enable jsdoc/check-indentation */
+    onDegraded(listener) {
+        return __classPrivateFieldGet(this, _ProfileMetricsService_policy, "f").onDegraded(listener);
+    }
+    /**
+     * Makes a request to the API in order to update the user profile.
+     *
+     * @param data - The data to send in the profile update request.
+     * @returns The response from the API.
+     */
+    async updateProfile(data) {
+        const authToken = await __classPrivateFieldGet(this, _ProfileMetricsService_messenger, "f").call('AuthenticationController:getBearerToken', data.entropySourceId || undefined);
+        await __classPrivateFieldGet(this, _ProfileMetricsService_policy, "f").execute(async () => {
+            const url = new URL(`${__classPrivateFieldGet(this, _ProfileMetricsService_baseURL, "f")}/profile/accounts`);
+            const localResponse = await __classPrivateFieldGet(this, _ProfileMetricsService_fetch, "f").call(this, url, {
+                method: 'PUT',
+                headers: {
+                    Authorization: `Bearer ${authToken}`,
+                    'Content-Type': 'application/json',
+                },
+                body: JSON.stringify({
+                    metametrics_id: data.metametricsId,
+                    accounts: data.accounts,
+                }),
+            });
+            if (!localResponse.ok) {
+                throw new controller_utils_1.HttpError(localResponse.status, `Fetching '${url.toString()}' failed with status '${localResponse.status}'`);
+            }
+            return localResponse;
+        });
+    }
+}
+exports.ProfileMetricsService = ProfileMetricsService;
+_a = ProfileMetricsService, _ProfileMetricsService_messenger = new WeakMap(), _ProfileMetricsService_fetch = new WeakMap(), _ProfileMetricsService_policy = new WeakMap(), _ProfileMetricsService_baseURL = new WeakMap();
+//# sourceMappingURL=ProfileMetricsService.cjs.map

package/dist/ProfileMetricsService.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileMetricsService.cjs","sourceRoot":"","sources":["../src/ProfileMetricsService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAIA,iEAA4E;AAI5E,kCAA4E;AAE5E,kBAAkB;AAElB;;;GAGG;AACU,QAAA,WAAW,GAAG,uBAAuB,CAAC;AAmBnD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,eAAe,CAAU,CAAC;AAkC7D,6BAA6B;AAE7B,MAAa,qBAAqB;IAgChC;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EAAE,aAAa,EACpB,aAAa,GAAG,EAAE,EAClB,GAAG,GAAG,MAAG,CAAC,GAAG,GAMd;QAjDD;;WAEG;QACM,mDAES;QAElB;;WAEG;QACM,+CAEK;QAEd;;;;WAIG;QACM,gDAAuB;QAEhC;;WAEG;QACM,iDAAiB;QA0BxB,IAAI,CAAC,IAAI,GAAG,mBAAW,CAAC;QACxB,uBAAA,IAAI,oCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,gCAAU,aAAa,MAAA,CAAC;QAC5B,uBAAA,IAAI,iCAAW,IAAA,sCAAmB,EAAC,aAAa,CAAC,MAAA,CAAC;QAClD,uBAAA,IAAI,kCAAY,IAAA,YAAS,EAAC,GAAG,CAAC,MAAA,CAAC;QAE/B,uBAAA,IAAI,wCAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,qCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,qCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,4CAA4C;IAC5C;;;;;;;;;;;;;;;;OAgBG;IACH,2CAA2C;IAC3C,UAAU,CAAC,QAAoD;QAC7D,OAAO,uBAAA,IAAI,qCAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,IAAiC;QACnD,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,wCAAW,CAAC,IAAI,CAC1C,yCAAyC,EACzC,IAAI,CAAC,eAAe,IAAI,SAAS,CAClC,CAAC;QACF,MAAM,uBAAA,IAAI,qCAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACpC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,uBAAA,IAAI,sCAAS,mBAAmB,CAAC,CAAC;YACzD,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,oCAAO,MAAX,IAAI,EAAQ,GAAG,EAAE;gBAC3C,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,aAAa,EAAE,UAAU,SAAS,EAAE;oBACpC,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,cAAc,EAAE,IAAI,CAAC,aAAa;oBAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ;iBACxB,CAAC;aACH,CAAC,CAAC;YACH,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;gBACtB,MAAM,IAAI,4BAAS,CACjB,aAAa,CAAC,MAAM,EACpB,aAAa,GAAG,CAAC,QAAQ,EAAE,yBAAyB,aAAa,CAAC,MAAM,GAAG,CAC5E,CAAC;YACJ,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAvJD,sDAuJC","sourcesContent":["import type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from '@metamask/controller-utils';\nimport { createServicePolicy, HttpError } from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { AuthenticationController } from '@metamask/profile-sync-controller';\n\nimport { type ProfileMetricsServiceMethodActions, Env, getEnvUrl } from '.';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link ProfileMetricsService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'ProfileMetricsService';\n\n/**\n * An account address along with its associated scopes.\n */\nexport type AccountWithScopes = {\n  address: string;\n  scopes: `${string}:${string}`[];\n};\n\n/**\n * The shape of the request object for updating the user profile.\n */\nexport type ProfileMetricsUpdateRequest = {\n  metametricsId: string;\n  entropySourceId?: string | null;\n  accounts: AccountWithScopes[];\n};\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['updateProfile'] as const;\n\n/**\n * Actions that {@link ProfileMetricsService} exposes to other consumers.\n */\nexport type ProfileMetricsServiceActions = ProfileMetricsServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link ProfileMetricsService} calls.\n */\ntype AllowedActions =\n  AuthenticationController.AuthenticationControllerGetBearerToken;\n\n/**\n * Events that {@link ProfileMetricsService} exposes to other consumers.\n */\nexport type ProfileMetricsServiceEvents = never;\n\n/**\n * Events from other messengers that {@link ProfileMetricsService} subscribes\n * to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link ProfileMetricsService}.\n */\nexport type ProfileMetricsServiceMessenger = Messenger<\n  typeof serviceName,\n  ProfileMetricsServiceActions | AllowedActions,\n  ProfileMetricsServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\nexport class ProfileMetricsService {\n  /**\n   * The name of the service.\n   */\n  readonly name: typeof serviceName;\n\n  /**\n   * The messenger suited for this service.\n   */\n  readonly #messenger: ConstructorParameters<\n    typeof ProfileMetricsService\n  >[0]['messenger'];\n\n  /**\n   * A function that can be used to make an HTTP request.\n   */\n  readonly #fetch: ConstructorParameters<\n    typeof ProfileMetricsService\n  >[0]['fetch'];\n\n  /**\n   * The policy that wraps the request.\n   *\n   * @see {@link createServicePolicy}\n   */\n  readonly #policy: ServicePolicy;\n\n  /**\n   * The API base URL environment.\n   */\n  readonly #baseURL: string;\n\n  /**\n   * Constructs a new ProfileMetricsService object.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this service.\n   * @param args.fetch - A function that can be used to make an HTTP request. If\n   * your JavaScript environment supports `fetch` natively, you'll probably want\n   * to pass that; otherwise you can pass an equivalent (such as `fetch` via\n   * `node-fetch`).\n   * @param args.policyOptions - Options to pass to `createServicePolicy`, which\n   * is used to wrap each request. See {@link CreateServicePolicyOptions}.\n   * @param args.env - The environment to determine the correct API endpoints.\n   */\n  constructor({\n    messenger,\n    fetch: fetchFunction,\n    policyOptions = {},\n    env = Env.DEV,\n  }: {\n    messenger: ProfileMetricsServiceMessenger;\n    fetch: typeof fetch;\n    policyOptions?: CreateServicePolicyOptions;\n    env?: Env;\n  }) {\n    this.name = serviceName;\n    this.#messenger = messenger;\n    this.#fetch = fetchFunction;\n    this.#policy = createServicePolicy(policyOptions);\n    this.#baseURL = getEnvUrl(env);\n\n    this.#messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Registers a handler that will be called after a request returns a non-500\n   * response, causing a retry. Primarily useful in tests where timers are being\n   * mocked.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]) {\n    return this.#policy.onRetry(listener);\n  }\n\n  /**\n   * Registers a handler that will be called after a set number of retry rounds\n   * prove that requests to the API endpoint consistently return a 5xx response.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]) {\n    return this.#policy.onBreak(listener);\n  }\n\n  /* eslint-disable jsdoc/check-indentation */\n  /**\n   * Registers a handler that will be called under one of two circumstances:\n   *\n   * 1. After a set number of retries prove that requests to the API\n   * consistently result in one of the following failures:\n   *    1. A connection initiation error\n   *    2. A connection reset error\n   *    3. A timeout error\n   *    4. A non-JSON response\n   *    5. A 502, 503, or 504 response\n   * 2. After a successful request is made to the API, but the response takes\n   * longer than a set duration to return.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   */\n  /* eslint-enable jsdoc/check-indentation */\n  onDegraded(listener: Parameters<ServicePolicy['onDegraded']>[0]) {\n    return this.#policy.onDegraded(listener);\n  }\n\n  /**\n   * Makes a request to the API in order to update the user profile.\n   *\n   * @param data - The data to send in the profile update request.\n   * @returns The response from the API.\n   */\n  async updateProfile(data: ProfileMetricsUpdateRequest): Promise<void> {\n    const authToken = await this.#messenger.call(\n      'AuthenticationController:getBearerToken',\n      data.entropySourceId || undefined,\n    );\n    await this.#policy.execute(async () => {\n      const url = new URL(`${this.#baseURL}/profile/accounts`);\n      const localResponse = await this.#fetch(url, {\n        method: 'PUT',\n        headers: {\n          Authorization: `Bearer ${authToken}`,\n          'Content-Type': 'application/json',\n        },\n        body: JSON.stringify({\n          metametrics_id: data.metametricsId,\n          accounts: data.accounts,\n        }),\n      });\n      if (!localResponse.ok) {\n        throw new HttpError(\n          localResponse.status,\n          `Fetching '${url.toString()}' failed with status '${localResponse.status}'`,\n        );\n      }\n      return localResponse;\n    });\n  }\n}\n"]}

package/dist/ProfileMetricsService.d.cts

@@ -0,0 +1,120 @@
+import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
+import type { Messenger } from "@metamask/messenger";
+import type { AuthenticationController } from "@metamask/profile-sync-controller";
+import { type ProfileMetricsServiceMethodActions, Env } from "./index.cjs";
+/**
+ * The name of the {@link ProfileMetricsService}, used to namespace the
+ * service's actions and events.
+ */
+export declare const serviceName = "ProfileMetricsService";
+/**
+ * An account address along with its associated scopes.
+ */
+export type AccountWithScopes = {
+    address: string;
+    scopes: `${string}:${string}`[];
+};
+/**
+ * The shape of the request object for updating the user profile.
+ */
+export type ProfileMetricsUpdateRequest = {
+    metametricsId: string;
+    entropySourceId?: string | null;
+    accounts: AccountWithScopes[];
+};
+/**
+ * Actions that {@link ProfileMetricsService} exposes to other consumers.
+ */
+export type ProfileMetricsServiceActions = ProfileMetricsServiceMethodActions;
+/**
+ * Actions from other messengers that {@link ProfileMetricsService} calls.
+ */
+type AllowedActions = AuthenticationController.AuthenticationControllerGetBearerToken;
+/**
+ * Events that {@link ProfileMetricsService} exposes to other consumers.
+ */
+export type ProfileMetricsServiceEvents = never;
+/**
+ * Events from other messengers that {@link ProfileMetricsService} subscribes
+ * to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger which is restricted to actions and events accessed by
+ * {@link ProfileMetricsService}.
+ */
+export type ProfileMetricsServiceMessenger = Messenger<typeof serviceName, ProfileMetricsServiceActions | AllowedActions, ProfileMetricsServiceEvents | AllowedEvents>;
+export declare class ProfileMetricsService {
+    #private;
+    /**
+     * The name of the service.
+     */
+    readonly name: typeof serviceName;
+    /**
+     * Constructs a new ProfileMetricsService object.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this service.
+     * @param args.fetch - A function that can be used to make an HTTP request. If
+     * your JavaScript environment supports `fetch` natively, you'll probably want
+     * to pass that; otherwise you can pass an equivalent (such as `fetch` via
+     * `node-fetch`).
+     * @param args.policyOptions - Options to pass to `createServicePolicy`, which
+     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
+     * @param args.env - The environment to determine the correct API endpoints.
+     */
+    constructor({ messenger, fetch: fetchFunction, policyOptions, env, }: {
+        messenger: ProfileMetricsServiceMessenger;
+        fetch: typeof fetch;
+        policyOptions?: CreateServicePolicyOptions;
+        env?: Env;
+    });
+    /**
+     * Registers a handler that will be called after a request returns a non-500
+     * response, causing a retry. Primarily useful in tests where timers are being
+     * mocked.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler. See
+     * {@link CockatielEvent}.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): import("cockatiel").IDisposable;
+    /**
+     * Registers a handler that will be called after a set number of retry rounds
+     * prove that requests to the API endpoint consistently return a 5xx response.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler. See
+     * {@link CockatielEvent}.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): import("cockatiel").IDisposable;
+    /**
+     * Registers a handler that will be called under one of two circumstances:
+     *
+     * 1. After a set number of retries prove that requests to the API
+     * consistently result in one of the following failures:
+     *    1. A connection initiation error
+     *    2. A connection reset error
+     *    3. A timeout error
+     *    4. A non-JSON response
+     *    5. A 502, 503, or 504 response
+     * 2. After a successful request is made to the API, but the response takes
+     * longer than a set duration to return.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler. See
+     * {@link CockatielEvent}.
+     */
+    onDegraded(listener: Parameters<ServicePolicy['onDegraded']>[0]): import("cockatiel").IDisposable;
+    /**
+     * Makes a request to the API in order to update the user profile.
+     *
+     * @param data - The data to send in the profile update request.
+     * @returns The response from the API.
+     */
+    updateProfile(data: ProfileMetricsUpdateRequest): Promise<void>;
+}
+export {};
+//# sourceMappingURL=ProfileMetricsService.d.cts.map

package/dist/ProfileMetricsService.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileMetricsService.d.cts","sourceRoot":"","sources":["../src/ProfileMetricsService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AAEpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,wBAAwB,EAAE,0CAA0C;AAElF,OAAO,EAAE,KAAK,kCAAkC,EAAE,GAAG,EAAa,oBAAU;AAI5E;;;GAGG;AACH,eAAO,MAAM,WAAW,0BAA0B,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,EAAE,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC/B,CAAC;AAMF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,kCAAkC,CAAC;AAE9E;;GAEG;AACH,KAAK,cAAc,GACjB,wBAAwB,CAAC,sCAAsC,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAAC;AAEhD;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,SAAS,CACpD,OAAO,WAAW,EAClB,4BAA4B,GAAG,cAAc,EAC7C,2BAA2B,GAAG,aAAa,CAC5C,CAAC;AAIF,qBAAa,qBAAqB;;IAChC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IA4BlC;;;;;;;;;;;;OAYG;gBACS,EACV,SAAS,EACT,KAAK,EAAE,aAAa,EACpB,aAAkB,EAClB,GAAa,GACd,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,aAAa,CAAC,EAAE,0BAA0B,CAAC;QAC3C,GAAG,CAAC,EAAE,GAAG,CAAC;KACX;IAaD;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAIzD;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAKzD;;;;;;;;;;;;;;;;OAgBG;IAEH,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAI/D;;;;;OAKG;IACG,aAAa,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;CA2BtE"}