Merge pull request #20423 from mozilla/PAY-3656

fix(payments-next): Add free trial reactivation email variant

Author: david1alvarez

libs/accounts/email-renderer/src/renderer/subplat-email-renderer.ts

@@ -237,7 +237,9 @@ export class SubplatEmailRender extends EmailRenderer {
       template: SubscriptionReactivation.template,
       version: SubscriptionReactivation.version,
       layout: SubscriptionReactivation.layout,
-      includes: SubscriptionReactivation.includes,
+      includes: SubscriptionReactivation.getIncludes(
+        templateValues.isFreeTrialReactivation
+      ),
       ...templateValues,
       ...layoutTemplateValues,
     });

libs/accounts/email-renderer/src/templates/subscriptionReactivation/en.ftl

@@ -1,10 +1,16 @@
 # Variables:
 #  $productName (String) - The name of the subscribed product, e.g. Mozilla VPN
-subscriptionReactivation-subject = { $productName } subscription reactivated
+subscriptionReactivation-subject-2 = Your { $productName } subscription has been reactivated
+# Variables:
+#  $productName (String) - The name of the subscribed product, e.g. Mozilla VPN
+subscriptionReactivation-freeTrial-subject = Your { $productName } trial has been reactivated
 # Variables:
 #  $productName (String) - The name of the subscribed product, e.g. Mozilla VPN
 subscriptionReactivation-title = Thank you for reactivating your { $productName } subscription!
 # Variables:
+#  $productName (String) - The name of the subscribed product, e.g. Mozilla VPN
+subscriptionReactivation-freeTrial-title = Thank you for reactivating your { $productName } trial!
+# Variables:
 #  $invoiceTotal (String) - The amount of the subscription invoice, including currency, e.g. $10.00
 #  $nextInvoiceDateOnly (String) - The date of the next invoice, e.g. 2016/01/20
 subscriptionReactivation-content = Your billing cycle and payment will remain the same. Your next charge will be { $invoiceTotal } on { $nextInvoiceDateOnly }. Your subscription will automatically renew each billing period unless you choose to cancel.

libs/accounts/email-renderer/src/templates/subscriptionReactivation/index.mjml

@@ -7,7 +7,11 @@
 <mj-section>
   <mj-column>
     <mj-text css-class="text-header">
-      <span data-l10n-id="subscriptionReactivation-title" data-l10n-args="<%= JSON.stringify({productName}) %>">Thank you for reactivating your <%- productName %> subscription!</span>
+      <% if (isFreeTrialReactivation) { %>
+        <span data-l10n-id="subscriptionReactivation-freeTrial-title" data-l10n-args="<%= JSON.stringify({productName}) %>">Thank you for reactivating your <%- productName %> trial!</span>
+      <% } else { %>
+        <span data-l10n-id="subscriptionReactivation-title" data-l10n-args="<%= JSON.stringify({productName}) %>">Thank you for reactivating your <%- productName %> subscription!</span>
+      <% } %>
     </mj-text>
 
     <mj-text css-class="text-body">

libs/accounts/email-renderer/src/templates/subscriptionReactivation/index.stories.ts

@@ -4,7 +4,7 @@
 
 import { Meta } from '@storybook/html';
 import { subplatStoryWithProps } from '../../storybook-email';
-import { includes, TemplateData } from './index';
+import { getIncludes, TemplateData } from './index';
 
 export default {
   title: 'SubPlat Emails/Templates/subscriptionReactivation',
@@ -16,13 +16,28 @@ const data = {
   nextInvoiceDateOnly: '11/13/2021',
   icon: 'https://placekitten.com/512/512',
   subscriptionSupportUrl: 'http://localhost:3030/support',
+  isFreeTrialReactivation: false,
 };
 
 const createStory = subplatStoryWithProps<TemplateData>(
   'subscriptionReactivation',
   'Sent when a user reactivates their subscription.',
   data,
-  includes
+  getIncludes(data.isFreeTrialReactivation)
 );
 
 export const SubscriptionReactivation = createStory();
+
+const freeTrialData = {
+  ...data,
+  isFreeTrialReactivation: true,
+};
+
+const createFreeTrialStory = subplatStoryWithProps<TemplateData>(
+  'subscriptionReactivation',
+  'Sent when a user reactivates their subscription while still in a free trial.',
+  freeTrialData,
+  getIncludes(freeTrialData.isFreeTrialReactivation)
+);
+
+export const SubscriptionReactivationFreeTrial = createFreeTrialStory();

libs/accounts/email-renderer/src/templates/subscriptionReactivation/index.ts

@@ -12,14 +12,23 @@ export type TemplateData = IconTemplateData &
     nextInvoiceDateOnly: string;
     icon: string;
     subscriptionSupportUrl: string;
+    isFreeTrialReactivation: boolean;
   };
 
 export const template = 'subscriptionReactivation';
