Merge pull request #18858 from mozilla/metrics-tweaks

feat(payments-next): add metrics for each server action, better tagging

Author: julianpoy

libs/payments/cart/src/lib/cart.manager.in.spec.ts

@@ -27,6 +27,7 @@ import {
 } from './cart.factories';
 import { CartManager } from './cart.manager';
 import { ResultCart } from './cart.types';
+import { type StatsD } from '@fxa/shared/metrics/statsd';
 
 // Fail action, which sometimes isn't here due to a weird issue defined here:
 // https://github.com/jestjs/jest/issues/11698#issuecomment-922351139
@@ -57,7 +58,9 @@ describe('CartManager', () => {
 
   beforeAll(async () => {
     db = await testAccountDatabaseSetup(['accounts', 'carts']);
-    cartManager = new CartManager(db);
+    cartManager = new CartManager(db, {
+      timing: jest.fn(),
+    } as unknown as StatsD);
     await db
       .insertInto('carts')
       .values({

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

@@ -22,7 +22,7 @@ import {
   fetchCartsByUid,
   updateCart,
 } from './cart.repository';
-import {
+import type {
   FinishCart,
   FinishErrorCart,
   ResultCart,
@@ -35,6 +35,7 @@ import type {
   CartErrorReasonId,
 } from '@fxa/shared/db/mysql/account';
 import assert from 'assert';
+import { CaptureTimingWithStatsD, StatsDService, type StatsD } from '@fxa/shared/metrics/statsd';
 // For an action to be executed, the cart state needs to be in one of
 // valid states listed in the array of CartStates below
 const ACTIONS_VALID_STATE = {
@@ -57,7 +58,10 @@ const isAction = (action: string): action is keyof typeof ACTIONS_VALID_STATE =>
 
 @Injectable()
 export class CartManager {
-  constructor(@Inject(AccountDbProvider) private db: AccountDatabase) {}
+  constructor(
+    @Inject(AccountDbProvider) private db: AccountDatabase,
+    @Inject(StatsDService) public statsd: StatsD
+  ) {}
 
   /**
    * Ensure that the action being executed has a valid Cart state for
@@ -92,6 +96,7 @@ export class CartManager {
     return cart;
   }
 
+  @CaptureTimingWithStatsD()
   public async createCart(input: SetupCart): Promise<ResultCart> {
     const now = Date.now();
     try {
@@ -123,6 +128,7 @@ export class CartManager {
     }
   }
 
+  @CaptureTimingWithStatsD()
   public async createErrorCart(
     input: SetupCart,
     errorReasonId: CartErrorReasonId
@@ -158,6 +164,7 @@ export class CartManager {
     }
   }
 
+  @CaptureTimingWithStatsD()
   public async fetchCartById(id: string): Promise<ResultCart> {
     try {
       const cart = await fetchCartById(this.db, Buffer.from(id, 'hex'));
@@ -176,6 +183,7 @@ export class CartManager {
     }
   }
 
+  @CaptureTimingWithStatsD()
   public async fetchCartsByUid(uid: string): Promise<ResultCart[]> {
     const carts = await fetchCartsByUid(this.db, Buffer.from(uid, 'hex'));
 
@@ -190,6 +198,7 @@ export class CartManager {
     });
   }
 
+  @CaptureTimingWithStatsD()
   public async updateFreshCart(
     cartId: string,
     version: number,
@@ -214,6 +223,7 @@ export class CartManager {
     }
   }
 
+  @CaptureTimingWithStatsD()
   public async finishCart(cartId: string, version: number, items: FinishCart) {
     const cart = await this.fetchAndValidateCartVersion(cartId, version);
 
@@ -231,6 +241,7 @@ export class CartManager {
     }
   }
 
+  @CaptureTimingWithStatsD()
   public async finishErrorCart(cartId: string, items: FinishErrorCart) {
     const cart = await this.fetchCartById(cartId);
 
@@ -248,6 +259,7 @@ export class CartManager {
     }
   }
 
+  @CaptureTimingWithStatsD()
   public async setNeedsInputCart(cartId: string) {
     const cart = await this.fetchCartById(cartId);
 
@@ -263,6 +275,7 @@ export class CartManager {
     }
   }
 
+  @CaptureTimingWithStatsD()
   public async setProcessingCart(cartId: string) {
     const cart = await this.fetchCartById(cartId);
 
@@ -278,6 +291,7 @@ export class CartManager {
     }
   }
 
+  @CaptureTimingWithStatsD()
   public async deleteCart(cart: ResultCart) {
     this.checkActionForValidCartState(cart, 'deleteCart');
 

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

@@ -146,6 +146,10 @@ export class CartService {
 
       const errorReasonId = resolveErrorInstance(error);
 
+      this.statsd.increment('checkout_failure_unexpected', {
+        errorReasonId,
+      });
+
       try {
         await this.cartManager.finishErrorCart(cartId, {
           errorReasonId,

libs/payments/ui/src/lib/nestapp/nextjs-actions.service.ts

@@ -2,7 +2,7 @@
  * 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 { GoogleManager } from '@fxa/google';
 import {
@@ -75,6 +75,7 @@ import { ValidateLocationActionResult } from './validators/ValidateLocationActio
 import { ValidateLocationActionArgs } from './validators/ValidateLocationActionArgs';
 import { UpdateTaxAddressActionArgs } from './validators/UpdateTaxAddressActionArgs';
 import { UpdateTaxAddressActionResult } from './validators/UpdateTaxAddressActionResult';
+import { CaptureTimingWithStatsD, StatsDService, type StatsD } from '@fxa/shared/metrics/statsd';
 
 /**
  * ANY AND ALL methods exposed via this service should be considered publicly accessible and callable with any arguments.
@@ -93,12 +94,14 @@ export class NextJSActionsService {
     private geodbManager: GeoDBManager,
     private currencyManager: CurrencyManager,
     private eligibilityService: EligibilityService,
-    private productConfigurationManager: ProductConfigurationManager
+    private productConfigurationManager: ProductConfigurationManager,
+    @Inject(StatsDService) public statsd: StatsD
   ) {}
 
   @SanitizeExceptions()
   @NextIOValidator(GetCartActionArgs, GetCartActionResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async getCart(args: { cartId: string }) {
     const cart = await this.cartService.getCart(args.cartId);
 
@@ -110,6 +113,7 @@ export class NextJSActionsService {
   })
   @NextIOValidator(GetCartActionArgs, GetSuccessCartActionResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async getSuccessCart(args: { cartId: string }): Promise<SuccessCartDTO> {
     const cart = await this.cartService.getCart(args.cartId);
 
@@ -129,6 +133,7 @@ export class NextJSActionsService {
   })
   @NextIOValidator(UpdateCartActionArgs, UpdateCartActionResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async updateCart(args: {
     cartId: string;
     version: number;
@@ -151,6 +156,7 @@ export class NextJSActionsService {
   @SanitizeExceptions()
   @NextIOValidator(RestartCartActionArgs, RestartCartActionResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async restartCart(args: { cartId: string }) {
     const cart = await this.cartService.restartCart(args.cartId);
 
@@ -162,6 +168,7 @@ export class NextJSActionsService {
   })
   @NextIOValidator(SetupCartActionArgs, SetupCartActionResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async setupCart(args: {
     interval: SubplatInterval;
     offeringConfigId: string;
@@ -180,6 +187,7 @@ export class NextJSActionsService {
   @SanitizeExceptions()
   @NextIOValidator(FinalizeCartWithErrorArgs, undefined)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async finalizeCartWithError(args: {
     cartId: string;
     errorReasonId: CartErrorReasonId;
@@ -193,13 +201,15 @@ export class NextJSActionsService {
   @SanitizeExceptions()
   @NextIOValidator(FinalizeProcessingCartActionArgs, undefined)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async finalizeProcessingCart(args: { cartId: string }) {
     await this.cartService.finalizeProcessingCart(args.cartId);
   }
 
   @SanitizeExceptions()
   @NextIOValidator(GetPayPalCheckoutTokenArgs, GetPayPalCheckoutTokenResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async getPayPalCheckoutToken(args: { currencyCode: string }) {
     const token = await this.checkoutTokenManager.get(args.currencyCode);
 
@@ -211,6 +221,7 @@ export class NextJSActionsService {
   @SanitizeExceptions()
   @NextIOValidator(GetTaxAddressArgs, GetTaxAddressResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async getTaxAddress(args: { ipAddress: string; uid?: string }) {
     const result = await this.taxService.getTaxAddress(
       args.ipAddress,
@@ -223,6 +234,7 @@ export class NextJSActionsService {
   @SanitizeExceptions()
   @NextIOValidator(CheckoutCartWithPaypalActionArgs, undefined)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async checkoutCartWithPaypal(args: {
     cartId: string;
     version: number;
@@ -240,6 +252,7 @@ export class NextJSActionsService {
   @SanitizeExceptions()
   @NextIOValidator(CheckoutCartWithStripeActionArgs, undefined)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async checkoutCartWithStripe(args: {
     cartId: string;
     version: number;
@@ -257,6 +270,7 @@ export class NextJSActionsService {
   @SanitizeExceptions({ allowlist: [ProductConfigError] })
   @NextIOValidator(FetchCMSDataActionArgs, FetchCMSDataActionResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async fetchCMSData(args: {
     offeringId: string;
     acceptLanguage?: string | null;
@@ -274,6 +288,7 @@ export class NextJSActionsService {
   @SanitizeExceptions()
   @NextIOValidator(RecordEmitterEventArgs, undefined)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async recordEmitterEvent(args: {
     eventName: string;
     requestArgs: CommonMetrics;
@@ -307,6 +322,7 @@ export class NextJSActionsService {
   @SanitizeExceptions()
   @NextIOValidator(GetNeedsInputActionArgs, getNeedsInputActionResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async getNeedsInput(args: { cartId: string }) {
     return await this.cartService.getNeedsInput(args.cartId);
   }
@@ -316,19 +332,22 @@ export class NextJSActionsService {
   })
   @NextIOValidator(SubmitNeedsInputActionArgs, undefined)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async submitNeedsInput(args: { cartId: string }) {
     await this.cartService.submitNeedsInput(args.cartId);
   }
 
   @SanitizeExceptions()
   @NextIOValidator(undefined, GetMetricsFlowActionResult)
+  @CaptureTimingWithStatsD()
   async getMetricsFlow() {
     return this.contentServerManager.getMetricsFlow();
   }
 
   @SanitizeExceptions()
   @NextIOValidator(ValidatePostalCodeActionArgs, ValidatePostalCodeActionResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async validateAndFormatPostalCode(args: {
     postalCode: string;
     countryCode: string;
@@ -342,6 +361,7 @@ export class NextJSActionsService {
   @SanitizeExceptions()
   @NextIOValidator(DetermineCurrencyActionArgs, DetermineCurrencyActionResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async determineCurrency(args: { ip: string }) {
     const location = this.geodbManager.getTaxAddress(args.ip);
 
@@ -361,6 +381,7 @@ export class NextJSActionsService {
   @SanitizeExceptions()
   @NextIOValidator(UpdateTaxAddressActionArgs, UpdateTaxAddressActionResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async updateTaxAddress(args: {
     cartId: string;
     version: number;
@@ -416,6 +437,7 @@ export class NextJSActionsService {
   @SanitizeExceptions()
   @NextIOValidator(ValidateLocationActionArgs, ValidateLocationActionResult)
   @WithTypeCachableAsyncLocalStorage()
+  @CaptureTimingWithStatsD()
   async validateLocation(args: {
     offeringId: string;
     taxAddress?: TaxAddress;

libs/shared/error/src/lib/sanitizeExceptionsDecorator.spec.ts

@@ -5,6 +5,7 @@
 import { Test, TestingModule } from '@nestjs/testing';
 import { SanitizeExceptions } from './sanitizeExceptionsDecorator';
 import { LOGGER_PROVIDER } from '@fxa/shared/log';
+import { MockStatsDProvider } from '@fxa/shared/metrics/statsd';
 
 // Mock Sentry
 jest.mock('@sentry/nextjs', () => ({
@@ -67,6 +68,7 @@ describe('SanitizeExceptions Decorator', () => {
           provide: LOGGER_PROVIDER,
           useValue: mockLogger,
         },
+        MockStatsDProvider
       ],
     }).compile();
 

libs/shared/error/src/lib/sanitizeExceptionsDecorator.ts

@@ -7,6 +7,7 @@ import { Inject } from '@nestjs/common';
 import { ILogger } from '@fxa/shared/log';
 import { LOGGER_PROVIDER } from '@fxa/shared/log';
 import { GENERIC_ERROR_MESSAGE } from './error';
+import { StatsDService, type StatsD } from '@fxa/shared/metrics/statsd';
 
 type Constructor<T> = new (...args: any[]) => T;
 
@@ -20,13 +21,17 @@ export function SanitizeExceptions(
   { allowlist }: { allowlist: Constructor<Error>[] } = { allowlist: [] }
 ) {
   const injectLogger = Inject(LOGGER_PROVIDER);
+  const injectStatsD = Inject(StatsDService);
 
   return function (
     target: any,
     propertyKey: string,
     descriptor: PropertyDescriptor
   ) {
     injectLogger(target, 'logger');
+    if (!target.statsd) {
+      injectStatsD(target, 'statsd');
+    }
 
     const originalMethod = descriptor.value;
     const isAsync = originalMethod.constructor.name === 'AsyncFunction';
@@ -43,6 +48,7 @@ export function SanitizeExceptions(
               methodName: propertyKey,
               allowlist,
               logger: this.logger,
+              statsd: this.statsd,
             });
           }
         }
@@ -56,6 +62,7 @@ export function SanitizeExceptions(
               methodName: propertyKey,
               allowlist,
               logger: this.logger,
+              statsd: this.statsd,
             });
           }
         };
@@ -70,6 +77,7 @@ function handleException(args: {
   methodName: string;
   allowlist: Constructor<Error>[];
   logger: ILogger;
+  statsd: StatsD;
 }): Error {
   const { error, className, methodName, allowlist, logger } = args;
 
@@ -98,5 +106,7 @@ function handleException(args: {
     },
   });
 
+  args.statsd.increment('unexpected_error_sanitized');
+
   return new Error(GENERIC_ERROR_MESSAGE);
 }