Merge branch 'main' into fix/evaluateCohortEligibility

Author: lwin-kyaw

app/_locales/en/messages.json

@@ -49,7 +49,10 @@ import {
   GetAddressSecurityAlertResponse,
   AddAddressSecurityAlertResponse,
 } from '../../../shared/lib/trust-signals';
-import { DefaultSubscriptionPaymentOptions } from '../../../shared/types';
+import {
+  DefaultSubscriptionPaymentOptions,
+  ShieldSubscriptionMetricsPropsFromUI,
+} from '../../../shared/types';
 import type {
   Preferences,
   PreferencesControllerGetStateAction,
@@ -128,6 +131,12 @@ export type AppStateControllerState = {
   pendingShieldCohortTxType: string | null;
   defaultSubscriptionPaymentOptions?: DefaultSubscriptionPaymentOptions;
 
+  /**
+   * The properties for the Shield subscription metrics.
+   * Since we can't access some of these properties in the background, we need to get them from the UI.
+   */
+  shieldSubscriptionMetricsProps?: ShieldSubscriptionMetricsPropsFromUI;
+
   /**
    * Whether the wallet reset is in progress.
    */
@@ -644,6 +653,12 @@ const controllerMetadata: StateMetadata<AppStateControllerState> = {
     includeInDebugSnapshot: false,
     usedInUi: false,
   },
+  shieldSubscriptionMetricsProps: {
+    includeInStateLogs: false,
+    persist: true,
+    includeInDebugSnapshot: false,
+    usedInUi: false,
+  },
 };
 
 export class AppStateController extends BaseController<
@@ -1585,4 +1600,17 @@ export class AppStateController extends BaseController<
         defaultSubscriptionPaymentOptions;
     });
   }
+
+  /**
+   * Update the Shield subscription metrics properties which are not accessible in the background directly.
+   *
+   * @param shieldSubscriptionMetricsProps - The Shield subscription metrics properties.
+   */
+  setShieldSubscriptionMetricsProps(
+    shieldSubscriptionMetricsProps: ShieldSubscriptionMetricsPropsFromUI,
+  ): void {
+    this.update((state) => {
+      state.shieldSubscriptionMetricsProps = shieldSubscriptionMetricsProps;
+    });
+  }
 }

app/_locales/en_GB/messages.json

@@ -2938,6 +2938,10 @@ export default class MetamaskController extends EventEmitter {
         appStateController.setDefaultSubscriptionPaymentOptions.bind(
           appStateController,
         ),
+      setShieldSubscriptionMetricsProps:
+        appStateController.setShieldSubscriptionMetricsProps.bind(
+          appStateController,
+        ),
 
       // EnsController
       tryReverseResolveAddress:

app/_locales/ga/messages.json

@@ -230,13 +230,17 @@ export class SubscriptionService {
     const appStateControllerState = this.#messenger.call(
       'AppStateController:getState',
     );
-    const { defaultSubscriptionPaymentOptions } = appStateControllerState;
+    const {
+      defaultSubscriptionPaymentOptions,
+      shieldSubscriptionMetricsProps,
+    } = appStateControllerState;
 
     const accountTypeAndCategory = this.#getAccountTypeAndCategoryForMetrics();
 
     const trackingProps = getSubscriptionRequestTrackingProps(
       subscriptionControllerState,
       defaultSubscriptionPaymentOptions,
+      shieldSubscriptionMetricsProps,
       transactionMeta,
     );
 
@@ -246,13 +250,17 @@ export class SubscriptionService {
       const renewalTrackingProps = getSubscriptionRestartRequestTrackingProps(
         subscriptionControllerState,
         requestStatus,
+        shieldSubscriptionMetricsProps,
         extrasProps?.error_message as string | undefined,
       );
 
       this.#messenger.call('MetaMetricsController:trackEvent', {
         event: MetaMetricsEventName.ShieldMembershipRestartRequest,
         category: MetaMetricsEventCategory.Shield,
-        properties: renewalTrackingProps,
+        properties: {
+          ...accountTypeAndCategory,
+          ...renewalTrackingProps,
+        },
       });
     }
 
@@ -262,8 +270,8 @@ export class SubscriptionService {
       properties: {
         ...accountTypeAndCategory,
         ...trackingProps,
-        status: requestStatus,
         ...extrasProps,
+        status: requestStatus,
       },
     });
   }

app/scripts/controllers/app-state-controller.ts

@@ -900,6 +900,7 @@
         "@metamask/superstruct": true,
         "@metamask/utils": true,
         "@metamask/bridge-controller>bignumber.js": true,
+        "browserify>buffer": true,
         "lodash": true,
         "reselect": true,
         "uuid": true

app/scripts/metamask-controller.js

@@ -900,6 +900,7 @@
         "@metamask/superstruct": true,
         "@metamask/utils": true,
         "@metamask/bridge-controller>bignumber.js": true,
+        "browserify>buffer": true,
         "lodash": true,
         "reselect": true,
         "uuid": true

app/scripts/services/subscription/subscription-service.ts

@@ -900,6 +900,7 @@
         "@metamask/superstruct": true,
         "@metamask/utils": true,
         "@metamask/bridge-controller>bignumber.js": true,
+        "browserify>buffer": true,
         "lodash": true,
         "reselect": true,
         "uuid": true

lavamoat/browserify/beta/policy.json

@@ -900,6 +900,7 @@
         "@metamask/superstruct": true,
         "@metamask/utils": true,
         "@metamask/bridge-controller>bignumber.js": true,
+        "browserify>buffer": true,
         "lodash": true,
         "reselect": true,
         "uuid": true