Remove firestore collection in favor of using memory and firestore cache

Author: StaberindeZA

apps/payments/api/.env

@@ -106,5 +106,8 @@ METERING_CONFIG__CLOUD_TASKS__THRESHOLD__BUCKET_SIZE_MS=300000
 METERING_CONFIG__CLOUD_TASKS__THRESHOLD__SCHEDULE_DELAY_MS=420000
 
 # Free Access Program Client Config 
-# NB: This needs to match config in payments-next
-FREE_ACCESS_PROGRAM_CLIENT_CONFIG__COLLECTION_NAME=subplat-free-access-program
+# NB: Ideally this matches the config in payments-next
+FREE_ACCESS_PROGRAM_CLIENT_CONFIG__FIRESTORE_CACHE_COLLECTION_NAME=subplat-free-access-program-cache
+FREE_ACCESS_PROGRAM_CLIENT_CONFIG__MEM_CACHE_T_T_L=300 # 5 minutes
+FREE_ACCESS_PROGRAM_CLIENT_CONFIG__FIRESTORE_CACHE_TTL=1800 # 30 minutes
+FREE_ACCESS_PROGRAM_CLIENT_CONFIG__FIRESTORE_OFFLINE_CACHE_TTL=604800 # 7 days

apps/payments/api/src/app/app.module.ts

@@ -49,14 +49,7 @@ import {
   PaypalCustomerManager,
 } from '@fxa/payments/paypal';
 import { CurrencyManager } from '@fxa/payments/currency';
-import {
-  AuthServerEmailCapabilityClient,
-  FreeAccessProgramManager,
-  FreeAccessProgramNotifierService,
-  FreeAccessProgramReconcilerService,
-  FreeAccessProgramWebhookController,
-  FreeAccessProgramWebhookService,
-} from '@fxa/free-access-program';
+import { FreeAccessProgramManager } from '@fxa/free-access-program';
 import { AccountDatabaseNestFactory } from '@fxa/shared/db/mysql/account';
 import { AccountManager } from '@fxa/shared/account/account';
 import { CartManager } from '@fxa/payments/cart';
@@ -92,7 +85,6 @@ import { PaymentsMetricsAggregatorService } from '@fxa/payments/metrics-aggregat
     AppController,
     BillingAndSubscriptionsController,
     CmsWebhooksController,
-    FreeAccessProgramWebhookController,
     FxaWebhooksController,
     StripeWebhooksController,
   ],
@@ -115,12 +107,8 @@ import { PaymentsMetricsAggregatorService } from '@fxa/payments/metrics-aggregat
     PaymentsEmitterService,
     PriceManager,
     ProductManager,
-    AuthServerEmailCapabilityClient,
     FirestoreProvider,
     FreeAccessProgramManager,
-    FreeAccessProgramNotifierService,
-    FreeAccessProgramReconcilerService,
-    FreeAccessProgramWebhookService,
     GoogleIapClient,
     GoogleIapPurchaseManager,
     StatsDProvider,

apps/payments/api/src/config/index.ts

@@ -3,10 +3,7 @@ import { IsDefined, ValidateNested } from 'class-validator';
 
 import { CurrencyConfig } from '@fxa/payments/currency';
 import { MeteringConfig } from '@fxa/entitlements/metering';
-import {
-  AuthServerEmailCapabilityConfig,
-  FreeAccessProgramClientConfig,
-} from '@fxa/free-access-program';
+import { FreeAccessProgramClientConfig } from '@fxa/free-access-program';
 import { AppleIapClientConfig, GoogleIapClientConfig } from '@fxa/payments/iap';
 import { PaymentsGleanConfig } from '@fxa/payments/metrics';
 import { PaypalClientConfig } from '@fxa/payments/paypal';
@@ -93,9 +90,4 @@ export class RootConfig {
   @ValidateNested()
   @IsDefined()
   public readonly freeAccessProgramClientConfig!: Partial<FreeAccessProgramClientConfig>;
-
-  @Type(() => AuthServerEmailCapabilityConfig)
-  @ValidateNested()
-  @IsDefined()
-  public readonly authServerEmailCapabilityConfig!: Partial<AuthServerEmailCapabilityConfig>;
 }

