refactor(analytics): migrate Batch 3-2: mobile-platform (MetaMask#26315)

## **Description**

Phase 3 analytics migration (Batch 3-2): migrate Security's
SecureKeychain, ProtectYourWalletModal, and RevealPrivateCredential from
MetaMetrics to the new analytics system.

**Reason**: Deprecate MetaMetrics in favour of the shared analytics
utility and AnalyticsController.

**Changes**:
- `SecureKeychain.ts` now uses `analytics.trackEvent()` and
`analytics.identify()` from `app/util/analytics` instead of
`MetaMetrics.getInstance().trackEvent()` and
`MetaMetrics.getInstance().addTraitsToUser()`; uses
`AnalyticsEventBuilder` instead of `MetricsEventBuilder`.
- `ProtectYourWalletModal` now uses `withAnalyticsAwareness` HOC from
`app/components/hooks/useAnalytics` instead of `withMetricsAwareness`
from `useMetrics`; prop renamed from `metrics` to `analytics`.
- `RevealPrivateCredential` now uses `useAnalytics` hook instead of
`useMetrics`.
- Test mocks updated to mock the analytics utility and `useAnalytics`
instead of MetaMetrics and `useMetrics`.

## **Changelog**

CHANGELOG entry: null

## **Related issues**

Fixes: https://consensyssoftware.atlassian.net/browse/MCWP-301 (Batch
3-2)

## **Manual testing steps**

```gherkin
Feature: Security analytics

  Scenario: user triggers a security flow event
    Given app is open and user is in a security flow

    When user performs an action that triggers analytics (e.g. reveal SRP, protect wallet modal interaction, biometric setup)
    Then the event is tracked on Mixpanel
```

## **Screenshots/Recordings**

N/A – analytics migration, no UI change.

## **Pre-merge author checklist**

- [x] 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).
- [x] I've completed the PR template to the best of my ability
- [x] I've included tests if applicable
- [x] I've documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] 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]
> **Medium Risk**
> Touches security-adjacent flows (keychain credential storage and
SRP/wallet-protection tracking) and changes analytics plumbing, so
regressions could silently drop events or mis-set user traits, though
app behavior should remain unchanged.
> 
> **Overview**
> Migrates security analytics instrumentation away from legacy
`MetaMetrics`/`useMetrics` to the shared analytics stack.
> 
> `SecureKeychain` now uses
`analytics.trackEvent()`/`analytics.identify()` plus
`AnalyticsEventBuilder` (replacing `MetaMetrics.getInstance()` and
`MetricsEventBuilder`) for hardware-keystore event tracking and
authentication-type user trait updates. `ProtectYourWalletModal` and
`RevealPrivateCredential` swap `withMetricsAwareness`/`useMetrics` for
`withAnalyticsAwareness`/`useAnalytics`, including the prop rename from
`metrics` to `analytics`.
> 
> Unit tests are updated to mock the new analytics utility/hooks and to
assert calls against `analytics.identify`/event builder usage instead of
MetaMetrics mocks.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
eb1430f. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: NicolasMassart

app/components/UI/ProtectYourWalletModal/index.js

@@ -8,11 +8,11 @@ import { protectWalletModalNotVisible } from '../../../actions/user';
 import Icon from 'react-native-vector-icons/FontAwesome';
 import { strings } from '../../../../locales/i18n';
 import scaling from '../../../util/scaling';
-import { MetaMetricsEvents } from '../../../core/Analytics';
+import { MetaMetricsEvents } from '../../../core/Analytics/MetaMetrics.events';
 
 import { ThemeContext, mockTheme } from '../../../util/theme';
 import { ProtectWalletModalSelectorsIDs } from './ProtectWalletModal.testIds';
-import { withMetricsAwareness } from '../../../components/hooks/useMetrics';
+import { withAnalyticsAwareness } from '../../../components/hooks/useAnalytics/withAnalyticsAwareness';
 import { selectSeedlessOnboardingLoginFlow } from '../../../selectors/seedlessOnboardingController';
 
 const protectWalletImage = require('../../../images/explain-backup-seedphrase.png'); // eslint-disable-line
