Merge pull request #20215 from mozilla/PAY-3571

david1alvarez · web-flow · commit e84de124874e · 2026-03-24T15:21:55.000-07:00
feat(payments-next): use LoggerService within TypeCachable decorators
diff --git a/libs/payments/cart/src/lib/tax.service.spec.ts b/libs/payments/cart/src/lib/tax.service.spec.ts
@@ -1,5 +1,6 @@
 import { faker } from '@faker-js/faker';
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 
 import {
   AccountCustomerManager,
@@ -50,6 +51,7 @@ describe('TaxService', () => {
         MockStatsDProvider,
         MockStripeConfigProvider,
         StripeClient,
+        MockLoggerProvider,
         MockAccountDatabaseNestFactory,
         AccountCustomerManager,
         CustomerManager,
@@ -139,7 +141,7 @@ describe('TaxService', () => {
 
       jest
         .spyOn(accountCustomerManager, 'getAccountCustomerByUid')
-        .mockRejectedValue(new AccountCustomerNotFoundError('not found'));
+        .mockRejectedValue(new AccountCustomerNotFoundError('not found', new Error()));
       jest.spyOn(geodbManager, 'getTaxAddress').mockReturnValue(geoAddress);
 
       const result = await taxService.getTaxAddress(ip, uid);
diff --git a/libs/payments/customer/src/lib/customer.manager.spec.ts b/libs/payments/customer/src/lib/customer.manager.spec.ts
@@ -4,6 +4,7 @@
 
 import { faker } from '@faker-js/faker';
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 
 import {
   StripeClient,
@@ -28,6 +29,7 @@ describe('CustomerManager', () => {
         StripeClient,
         CustomerManager,
         MockStatsDProvider,
+        MockLoggerProvider,
       ],
     }).compile();
 
diff --git a/libs/payments/customer/src/lib/customerSession.manager.spec.ts b/libs/payments/customer/src/lib/customerSession.manager.spec.ts
@@ -3,6 +3,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 
 import { CustomerSessionManager } from './customerSession.manager';
 import {
@@ -24,6 +25,7 @@ describe('CustomerSessionManager', () => {
         CustomerSessionManager,
         StripeClient,
         MockStatsDProvider,
+        MockLoggerProvider,
       ],
     }).compile();
 
diff --git a/libs/payments/customer/src/lib/invoice.manager.spec.ts b/libs/payments/customer/src/lib/invoice.manager.spec.ts
@@ -3,6 +3,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 
 import {
   StripeClient,
@@ -63,6 +64,7 @@ describe('InvoiceManager', () => {
         MockStripeConfigProvider,
         InvoiceManager,
         MockStatsDProvider,
+        MockLoggerProvider,
       ],
     }).compile();
 
diff --git a/libs/payments/customer/src/lib/paymentIntent.manager.spec.ts b/libs/payments/customer/src/lib/paymentIntent.manager.spec.ts
@@ -3,6 +3,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 
 import { PaymentIntentManager } from './paymentIntent.manager';
 import {
@@ -24,6 +25,7 @@ describe('PaymentIntentManager', () => {
         PaymentIntentManager,
         StripeClient,
         MockStatsDProvider,
+        MockLoggerProvider,
       ],
     }).compile();
 
diff --git a/libs/payments/customer/src/lib/paymentMethod.manager.spec.ts b/libs/payments/customer/src/lib/paymentMethod.manager.spec.ts
@@ -4,6 +4,7 @@
 
 import { faker } from '@faker-js/faker';
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 import { PaymentMethodManager } from './paymentMethod.manager';
 import {
   MockPaypalClientConfigProvider,
@@ -44,6 +45,7 @@ describe('PaymentMethodManager', () => {
         PaypalCustomerManager,
         StripeClient,
         MockStatsDProvider,
+        MockLoggerProvider,
       ],
     }).compile();
 
diff --git a/libs/payments/customer/src/lib/price.manager.spec.ts b/libs/payments/customer/src/lib/price.manager.spec.ts
@@ -3,6 +3,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 
 import {
   StripeClient,
@@ -29,6 +30,7 @@ describe('PriceManager', () => {
         StripeClient,
         PriceManager,
         MockStatsDProvider,
+        MockLoggerProvider,
       ],
     }).compile();
 
diff --git a/libs/payments/customer/src/lib/product.manager.spec.ts b/libs/payments/customer/src/lib/product.manager.spec.ts
@@ -3,6 +3,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 
 import {
   StripeClient,
@@ -24,6 +25,7 @@ describe('ProductManager', () => {
         StripeClient,
         ProductManager,
         MockStatsDProvider,
+        MockLoggerProvider,
       ],
     }).compile();
 
diff --git a/libs/payments/customer/src/lib/promotionCode.manager.spec.ts b/libs/payments/customer/src/lib/promotionCode.manager.spec.ts
@@ -4,6 +4,7 @@
 
 import { faker } from '@faker-js/faker';
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 import { Stripe } from 'stripe';
 
 import { ProductManager } from './product.manager';
@@ -71,6 +72,7 @@ describe('PromotionCodeManager', () => {
         PromotionCodeManager,
         StripeClient,
         SubscriptionManager,
+        MockLoggerProvider,
       ],
     }).compile();
 
diff --git a/libs/payments/customer/src/lib/setupIntent.manager.spec.ts b/libs/payments/customer/src/lib/setupIntent.manager.spec.ts
@@ -3,6 +3,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 
 import { SetupIntentManager } from './setupIntent.manager';
 import {
@@ -25,6 +26,7 @@ describe('SetupIntentManager', () => {
         SetupIntentManager,
         StripeClient,
         MockStatsDProvider,
+        MockLoggerProvider,
       ],
     }).compile();
 
diff --git a/libs/payments/customer/src/lib/subscription.manager.spec.ts b/libs/payments/customer/src/lib/subscription.manager.spec.ts
@@ -4,6 +4,7 @@
 
 import { faker } from '@faker-js/faker';
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 
 import {
   StripeClient,
@@ -33,6 +34,7 @@ describe('SubscriptionManager', () => {
         StripeClient,
         SubscriptionManager,
         MockStatsDProvider,
+        MockLoggerProvider,
       ],
     }).compile();
 
diff --git a/libs/payments/legacy/src/lib/stripe-mapper.service.ts b/libs/payments/legacy/src/lib/stripe-mapper.service.ts
@@ -1,4 +1,5 @@
-import { Injectable } from '@nestjs/common';
+import { Inject, Injectable, Logger } from '@nestjs/common';
+import type { LoggerService } from '@nestjs/common';
 import { Stripe } from 'stripe';
 import { ProductConfigurationManager } from '@fxa/shared/cms';
 import { PlanMapperUtil } from './plan-mapper.util';
@@ -22,7 +23,8 @@ export class StripeMapperService {
   private successfulIds = new Set();
   constructor(
     private productConfigurationManager: ProductConfigurationManager,
-    private config: StripeMapperConfig
+    private config: StripeMapperConfig,
+    @Inject(Logger) public log: LoggerService
   ) {}
 
   /**
@@ -72,7 +74,7 @@ export class StripeMapperService {
    */
   @Cacheable({
     cacheKey: (args) => cacheKeyForMap(args[0], args[1]),
-    strategy: new CacheFirstStrategy(),
+    strategy: (_: any, context: StripeMapperService) => new CacheFirstStrategy(undefined, undefined, context.log),
     ttlSeconds: (_, context: StripeMapperService) =>
       context.config.ttl || DEFAULT_TTL_SECONDS,
     client: new MemoryAdapter(),
diff --git a/libs/payments/paypal/src/lib/paypalBillingAgreement.manager.spec.ts b/libs/payments/paypal/src/lib/paypalBillingAgreement.manager.spec.ts
@@ -3,6 +3,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 import { faker } from '@faker-js/faker';
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 
 import { MockStripeConfigProvider, StripeClient } from '@fxa/payments/stripe';
 import { MockAccountDatabaseNestFactory } from '@fxa/shared/db/mysql/account';
@@ -37,6 +38,7 @@ describe('PaypalBillingAgreementManager', () => {
         MockPaypalClientConfigProvider,
         StripeClient,
         MockStatsDProvider,
+        MockLoggerProvider,
       ],
     }).compile();
 
diff --git a/libs/payments/stripe/src/lib/stripe.client.spec.ts b/libs/payments/stripe/src/lib/stripe.client.spec.ts
@@ -4,6 +4,7 @@
 
 import { faker } from '@faker-js/faker';
 import { Test } from '@nestjs/testing';
+import { MockLoggerProvider } from '@fxa/shared/log';
 import { Stripe } from 'stripe';
 
 import {
@@ -102,7 +103,12 @@ describe('StripeClient', () => {
 
   beforeEach(async () => {
     const module = await Test.createTestingModule({
-      providers: [MockStripeConfigProvider, StripeClient, MockStatsDProvider],
+      providers: [
+        MockStripeConfigProvider,
+        StripeClient,
+        MockStatsDProvider,
+        MockLoggerProvider,
+      ],
     }).compile();
 
     stripeClient = module.get(StripeClient);
diff --git a/libs/payments/stripe/src/lib/stripe.client.ts b/libs/payments/stripe/src/lib/stripe.client.ts
@@ -2,7 +2,8 @@
  * 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 { Stripe } from 'stripe';
 import { Cacheable } from '@type-cacheable/core';
 
@@ -52,7 +53,8 @@ export class StripeClient {
   private readonly stripe: Stripe;
   constructor(
     private stripeConfig: StripeConfig,
-    @Inject(StatsDService) public statsd: StatsD
+    @Inject(StatsDService) public statsd: StatsD,
+    @Inject(Logger) public log: LoggerService
   ) {
     this.stripe = new Stripe(
       // 'api_key_placeholder' is currently needed during build time
@@ -139,8 +141,8 @@ export class StripeClient {
   @Cacheable({
     cacheKey: (args: any) =>
       cacheKeyForClient('subscriptionsList', undefined, args[0]),
-    strategy: new CacheFirstStrategy(),
-    client: new AsyncLocalStorageAdapter(),
+    strategy: (_: any, context: StripeClient) => new CacheFirstStrategy(undefined, undefined, context.log),
+    client: (_: any, context: StripeClient) => new AsyncLocalStorageAdapter(false, context.log),
   })
   @CaptureTimingWithStatsD()
   async subscriptionsList(params?: Stripe.SubscriptionListParams) {
@@ -194,8 +196,8 @@ export class StripeClient {
   @Cacheable({
     cacheKey: (args: any) =>
       cacheKeyForClient('subscriptionsRetrieve', args[0], args[1]),
-    strategy: new CacheFirstStrategy(),
-    client: new AsyncLocalStorageAdapter(),
+    strategy: (_: any, context: StripeClient) => new CacheFirstStrategy(undefined, undefined, context.log),
+    client: (_: any, context: StripeClient) => new AsyncLocalStorageAdapter(false, context.log),
   })
   @CaptureTimingWithStatsD()
   async subscriptionsRetrieve(
@@ -315,8 +317,8 @@ export class StripeClient {
   @Cacheable({
     cacheKey: (args: any) =>
       cacheKeyForClient('paymentMethodsRetrieve', args[0], args[1]),
-    strategy: new CacheFirstStrategy(),
-    client: new AsyncLocalStorageAdapter(),
+    strategy: (_: any, context: StripeClient) => new CacheFirstStrategy(undefined, undefined, context.log),
+    client: (_: any, context: StripeClient) => new AsyncLocalStorageAdapter(false, context.log),
   })
   @CaptureTimingWithStatsD()
   async paymentMethodRetrieve(
@@ -343,7 +345,7 @@ export class StripeClient {
   @Cacheable({
     cacheKey: (args: any) =>
       cacheKeyForClient('pricesRetrieve', args[0], args[1]),
-    strategy: new CacheFirstStrategy(),
+    strategy: (_: any, context: StripeClient) => new CacheFirstStrategy(undefined, undefined, context.log),
     ttlSeconds: 600,
     client: new MemoryAdapter(),
   })
@@ -359,7 +361,7 @@ export class StripeClient {
   @Cacheable({
     cacheKey: (args: any) =>
       cacheKeyForClient('productsRetrieve', args[0], args[1]),
-    strategy: new CacheFirstStrategy(),
+    strategy: (_: any, context: StripeClient) => new CacheFirstStrategy(undefined, undefined, context.log),
     ttlSeconds: 600,
     client: new MemoryAdapter(),
   })
@@ -375,7 +377,7 @@ export class StripeClient {
   @Cacheable({
     cacheKey: (args: any) =>
       cacheKeyForClient('promotionCodesList', undefined, args[0]),
-    strategy: new CacheFirstStrategy(),
+    strategy: (_: any, context: StripeClient) => new CacheFirstStrategy(undefined, undefined, context.log),
     ttlSeconds: 600,
     client: new MemoryAdapter(),
   })
@@ -391,7 +393,7 @@ export class StripeClient {
   @Cacheable({
     cacheKey: (args: any) =>
       cacheKeyForClient('promotionCodesRetrieve', args[0], args[1]),
-    strategy: new CacheFirstStrategy(),
+    strategy: (_: any, context: StripeClient) => new CacheFirstStrategy(undefined, undefined, context.log),
     ttlSeconds: 600,
     client: new MemoryAdapter(),
   })
diff --git a/libs/payments/ui/src/lib/nestapp/nextjs-actions.service.ts b/libs/payments/ui/src/lib/nestapp/nextjs-actions.service.ts
@@ -163,7 +163,7 @@ export class NextJSActionsService {
     private paypalBillingAgreementManager: PaypalBillingAgreementManager,
     private nimbusManager: NimbusManager,
     @Inject(StatsDService) public statsd: StatsD,
-    @Inject(Logger) private log: LoggerService
+    @Inject(Logger) public log: LoggerService
   ) {}
 
   @SanitizeExceptions()
diff --git a/libs/shared/cms/src/lib/relying-party-configuration.manager.ts b/libs/shared/cms/src/lib/relying-party-configuration.manager.ts
@@ -116,7 +116,8 @@ export class RelyingPartyConfigurationManager {
               locale: args[0],
             });
           }
-        }
+        },
+        context.log
       ),
     ttlSeconds: (args: any) => {
       // Get TTL from config, fallback to 5 minutes if not specified
@@ -147,7 +148,8 @@ export class RelyingPartyConfigurationManager {
             cacheType: result,
             locale: args[0],
           });
-        }
+        },
+        context.log
       );
     },
     ttlSeconds: (args: any) => {
diff --git a/libs/shared/cms/src/lib/strapi.client.ts b/libs/shared/cms/src/lib/strapi.client.ts
@@ -8,7 +8,7 @@ import { Firestore } from '@google-cloud/firestore';
 import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
 import { Inject, Injectable, Logger } from '@nestjs/common';
 import type { LoggerService } from '@nestjs/common';
-import cacheManager, { Cacheable, CacheClear } from '@type-cacheable/core';
+import { Cacheable, CacheClear } from '@type-cacheable/core';
 import EventEmitter from 'events';
 import { GraphQLClient } from 'graphql-request';
 import * as Sentry from '@sentry/node';
@@ -27,12 +27,6 @@ import { cacheKeyForQuery, CMS_QUERY_CACHE_KEY } from './util';
 import { StrapiClientConfig } from './strapi.client.config';
 import { localesQuery, LocalesResult } from './queries/locales';
 
-cacheManager.setOptions({
-  // Must be disabled globally per https://github.com/joshuaslate/type-cacheable?tab=readme-ov-file#change-global-options
-  // otherwise @Cacheable context will be undefined
-  excludeContext: false,
-});
-
 const DEFAULT_FIRESTORE_OFFLINE_CACHE_TTL_SECONDS = 604800; // 604800 seconds is 7 days.
 const DEFAULT_FIRESTORE_CACHE_TTL_SECONDS = 1800; // 1800 seconds is 30 minutes.
 const DEFAULT_MEM_CACHE_TTL_SECONDS = 300; // 300 seconds is 5 minutes.
diff --git a/libs/shared/db/type-cacheable/src/index.ts b/libs/shared/db/type-cacheable/src/index.ts
diff --git a/libs/shared/db/type-cacheable/src/lib/type-cachable-async-local-storage-adapter.ts b/libs/shared/db/type-cacheable/src/lib/type-cachable-async-local-storage-adapter.ts
diff --git a/libs/shared/db/type-cacheable/src/lib/type-cachable-async-local-storage-init.ts b/libs/shared/db/type-cacheable/src/lib/type-cachable-async-local-storage-init.ts
diff --git a/libs/shared/db/type-cacheable/src/lib/type-cachable-cache-first.ts b/libs/shared/db/type-cacheable/src/lib/type-cachable-cache-first.ts
diff --git a/libs/shared/db/type-cacheable/src/lib/type-cachable-stale-while-revalidate-with-fallback.ts b/libs/shared/db/type-cacheable/src/lib/type-cachable-stale-while-revalidate-with-fallback.ts
diff --git a/libs/shared/log/src/index.ts b/libs/shared/log/src/index.ts
diff --git a/libs/shared/log/src/lib/nest/logger.provider.ts b/libs/shared/log/src/lib/nest/logger.provider.ts
diff --git a/packages/fxa-auth-server/lib/payments/initSubplat.ts b/packages/fxa-auth-server/lib/payments/initSubplat.ts
diff --git a/packages/fxa-auth-server/lib/payments/stripe.ts b/packages/fxa-auth-server/lib/payments/stripe.ts
