[iOS] Fix EarlGrey deadlock due to unfinished animation.

Currently we only stop the activity indicator spinning animation when
the user presses 'Cancel' on the user sign-in screen. This otherwise
infinite animation causes deadlocks in EarlGrey during the
authentication flow.

We move all activity indicator handling to the user sign-in delegate.

Bug: 1005509
Change-Id: Ia775ab32346d8b67ef4842d5952a250d3208a11c
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2144014Reviewed-by: Jérôme Lebel <jlebel@chromium.org>
Reviewed-by: Nohemi Fernandez <fernandex@chromium.org>
Commit-Queue: Nohemi Fernandez <fernandex@chromium.org>
Cr-Commit-Position: refs/heads/master@{#760459}

ios/chrome/browser/ui/authentication/authentication_flow.h

@@ -16,6 +16,17 @@ class Browser;
 @class ChromeIdentity;
 @class UIViewController;
 
+// Handles completion of AuthenticationFlow operations.
+@protocol AuthenticationFlowDelegate <NSObject>
+
+// Indicates that a user dialog is presented from the authentication flow.
+- (void)didPresentDialog;
+
+// Indicates that a user dialog is dismissed from the authentication flow.
+- (void)didDismissDialog;
+
+@end
+
 // |AuthenticationFlow| manages the authentication flow for a given identity.
 //
 // A new instance of |AuthenticationFlow| should be used each time an identity
@@ -59,6 +70,9 @@ class Browser;
 // The dispatcher used to clear browsing data.
 @property(nonatomic, weak) id<BrowsingDataCommands> dispatcher;
 
+// The delegate.
+@property(nonatomic, weak) id<AuthenticationFlowDelegate> delegate;
+
 @end
 
 // Private methods in AuthenticationFlow to test.

ios/chrome/browser/ui/authentication/authentication_flow.mm

@@ -4,6 +4,7 @@
 
 #import "ios/chrome/browser/ui/authentication/authentication_flow.h"
 
+#import "base/ios/block_types.h"
 #include "base/logging.h"
 #include "ios/chrome/browser/browser_state/chrome_browser_state.h"
 #include "ios/chrome/browser/main/browser.h"
@@ -408,6 +409,7 @@ NSError* IdentityMissingError() {
   DCHECK_NE(SHOULD_CLEAR_DATA_USER_CHOICE, shouldClearData);
   _shouldSignOut = YES;
   _shouldClearData = shouldClearData;
+
   [self continueSignin];
 }
 
@@ -443,8 +445,28 @@ NSError* IdentityMissingError() {
   [self cancelFlow];
 }
 
-- (UIViewController*)presentingViewController {
-  return _presentingViewController;
+- (void)dismissPresentingViewControllerAnimated:(BOOL)animated
+                                     completion:(ProceduralBlock)completion {
+  [_presentingViewController dismissViewControllerAnimated:animated
+                                                completion:^() {
+                                                  [_delegate didDismissDialog];
+                                                  if (completion) {
+                                                    completion();
+                                                  }
+                                                }];
+}
+
+- (void)presentViewController:(UIViewController*)viewController
+                     animated:(BOOL)animated
+                   completion:(ProceduralBlock)completion {
+  [_presentingViewController presentViewController:viewController
+                                          animated:animated
+                                        completion:^() {
+                                          [_delegate didPresentDialog];
+                                          if (completion) {
+                                            completion();
+                                          }
+                                        }];
 }
 
 #pragma mark - Used for testing

ios/chrome/browser/ui/authentication/authentication_flow_performer.mm

@@ -96,8 +96,7 @@ const int64_t kAuthenticationFlowTimeoutSeconds = 10;
   if (_navigationController) {
     [_navigationController cleanUpSettings];
     _navigationController = nil;
-    [[_delegate presentingViewController] dismissViewControllerAnimated:NO
-                                                             completion:nil];
+    [_delegate dismissPresentingViewControllerAnimated:NO completion:nil];
   }
   [self stopWatchdogTimer];
 }
@@ -282,10 +281,9 @@ const int64_t kAuthenticationFlowTimeoutSeconds = 10;
                            fromEmail:lastSignedInEmail
                              toEmail:[identity userEmail]
                           isSignedIn:isSignedIn];
