Merge pull request #19952 from mozilla/FXA-12883

feat(auth): Use libs email in auth server

Author: nshirley

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

@@ -45,7 +45,8 @@ export const splitEmails = (
  */
 export const constructLocalTimeAndDateStrings = (
   timeZone?: string,
-  acceptLanguage?: string
+  acceptLanguage?: string,
+  date?: Date | number
 ): {
   acceptLanguage: string;
   date: string;
@@ -57,18 +58,18 @@ export const constructLocalTimeAndDateStrings = (
   const locale = determineLocale(acceptLanguage) || DEFAULT_LOCALE;
   moment.locale(locale);
 
-  let timeMoment = moment();
+  let timeMoment = moment(date ? date : undefined);
   if (timeZone) {
     timeMoment = timeMoment.tz(timeZone);
   }
 
-  const time = timeMoment.format('LTS (z)');
-  const date = timeMoment.format('dddd, ll');
+  const formattedTime = timeMoment.format('LTS (z)');
+  const formattedDate = timeMoment.format('dddd, ll');
 
   return {
     acceptLanguage: locale,
-    date,
-    time,
+    date: formattedDate,
+    time: formattedTime,
     timeZone: timeZone || DEFAULT_TIMEZONE,
   };
 };

libs/accounts/email-renderer/src/renderer/email-link-builder.spec.ts

@@ -34,6 +34,8 @@ describe('EmailLinkBuilder', () => {
       'https://survey.alchemer.com/s3/6534408/Privacy-Security-Product-Cancellation-of-Service-Q4-21',
     firefoxDesktopUrl:
       'https://firefox.com?utm_content=registration-confirmation&utm_medium=email&utm_source=fxa',
+    unsubscribeUrl:
+      'https://privacyportal.onetrust.com/webform/1350748f-7139-405c-8188-22740b3b5587/4ba08202-2ede-4934-a89e-f0b0870f95f0',
   };
 
   let linkBuilder: EmailLinkBuilder;
@@ -319,6 +321,13 @@ describe('EmailLinkBuilder', () => {
       const attrs = linkBuilder.buildCadLink('postVerify', false);
       expect(attrs).toEqual('http://localhost:30303/connect_another_device');
     });
+
+    it('can build one click link', () => {
+      const attrs = linkBuilder.buildCadLink('postVerify', true, true);
+      expect(attrs).toEqual(
+        'http://localhost:30303/connect_another_device?utm_medium=email&utm_campaign=fx-account-verified&utm_content=fx-account-verified-one-click&one_click=true'
+      );
+    });
   });
 
   describe('buildVerifyLoginLink', () => {
@@ -386,4 +395,49 @@ describe('EmailLinkBuilder', () => {
       expect(link).toEqual(mockConfig.firefoxDesktopUrl);
     });
   });
+
+  describe('buildVerifyEmailLink', () => {
+    it('can build', () => {
+      const link = linkBuilder.buildVerifyEmailLink('verifyEmail', true, {
+        code: 'abcd',
+        uid: '123',
+        redirectTo: 'http://mozilla.org',
+        reminder: 'first',
+        resume: 'xyz',
+        service: 'sync',
+      });
+      expect(link).toEqual(
+        'http://test.localhost:30303/verify_email?utm_medium=email&utm_campaign=fx-welcome&utm_content=fx-welcome&code=abcd&uid=123&redirectTo=http%3A%2F%2Fmozilla.org&reminder=first&resume=xyz&service=sync'
+      );
+    });
+    it(' can build without utm', () => {
+      const link = linkBuilder.buildVerifyEmailLink('verifyEmail', false, {
+        code: 'abcd',
+        uid: '123',
+      });
+      expect(link).toEqual(
+        'http://test.localhost:30303/verify_email?code=abcd&uid=123'
+      );
+    });
+  });
+  describe('buildReportSigninLink', () => {
+    it('can build', () => {
+      const link = linkBuilder.buildReportSignInLink('verifyEmail', true, {
+        uid: '123',
+        unblockCode: 'abcd',
+      });
+      expect(link).toEqual(
+        'http://localhost:30303/report_signin?utm_medium=email&utm_campaign=fx-welcome&utm_content=fx-report&uid=123&unblockCode=abcd'
+      );
+    });
+    it('can build without utm', () => {
+      const link = linkBuilder.buildReportSignInLink('verifyEmail', false, {
+        uid: '123',
+        unblockCode: 'abcd',
+      });
+      expect(link).toEqual(
+        'http://localhost:30303/report_signin?uid=123&unblockCode=abcd'
+      );
+    });
+  });
 });

