Merge pull request #20211 from mozilla/PAY-3496-add-payment-method-from-checkout-to-glean-metrics

feat(payments-next): Add payment method from Checkout to Glean metrics

Author: elizabeth-ilina

libs/payments/events/src/lib/emitter.service.spec.ts

@@ -31,6 +31,7 @@ import {
   SubscriptionManager,
   PaymentMethodManager,
   PaymentProvider,
+  SubPlatPaymentMethodType,
   StripePaymentMethodTypeResponseFactory,
 } from '@fxa/payments/customer';
 import { MockFirestoreProvider } from '@fxa/shared/db/firestore';
@@ -109,6 +110,7 @@ describe('PaymentsEmitterService', () => {
   const mockCheckoutPaymentEvents = {
     ...mockCommonMetricsData,
     paymentProvider: PaymentProvider.Stripe,
+    paymentMethod: SubPlatPaymentMethodType.Card,
   };
   let retrieveOptOutMock: jest.SpyInstance<any, unknown[], any>;
   const mockLogger = {
@@ -383,7 +385,8 @@ describe('PaymentsEmitterService', () => {
           experimentationData: { nimbusUserId },
           ...additionalMetricsData,
         },
-        mockCheckoutPaymentEvents.paymentProvider
+        mockCheckoutPaymentEvents.paymentProvider,
+        mockCheckoutPaymentEvents.paymentMethod
       );
     });
 
@@ -445,7 +448,8 @@ describe('PaymentsEmitterService', () => {
           experimentationData: { nimbusUserId },
           ...additionalMetricsData,
         },
-        mockPaymentMethod.provider
+        mockPaymentMethod.provider,
+        mockPaymentMethod.type
       );
     });
 

libs/payments/events/src/lib/emitter.service.ts

@@ -27,6 +27,7 @@ import {
   SubscriptionManager,
   PaymentMethodManager,
   PaymentProvidersType,
+  type SubPlatPaymentMethodType,
 } from '@fxa/payments/customer';
 import * as Sentry from '@sentry/nestjs';
 import { StatsD, StatsDService } from '@fxa/shared/metrics/statsd';
@@ -205,7 +206,8 @@ export class PaymentsEmitterService {
           ...additionalData,
           experimentationData: { nimbusUserId },
         },
-        eventData.paymentProvider
+        eventData.paymentProvider,
+        eventData.paymentMethod
       );
     }
   }
@@ -231,8 +233,9 @@ export class PaymentsEmitterService {
           eventData?.searchParams?.['experimentationPreview'] === 'true',
       });
 
-      // Determine payment provider
+      // Determine payment provider and method
       let paymentProvider: PaymentProvidersType | undefined;
+      let paymentMethod: SubPlatPaymentMethodType | undefined;
       if (additionalData.cartMetricsData.stripeCustomerId) {
         const { stripeCustomerId } = additionalData.cartMetricsData;
         const customer = await this.customerManager.retrieve(stripeCustomerId);
@@ -246,6 +249,7 @@ export class PaymentsEmitterService {
 
         if (paymentMethodTypeResponse?.type) {
           paymentProvider = paymentMethodTypeResponse.provider;
+          paymentMethod = paymentMethodTypeResponse.type;
         }
       }
 
@@ -255,7 +259,8 @@ export class PaymentsEmitterService {
           ...additionalData,
           experimentationData: { nimbusUserId },
         },
-        paymentProvider
+        paymentProvider,
+        paymentMethod
       );
     }
   }

libs/payments/events/src/lib/emitter.types.ts

@@ -11,7 +11,10 @@ import {
 } from '@fxa/payments/metrics';
 import { LocationStatus } from '@fxa/payments/eligibility';
 import { TaxChangeAllowedStatus } from '@fxa/payments/cart';
