[iOS][multiball] Move signinInteractionCoordinator to SceneController.

Reparents signinInteractionCooordinator and cleans up guts interfaces.

Note the new method in SceneControllerGuts that allows MC to cleanup
a SC before shutdown. I think this is fine at least temporarily, but
we need to iron out how this happens in iOS 12 compat in the future.

Bug: none
Change-Id: Ie214b60b830548f1aaec56207298cdf6ba6ddd3e
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2007051
Commit-Queue: Stepan Khapugin <stkhapugin@chromium.org>
Reviewed-by: Mark Cogan <marq@chromium.org>
Cr-Commit-Position: refs/heads/master@{#733427}

ios/chrome/app/BUILD.gn

@@ -228,7 +228,6 @@ source_set("app_internal") {
     "//ios/chrome/browser/ui/settings",
     "//ios/chrome/browser/ui/settings:settings_root",
     "//ios/chrome/browser/ui/settings/google_services",
-    "//ios/chrome/browser/ui/signin_interaction",
     "//ios/chrome/browser/ui/tab_grid",
     "//ios/chrome/browser/ui/tab_grid:tab_grid_ui",
     "//ios/chrome/browser/ui/table_view",

ios/chrome/app/main_controller.mm

@@ -123,7 +123,6 @@
 #import "ios/chrome/browser/ui/main/scene_controller_guts.h"
 #import "ios/chrome/browser/ui/promos/signin_promo_view_controller.h"
 #import "ios/chrome/browser/ui/settings/settings_navigation_controller.h"
-#import "ios/chrome/browser/ui/signin_interaction/signin_interaction_coordinator.h"
 #include "ios/chrome/browser/ui/tab_grid/tab_grid_coordinator.h"
 #import "ios/chrome/browser/ui/tab_grid/tab_switcher.h"
 #import "ios/chrome/browser/ui/tab_grid/view_controller_swapping.h"
@@ -431,7 +430,6 @@ void MainControllerAuthenticationServiceDelegate::ClearBrowsingData(
 @synthesize appURLLoadingService;
 @synthesize isProcessingTabSwitcherCommand;
 @synthesize isProcessingVoiceSearchCommand;
-@synthesize signinInteractionCoordinator;
 @synthesize dismissingTabSwitcher = _dismissingTabSwitcher;
 @synthesize restoreHelper = _restoreHelper;
 
@@ -756,11 +754,6 @@ void MainControllerAuthenticationServiceDelegate::ClearBrowsingData(
   return [[PreviousSessionInfo sharedInstance] isFirstSessionAfterUpgrade];
 }
 
-- (BOOL)isSettingsViewPresented {
-  return [self.sceneController hasSettingsNavigationController] ||
-         self.signinInteractionCoordinator.isSettingsViewPresented;
-}
-
 #pragma mark - StartupInformation implementation.
 
 - (FirstUserActionRecorder*)firstUserActionRecorder {
@@ -784,9 +777,8 @@ void MainControllerAuthenticationServiceDelegate::ClearBrowsingData(
 }
 
 - (void)stopChromeMain {
-  // The UI should be stopped before the models they observe are stopped.
-  [self.signinInteractionCoordinator cancel];
-  self.signinInteractionCoordinator = nil;
+  // Teardown UI state that is associated with scenes.
+  [self.sceneController teardownUI];
 
   [_mainCoordinator stop];
   _mainCoordinator = nil;

ios/chrome/app/main_controller_guts.h

@@ -18,7 +18,6 @@
 @class BrowserViewController;
 @class BrowserViewWrangler;
 @class HistoryCoordinator;
-@class SigninInteractionCoordinator;
 @class TabGridCoordinator;
 @protocol BrowserInterfaceProvider;
 @protocol TabSwitcher;
@@ -56,11 +55,6 @@ enum class TabSwitcherDismissalMode { NONE, NORMAL, INCOGNITO };
 // exclusive chrome commands sent at nearly the same time.
 @property(nonatomic, assign) BOOL isProcessingTabSwitcherCommand;
 @property(nonatomic, assign) BOOL isProcessingVoiceSearchCommand;
-// The SigninInteractionCoordinator to present Sign In UI. It is created the
-// first time Sign In UI is needed to be presented and should not be destroyed
-// while the UI is presented.
-@property(nonatomic, strong)
-    SigninInteractionCoordinator* signinInteractionCoordinator;
 
 // If YES, the tab switcher is currently active.
 @property(nonatomic, assign, getter=isTabSwitcherActive)
@@ -69,11 +63,6 @@ enum class TabSwitcherDismissalMode { NONE, NORMAL, INCOGNITO };
 // YES while animating the dismissal of tab switcher.
 @property(nonatomic, assign) BOOL dismissingTabSwitcher;
 
-// Returns YES if the settings are presented, either from
-// self.settingsNavigationController or from SigninInteractionCoordinator.
-@property(nonatomic, assign, readonly, getter=isSettingsViewPresented)
-    BOOL settingsViewPresented;
-
 // If not NONE, the current BVC should be switched to this BVC on completion
 // of tab switcher dismissal.
 @property(nonatomic, assign)

ios/chrome/browser/ui/main/scene_controller.mm

@@ -101,6 +101,17 @@ enum class EnterTabSwitcherSnapshotResult {
 // A flag that keeps track of the UI initialization for the controlled scene.
 @property(nonatomic, assign) BOOL hasInitializedUI;
 
+// The SigninInteractionCoordinator to present Sign In UI. It is created the
+// first time Sign In UI is needed to be presented and should not be destroyed
+// while the UI is presented.
+@property(nonatomic, strong)
+    SigninInteractionCoordinator* signinInteractionCoordinator;
+
+// Returns YES if the settings are presented, either from
+// self.settingsNavigationController or from SigninInteractionCoordinator.
+@property(nonatomic, assign, readonly, getter=isSettingsViewPresented)
+    BOOL settingsViewPresented;
+
 @end
 
 @implementation SceneController
@@ -141,6 +152,11 @@ enum class EnterTabSwitcherSnapshotResult {
   return self.mainController.interfaceProvider;
 }
 
+- (BOOL)isSettingsViewPresented {
+  return self.settingsNavigationController ||
+         self.signinInteractionCoordinator.isSettingsViewPresented;
+}
+
 #pragma mark - SceneStateObserver
 
 - (void)sceneState:(SceneState*)sceneState
@@ -156,10 +172,18 @@ enum class EnterTabSwitcherSnapshotResult {
   self.hasInitializedUI = YES;
 }
 
-#pragma mark - Guts
+// This method completely destroys all of the UI. It should be called when the
+// scene is disconnected.
+- (void)teardownUI {
+  if (!self.hasInitializedUI) {
+    return;  // Nothing to do.
+  }
+
+  // The UI should be stopped before the models they observe are stopped.
+  [self.signinInteractionCoordinator cancel];
+  self.signinInteractionCoordinator = nil;
 
-- (BOOL)hasSettingsNavigationController {
-  return self.settingsNavigationController != nil;
+  self.hasInitializedUI = NO;
 }
 
 #pragma mark - ApplicationCommands
@@ -236,8 +260,7 @@ enum class EnterTabSwitcherSnapshotResult {
 // TODO(crbug.com/779791) : Remove showing settings from MainController.
 - (void)showAutofillSettingsFromViewController:
     (UIViewController*)baseViewController {
-  DCHECK(!self.mainController.signinInteractionCoordinator
-              .isSettingsViewPresented);
+  DCHECK(!self.signinInteractionCoordinator.isSettingsViewPresented);
   if (self.settingsNavigationController)
     return;
 
@@ -256,8 +279,7 @@ enum class EnterTabSwitcherSnapshotResult {
   // This dispatch is necessary to give enough time for the tools menu to
   // disappear before taking a screenshot.
   dispatch_async(dispatch_get_main_queue(), ^{
-    DCHECK(!self.mainController.signinInteractionCoordinator
-                .isSettingsViewPresented);
+    DCHECK(!self.signinInteractionCoordinator.isSettingsViewPresented);
     if (self.settingsNavigationController)
       return;
     Browser* browser = self.mainInterface.browser;
@@ -289,29 +311,27 @@ enum class EnterTabSwitcherSnapshotResult {
 // TODO(crbug.com/779791) : Do not pass |baseViewController| through dispatcher.
 - (void)showSignin:(ShowSigninCommand*)command
     baseViewController:(UIViewController*)baseViewController {
-  if (!self.mainController.signinInteractionCoordinator) {
+  if (!self.signinInteractionCoordinator) {
     Browser* mainBrowser = self.mainInterface.browser;
-    self.mainController.signinInteractionCoordinator =
-        [[SigninInteractionCoordinator alloc]
-            initWithBrowser:mainBrowser
-                 dispatcher:self.mainController.mainBVC.dispatcher];
+    self.signinInteractionCoordinator = [[SigninInteractionCoordinator alloc]
+        initWithBrowser:mainBrowser
+             dispatcher:self.mainController.mainBVC.dispatcher];
   }
 
   switch (command.operation) {
     case AUTHENTICATION_OPERATION_REAUTHENTICATE:
-      [self.mainController.signinInteractionCoordinator
+      [self.signinInteractionCoordinator
           reAuthenticateWithAccessPoint:command.accessPoint
                             promoAction:command.promoAction
                presentingViewController:baseViewController
                              completion:command.callback];
       break;
     case AUTHENTICATION_OPERATION_SIGNIN:
-      [self.mainController.signinInteractionCoordinator
-                signInWithIdentity:command.identity
-                       accessPoint:command.accessPoint
-                       promoAction:command.promoAction
-          presentingViewController:baseViewController
-                        completion:command.callback];
+      [self.signinInteractionCoordinator signInWithIdentity:command.identity
+                                                accessPoint:command.accessPoint
+                                                promoAction:command.promoAction
+                                   presentingViewController:baseViewController
+                                                 completion:command.callback];
       break;
   }
 }
@@ -319,11 +339,10 @@ enum class EnterTabSwitcherSnapshotResult {
 - (void)showAdvancedSigninSettingsFromViewController:
     (UIViewController*)baseViewController {
   Browser* mainBrowser = self.mainInterface.browser;
-  self.mainController.signinInteractionCoordinator =
-      [[SigninInteractionCoordinator alloc]
-          initWithBrowser:mainBrowser
-               dispatcher:self.mainController.mainBVC.dispatcher];
-  [self.mainController.signinInteractionCoordinator
+  self.signinInteractionCoordinator = [[SigninInteractionCoordinator alloc]
+      initWithBrowser:mainBrowser
+           dispatcher:self.mainController.mainBVC.dispatcher];
+  [self.signinInteractionCoordinator
       showAdvancedSigninSettingsWithPresentingViewController:
           baseViewController];
 }
@@ -331,14 +350,13 @@ enum class EnterTabSwitcherSnapshotResult {
 // TODO(crbug.com/779791) : Remove settings commands from MainController.
 - (void)showAddAccountFromViewController:(UIViewController*)baseViewController {
   Browser* mainBrowser = self.mainInterface.browser;
-  if (!self.mainController.signinInteractionCoordinator) {
-    self.mainController.signinInteractionCoordinator =
-        [[SigninInteractionCoordinator alloc]
-            initWithBrowser:mainBrowser
-                 dispatcher:self.mainController.mainBVC.dispatcher];
+  if (!self.signinInteractionCoordinator) {
+    self.signinInteractionCoordinator = [[SigninInteractionCoordinator alloc]
+        initWithBrowser:mainBrowser
+             dispatcher:self.mainController.mainBVC.dispatcher];
   }
 
-  [self.mainController.signinInteractionCoordinator
+  [self.signinInteractionCoordinator
       addAccountWithAccessPoint:signin_metrics::AccessPoint::
                                     ACCESS_POINT_UNKNOWN
                     promoAction:signin_metrics::PromoAction::
@@ -364,8 +382,7 @@ enum class EnterTabSwitcherSnapshotResult {
 }
 
 - (void)showSettingsFromViewController:(UIViewController*)baseViewController {
-  DCHECK(!self.mainController.signinInteractionCoordinator
-              .isSettingsViewPresented);
+  DCHECK(!self.signinInteractionCoordinator.isSettingsViewPresented);
   if (self.settingsNavigationController)
     return;
   [[DeferredInitializationRunner sharedInstance]
@@ -386,8 +403,7 @@ enum class EnterTabSwitcherSnapshotResult {
 // TODO(crbug.com/779791) : Remove show settings from MainController.
 - (void)showAccountsSettingsFromViewController:
     (UIViewController*)baseViewController {
-  DCHECK(!self.mainController.signinInteractionCoordinator
-              .isSettingsViewPresented);
+  DCHECK(!self.signinInteractionCoordinator.isSettingsViewPresented);
   if (!baseViewController) {
     DCHECK_EQ(self.mainController.currentBVC,
               self.mainController.mainCoordinator.activeViewController);
@@ -416,8 +432,7 @@ enum class EnterTabSwitcherSnapshotResult {
 // TODO(crbug.com/779791) : Remove Google services settings from MainController.
 - (void)showGoogleServicesSettingsFromViewController:
     (UIViewController*)baseViewController {
-  DCHECK(!self.mainController.signinInteractionCoordinator
-              .isSettingsViewPresented);
+  DCHECK(!self.signinInteractionCoordinator.isSettingsViewPresented);
   if (!baseViewController) {
     DCHECK_EQ(self.mainController.currentBVC,
               self.mainController.mainCoordinator.activeViewController);
@@ -445,8 +460,7 @@ enum class EnterTabSwitcherSnapshotResult {
 // TODO(crbug.com/779791) : Remove show settings commands from MainController.
 - (void)showSyncPassphraseSettingsFromViewController:
     (UIViewController*)baseViewController {
-  DCHECK(!self.mainController.signinInteractionCoordinator
-              .isSettingsViewPresented);
+  DCHECK(!self.signinInteractionCoordinator.isSettingsViewPresented);
   if (self.settingsNavigationController) {
     [self.settingsNavigationController
         showSyncPassphraseSettingsFromViewController:baseViewController];
@@ -465,8 +479,7 @@ enum class EnterTabSwitcherSnapshotResult {
 // TODO(crbug.com/779791) : Remove show settings commands from MainController.
 - (void)showSavedPasswordsSettingsFromViewController:
     (UIViewController*)baseViewController {
-  DCHECK(!self.mainController.signinInteractionCoordinator
-              .isSettingsViewPresented);
+  DCHECK(!self.signinInteractionCoordinator.isSettingsViewPresented);
   if (self.settingsNavigationController) {
     [self.settingsNavigationController
         showSavedPasswordsSettingsFromViewController:baseViewController];
@@ -484,8 +497,7 @@ enum class EnterTabSwitcherSnapshotResult {
 // TODO(crbug.com/779791) : Remove show settings commands from MainController.
 - (void)showProfileSettingsFromViewController:
     (UIViewController*)baseViewController {
-  DCHECK(!self.mainController.signinInteractionCoordinator
-              .isSettingsViewPresented);
+  DCHECK(!self.signinInteractionCoordinator.isSettingsViewPresented);
   if (self.settingsNavigationController) {
     [self.settingsNavigationController
         showProfileSettingsFromViewController:baseViewController];
@@ -504,8 +516,7 @@ enum class EnterTabSwitcherSnapshotResult {
 // TODO(crbug.com/779791) : Remove show settings commands from MainController.
 - (void)showCreditCardSettingsFromViewController:
     (UIViewController*)baseViewController {
-  DCHECK(!self.mainController.signinInteractionCoordinator
-              .isSettingsViewPresented);
+  DCHECK(!self.signinInteractionCoordinator.isSettingsViewPresented);
   if (self.settingsNavigationController) {
     [self.settingsNavigationController
         showCreditCardSettingsFromViewController:baseViewController];
@@ -858,7 +869,7 @@ enum class EnterTabSwitcherSnapshotResult {
   ProceduralBlock completionWithBVC = ^{
     DCHECK(self.mainController.currentBVC);
     DCHECK(!self.mainController.tabSwitcherIsActive);
-    DCHECK(!self.mainController.signinInteractionCoordinator.isActive);
+    DCHECK(!self.signinInteractionCoordinator.isActive);
     // This will dismiss the SSO view controller.
     [self.interfaceProvider.currentInterface
         clearPresentedStateWithCompletion:completion
@@ -869,7 +880,7 @@ enum class EnterTabSwitcherSnapshotResult {
     // active.
     DCHECK(self.mainController.tabSwitcherIsActive);
     // This will dismiss the SSO view controller.
-    [self.mainController.signinInteractionCoordinator cancelAndDismiss];
+    [self.signinInteractionCoordinator cancelAndDismiss];
     // History coordinator can be started on top of the tab grid. This is not
     // true of the other tab switchers.
     DCHECK(self.mainController.mainCoordinator);
@@ -881,18 +892,18 @@ enum class EnterTabSwitcherSnapshotResult {
   // dismissed. Then, based on whether the BVC is present or not, a different
   // completion callback is called.
   if (!self.mainController.tabSwitcherIsActive &&
-      self.mainController.isSettingsViewPresented) {
+      self.isSettingsViewPresented) {
     // In this case, the settings are up and the BVC is showing. Close the
     // settings then call the BVC completion.
     [self closeSettingsAnimated:NO completion:completionWithBVC];
-  } else if (self.mainController.isSettingsViewPresented) {
+  } else if (self.isSettingsViewPresented) {
     // In this case, the settings are up but the BVC is not showing. Close the
     // settings then call the no-BVC completion.
     [self closeSettingsAnimated:NO completion:completionWithoutBVC];
   } else if (![self.mainController isTabSwitcherActive]) {
     // In this case, the settings are not shown but the BVC is showing. Call the
     // BVC completion.
-    [self.mainController.signinInteractionCoordinator cancel];
+    [self.signinInteractionCoordinator cancel];
     completionWithBVC();
   } else {
     // In this case, neither the settings nor the BVC are shown. Call the no-BVC
@@ -1143,9 +1154,8 @@ enum class EnterTabSwitcherSnapshotResult {
   //  - start sign-in
   //  - tap on "Settings" to open the advanced sign-in settings
   //  - tap on "Manage Your Google Account"
-  DCHECK(
-      self.mainController.signinInteractionCoordinator.isSettingsViewPresented);
-  [self.mainController.signinInteractionCoordinator
+  DCHECK(self.signinInteractionCoordinator.isSettingsViewPresented);
+  [self.signinInteractionCoordinator
       abortAndDismissSettingsViewAnimated:animated
                                completion:completion];
 }

ios/chrome/browser/ui/main/scene_controller_guts.h

@@ -60,15 +60,18 @@ class ChromeBrowserState;
 - (void)presentSignedInAccountsViewControllerForBrowserState:
     (ios::ChromeBrowserState*)browserState;
 
-// Returns YES if the settings navigation controller exists.
-- (BOOL)hasSettingsNavigationController;
-
 // Clears incognito data that is specific to iOS and won't be cleared by
 // deleting the browser state.
 - (void)clearIOSSpecificIncognitoData;
 
 - (void)activateBVCAndMakeCurrentBVCPrimary;
 
+#pragma mark - iOS 12 compat
+
+// Method called on SceneController when the scene disconnects. Exposed here for
+// iOS 12 compatibility.
+- (void)teardownUI;
+
 @end
 
 #endif  // IOS_CHROME_BROWSER_UI_MAIN_SCENE_CONTROLLER_GUTS_H_