feat: add profile_id as a metametrics user trait

MetaMask · Feb 25, 2025 · cdcede6 · cdcede6
1 parent 5ddd7e9
commit cdcede6
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 0 deletions.
diff --git a/app/scripts/controllers/metametrics-controller.test.ts b/app/scripts/controllers/metametrics-controller.test.ts
@@ -1458,6 +1458,7 @@ describe('MetaMetricsController', function () {
           ///: BEGIN:ONLY_INCLUDE_IF(build-mmi)
           custodyAccountDetails: {},
           ///: END:ONLY_INCLUDE_IF
+          sessionData: undefined,
         });
 
         expect(traits).toStrictEqual({
@@ -1555,6 +1556,7 @@ describe('MetaMetricsController', function () {
           ///: BEGIN:ONLY_INCLUDE_IF(build-mmi)
           custodyAccountDetails: {},
           ///: END:ONLY_INCLUDE_IF
+          sessionData: undefined,
         });
 
         const updatedTraits = controller._buildUserTraitsObject({
@@ -1614,6 +1616,14 @@ describe('MetaMetricsController', function () {
           ///: BEGIN:ONLY_INCLUDE_IF(build-mmi)
           custodyAccountDetails: {},
           ///: END:ONLY_INCLUDE_IF
+          sessionData: {
+            accessToken: '',
+            expiresIn: '',
+            profile: {
+              identifierId: 'identifierId',
+              profileId: 'profileId',
+            },
+          },
         });
 
         expect(updatedTraits).toStrictEqual({
@@ -1622,6 +1632,7 @@ describe('MetaMetricsController', function () {
           [MetaMetricsUserTrait.NumberOfTokens]: 1,
           [MetaMetricsUserTrait.OpenSeaApiEnabled]: false,
           [MetaMetricsUserTrait.ShowNativeTokenAsMainBalance]: false,
+          [MetaMetricsUserTrait.ProfileId]: 'profileId',
         });
       });
     });
@@ -1681,6 +1692,14 @@ describe('MetaMetricsController', function () {
           ///: BEGIN:ONLY_INCLUDE_IF(build-mmi)
           custodyAccountDetails: {},
           ///: END:ONLY_INCLUDE_IF
+          sessionData: {
+            accessToken: '',
+            expiresIn: '',
+            profile: {
+              identifierId: 'identifierId',
+              profileId: 'profileId',
+            },
+          },
         });
 
         const updatedTraits = controller._buildUserTraitsObject({
@@ -1730,6 +1749,14 @@ describe('MetaMetricsController', function () {
           ///: BEGIN:ONLY_INCLUDE_IF(build-mmi)
           custodyAccountDetails: {},
           ///: END:ONLY_INCLUDE_IF
+          sessionData: {
+            accessToken: '',
+            expiresIn: '',
+            profile: {
+              identifierId: 'identifierId',
+              profileId: 'profileId',
+            },
+          },
         });
         expect(updatedTraits).toStrictEqual(null);
       });

diff --git a/app/scripts/controllers/metametrics-controller.ts b/app/scripts/controllers/metametrics-controller.ts
@@ -39,6 +39,7 @@ import {
   RestrictedMessenger,
 } from '@metamask/base-controller';
 import { AddressBookControllerState } from '@metamask/address-book-controller';
+import { AuthenticationControllerState } from '@metamask/profile-sync-controller/auth';
 import { ENVIRONMENT_TYPE_BACKGROUND } from '../../../shared/constants/app';
 import {
   METAMETRICS_ANONYMOUS_ID,
@@ -168,6 +169,7 @@ export type MetaMaskState = {
     privacyMode: PreferencesControllerState['preferences']['privacyMode'];
     tokenNetworkFilter: string[];
   };
+  sessionData: AuthenticationControllerState['sessionData'];
   ///: BEGIN:ONLY_INCLUDE_IF(build-mmi)
   custodyAccountDetails: {
     [address: string]: {
@@ -1237,6 +1239,8 @@ export default class MetaMetricsController extends BaseController<
       [MetaMetricsUserTrait.NetworkFilterPreference]: Object.keys(
         metamaskState.preferences.tokenNetworkFilter || {},
       ),
+      [MetaMetricsUserTrait.ProfileId]:
+        metamaskState.sessionData?.profile?.profileId,
     };
 
     if (!previousUserTraits && metamaskState.participateInMetaMetrics) {

diff --git a/shared/constants/metametrics.ts b/shared/constants/metametrics.ts
@@ -490,6 +490,10 @@ export type MetaMetricsUserTraits = {
    * The number of petname addresses
    */
   petname_addresses_count?: number;
+  /**
+   * The profile ID of the user if they have been signed in
+   */
+  profile_id?: string;
 };
 
 export enum MetaMetricsUserTrait {
@@ -598,6 +602,10 @@ export enum MetaMetricsUserTrait {
    * Identified when the user prefers to see all tokens or current network tokens in wallet list
    */
   NetworkFilterPreference = 'selected_network_filter',
+  /**
+   * Identified when the user signs in
+   */
+  ProfileId = 'profile_id',
 }
 
 /**