feat(analytics-controller): add persisted event queue#8797
feat(analytics-controller): add persisted event queue#8797gauthierpetetin wants to merge 6 commits into
Conversation
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit c43147b. Configure here.
| if (queuedEvent.type === 'track') { | ||
| this.#platformAdapter.track( | ||
| queuedEvent.eventName, | ||
| queuedEvent.properties, |
There was a problem hiding this comment.
[P2] #enqueueEvent stores queuedEvent in controller state before delivery, and BaseController.update deep-freezes controller state. #sendQueuedEvent then passes the same properties/traits object to the platform adapter. If an adapter normalizes or augments the payload in place, that mutation can throw, the catch leaves the event in the queue, and every retry can fail the same way. Please pass a mutable clone to the adapter while keeping the persisted queue entry immutable.
| state.optedIn = false; | ||
| }); | ||
|
|
||
| if (this.#isEventQueuePersistenceEnabled) { |
There was a problem hiding this comment.
[P3] optOut() only clears eventQueue when isEventQueuePersistenceEnabled is currently true. If queued payloads already exist from a previous enabled session and the feature is later disabled, opting out leaves those payloads persisted. If the user opts back in and queue persistence is re-enabled, old pre-opt-out analytics events can replay. Please clear any existing queue on opt-out regardless of the current feature flag.

Explanation
Adds optional persisted event queue support to @metamask/analytics-controller.
The feature is disabled by default and can be enabled by clients that do not have SDK-level persistence. When enabled, final analytics payloads are persisted before delivery and removed only after the platform adapter reports successful delivery.
References
NA
Checklist
Note
Medium Risk
Adds optional persistence/replay of analytics delivery payloads and changes adapter method signatures to accept delivery callbacks/options, which could affect client adapters if typings/implementations aren’t updated. Default behavior is unchanged when the feature flag is off.
Overview
Adds an opt-in persisted delivery queue to
AnalyticsController(isEventQueuePersistenceEnabled) that storestrack/identify/viewadapter payloads bymessageIduntil the adapter acknowledges success via a callback, and replays queued payloads oninit(dropping invalid entries and clearing the queue when opted out).Extends
AnalyticsPlatformAdaptermethods to accept optionalAnalyticsDeliveryOptions(messageId,timestamp,callback), addseventQueueto controller state metadata as persisted but excluded from logs/debug snapshots/UI, and updates docs, exports, deps (uuid), and tests to cover the new behavior.Reviewed by Cursor Bugbot for commit 0a79f0e. Bugbot is set up for automated code reviews on this repo. Configure here.