feat(payments-next): Create Stay subscribed churn page

This pull request:
Adds the following churn pages:
  Error
  Not Found
  Stay Subscribed/component
Updates Terms page to have a min-width value
Updates ChurnInterventionManager to create entry if none exist
Adds hasCouponId to SubscriptionManager to check if coupon exists on subscription
Updates ChurnInterventionService.determineStaySubscribedEligibility
    Changes initial discount already applied to redemption limit exceeded
    Adds in discount already applied (checks subscription for coupon)
    Reorders reasons:
        From: No churn intervention found, discount already applied, sub not active, sub still active, eligible, general error
        To: Sub not active, sub still active, no churn intervention found, redemption limit exceeded, discount already applied, eligible, general error
Updates subscriptionManagementService.applyStripeCouponToSubscription as it was not updating cancel_at_period_end when resubscribing
Updates CMS to retrieve additional values (apiIdentifier, successActionButtonUrl, etc)

Author: xlisachan

apps/payments/next/app/[locale]/[offeringId]/[interval]/[churnType]/loyalty-discount/terms/page.tsx

@@ -53,7 +53,7 @@ export default async function ChurnTerms({
       className="flex tablet:items-center justify-center min-h-[calc(100vh_-_4rem)] tablet:min-h-[calc(100vh_-_5rem)]"
       aria-labelledby="loyalty-discount-terms"
     >
-      <div className="max-w-xl flex flex-col p-6 pt-10 tablet:bg-white tablet:border tablet:border-grey-200 tablet:opacity-100 tablet:p-8 tablet:rounded-xl tablet:shadow-[0_0px_10px_rgba(0,0,0,0.08)]">
+      <div className="max-w-xl min-w-[480px] flex flex-col p-6 pt-10 tablet:bg-white tablet:border tablet:border-grey-200 tablet:opacity-100 tablet:p-8 tablet:rounded-xl tablet:shadow-[0_0px_10px_rgba(0,0,0,0.08)]">
         <h1
           id="loyalty-discount-terms"
           className="font-semibold text-xl leading-8"

apps/payments/next/app/[locale]/subscriptions/[subscriptionId]/loyalty-discount/en.ftl

@@ -0,0 +1,7 @@
+## Loyalty discount - Not found page
+
+not-found-loyalty-discount-title = Page not found
+not-found-loyalty-discount-description = The page you are looking for does not exist.
+not-found-loyalty-discount-button-back-to-subscriptions = Back to subscriptions
+
+##

apps/payments/next/app/[locale]/subscriptions/[subscriptionId]/loyalty-discount/not-found.tsx

@@ -0,0 +1,33 @@
+/* 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 { headers } from 'next/headers';
+import { PageNotFound } from '@fxa/payments/ui';
+import { getApp } from '@fxa/payments/ui/server';
+
+export enum PaymentsPage {
+  Subscriptions = 'subscriptions',
+}
+
+export default function NotFound() {
+  const acceptLanguage = headers().get('accept-language');
+  const l10n = getApp().getL10n(acceptLanguage);
+  return (
+    <PageNotFound
+      header={l10n.getString(
+        'not-found-loyalty-discount-title',
+        'Page not found'
+      )}
+      description={l10n.getString(
+        'not-found-loyalty-discount-description',
+        'The page you are looking for does not exist.'
+      )}
+      button={l10n.getString(
+        'not-found-loyalty-discount-button-back-to-subscriptions',
+        'Back to subscriptions'
+      )}
+      paymentsPage={PaymentsPage.Subscriptions}
+    />
+  );
+}

apps/payments/next/app/[locale]/subscriptions/[subscriptionId]/loyalty-discount/stay-subscribed/error/page.tsx

@@ -0,0 +1,66 @@
+/* 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 { headers } from 'next/headers';
+import { notFound, redirect } from 'next/navigation';
+
+import { SubscriptionParams } from '@fxa/payments/ui';
+import { determineStaySubscribedEligibilityAction } from '@fxa/payments/ui/actions';
+import { ChurnError } from '@fxa/payments/ui/server';
+import { auth } from 'apps/payments/next/auth';
+import { config } from 'apps/payments/next/config';
+
+export default async function LoyaltyDiscountStaySubscribedErrorPage({
+  params,
+  searchParams,
+}: {
+  params: SubscriptionParams;
+  searchParams: Record<string, string> | undefined;
+}) {
+  const { locale, subscriptionId } = params;
+  const acceptLanguage = headers().get('accept-language');
+
+  const session = await auth();
+  if (!session?.user?.id) {
+    const redirectToUrl = new URL(
+      `${config.paymentsNextHostedUrl}/${locale}/subscriptions/landing`
+    );
+    redirectToUrl.search = new URLSearchParams(searchParams).toString();
+    redirect(redirectToUrl.href);
+  }
+
+  const uid = session.user.id;
+
+  const pageContent = await determineStaySubscribedEligibilityAction(
+    uid,
+    subscriptionId,
+    acceptLanguage
+  );
+
+  if (!pageContent) {
+    notFound();
+  }
+
+  const { cmsOfferingContent, reason } = pageContent;
+
+  if (!cmsOfferingContent) {
+    notFound();
+  }
+
+  const staySubscribedContent = pageContent.staySubscribedContent;
+
+  if (staySubscribedContent.flowType !== 'stay_subscribed') {
+    notFound();
+  }
+
+  return (
+    <ChurnError
+      cmsOfferingContent={cmsOfferingContent}
+      locale={locale}
+      reason={reason}
+      pageContent={staySubscribedContent}
+      subscriptionId={subscriptionId}
+    />
+  );
+}

apps/payments/next/app/[locale]/subscriptions/[subscriptionId]/loyalty-discount/stay-subscribed/page.tsx

@@ -0,0 +1,87 @@
+/* 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 { headers } from 'next/headers';
+import { notFound, redirect } from 'next/navigation';
+
+import { ChurnStaySubscribed, SubscriptionParams } from '@fxa/payments/ui';
+import { determineStaySubscribedEligibilityAction } from '@fxa/payments/ui/actions';
+import { auth } from 'apps/payments/next/auth';
+import { config } from 'apps/payments/next/config';
+
+enum ChurnStayErrorReason {
+  DiscountAlreadyApplied = 'discount_already_applied',
+  SubscriptionNotActive = 'subscription_not_active',
+  GeneralError = 'general_error',
+  RedemptionLimitExceeded = 'redemption_limit_exceeded',
+}
+
+export default async function LoyaltyDiscountStaySubscribedPage({
+  params,
+  searchParams,
+}: {
+  params: SubscriptionParams;
+  searchParams: Record<string, string> | undefined;
+}) {
+  const { locale, subscriptionId } = params;
+  const acceptLanguage = headers().get('accept-language');
+
+  const session = await auth();
+  if (!session?.user?.id) {
+    const redirectToUrl = new URL(
+      `${config.paymentsNextHostedUrl}/${locale}/subscriptions/landing`
+    );
+    redirectToUrl.search = new URLSearchParams(searchParams).toString();
+    redirect(redirectToUrl.href);
+  }
+
+  const uid = session.user.id;
+
+  const pageContent = await determineStaySubscribedEligibilityAction(
+    uid,
+    subscriptionId,
+    acceptLanguage
+  );
+
+  if (!pageContent) notFound();
+
+  const { cmsOfferingContent, reason, staySubscribedContent } = pageContent;
+  const reasonStr = typeof reason === 'string' ? reason : undefined;
+  const isErrorReason =
+    !!reasonStr &&
+    (Object.values(ChurnStayErrorReason) as string[]).includes(reasonStr);
+  const isAllowedStayReason =
+    reasonStr === 'eligible' ||
+    reasonStr === 'no_churn_intervention_found' ||
+    reasonStr === 'subscription_still_active';
+
+  if (isErrorReason) {
+    redirect(
+      `/${locale}/subscriptions/${subscriptionId}/loyalty-discount/stay-subscribed/error`
+    );
+  }
+
+  if (
+    !staySubscribedContent ||
+    staySubscribedContent.flowType !== 'stay_subscribed'
+  ) {
+    notFound();
+  }
+
+  if (reasonStr == null || isAllowedStayReason) {
+    return (
+      <ChurnStaySubscribed
+        uid={uid}
+        subscriptionId={subscriptionId}
+        locale={locale}
+        reason={reason}
+        cmsChurnInterventionEntry={pageContent.cmsChurnInterventionEntry}
+        cmsOfferingContent={cmsOfferingContent}
+        staySubscribedContent={staySubscribedContent}
+      />
+    );
+  }
+
+  notFound();
+}

libs/payments/cart/src/lib/churn-intervention.manager.spec.ts

@@ -26,7 +26,9 @@ jest.mock('./churn-intervention.repository', () => ({
 
 describe('ChurnInterventionManager', () => {
   let manager: ChurnInterventionManager;
-  const mockConfig = { collectionName: 'testCollection' } as ChurnInterventionConfig;
+  const mockConfig = {
+    collectionName: 'testCollection',
+  } as ChurnInterventionConfig;
   const mockEntry = ChurnInterventionEntryFactory();
 
   beforeEach(() => {
@@ -48,21 +50,26 @@ describe('ChurnInterventionManager', () => {
 
       const result = await manager.createEntry(mockEntry);
 
-      expect(createChurnInterventionEntry).toHaveBeenCalledWith(mockCollection, {
-        customerId: mockEntry.customerId,
-        churnInterventionId: mockEntry.churnInterventionId,
-        redemptionCount: mockEntry.redemptionCount ?? 0,
-      });
+      expect(createChurnInterventionEntry).toHaveBeenCalledWith(
+        mockCollection,
+        {
+          customerId: mockEntry.customerId,
+          churnInterventionId: mockEntry.churnInterventionId,
+          redemptionCount: mockEntry.redemptionCount ?? 0,
+        }
+      );
       expect(result).toEqual(mockEntry);
     });
   });
 
-  describe('getEntry', () => {
+  describe('getOrCreateEntry', () => {
     it('successfully gets data', async () => {
       (getChurnInterventionEntryData as jest.Mock).mockResolvedValue(mockEntry);
 
-      const result = await manager.getEntry(mockEntry.customerId, mockEntry.churnInterventionId);
-
+      const result = await manager.getOrCreateEntry(
+        mockEntry.customerId,
+        mockEntry.churnInterventionId
+      );
       expect(getChurnInterventionEntryData).toHaveBeenCalledWith(
         mockCollection,
         mockEntry.customerId,
@@ -78,7 +85,10 @@ describe('ChurnInterventionManager', () => {
 
   describe('updateEntry', () => {
     it('successfully udpates', async () => {
-      const updated = { ...mockEntry, redemptionCount: mockEntry.redemptionCount + 1 };
+      const updated = {
+        ...mockEntry,
+        redemptionCount: mockEntry.redemptionCount + 1,
+      };
       (updateChurnInterventionEntry as jest.Mock).mockResolvedValue(updated);
 
       const result = await manager.updateEntry(
@@ -105,7 +115,10 @@ describe('ChurnInterventionManager', () => {
     it('successfully deletes', async () => {
       (deleteChurnInterventionEntry as jest.Mock).mockResolvedValue(true);
 
-      const result = await manager.deleteEntry(mockEntry.customerId, mockEntry.churnInterventionId);
+      const result = await manager.deleteEntry(
+        mockEntry.customerId,
+        mockEntry.churnInterventionId
+      );
 
       expect(deleteChurnInterventionEntry).toHaveBeenCalledWith(
         mockCollection,

libs/payments/cart/src/lib/churn-intervention.manager.ts

@@ -19,49 +19,61 @@ import {
 export class ChurnInterventionManager {
   constructor(
     private config: ChurnInterventionConfig,
-    @Inject(FirestoreService) private firestore: Firestore,
+    @Inject(FirestoreService) private firestore: Firestore
   ) {}
 
   get collectionRef(): CollectionReference {
     return this.firestore.collection(this.config.collectionName);
   }
 
-  async createEntry(
-    entry: ChurnInterventionEntry
-  ) {
-    const data = await createChurnInterventionEntry(
-      this.collectionRef,
-      {
-        customerId: entry.customerId,
-        churnInterventionId: entry.churnInterventionId,
-        redemptionCount: entry.redemptionCount ?? 0,
-      }
-    );
+  async createEntry(entry: ChurnInterventionEntry) {
+    const data = await createChurnInterventionEntry(this.collectionRef, {
+      customerId: entry.customerId,
+      churnInterventionId: entry.churnInterventionId,
+      redemptionCount: entry.redemptionCount ?? 0,
+    });
     return data;
   }
 
-  async getEntry(
-    customerId: string,
-    churnInterventionId: string
-  ) {
-    const data = await getChurnInterventionEntryData(
-      this.collectionRef,
-      customerId,
-      churnInterventionId
-    );
-    return {
-      customerId: data.customerId,
-      churnInterventionId: data.churnInterventionId,
-      redemptionCount: data.redemptionCount,
-    };
+  async getOrCreateEntry(customerId: string, churnInterventionId: string) {
+    try {
+      const data = await getChurnInterventionEntryData(
+        this.collectionRef,
+        customerId,
+        churnInterventionId
+      );
+      return {
+        customerId: data.customerId,
+        churnInterventionId: data.churnInterventionId,
+        redemptionCount: data.redemptionCount,
+      };
+    } catch (error) {
+      if (error instanceof ChurnInterventionEntryNotFoundError) {
+        const created = await this.createEntry({
+          customerId,
+          churnInterventionId,
+          redemptionCount: 0,
+        });
+
+        return {
+          customerId: created.customerId,
+          churnInterventionId: created.churnInterventionId,
+          redemptionCount: created.redemptionCount ?? 0,
+        };
+      }
+      throw error;
+    }
   }
 
   async getRedemptionCountForUid(
     customerId: string,
     churnInterventionId: string
   ) {
     try {
-      const churnInterventionEntryData = await this.getEntry(customerId, churnInterventionId);
+      const churnInterventionEntryData = await this.getOrCreateEntry(
+        customerId,
+        churnInterventionId
+      );
       return churnInterventionEntryData.redemptionCount ?? 0;
     } catch (error) {
       if (error instanceof ChurnInterventionEntryNotFoundError) {
@@ -74,7 +86,7 @@ export class ChurnInterventionManager {
   async updateEntry(
     customerId: string,
     churnInterventionId: string,
-    incrementBy: number,
+    incrementBy: number
   ) {
     const data = await updateChurnInterventionEntry(
       this.collectionRef,
@@ -89,10 +101,7 @@ export class ChurnInterventionManager {
     };
   }
 
-  async deleteEntry(
-    customerId: string,
-    churnInterventionId: string
-  ) {
+  async deleteEntry(customerId: string, churnInterventionId: string) {
     return await deleteChurnInterventionEntry(
       this.collectionRef,
       customerId,