Merge pull request #18312 from mozilla/FXA-11007

feat(sms): Add localized body text to SMS

Author: vpomerleau

libs/accounts/recovery-phone/README.md

@@ -8,4 +8,8 @@ Run `nx build recovery-phone` to build the library.
 
 ## Running unit tests
 
-Run `nx test recovery-phone` to execute the unit tests via [Jest](https://jestjs.io).
+Run `nx test-unit recovery-phone` to execute the unit tests via [Jest](https://jestjs.io).
+
+## Running integration tests
+
+Run `nx test-integration recovery-phone` to execute the integration tests via [Jest](https://jestjs.io).

libs/accounts/recovery-phone/src/lib/recovery-phone.manager.in.spec.ts

@@ -204,20 +204,26 @@ describe('RecoveryPhoneManager', () => {
       mockLookUpData
     );
 
-    const expectedData = JSON.stringify({
-      createdAt: 1739227529776,
-      phoneNumber,
-      isSetup,
-      lookupData: JSON.stringify(mockLookUpData),
-    });
     const redisKey = `sms-attempt:${uid.toString('hex')}:${code}`;
 
     expect(mockRedis.set).toHaveBeenCalledWith(
       redisKey,
-      expectedData,
+      expect.any(String),
       'EX',
       600
     );
+
+    const expectedData = expect.objectContaining({
+      createdAt: expect.any(Number),
+      phoneNumber,
+      isSetup,
+      lookupData: JSON.stringify(mockLookUpData),
+    });
+
+    const storedData = mockRedis.set.mock.calls[0][1];
+    expect(() => JSON.parse(storedData)).not.toThrow();
+    const parsedData = JSON.parse(mockRedis.set.mock.calls[0][1]);
+    expect(parsedData).toEqual(expectedData);
   });
 
   it('should return null if no unconfirmed phone number data is found in Redis', async () => {

libs/accounts/recovery-phone/src/lib/recovery-phone.service.spec.ts

@@ -140,6 +140,31 @@ describe('RecoveryPhoneService', () => {
     expect(mockRecoveryPhoneManager.getAllUnconfirmed).toBeCalledWith(uid);
   });
 
+  it('handles message template when provided to setup phone number', async () => {
+    mockOtpManager.generateCode.mockReturnValue(code);
+    const getFormattedMessage = jest.fn().mockResolvedValue('message');
+
+    const result = await service.setupPhoneNumber(
+      uid,
+      phoneNumber,
+      getFormattedMessage
+    );
+
+    expect(result).toBeTruthy();
+    expect(mockOtpManager.generateCode).toBeCalled();
+    expect(mockSmsManager.sendSMS).toBeCalledWith({
+      to: phoneNumber,
+      body: 'message',
+    });
+    expect(mockRecoveryPhoneManager.storeUnconfirmed).toBeCalledWith(
+      uid,
+      code,
+      phoneNumber,
+      true
+    );
+    expect(mockRecoveryPhoneManager.getAllUnconfirmed).toBeCalledWith(uid);
+  });
+
   it('Will reject a phone number that is not part of launch', async () => {
     const to = '+16005551234';
     await expect(service.setupPhoneNumber(uid, to)).rejects.toEqual(

libs/accounts/recovery-phone/src/lib/recovery-phone.service.ts

@@ -61,9 +61,14 @@ export class RecoveryPhoneService {
    * by sending the phone number provided an OTP code to verify.
    * @param uid The account id
    * @param phoneNumber The phone number to register
+   * @param localizedMessageBody Optional localized message body
    * @returns True if code was sent and stored
    */
-  public async setupPhoneNumber(uid: string, phoneNumber: string) {
+  public async setupPhoneNumber(
+    uid: string,
+    phoneNumber: string,
+    getFormattedMessage?: (code: string) => Promise<string>
+  ) {
     if (!this.config.enabled) {
       throw new RecoveryPhoneNotEnabled();
     }
@@ -90,21 +95,26 @@ export class RecoveryPhoneService {
     }
 
     const code = await this.otpCode.generateCode();
-    const msg = await this.smsManager.sendSMS({
-      to: phoneNumber,
-      body: code,
-    });
 
-    if (!this.isSuccessfulSmsSend(msg)) {
-      return false;
-    }
     await this.recoveryPhoneManager.storeUnconfirmed(
       uid,
       code,
       phoneNumber,
       true
     );
-    return true;
+
+    const formattedSMSbody = getFormattedMessage
+      ? await getFormattedMessage(code)
+      : undefined;
+
+    const smsBody = formattedSMSbody || `${code}`;
+
+    const msg = await this.smsManager.sendSMS({
+      to: phoneNumber,
+      body: smsBody,
+    });
+
+    return this.isSuccessfulSmsSend(msg);
   }
 
   /**
@@ -323,9 +333,13 @@ export class RecoveryPhoneService {
   /**
    * Sends an totp code to a user
    * @param uid Account id
+   * @param getFormattedMessage Optional template function to format the message
    * @returns True if message didn't fail to send.
    */
-  public async sendCode(uid: string) {
+  public async sendCode(
+    uid: string,
+    getFormattedMessage?: (code: string) => Promise<string>
+  ) {
     if (!this.config.enabled) {
       throw new RecoveryPhoneNotEnabled();
     }
@@ -339,9 +353,16 @@ export class RecoveryPhoneService {
       phoneNumber,
       false
     );
+
+    const formattedSMSbody = getFormattedMessage
+      ? await getFormattedMessage(code)
+      : undefined;
+
+    const smsBody = formattedSMSbody || `${code}`;
+
     const msg = await this.smsManager.sendSMS({
       to: phoneNumber,
-      body: `${code}`, // TODO: Other text or translation around code?
+      body: smsBody,
     });
 
     return this.isSuccessfulSmsSend(msg);

packages/functional-tests/lib/email.ts

@@ -59,6 +59,10 @@ export enum EmailType {
   verificationReminderFinal,
   cadReminderFirst,
   cadReminderSecond,
+  postAddRecoveryPhone,
+  postChangeRecoveryPhone,
+  postRemoveRecoveryPhone,
+  postSigninRecoveryPhone,
 }
 
 export enum EmailHeader {

packages/functional-tests/tests/settings/recoveryPhone.spec.ts

@@ -103,7 +103,7 @@ test.describe('severity-1 #smoke', () => {
       await settings.disconnectTotp();
     });
 
-    test('can sign-in settings with recovery phone', async ({
+    test('can sign-in to settings with recovery phone', async ({
       target,
       pages: {
         page,

packages/fxa-auth-server/config/index.ts

@@ -2196,7 +2196,7 @@ const convictConf = convict({
         format: Array,
       },
       maxMessageLength: {
-        default: 60,
+        default: 160,
         doc: 'Max allows sms message length',
         env: 'RECOVERY_PHONE__SMS__MAX_MESSAGE_LENGTH',
         format: Number,

packages/fxa-auth-server/lib/l10n/index.ts

@@ -7,9 +7,16 @@ import { FluentBundle, FluentResource } from '@fluent/bundle';
 import { determineLocale, parseAcceptLanguage } from '@fxa/shared/l10n';
 import { ILocalizerBindings } from './interfaces/ILocalizerBindings';
 
+/**
+ * Represents a Fluent (FTL) message
+ * @param id - unique identifier for the message
+ * @param message - a fallback message in case the localized string cannot be found
+ * @param vars - optional arguments to be interpolated into the localized string
+ */
 export interface FtlIdMsg {
   id: string;
   message: string;
+  vars?: Record<string, string>;
 }
 
 interface LocalizedStrings {
@@ -118,11 +125,11 @@ class Localizer {
 
     const localizedFtlIdMsgs = await Promise.all(
       ftlIdMsgs.map(async (ftlIdMsg) => {
-        const { id, message } = ftlIdMsg;
+        const { id, message, vars } = ftlIdMsg;
         let localizedMessage;
         try {
-          localizedMessage = (await l10n.formatValue(id, message)) || message;
-        } catch {
+          localizedMessage = (await l10n.formatValue(id, vars)) || message;
+        } catch (e) {
           localizedMessage = message;
         }
         return Promise.resolve({

packages/fxa-auth-server/lib/l10n/server.ftl

@@ -2,3 +2,15 @@
 
 session-verify-send-push-title-2 = Logging in to your { -product-mozilla-account }?
 session-verify-send-push-body-2 = Click here to confirm it’s you
+
+# Message sent by SMS with limited character length, please test translation with the messaging segment calculator
+# https://twiliodeved.github.io/message-segment-calculator/
+# Messages should be limited to one segment
+# $code  - 6 digit code used to verify phone ownership when registering a recovery phone
+recovery-phone-setup-sms-body = { $code } is your { -brand-mozilla } verification code. Expires in 5 minutes.
+
+# Message sent by SMS with limited character length, please test translation with the messaging segment calculator
+# https://twiliodeved.github.io/message-segment-calculator/
+# Messages should be limited to one segment
+# $code  - 6 digit code used to sign in with a recovery phone as backup for two-step authentication
+recovery-phone-signin-sms-body = { $code } is your { -brand-mozilla } recovery code. Expires in 5 minutes.