Merge pull request #18339 from mozilla/FXA-11055

task(recovery-phone): Handle error retrieveving Twilio lookup

Author: dschom

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

@@ -8,6 +8,7 @@ import {
   testAccountDatabaseSetup,
 } from '@fxa/shared/db/mysql/account';
 import { Test } from '@nestjs/testing';
+import { RecoveryPhoneFactory } from '@fxa/shared/db/mysql/account';
 
 describe('RecoveryPhoneManager', () => {
   let recoveryPhoneManager: RecoveryPhoneManager;

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

@@ -14,12 +14,16 @@ import {
   RecoveryPhoneNotEnabled,
   RecoveryNumberRemoveMissingBackupCodes,
 } from './recovery-phone.errors';
+import { LOGGER_PROVIDER } from '@fxa/shared/log';
 
 describe('RecoveryPhoneService', () => {
   const phoneNumber = '+15005551234';
   const uid = '0123456789abcdef0123456789abcdef';
   const code = '000000';
 
+  const mockLogger = {
+    error: jest.fn(),
+  };
   const mockSmsManager = {
     sendSMS: jest.fn(),
     phoneNumberLookup: jest.fn(),
@@ -60,6 +64,10 @@ describe('RecoveryPhoneService', () => {
           provide: RecoveryPhoneConfig,
           useValue: mockRecoveryPhoneConfig,
         },
+        {
+          provide: LOGGER_PROVIDER,
+          useValue: mockLogger,
+        },
         RecoveryPhoneService,
       ],
     }).compile();
@@ -216,6 +224,18 @@ describe('RecoveryPhoneService', () => {
       expect(mockRecoveryPhoneManager.getUnconfirmed).toBeCalledWith(uid, code);
     });
 
+    it('can handled failed lookup by throwing PhoneNumberNotSupported error', async () => {
+      mockRecoveryPhoneManager.getUnconfirmed.mockReturnValue({
+        isSetup: true,
+      });
+      mockSmsManager.phoneNumberLookup.mockRejectedValueOnce(new Error('BOOM'));
+
+      const promise = service.confirmSetupCode(uid, code);
+
+      await expect(promise).rejects.toThrow(/Phone number not supported.*/);
+      expect(mockLogger.error).toBeCalledTimes(1);
+    });
+
     it('will not confirm a valid sms code for signin', async () => {
       mockRecoveryPhoneManager.getUnconfirmed.mockReturnValue({});
 

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

@@ -2,26 +2,31 @@
  * 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 { Injectable } from '@nestjs/common';
+import { Inject, Injectable, LoggerService } from '@nestjs/common';
 import { SmsManager } from './sms.manager';
 import { OtpManager } from '@fxa/shared/otp';
 import { RecoveryPhoneConfig } from './recovery-phone.service.config';
-import { RecoveryPhoneManager } from './recovery-phone.manager';
+import {
+  PhoneNumberLookupData,
+  RecoveryPhoneManager,
+} from './recovery-phone.manager';
 import {
   RecoveryNumberNotExistsError,
   RecoveryNumberNotSupportedError,
   RecoveryPhoneNotEnabled,
   RecoveryNumberRemoveMissingBackupCodes,
 } from './recovery-phone.errors';
 import { MessageInstance } from 'twilio/lib/rest/api/v2010/account/message';
+import { LOGGER_PROVIDER } from '@fxa/shared/log';
 
 @Injectable()
 export class RecoveryPhoneService {
   constructor(
     private readonly recoveryPhoneManager: RecoveryPhoneManager,
     private readonly smsManager: SmsManager,
     private readonly otpCode: OtpManager,
-    private readonly config: RecoveryPhoneConfig
+    private readonly config: RecoveryPhoneConfig,
+    @Inject(LOGGER_PROVIDER) private readonly log?: LoggerService
   ) {}
 
   /**
@@ -125,9 +130,16 @@ export class RecoveryPhoneService {
     }
 
     // If this was for a setup operation. Register the phone number to the uid.
-    const lookupData = await this.smsManager.phoneNumberLookup(
-      data.phoneNumber
-    );
+    const lookupData: PhoneNumberLookupData = await (async () => {
+      try {
+        return await this.smsManager.phoneNumberLookup(data.phoneNumber);
+      } catch (error) {
+        this.log?.error('RecoveryPhoneService.confirmSetupCode', error);
+
+        throw new RecoveryNumberNotSupportedError(data.phoneNumber, error);
+      }
+    })();
+
     await this.recoveryPhoneManager.registerPhoneNumber(
       uid,
       data.phoneNumber,

libs/shared/db/mysql/account/src/index.ts

@@ -9,6 +9,7 @@ export {
   AccountFactory,
   AccountCustomerFactory,
   PaypalCustomerFactory,
+  RecoveryPhoneFactory,
 } from './lib/factories';
 export { setupAccountDatabase, AccountDbProvider } from './lib/setup';
 export { testAccountDatabaseSetup } from './lib/tests';

packages/fxa-auth-server/bin/key_server.js

@@ -245,7 +245,8 @@ async function run(config) {
     recoveryPhoneManager,
     smsManager,
     otpCodeManager,
-    config.recoveryPhone
+    config.recoveryPhone,
+    log
   );
   Container.set(RecoveryPhoneService, recoveryPhoneService);