@@ -91,9 +91,9 @@ class ProtectYourWalletModal extends PureComponent {
      */
     passwordSet: PropTypes.bool,
     /**
-     * Metrics injected by withMetricsAwareness HOC
+     * Analytics injected by withAnalyticsAwareness HOC
      */
-    metrics: PropTypes.object,
+    analytics: PropTypes.object,
     /**
      * A boolean representing if the user is in the seedless onboarding login flow
      */
@@ -106,8 +106,8 @@ class ProtectYourWalletModal extends PureComponent {
       'SetPasswordFlow',
       this.props.passwordSet ? { screen: 'AccountBackupStep1' } : undefined,
     );
-    this.props.metrics.trackEvent(
-      this.props.metrics
+    this.props.analytics.trackEvent(
+      this.props.analytics
         .createEventBuilder(MetaMetricsEvents.WALLET_SECURITY_PROTECT_ENGAGED)
         .addProperties({
           wallet_protection_required: false,
@@ -130,8 +130,8 @@ class ProtectYourWalletModal extends PureComponent {
 
   onDismiss = () => {
     this.props.protectWalletModalNotVisible();
-    this.props.metrics.trackEvent(
-      this.props.metrics
+    this.props.analytics.trackEvent(
+      this.props.analytics
         .createEventBuilder(MetaMetricsEvents.WALLET_SECURITY_PROTECT_DISMISSED)
         .addProperties({
           wallet_protection_required: false,
@@ -222,4 +222,4 @@ ProtectYourWalletModal.contextType = ThemeContext;
 export default connect(
   mapStateToProps,
   mapDispatchToProps,
-)(withMetricsAwareness(ProtectYourWalletModal));
+)(withAnalyticsAwareness(ProtectYourWalletModal));

app/components/UI/ProtectYourWalletModal/index.test.tsx

@@ -39,28 +39,34 @@ jest.mock('../../../util/analytics/analytics', () => ({
   },
 }));
 
-// Mock useMetrics hook which is used by withMetricsAwareness HOC
-jest.mock('../../../components/hooks/useMetrics', () => ({
-  useMetrics: () => ({
+// Mock useAnalytics hook which is used by withAnalyticsAwareness HOC
+jest.mock('../../../components/hooks/useAnalytics/useAnalytics', () => ({
+  useAnalytics: () => ({
     trackEvent: mockTrackEvent,
     createEventBuilder: mockCreateEventBuilder,
     isEnabled: mockMetricsIsEnabled,
   }),
-  withMetricsAwareness:
-    (Component: React.ComponentType) => (props: Record<string, unknown>) => (
-      <Component
-        {...props}
-        {...({
-          metrics: {
-            trackEvent: mockTrackEvent,
-            createEventBuilder: mockCreateEventBuilder,
-            isEnabled: mockMetricsIsEnabled,
-          },
-        } as Record<string, unknown>)}
-      />
-    ),
 }));
 
+jest.mock(
+  '../../../components/hooks/useAnalytics/withAnalyticsAwareness',
+  () => ({
+    withAnalyticsAwareness:
+      (Component: React.ComponentType) => (props: Record<string, unknown>) => (
+        <Component
+          {...props}
+          {...({
+            analytics: {
+              trackEvent: mockTrackEvent,
+              createEventBuilder: mockCreateEventBuilder,
+              isEnabled: mockMetricsIsEnabled,
+            },
+          } as Record<string, unknown>)}
+        />
+      ),
+  }),
+);
+
 const mockStore = configureMockStore();
 
 const initialState = {

app/components/Views/RevealPrivateCredential/RevealPrivateCredential.test.tsx

@@ -12,7 +12,7 @@ import { KeyringTypes } from '@metamask/keyring-controller';
 import { WRONG_PASSWORD_ERROR } from '../../../constants/error';
 import { ReauthenticateErrorType } from '../../../core/Authentication/types';
 import ClipboardManager from '../../../core/ClipboardManager';
-import { MetaMetricsEvents } from '../../../core/Analytics';
+import { MetaMetricsEvents } from '../../../core/Analytics/MetaMetrics.events';
 import Device from '../../../util/device';
 
 const MOCK_PASSWORD = 'word1 word2 word3 word4';
@@ -109,12 +109,11 @@ jest.mock('react-redux', () => ({
   useDispatch: () => mockDispatch,
 }));
 
-jest.mock('../../../components/hooks/useMetrics', () => ({
-  useMetrics: () => ({
+jest.mock('../../../components/hooks/useAnalytics/useAnalytics', () => ({
+  useAnalytics: () => ({
     trackEvent: mockTrackEvent,
     createEventBuilder: mockCreateEventBuilder,
   }),
-  withMetricsAwareness: jest.fn((Component) => Component),
 }));
 
 // Mock ClipboardManager - necessary for testing clipboard functionality

app/components/Views/RevealPrivateCredential/RevealPrivateCredential.tsx

@@ -35,7 +35,7 @@ import { WRONG_PASSWORD_ERROR } from '../../../constants/error';
 import { KEEP_SRP_SAFE_URL, SRP_GUIDE_URL } from '../../../constants/urls';
 import ClipboardManager from '../../../core/ClipboardManager';
 import { useTheme } from '../../../util/theme';
-import { MetaMetricsEvents } from '../../../core/Analytics';
+import { MetaMetricsEvents } from '../../../core/Analytics/MetaMetrics.events';
 import { passwordRequirementsMet } from '../../../util/password';
 import useAuthentication from '../../../core/Authentication/hooks/useAuthentication';
 import { ReauthenticateErrorType } from '../../../core/Authentication/types';
@@ -50,7 +50,7 @@ import { getNavigationOptionsTitle } from '../../../components/UI/Navbar';
 import { RevealSeedViewSelectorsIDs } from './RevealSeedView.testIds';
 
 import { selectSelectedInternalAccountFormattedAddress } from '../../../selectors/accountsController';
-import { useMetrics } from '../../../components/hooks/useMetrics';
+import { useAnalytics } from '../../../components/hooks/useAnalytics/useAnalytics';
 import {
   endTrace,
   trace,
@@ -114,7 +114,7 @@ const RevealPrivateCredential = ({
   const dispatch = useDispatch();
 
   const theme = useTheme();
-  const { trackEvent, createEventBuilder } = useMetrics();
+  const { trackEvent, createEventBuilder } = useAnalytics();
   const { colors, themeAppearance } = theme;
   const styles = createStyles(theme);
 

app/core/SecureKeychain.test.ts

@@ -3,6 +3,7 @@ import * as Keychain from 'react-native-keychain'; // eslint-disable-line import
 import { UserProfileProperty } from '../util/metrics/UserSettingsAnalyticsMetaData/UserProfileAnalyticsMetaData.types';
 import AUTHENTICATION_TYPE from '../constants/userProperties';
 import QuickCrypto from 'react-native-quick-crypto';
+import { analytics } from '../util/analytics/analytics';
 
 jest.mock('../../locales/i18n', () => ({
   strings: jest.fn((key) => key),
@@ -42,13 +43,18 @@ jest.mock('../store/storage-wrapper', () => ({
   },
 }));
 
-const mockAddTraitsToUser = jest.fn();
-jest.mock('../core/Analytics', () => ({
-  MetaMetrics: {
-    getInstance: jest.fn(() => ({
-      addTraitsToUser: mockAddTraitsToUser,
-      trackEvent: jest.fn(),
-      updateDataRecordingFlag: jest.fn(),
+jest.mock('../util/analytics/analytics', () => ({
+  analytics: {
+    identify: jest.fn(),
+    trackEvent: jest.fn(),
+  },
+}));
+
+jest.mock('../util/analytics/AnalyticsEventBuilder', () => ({
+  AnalyticsEventBuilder: {
+    createEventBuilder: jest.fn(() => ({
+      addProperties: jest.fn().mockReturnThis(),
+      build: jest.fn(),
     })),
   },
 }));
@@ -76,7 +82,7 @@ describe('SecureKeychain - setGenericPassword', () => {
       }),
     );
 
-    expect(mockAddTraitsToUser).toHaveBeenCalledWith(
+    expect(analytics.identify).toHaveBeenCalledWith(
       expect.objectContaining({
         [UserProfileProperty.AUTHENTICATION_TYPE]:
           AUTHENTICATION_TYPE.DEVICE_AUTHENTICATION,
@@ -99,7 +105,7 @@ describe('SecureKeychain - setGenericPassword', () => {
       }),
     );
 
-    expect(mockAddTraitsToUser).toHaveBeenCalledWith(
+    expect(analytics.identify).toHaveBeenCalledWith(
       expect.objectContaining({
         [UserProfileProperty.AUTHENTICATION_TYPE]:
           AUTHENTICATION_TYPE.DEVICE_AUTHENTICATION,
@@ -122,7 +128,7 @@ describe('SecureKeychain - setGenericPassword', () => {
       }),
     );
 
-    expect(mockAddTraitsToUser).toHaveBeenCalledWith(
+    expect(analytics.identify).toHaveBeenCalledWith(
       expect.objectContaining({
         [UserProfileProperty.AUTHENTICATION_TYPE]:
           AUTHENTICATION_TYPE.DEVICE_AUTHENTICATION,

app/core/SecureKeychain.ts

@@ -2,12 +2,12 @@ import { Platform } from 'react-native';
 import * as Keychain from 'react-native-keychain'; // eslint-disable-line import/no-namespace
 import { Encryptor, LEGACY_DERIVATION_OPTIONS } from './Encryptor';
 import { strings } from '../../locales/i18n';
-import { MetaMetricsEvents, MetaMetrics } from './Analytics';
+import { MetaMetricsEvents } from './Analytics/MetaMetrics.events';
+import { analytics } from '../util/analytics/analytics';
+import { AnalyticsEventBuilder } from '../util/analytics/AnalyticsEventBuilder';
 import Device from '../util/device';
 import AUTHENTICATION_TYPE from '../constants/userProperties';
 import { UserProfileProperty } from '../util/metrics/UserSettingsAnalyticsMetaData/UserProfileAnalyticsMetaData.types';
-import { MetricsEventBuilder } from './Analytics/MetricsEventBuilder';
-
 const privates = new WeakMap();
 const encryptor = new Encryptor({
   keyDerivationOptions: LEGACY_DERIVATION_OPTIONS,
@@ -64,8 +64,8 @@ const SecureKeychain = {
     instance = SecureKeychainEncryptor.getInstance(salt);
 
     if (Device.isAndroid() && Keychain.SECURITY_LEVEL?.SECURE_HARDWARE)
-      MetaMetrics.getInstance().trackEvent(
-        MetricsEventBuilder.createEventBuilder(
+      analytics.trackEvent(
+        AnalyticsEventBuilder.createEventBuilder(
           MetaMetricsEvents.ANDROID_HARDWARE_KEYSTORE,
         ).build(),
       );
@@ -139,7 +139,7 @@ const SecureKeychain = {
   async resetGenericPassword() {
     const options = { service: defaultCredentialsOptions.service };
     // This is called to remove other auth types and set the user back to the default password login
-    await MetaMetrics.getInstance().addTraitsToUser({
+    analytics.identify({
       [UserProfileProperty.AUTHENTICATION_TYPE]: AUTHENTICATION_TYPE.PASSWORD,
     });
     return Keychain.resetGenericPassword(options);
@@ -181,7 +181,6 @@ const SecureKeychain = {
       accessible: Keychain.ACCESSIBLE.WHEN_UNLOCKED_THIS_DEVICE_ONLY,
     };
 
-    const metrics = MetaMetrics.getInstance();
     // TODO: Remove biometric and passcode types once we have removed the legacy authentication types
     if (
       type === AUTHENTICATION_TYPE.DEVICE_AUTHENTICATION ||
@@ -191,7 +190,7 @@ const SecureKeychain = {
       authOptions.accessControl =
         Keychain.ACCESS_CONTROL.BIOMETRY_ANY_OR_DEVICE_PASSCODE;
 
-      await metrics.addTraitsToUser({
+      analytics.identify({
         [UserProfileProperty.AUTHENTICATION_TYPE]:
           AUTHENTICATION_TYPE.DEVICE_AUTHENTICATION,
       });