feat(auth): update subscription reminders script for cron

Because:

- The subscription reminders script needs to support daily
  subscription prices.

This commit:

- Optionally adds support for daily subscription prices, so
  that it can be toggled on and off where required.
- Updates script to allow unsupported params. This was done
  to allow updates to the CRON jobs with new parameters,
  before those parameters have shipped.

Closes #PAY-2294

Author: StaberindeZA

libs/payments/stripe/src/lib/factories/subscription.factory.ts

@@ -7,6 +7,7 @@ import { StripePriceFactory } from './price.factory';
 import {
   StripeSubscription,
   StripeSubscriptionItem,
+  type StripeApiListPromise,
 } from '../stripe.client.types';
 
 export const StripeSubscriptionFactory = (

libs/payments/stripe/src/lib/stripe.client.spec.ts

@@ -17,11 +17,18 @@ import { StripePaymentMethodFactory } from './factories/payment-method.factory';
 import { StripePriceFactory } from './factories/price.factory';
 import { StripeProductFactory } from './factories/product.factory';
 import { StripePromotionCodeFactory } from './factories/promotion-code.factory';
-import { StripeSubscriptionFactory } from './factories/subscription.factory';
+import {
+  StripeSubscriptionAsyncGeneratorFactory,
+  StripeSubscriptionFactory,
+} from './factories/subscription.factory';
 import { StripeUpcomingInvoiceFactory } from './factories/upcoming-invoice.factory';
 import { StripeClient } from './stripe.client';
 import { MockStripeConfigProvider } from './stripe.config';
 import { MockStatsDProvider } from '@fxa/shared/metrics/statsd';
+import type {
+  StripeApiListPromise,
+  StripeSubscription,
+} from './stripe.client.types';
 
 const mockJestFnGenerator = <T extends (...args: any[]) => any>() => {
   return jest.fn<ReturnType<T>, Parameters<T>>();

packages/fxa-auth-server/lib/payments/initSubplat.ts

@@ -216,6 +216,7 @@ export async function initSubplat({
     paypalCustomerManager,
     logger
   );
+
   /**
    * Add initialized instances to Container
    */

packages/fxa-auth-server/lib/payments/subscription-reminders.ts

@@ -34,6 +34,7 @@ const planIntervalsToDuration = {
 interface EndingRemindersOptions {
   enabled: boolean;
   paymentsNextUrl: string;
+  dailyReminderDays?: number;
   monthlyReminderDays: number;
   yearlyReminderDays: number;
 }
@@ -45,6 +46,7 @@ export class SubscriptionReminders {
   private planDuration: Duration;
   private reminderDuration: Duration;
   private endingReminderEnabled: boolean;
+  private dailyEndingReminderDuration: Duration | undefined;
   private monthlyEndingReminderDuration: Duration;
   private yearlyEndingReminderDuration: Duration;
   private paymentsNextUrl: string;
@@ -74,6 +76,11 @@ export class SubscriptionReminders {
     this.planDuration = Duration.fromObject({ days: planLength });
     this.reminderDuration = Duration.fromObject({ days: reminderLength });
     this.endingReminderEnabled = endingReminderOptions.enabled;
+    if (endingReminderOptions.dailyReminderDays) {
+      this.dailyEndingReminderDuration = Duration.fromObject({
+        days: endingReminderOptions.dailyReminderDays,
+      });
+    }
     this.monthlyEndingReminderDuration = Duration.fromObject({
       days: endingReminderOptions.monthlyReminderDays,
     });
@@ -414,6 +421,13 @@ export class SubscriptionReminders {
 
     // 4
     if (this.endingReminderEnabled) {
+      // Daily
+      if (this.dailyEndingReminderDuration) {
+        await this.sendEndingReminders(
+          this.dailyEndingReminderDuration,
+          SubplatInterval.Daily
+        );
+      }
       // Monthly
       await this.sendEndingReminders(
         this.monthlyEndingReminderDuration,

packages/fxa-auth-server/scripts/subscription-reminders.ts

@@ -20,6 +20,7 @@ import { parseBooleanArg } from './lib/args';
 
 const DEFAULT_PLAN_LENGTH = 180;
 const DEFAULT_REMINDER_LENGTH = 14;
+const DEFAULT_ENDING_REMINDER_DAILY_LENGTH = 0;
 const DEFAULT_ENDING_REMINDER_MONTHLY_LENGTH = 7;
 const DEFAULT_ENDING_REMINDER_YEARLY_LENGTH = 14;
 
@@ -28,6 +29,7 @@ Sentry.init({});
 async function init() {
   program
     .version(pckg.version)
+    .allowUnknownOption(true)
     .option(
       '-p, --plan-length [days]',
       'Plan length in days beyond which a reminder email before the next recurring charge should be sent. Defaults to 180.',
@@ -43,6 +45,11 @@ async function init() {
       'Enable the sending of subscription ending reminder emails. Defaults to false.',
       false
     )
+    .option(
+      '-d, --ending-reminder-daily-length [days]',
+      'Reminder length in days before the daily subscription ending date to send the reminder email. Defaults to 0.',
+      DEFAULT_ENDING_REMINDER_DAILY_LENGTH.toString()
+    )
     .option(
       '-m, --ending-reminder-monthly-length [days]',
       'Reminder length in days before the montly subscription ending date to send the reminder email. Defaults to 7.',
@@ -78,6 +85,7 @@ async function init() {
     {
       enabled: parseBooleanArg(program.enableEndingReminders),
       paymentsNextUrl: config.smtp.subscriptionSettingsUrl,
+      dailyReminderDays: parseInt(program.endingReminderDailyLength),
       monthlyReminderDays: parseInt(program.endingReminderMonthlyLength),
       yearlyReminderDays: parseInt(program.endingReminderYearlyLength),
     },

packages/fxa-auth-server/test/local/payments/subscription-reminders.js

@@ -16,6 +16,7 @@ const { SentEmail } = require('fxa-shared/db/models/auth/sent-email');
 const {
   EMAIL_TYPE,
   SubscriptionReminders,
+  SubscriptionRemindersPlanRecurringError,
 } = require('../../../lib/payments/subscription-reminders');
 const invoicePreview = require('./fixtures/stripe/invoice_preview_tax.json');
 const longPlan1 = require('./fixtures/stripe/plan1.json');
@@ -60,6 +61,7 @@ describe('SubscriptionReminders', () => {
   let mockConfig;
   let realDateNow;
 
+  const mockDailyReminderDuration = undefined;
   const mockMonthlyReminderDuration = 7;
   const mockYearlyReminderDuration = 14;
 
@@ -97,6 +99,7 @@ describe('SubscriptionReminders', () => {
       {
         enabled: false,
         paymentsNextUrl: 'http://localhost:3035',
+        dailyReminderDays: mockDailyReminderDuration,
         monthlyReminderDays: mockMonthlyReminderDuration,
         yearlyReminderDays: mockYearlyReminderDuration,
       },
@@ -727,6 +730,32 @@ describe('SubscriptionReminders', () => {
         'yearly'
       );
     });
+
+    it('calls sendEndingReminders for daily if dailyEndingReminderDuration is provided', async () => {
+      const mockDailyReminderDays = 3;
+      reminder.sendEndingReminders = sandbox.fake.resolves({});
+      reminder.endingReminderEnabled = true;
+      reminder.dailyEndingReminderDuration = Duration.fromObject({
+        days: mockDailyReminderDays,
+      });
+      await reminder.sendReminders();
+
+      sinon.assert.calledWith(
+        reminder.sendEndingReminders,
+        Duration.fromObject({ days: mockDailyReminderDays }),
+        'daily'
+      );
+      sinon.assert.calledWith(
+        reminder.sendEndingReminders,
+        Duration.fromObject({ days: mockMonthlyReminderDuration }),
+        'monthly'
+      );
+      sinon.assert.calledWith(
+        reminder.sendEndingReminders,
+        Duration.fromObject({ days: mockYearlyReminderDuration }),
+        'yearly'
+      );
+    });
   });
 
   describe('sendEndingReminders', () => {