libs/accounts/email-renderer/src/renderer/email-link-builder.ts

@@ -145,12 +145,14 @@ export class EmailLinkBuilder {
    * @param templateName - Email template name (used to lookup campaign)
    * @param metricsEnabled - Inidicates if metrics/tracking is enabled for the user
    * @param content - Optional content override (defaults to template's content map value)
+   * @param oneClickLink - Indicates if this should be a one-click link, adding a suffix to the utm_content value
    */
   private addUTMParams(
     url: URL,
     templateName: string,
     metricsEnabled: boolean,
-    content?: string
+    content?: string,
+    oneClickLink = false
   ): void {
     // Don't include utm parameters if metrics are disabled. This flag
     // comes from the users's account state and must be supplied.
@@ -168,7 +170,13 @@ export class EmailLinkBuilder {
     }
 
     const contentValue = content || this.getContent(templateName);
-    if (contentValue) {
+    if (contentValue && oneClickLink) {
+      url.searchParams.set(
+        'utm_content',
+        UTM_PREFIX + contentValue + '-one-click'
+      );
+      url.searchParams.set('one_click', 'true');
+    } else if (contentValue) {
       url.searchParams.set('utm_content', UTM_PREFIX + contentValue);
     }
 
@@ -378,9 +386,19 @@ export class EmailLinkBuilder {
     return url.toString();
   }
 
-  buildCadLink(templateName: string, metricsEnabled: boolean) {
+  buildCadLink(
+    templateName: string,
+    metricsEnabled: boolean,
+    oneClickLink = false
+  ) {
     const url = new URL(`${this.baseUri}/connect_another_device`);
-    this.addUTMParams(url, templateName, metricsEnabled);
+    this.addUTMParams(
+      url,
+      templateName,
+      metricsEnabled,
+      undefined,
+      oneClickLink
+    );
     return url.toString();
   }
 
@@ -424,6 +442,41 @@ export class EmailLinkBuilder {
   buildDesktopLink() {
     return this.config.firefoxDesktopUrl;
   }
+
+  buildVerifyEmailLink(
+    templateName: string,
+    metricsEnabled: boolean,
+    query: {
+      code: string;
+      uid: string;
+      resume?: string;
+      redirectTo?: string;
+      service?: string;
+      reminder?: 'first' | 'second' | 'final';
+    }
+  ): string {
+    const url = new URL(`${this.baseUri}/verify_email`);
+    if (this.config.prependVerificationSubdomain.enabled) {
+      url.host = `${this.config.prependVerificationSubdomain.subdomain}.${url.host}`;
+    }
+    this.addUTMParams(url, templateName, metricsEnabled);
+    this.addQueryParams(url, query);
+    return url.toString();
+  }
+
+  buildReportSignInLink(
+    templateName: string,
+    metricsEnabled: boolean,
+    query: {
+      uid: string;
+      unblockCode: string;
+    }
+  ): string {
+    const url = new URL(`${this.baseUri}/report_signin`);
+    this.addUTMParams(url, templateName, metricsEnabled, 'report');
+    this.addQueryParams(url, query);
+    return url.toString();
+  }
 }
 
 // PORTED FROM fxa-shared/subscriptions/configuration/utils.ts

packages/fxa-auth-server/lib/inactive-accounts/index.ts

@@ -35,6 +35,8 @@ import {
   getAccountCustomerByUid,
 } from 'fxa-shared/db/models/auth';
 import { BOUNCE_TYPES } from 'fxa-shared/db/models/auth/email-bounce';
+import { FxaMailer } from '../senders/fxa-mailer';
+import { FxaMailerFormat } from '../senders/fxa-mailer-format';
 
 const aDayInMs = 24 * 60 * 60 * 1000;
 const sixtyDaysInMs = 60 * aDayInMs;
@@ -55,6 +57,17 @@ export const requestForGlean = {
     isMetricsEnabled: () => true,
     metricsContext: () => ({}),
     ua: {},
+    geo: {
+      timeZone: 'UTC',
+      location: {
+        city: '',
+        state: '',
+        stateCode: '',
+        country: '',
+        countryCode: '',
+      },
+    },
+    acceptLanguage: 'en',
   },
   auth: {},
   headers: {
@@ -148,6 +161,7 @@ export class InactiveAccountsManager {
   statsd: StatsD;
   glean: GleanMetricsType;
   log: Logger;
+  private fxaMailer: FxaMailer;
 
   constructor({
     fxaDb,
@@ -175,6 +189,8 @@ export class InactiveAccountsManager {
     this.statsd = statsd;
     this.glean = glean;
     this.log = log;
+
+    this.fxaMailer = Container.get(FxaMailer);
   }
 
   async isActive(uid: string, activeByDateTimestamp?: number) {
@@ -281,11 +297,31 @@ export class InactiveAccountsManager {
       acceptLanguage: account.locale,
       inactiveDeletionEta: now + emailTypeSpecificVals.timeToDeletion,
     };
-    await this.mailer[emailTypeSpecificVals.emailSender](
-      account.emails,
-      account,
-      message
-    );
+
+    if (this.fxaMailer.canSend(emailTypeSpecificVals.emailTemplate)) {
+      await this.fxaMailer[emailTypeSpecificVals.emailSender]({
+        ...FxaMailerFormat.account(account),
+        ...(await FxaMailerFormat.metricsContext(requestForGlean)),
+        ...FxaMailerFormat.localTime(requestForGlean),
+        ...FxaMailerFormat.location(requestForGlean),
+        ...FxaMailerFormat.device(requestForGlean),
+        ...FxaMailerFormat.sync(false),
+        // use the formatter to convert inactiveDeletionEta to localized strings
+        deletionDate: FxaMailerFormat.localTime(
+          requestForGlean,
+          message.inactiveDeletionEta
+        ).date,
+        // override acceptLanguage to ensure email is localized as best we can
+        acceptLanguage: account.locale,
+      });
+    } else {
+      await this.mailer[emailTypeSpecificVals.emailSender](
+        account.emails,
+        account,
+        message
+      );
+    }
+
     this.statsd.increment(
       `account.inactive.${emailTypeSpecificVals.attempt}-email.sent`
     );

packages/fxa-auth-server/lib/routes/account.ts

@@ -403,28 +403,45 @@ export class AccountHandler {
           break;
         }
         default: {
-          await this.mailer.sendVerifyEmail([], account, {
-            code: account.emailCode,
-            service: form.service || query.service,
-            redirectTo: form.redirectTo,
-            resume: form.resume,
-            acceptLanguage: locale,
-            deviceId,
-            flowId,
-            flowBeginTime,
-            productId,
-            planId,
-            ip,
-            location: request.app.geo.location,
-            timeZone: request.app.geo.timeZone,
-            style,
-            uaBrowser: sessionToken.uaBrowser,
-            uaBrowserVersion: sessionToken.uaBrowserVersion,
-            uaOS: sessionToken.uaOS,
-            uaOSVersion: sessionToken.uaOSVersion,
-            uaDeviceType: sessionToken.uaDeviceType,
-            uid: sessionToken.uid,
-          });
+          if (this.fxaMailer.canSend('verify')) {
+            await this.fxaMailer.sendVerifyEmail({
+              ...FxaMailerFormat.account(account),
+              ...(await FxaMailerFormat.metricsContext(request)),
+              ...FxaMailerFormat.sync(form.service || query.service),
+              ...FxaMailerFormat.localTime(request),
+              ...FxaMailerFormat.location(request),
+              ...FxaMailerFormat.device(request),
+              code: account.emailCode,
+              resume: form.resume,
+              redirectTo: form.redirectTo,
+              service: form.service || query.service,
+            });
+          } else {
+            console.debug('falling back')
+            const sent = await this.mailer.sendVerifyEmail([], account, {
+              code: account.emailCode,
+              service: form.service || query.service,
+              redirectTo: form.redirectTo,
+              resume: form.resume,
+              acceptLanguage: locale,
+              deviceId,
+              flowId,
+              flowBeginTime,
+              productId,
+              planId,
+              ip,
+              location: request.app.geo.location,
+              timeZone: request.app.geo.timeZone,
+              style,
+              uaBrowser: sessionToken.uaBrowser,
+              uaBrowserVersion: sessionToken.uaBrowserVersion,
+              uaOS: sessionToken.uaOS,
+              uaOSVersion: sessionToken.uaOSVersion,
+              uaDeviceType: sessionToken.uaDeviceType,
+              uid: sessionToken.uid,
+            });
+            console.debug('falling back sent!', sent);
+          }
         }
       }