fix: update marketing traits when tracked settings change [PR 1/2] (#13254)

## **Description**

>[!important]
> This PR is the first of two.
> In order to have small scope PRs and limit the amount of changes, the
work is split into two PRs.
> This PR mainly deals with the changes about marketing consent
analytics.
> It can be merged independently from 2/2.

- moves marketing traits to global
`generateUserProfileAnalyticsMetaData` user traits function
- makes marketing traits use ON or OFF values for consistency with other
user profile traits.
- removes `is_metrics_opted_in` from user profile traits as we don't
have consistent data anyway and the fact that data is tracked means use
opted in.
- the user optin (metrics enabled or not) remains unchanged in the app
and is stored to know if events should be tracked or not.
- If user optin is not set at onboarding, it can be updated in settings.
- adds unit tests for `generateUserProfileAnalyticsMetaData` function
- update other unit tests

## **Related issues**

Fixes part 1/2 of
MetaMask/mobile-planning#1459

## **Manual testing steps**

```gherkin
Feature: update marketing consent in user profile when it changes

  Scenario: user accepts marketing during onboarding
    Given a fresh install of the app
    When user accepts metametrics during onboarding
    And user accepts marketing consent
    Then you have IDENTIFY event sent
    And identify event contains "has_marketing_consent" trait with value "ON"
    And you have TRACK event sent
    And track event has "has_marketing_consent" prop set to "true"
    And track event has "location" prop set to "onboarding_metametrics"
    And track event has "updated_after_onboarding" prop set to "false"

  Scenario: user refuses marketing during onboarding
    Given a fresh install of the app
    When user accepts metametrics during onboarding
    And user refuses marketing consent (leave checkbox unchecked)
    Then you have IDENTIFY event sent
    And identify event contains "has_marketing_consent" trait with value "OFF"
    And you have TRACK event sent
    And track event has "has_marketing_consent" prop set to "false"
    And track event has "location" prop set to "onboarding_metametrics"
    And track event has "updated_after_onboarding" prop set to "false"

  Scenario: user accepts marketing in settings after onboarding
    Given an already onboarded app
    And user opted in for metrics
    And user navigates to privacy&security settings 
    When user activates "data collection for marketing"
    Then you have IDENTIFY event sent
    And identify event contains "has_marketing_consent" trait with value "ON"
    And you have TRACK event sent
    And track event has "has_marketing_consent" prop set to "true"
    And track event has "location" prop set to "settings"
    And track event has "updated_after_onboarding" prop set to "true"

  Scenario: user refuses marketing in settings after onboarding
    Given an already onboarded app
    And user opted in for metrics
    And user navigates to privacy&security settings 
    When user activates "data collection for marketing"
    Then you have IDENTIFY event sent
    And identify event contains "has_marketing_consent" trait with value "OFF"
    And you have TRACK event sent
    And track event has "has_marketing_consent" prop set to "false"
    And track event has "location" prop set to "settings"
    And track event has "updated_after_onboarding" prop set to "true"
```

## **Screenshots/Recordings**

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

### **Before**

```
 INFO  IDENTIFY event saved {"traits": {"Batch account balance requests": "ON", "Enable OpenSea API": "ON", "NFT Autodetection": "ON", "Theme": "light", "applicationVersion": "7.37.1", "currentBuildNumber": "1520", "deviceBrand": "Apple", "has_marketing_consent": true, "operatingSystemVersion": "18.2", "platform": "ios", "security_providers": "blockaid", "token_detection_enable": "ON"}, "type": "identify", "userId": "c82a0d7b-599c-4526-8dd7-cd3a35b863fd"}
```

### **After**

#### Onboarding

<img width="182" alt="image"
src="https://github.com/user-attachments/assets/133037f9-f0b6-4c49-b673-cec005757568"
/>

When user check the box for collection for marketing in onboarding
```
 INFO  TRACK event saved {"event": "Analytics Preference Selected", "properties": {"has_marketing_consent": true, "is_metrics_opted_in": true, "location": "onboarding_metametrics", "updated_after_onboarding": false}, "type": "track"}
 INFO  IDENTIFY event saved {"traits": {"Batch account balance requests": "ON", "Enable OpenSea API": "ON", "NFT Autodetection": "ON", "Theme": "light", "applicationVersion": "7.37.1", "currentBuildNumber": "1520", "deviceBrand": "Apple", "has_marketing_consent": "ON", "operatingSystemVersion": "18.2", "platform": "ios", "security_providers": "blockaid", "token_detection_enable": "ON"}, "type": "identify", "userId": "e142a0a5-670b-4f74-b531-b207bf0576d4"}
```

#### Settings

<img width="182" alt="image"
src="https://github.com/user-attachments/assets/6b520c52-b62c-42e1-99e6-d1e21fe303c3"
/>

When user switches ON data collection for marketing in settings
```
 INFO  IDENTIFY event saved {"traits": {"has_marketing_consent": "ON"}, "type": "identify", "userId": "ba888bd9-92cc-4783-a1c6-b72aaeadccab"}
 INFO  TRACK event saved {"event": "Analytics Preference Selected", "properties": {"has_marketing_consent": true, "location": "settings", "updated_after_onboarding": true}, "type": "track"}
```

When user switches OFF data collection for marketing in settings
```
 INFO  IDENTIFY event saved {"traits": {"has_marketing_consent": "OFF"}, "type": "identify", "userId": "ba888bd9-92cc-4783-a1c6-b72aaeadccab"}
 INFO  TRACK event saved {"event": "Analytics Preference Selected", "properties": {"has_marketing_consent": false, "location": "settings", "updated_after_onboarding": true}, "type": "track"}
```

#### Marketing modal

<img width="182" alt="image"
src="https://github.com/user-attachments/assets/87b92f34-57ab-49c5-a3ea-38d3ac374a81"
/>

When user touches "no thanks"
```
INFO  IDENTIFY event saved {"traits": {"has_marketing_consent": "OFF"}, "type": "identify", "userId": "e142a0a5-670b-4f74-b531-b207bf0576d4"}
 INFO  TRACK event saved {"event": "Analytics Preference Selected", "properties": {"has_marketing_consent": false, "location": "marketing_consent_modal", "updated_after_onboarding": true}, "type": "track"}
```

When user touches "I agree"
```
 INFO  IDENTIFY event saved {"traits": {"has_marketing_consent": "ON"}, "type": "identify", "userId": "e142a0a5-670b-4f74-b531-b207bf0576d4"}
 INFO  TRACK event saved {"event": "Analytics Preference Selected", "properties": {"has_marketing_consent": true, "location": "marketing_consent_modal", "updated_after_onboarding": true}, "type": "track"}
```

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

Author: NicolasMassart

app/components/UI/OptinMetrics/index.js

@@ -40,6 +40,9 @@ import Routes from '../../../constants/navigation/Routes';
 import generateDeviceAnalyticsMetaData, {
   UserSettingsAnalyticsMetaData as generateUserSettingsAnalyticsMetaData,
 } from '../../../util/metrics';
+import {
+    UserProfileProperty
+} from '../../../util/metrics/UserSettingsAnalyticsMetaData/UserProfileAnalyticsMetaData.types';
 
 const createStyles = ({ colors }) =>
   StyleSheet.create({
@@ -338,44 +341,33 @@ class OptinMetrics extends PureComponent {
       setDataCollectionForMarketing,
     } = this.props;
 
-    // Set marketing consent trait based on user selection
-    const dataCollectionForMarketingTraits = {
-      has_marketing_consent: Boolean(
-        this.props.isDataCollectionForMarketingEnabled,
-      ),
-    };
-
     await metrics.enable();
 
+    // Handle null case for marketing consent
+    if (
+      isDataCollectionForMarketingEnabled === null &&
+      setDataCollectionForMarketing
+    ) {
+      setDataCollectionForMarketing(false);
+    }
+
     // Track the analytics preference event first
     metrics.trackEvent(
       metrics
         .createEventBuilder(MetaMetricsEvents.ANALYTICS_PREFERENCE_SELECTED)
         .addProperties({
-          ...dataCollectionForMarketingTraits,
-          is_metrics_opted_in: true,
-          location: 'onboarding_metametrics',
-          updated_after_onboarding: false,
+            [UserProfileProperty.HAS_MARKETING_CONSENT]: Boolean( isDataCollectionForMarketingEnabled ),
+            is_metrics_opted_in: true,
+            location: 'onboarding_metametrics',
+            updated_after_onboarding: false,
         })
         .build(),
     );
 
-    // Handle null case for marketing consent
-    if (
-      isDataCollectionForMarketingEnabled === null &&
-      setDataCollectionForMarketing
-    ) {
-      setDataCollectionForMarketing(false);
-    }
-
-    // consolidate device and user settings traits
-    const consolidatedTraits = {
-      ...dataCollectionForMarketingTraits,
-      is_metrics_opted_in: true,
-      ...generateDeviceAnalyticsMetaData(),
-      ...generateUserSettingsAnalyticsMetaData(),
-    };
-    await metrics.addTraitsToUser(consolidatedTraits);
+    await metrics.addTraitsToUser({
+        ...generateDeviceAnalyticsMetaData(),
+        ...generateUserSettingsAnalyticsMetaData(),
+    });
 
     // track onboarding events that were stored before user opted in
     // only if the user eventually opts in.

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

@@ -75,8 +75,6 @@ describe('OptinMetrics', () => {
         expect(mockMetrics.addTraitsToUser).toHaveBeenNthCalledWith(1, {
           deviceProp: 'Device value',
           userProp: 'User value',
-          is_metrics_opted_in: true,
-          has_marketing_consent: false,
         });
       });
     });
@@ -106,8 +104,6 @@ describe('OptinMetrics', () => {
         expect(mockMetrics.addTraitsToUser).toHaveBeenNthCalledWith(1, {
           deviceProp: 'Device value',
           userProp: 'User value',
-          is_metrics_opted_in: true,
-          has_marketing_consent: true,
         });
       });
     });