-  [[_delegate presentingViewController]
-      presentViewController:_navigationController
-                   animated:YES
-                 completion:nil];
+  [_delegate presentViewController:_navigationController
+                          animated:YES
+                        completion:nil];
 }
 
 - (void)clearDataFromBrowser:(Browser*)browser
@@ -465,8 +463,7 @@ const int64_t kAuthenticationFlowTimeoutSeconds = 10;
     [[strongSelf delegate] didChooseClearDataPolicy:shouldClearData];
   };
   [_navigationController cleanUpSettings];
-  [[_delegate presentingViewController] dismissViewControllerAnimated:YES
-                                                           completion:block];
+  [_delegate dismissPresentingViewControllerAnimated:YES completion:block];
 }
 
 #pragma mark - SettingsNavigationControllerDelegate
@@ -483,8 +480,7 @@ const int64_t kAuthenticationFlowTimeoutSeconds = 10;
     [[strongSelf delegate] didChooseCancel];
   };
   [_navigationController cleanUpSettings];
-  [[_delegate presentingViewController] dismissViewControllerAnimated:YES
-                                                           completion:block];
+  [_delegate dismissPresentingViewControllerAnimated:YES completion:block];
 }
 
 - (void)settingsWasDismissed {

ios/chrome/browser/ui/authentication/authentication_flow_performer_delegate.h

@@ -7,6 +7,7 @@
 
 #import <Foundation/Foundation.h>
 
+#import "base/ios/block_types.h"
 #include "ios/chrome/browser/signin/constants.h"
 
 @class UIViewController;
@@ -38,8 +39,14 @@
 // Indicates that the user cancelled signing in to a managed account.
 - (void)didCancelManagedConfirmation;
 
-// The view controller that is showing the sign-in flow.
-@property(readonly) UIViewController* presentingViewController;
+// Dismisses the view controller that is showing the sign-in flow.
+- (void)dismissPresentingViewControllerAnimated:(BOOL)animated
+                                     completion:(ProceduralBlock)completion;
+
+// Presents a view controller on the sign-in flow.
+- (void)presentViewController:(UIViewController*)viewController
+                     animated:(BOOL)animated
+                   completion:(ProceduralBlock)completion;
 
 @end
 

ios/chrome/browser/ui/authentication/signin/user_signin/user_signin_coordinator.mm

@@ -494,6 +494,7 @@ const CGFloat kFadeOutAnimationDuration = 0.16f;
       presentingViewController:self.viewController];
   authenticationFlow.dispatcher = HandlerForProtocol(
       self.browser->GetCommandDispatcher(), BrowsingDataCommands);
+  authenticationFlow.delegate = self.viewController;
 
   [self.mediator
       authenticateWithIdentity:self.unifiedConsentCoordinator.selectedIdentity

ios/chrome/browser/ui/authentication/signin/user_signin/user_signin_view_controller.h

@@ -7,6 +7,8 @@
 
 #import <UIKit/UIKit.h>
 
+#import "ios/chrome/browser/ui/authentication/authentication_flow.h"
+
 // Delegate that interacts with the user sign-in coordinator.
 @protocol UserSigninViewControllerDelegate
 
@@ -29,7 +31,8 @@
 @end
 
 // View controller used to show sign-in UI.
-@interface UserSigninViewController : UIViewController
+@interface UserSigninViewController
+    : UIViewController <AuthenticationFlowDelegate>
 
 // The delegate.
 @property(nonatomic, weak) id<UserSigninViewControllerDelegate> delegate;

ios/chrome/browser/ui/authentication/signin/user_signin/user_signin_view_controller.mm

@@ -142,6 +142,16 @@ enum AuthenticationButtonType {
                        : UIInterfaceOrientationMaskPortrait;
 }
 
+#pragma mark - AuthenticationFlowDelegate
+
+- (void)didPresentDialog {
+  [self.activityIndicator stopAnimating];
+}
+
+- (void)didDismissDialog {
+  [self.activityIndicator startAnimating];
+}
+
 #pragma mark - MDCActivityIndicator
 
 - (void)startAnimatingActivityIndicator {