[auth-swift] VerifyPhoneNumber RPC (#10897)

Author: paulb777

FirebaseAuth/Sources/Auth/FIRAuth.m

@@ -970,7 +970,7 @@ - (void)internalSignInAndRetrieveDataWithCredential:(FIRAuthCredential *)credent
                              }
 
                              [self
-                                 completeSignInWithAccessToken:response.IDToken
+                                 completeSignInWithAccessToken:response.idToken
                                      accessTokenExpirationDate:response.approximateExpirationDate
                                                   refreshToken:response.refreshToken
                                                      anonymous:NO
@@ -1633,7 +1633,7 @@ - (void)signInWithPhoneCredential:(FIRPhoneAuthCredential *)credential
                                                         phoneNumber:credential.phoneNumber
                                                           operation:operation
                                                requestConfiguration:_requestConfiguration];
-    [FIRAuthBackend verifyPhoneNumber:request callback:callback];
+    [FIRAuthBackend2 postWithRequest:request callback:callback];
     return;
   }
 
@@ -1650,7 +1650,7 @@ - (void)signInWithPhoneCredential:(FIRPhoneAuthCredential *)credential
                                                  verificationCode:credential.verificationCode
                                                         operation:operation
                                              requestConfiguration:_requestConfiguration];
-  [FIRAuthBackend verifyPhoneNumber:request callback:callback];
+  [FIRAuthBackend2 postWithRequest:request callback:callback];
 }
 
 #endif

FirebaseAuth/Sources/Backend/FIRAuthBackend.h

@@ -19,7 +19,6 @@
 @protocol FIRAuthRPCRequest;
 @protocol FIRAuthRPCResponse;
 @class FIRAuthRequestConfiguration;
-@class FIRVerifyPhoneNumberRequest;
 @class FIRVerifyPhoneNumberResponse;
 // TODO: FIRSignUpNewUserResponse Used in extra internal functions in FIRAuth.m
 @class FIRSignUpNewUserResponse;
@@ -38,12 +37,6 @@ NS_ASSUME_NONNULL_BEGIN
 typedef void (^FIRAuthBackendRPCIssuerCompletionHandler)(NSData *_Nullable data,
                                                          NSError *_Nullable error);
 
-/** @typedef FIRDeleteCallBack
-    @brief The type of block called when a request delete account has finished.
-    @param error The error which occurred, or nil if the request was successful.
- */
-typedef void (^FIRDeleteCallBack)(NSError *_Nullable error);
-
 /** @typedef FIRSignupNewUserCallback
     @brief The type of block used to return the result of a call to the signupNewUser endpoint.
     @param response The received response, if any.
@@ -96,17 +89,6 @@ typedef void (^FIRVerifyPhoneNumberResponseCallback)(
 + (void)setDefaultBackendImplementationWithRPCIssuer:
     (nullable id<FIRAuthBackendRPCIssuer>)RPCIssuer;
 
-#if TARGET_OS_IOS
-/** @fn verifyPhoneNumber:callback:
-    @brief Calls the verifyPhoneNumber endpoint, which is responsible for sending the verification
-        code to a phone number specified in the request parameters.
-    @param request The request parameters.
-    @param callback The callback.
- */
-+ (void)verifyPhoneNumber:(FIRVerifyPhoneNumberRequest *)request
-                 callback:(FIRVerifyPhoneNumberResponseCallback)callback;
-#endif
-
 @end
 
 /** @protocol FIRAuthBackendRPCIssuer
@@ -137,17 +119,6 @@ typedef void (^FIRVerifyPhoneNumberResponseCallback)(
  */
 @protocol FIRAuthBackendImplementation <NSObject>
 
