Merge pull request #18869 from mozilla/FXA-11639

feat(payments-next): Improve payments-next logging

Author: david1alvarez

apps/payments/next/instrumentation.ts

@@ -6,7 +6,10 @@ export async function register() {
   if (process.env.NEXT_RUNTIME === 'nodejs') {
     await import('./sentry.server.config');
     const { getApp } = await import('@fxa/payments/ui/server');
+    const { monkeyPatchServerLogging } = await import('@fxa/shared/log');
 
     await getApp().initialize();
+
+    monkeyPatchServerLogging();
   }
 }

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

@@ -22,24 +22,32 @@ export class CartError extends BaseError {
       cause,
       info,
     });
+    this.name = 'CartError';
+    Object.setPrototypeOf(this, CartError.prototype);
   }
 }
 
 export class CartNotCreatedError extends CartError {
   constructor(data: SetupCart, cause: Error) {
     super('Cart not created', data, cause);
+    this.name = 'CartNotCreatedError';
+    Object.setPrototypeOf(this, CartNotCreatedError.prototype);
   }
 }
 
 export class CartNotFoundError extends CartError {
   constructor(cartId: string, cause: Error) {
     super('Cart not found', { cartId }, cause);
+    this.name = 'CartNotFoundError';
+    Object.setPrototypeOf(this, CartNotFoundError.prototype);
   }
 }
 
 export class CartVersionMismatchError extends CartError {
   constructor(cartId: string) {
     super('Cart version mismatch', { cartId });
+    this.name = 'CartVersionMismatchError';
+    Object.setPrototypeOf(this, CartVersionMismatchError.prototype);
   }
 }
 
@@ -57,30 +65,40 @@ export class CartNotUpdatedError extends CartError {
       },
       cause
     );
+    this.name = 'CartNotUpdatedError';
+    Object.setPrototypeOf(this, CartNotUpdatedError.prototype);
   }
 }
 
 export class CartStateProcessingError extends CartError {
   constructor(cartId: string, cause: Error) {
     super('Cart state not changed to processing', { cartId }, cause);
+    this.name = 'CartStateProcessingError';
+    Object.setPrototypeOf(this, CartStateProcessingError.prototype);
   }
 }
 
 export class CartStateFinishedError extends CartError {
   constructor() {
     super('Cart state is already finished', {});
+    this.name = 'CartStateFinishedError';
+    Object.setPrototypeOf(this, CartStateFinishedError.prototype);
   }
 }
 
 export class CartNotDeletedError extends CartError {
   constructor(cartId: string, cause?: Error) {
     super('Cart not deleted', { cartId }, cause);
+    this.name = 'CartNotDeletedError';
+    Object.setPrototypeOf(this, CartNotDeletedError.prototype);
   }
 }
 
 export class CartNotRestartedError extends CartError {
   constructor(previousCartId: string, cause: Error) {
     super('Cart not created', { previousCartId }, cause);
+    this.name = 'CartNotRestartedError';
+    Object.setPrototypeOf(this, CartNotRestartedError.prototype);
   }
 }
 
@@ -91,12 +109,16 @@ export class CartInvalidStateForActionError extends CartError {
       state,
       action,
     });
+    this.name = 'CartInvalidStateForActionError';
+    Object.setPrototypeOf(this, CartInvalidStateForActionError.prototype);
   }
 }
 
 export class CartTotalMismatchError extends CartError {
   constructor(cartId: string, cartAmount: number, invoiceAmount: number) {
     super('Cart total mismatch', { cartId, cartAmount, invoiceAmount });
+    this.name = 'CartTotalMismatchError';
+    Object.setPrototypeOf(this, CartTotalMismatchError.prototype);
   }
 }
 
@@ -111,6 +133,8 @@ export class CartEligibilityMismatchError extends CartError {
       cartEligibility,
       incomingEligibility,
     });
+    this.name = 'CartEligibilityMismatchError';
+    Object.setPrototypeOf(this, CartEligibilityMismatchError.prototype);
   }
 }
 
