feat(next): add initial support for stripe webhooks

Because:

- Need to record a glean event when a customers subscription is
  cancelled

This commit:

- Adds payments-webhooks library for webhook related logic
- Adds StripeWebhookService to payments-webhooks
- Adds new route handler to payments-next to accept incoming Stripe
  events
- Moves PaymentsEmitter into new payments-events library

Closes #FXA-10089

Author: StaberindeZA

.gitignore

@@ -161,7 +161,7 @@ apps/payments/next/public/locales
 !apps/payments/next/.env
 
 # payments-metrics
-libs/payments/metrics/src/lib/glean/__generated__/server_events.ts
+libs/payments/metrics/src/lib/glean/__generated__/
 
 Library
 .node
@@ -183,4 +183,4 @@ libs/shared/cms/src/__generated__/graphql.d.ts
 libs/shared/cms/src/__generated__/graphql.js
 
 # Sentry Config File
-.env.sentry-build-plugin
+.env.sentry-build-plugin

apps/payments/next/.env

@@ -37,6 +37,7 @@ GEODB_MANAGER_CONFIG__LOCATION_OVERRIDE__POSTAL_CODE=11211
 
 # Stripe Config
 STRIPE_CONFIG__API_KEY=11233
+STRIPE_CONFIG__WEBHOOK_SECRET=11233
 STRIPE_CONFIG__TAX_IDS={}
 STRIPE_PUBLIC_API_KEY=pk_test_VNpCidC0a2TJJB3wqXq7drhN00sF8r9mhs
 

apps/payments/next/app/api/webhooks/stripe/route.ts

@@ -0,0 +1,22 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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 { getApp } from '@fxa/payments/ui/server';
+
+export const dynamic = 'force-dynamic';
+
+export async function POST(request: Request) {
+  const signature = request.headers.get('stripe-signature');
+  if (!signature || typeof signature !== 'string') {
+    return new Response('Bad Request', { status: 400 });
+  }
+
+  const payload = await request.text();
+
+  const stripeWebhookService = getApp().getStripeWebhookService();
+
+  await stripeWebhookService.handleWebhookEvent(payload, signature);
+
+  return new Response('Received', { status: 200 });
+}

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