app/components/Views/ExperienceEnhancerModal/index.tsx

@@ -25,6 +25,9 @@ import {
 } from '../../../components/hooks/useMetrics';
 import { HOW_TO_MANAGE_METRAMETRICS_SETTINGS } from '../../../constants/urls';
 import { ExperienceEnhancerBottomSheetSelectorsIDs } from '../../../../e2e/selectors/Onboarding/ExperienceEnhancerModal.selectors.js';
+import {
+  UserProfileProperty
+} from '../../../util/metrics/UserSettingsAnalyticsMetaData/UserProfileAnalyticsMetaData.types';
 
 const ExperienceEnhancerModal = () => {
   const dispatch = useDispatch();
@@ -40,14 +43,14 @@ const ExperienceEnhancerModal = () => {
       dispatch(setDataCollectionForMarketing(false));
       bottomSheetRef.current?.onCloseBottomSheet();
 
-      const traits = {
-        has_marketing_consent: false,
-      };
-      addTraitsToUser(traits);
+      addTraitsToUser({
+        [UserProfileProperty.HAS_MARKETING_CONSENT]: UserProfileProperty.OFF,
+      });
       trackEvent(
         createEventBuilder(MetaMetricsEvents.ANALYTICS_PREFERENCE_SELECTED)
           .addProperties({
-            ...traits,
+            [UserProfileProperty.HAS_MARKETING_CONSENT]: false,
+            updated_after_onboarding: true,
             location: 'marketing_consent_modal',
           })
           .build(),
@@ -64,12 +67,14 @@ const ExperienceEnhancerModal = () => {
       dispatch(setDataCollectionForMarketing(true));
       bottomSheetRef.current?.onCloseBottomSheet();
 
-      const traits = { has_marketing_consent: true };
-      addTraitsToUser(traits);
+      addTraitsToUser({
+        [UserProfileProperty.HAS_MARKETING_CONSENT]: UserProfileProperty.ON,
+      });
       trackEvent(
         createEventBuilder(MetaMetricsEvents.ANALYTICS_PREFERENCE_SELECTED)
           .addProperties({
-            ...traits,
+            [UserProfileProperty.HAS_MARKETING_CONSENT]: true,
+            updated_after_onboarding: true,
             location: 'marketing_consent_modal',
           })
           .build(),

app/components/Views/Settings/SecuritySettings/Sections/MetaMetricsAndDataCollectionSection/MetaMetricsAndDataCollectionSection.test.tsx

@@ -210,7 +210,6 @@ describe('MetaMetricsAndDataCollectionSection', () => {
           expect(mockMetrics.addTraitsToUser).toHaveBeenCalledWith({
             deviceProp: 'Device value',
             userProp: 'User value',
-            is_metrics_opted_in: true,
           });
           expect(mockMetrics.trackEvent).toHaveBeenCalledWith(
             MetricsEventBuilder.createEventBuilder(
@@ -219,6 +218,7 @@ describe('MetaMetricsAndDataCollectionSection', () => {
               .addProperties({
                 is_metrics_opted_in: true,
                 updated_after_onboarding: true,
+                location: 'settings',
               })
               .build(),
           );
@@ -299,7 +299,6 @@ describe('MetaMetricsAndDataCollectionSection', () => {
             expect(mockMetrics.addTraitsToUser).toHaveBeenNthCalledWith(1, {
               deviceProp: 'Device value',
               userProp: 'User value',
-              is_metrics_opted_in: true,
             });
             expect(mockMetrics.trackEvent).toHaveBeenNthCalledWith(
               1,
@@ -308,6 +307,7 @@ describe('MetaMetricsAndDataCollectionSection', () => {
               )
                 .addProperties({
                   is_metrics_opted_in: true,
+                  location: 'settings',
                   updated_after_onboarding: true,
                 })
                 .build(),
@@ -318,7 +318,7 @@ describe('MetaMetricsAndDataCollectionSection', () => {
             // if MetaMetrics is initially disabled, addTraitsToUser is called twice and this is 2nd call
             !metaMetricsInitiallyEnabled ? 2 : 1,
             {
-              has_marketing_consent: true,
+              has_marketing_consent: 'ON',
             },
           );
           expect(mockMetrics.trackEvent).toHaveBeenNthCalledWith(
@@ -330,6 +330,7 @@ describe('MetaMetricsAndDataCollectionSection', () => {
               .addProperties({
                 has_marketing_consent: true,
                 location: 'settings',
+                updated_after_onboarding: true,
               })
               .build(),
           );
@@ -376,7 +377,7 @@ describe('MetaMetricsAndDataCollectionSection', () => {
           expect(mockAlert).not.toHaveBeenCalled();
           expect(mockMetrics.addTraitsToUser).toHaveBeenCalledTimes(1);
           expect(mockMetrics.addTraitsToUser).toHaveBeenCalledWith({
-            has_marketing_consent: false,
+            has_marketing_consent: 'OFF',
           });
           expect(mockMetrics.trackEvent).toHaveBeenCalledTimes(1);
           expect(mockMetrics.trackEvent).toHaveBeenCalledWith(
@@ -386,6 +387,7 @@ describe('MetaMetricsAndDataCollectionSection', () => {
               .addProperties({
                 has_marketing_consent: false,
                 location: 'settings',
+                updated_after_onboarding: true,
               })
               .build(),
           );

app/components/Views/Settings/SecuritySettings/Sections/MetaMetricsAndDataCollectionSection/MetaMetricsAndDataCollectionSection.tsx

@@ -26,6 +26,9 @@ import Routes from '../../../../../../constants/navigation/Routes';
 import { useMetrics } from '../../../../../hooks/useMetrics';
 import { useDispatch, useSelector } from 'react-redux';
 import { useNavigation } from '@react-navigation/native';
+import {
+  UserProfileProperty
+} from '../../../../../../util/metrics/UserSettingsAnalyticsMetaData/UserProfileAnalyticsMetaData.types';
 
 const MetaMetricsAndDataCollectionSection: React.FC = () => {
   const theme = useTheme();
@@ -51,7 +54,6 @@ const MetaMetricsAndDataCollectionSection: React.FC = () => {
       const consolidatedTraits = {
         ...generateDeviceAnalyticsMetaData(),
         ...generateUserSettingsAnalyticsMetaData(),
-        is_metrics_opted_in: true,
       };
       await enable();
       setAnalyticsEnabled(true);
@@ -63,6 +65,7 @@ const MetaMetricsAndDataCollectionSection: React.FC = () => {
             .addProperties({
               is_metrics_opted_in: true,
               updated_after_onboarding: true,
+              location: 'settings',
             })
             .build(),
         );
@@ -82,14 +85,14 @@ const MetaMetricsAndDataCollectionSection: React.FC = () => {
 
   const addMarketingConsentToTraits = (marketingOptIn: boolean) => {
     InteractionManager.runAfterInteractions(async () => {
-      const traits = {
-        has_marketing_consent: marketingOptIn,
-      };
-      await addTraitsToUser(traits);
+      await addTraitsToUser({
+        [UserProfileProperty.HAS_MARKETING_CONSENT]: marketingOptIn ? UserProfileProperty.ON : UserProfileProperty.OFF,
+      });
       trackEvent(
         createEventBuilder(MetaMetricsEvents.ANALYTICS_PREFERENCE_SELECTED)
           .addProperties({
-            ...traits,
+            [UserProfileProperty.HAS_MARKETING_CONSENT]: marketingOptIn,
+            updated_after_onboarding: true,
             location: 'settings',
           })
           .build(),

app/core/AppStateEventListener.test.ts

@@ -16,6 +16,16 @@ jest.mock('./processAttribution', () => ({
   processAttribution: jest.fn(),
 }));
 
+jest.mock(
+    '../util/metrics/UserSettingsAnalyticsMetaData/generateUserProfileAnalyticsMetaData',
+    () => jest.fn().mockReturnValue({ userProp: 'User value' }),
+);
+
+jest.mock(
+    '../util/metrics/DeviceAnalyticsMetaData/generateDeviceAnalyticsMetaData',
+    () => jest.fn().mockReturnValue({ deviceProp: 'Device value' }),
+);
+
 jest.mock('./Analytics/MetaMetrics');
 
 const mockMetrics = {
@@ -115,17 +125,8 @@ describe('AppStateEventListener', () => {
 
     expect(mockMetrics.addTraitsToUser).toHaveBeenCalledTimes(1);
     expect(mockMetrics.addTraitsToUser).toHaveBeenCalledWith({
-      'Batch account balance requests': 'OFF',
-      'Enable OpenSea API': 'OFF',
-      'NFT Autodetection': 'OFF',
-      'Theme': undefined,
-      'applicationVersion': expect.any(Promise),
-      'currentBuildNumber': expect.any(Promise),
-      'deviceBrand': 'Apple',
-      'operatingSystemVersion': 'ios',
-      'platform': 'ios',
-      'security_providers': '',
-      'token_detection_enable': 'OFF',
+      deviceProp: 'Device value',
+      userProp: 'User value',
     });
   });
 

app/util/metrics/UserSettingsAnalyticsMetaData/UserProfileAnalyticsMetaData.types.ts

@@ -10,6 +10,7 @@ export enum UserProfileProperty {
   SECURITY_PROVIDERS = 'security_providers',
   PRIMARY_CURRENCY = 'primary_currency',
   CURRENT_CURRENCY = 'current_currency',
+  HAS_MARKETING_CONSENT = 'has_marketing_consent',
 }
 
 export interface UserProfileMetaData {
@@ -22,4 +23,5 @@ export interface UserProfileMetaData {
   [UserProfileProperty.SECURITY_PROVIDERS]: string;
   [UserProfileProperty.PRIMARY_CURRENCY]?: string;
   [UserProfileProperty.CURRENT_CURRENCY]?: string;
+  [UserProfileProperty.HAS_MARKETING_CONSENT]: string;
 }

app/util/metrics/UserSettingsAnalyticsMetaData/generateUserProfileAnalyticsMetaData.test.ts

@@ -0,0 +1,83 @@
+import generateUserProfileAnalyticsMetaData from './generateUserProfileAnalyticsMetaData';
+import { UserProfileProperty } from './UserProfileAnalyticsMetaData.types';
+import {Appearance} from 'react-native';
+
+const mockGetState = jest.fn();
+jest.mock('../../../store', () => ({
+    store: {
+      getState: jest.fn(() => mockGetState()),
+    },
+  }));
+
+const mockIsMetricsEnabled = jest.fn();
+jest.mock('../../../core/Analytics', () => ({
+  MetaMetrics: {
+    getInstance: jest.fn(() => ({ isEnabled: mockIsMetricsEnabled })),
+  },
+}));
+
+jest.spyOn(Appearance, 'getColorScheme').mockReturnValue('dark');
+
+describe('generateUserProfileAnalyticsMetaData', () => {
+  const mockState = {
+    engine: {
+      backgroundState: {
+        PreferencesController: {
+          displayNftMedia: true,
+          useNftDetection: false,
+          useTokenDetection: true,
+          isMultiAccountBalancesEnabled: false,
+          securityAlertsEnabled: true,
+        },
+      },
+    },
+    user: { appTheme: 'os' },
+    security: { dataCollectionForMarketing: true },
+  };
+
+  it('returns metadata', () => {
+    mockGetState.mockReturnValue(mockState);
+    mockIsMetricsEnabled.mockReturnValue(true);
+
+    const metadata = generateUserProfileAnalyticsMetaData();
+    expect(metadata).toEqual({
+      [UserProfileProperty.ENABLE_OPENSEA_API]: UserProfileProperty.ON,
+      [UserProfileProperty.NFT_AUTODETECTION]: UserProfileProperty.OFF,
+      [UserProfileProperty.THEME]: 'dark',
+      [UserProfileProperty.TOKEN_DETECTION]: UserProfileProperty.ON,
+      [UserProfileProperty.MULTI_ACCOUNT_BALANCE]: UserProfileProperty.OFF,
+      [UserProfileProperty.SECURITY_PROVIDERS]: 'blockaid',
+      [UserProfileProperty.HAS_MARKETING_CONSENT]: UserProfileProperty.ON,
+    });
+  });
+
+  it.each([
+    [UserProfileProperty.ON, true],
+    [UserProfileProperty.OFF, false],
+  ])('returns marketing consent "%s"', (expected, stateConsentValue) => {
+    mockGetState.mockReturnValue({ ...mockState, security: { dataCollectionForMarketing: stateConsentValue } });
+
+    const metadata = generateUserProfileAnalyticsMetaData();
+    expect(metadata[UserProfileProperty.HAS_MARKETING_CONSENT]).toEqual(expected);
+  });
+
+  it('returns default metadata when missing preferences controller', () => {
+    mockGetState.mockReturnValue({ ...mockState, engine: {} });
+
+    const metadata = generateUserProfileAnalyticsMetaData();
+    expect(metadata).toMatchObject({
+      [UserProfileProperty.ENABLE_OPENSEA_API]: UserProfileProperty.OFF,
+      [UserProfileProperty.NFT_AUTODETECTION]: UserProfileProperty.OFF,
+      [UserProfileProperty.TOKEN_DETECTION]: UserProfileProperty.OFF,
+      [UserProfileProperty.MULTI_ACCOUNT_BALANCE]: UserProfileProperty.OFF,
+      [UserProfileProperty.SECURITY_PROVIDERS]: '',
+    });
+  });
+
+  it('returns user preference for theme', () => {
+    mockGetState.mockReturnValue({ ...mockState, user: { appTheme: 'light' } });
+
+    const metadata = generateUserProfileAnalyticsMetaData();
+    expect(metadata[UserProfileProperty.THEME]).toBe('light');
+  });
+});