feat: add profile_id as a metametrics user trait (#30552)

## **Description**

This PR adds `profile_id` as a MetaMetrics user trait so that it gets
attached to every event when present in the state.

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

## **Related issues**

Related to: https://consensyssoftware.atlassian.net/browse/IDENTITY-39
Segment PR: Consensys/segment-schema#243

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

- [x] 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).
- [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-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [x] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [x] 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: mathieuartu

app/scripts/controllers/metametrics-controller.test.ts

@@ -1459,6 +1459,7 @@ describe('MetaMetricsController', function () {
           ///: BEGIN:ONLY_INCLUDE_IF(build-mmi)
           custodyAccountDetails: {},
           ///: END:ONLY_INCLUDE_IF
+          sessionData: undefined,
           keyrings: [],
         });
 
@@ -1558,6 +1559,7 @@ describe('MetaMetricsController', function () {
           ///: BEGIN:ONLY_INCLUDE_IF(build-mmi)
           custodyAccountDetails: {},
           ///: END:ONLY_INCLUDE_IF
+          sessionData: undefined,
           keyrings: [],
         });
 
@@ -1618,6 +1620,14 @@ describe('MetaMetricsController', function () {
           ///: BEGIN:ONLY_INCLUDE_IF(build-mmi)
           custodyAccountDetails: {},
           ///: END:ONLY_INCLUDE_IF
+          sessionData: {
+            accessToken: '',
+            expiresIn: '',
+            profile: {
+              identifierId: 'identifierId',
+              profileId: 'profileId',
+            },
+          },
           keyrings: [],
         });
 
@@ -1627,6 +1637,7 @@ describe('MetaMetricsController', function () {
           [MetaMetricsUserTrait.NumberOfTokens]: 1,
           [MetaMetricsUserTrait.OpenSeaApiEnabled]: false,
           [MetaMetricsUserTrait.ShowNativeTokenAsMainBalance]: false,
+          [MetaMetricsUserTrait.ProfileId]: 'profileId',
         });
       });
     });
@@ -1686,6 +1697,14 @@ describe('MetaMetricsController', function () {
           ///: BEGIN:ONLY_INCLUDE_IF(build-mmi)
           custodyAccountDetails: {},
           ///: END:ONLY_INCLUDE_IF
+          sessionData: {
+            accessToken: '',
+            expiresIn: '',
+            profile: {
+              identifierId: 'identifierId',
+              profileId: 'profileId',
+            },
+          },
           keyrings: [],
         });
 
@@ -1736,6 +1755,14 @@ describe('MetaMetricsController', function () {
           ///: BEGIN:ONLY_INCLUDE_IF(build-mmi)
           custodyAccountDetails: {},
           ///: END:ONLY_INCLUDE_IF
+          sessionData: {
+            accessToken: '',
+            expiresIn: '',
+            profile: {
+              identifierId: 'identifierId',
+              profileId: 'profileId',
+            },
+          },
           keyrings: [],
         });
         expect(updatedTraits).toStrictEqual(null);

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,
@@ -169,6 +170,7 @@ export type MetaMaskState = {
     privacyMode: PreferencesControllerState['preferences']['privacyMode'];
     tokenNetworkFilter: string[];
   };
+  sessionData: AuthenticationControllerState['sessionData'];
   ///: BEGIN:ONLY_INCLUDE_IF(build-mmi)
   custodyAccountDetails: {
     [address: string]: {
@@ -1242,6 +1244,8 @@ export default class MetaMetricsController extends BaseController<
       [MetaMetricsUserTrait.NetworkFilterPreference]: Object.keys(
         metamaskState.preferences.tokenNetworkFilter || {},
       ),
+      [MetaMetricsUserTrait.ProfileId]:
+        metamaskState.sessionData?.profile?.profileId,
     };
 
     if (!previousUserTraits && metamaskState.participateInMetaMetrics) {

shared/constants/metametrics.ts

@@ -494,6 +494,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 {
@@ -606,6 +610,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',
 }
 
 /**