Merge pull request #405 from firebase/fix-reason-parameter

Fix reason parameter

Author: Ivan164

Example/Auth/Tests/FIRPhoneAuthProviderTests.m

@@ -162,6 +162,16 @@
     "0invalid%2520or%2520does%2520not%2520match%2520the%2520specified%2520API%2520key.%2522%257D%26"
     "authType%3DverifyApp";
 
+/** @var kFakeRedirectURLStringUnstructuredError
+    @brief The format for a fake redirect URL string with unstructured error response.
+ */
+static NSString *const kFakeRedirectURLStringUnstructuredError = @"com.googleusercontent.apps.1"
+    "23456://firebaseauth/link?deep_link_id=https%3A%2F%2Fexample.firebaseapp.com%2F__%2Fauth%2Fcal"
+    "lback%3FfirebaseError%3D%257B%2522unstructuredcode%2522%253A%2522auth%252Funknown-error-id%2522%252"
+    "C%2522unstructuredmessage%2522%253A%2522The%2520OAuth%2520client%2520ID%2520provided%2520is%2520either%252"
+    "0invalid%2520or%2520does%2520not%2520match%2520the%2520specified%2520API%2520key.%2522%257D%26"
+    "authType%3DverifyApp";
+
 /** @var kTestTimeout
     @brief A fake timeout value for waiting for push notification.
  */
@@ -721,6 +731,69 @@ - (void)testVerifyPhoneNumberUIDelegateUnexpectedError {
   OCMVerifyAll(_mockNotificationManager);
 }
 
+/** @fn testVerifyPhoneNumberUIDelegateUnstructuredError
+    @brief Tests a invocation of @c verifyPhoneNumber:UIDelegate:completion: which results in an error being surfaced due to an unexpected structure of the error response.
+ */
+- (void)testVerifyPhoneNumberUIDelegateUnstructuredError {
+  id mockBundle = OCMClassMock([NSBundle class]);
+  OCMStub(ClassMethod([mockBundle mainBundle])).andReturn(mockBundle);
+  OCMStub([mockBundle objectForInfoDictionaryKey:@"CFBundleURLTypes"])
+  .andReturn(@[ @{ @"CFBundleURLSchemes" : @[ kFakeReverseClientID ] } ]);
+  OCMStub([mockBundle bundleIdentifier]).andReturn(kFakeBundleID);
+
+  // Simulate missing app token error.
+  OCMExpect([_mockNotificationManager checkNotificationForwardingWithCallback:OCMOCK_ANY])
+  .andCallBlock1(^(FIRAuthNotificationForwardingCallback callback) { callback(YES); });
+  OCMExpect([_mockAppCredentialManager credential]).andReturn(nil);
+  OCMExpect([_mockAPNSTokenManager getTokenWithCallback:OCMOCK_ANY])
+  .andCallBlock1(^(FIRAuthAPNSTokenCallback callback) {
+    NSError *error = [NSError errorWithDomain:FIRAuthErrorDomain
+                                         code:FIRAuthErrorCodeMissingAppToken
+                                     userInfo:nil];
+    callback(nil, error);
+  });
+  OCMExpect([_mockBackend getProjectConfig:[OCMArg any] callback:[OCMArg any]])
+  .andCallBlock2(^(FIRGetProjectConfigRequest *request,
+                   FIRGetProjectConfigResponseCallback callback) {
+    XCTAssertNotNil(request);
+    dispatch_async(FIRAuthGlobalWorkQueue(), ^() {
+      id mockGetProjectConfigResponse = OCMClassMock([FIRGetProjectConfigResponse class]);
+      OCMStub([mockGetProjectConfigResponse authorizedDomains]).
+      andReturn(@[ kFakeAuthorizedDomain]);
+      callback(mockGetProjectConfigResponse, nil);
+    });
+  });
+  id mockUIDelegate = OCMProtocolMock(@protocol(FIRAuthUIDelegate));
+
+  // Expect view controller presentation by UIDelegate.
+  OCMExpect([_mockURLPresenter presentURL:OCMOCK_ANY
+                               UIDelegate:mockUIDelegate
+                          callbackMatcher:OCMOCK_ANY
+                               completion:OCMOCK_ANY]).andDo(^(NSInvocation *invocation) {
+    __unsafe_unretained id unretainedArgument;
+    // Indices 0 and 1 indicate the hidden arguments self and _cmd.
+    // `completion` is at index 5
+    [invocation getArgument:&unretainedArgument atIndex:5];
+    FIRAuthURLPresentationCompletion completion = unretainedArgument;
+    dispatch_async(FIRAuthGlobalWorkQueue(), ^() {
+      completion([NSURL URLWithString:kFakeRedirectURLStringUnstructuredError], nil);
+    });
+  });
+
+  XCTestExpectation *expectation = [self expectationWithDescription:@"callback"];
+  [_provider verifyPhoneNumber:kTestPhoneNumber
+                    UIDelegate:mockUIDelegate
+                    completion:^(NSString *_Nullable verificationID, NSError *_Nullable error) {
+                      XCTAssertTrue([NSThread isMainThread]);
+                      XCTAssertEqual(error.code, FIRAuthErrorCodeAppVerificationUserInteractionFailure);
+                      XCTAssertNil(verificationID);
+                      [expectation fulfill];
+                    }];
+  [self waitForExpectationsWithTimeout:kExpectationTimeout handler:nil];
+  OCMVerifyAll(_mockBackend);
+  OCMVerifyAll(_mockNotificationManager);
+}
+
 /** @fn testVerifyPhoneNumberUIDelegateRaiseException
     @brief Tests a invocation of @c verifyPhoneNumber:UIDelegate:completion: which results in an
         exception.

Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.m

@@ -266,6 +266,9 @@ - (NSString *)reCAPTCHATokenForURL:(NSURL *)URL error:(NSError **)error {
     NSString *reason;
     if(errorDict[@"code"] && errorDict[@"message"]) {
       reason = [NSString stringWithFormat:@"[%@] - %@",errorDict[@"code"], errorDict[@"message"]];
+    } else {
+      reason = [NSString stringWithFormat:@"An unknown error occurred with the following "
+          "response: %@", deepLinkURL];
     }
     *error = [FIRAuthErrorUtils appVerificationUserInteractionFailureWithReason:reason];
   }

Firebase/Auth/Source/FIRAuthErrorUtils.h

@@ -472,7 +472,7 @@ NS_ASSUME_NONNULL_BEGIN
     @param reason Reason for error, returned via URL response.
     @return The NSError instance associated with the given FIRAuthError.
  */
-+ (NSError *)appVerificationUserInteractionFailureWithReason:(nullable NSString *)reason;
++ (NSError *)appVerificationUserInteractionFailureWithReason:(NSString *)reason;
 
 /** @fn URLResponseErrorWithCode:message:
     @brief Constructs an @c NSError with the code and message provided.

Firebase/Auth/Source/FIRAuthErrorUtils.m

@@ -961,7 +961,7 @@ + (NSError *)webContextCancelledErrorWithMessage:(nullable NSString *)message {
   return [self errorWithCode:FIRAuthInternalErrorCodeWebContextCancelled message:message];
 }
 
-+ (NSError *)appVerificationUserInteractionFailureWithReason:(nullable NSString *)reason {
++ (NSError *)appVerificationUserInteractionFailureWithReason:(NSString *)reason {
   return [self errorWithCode:FIRAuthInternalErrorCodeAppVerificationUserInteractionFailure
                     userInfo:@{
     NSLocalizedFailureReasonErrorKey : reason