-import { PaymentProvidersType } from '@fxa/payments/customer';
+import {
+  PaymentProvidersType,
+  type SubPlatPaymentMethodType,
+} from '@fxa/payments/customer';
 
 export enum GleanGenericEventNames {
   CancelRouteChurnContent = 'recordCancelRouteChurnContent',
@@ -29,6 +32,7 @@ export enum GleanGenericEventNames {
 export type CheckoutEvents = CommonMetrics;
 export type CheckoutPaymentEvents = CommonMetrics & {
   paymentProvider?: PaymentProvidersType;
+  paymentMethod?: SubPlatPaymentMethodType;
 };
 
 export type SubscriptionEndedEvents = {

libs/payments/metrics/src/lib/glean/glean.manager.spec.ts

@@ -17,6 +17,7 @@ import {
   MockPaymentsGleanConfigProvider,
   PaymentsGleanConfig,
 } from './glean.config';
+import { SubPlatPaymentMethodType } from '@fxa/payments/customer';
 
 const mockCommonMetricsData = {
   commonMetricsData: CommonMetricsFactory(),
@@ -27,6 +28,7 @@ const mockCommonMetricsData = {
 };
 const mockCommonMetrics = { common: 'metrics' };
 const mockPaymentProvider = 'stripe';
+const mockPaymentMethod = SubPlatPaymentMethodType.Card;
 
 describe('PaymentsGleanManager', () => {
   let paymentsGleanManager: PaymentsGleanManager;
@@ -106,19 +108,23 @@ describe('PaymentsGleanManager', () => {
         .mockReturnValue(mockCommonMetrics);
     });
 
-    it('should record fxa pay setup engage', () => {
+    it('should record fxa pay setup submit', () => {
       paymentsGleanManager.recordFxaPaySetupSubmit(
         mockCommonMetricsData,
-        mockPaymentProvider
+        mockPaymentProvider,
+        mockPaymentMethod
       );
       expect(spyPopulateCommonMetrics).toHaveBeenCalledWith(
-        mockCommonMetricsData
+        mockCommonMetricsData,
+        mockPaymentProvider,
+        mockPaymentMethod
       );
       expect(
         paymentsGleanServerEventsLogger.recordPaySetupSubmit
       ).toHaveBeenCalledWith({
         ...mockCommonMetrics,
         subscription_payment_provider: mockPaymentProvider,
+        subscription_payment_method: mockPaymentMethod,
       });
     });
   });
@@ -133,19 +139,23 @@ describe('PaymentsGleanManager', () => {
         .mockReturnValue(mockCommonMetrics);
     });
 
-    it('should record fxa pay setup engage', () => {
+    it('should record fxa pay setup success', () => {
       paymentsGleanManager.recordFxaPaySetupSuccess(
         mockCommonMetricsData,
-        mockPaymentProvider
+        mockPaymentProvider,
+        mockPaymentMethod
       );
       expect(spyPopulateCommonMetrics).toHaveBeenCalledWith(
-        mockCommonMetricsData
+        mockCommonMetricsData,
+        mockPaymentProvider,
+        mockPaymentMethod
       );
       expect(
         paymentsGleanServerEventsLogger.recordPaySetupSuccess
       ).toHaveBeenCalledWith({
         ...mockCommonMetrics,
         subscription_payment_provider: mockPaymentProvider,
+        subscription_payment_method: mockPaymentMethod,
       });
     });
   });
@@ -160,13 +170,13 @@ describe('PaymentsGleanManager', () => {
         .mockReturnValue(mockCommonMetrics);
     });
 
-    it('should record fxa pay setup engage', () => {
+    it('should record fxa pay setup fail', () => {
       paymentsGleanManager.recordFxaPaySetupFail(
         mockCommonMetricsData,
         mockPaymentProvider
       );
       expect(spyPopulateCommonMetrics).toHaveBeenCalledWith(
-        mockCommonMetricsData
+        mockCommonMetricsData,
       );
       expect(
         paymentsGleanServerEventsLogger.recordPaySetupFail
@@ -196,11 +206,14 @@ describe('PaymentsGleanManager', () => {
         },
         mockPaymentProvider
       );
-      expect(spyPopulateCommonMetrics).toHaveBeenCalledWith({
-        cmsMetricsData: mockCommonMetricsData.cmsMetricsData,
-        subscriptionCancellationData:
-          mockCommonMetricsData.subscriptionCancellationData,
-      });
+      expect(spyPopulateCommonMetrics).toHaveBeenCalledWith(
+        {
+          cmsMetricsData: mockCommonMetricsData.cmsMetricsData,
+          subscriptionCancellationData:
+            mockCommonMetricsData.subscriptionCancellationData,
+        },
+        mockPaymentProvider
+      );
       expect(
         paymentsGleanServerEventsLogger.recordSubscriptionEnded
       ).toHaveBeenCalledWith({

libs/payments/metrics/src/lib/glean/glean.manager.ts

@@ -17,7 +17,10 @@ import {
   type SubPlatCmsMetricsData,
 } from './glean.types';
 import { Inject, Injectable } from '@nestjs/common';
-import { PaymentProvidersType } from '@fxa/payments/customer';
+import {
+  PaymentProvidersType,
+  type SubPlatPaymentMethodType,
+} from '@fxa/payments/customer';
 import { type PaymentsGleanServerEventsLogger } from './glean.provider';
 import { mapSession } from './utils/mapSession';
 import { mapUtm } from './utils/mapUtm';
@@ -86,13 +89,16 @@ export class PaymentsGleanManager {
       cmsMetricsData: CmsMetricsData;
       experimentationData: ExperimentationData;
     },
-    paymentProvider?: PaymentProvidersType
+    paymentProvider?: PaymentProvidersType,
+    paymentMethod?: SubPlatPaymentMethodType
   ) {
     if (this.isEnabled) {
       this.paymentsGleanServerEventsLogger.recordPaySetupSubmit({
-        ...this.populateCommonMetrics(metrics),
+        ...this.populateCommonMetrics(metrics, paymentProvider, paymentMethod),
         subscription_payment_provider:
           normalizeGleanFalsyValues(paymentProvider),
+        subscription_payment_method:
+          normalizeGleanFalsyValues(paymentMethod),
       });
     }
   }
@@ -104,15 +110,18 @@ export class PaymentsGleanManager {
       cmsMetricsData: CmsMetricsData;
       experimentationData: ExperimentationData;
     },
-    paymentProvider?: PaymentProvidersType
+    paymentProvider?: PaymentProvidersType,
+    paymentMethod?: SubPlatPaymentMethodType
   ) {
-    const commonMetrics = this.populateCommonMetrics(metrics);
+    const commonMetrics = this.populateCommonMetrics(metrics, paymentProvider, paymentMethod);
 
     if (this.isEnabled) {
       this.paymentsGleanServerEventsLogger.recordPaySetupSuccess({
         ...commonMetrics,
         subscription_payment_provider:
           normalizeGleanFalsyValues(paymentProvider),
+        subscription_payment_method:
+          normalizeGleanFalsyValues(paymentMethod),
       });
     }
   }
@@ -144,7 +153,7 @@ export class PaymentsGleanManager {
     },
     paymentProvider?: PaymentProvidersType
   ) {
-    const commonMetrics = this.populateCommonMetrics(metrics);
+    const commonMetrics = this.populateCommonMetrics(metrics, paymentProvider);
 
     if (this.isEnabled) {
       this.paymentsGleanServerEventsLogger.recordSubscriptionEnded({
@@ -243,6 +252,7 @@ export class PaymentsGleanManager {
       subscription_interval: cms.interval ?? '',
       subscription_offering_id: cms.offeringId ?? '',
       subscription_payment_provider: PLACEHOLDER_FUTURE_USE,
+      subscription_payment_method: PLACEHOLDER_FUTURE_USE,
       subscription_plan_id: stripe.priceId ?? '',
       subscription_product_id: stripe.productId ?? '',
       subscription_promotion_code: stripe.couponCode ?? '',
@@ -266,13 +276,17 @@ export class PaymentsGleanManager {
     };
   }
 
-  private populateCommonMetrics(metrics: {
-    commonMetricsData?: CommonMetrics;
-    cartMetricsData?: CartMetrics;
-    cmsMetricsData?: CmsMetricsData;
-    experimentationData?: ExperimentationData;
-    subscriptionCancellationData?: SubscriptionCancellationData;
-  }) {
+  private populateCommonMetrics(
+    metrics: {
+      commonMetricsData?: CommonMetrics;
+      cartMetricsData?: CartMetrics;
+      cmsMetricsData?: CmsMetricsData;
+      experimentationData?: ExperimentationData;
+      subscriptionCancellationData?: SubscriptionCancellationData;
+    },
+    paymentProvider?: PaymentProvidersType,
+    paymentMethod?: SubPlatPaymentMethodType
+  ) {
     const emptyCommonMetricsData: CommonMetrics = {
       ipAddress: '',
       deviceType: '',
@@ -325,6 +339,8 @@ export class PaymentsGleanManager {
         cartMetricsData,
         cmsMetricsData,
         subscriptionCancellationData,
+        paymentProvider,
+        paymentMethod,
         isFreeTrial: commonMetricsData.isFreeTrial,
       }),
       ...mapUtm(commonMetricsData.searchParams),

libs/payments/metrics/src/lib/glean/utils/mapSubscription.spec.ts

@@ -9,6 +9,7 @@ import {
   CheckoutParamsFactory,
 } from '../glean.factory';
 import { mapSubscription } from './mapSubscription';
+import { SubPlatPaymentMethodType } from '@fxa/payments/customer';
 
 describe('mapSubscription', () => {
   it('should map all values', () => {
@@ -24,6 +25,8 @@ describe('mapSubscription', () => {
       commonMetricsData: mockCommonData,
       cartMetricsData: mockCartData,
       cmsMetricsData: mockCmsMetricsData,
+      paymentProvider: 'stripe',
+      paymentMethod: SubPlatPaymentMethodType.Card,
     });
     expect(result).toEqual({
       subscription_cancellation_reason: '',
@@ -33,7 +36,8 @@ describe('mapSubscription', () => {
       subscription_is_free_trial: '',
       subscription_interval: mockCommonData.params['interval'],
       subscription_offering_id: mockCommonData.params['offeringId'],
-      subscription_payment_provider: '',
+      subscription_payment_method: 'card',
+      subscription_payment_provider: 'stripe',
       subscription_plan_id: mockCmsMetricsData.priceId,
       subscription_product_id: mockCmsMetricsData.productId,
       subscription_promotion_code: mockCartData.couponCode,
@@ -72,6 +76,35 @@ describe('mapSubscription', () => {
     expect(result.subscription_is_free_trial).toBe('');
   });
 
+  it('should map paymentMethod when provided', () => {
+    const mockCommonData = CommonMetricsFactory({
+      params: CheckoutParamsFactory(),
+    });
+    const mockCartData = CartMetricsFactory();
+    const mockCmsMetricsData = CmsMetricsDataFactory();
+    const result = mapSubscription({
+      commonMetricsData: mockCommonData,
+      cartMetricsData: mockCartData,
+      cmsMetricsData: mockCmsMetricsData,
+      paymentMethod: SubPlatPaymentMethodType.PayPal,
+    });
+    expect(result.subscription_payment_method).toBe('external_paypal');
+  });
+
+  it('should default paymentMethod to empty string when not provided', () => {
+    const mockCommonData = CommonMetricsFactory({
+      params: CheckoutParamsFactory(),
+    });
+    const mockCartData = CartMetricsFactory();
+    const mockCmsMetricsData = CmsMetricsDataFactory();
+    const result = mapSubscription({
+      commonMetricsData: mockCommonData,
+      cartMetricsData: mockCartData,
+      cmsMetricsData: mockCmsMetricsData,
+    });
+    expect(result.subscription_payment_method).toBe('');
+  });
+
   it('should return empty strings if values are not present', () => {
     const mockCommonData = CommonMetricsFactory({
       params: {},
@@ -98,6 +131,7 @@ describe('mapSubscription', () => {
       subscription_is_free_trial: '',
       subscription_interval: '',
       subscription_offering_id: '',
+      subscription_payment_method: '',
       subscription_payment_provider: '',
       subscription_plan_id: '',
       subscription_product_id: '',