feat: add @metamask/profile-metrics-controller (#38177)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->
The `@metamask/profile-metrics-controller` package is being added to the
extension. The package ships two new components and their messengers:
- `ProfileMetricsController`
- `ProfileMetricsService`

Preview build coming from MetaMask/core#7196

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/38177?quickstart=1)

## **Changelog**

<!--
If this PR is not End-User-Facing and should not show up in the
CHANGELOG, you can choose to either:
1. Write `CHANGELOG entry: null`
2. Label with `no-changelog`

If this PR is End-User-Facing, please write a short User-Facing
description in the past tense like:
`CHANGELOG entry: Added a new tab for users to see their NFTs`
`CHANGELOG entry: Fixed a bug that was causing some NFTs to flicker`

(This helps the Release Engineer do their job more quickly and
accurately)
-->

CHANGELOG entry: null

## **Related issues**

* Related to https://consensyssoftware.atlassian.net/browse/WPC-179

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [ ] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Integrates `@metamask/profile-metrics-controller` (controller +
service) with messengers, initialization, state wiring, LavaMoat
policies, and adds E2E/unit tests and fixtures.
> 
> - **Controllers/Services**
> - Add `ProfileMetricsController` and `ProfileMetricsService` to
controller list/types and initialization
(`app/scripts/controller-init/*`, `metamask-controller.js`).
> - Wire controller state into persisted/mem stores and
`ControllerFlatState`.
> - **Messengers**
> - Introduce restricted messengers:
`getProfileMetricsControllerMessenger` and
`getProfileMetricsServiceMessenger`, plus registry entries
(`messengers/index.ts`).
> - **Initialization**
> - New inits: `profile-metrics-controller-init.ts` (feature-flag +
MetaMetrics gated, interval config) and
`profile-metrics-service-init.ts` (bind `fetch`, set SDK env).
> - **Security/Build**
> - Update LavaMoat Browserify/Webpack policies to allow profile-metrics
modules and deps.
> - Add dependency `@metamask/profile-metrics-controller` in
`package.json`.
> - **Tests/Fixtures**
>   - Add unit tests for messengers and inits.
> - Add E2E tests validating API calls based on feature flag and
MetaMetrics opt-in.
> - Update E2E fixtures/state snapshots to include
`ProfileMetricsController` state.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
c162dab. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: MetaMask Bot <[email protected]>
Co-authored-by: Mark Stacey <[email protected]>
Co-authored-by: Elliot Winkler <[email protected]>

Author: 4 people

app/scripts/controller-init/controller-list.ts

@@ -83,6 +83,10 @@ import {
   BackendWebSocketService,
 } from '@metamask/core-backend';
 import { ClaimsController, ClaimsService } from '@metamask/claims-controller';
+import {
+  ProfileMetricsController,
+  ProfileMetricsService,
+} from '@metamask/profile-metrics-controller';
 import OnboardingController from '../controllers/onboarding';
 import { PreferencesController } from '../controllers/preferences-controller';
 import SwapsController from '../controllers/swaps';
@@ -197,7 +201,9 @@ export type Controller =
   | AccountActivityService
   | MultichainAccountService
   | NetworkEnablementController
