feat: integrate analytics controller

app/scripts/background.js

@@ -1276,7 +1276,7 @@ export async function loadStateFromPersistence(backup) {
  * @param {number} [frameId] - The frame ID from chrome.runtime.MessageSender (0 = top-level, >0 = iframe)
  */
 function emitDappViewedMetricEvent(origin, mainFrameOrigin, frameId) {
-  const { metaMetricsId } = controller.metaMetricsController.state;
+  const { metaMetricsId } = controller.getState();
   if (!shouldEmitDappViewedEvent(metaMetricsId)) {
     return;
   }
@@ -1370,11 +1370,10 @@ function trackDappView(remotePort) {
  * @param {string} environmentType - The environment type where the app is opening
  */
 function emitAppOpenedMetricEvent(environmentType) {
-  const { metaMetricsId, participateInMetaMetrics } =
-    controller.metaMetricsController.state;
+  const { participateInMetaMetrics } = controller.getState();
 
   // Skip if user hasn't opted into metrics
-  if (metaMetricsId === null && !participateInMetaMetrics) {
+  if (!participateInMetaMetrics) {
     return;
   }
 
@@ -2157,20 +2156,16 @@ const addAppInstalledEvent = async (installAttributionPromise) => {
     properties: eventProperties,
   };
 
-  const { participateInMetaMetrics, metaMetricsId } =
-    controller.metaMetricsController.state;
+  const { participateInMetaMetrics, metaMetricsId } = controller.getState();
 
   if (participateInMetaMetrics === false) {
     // We can skip tracking completely if they've already explicitly opted out
     return;
   }
 
-  // Track immediately only once consent is active and the controller has a
-  // persisted MetaMetrics ID. Otherwise keep the event buffered for the opt-in
-  // flush path so it is not dropped.
-  // No need to call getMetaMetricsId() first: setParticipateInMetaMetrics()
-  // generates and persists the ID before setting participation to true, and this
-  // install handler should not create a metrics ID outside that consent path.
+  // Track immediately only once consent is active and the compatibility
+  // MetaMetrics ID is available. Otherwise keep the event buffered for the
+  // opt-in flush path so it is not dropped.
   if (participateInMetaMetrics === true && metaMetricsId) {
     controller.metaMetricsController.trackEvent(appInstalledEvent);
   } else {

app/scripts/constants/sentry-state.ts

@@ -41,6 +41,11 @@ export const SENTRY_BACKGROUND_STATE: SentryBackgroundControllerMasks = {
     unconnectedAccountAlertShownOrigins: false,
     web3ShimUsageOrigins: false,
   },
+  AnalyticsController: {
+    analyticsId: true,
+    eventQueue: false,
+    optedIn: true,
+  },
   AnnouncementController: {
     announcements: false,
   },
@@ -190,12 +195,10 @@ export const SENTRY_BACKGROUND_STATE: SentryBackgroundControllerMasks = {
     isUpdatingMetamaskNotificationsAccount: false,
   },
   MetaMetricsController: {
+    completedMetaMetricsOnboarding: true,
     eventsBeforeMetricsOptIn: false,
     tracesBeforeMetricsOptIn: false,
     fragments: false,
-    metaMetricsId: true,
-    participateInMetaMetrics: true,
-    segmentApiCalls: false,
     traits: false,
     dataCollectionForMarketing: false,
     marketingCampaignCookieId: true,

app/scripts/controllers/analytics/platform-adapter.test.ts

@@ -0,0 +1,245 @@
+import { segment as sharedExtensionSegment } from '../../lib/segment';
+import {
+  METAMETRICS_ANONYMOUS_ID,
+  MetaMetricsEventName,
+} from '../../../../shared/constants/metametrics';
+import {
+  AnonymousTransactionMetaMetricsEvent,
+  TransactionMetaMetricsEvent,
+} from '../../../../shared/constants/transaction';
+import {
+  ANONYMOUS_EVENT_PROPERTY,
+  createPlatformAdapter,
+} from './platform-adapter';
+
+const ANALYTICS_ID = '0xabc123';
+
+type SegmentSpy = {
+  track: jest.SpiedFunction<typeof sharedExtensionSegment.track>;
+  identify: jest.SpiedFunction<typeof sharedExtensionSegment.identify>;
+  page: jest.SpiedFunction<typeof sharedExtensionSegment.page>;
+};
+
+function createSegmentSpy(): SegmentSpy {
+  return {
+    track: jest.spyOn(sharedExtensionSegment, 'track').mockImplementation(),
+    identify: jest
+      .spyOn(sharedExtensionSegment, 'identify')
+      .mockImplementation(),
+    page: jest.spyOn(sharedExtensionSegment, 'page').mockImplementation(),
+  };
+}
+
+function buildAdapter() {
+  const segment = createSegmentSpy();
+  const adapter = createPlatformAdapter();
+  // After PR MetaMask/core#8543 lands, AnalyticsController guarantees
+  // onSetupCompleted runs before track/identify/view; replicate that here.
+  adapter.onSetupCompleted(ANALYTICS_ID);
+  return { adapter, segment };
+}
+
+afterEach(() => {
+  jest.restoreAllMocks();
+});
+
+describe('createPlatformAdapter', () => {
+  describe('skipUUIDv4Check', () => {
+    it('is set to true so non-UUIDv4 extension analyticsIds are accepted', () => {
+      const adapter = createPlatformAdapter();
+      expect(adapter.skipUUIDv4Check).toBe(true);
+    });
+  });
+
+  describe('track', () => {
+    it('calls segment.track with the analyticsId as userId and the event name', () => {
+      const { adapter, segment } = buildAdapter();
+      adapter.track('Wallet Opened');
+      expect(segment.track).toHaveBeenCalledWith(
+        { userId: ANALYTICS_ID, event: 'Wallet Opened' },
+        undefined,
+      );
+    });
+
+    it('forwards properties when provided', () => {
+      const { adapter, segment } = buildAdapter();
+      adapter.track('Wallet Opened', { chainId: '0x1' });
+      expect(segment.track).toHaveBeenCalledWith(
+        {
+          userId: ANALYTICS_ID,
+          event: 'Wallet Opened',
+          properties: { chainId: '0x1' },
+        },
+        undefined,
+      );
+    });
+
+    it('forwards context and delivery options', () => {
+      const { adapter, segment } = buildAdapter();
+      const callback = jest.fn();
+      const timestamp = new Date('2026-01-01T00:00:00Z');
+      adapter.track(
+        'Wallet Opened',
+        { foo: 'bar' },
+        { app: { name: 'MetaMask Extension', version: '1.0.0' } },
+        {
+          messageId: 'msg-1',
+          timestamp,
+          callback,
+        },
+      );
+      expect(segment.track).toHaveBeenCalledWith(
+        {
+          userId: ANALYTICS_ID,
+          event: 'Wallet Opened',
+          properties: { foo: 'bar' },
+          context: { app: { name: 'MetaMask Extension', version: '1.0.0' } },
+          messageId: 'msg-1',
+          timestamp,
+        },
+        callback,
+      );
+    });
+
+    it('downgrades anonymous-marked track payloads to the shared anonymous ID', () => {
+      const { adapter, segment } = buildAdapter();
+      const properties = {
+        foo: 'bar',
+        [ANONYMOUS_EVENT_PROPERTY]: true,
+      };
+
+      adapter.track('Wallet Opened', properties);
+
+      expect(segment.track).toHaveBeenCalledWith(
+        {
+          anonymousId: METAMETRICS_ANONYMOUS_ID,
+          event: 'Wallet Opened',
+          properties: { foo: 'bar' },
+        },
+        undefined,
+      );
+      expect(properties).toStrictEqual({
+        foo: 'bar',
+        [ANONYMOUS_EVENT_PROPERTY]: true,
+      });
+    });
+
+    it('overrides anonymous signature event names', () => {
+      const { adapter, segment } = buildAdapter();
+
+      adapter.track(MetaMetricsEventName.SignatureRequested, {
+        [ANONYMOUS_EVENT_PROPERTY]: true,
+      });
+
+      expect(segment.track).toHaveBeenCalledWith(
+        {
+          anonymousId: METAMETRICS_ANONYMOUS_ID,
+          event: MetaMetricsEventName.SignatureRequestedAnon,
+          properties: {},
+        },
+        undefined,
+      );
+    });
+
+    it('overrides anonymous transaction event names', () => {
+      const { adapter, segment } = buildAdapter();
+
+      adapter.track(TransactionMetaMetricsEvent.submitted, {
+        [ANONYMOUS_EVENT_PROPERTY]: true,
+      });
+
+      expect(segment.track).toHaveBeenCalledWith(
+        {
+          anonymousId: METAMETRICS_ANONYMOUS_ID,
+          event: AnonymousTransactionMetaMetricsEvent.submitted,
+          properties: {},
+        },
+        undefined,
+      );
+    });
+  });
+
+  describe('identify', () => {
+    it('forwards the userId argument from AnalyticsController and traits', () => {
+      const { adapter, segment } = buildAdapter();
+      adapter.identify('user-1', { plan: 'pro' });
+      expect(segment.identify).toHaveBeenCalledWith(
+        { userId: 'user-1', traits: { plan: 'pro' } },
+        undefined,
+      );
+    });
+
+    it('omits traits when not provided', () => {
+      const { adapter, segment } = buildAdapter();
+      adapter.identify('user-1');
+      expect(segment.identify).toHaveBeenCalledWith(
+        { userId: 'user-1' },
+        undefined,
+      );
+    });
+
+    it('forwards context and delivery options', () => {
+      const { adapter, segment } = buildAdapter();
+      const callback = jest.fn();
+      const timestamp = new Date('2026-01-01T00:00:00Z');
+      adapter.identify(
+        'user-1',
+        { plan: 'pro' },
+        { app: { name: 'MetaMask Extension' } },
+        {
+          messageId: 'id-1',
+          timestamp,
+          callback,
+        },
+      );
+      expect(segment.identify).toHaveBeenCalledWith(
+        {
+          userId: 'user-1',
+          traits: { plan: 'pro' },
+          context: { app: { name: 'MetaMask Extension' } },
+          messageId: 'id-1',
+          timestamp,
+        },
+        callback,
+      );
+    });
+  });
+
+  describe('view', () => {
+    it('forwards as a Segment page() call with the analyticsId', () => {
+      const { adapter, segment } = buildAdapter();
+      adapter.view('Home');
+      expect(segment.page).toHaveBeenCalledWith(
+        { userId: ANALYTICS_ID, name: 'Home' },
+        undefined,
+      );
+    });
+
+    it('forwards properties, context, and delivery options', () => {
+      const { adapter, segment } = buildAdapter();
+      const callback = jest.fn();
+      const timestamp = new Date('2026-01-01T00:00:00Z');
+      adapter.view(
+        'Home',
+        { section: 'tokens' },
+        { app: { name: 'MetaMask Extension' } },
+        {
+          messageId: 'page-1',
+          timestamp,
+          callback,
+        },
+      );
+      expect(segment.page).toHaveBeenCalledWith(
+        {
+          userId: ANALYTICS_ID,
+          name: 'Home',
+          properties: { section: 'tokens' },
+          context: { app: { name: 'MetaMask Extension' } },
+          messageId: 'page-1',
+          timestamp,
+        },
+        callback,
+      );
+    });
+  });
+});