Merge pull request #20408 from mozilla/PAY-3657

fix(payments-cart): validate isFreeTrial on cart

Author: julianpoy

apps/payments/next/app/[locale]/en.ftl

@@ -27,6 +27,7 @@ checkout-error-contact-support = Please contact support so we can help you.
 cart-error-currency-not-determined = We were unable to determine the currency for this purchase, please try again.
 checkout-processing-general-error = An unexpected error has occurred while processing your payment, please try again.
 cart-total-mismatch-error = The invoice amount has changed. Please try again.
+cart-free-trial-mismatch-error = Your free trial eligibility has changed. Please try again.
 
 ## Error pages - Payment method failure messages
 intent-card-error = Your transaction could not be processed. Please verify your credit card information and try again.

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

@@ -229,6 +229,21 @@ export class CartEligibilityMismatchError extends CartError {
   }
 }
 
+export class CartFreeTrialMismatchError extends CartError {
+  constructor(
+    cartId: string,
+    cartIsFreeTrial: boolean,
+    incomingIsFreeTrial: boolean
+  ) {
+    super('Cart free trial eligibility mismatch', {
+      cartId,
+      cartIsFreeTrial,
+      incomingIsFreeTrial,
+    });
+    this.name = 'CartFreeTrialMismatchError';
+  }
+}
+
 export class CartAccountNotFoundError extends CartError {
   constructor(cartId: string) {
     super('Cart account not found for uid', {

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

@@ -81,6 +81,7 @@ export const SetupCartFactory = (override?: Partial<SetupCart>): SetupCart => ({
     postalCode: faker.location.zipCode(),
   },
   currency: faker.finance.currencyCode().toLowerCase(),
+  isFreeTrial: false,
   ...override,
 });
 
@@ -150,6 +151,7 @@ export const ResultCartFactory = (
   amount: faker.number.int(),
   version: faker.number.int(),
   eligibilityStatus: faker.helpers.enumValue(CartEligibilityStatus),
+  isFreeTrial: false,
   ...override,
 });
 

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

@@ -671,6 +671,9 @@ describe('CartService', () => {
       jest.spyOn(eligibilityService, 'checkEligibility').mockResolvedValue({
         subscriptionEligibilityResult: EligibilityStatus.CREATE,
       });
+      jest
+        .spyOn(checkoutService, 'getFreeTrialEligibility')
+        .mockResolvedValue(null);
     });
 
     it('calls createCart with expected parameters', async () => {
@@ -699,6 +702,7 @@ describe('CartService', () => {
         currency: mockResolvedCurrency,
         eligibilityStatus: CartEligibilityStatus.CREATE,
         couponCode: args.promoCode,
+        isFreeTrial: false,
       });
       expect(result).toEqual(mockResultCart);
     });
@@ -773,6 +777,7 @@ describe('CartService', () => {
         taxAddress,
         currency: mockResolvedCurrency,
         eligibilityStatus: CartEligibilityStatus.UPGRADE,
+        isFreeTrial: false,
       });
       expect(result).toEqual(mockResultCart);
       expect(result.couponCode).toBeNull();
@@ -835,6 +840,7 @@ describe('CartService', () => {
           currency: mockResolvedCurrency,
           eligibilityStatus: CartEligibilityStatus.BLOCKED_IAP,
           couponCode: args.promoCode,
+          isFreeTrial: false,
         },
         CartErrorReasonId.IAP_BLOCKED_CONTACT_SUPPORT
       );
@@ -877,6 +883,7 @@ describe('CartService', () => {
           currency: mockResolvedCurrency,
           eligibilityStatus: CartEligibilityStatus.DOWNGRADE,
           couponCode: args.promoCode,
+          isFreeTrial: false,
         },
         CartErrorReasonId.CART_ELIGIBILITY_STATUS_DOWNGRADE
       );
@@ -917,6 +924,7 @@ describe('CartService', () => {
           currency: mockResolvedCurrency,
           eligibilityStatus: CartEligibilityStatus.INVALID,
           couponCode: args.promoCode,
+          isFreeTrial: false,
         },
         CartErrorReasonId.CART_ELIGIBILITY_STATUS_INVALID
       );
@@ -957,6 +965,7 @@ describe('CartService', () => {
           currency: mockResolvedCurrency,
           eligibilityStatus: CartEligibilityStatus.INVALID,
           couponCode: args.promoCode,
+          isFreeTrial: false,
         },
         CartErrorReasonId.CART_ELIGIBILITY_STATUS_SAME
       );
@@ -1053,6 +1062,7 @@ describe('CartService', () => {
         stripeCustomerId: mockAccountCustomer.stripeCustomerId,
         amount: mockOldCart.amount,
         eligibilityStatus: mockOldCart.eligibilityStatus,
+        isFreeTrial: mockOldCart.isFreeTrial,
       });
       expect(result).toEqual(mockNewCart);
     });