-  | ClaimsService;
+  | ClaimsService
+  | ProfileMetricsController
+  | ProfileMetricsService;
 
 /**
  * Flat state object for all controllers supporting or required by modular initialization.
@@ -270,4 +276,5 @@ export type ControllerFlatState = AccountOrderController['state'] &
   NftController['state'] &
   NftDetectionController['state'] &
   NetworkEnablementController['state'] &
-  AccountTrackerController['state'];
+  AccountTrackerController['state'] &
+  ProfileMetricsController['state'];

app/scripts/controller-init/messengers/index.ts

@@ -204,6 +204,8 @@ import {
   getClaimsControllerMessenger,
 } from './claims/claims-controller-messenger';
 import { getClaimsServiceMessenger } from './claims/claims-service-messenger';
+import { getProfileMetricsControllerMessenger } from './profile-metrics-controller-messenger';
+import { getProfileMetricsServiceMessenger } from './profile-metrics-service-messenger';
 
 export type { AccountOrderControllerMessenger } from './account-order-controller-messenger';
 export { getAccountOrderControllerMessenger } from './account-order-controller-messenger';
@@ -409,6 +411,8 @@ export {
   getUserOperationControllerMessenger,
   getUserOperationControllerInitMessenger,
 } from './user-operation-controller-messenger';
+export { getProfileMetricsControllerMessenger } from './profile-metrics-controller-messenger';
+export { getProfileMetricsServiceMessenger } from './profile-metrics-service-messenger';
 
 export const CONTROLLER_MESSENGERS = {
   AccountOrderController: {
@@ -765,4 +769,12 @@ export const CONTROLLER_MESSENGERS = {
     getMessenger: getNetworkEnablementControllerMessenger,
     getInitMessenger: getNetworkEnablementControllerInitMessenger,
   },
+  ProfileMetricsController: {
+    getMessenger: getProfileMetricsControllerMessenger,
+    getInitMessenger: noop,
+  },
+  ProfileMetricsService: {
+    getMessenger: getProfileMetricsServiceMessenger,
+    getInitMessenger: noop,
+  },
 } as const;

app/scripts/controller-init/messengers/profile-metrics-controller-messenger.test.ts

@@ -0,0 +1,13 @@
+import { Messenger } from '@metamask/messenger';
+import { getRootMessenger } from '../../lib/messenger';
+import { getProfileMetricsControllerMessenger } from './profile-metrics-controller-messenger';
+
+describe('getProfileMetricsControllerMessenger', () => {
+  it('returns a restricted messenger', () => {
+    const messenger = getRootMessenger<never, never>();
+    const profileMetricsControllerMessenger =
+      getProfileMetricsControllerMessenger(messenger);
+
+    expect(profileMetricsControllerMessenger).toBeInstanceOf(Messenger);
+  });
+});

app/scripts/controller-init/messengers/profile-metrics-controller-messenger.ts

@@ -0,0 +1,46 @@
+import { ProfileMetricsControllerMessenger } from '@metamask/profile-metrics-controller';
+import {
+  Messenger,
+  MessengerActions,
+  MessengerEvents,
+} from '@metamask/messenger';
+import { RootMessenger } from '../../lib/messenger';
+
+type AllowedActions = MessengerActions<ProfileMetricsControllerMessenger>;
+
+type AllowedEvents = MessengerEvents<ProfileMetricsControllerMessenger>;
+
+/**
+ * Create a messenger restricted to the allowed actions and events of the
+ * accounts controller.
+ *
+ * @param messenger - The base messenger used to create the restricted
+ * messenger.
+ */
+export function getProfileMetricsControllerMessenger(
+  messenger: RootMessenger<AllowedActions, AllowedEvents>,
+) {
+  const controllerMessenger = new Messenger<
+    'ProfileMetricsController',
+    AllowedActions,
+    AllowedEvents,
+    typeof messenger
+  >({
+    namespace: 'ProfileMetricsController',
+    parent: messenger,
+  });
+  messenger.delegate({
+    messenger: controllerMessenger,
+    actions: [
+      'AccountsController:listAccounts',
+      'ProfileMetricsService:submitMetrics',
+    ],
+    events: [
+      'AccountsController:accountAdded',
+      'AccountsController:accountRemoved',
+      'KeyringController:lock',
+      'KeyringController:unlock',
+    ],
+  });
+  return controllerMessenger;
+}

app/scripts/controller-init/messengers/profile-metrics-service-messenger.test.ts

@@ -0,0 +1,13 @@
+import { Messenger } from '@metamask/messenger';
+import { getRootMessenger } from '../../lib/messenger';
+import { getProfileMetricsServiceMessenger } from './profile-metrics-service-messenger';
+
+describe('getProfileMetricsServiceMessenger', () => {
+  it('returns a restricted messenger', () => {
+    const messenger = getRootMessenger<never, never>();
+    const profileMetricsServiceMessenger =
+      getProfileMetricsServiceMessenger(messenger);
+
+    expect(profileMetricsServiceMessenger).toBeInstanceOf(Messenger);
+  });
+});

