feat: add ProfileMetricsController to @metamask/profile-metrics-controller
#7196
+984
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ser-profile-controller-queue
mikesposito
force-pushed
the
mikesposito/user-profile-controller
branch
from
522b8f7 to
747f8f7
Compare
…ser-profile-controller-queue
…ser-profile-controller-queue
…ser-profile-controller-queue
4 tasks
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
packages/profile-metrics-controller/src/ProfileMetricsController.ts
Outdated
Show resolved
Hide resolved
Member
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
danroc
reviewed
Nov 27, 2025
packages/profile-metrics-controller/src/ProfileMetricsController.ts
Outdated
Show resolved
Hide resolved
danroc
reviewed
Nov 27, 2025
packages/profile-metrics-controller/src/ProfileMetricsController.ts
Outdated
Show resolved
Hide resolved
danroc
reviewed
Nov 27, 2025
danroc
reviewed
Nov 27, 2025
packages/profile-metrics-controller/src/ProfileMetricsController.ts
Outdated
Show resolved
Hide resolved
…tadata` Co-authored-by: Daniel Rocha <68558152+danroc@users.noreply.github.com>
danroc
previously approved these changes
Nov 27, 2025
cryptodev-2s
previously approved these changes
Nov 27, 2025
mikesposito
dismissed stale reviews from cryptodev-2s and danroc
via
f4611d4
packages/profile-metrics-controller/src/ProfileMetricsController.test.ts
Outdated
Show resolved
Hide resolved
Member
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
| state.syncQueue[key] = []; | ||
| } | ||
| state.syncQueue[key].push(...newGroupedAccounts[key]); | ||
| } |
There was a problem hiding this comment.
Bug: Duplicate accounts added to queue during initial sync
The #queueFirstSyncIfNeeded method appends all accounts from listAccounts to syncQueue without checking if they already exist. If AccountsController:accountAdded events fire before KeyringController:unlock (possible during wallet setup), accounts added by #addAccountToQueue will be duplicated when #queueFirstSyncIfNeeded runs on unlock. The code checks if syncQueue[key] exists but then blindly pushes accounts rather than deduplicating, causing the same accounts to be submitted multiple times to ProfileMetricsService.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
This PR adds
ProfileMetricsControllerto@metamask/profile-metrics-controller.The new controller manages a queue of addresses that need to be sent to
ProfileMetricsServiceThe queue is updated in the following scenarios:
firstSyncCompletedisfalse(i.e., first sync has not been completed yet)The queue is processed at regular intervals (every 10 seconds by default). At each polling interval, if there are items in the queue, the controller will attempt to call
ProfileMetricsServicethrough the messenger to sync addresses in batches, grouped by their entropy source. Accounts with no entropy source will be batched together.The queue is persisted to storage, so that if the app is closed and reopened, the sync process can continue from where it left off. If one of the batch syncs fails, the same batch will be retried in the next interval.
References
Checklist
Note
Adds
ProfileMetricsControllerthat queues accounts and periodically submits grouped metrics via messenger, with persistence, mutexing, and comprehensive tests.src/ProfileMetricsController.tsStaticIntervalPollingController(default 10s) to callProfileMetricsService:submitMetrics.syncQueuegrouped by entropy source (nullfor none); guarded byasync-mutex.KeyringController:unlock/lockandAccountsController:accountAdded/accountRemovedto enqueue/dequeue; initial enqueue on unlock if not completed.initialEnqueueCompleted,syncQueue).src/ProfileMetricsController.test.tscovering subscriptions, polling behavior, batching, failure handling, and state metadata.src/index.tsto export controller types and helpers.@metamask/accounts-controller,@metamask/keyring-controller,@metamask/polling-controller,async-mutex(and dev@metamask/keyring-internal-api).tsconfig.jsonandtsconfig.build.json.CHANGELOG.mdentry for initial release.Written by Cursor Bugbot for commit bc80feb. This will update automatically on new commits. Configure here.