@@ -119,6 +143,8 @@ export class CartAccountNotFoundError extends CartError {
     super('Cart account not found for uid', {
       cartId,
     });
+    this.name = 'CartAccountNotFoundError';
+    Object.setPrototypeOf(this, CartAccountNotFoundError.prototype);
   }
 }
 
@@ -127,6 +153,8 @@ export class CartUidNotFoundError extends CartError {
     super('Cart uid not found', {
       cartId,
     });
+    this.name = 'CartUidNotFoundError';
+    Object.setPrototypeOf(this, CartUidNotFoundError.prototype);
   }
 }
 
@@ -141,6 +169,8 @@ export class CartInvalidPromoCodeError extends CartError {
       undefined,
       'CartInvalidPromoCodeError'
     );
+    this.name = 'CartInvalidPromoCodeError';
+    Object.setPrototypeOf(this, CartInvalidPromoCodeError.prototype);
   }
 }
 
@@ -155,6 +185,8 @@ export class CartCurrencyNotFoundError extends CartError {
       currency,
       country,
     });
+    this.name = 'CartCurrencyNotFoundError';
+    Object.setPrototypeOf(this, CartCurrencyNotFoundError.prototype);
   }
 }
 
@@ -163,6 +195,8 @@ export class CartNoTaxAddressError extends CartError {
     super('Cart tax address not found', {
       cartId,
     });
+    this.name = 'CartNoTaxAddressError';
+    Object.setPrototypeOf(this, CartNoTaxAddressError.prototype);
   }
 }
 
@@ -171,5 +205,7 @@ export class CartSubscriptionNotFoundError extends CartError {
     super('Cart subscription not found', {
       cartId,
     });
+    this.name = 'CartSubscriptionNotFoundError';
+    Object.setPrototypeOf(this, CartSubscriptionNotFoundError.prototype);
   }
 }

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

@@ -3,9 +3,9 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 import { NotFoundError } from 'objection';
 import { v4 as uuidv4 } from 'uuid';
-
+import type { LoggerService } from '@nestjs/common';
 import { AccountDbProvider, CartState } from '@fxa/shared/db/mysql/account';