app/scripts/controller-init/messengers/profile-metrics-service-messenger.ts

@@ -0,0 +1,37 @@
+import { ProfileMetricsServiceMessenger } from '@metamask/profile-metrics-controller';
+import {
+  Messenger,
+  MessengerActions,
+  MessengerEvents,
+} from '@metamask/messenger';
+import { RootMessenger } from '../../lib/messenger';
+
+type AllowedActions = MessengerActions<ProfileMetricsServiceMessenger>;
+
+type AllowedEvents = MessengerEvents<ProfileMetricsServiceMessenger>;
+
+/**
+ * Create a messenger restricted to the allowed actions and events of the
+ * accounts controller.
+ *
+ * @param messenger - The base messenger used to create the restricted
+ * messenger.
+ */
+export function getProfileMetricsServiceMessenger(
+  messenger: RootMessenger<AllowedActions, AllowedEvents>,
+): ProfileMetricsServiceMessenger {
+  const serviceMessenger = new Messenger<
+    'ProfileMetricsService',
+    AllowedActions,
+    AllowedEvents,
+    typeof messenger
+  >({
+    namespace: 'ProfileMetricsService',
+    parent: messenger,
+  });
+  messenger.delegate({
+    messenger: serviceMessenger,
+    actions: ['AuthenticationController:getBearerToken'],
+  });
+  return serviceMessenger;
+}

app/scripts/controller-init/profile-metrics-controller-init.test.ts

@@ -0,0 +1,45 @@
+import {
+  ProfileMetricsController,
+  ProfileMetricsControllerMessenger,
+} from '@metamask/profile-metrics-controller';
+import { getRootMessenger } from '../lib/messenger';
+import { ControllerInitRequest } from './types';
+import { buildControllerInitRequestMock } from './test/utils';
+import { getProfileMetricsControllerMessenger } from './messengers';
+import { ProfileMetricsControllerInit } from './profile-metrics-controller-init';
+
+jest.mock('@metamask/profile-metrics-controller');
+
+function getInitRequestMock(): jest.Mocked<
+  ControllerInitRequest<ProfileMetricsControllerMessenger>
+> {
+  const baseMessenger = getRootMessenger<never, never>();
+
+  const requestMock = {
+    ...buildControllerInitRequestMock(),
+    controllerMessenger: getProfileMetricsControllerMessenger(baseMessenger),
+    initMessenger: undefined,
+  };
+
+  return requestMock;
+}
+
+describe('ProfileMetricsControllerInit', () => {
+  it('initializes the controller', () => {
+    const { controller } = ProfileMetricsControllerInit(getInitRequestMock());
+    expect(controller).toBeInstanceOf(ProfileMetricsController);
+  });
+
+  it('passes the proper arguments to the controller', () => {
+    ProfileMetricsControllerInit(getInitRequestMock());
+
+    const controllerMock = jest.mocked(ProfileMetricsController);
+    expect(controllerMock).toHaveBeenCalledWith({
+      messenger: expect.any(Object),
+      state: undefined,
+      interval: expect.any(Number),
+      assertUserOptedIn: expect.any(Function),
+      getMetaMetricsId: expect.any(Function),
+    });
+  });
+});

app/scripts/controller-init/profile-metrics-controller-init.ts