@@ -1348,6 +1358,7 @@ describe('CartService', () => {
       const mockCart = ResultCartFactory({
         stripeSubscriptionId: undefined,
         currency: mockCurrency,
+        eligibilityStatus: CartEligibilityStatus.INVALID,
       });
       const mockUpdateCartInput = UpdateCartInputFactory({
         taxAddress: {
@@ -1360,6 +1371,7 @@ describe('CartService', () => {
       const expectedUpdateCart = {
         ...mockUpdateCartInput,
         currency: mockCurrency,
+        isFreeTrial: false,
       };
       const mockCustomer = StripeResponseFactory(StripeCustomerFactory());
 
@@ -1380,6 +1392,9 @@ describe('CartService', () => {
         jest
           .spyOn(invoiceManager, 'previewUpcoming')
           .mockResolvedValue(mockPreviewInvoice);
+        jest
+          .spyOn(checkoutService, 'getFreeTrialEligibility')
+          .mockResolvedValue(null);
       });
 
       it('calls cartManager.updateFreshCart with no currency change', async () => {
@@ -1487,6 +1502,7 @@ describe('CartService', () => {
       });
       const expectedUpdateCart = {
         ...mockUpdateCartInput,
+        isFreeTrial: false,
       };
 
       beforeEach(async () => {
@@ -1497,12 +1513,16 @@ describe('CartService', () => {
           .spyOn(promotionCodeManager, 'assertValidForPriceAndCustomer')
           .mockResolvedValue(undefined);
         jest.spyOn(cartManager, 'updateFreshCart').mockResolvedValue();
+        jest
+          .spyOn(checkoutService, 'getFreeTrialEligibility')
+          .mockResolvedValue(null);
       });
 
       it('success if coupon is valid for new customer', async () => {
         const mockCart = ResultCartFactory({
           stripeCustomerId: undefined,
           stripeSubscriptionId: undefined,
+          eligibilityStatus: CartEligibilityStatus.INVALID,
         });
 
         jest.spyOn(cartManager, 'fetchCartById').mockResolvedValue(mockCart);
@@ -1525,6 +1545,7 @@ describe('CartService', () => {
           stripeCustomerId: mockCustomer.id,
           stripeSubscriptionId: undefined,
           taxAddress: TaxAddressFactory(),
+          eligibilityStatus: CartEligibilityStatus.INVALID,
         });
         const mockPreviewInvoice = InvoicePreviewFactory();
 
@@ -2445,6 +2466,7 @@ describe('CartService', () => {
         state: CartState.START,
         stripeSubscriptionId: null,
         eligibilityStatus: CartEligibilityStatus.CREATE,
+        isFreeTrial: true,
       });
       const mockInvoicePreview = InvoicePreviewFactory();
 
@@ -2470,6 +2492,33 @@ describe('CartService', () => {
       });
     });
 
+    it('does not call getFreeTrialEligibility when cart was not promised a trial', async () => {
+      const mockFreeTrial = FreeTrialFactory({ trialLengthDays: 7 });
+      const mockCart = ResultCartFactory({
+        uid: faker.string.uuid(),
+        state: CartState.START,
+        stripeSubscriptionId: null,
+        eligibilityStatus: CartEligibilityStatus.CREATE,
+        isFreeTrial: false,
+      });
+      const mockInvoicePreview = InvoicePreviewFactory();
+
+      jest.spyOn(cartManager, 'fetchCartById').mockResolvedValue(mockCart);
+      jest.spyOn(eligibilityService, 'checkEligibility').mockResolvedValue({
+        subscriptionEligibilityResult: EligibilityStatus.CREATE,
+      });
+      jest
+        .spyOn(invoiceManager, 'previewUpcoming')
+        .mockResolvedValue(mockInvoicePreview);
+      jest
+        .spyOn(checkoutService, 'getFreeTrialEligibility')
+        .mockResolvedValue(mockFreeTrial);
+
+      const result = await cartService.getCart(mockCart.id);
+      expect(result.freeTrialEligibility).toBeNull();
+      expect(checkoutService.getFreeTrialEligibility).not.toHaveBeenCalled();
+    });
+
     it('sets freeTrialEligibility to null when cart has no uid', async () => {
       const mockCart = ResultCartFactory({
         uid: undefined,

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

@@ -444,6 +444,16 @@ export class CartService {
       }
     }
 
+    const freeTrial = args.uid
+      ? await this.checkoutService.getFreeTrialEligibility({
+          uid: args.uid,
+          offeringConfigId: args.offeringConfigId,
+          countryCode: args.taxAddress.countryCode,
+          interval: args.interval,
+          eligibilityStatus: eligibility.subscriptionEligibilityResult,
+        })
+      : null;
+
     const createCartParams: SetupCart = {
       interval: args.interval,
       offeringConfigId: args.offeringConfigId,
@@ -455,6 +465,7 @@ export class CartService {
       currency,
       eligibilityStatus: cartEligibilityStatus,
       couponCode,
+      isFreeTrial: !!freeTrial,
     };
 
     if (eligibility.subscriptionEligibilityResult === EligibilityStatus.SAME) {
@@ -547,6 +558,7 @@ export class CartService {
         stripeCustomerId: accountCustomer?.stripeCustomerId || undefined,
         amount: oldCart.amount,
         eligibilityStatus: oldCart.eligibilityStatus,
+        isFreeTrial: oldCart.isFreeTrial,
       });
     });
   }
@@ -825,6 +837,27 @@ export class CartService {
           );
         }
 
+        const effectiveUid = cartDetailsInput.uid ?? oldCart.uid;
+        if (
+          effectiveUid &&
+          oldCart.eligibilityStatus === CartEligibilityStatus.CREATE
+        ) {
+          const freeTrial =
+            await this.checkoutService.getFreeTrialEligibility({
+              uid: effectiveUid,
+              offeringConfigId: oldCart.offeringConfigId,
+              countryCode:
+                cartDetailsInput.taxAddress?.countryCode ??
+                oldCart.taxAddress?.countryCode ??
+                '',
+              interval: oldCart.interval as SubplatInterval,
+              eligibilityStatus: EligibilityStatus.CREATE,
+            });
+          cartDetails.isFreeTrial = !!freeTrial;
+        } else {
+          cartDetails.isFreeTrial = false;
+        }
+
         await this.cartManager.updateFreshCart(cartId, version, cartDetails);
 
         return this.cartManager.fetchCartById(cartId);
@@ -897,7 +930,7 @@ export class CartService {
     const trialEndDate = trialSubscription?.trial_end ?? undefined;
 
     let freeTrialEligibility: FreeTrial | null = null;
-    if (cart.uid && cart.state === CartState.START) {
+    if (cart.uid && cart.state === CartState.START && cart.isFreeTrial) {
       freeTrialEligibility = await this.checkoutService.getFreeTrialEligibility(
         {
           uid: cart.uid,

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

@@ -128,6 +128,7 @@ export type SetupCart = {
   stripeCustomerId?: string;
   amount: number;
   eligibilityStatus: CartEligibilityStatus;
+  isFreeTrial: boolean;
 };
 
 export interface TaxAmount {
@@ -145,6 +146,7 @@ export type UpdateCart = {
   stripeCustomerId?: string;
   stripeSubscriptionId?: string;
   stripeIntentId?: string;
+  isFreeTrial?: boolean;
 };
 
 export type UpdateCartInput = Pick<

libs/payments/cart/src/lib/checkout.factories.ts

@@ -22,6 +22,7 @@ export const PrePayStepsResultFactory = (
     eligibility: SubscriptionEligibilityResultFactory({
       subscriptionEligibilityResult: EligibilityStatus.CREATE,
     }),
+    freeTrial: null,
     ...override,
   };
 };