-import { Inject, Injectable } from '@nestjs/common';
+import { Inject, Injectable, Logger } from '@nestjs/common';
 
 import {
   CartInvalidStateForActionError,
@@ -35,7 +35,11 @@ import type {
   CartErrorReasonId,
 } from '@fxa/shared/db/mysql/account';
 import assert from 'assert';
-import { CaptureTimingWithStatsD, StatsDService, type StatsD } from '@fxa/shared/metrics/statsd';
+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 = {
@@ -60,7 +64,8 @@ const isAction = (action: string): action is keyof typeof ACTIONS_VALID_STATE =>
 export class CartManager {
   constructor(
     @Inject(AccountDbProvider) private db: AccountDatabase,
-    @Inject(StatsDService) public statsd: StatsD
+    @Inject(StatsDService) public statsd: StatsD,
+    @Inject(Logger) private log: LoggerService
   ) {}
 
   /**
@@ -123,7 +128,7 @@ export class CartManager {
         currency: cart.currency,
       };
     } catch (error) {
-      console.log(error);
+      this.log.error(error);
       throw new CartNotCreatedError(input, error);
     }
   }
@@ -159,7 +164,7 @@ export class CartManager {
         currency: cart.currency,
       };
     } catch (error) {
-      console.log(error);
+      this.log.error(error);
       throw new CartNotCreatedError(input, error);
     }
   }

libs/payments/cart/src/lib/cart.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 { Inject, Injectable } from '@nestjs/common';
+import { Inject, Injectable, Logger } from '@nestjs/common';
 import type { LoggerService } from '@nestjs/common';
 import * as Sentry from '@sentry/node';
 import assert from 'assert';
@@ -51,7 +51,6 @@ import {
   CartState,
 } from '@fxa/shared/db/mysql/account';
 import { SanitizeExceptions } from '@fxa/shared/error';
-import { LOGGER_PROVIDER } from '@fxa/shared/log';
 import { StatsDService } from '@fxa/shared/metrics/statsd';
 
 import {
@@ -99,7 +98,7 @@ export class CartService {
     private customerSessionManager: CustomerSessionManager,
     private eligibilityService: EligibilityService,
     private invoiceManager: InvoiceManager,
-    @Inject(LOGGER_PROVIDER) private log: LoggerService,
+    @Inject(Logger) private log: LoggerService,
     private paymentMethodManager: PaymentMethodManager,
     private paymentIntentManager: PaymentIntentManager,
     private priceManager: PriceManager,
@@ -220,11 +219,14 @@ export class CartService {
               'checkout_failure_subscription_not_cancelled'
             );
 
-            this.log.log('checkout failed, subscription not canceled', {
-              eligibility_status: cart.eligibilityStatus,
-              offering_id: cart.offeringConfigId,
-              interval: cart.interval,
-            });
+            this.log.log(
+              'cartService.wrapWithCartCatch.subscriptionNotCancelled',
+              {
+                eligibilityStatus: cart.eligibilityStatus,
+                offeringId: cart.offeringConfigId,
+                interval: cart.interval,
+              }
+            );
           }
         }
       } catch (e) {
@@ -358,7 +360,6 @@ export class CartService {
         CartErrorReasonId.IAP_BLOCKED_CONTACT_SUPPORT
       );
     }
-
     return this.cartManager.createCart(createCartParams);
   }
 

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

@@ -7,23 +7,31 @@ import { BaseError } from '@fxa/shared/error';
 export class CheckoutError extends BaseError {
   constructor(...args: ConstructorParameters<typeof BaseError>) {
     super(...args);
+    this.name = 'CheckoutError';
+    Object.setPrototypeOf(this, CheckoutError.prototype);
   }
 }
 
 export class CheckoutPaymentError extends BaseError {
   constructor(...args: ConstructorParameters<typeof BaseError>) {
     super(...args);
+    this.name = 'CheckoutPaymentError';
+    Object.setPrototypeOf(this, CheckoutPaymentError.prototype);
   }
 }
 
 export class CheckoutFailedError extends CheckoutError {
   constructor(...args: ConstructorParameters<typeof BaseError>) {
     super(...args);
+    this.name = 'CheckoutFailedError';
+    Object.setPrototypeOf(this, CheckoutFailedError.prototype);
   }
 }
 
 export class CheckoutUpgradeError extends BaseError {
   constructor(...args: ConstructorParameters<typeof BaseError>) {
     super(...args);
+    this.name = 'CheckoutUpgradeError';
+    Object.setPrototypeOf(this, CheckoutUpgradeError.prototype);
   }
 }

libs/payments/currency/src/lib/currency.error.ts

@@ -7,6 +7,8 @@ import { BaseError } from '@fxa/shared/error';
 export class CurrencyError extends BaseError {
   constructor(...args: ConstructorParameters<typeof BaseError>) {
     super(...args);
+    this.name = 'CurrencyError';
+    Object.setPrototypeOf(this, CurrencyError.prototype);
   }
 }
 
@@ -18,6 +20,8 @@ export class CurrencyCodeInvalidError extends CurrencyError {
       },
       cause,
     });
+    this.name = 'CurrencyCodeInvalidError';
+    Object.setPrototypeOf(this, CurrencyCodeInvalidError.prototype);
   }
 }
 
@@ -29,6 +33,8 @@ export class CountryCodeInvalidError extends CurrencyError {
       },
       cause,
     });
+    this.name = 'CountryCodeInvalidError';
+    Object.setPrototypeOf(this, CountryCodeInvalidError.prototype);
   }
 }
 
@@ -41,5 +47,7 @@ export class CurrencyCountryMismatchError extends CurrencyError {
       },
       cause,
     });
+    this.name = 'CurrencyCountryMismatchError';
+    Object.setPrototypeOf(this, CurrencyCountryMismatchError.prototype);
   }
 }