-#if TARGET_OS_IOS
-/** @fn verifyPhoneNumber:callback:
-    @brief Calls the verifyPhoneNumber endpoint, which is responsible for sending the verification
-        code to a phone number specified in the request parameters.
-    @param request The request parameters.
-    @param callback The callback.
- */
-- (void)verifyPhoneNumber:(FIRVerifyPhoneNumberRequest *)request
-                 callback:(FIRVerifyPhoneNumberResponseCallback)callback;
-#endif
-
 /** @fn postWithRequest:response:callback:
     @brief Calls the RPC using HTTP POST.
     @remarks Possible error responses:

FirebaseAuth/Sources/Backend/FIRAuthBackend.m

@@ -486,13 +486,6 @@ + (void)setDefaultBackendImplementationWithRPCIssuer:
   gBackendImplementation = defaultImplementation;
 }
 
-#if TARGET_OS_IOS
-+ (void)verifyPhoneNumber:(FIRVerifyPhoneNumberRequest *)request
-                 callback:(FIRVerifyPhoneNumberResponseCallback)callback {
-  [[self implementation] verifyPhoneNumber:request callback:callback];
-}
-#endif
-
 + (NSString *)authUserAgent {
   return [NSString stringWithFormat:@"FirebaseAuth.iOS/%@ %@", FIRFirebaseVersion(),
                                     GTMFetcherStandardUserAgentString(nil)];
@@ -602,35 +595,6 @@ - (instancetype)init {
   return self;
 }
 
-#if TARGET_OS_IOS
-- (void)verifyPhoneNumber:(FIRVerifyPhoneNumberRequest *)request
-                 callback:(FIRVerifyPhoneNumberResponseCallback)callback {
-  FIRVerifyPhoneNumberResponse *response = [[FIRVerifyPhoneNumberResponse alloc] init];
-  [self
-      postWithRequest:request
-             response:response
-             callback:^(NSError *error) {
-               if (error) {
-                 callback(nil, error);
-                 return;
-               }
-               // Check whether or not the successful response is actually the special case phone
-               // auth flow that returns a temporary proof and phone number.
-               if (response.phoneNumber.length && response.temporaryProof.length) {
-                 FIRPhoneAuthCredential *credential = [[FIRPhoneAuthCredential alloc]
-                     initWithTemporaryProof:response.temporaryProof
-                                phoneNumber:response.phoneNumber
-                                 providerID:FIRPhoneAuthProvider.id];
-                 callback(nil, [FIRAuthErrorUtils credentialAlreadyInUseErrorWithMessage:nil
-                                                                              credential:credential
-                                                                                   email:nil]);
-                 return;
-               }
-               callback(response, nil);
-             }];
-}
-#endif
-
 #pragma mark - Generic RPC handling methods
 
 /** @fn postWithRequest:response:callback:

FirebaseAuth/Sources/Swift/Backend/AuthBackend.swift

@@ -175,6 +175,8 @@ private class AuthBackendRPCImplementation: NSObject, AuthBackendImplementation
         .generateMFAError(response: response,
                           auth: request.requestConfiguration().auth) {
         callback(nil, mfaError)
+      } else if let error = AuthBackendRPCImplementation.phoneCredentialInUse(response: response) {
+        callback(nil, error)
       } else {
         callback(response, nil)
       }
@@ -205,6 +207,31 @@ private class AuthBackendRPCImplementation: NSObject, AuthBackendImplementation
     }
   #endif
 
+  #if os(iOS)
+    // Check whether or not the successful response is actually the special case phone
+    // auth flow that returns a temporary proof and phone number.
+    private class func phoneCredentialInUse(response: AuthRPCResponse) -> Error? {
+      if let phoneAuthResponse = response as? VerifyPhoneNumberResponse,
+         let phoneNumber = phoneAuthResponse.phoneNumber,
+         phoneNumber.count > 0,
+         let temporaryProof = phoneAuthResponse.temporaryProof,
+         temporaryProof.count > 0 {
+        let credential = PhoneAuthCredential(withTemporaryProof: temporaryProof,
+                                             phoneNumber: phoneNumber,
+                                             providerID: PhoneAuthProvider.id)
+        return AuthErrorUtils.credentialAlreadyInUseError(message: nil,
+                                                          credential: credential,
+                                                          email: nil)
+      } else {
+        return nil
+      }
+    }
+  #else
+    private class func phoneCredentialInUse(response: AuthRPCResponse) -> Error? {
+      return nil
+    }
+  #endif
+
   /** @fn postWithRequest:response:callback:
       @brief Calls the RPC using HTTP POST.
       @remarks Possible error responses:
@@ -446,6 +473,12 @@ private class AuthBackendRPCImplementation: NSObject, AuthBackendImplementation
       .invalidAppCredential(message: serverDetailErrorMessage)
     case "MISSING_APP_CREDENTIAL": return AuthErrorUtils
       .missingAppCredential(message: serverDetailErrorMessage)
+    case "INVALID_CODE": return AuthErrorUtils
+      .invalidVerificationCodeError(message: serverDetailErrorMessage)
+    case "INVALID_SESSION_INFO": return AuthErrorUtils
+      .invalidVerificationIDError(message: serverDetailErrorMessage)
+    case "SESSION_EXPIRED": return AuthErrorUtils
+      .sessionExpiredError(message: serverDetailErrorMessage)
     case "FEDERATED_USER_ID_ALREADY_LINKED":
       guard let verifyAssertion = response as? VerifyAssertionResponse else {
         return AuthErrorUtils.credentialAlreadyInUseError(

FirebaseAuth/Sources/Swift/Backend/RPC/VerifyPhoneNumberResponse.swift

@@ -21,7 +21,7 @@ import Foundation
    access token from Secure Token Service, depending on whether @c returnSecureToken is set
    on the request.
    */
