feat(payments): add statsd logging to hot paths

Because:

- We want to log interactions with various services to statsd

This commit:

- Adds a statsd decorator, as well as a few specific calls to statsd
  after important events

Closes FXA-10618
Closes FXA-8304

Author: julianpoy

libs/google/src/lib/google.client.spec.ts

@@ -6,6 +6,7 @@ import { Test } from '@nestjs/testing';
 import { GeocodeResultFactory } from './factories';
 import { GoogleClient } from './google.client';
 import { MockGoogleClientConfigProvider } from './google.client.config';
+import { MockStatsDProvider } from '@fxa/shared/metrics/statsd';
 
 const mockJestFnGenerator = <T extends (...args: any[]) => any>() => {
   return jest.fn<ReturnType<T>, Parameters<T>>();
@@ -26,7 +27,11 @@ describe('GoogleClient', () => {
 
   beforeEach(async () => {
     const module = await Test.createTestingModule({
-      providers: [GoogleClient, MockGoogleClientConfigProvider],
+      providers: [
+        GoogleClient,
+        MockGoogleClientConfigProvider,
+        MockStatsDProvider,
+      ],
     }).compile();
 
     googleClient = module.get<GoogleClient>(GoogleClient);

libs/google/src/lib/google.client.ts

@@ -6,20 +6,29 @@ import {
   Client,
   GeocodeResponseData,
 } from '@googlemaps/google-maps-services-js';
-import { Injectable } from '@nestjs/common';
+import { Inject, Injectable } from '@nestjs/common';
 import { GoogleClientConfig } from './google.client.config';
+import {
+  CaptureTimingWithStatsD,
+  StatsDService,
+  type StatsD,
+} from '@fxa/shared/metrics/statsd';
 
 @Injectable()
 export class GoogleClient {
   private readonly google: Client;
-  constructor(private googleClientConfig: GoogleClientConfig) {
+  constructor(
+    private googleClientConfig: GoogleClientConfig,
+    @Inject(StatsDService) public statsd: StatsD
+  ) {
     this.google = new Client();
   }
 
   /**
    * Retrieve Geocode Data for the specified address. For more information review
    * https://developers.google.com/maps/documentation/geocoding/overview
    */
+  @CaptureTimingWithStatsD()
   async geocode(address: string, countryCode: string) {
     const response = await this.google.geocode({
       params: {

libs/google/src/lib/google.manager.spec.ts

@@ -8,14 +8,20 @@ import { GeocodeResultFactory } from './factories';
 import { GoogleClient } from './google.client';
 import { MockGoogleClientConfigProvider } from './google.client.config';
 import { GoogleManager } from './google.manager';
+import { MockStatsDProvider } from '@fxa/shared/metrics/statsd';
 
 describe('GoogleManager', () => {
   let googleClient: GoogleClient;
   let googleManager: GoogleManager;
 
   beforeEach(async () => {
     const module = await Test.createTestingModule({
-      providers: [GoogleClient, GoogleManager, MockGoogleClientConfigProvider],
+      providers: [
+        GoogleClient,
+        GoogleManager,
+        MockGoogleClientConfigProvider,
+        MockStatsDProvider,
+      ],
     }).compile();
 
     googleClient = module.get<GoogleClient>(GoogleClient);

libs/payments/cart/src/lib/cart.service.spec.ts

@@ -854,12 +854,13 @@ describe('CartService', () => {
 
       await cartService.finalizeProcessingCart(mockCart.id);
 
-      expect(checkoutService.postPaySteps).toHaveBeenCalledWith(
-        mockCart,
-        mockCart.version,
-        mockSubscription,
-        mockCart.uid
-      );
+      expect(checkoutService.postPaySteps).toHaveBeenCalledWith({
+        cart: mockCart,
+        version: mockCart.version,
+        subscription: mockSubscription,
+        uid: mockCart.uid,
+        paymentProvider: 'stripe',
+      });
     });
   });
 
@@ -1539,12 +1540,13 @@ describe('CartService', () => {
           default_payment_method: mockPaymentMethod.id,
         },
       });
-      expect(checkoutService.postPaySteps).toHaveBeenCalledWith(
-        mockCart,
-        mockCart.version,
-        mockSubscription,
-        mockCart.uid
-      );
+      expect(checkoutService.postPaySteps).toHaveBeenCalledWith({
+        cart: mockCart,
+        version: mockCart.version,
+        subscription: mockSubscription,
+        uid: mockCart.uid,
+        paymentProvider: 'stripe',
+      });
       expect(cartManager.finishErrorCart).not.toHaveBeenCalled();
     });
 

libs/payments/cart/src/lib/cart.service.ts

@@ -194,11 +194,6 @@ export class CartService {
     uid?: string;
     ip?: string;
   }): Promise<ResultCart> {
-    // TODO:
-    // - Fetch information about interval, offering, experiments from CMS
-    // - Guess TaxAddress via maxmind client
-    // - Check if user is eligible to subscribe to plan, else throw error
-    // - Fetch stripeCustomerId if uid is passed and has a customer id
     let accountCustomer;
     if (args.uid) {
       accountCustomer = await this.accountCustomerManager
@@ -443,12 +438,14 @@ export class CartService {
       if (!subscription) {
         throw new CartSubscriptionNotFoundError(cartId);
       }
-      await this.checkoutService.postPaySteps(
+      await this.checkoutService.postPaySteps({
         cart,
-        cart.version,
+        version: cart.version,
         subscription,
-        cart.uid
-      );
+        uid: cart.uid,
+        paymentProvider:
+          this.subscriptionManager.getPaymentProvider(subscription),
+      });
     });
   }
 
@@ -603,7 +600,10 @@ export class CartService {
     } else if (subscriptions.length) {
       const firstListedSubscription = subscriptions[0];
       // fetch payment method info
-      if (firstListedSubscription.collection_method === 'send_invoice') {
+      if (
+        this.subscriptionManager.getPaymentProvider(firstListedSubscription) ===
+        'paypal'
+      ) {
         // PayPal payment method collection
         paymentInfo = {
           type: 'external_paypal',
@@ -756,12 +756,14 @@ export class CartService {
         const subscription = await this.subscriptionManager.retrieve(
           cart.stripeSubscriptionId
         );
-        await this.checkoutService.postPaySteps(
+        await this.checkoutService.postPaySteps({
           cart,
-          cart.version,
+          version: cart.version,
           subscription,
-          cart.uid
-        );
+          uid: cart.uid,
+          paymentProvider:
+            this.subscriptionManager.getPaymentProvider(subscription),
+        });
       } else {
         const promises: Promise<any>[] = [
           this.finalizeCartWithError(cartId, CartErrorReasonId.Unknown),

libs/payments/cart/src/lib/checkout.service.spec.ts

@@ -411,17 +411,20 @@ describe('CheckoutService', () => {
       jest.spyOn(customerManager, 'setTaxId').mockResolvedValue();
       jest.spyOn(profileClient, 'deleteCache').mockResolvedValue('test');
       jest.spyOn(cartManager, 'finishCart').mockResolvedValue();
+      jest.spyOn(statsd, 'increment');
     });
 
     it('success', async () => {
       const mockCart = ResultCartFactory();
+      const paymentProvider = 'stripe';
 
-      await checkoutService.postPaySteps(
-        mockCart,
-        mockCart.version,
-        mockSubscription,
-        mockUid
-      );
+      await checkoutService.postPaySteps({
+        cart: mockCart,
+        version: mockCart.version,
+        subscription: mockSubscription,
+        uid: mockUid,
+        paymentProvider,
+      });
 
       expect(customerManager.setTaxId).toHaveBeenCalledWith(
         mockSubscription.customer,
@@ -430,6 +433,11 @@ describe('CheckoutService', () => {
 
       expect(privateMethod).toHaveBeenCalled();
       expect(cartManager.finishCart).toHaveBeenCalled();
+      expect(statsd.increment).toHaveBeenCalledWith('subscription_success', {
+        payment_provider: paymentProvider,
+        offering_id: mockCart.offeringConfigId,
+        interval: mockCart.interval,
+      });
     });
 
     it('success - adds coupon code to subscription metadata if it exists', async () => {
@@ -444,17 +452,19 @@ describe('CheckoutService', () => {
           },
         })
       );
+      const paymentProvider = 'stripe';
 
       jest
         .spyOn(subscriptionManager, 'update')
         .mockResolvedValue(mockUpdatedSubscription);
 
-      await checkoutService.postPaySteps(
-        mockCart,
-        mockCart.version,
-        mockSubscription,
-        mockUid
-      );
+      await checkoutService.postPaySteps({
+        cart: mockCart,
+        version: mockCart.version,
+        subscription: mockSubscription,
+        uid: mockUid,
+        paymentProvider,
+      });
 
       expect(customerManager.setTaxId).toHaveBeenCalledWith(
         mockSubscription.customer,
@@ -598,12 +608,13 @@ describe('CheckoutService', () => {
       });
 
       it('calls postPaySteps', async () => {
-        expect(checkoutService.postPaySteps).toHaveBeenCalledWith(
-          mockCart,
-          mockPrePayStepsResult.version + 1,
-          mockSubscription,
-          mockCart.uid
-        );
+        expect(checkoutService.postPaySteps).toHaveBeenCalledWith({
+          cart: mockCart,
+          version: mockPrePayStepsResult.version + 1,
+          subscription: mockSubscription,
+          uid: mockCart.uid,
+          paymentProvider: 'stripe',
+        });
       });
     });
 
@@ -829,12 +840,13 @@ describe('CheckoutService', () => {
         );
       });
       it('calls postPaySteps', async () => {
-        expect(checkoutService.postPaySteps).toHaveBeenCalledWith(
-          mockCart,
-          mockPrePayStepsResult.version + 1,
-          mockSubscription,
-          mockCart.uid
-        );
+        expect(checkoutService.postPaySteps).toHaveBeenCalledWith({
+          cart: mockCart,
+          version: mockPrePayStepsResult.version + 1,
+          subscription: mockSubscription,
+          uid: mockCart.uid,
+          paymentProvider: 'paypal',
+        });
       });
     });
     describe('uncollectible', () => {

libs/payments/cart/src/lib/checkout.service.ts

@@ -212,12 +212,14 @@ export class CheckoutService {
     };
   }
 
-  async postPaySteps(
-    cart: ResultCart,
-    version: number,
-    subscription: StripeSubscription,
-    uid: string
-  ) {
+  async postPaySteps(args: {
+    cart: ResultCart;
+    version: number;
+    subscription: StripeSubscription;
+    uid: string;
+    paymentProvider: 'stripe' | 'paypal';
+  }) {
+    const { cart, version, subscription, uid, paymentProvider } = args;
     const { customer: customerId, currency } = subscription;
 
     await this.customerManager.setTaxId(customerId, currency);
@@ -235,8 +237,11 @@ export class CheckoutService {
     }
     await this.cartManager.finishCart(cart.id, version, {});
 
-    // TODO: call sendFinishSetupEmailForStubAccount
-    console.log(cart.id, subscription.id);
+    this.statsd.increment('subscription_success', {
+      payment_provider: paymentProvider,
+      offering_id: cart.offeringConfigId,
+      interval: cart.interval,
+    });
   }
 
   async payWithStripe(
@@ -319,7 +324,13 @@ export class CheckoutService {
           { cartId: cart.id }
         );
       }
-      await this.postPaySteps(cart, updatedVersion, subscription, uid);
+      await this.postPaySteps({
+        cart,
+        version: updatedVersion,
+        subscription,
+        uid,
+        paymentProvider: 'stripe',
+      });
     } else {
       throw new CheckoutPaymentError(
         `Expected payment intent status to be one of [requires_action, succeeded], instead found: ${paymentIntent.status}`
@@ -409,7 +420,13 @@ export class CheckoutService {
       latestInvoice
     );
     if (['paid', 'open'].includes(processedInvoice.status ?? '')) {
-      await this.postPaySteps(cart, updatedVersion, subscription, uid);
+      await this.postPaySteps({
+        cart,
+        version: updatedVersion,
+        subscription,
+        uid,
+        paymentProvider: 'paypal',
+      });
     } else {
       throw new CheckoutPaymentError(
         `Expected processed invoice status to be one of [paid, open], instead found: ${processedInvoice.status}`

libs/payments/content-server/src/lib/content-server.client.ts

@@ -2,17 +2,26 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-import { Injectable } from '@nestjs/common';
+import { Inject, Injectable } from '@nestjs/common';
 import { ContentServerClientConfig } from './content-server.config';
 import { MetricsFlow } from './content-server.types';
+import {
+  CaptureTimingWithStatsD,
+  StatsDService,
+  type StatsD,
+} from '@fxa/shared/metrics/statsd';
 
 @Injectable()
 export class ContentServerClient {
   private readonly url: string;
-  constructor(private contentServerClientConfig: ContentServerClientConfig) {
+  constructor(
+    private contentServerClientConfig: ContentServerClientConfig,
+    @Inject(StatsDService) public statsd: StatsD
+  ) {
     this.url = this.contentServerClientConfig.url || 'http://localhost:3030';
   }
 
+  @CaptureTimingWithStatsD()
   public async getMetricsFlow() {
     const response = await fetch(`${this.url}/metrics-flow`, { method: 'GET' });
     if (!response.ok) {

libs/payments/customer/src/lib/customer.manager.spec.ts

@@ -14,14 +14,20 @@ import {
 } from '@fxa/payments/stripe';
 import { TaxAddressFactory } from './factories/tax-address.factory';
 import { CustomerManager } from './customer.manager';
+import { MockStatsDProvider } from '@fxa/shared/metrics/statsd';
 
 describe('CustomerManager', () => {
   let customerManager: CustomerManager;
   let stripeClient: StripeClient;
 
   beforeEach(async () => {
     const module = await Test.createTestingModule({
-      providers: [MockStripeConfigProvider, StripeClient, CustomerManager],
+      providers: [
+        MockStripeConfigProvider,
+        StripeClient,
+        CustomerManager,
+        MockStatsDProvider,
+      ],
     }).compile();
 
     customerManager = module.get(CustomerManager);