-export const version = 2;
+export const version = 3;
 export const layout = 'subscription';
-export const includes = {
-  subject: {
-    id: 'subscriptionReactivation-subject-2',
-    message: 'Your <%- productName %> subscription has been reactivated',
-  },
-};
+
+export function getIncludes(isFreeTrialReactivation: boolean) {
+  return {
+    subject: isFreeTrialReactivation
+      ? {
+          id: 'subscriptionReactivation-freeTrial-subject',
+          message: 'Your <%- productName %> trial has been reactivated',
+        }
+      : {
+          id: 'subscriptionReactivation-subject-2',
+          message: 'Your <%- productName %> subscription has been reactivated',
+        },
+  };
+}

libs/accounts/email-renderer/src/templates/subscriptionReactivation/index.txt

@@ -1,4 +1,8 @@
+<% if (isFreeTrialReactivation) { %>
+subscriptionReactivation-freeTrial-title = "Thank you for reactivating your <%- productName %> trial!"
+<% } else { %>
 subscriptionReactivation-title = "Thank you for reactivating your <%- productName %> subscription!"
+<% } %>
 
 subscriptionReactivation-content = "Your billing cycle and payment will remain the same. Your next charge will be <%- invoiceTotal %> on <%- nextInvoiceDateOnly %>. Your subscription will automatically renew each billing period unless you choose to cancel."
 

packages/fxa-auth-server/lib/payments/stripe.spec.ts

@@ -7237,6 +7237,7 @@ describe('StripeHelper', () => {
         cardType: card.brand,
         lastFour: card.last4,
         nextInvoiceDate: new Date(mockInvoice.lines.data[0].period.end * 1000),
+        isFreeTrialReactivation: false,
       };
 
       const { lastFour, cardType } = defaultExpected;
@@ -7279,6 +7280,24 @@ describe('StripeHelper', () => {
         expect(result).toEqual(defaultExpected);
       });
 
+      it('sets isFreeTrialReactivation to true when subscription status is trialing', async () => {
+        const event = deepCopy(eventCustomerSubscriptionUpdated);
+        event.data.object.status = 'trialing';
+        jest
+          .spyOn(stripeHelper, 'fetchCustomer')
+          .mockResolvedValue(reactivationMockCustomer);
+        const result =
+          await stripeHelper.extractSubscriptionUpdateReactivationDetailsForEmail(
+            event.data.object,
+            expectedBaseUpdateDetails,
+            mockInvoice
+          );
+        expect(result).toEqual({
+          ...defaultExpected,
+          isFreeTrialReactivation: true,
+        });
+      });
+
       it('does not throw an exception when payment method is missing', async () => {
         const event = deepCopy(eventCustomerSubscriptionUpdated);
         const customerNoPayment = deepCopy(reactivationMockCustomer);

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

@@ -3380,6 +3380,7 @@ export class StripeHelper extends StripeHelperBase {
       nextInvoiceDate: nextInvoiceDate
         ? new Date(nextInvoiceDate * 1000)
         : null,
+      isFreeTrialReactivation: subscription.status === 'trialing',
       planConfig,
     };
   }

packages/fxa-auth-server/lib/senders/email.js

@@ -3092,6 +3092,7 @@ module.exports = function (log, config, bounces, statsd) {
       lastFour,
       nextInvoiceDate,
       payment_provider,
+      isFreeTrialReactivation = false,
     } = message;
 
     const enabled = config.subscriptions.transactionalEmails.enabled;
@@ -3142,6 +3143,7 @@ module.exports = function (log, config, bounces, statsd) {
         cardName: cardTypeToText(cardType),
         lastFour,
         nextInvoiceDate,
+        isFreeTrialReactivation,
       },
     });
   };

packages/fxa-auth-server/lib/senders/emails/templates/_versions.json

@@ -1,6 +1,6 @@
 {
   "freeTrialEndingReminder": 2,
-  "subscriptionReactivation": 2,
+  "subscriptionReactivation": 3,
   "subscriptionRenewalReminder": 4,
   "subscriptionEndingReminder": 2,
   "subscriptionUpgrade": 7,