-  @objc public var IDToken: String?
+  @objc public var idToken: String?
 
   /** @property refreshToken
    @brief The refresh token from Secure Token Service.
@@ -60,7 +60,7 @@ import Foundation
   }
 
   public func setFields(dictionary: [String: Any]) throws {
-    IDToken = dictionary["idToken"] as? String
+    idToken = dictionary["idToken"] as? String
     refreshToken = dictionary["refreshToken"] as? String
     isNewUser = (dictionary["isNewUser"] as? Bool) ?? false
     localID = dictionary["localId"] as? String

FirebaseAuth/Sources/Swift/Utilities/AuthErrors.swift

@@ -47,7 +47,7 @@ import Foundation
    exists.
    */
   @objc(FIRAuthErrorUserInfoEmailKey)
-  public static var AuthErrorUserInfoEmailKey: String =
+  public static let AuthErrorUserInfoEmailKey: String =
     "FIRAuthErrorUserInfoEmailKey"
 
   /**
@@ -56,15 +56,15 @@ import Foundation
    recovery if applicable.
    */
   @objc(FIRAuthErrorUserInfoUpdatedCredentialKey)
-  public static var AuthErrorUserInfoUpdatedCredentialKey: String =
+  public static let AuthErrorUserInfoUpdatedCredentialKey: String =
     "FIRAuthErrorUserInfoUpdatedCredentialKey"
 
   /**
    @brief The key used to read the MFA resolver from the userInfo dictionary of the NSError object
    returned when 2FA is required for sign-incompletion.
    */
   @objc(FIRAuthErrorUserInfoMultiFactorResolverKey)
-  static var AuthErrorUserInfoMultiFactorResolverKey: String =
+  static let AuthErrorUserInfoMultiFactorResolverKey: String =
     "FIRAuthErrorUserInfoMultiFactorResolverKey"
 }
 

FirebaseAuth/Sources/User/FIRUser.m

@@ -688,39 +688,39 @@ - (void)internalUpdateOrLinkPhoneNumberCredential:(FIRPhoneAuthCredential *)phon
                      operation:operation
           requestConfiguration:self->_auth.requestConfiguration];
     request.accessToken = accessToken;
-    [FIRAuthBackend verifyPhoneNumber:request
-                             callback:^(FIRVerifyPhoneNumberResponse *_Nullable response,
-                                        NSError *_Nullable error) {
-                               if (error) {
-                                 [self signOutIfTokenIsInvalidWithError:error];
-                                 completion(error);
-                                 return;
-                               }
-                               FIRAuthRequestConfiguration *requestConfiguration =
-                                   self.auth.requestConfiguration;
-                               // Update the new token and refresh user info again.
-                               self->_tokenService = [[FIRSecureTokenService alloc]
-                                   initWithRequestConfiguration:requestConfiguration
-                                                    accessToken:response.IDToken
-                                      accessTokenExpirationDate:response.approximateExpirationDate
-                                                   refreshToken:response.refreshToken];
-                               // Get account info to update cached user info.
-                               [self getAccountInfoRefreshingCache:^(
-                                         FIRGetAccountInfoResponseUser *_Nullable user,
-                                         NSError *_Nullable error) {
-                                 if (error) {
-                                   [self signOutIfTokenIsInvalidWithError:error];
-                                   completion(error);
-                                   return;
-                                 }
-                                 self.anonymous = NO;
-                                 if (![self updateKeychain:&error]) {
-                                   completion(error);
-                                   return;
-                                 }
-                                 completion(nil);
-                               }];
-                             }];
+    [FIRAuthBackend2
+        postWithRequest:request
+               callback:^(FIRVerifyPhoneNumberResponse *_Nullable response,
+                          NSError *_Nullable error) {
+                 if (error) {
+                   [self signOutIfTokenIsInvalidWithError:error];
+                   completion(error);
+                   return;
+                 }
+                 FIRAuthRequestConfiguration *requestConfiguration = self.auth.requestConfiguration;
+                 // Update the new token and refresh user info again.
+                 self->_tokenService = [[FIRSecureTokenService alloc]
+                     initWithRequestConfiguration:requestConfiguration
+                                      accessToken:response.idToken
+                        accessTokenExpirationDate:response.approximateExpirationDate
+                                     refreshToken:response.refreshToken];
+                 // Get account info to update cached user info.
+                 [self
+                     getAccountInfoRefreshingCache:^(FIRGetAccountInfoResponseUser *_Nullable user,
+                                                     NSError *_Nullable error) {
+                       if (error) {
+                         [self signOutIfTokenIsInvalidWithError:error];
+                         completion(error);
+                         return;
+                       }
+                       self.anonymous = NO;
+                       if (![self updateKeychain:&error]) {
+                         completion(error);
+                         return;
+                       }
+                       completion(nil);
+                     }];
+               }];
   }];
 }