Sync: Support multiple setup UIs.

components/browser_sync/browser/profile_sync_service.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef COMPONENTS_BROWSER_SYNC_BROWSER_PROFILE_SYNC_SERVICE_H_
 #define COMPONENTS_BROWSER_SYNC_BROWSER_PROFILE_SYNC_SERVICE_H_
 
 #include <memory>
 #include <set>
 #include <string>
@@ skipping 147 matching lines @@
 //   The "sync everything" state cannot be read from ProfileSyncService, but
 //   is instead pulled from SyncPrefs.HasKeepEverythingSynced().
 //
 // Initial sync setup:
 //
 //   For privacy reasons, it is usually desirable to avoid syncing any data
 //   types until the user has finished setting up sync. There are two APIs
 //   that control the initial sync download:
 //
 //    * SetFirstSetupComplete()
-//    * SetSetupInProgress()
+//    * GetSetupInProgressHandle()
 //
 //   SetFirstSetupComplete() should be called once the user has finished setting
-//   up sync at least once on their account. SetSetupInProgress(true) should be
-//   called while the user is actively configuring their account, and then
-//   SetSetupInProgress(false) should be called when configuration is complete.
-//   Once both these conditions have been met, CanConfigureDataTypes() will
-//   return true and datatype configuration can begin.
+//   up sync at least once on their account. GetSetupInProgressHandle() should
+//   be called while the user is actively configuring their account. The handle
+//   should be deleted once configuration is complete.
+//
+//   Once first setup has completed and there are no outstanding
+//   setup-in-progress handles, CanConfigureDataTypes() will return true and
+//   datatype configuration can begin.
 class ProfileSyncService : public sync_driver::SyncService,
                            public sync_driver::SyncFrontend,
                            public sync_driver::SyncPrefObserver,
                            public sync_driver::DataTypeManagerObserver,
                            public syncer::UnrecoverableErrorHandler,
                            public KeyedService,
                            public OAuth2TokenService::Consumer,
                            public OAuth2TokenService::Observer,
                            public SigninManagerBase::Observer,
                            public GaiaCookieManagerService::Observer {
@@ skipping 87 matching lines @@
   bool CanSyncStart() const override;
   void RequestStop(SyncStopDataFate data_fate) override;
   void RequestStart() override;
   syncer::ModelTypeSet GetActiveDataTypes() const override;
   sync_driver::SyncClient* GetSyncClient() const override;
   syncer::ModelTypeSet GetPreferredDataTypes() const override;
   void OnUserChoseDatatypes(bool sync_everything,
                             syncer::ModelTypeSet chosen_types) override;
   void SetFirstSetupComplete() override;
   bool IsFirstSetupInProgress() const override;
-  void SetSetupInProgress(bool setup_in_progress) override;
+  std::unique_ptr<sync_driver::SyncSetupInProgressHandle>
+  GetSetupInProgressHandle() override;
   bool IsSetupInProgress() const override;
   bool ConfigurationDone() const override;
   const GoogleServiceAuthError& GetAuthError() const override;
   bool HasUnrecoverableError() const override;
   bool IsBackendInitialized() const override;
   sync_driver::OpenTabsUIDelegate* GetOpenTabsUIDelegate() override;
   bool IsPassphraseRequiredForDecryption() const override;
   base::Time GetExplicitPassphraseTime() const override;
   bool IsUsingSecondaryPassphrase() const override;
   void EnableEncryptEverything() override;
@@ skipping 501 matching lines @@
 
   // Calls sync backend to send ClearServerDataMessage to server.
   void ClearAndRestartSyncForPassphraseEncryption();
 
   // Restarts sync clearing directory in the process.
   void OnClearServerDataDone();
 
   // True if setup has been completed at least once and is not in progress.
   bool CanConfigureDataTypes() const;
 
+  // Called when a SetupInProgressHandle issued by this instance is destroyed.
+  virtual void OnSetupInProgressHandleDestroyed();
+
   // This profile's SyncClient, which abstracts away non-Sync dependencies and
   // the Sync API component factory.
   std::unique_ptr<sync_driver::SyncClient> sync_client_;
 
   // The class that handles getting, setting, and persisting sync
   // preferences.
   sync_driver::SyncPrefs sync_prefs_;
 
   // TODO(ncarter): Put this in a profile, once there is UI for it.
   // This specifies where to find the sync server.
@@ skipping 22 matching lines @@
 
   // Threading context.
   scoped_refptr<base::SingleThreadTaskRunner> db_thread_;
   scoped_refptr<base::SingleThreadTaskRunner> file_thread_;
   base::SequencedWorkerPool* blocking_pool_;
 
   // Indicates if this is the first time sync is being configured.  This value
   // is equal to !IsFirstSetupComplete() at the time of OnBackendInitialized().
   bool is_first_time_sync_configure_;
 
+  // Number of UIs currently configuring the Sync service. When this number
+  // is decremented back to zero, Sync setup is marked no longer in progress.
+  int outstanding_setup_in_progress_handles_ = 0;
+
   // List of available data type controllers.
   sync_driver::DataTypeController::TypeMap data_type_controllers_;
 
   // Whether the SyncBackendHost has been initialized.
   bool backend_initialized_;
 
   // Set when sync receives DISABLED_BY_ADMIN error from server. Prevents
   // ProfileSyncService from starting backend till browser restarted or user
   // signed out.
   bool sync_disabled_by_admin_;
@@ skipping 163 matching lines @@
   base::WeakPtrFactory<ProfileSyncService> startup_controller_weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(ProfileSyncService);
 };
 
 bool ShouldShowActionOnUI(
     const syncer::SyncProtocolError& error);
 
 
 #endif  // COMPONENTS_BROWSER_SYNC_BROWSER_PROFILE_SYNC_SERVICE_H_