@@ -19,6 +19,7 @@ import {
   CouponErrorLimitReached,
   CustomerSessionManager,
   PaymentIntentManager,
+  determinePaymentMethodType,
 } from '@fxa/payments/customer';
 import { EligibilityService } from '@fxa/payments/eligibility';
 import {
@@ -574,9 +575,13 @@ export class CartService {
     }
 
     let paymentInfo: PaymentInfo | undefined;
-    if (customer?.invoice_settings.default_payment_method) {
+    const paymentMethodType = determinePaymentMethodType(
+      customer,
+      subscriptions
+    );
+    if (paymentMethodType?.type === 'stripe') {
       const paymentMethodPromise = this.paymentMethodManager.retrieve(
-        customer.invoice_settings.default_payment_method
+        paymentMethodType.paymentMethodId
       );
       const customerSessionPromise = cart.stripeCustomerId
         ? this.customerSessionManager.create(cart.stripeCustomerId)
@@ -591,6 +596,10 @@ export class CartService {
         brand: paymentMethod.card?.brand,
         customerSessionClientSecret: customerSession?.client_secret,
       };
+    } else if (paymentMethodType?.type === 'external_paypal') {
+      paymentInfo = {
+        type: 'external_paypal',
+      };
     } else if (subscriptions.length) {
       const firstListedSubscription = subscriptions[0];
       // fetch payment method info

libs/payments/customer/src/index.ts

@@ -16,3 +16,5 @@ export * from './lib/types';
 export * from './lib/factories/tax-address.factory';
 export * from './lib/error';
 export * from './lib/util/stripeInvoiceToFirstInvoicePreviewDTO';
+export * from './lib/util/getSubplatInterval';
+export * from './lib/util/determinePaymentMethodType';

libs/payments/customer/src/lib/constants.ts

@@ -0,0 +1,28 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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 { Interval, SubplatInterval } from './types';
+
+export const subplatIntervalToInterval = {
+  [SubplatInterval.Daily]: {
+    interval: 'day',
+    intervalCount: 1,
+  },
+  [SubplatInterval.Weekly]: {
+    interval: 'week',
+    intervalCount: 1,
+  },
+  [SubplatInterval.Monthly]: {
+    interval: 'month',
+    intervalCount: 1,
+  },
+  [SubplatInterval.HalfYearly]: {
+    interval: 'month',
+    intervalCount: 6,
+  },
+  [SubplatInterval.Yearly]: {
+    interval: 'year',
+    intervalCount: 1,
+  },
+} satisfies Record<SubplatInterval, Interval>;

libs/payments/customer/src/lib/types.ts

@@ -2,6 +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 { StripePrice } from '@fxa/payments/stripe';
+
 export type InvoicePreview = {
   currency: string;
   listAmount: number;
@@ -16,6 +18,11 @@ export type InvoicePreview = {
   oneTimeCharge?: number;
 };
 
+export interface Interval {
+  interval: NonNullable<StripePrice['recurring']>['interval'];
+  intervalCount: number;
+}
+
 export interface TaxAmount {
   title: string;
   inclusive: boolean;

libs/payments/customer/src/lib/util/determinePaymentMethod.spec.ts

@@ -0,0 +1,32 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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 {
+  StripeCustomerFactory,
+  StripeSubscriptionFactory,
+} from '@fxa/payments/stripe';
+import { determinePaymentMethodType } from './determinePaymentMethodType';
+
+describe('determinePaymentMethodType', () => {
+  it('returns stripe', () => {
+    const mockCustomer = StripeCustomerFactory();
+    expect(determinePaymentMethodType(mockCustomer)).toEqual({
+      type: 'stripe',
+      paymentMethodId: expect.any(String),
+    });
+  });
+
+  it('returns external_paypal', () => {
+    const mockSubscription = StripeSubscriptionFactory({
+      collection_method: 'send_invoice',
+    });
+    expect(determinePaymentMethodType(undefined, [mockSubscription])).toEqual({
+      type: 'external_paypal',
+    });
+  });
+
+  it('returns null', () => {
+    expect(determinePaymentMethodType(undefined, undefined));
+  });
+});

libs/payments/customer/src/lib/util/determinePaymentMethodType.ts

@@ -0,0 +1,41 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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 { StripeCustomer, StripeSubscription } from '@fxa/payments/stripe';
+
+interface StripePaymentMethod {
+  type: 'stripe';
+  paymentMethodId: string;
+}
+
+interface PayPalPaymentMethod {
+  type: 'external_paypal';
+}
+
+type PaymentMethodTypeResponse =
+  | StripePaymentMethod
+  | PayPalPaymentMethod
+  | null;
+
+export const determinePaymentMethodType = (
+  customer?: StripeCustomer,
+  subscriptions?: StripeSubscription[]
+): PaymentMethodTypeResponse => {
+  if (customer?.invoice_settings.default_payment_method) {
+    return {
+      type: 'stripe',
+      paymentMethodId: customer.invoice_settings.default_payment_method,
+    };
+  } else if (subscriptions?.length) {
+    const firstListedSubscription = subscriptions[0];
+    // fetch payment method info
+    if (firstListedSubscription.collection_method === 'send_invoice') {
+      return {
+        type: 'external_paypal',
+      };
+    }
+  }
+
+  return null;
+};

libs/payments/customer/src/lib/util/doesPriceMatchSubplatInterval.ts

@@ -4,34 +4,7 @@
 
 import { StripePrice } from '@fxa/payments/stripe';
 import { SubplatInterval } from '../types';
-
-interface Interval {
-  interval: NonNullable<StripePrice['recurring']>['interval'];
-  intervalCount: number;
-}
-
-const subplatIntervalToInterval = {
-  [SubplatInterval.Daily]: {
-    interval: 'day',
-    intervalCount: 1,
-  },
-  [SubplatInterval.Weekly]: {
-    interval: 'week',
-    intervalCount: 1,
-  },
-  [SubplatInterval.Monthly]: {
-    interval: 'month',
-    intervalCount: 1,
-  },
-  [SubplatInterval.HalfYearly]: {
-    interval: 'month',
-    intervalCount: 6,
-  },
-  [SubplatInterval.Yearly]: {
-    interval: 'year',
-    intervalCount: 1,
-  },
-} satisfies Record<SubplatInterval, Interval>;
+import { subplatIntervalToInterval } from '../constants';
 
 export const doesPriceMatchSubplatInterval = (
   price: StripePrice,