feat(payments-next): actions response validation and dto updates

Because: - We want response validation - We want a better way of doing IO validation for actions without the hassle of conversion to class-validator format each time This commit: - Adds a decorator that does the above Closes FXA-10708
mozilla · Feb 27, 2025 · e0bdb5d · e0bdb5d
1 parent 6b52b86
commit e0bdb5d
Show file tree

Hide file tree

Showing 35 changed files with 844 additions and 218 deletions.
diff --git a/apps/payments/next/app/[locale]/[offeringId]/[interval]/new/route.ts b/apps/payments/next/app/[locale]/[offeringId]/[interval]/new/route.ts
@@ -10,6 +10,7 @@ import { CartEligibilityStatus } from '@fxa/shared/db/mysql/account';
 import { BaseParams, buildRedirectUrl } from '@fxa/payments/ui';
 import { getIpAddress } from '@fxa/payments/ui/server';
 import { config } from 'apps/payments/next/config';
+import type { SubplatInterval } from '@fxa/payments/customer';
 
 export const dynamic = 'force-dynamic';
 
@@ -32,7 +33,7 @@ export async function GET(
   let redirectToUrl: URL;
   try {
     const { id: cartId, eligibilityStatus } = await setupCartAction(
-      interval,
+      interval as SubplatInterval,
       offeringId,
       undefined,
       coupon,
@@ -56,7 +57,7 @@ export async function GET(
   } catch (error) {
     if (error.constructor.name === 'CartInvalidPromoCodeError') {
       const { id: cartId, eligibilityStatus } = await setupCartAction(
-        interval,
+        interval as SubplatInterval,
         offeringId,
         undefined,
         undefined,

diff --git a/libs/payments/cart/src/index.ts b/libs/payments/cart/src/index.ts
@@ -6,5 +6,6 @@ export * from './lib/cart.factories';
 export * from './lib/cart.manager';
 export * from './lib/cart.service';
 export * from './lib/cart.utils';
+export { CartInvalidStateForActionError } from './lib/cart.error';
 export * from './lib/checkout.service';
 export * from './lib/checkout.error';
diff --git a/libs/payments/customer/src/lib/util/stripeInvoiceToFirstInvoicePreviewDTO.ts b/libs/payments/customer/src/lib/util/stripeInvoiceToFirstInvoicePreviewDTO.ts
@@ -12,7 +12,7 @@ export function stripeInvoiceToInvoicePreviewDTO(
   invoice: StripeUpcomingInvoice | StripeInvoice
 ): InvoicePreview {
   const taxAmounts = invoice.total_tax_amounts.map((amount) => ({
-    title: amount.tax_rate.display_name,
+    title: amount.tax_rate.display_name || '',
     inclusive: amount.inclusive,
     amount: amount.amount,
   }));

diff --git a/libs/payments/metrics/src/lib/glean/glean.types.ts b/libs/payments/metrics/src/lib/glean/glean.types.ts
@@ -2,6 +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 { ResultCart } from '@fxa/payments/cart';
+import Stripe from 'stripe';
 
 export const CheckoutTypes = ['with-accounts', 'without-accounts'] as const;
 export type CheckoutTypesType = (typeof CheckoutTypes)[number];
@@ -13,7 +14,7 @@ export const PaymentProvidersTypePartial = [
   'external_paypal',
 ] as const;
 export type PaymentProvidersType =
-  | 'card'
+  | Stripe.PaymentMethod.Type
   | 'google_iap'
   | 'apple_iap'
   | 'external_paypal';

diff --git a/libs/payments/ui/src/lib/actions/checkoutCartWithPaypal.ts b/libs/payments/ui/src/lib/actions/checkoutCartWithPaypal.ts
@@ -4,22 +4,18 @@
 
 'use server';
 
-import { plainToClass } from 'class-transformer';
 import { getApp } from '../nestapp/app';
-import { CheckoutCartWithPaypalActionArgs } from '../nestapp/validators/CheckoutCartWithPaypalActionArgs';
 
 export const checkoutCartWithPaypal = async (
   cartId: string,
   version: number,
   customerData: { locale: string; displayName: string },
   token?: string
 ) => {
-  await getApp().getActionsService().checkoutCartWithPaypal(
-    plainToClass(CheckoutCartWithPaypalActionArgs, {
-      cartId,
-      version,
-      customerData,
-      token,
-    })
-  );
+  await getApp().getActionsService().checkoutCartWithPaypal({
+    cartId,
+    version,
+    customerData,
+    token,
+  });
 };
diff --git a/libs/payments/ui/src/lib/actions/checkoutCartWithStripe.ts b/libs/payments/ui/src/lib/actions/checkoutCartWithStripe.ts
@@ -4,25 +4,21 @@
 
 'use server';
 
-import { plainToClass } from 'class-transformer';
 import { getApp } from '../nestapp/app';
-import {
-  CheckoutCartWithStripeActionArgs,
-  CheckoutCartWithStripeActionCustomerData,
-} from '../nestapp/validators/CheckoutCartWithStripeActionArgs';
 
 export const checkoutCartWithStripe = async (
   cartId: string,
   version: number,
   confirmationTokenId: string,
-  customerData: CheckoutCartWithStripeActionCustomerData
+  customerData: {
+    locale: string;
+    displayName: string;
+  }
 ) => {
-  getApp().getActionsService().checkoutCartWithStripe(
-    plainToClass(CheckoutCartWithStripeActionArgs, {
-      cartId,
-      version,
-      customerData,
-      confirmationTokenId,
-    })
-  );
+  getApp().getActionsService().checkoutCartWithStripe({
+    cartId,
+    version,
+    customerData,
+    confirmationTokenId,
+  });
 };
diff --git a/libs/payments/ui/src/lib/actions/determineCurrency.ts b/libs/payments/ui/src/lib/actions/determineCurrency.ts
@@ -4,16 +4,12 @@
 
 'use server';
 
-import { plainToClass } from 'class-transformer';
 import { getApp } from '../nestapp/app';
-import { DetermineCurrencyActionArgs } from '../nestapp/validators/DetermineCurrencyActionArgs';
 
 export const determineCurrencyAction = async (ip: string) => {
-  const currency = await getApp().getActionsService().determineCurrency(
-    plainToClass(DetermineCurrencyActionArgs, {
-      ip,
-    })
-  );
+  const { currency } = await getApp().getActionsService().determineCurrency({
+    ip,
+  });
 
   return currency;
 };
diff --git a/libs/payments/ui/src/lib/actions/fetchCMSData.ts b/libs/payments/ui/src/lib/actions/fetchCMSData.ts
@@ -4,20 +4,16 @@
 
 'use server';
 
-import { plainToClass } from 'class-transformer';
 import { getApp } from '../nestapp/app';
-import { FetchCMSDataArgs } from '../nestapp/validators/FetchCMSDataArgs';
 
 export const fetchCMSData = (
   offeringId: string,
   acceptLanguage?: string | null,
   selectedLanguage?: string
 ) => {
-  return getApp().getActionsService().fetchCMSData(
-    plainToClass(FetchCMSDataArgs, {
-      offeringId,
-      acceptLanguage,
-      selectedLanguage,
-    })
-  );
+  return getApp().getActionsService().fetchCMSData({
+    offeringId,
+    acceptLanguage,
+    selectedLanguage,
+  });
 };
diff --git a/libs/payments/ui/src/lib/actions/finalizeCartWithError.ts b/libs/payments/ui/src/lib/actions/finalizeCartWithError.ts
@@ -4,19 +4,15 @@
 
 'use server';
 
-import { plainToClass } from 'class-transformer';
 import { getApp } from '../nestapp/app';
-import { FinalizeCartWithErrorArgs } from '../nestapp/validators/FinalizeCartWithErrorArgs';
 import { CartErrorReasonId } from '@fxa/shared/db/mysql/account/kysely-types';
 
 export const finalizeCartWithError = async (
   cartId: string,
   errorReasonId: CartErrorReasonId
 ) => {
-  return await getApp().getActionsService().finalizeCartWithError(
-    plainToClass(FinalizeCartWithErrorArgs, {
-      cartId,
-      errorReasonId,
-    })
-  );
+  return await getApp().getActionsService().finalizeCartWithError({
+    cartId,
+    errorReasonId,
+  });
 };
diff --git a/libs/payments/ui/src/lib/actions/finalizeProcessingCart.ts b/libs/payments/ui/src/lib/actions/finalizeProcessingCart.ts
@@ -4,16 +4,12 @@
 
 'use server';
 
-import { plainToClass } from 'class-transformer';
 import { getApp } from '../nestapp/app';
-import { GetCartActionArgs } from '../nestapp/validators/GetCartActionArgs';
 
 export const finalizeProcessingCartAction = async (cartId: string) => {
-  const cart = await getApp().getActionsService().finalizeProcessingCart(
-    plainToClass(GetCartActionArgs, {
-      cartId,
-    })
-  );
+  const cart = await getApp().getActionsService().finalizeProcessingCart({
+    cartId,
+  });
 
   return cart;
 };
diff --git a/libs/payments/ui/src/lib/actions/getCart.ts b/libs/payments/ui/src/lib/actions/getCart.ts
@@ -4,16 +4,12 @@
 
 'use server';
 
-import { plainToClass } from 'class-transformer';
 import { getApp } from '../nestapp/app';
-import { GetCartActionArgs } from '../nestapp/validators/GetCartActionArgs';
 
 export const getCartAction = async (cartId: string) => {
-  const cart = await getApp().getActionsService().getCart(
-    plainToClass(GetCartActionArgs, {
-      cartId,
-    })
-  );
+  const cart = await getApp().getActionsService().getCart({
+    cartId,
+  });
 
   return cart;
 };
diff --git a/libs/payments/ui/src/lib/actions/getCartOrRedirect.ts b/libs/payments/ui/src/lib/actions/getCartOrRedirect.ts
@@ -4,10 +4,8 @@
 
 'use server';
 
-import { plainToClass } from 'class-transformer';
 import { redirect } from 'next/navigation';
 import { getApp } from '../nestapp/app';
-import { GetCartActionArgs } from '../nestapp/validators/GetCartActionArgs';
 import { getRedirect, validateCartState } from '../utils/get-cart';
 import { SupportedPages } from '../utils/types';
 import {
@@ -17,8 +15,8 @@ import {
   FailCartDTO,
   SuccessCartDTO,
   CartDTO,
+  CartInvalidStateForActionError,
 } from '@fxa/payments/cart';
-import { CartInvalidStateForActionError } from 'libs/payments/cart/src/lib/cart.error';
 import { VError } from 'verror';
 
 /**
@@ -63,11 +61,9 @@ async function getCartOrRedirectAction(
   switch (page) {
     case SupportedPages.SUCCESS: {
       try {
-        cart = await getApp().getActionsService().getSuccessCart(
-          plainToClass(GetCartActionArgs, {
-            cartId,
-          })
-        );
+        cart = await getApp().getActionsService().getSuccessCart({
+          cartId,
+        });
       } catch (error) {
         if (error instanceof CartInvalidStateForActionError) {
           redirect(getRedirect(VError.info(error).state) + params);
@@ -81,11 +77,9 @@ async function getCartOrRedirectAction(
     case SupportedPages.PROCESSING:
     case SupportedPages.NEEDS_INPUT:
     case SupportedPages.ERROR: {
-      cart = await getApp().getActionsService().getCart(
-        plainToClass(GetCartActionArgs, {
-          cartId,
-        })
-      );
+      cart = await getApp().getActionsService().getCart({
+        cartId,
+      });
       break;
     }
   }

diff --git a/libs/payments/ui/src/lib/actions/getNeedsInput.ts b/libs/payments/ui/src/lib/actions/getNeedsInput.ts
@@ -5,13 +5,9 @@
 'use server';
 
 import { getApp } from '../nestapp/app';
-import { plainToClass } from 'class-transformer';
-import { GetNeedsInputActionArgs } from '../nestapp/validators/GetNeedsInputActionArgs';
 
 export const getNeedsInputAction = async (cartId: string) => {
-  const inputNeeded = getApp()
-    .getActionsService()
-    .getNeedsInput(plainToClass(GetNeedsInputActionArgs, { cartId }));
+  const inputNeeded = getApp().getActionsService().getNeedsInput({ cartId });
 
   return inputNeeded;
 };
diff --git a/libs/payments/ui/src/lib/actions/getPayPalCheckoutToken.ts b/libs/payments/ui/src/lib/actions/getPayPalCheckoutToken.ts
@@ -4,18 +4,14 @@
 
 'use server';
 
-import { plainToClass } from 'class-transformer';
 import { getApp } from '../nestapp/app';
-import { GetPayPalCheckoutTokenArgs } from '../nestapp/validators/GetPayPalCheckoutTokenArgs';
 
-export const getPayPalCheckoutToken = async (currencyCode?: string | null) => {
+export const getPayPalCheckoutToken = async (currencyCode: string) => {
   const actionsService = getApp().getActionsService();
 
-  const token = await actionsService.getPayPalCheckoutToken(
-    plainToClass(GetPayPalCheckoutTokenArgs, {
-      currencyCode,
-    })
-  );
+  const { token } = await actionsService.getPayPalCheckoutToken({
+    currencyCode,
+  });
 
   return token;
 };
diff --git a/libs/payments/ui/src/lib/actions/recordEmitterEvent.ts b/libs/payments/ui/src/lib/actions/recordEmitterEvent.ts
@@ -4,8 +4,6 @@
 'use server';
 
 import { getApp } from '../nestapp/app';
-import { plainToClass } from 'class-transformer';
-import { RecordEmitterEventArgs } from '../nestapp/validators/RecordEmitterEvent';
 import { getAdditionalRequestArgs } from '../utils/getAdditionalRequestArgs';
 import { PaymentProvidersType } from '@fxa/payments/cart';
 import { PaymentsEmitterEventsKeysType } from '@fxa/payments/events';
@@ -38,17 +36,16 @@ async function recordEmitterEventAction(
 ) {
   const requestArgs = {
     ...getAdditionalRequestArgs(),
-    params,
+    // TODO: This type mismatch appears to be an actual bug -- FXA-11214
+    params: params as Record<string, string>,
     searchParams,
   };
 
-  return getApp().getActionsService().recordEmitterEvent(
-    plainToClass(RecordEmitterEventArgs, {
-      eventName,
-      requestArgs,
-      paymentProvider,
-    })
-  );
+  return getApp().getActionsService().recordEmitterEvent({
+    eventName,
+    requestArgs,
+    paymentProvider,
+  });
 }
 
 export { recordEmitterEventAction };
diff --git a/libs/payments/ui/src/lib/actions/restartCart.ts b/libs/payments/ui/src/lib/actions/restartCart.ts
@@ -4,18 +4,14 @@
 
 'use server';
 
-import { plainToClass } from 'class-transformer';
 import { getApp } from '../nestapp/app';
-import { RestartCartActionArgs } from '../nestapp/validators/RestartCartActionArgs';
 
 export const restartCartAction = async (cartId: string) => {
   const actionsService = getApp().getActionsService();
 
-  const cart = await actionsService.restartCart(
-    plainToClass(RestartCartActionArgs, {
-      cartId,
-    })
-  );
+  const cart = await actionsService.restartCart({
+    cartId,
+  });
 
   return cart;
 };