Fix a bug where phone multi factor id is not correctly retrieved (#10061)

Author: chuanr

FirebaseAuth/Sources/Backend/RPC/Proto/FIRAuthProtoMFAEnrollment.h

@@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface FIRAuthProtoMFAEnrollment : NSObject <FIRAuthProto>
 
-@property(nonatomic, copy, readonly, nullable) NSString *MFAValue;
+@property(nonatomic, copy, readonly, nullable) NSString *phoneInfo;
 
 @property(nonatomic, copy, readonly, nullable) NSString *MFAEnrollmentID;
 

FirebaseAuth/Sources/Backend/RPC/Proto/FIRAuthProtoMFAEnrollment.m

@@ -24,7 +24,7 @@ - (instancetype)initWithDictionary:(NSDictionary *)dictionary {
   self = [super init];
   if (self) {
     if (dictionary[@"phoneInfo"]) {
-      _MFAValue = dictionary[@"phoneInfo"];
+      _phoneInfo = dictionary[@"phoneInfo"];
     }
     _MFAEnrollmentID = dictionary[@"mfaEnrollmentId"];
     _displayName = dictionary[@"displayName"];

FirebaseAuth/Sources/MultiFactor/FIRMultiFactor.m

@@ -32,6 +32,8 @@
 
 #import "FirebaseAuth/Sources/AuthProvider/Phone/FIRPhoneAuthCredential_Internal.h"
 #import "FirebaseAuth/Sources/MultiFactor/Phone/FIRPhoneMultiFactorAssertion+Internal.h"
+#import "FirebaseAuth/Sources/MultiFactor/Phone/FIRPhoneMultiFactorInfo+Internal.h"
+
 #endif
 
 NS_ASSUME_NONNULL_BEGIN
@@ -155,9 +157,11 @@ - (instancetype)initWithMFAEnrollments:(NSArray<FIRAuthProtoMFAEnrollment *> *)M
   if (self) {
     NSMutableArray<FIRMultiFactorInfo *> *multiFactorInfoArray = [[NSMutableArray alloc] init];
     for (FIRAuthProtoMFAEnrollment *MFAEnrollment in MFAEnrollments) {
-      FIRMultiFactorInfo *multiFactorInfo =
-          [[FIRMultiFactorInfo alloc] initWithProto:MFAEnrollment];
-      [multiFactorInfoArray addObject:multiFactorInfo];
+      if (MFAEnrollment.phoneInfo) {
+        FIRMultiFactorInfo *multiFactorInfo =
+            [[FIRPhoneMultiFactorInfo alloc] initWithProto:MFAEnrollment];
+        [multiFactorInfoArray addObject:multiFactorInfo];
+      }
     }
     _enrolledFactors = [multiFactorInfoArray copy];
   }

FirebaseAuth/Sources/MultiFactor/FIRMultiFactorConstants.m

@@ -21,6 +21,6 @@
 
 #pragma mark - Multi Factor ID constants
 
-NSString *const FIRPhoneMultiFactorID = @"1";
+NSString *const FIRPhoneMultiFactorID = @"phone";
 
 #endif

FirebaseAuth/Sources/MultiFactor/Phone/FIRPhoneMultiFactorInfo.m

@@ -31,7 +31,7 @@ - (instancetype)initWithProto:(FIRAuthProtoMFAEnrollment *)proto {
   self = [super initWithProto:proto];
   if (self) {
     _factorID = FIRPhoneMultiFactorID;
-    _phoneNumber = proto.MFAValue;
+    _phoneNumber = proto.phoneInfo;
   }
   return self;
 }

FirebaseAuth/Tests/Unit/FIRUserTests.m

@@ -363,6 +363,26 @@
  */
 static const NSTimeInterval kExpectationTimeout = 2;
 
+/** @var kPhoneInfo
+    @brief The mock multi factor phone info.
+ */
+static NSString *const kPhoneInfo = @"+15555555555";
+
+/** @var kEnrollmentID
+    @brief The mock multi factor enrollment ID.
+ */
+static NSString *const kEnrollmentID = @"mockEnrollmentID";
+
+/** @var kDisplayName
+    @brief The mock multi factor display name.
+ */
+static NSString *const kDisplayName = @"mockDisplayName";
+
+/** @var kEnrolledAt
+    @brief The mock multi factor enroll at date.
+ */
+static NSString *const kEnrolledAt = @"2022-08-01T18:31:15.426458Z";
+
 /** @extention FIRSecureTokenService
     @brief Extends the FIRSecureTokenService class to expose one private method for testing only.
  */
@@ -464,6 +484,13 @@ - (void)testUserPropertiesAndNSSecureCoding {
   ];
   OCMStub([mockGetAccountInfoResponseUser providerUserInfo]).andReturn(providerUserInfos);
   OCMStub([mockGetAccountInfoResponseUser passwordHash]).andReturn(kPasswordHash);
+  FIRAuthProtoMFAEnrollment *enrollment = [[FIRAuthProtoMFAEnrollment alloc] initWithDictionary:@{
+    @"phoneInfo" : kPhoneInfo,
+    @"mfaEnrollmentId" : kEnrollmentID,
+    @"displayName" : kDisplayName,
+    @"enrolledAt" : kEnrolledAt
+  }];
+  OCMStub([mockGetAccountInfoResponseUser MFAEnrollments]).andReturn(@[ enrollment ]);
 
   XCTestExpectation *expectation = [self expectationWithDescription:@"callback"];
   [self
@@ -640,8 +667,27 @@ - (void)testUserPropertiesAndNSSecureCoding {
                                              XCTAssertEqualObjects(
                                                  unarchivedPhoneUserInfo.phoneNumber,
                                                  phoneUserInfo.phoneNumber);
-#endif
 
+                                             // Verify FIRMultiFactorInfo properties.
+                                             XCTAssertEqualObjects(
+                                                 user.multiFactor.enrolledFactors[0].factorID,
+                                                 FIRPhoneMultiFactorID);
+                                             XCTAssertEqualObjects(
+                                                 user.multiFactor.enrolledFactors[0].UID,
+                                                 kEnrollmentID);
+                                             XCTAssertEqualObjects(
+                                                 user.multiFactor.enrolledFactors[0].displayName,
+                                                 kDisplayName);
+                                             NSDateFormatter *dateFormatter =
+                                                 [[NSDateFormatter alloc] init];
+                                             [dateFormatter
+                                                 setDateFormat:@"yyyy-MM-dd'T'HH:mm:ss.SSSZ"];
+                                             NSDate *date =
+                                                 [dateFormatter dateFromString:kEnrolledAt];
+                                             XCTAssertEqualObjects(
+                                                 user.multiFactor.enrolledFactors[0].enrollmentDate,
+                                                 date);
+#endif
                                              [expectation fulfill];
                                            }];
   [self waitForExpectationsWithTimeout:kExpectationTimeout handler:nil];