apps/payments/next/.env

@@ -100,8 +100,11 @@ CHURN_INTERVENTION_CONFIG__ENABLED=
 FREE_TRIAL_CONFIG__FIRESTORE_COLLECTION_NAME=freeTrials
 
 # Free Access Program Client Config 
-# NB: This needs to match config in payments-api
-FREE_ACCESS_PROGRAM_CLIENT_CONFIG__COLLECTION_NAME=subplat-free-access-program
+# NB: Ideally this matches the config in payments-api
+FREE_ACCESS_PROGRAM_CLIENT_CONFIG__FIRESTORE_CACHE_COLLECTION_NAME=subplat-free-access-program-cache
+FREE_ACCESS_PROGRAM_CLIENT_CONFIG__MEM_CACHE_T_T_L=300 # 5 minutes
+FREE_ACCESS_PROGRAM_CLIENT_CONFIG__FIRESTORE_CACHE_TTL=1800 # 30 minutes
+FREE_ACCESS_PROGRAM_CLIENT_CONFIG__FIRESTORE_OFFLINE_CACHE_TTL=604800 # 7 days
 
 # StatsD Config
 STATS_D_CONFIG__SAMPLE_RATE=

libs/free-access-program/project.json

@@ -44,12 +44,6 @@
       "options": {
         "jestConfig": "libs/free-access-program/jest.config.ts"
       }
-    },
-    "reconcile-all": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "TS_NODE_PROJECT=tsconfig.base.json node -r ts-node/register/transpile-only -r tsconfig-paths/register libs/free-access-program/src/scripts/reconcile-all.ts"
-      }
     }
   }
 }

libs/free-access-program/src/index.ts

@@ -2,19 +2,10 @@
  * 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/. */
 
-export * from './lib/auth-server-email-capability.client';
-export * from './lib/auth-server-email-capability.config';
 export * from './lib/factories';
-// FreeAccessProgramReconcilerModule is consumed only by the standalone
-// reconcile-all script; intentionally not re-exported here so consumers of
-// the public lib don't pull in `nest-typed-config` (which ships as raw TS).
 export * from './lib/free-access-program.client.config';
 export * from './lib/free-access-program.manager';
-export * from './lib/free-access-program.notifier.service';
 export * from './lib/free-access-program.projector';
 export * from './lib/free-access-program.reconciler.service';
-export * from './lib/free-access-program.repository';
-export * from './lib/free-access-program.webhook.controller';
-export * from './lib/free-access-program.webhook.service';
 export * from './lib/free-access-program.webhook.types';
 export * from './lib/types';

libs/free-access-program/src/lib/auth-server-email-capability.client.ts

@@ -3,22 +3,21 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { faker } from '@faker-js/faker';
-import { Timestamp } from '@google-cloud/firestore';
-import type { FirestoreFreeAccessProgramRecord } from './types';
+import type { FreeAccessRecord } from './types';
 
-export const FirestoreFreeAccessProgramRecordFactory = (
-  override?: Partial<FirestoreFreeAccessProgramRecord>
-): FirestoreFreeAccessProgramRecord => ({
+export const FreeAccessRecordFactory = (
+  override?: Partial<FreeAccessRecord>
+): FreeAccessRecord => ({
   entitlementId: faker.string.uuid(),
   email: faker.internet.email().toLowerCase(),
   capabilities: {
     [faker.string.alphanumeric({ length: 16 })]: [
       `cap-${faker.string.alphanumeric({ length: 8 })}`,
     ],
   },
-  expiresAt: Timestamp.fromDate(faker.date.future()),
+  expiresAt: faker.date.future().getTime(),
   description: faker.lorem.sentence(),
   internalName: faker.company.name(),
-  createdAt: Timestamp.fromDate(faker.date.recent()),
+  createdAt: faker.date.recent().getTime(),
   ...override,
 });