@@ -0,0 +1,42 @@
+import {
+  ProfileMetricsController,
+  ProfileMetricsControllerMessenger,
+} from '@metamask/profile-metrics-controller';
+import type { ControllerInitFunction } from './types';
+
+const isTestEnvironment = Boolean(process.env.IN_TEST);
+
+/**
+ * Initialize the profile metrics controller.
+ *
+ * @param request - The request object.
+ * @param request.controllerMessenger - The messenger to use for the controller.
+ * @param request.persistedState - The persisted state to use for the
+ * controller.
+ * @param request.getController - A function to get other initialized controllers.
+ * @returns The initialized controller.
+ */
+export const ProfileMetricsControllerInit: ControllerInitFunction<
+  ProfileMetricsController,
+  ProfileMetricsControllerMessenger
+> = ({ controllerMessenger, persistedState, getController }) => {
+  const remoteFeatureFlagController = getController(
+    'RemoteFeatureFlagController',
+  );
+  const metaMetricsController = getController('MetaMetricsController');
+  const assertUserOptedIn = () =>
+    remoteFeatureFlagController.state.remoteFeatureFlags.extensionUxPna25 ===
+      true && metaMetricsController.state.participateInMetaMetrics === true;
+
+  const controller = new ProfileMetricsController({
+    messenger: controllerMessenger,
+    state: persistedState.ProfileMetricsController,
+    interval: isTestEnvironment ? 1000 : 10 * 1000,
+    assertUserOptedIn,
+    getMetaMetricsId: () => metaMetricsController.getMetaMetricsId(),
+  });
+
+  return {
+    controller,
+  };
+};

app/scripts/controller-init/profile-metrics-service-init.test.ts

@@ -0,0 +1,44 @@
+import {
+  ProfileMetricsService,
+  ProfileMetricsServiceMessenger,
+} from '@metamask/profile-metrics-controller';
+import { SDK } from '@metamask/profile-sync-controller';
+import { getRootMessenger } from '../lib/messenger';
+import { ControllerInitRequest } from './types';
+import { buildControllerInitRequestMock } from './test/utils';
+import { getProfileMetricsServiceMessenger } from './messengers';
+import { ProfileMetricsServiceInit } from './profile-metrics-service-init';
+
+jest.mock('@metamask/profile-metrics-controller');
+
+function getInitRequestMock(): jest.Mocked<
+  ControllerInitRequest<ProfileMetricsServiceMessenger>
+> {
+  const baseMessenger = getRootMessenger<never, never>();
+
+  const requestMock = {
+    ...buildControllerInitRequestMock(),
+    controllerMessenger: getProfileMetricsServiceMessenger(baseMessenger),
+    initMessenger: undefined,
+  };
+
+  return requestMock;
+}
+
+describe('ProfileMetricsServiceInit', () => {
+  it('initializes the service', () => {
+    const { controller } = ProfileMetricsServiceInit(getInitRequestMock());
+    expect(controller).toBeInstanceOf(ProfileMetricsService);
+  });
+
+  it('passes the proper arguments to the controller', () => {
+    ProfileMetricsServiceInit(getInitRequestMock());
+
+    const controllerMock = jest.mocked(ProfileMetricsService);
+    expect(controllerMock).toHaveBeenCalledWith({
+      messenger: expect.any(Object),
+      fetch: expect.any(Function),
+      env: SDK.Env.PRD,
+    });
+  });
+});

app/scripts/controller-init/profile-metrics-service-init.ts

@@ -0,0 +1,33 @@
+import {
+  ProfileMetricsService,
+  ProfileMetricsServiceMessenger,
+} from '@metamask/profile-metrics-controller';
+import { SDK } from '@metamask/profile-sync-controller';
+import { ControllerInitFunction } from './types';
+
+/**
+ * Initialize the profile metrics service.
+ *
+ * @param request - The request object.
+ * @param request.controllerMessenger - The messenger to use for the service.
+ * @returns The initialized controller.
+ */
+export const ProfileMetricsServiceInit: ControllerInitFunction<
+  ProfileMetricsService,
+  ProfileMetricsServiceMessenger
+> = ({ controllerMessenger }) => {
+  // The environment must be the same used by AuthenticationController.
+  const env = SDK.Env.PRD;
+
+  const controller = new ProfileMetricsService({
+    messenger: controllerMessenger,
+    fetch: fetch.bind(globalThis),
+    env,
+  });
+
+  return {
+    persistedStateKey: null,
+    memStateKey: null,
+    controller,
+  };
+};