feat: cp-7.61.0 add @metamask/profile-metrics-controller (MetaMask#23247)

<!--
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
Mobile client. The package ships two new components and their
messengers:
- `ProfileMetricsController`
- `ProfileMetricsService`

Preview build coming from MetaMask/core#7196

## **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

## **Pre-merge author checklist**

- [ ] I’ve followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/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-mobile/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 `ProfileMetricsController` and `ProfileMetricsService`
across Engine init, messengers, types, state, and tests, and adds
`@metamask/profile-metrics-controller` dependency.
> 
> - **Engine**:
> - Initialize and register `ProfileMetricsController` and
`ProfileMetricsService` in `Engine` init, add to `context`, and expose
`ProfileMetricsController` in `state`.
> - **Controllers/Services**:
> - Add `profile-metrics-controller-init` (uses
`RemoteFeatureFlagController` flag `extensionUxPna25` +
`MetaMetrics.isEnabled` and `metaMetricsId`).
> - Add `profile-metrics-service-init` (binds `fetch`, uses
`SDK.Env.PRD`).
> - **Messengers**:
> - New restricted messengers `profile-metrics-controller-messenger` and
`profile-metrics-service-messenger`; register both in
`CONTROLLER_MESSENGERS`.
> - **Types/Constants**:
> - Extend global actions/events, controller names, `EngineState`,
`ControllersToInitialize` for profile metrics; add
`ProfileMetricsService` to `STATELESS_NON_CONTROLLER_NAMES`; add
`ProfileMetricsController:stateChange` to background events.
> - **State/Fixtures**:
> - Include `ProfileMetricsController` default state in snapshots and
initial background state.
> - **Tests**:
>   - Add init and messenger tests for controller/service.
> - **Dependencies**:
>   - Add `@metamask/profile-metrics-controller` to `package.json`.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
d0e0e4a. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: mikesposito

app/core/Engine/Engine.ts

@@ -173,6 +173,8 @@ import { loggingControllerInit } from './controllers/logging-controller-init';
 import { phishingControllerInit } from './controllers/phishing-controller-init';
 import { addressBookControllerInit } from './controllers/address-book-controller-init';
 import { multichainRouterInit } from './controllers/multichain-router-init';
+import { profileMetricsControllerInit } from './controllers/profile-metrics-controller-init';
+import { profileMetricsServiceInit } from './controllers/profile-metrics-service-init';
 import { Messenger, MessengerEvents } from '@metamask/messenger';
 
 // TODO: Replace "any" with type
@@ -361,6 +363,8 @@ export class Engine {
         RewardsDataService: rewardsDataServiceInit,
         DelegationController: DelegationControllerInit,
         AddressBookController: addressBookControllerInit,
+        ProfileMetricsController: profileMetricsControllerInit,
+        ProfileMetricsService: profileMetricsServiceInit,
       },
       persistedState: initialState as EngineState,
       baseControllerMessenger: this.controllerMessenger,
@@ -393,6 +397,8 @@ export class Engine {
     const preferencesController = controllersByName.PreferencesController;
     const delegationController = controllersByName.DelegationController;
     const addressBookController = controllersByName.AddressBookController;
+    const profileMetricsController = controllersByName.ProfileMetricsController;
+    const profileMetricsService = controllersByName.ProfileMetricsService;
 
     // Backwards compatibility for existing references
     this.accountsController = accountsController;
@@ -539,6 +545,8 @@ export class Engine {
       PredictController: predictController,
       RewardsController: rewardsController,
       DelegationController: delegationController,
+      ProfileMetricsController: profileMetricsController,
+      ProfileMetricsService: profileMetricsService,
     };
 
     const childControllers = Object.assign({}, this.context);
@@ -1329,6 +1337,7 @@ export default {
       MultichainBalancesController,
       MultichainTransactionsController,
       ///: END:ONLY_INCLUDE_IF
+      ProfileMetricsController,
     } = instance.datamodel.state;
 
     return {
@@ -1390,6 +1399,7 @@ export default {
       MultichainBalancesController,
       MultichainTransactionsController,
       ///: END:ONLY_INCLUDE_IF
+      ProfileMetricsController,
     };
   },
 

app/core/Engine/constants.ts

@@ -15,6 +15,7 @@ export const STATELESS_NON_CONTROLLER_NAMES = [
   'BackendWebSocketService',
   'AccountActivityService',
   'MultichainAccountService',
+  'ProfileMetricsService',
 ] as const;
 
 export const BACKGROUND_STATE_CHANGE_EVENT_NAMES = [
@@ -78,6 +79,7 @@ export const BACKGROUND_STATE_CHANGE_EVENT_NAMES = [
   'NetworkEnablementController:stateChange',
   'PredictController:stateChange',
   'DelegationController:stateChange',
+  'ProfileMetricsController:stateChange',
 ] as const;
 
 export const swapsSupportedChainIds = [

app/core/Engine/controllers/profile-metrics-controller-init.test.ts

@@ -0,0 +1,116 @@
+import {
+  ProfileMetricsController,
+  ProfileMetricsControllerMessenger,
+} from '@metamask/profile-metrics-controller';
+import { ControllerInitRequest } from '../types';
+import { profileMetricsControllerInit } from './profile-metrics-controller-init';
+import { ExtendedMessenger } from '../../ExtendedMessenger';
+import { MOCK_ANY_NAMESPACE, MockAnyNamespace } from '@metamask/messenger';
+import { getProfileMetricsControllerMessenger } from '../messengers/profile-metrics-controller-messenger';
+import { buildControllerInitRequestMock } from '../utils/test-utils';
+import { MetaMetrics } from '../../Analytics';
+
+jest.mock('@metamask/profile-metrics-controller');
+
+function getInitRequestMock({
+  metaMetricsId,
+  remoteFeatureFlag,
+  metaMetricsEnabled,
+}: {
+  metaMetricsId: string;
+  remoteFeatureFlag: boolean;
+  metaMetricsEnabled: boolean;
+}): jest.Mocked<ControllerInitRequest<ProfileMetricsControllerMessenger>> {
+  const baseMessenger = new ExtendedMessenger<MockAnyNamespace, never, never>({
+    namespace: MOCK_ANY_NAMESPACE,
+  });
+
+  jest.spyOn(MetaMetrics, 'getInstance').mockReturnValue({
+    isEnabled: () => metaMetricsEnabled,
+  } as MetaMetrics);
+
+  const mockGetController = jest.fn().mockReturnValue({
+    state: {
+      remoteFeatureFlags: { extensionUxPna25: remoteFeatureFlag },
+    },
+  });
+
+  const requestMock = {
+    ...buildControllerInitRequestMock(baseMessenger),
+    controllerMessenger: getProfileMetricsControllerMessenger(baseMessenger),
+    initMessenger: undefined,
+    metaMetricsId,
+    getController: mockGetController,
+  };
+
+  return requestMock;
+}
+
+describe.each([
+  {
+    metaMetricsId: 'dd6395a5-7a84-47b8-8bc3-713170c2f3e8',
+    remoteFeatureFlag: true,
+    metaMetricsEnabled: true,
+  },
+  {
+    metaMetricsId: '898cbad5-7a5e-4ea1-8ca0-822bb4804665',
+    remoteFeatureFlag: false,
+    metaMetricsEnabled: false,
+  },
+  {
+    metaMetricsId: '9c9fe89c-76c3-4ad6-89f8-b76061159458',
+    remoteFeatureFlag: true,
+    metaMetricsEnabled: false,
+  },
+  {
+    metaMetricsId: '5aed4107-f430-4bb0-84c9-1e7031599cc2',
+    remoteFeatureFlag: false,
+    metaMetricsEnabled: true,
+  },
+])(
+  'profileMetricsControllerInit',
+  ({ metaMetricsId, remoteFeatureFlag, metaMetricsEnabled }) => {
+    beforeEach(() => {
+      jest.clearAllMocks();
+    });
+
+    describe(`when metaMetricsId is ${metaMetricsId}, the feature flag value is ${remoteFeatureFlag} and MetaMetrics is ${metaMetricsEnabled ? 'enabled' : 'disabled'}`, () => {
+      it('initializes the controller', () => {
+        const { controller } = profileMetricsControllerInit(
+          getInitRequestMock({
+            metaMetricsId,
+            remoteFeatureFlag,
+            metaMetricsEnabled,
+          }),
+        );
+
+        expect(controller).toBeInstanceOf(ProfileMetricsController);
+      });
+
+      it('passes the proper arguments to the controller', () => {
+        profileMetricsControllerInit(
+          getInitRequestMock({
+            metaMetricsId,
+            remoteFeatureFlag,
+            metaMetricsEnabled,
+          }),
+        );
+
+        const controllerMock = jest.mocked(ProfileMetricsController);
+
+        expect(controllerMock).toHaveBeenCalledWith({
+          messenger: expect.any(Object),
+          state: undefined,
+          assertUserOptedIn: expect.any(Function),
+          getMetaMetricsId: expect.any(Function),
+        });
+        expect(controllerMock.mock.calls[0][0].assertUserOptedIn()).toBe(
+          metaMetricsEnabled && remoteFeatureFlag,
+        );
+        expect(controllerMock.mock.calls[0][0].getMetaMetricsId()).toBe(
+          metaMetricsId,
+        );
+      });
+    });
+  },
+);

app/core/Engine/controllers/profile-metrics-controller-init.ts

@@ -0,0 +1,39 @@
+import {
+  ProfileMetricsController,
+  ProfileMetricsControllerMessenger,
+} from '@metamask/profile-metrics-controller';
+import { ControllerInitFunction } from '../types';
+import { MetaMetrics } from '../../Analytics';
+
+/**
+ * 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, metaMetricsId }) => {
+  const remoteFeatureFlagController = getController(
+    'RemoteFeatureFlagController',
+  );
+  const assertUserOptedIn = () =>
+    remoteFeatureFlagController.state.remoteFeatureFlags.extensionUxPna25 ===
+      true && MetaMetrics.getInstance().isEnabled() === true;
+
+  const controller = new ProfileMetricsController({
+    messenger: controllerMessenger,
+    state: persistedState.ProfileMetricsController,
+    assertUserOptedIn,
+    getMetaMetricsId: () => metaMetricsId,
+  });
+
+  return {
+    controller,
+  };
+};

app/core/Engine/controllers/profile-metrics-service-init.test.ts

@@ -0,0 +1,47 @@
+import {
+  ProfileMetricsService,
+  ProfileMetricsServiceMessenger,
+} from '@metamask/profile-metrics-controller';
+import { SDK } from '@metamask/profile-sync-controller';
+import { ControllerInitRequest } from '../types';
+import { buildControllerInitRequestMock } from '../utils/test-utils';
+import { profileMetricsServiceInit } from './profile-metrics-service-init';
+import { ExtendedMessenger } from '../../ExtendedMessenger';
+import { MOCK_ANY_NAMESPACE, MockAnyNamespace } from '@metamask/messenger';
+import { getProfileMetricsServiceMessenger } from '../messengers/profile-metrics-service-messenger';
+
+jest.mock('@metamask/profile-metrics-controller');
+
+function getInitRequestMock(): jest.Mocked<
+  ControllerInitRequest<ProfileMetricsServiceMessenger>
+> {
+  const baseMessenger = new ExtendedMessenger<MockAnyNamespace, never, never>({
+    namespace: MOCK_ANY_NAMESPACE,
+  });
+
+  const requestMock = {
+    ...buildControllerInitRequestMock(baseMessenger),
+    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/core/Engine/controllers/profile-metrics-service-init.ts

@@ -0,0 +1,31 @@
+import {
+  ProfileMetricsService,
+  ProfileMetricsServiceMessenger,
+} from '@metamask/profile-metrics-controller';
+import { ControllerInitFunction } from '../types';
+import { SDK } from '@metamask/profile-sync-controller';
+
+/**
+ * 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 {
+    controller,
+  };
+};

app/core/Engine/messengers/index.ts

@@ -122,6 +122,8 @@ import {
   getTransactionPayControllerInitMessenger,
   getTransactionPayControllerMessenger,
 } from './transaction-pay-controller-messenger';
+import { getProfileMetricsControllerMessenger } from './profile-metrics-controller-messenger';
+import { getProfileMetricsServiceMessenger } from './profile-metrics-service-messenger';
 
 /**
  * The messengers for the controllers that have been.
@@ -397,4 +399,12 @@ export const CONTROLLER_MESSENGERS = {
     getMessenger: getAccountActivityServiceMessenger,
     getInitMessenger: noop,
   },
+  ProfileMetricsController: {
+    getMessenger: getProfileMetricsControllerMessenger,
+    getInitMessenger: noop,
+  },
+  ProfileMetricsService: {
+    getMessenger: getProfileMetricsServiceMessenger,
+    getInitMessenger: noop,
+  },
 } as const;

app/core/Engine/messengers/profile-metrics-controller-messenger.test.ts

@@ -0,0 +1,30 @@
+import {
+  MOCK_ANY_NAMESPACE,
+  Messenger,
+  MessengerActions,
+  MessengerEvents,
+  MockAnyNamespace,
+} from '@metamask/messenger';
+import { getProfileMetricsControllerMessenger } from './profile-metrics-controller-messenger';
+import { ProfileMetricsControllerMessenger } from '@metamask/profile-metrics-controller';
+
+type RootMessenger = Messenger<
+  MockAnyNamespace,
+  MessengerActions<ProfileMetricsControllerMessenger>,
+  MessengerEvents<ProfileMetricsControllerMessenger>
+>;
+
+const getRootMessenger = (): RootMessenger =>
+  new Messenger({
+    namespace: MOCK_ANY_NAMESPACE,
+  });
+
+describe('getProfileMetricsControllerMessenger', () => {
+  it('returns a restricted messenger', () => {
+    const messenger = getRootMessenger();
+    const profileMetricsControllerMessenger =
+      getProfileMetricsControllerMessenger(messenger);
+
+    expect(profileMetricsControllerMessenger).toBeInstanceOf(Messenger);
+  });
+});