[Sync] Refactor sync configuration logic.

sync/internal_api/sync_manager.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 SYNC_INTERNAL_API_SYNC_MANAGER_H_
 #define SYNC_INTERNAL_API_SYNC_MANAGER_H_
 
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/callback_forward.h"
 #include "base/file_path.h"
 #include "base/memory/ref_counted.h"
 #include "base/task_runner.h"
 #include "base/threading/thread_checker.h"
 #include "base/time.h"
 #include "sync/internal_api/change_record.h"
 #include "sync/internal_api/configure_reason.h"
 #include "sync/internal_api/public/engine/model_safe_worker.h"
 #include "sync/internal_api/public/engine/sync_status.h"
 #include "sync/internal_api/public/syncable/model_type.h"
 #include "sync/protocol/sync_protocol_error.h"
 #include "sync/util/report_unrecoverable_error_function.h"
 #include "sync/util/unrecoverable_error_handler.h"
 #include "sync/util/weak_handle.h"
 
 namespace browser_sync {
+struct ConfigurationParams;
 class Encryptor;
 struct Experiments;
 class ExtensionsActivityMonitor;
 class JsBackend;
 class JsEventHandler;
 
 namespace sessions {
 class SyncSessionSnapshot;
 }  // namespace sessions
 }  // namespace browser_sync
@@ skipping 385 matching lines @@
   // re-encryption once the pending keys are decrypted.
   void SetEncryptionPassphrase(const std::string& passphrase, bool is_explicit);
 
   // Provides a passphrase for decrypting the user's existing sync data.
   // Notifies observers of the result of the operation via OnPassphraseAccepted
   // or OnPassphraseRequired, updates the nigori node, and does re-encryption as
   // appropriate if there is a previously cached encryption passphrase. It is an
   // error to call this when we don't have pending keys.
   void SetDecryptionPassphrase(const std::string& passphrase);
 
-  // Puts the SyncScheduler into a mode where no normal nudge or poll traffic
-  // will occur, but calls to RequestConfig will be supported.  If |callback|
-  // is provided, it will be invoked (from the internal SyncScheduler) when
-  // the thread has changed to configuration mode.
-  void StartConfigurationMode(const base::Closure& callback);
-
-  // Switches the mode of operation to CONFIGURATION_MODE and
-  // schedules a config task to fetch updates for |types|.
-  void RequestConfig(const browser_sync::ModelSafeRoutingInfo& routing_info,
-                     const syncable::ModelTypeSet& types,
-                     sync_api::ConfigureReason reason);
-
-  void RequestCleanupDisabledTypes(
-      const browser_sync::ModelSafeRoutingInfo& routing_info);
-
   // Request a clearing of all data on the server
   void RequestClearServerData();
 
+  // Switches the mode of operation to CONFIGURATION_MODE and performs
+  // any configuration tasks needed as determined by the params. Once complete,
+  // syncer will remain in CONFIGURATION_MODE until StartSyncingNormally is
+  // called.
+  // |ready_task| is invoked when the configuration completes.
+  // |retry_task| is invoked if the configuration job could not immediately
+  //              execute. |ready_task| will still be called when it eventually
+  //              does finish.
+  void ConfigureSyncer(
+      ConfigureReason reason,
+      const syncable::ModelTypeSet& types_to_config,
+      const browser_sync::ModelSafeRoutingInfo& new_routing_info,
+      const base::Closure& ready_task,
+      const base::Closure& retry_task);
+
   // Adds a listener to be notified of sync events.
   // NOTE: It is OK (in fact, it's probably a good idea) to call this before
   // having received OnInitializationCompleted.
   void AddObserver(Observer* observer);
 
   // Remove the given observer.  Make sure to call this if the
   // Observer is being destroyed so the SyncManager doesn't
   // potentially dereference garbage.
   void RemoveObserver(Observer* observer);
 
@@ skipping 73 matching lines @@
 
   void TriggerOnIncomingNotificationForTest(
       syncable::ModelTypeSet model_types);
 
   static const int kDefaultNudgeDelayMilliseconds;
   static const int kPreferencesNudgeDelayMilliseconds;
   static const int kPiggybackNudgeDelay;
 
   static const FilePath::CharType kSyncDatabaseFilename[];
 
+ protected:
+  // Returns true if the configuration completed on the first attempt, false
+  // if a retry will be performed at a later time.
+  // Virtual for testing.
+  virtual bool DoConfigureSyncer(
+      const browser_sync::ConfigurationParams& params);
+
  private:
   FRIEND_TEST_ALL_PREFIXES(SyncManagerTest, NudgeDelayTest);
 
   // For unit tests.
   base::TimeDelta GetNudgeDelayTimeDelta(const syncable::ModelType& model_type);
 
   base::ThreadChecker thread_checker_;
 
   // An opaque pointer to the nested private class.
   SyncInternal* data_;
 
   DISALLOW_COPY_AND_ASSIGN(SyncManager);
 };
 
 bool InitialSyncEndedForTypes(syncable::ModelTypeSet types, UserShare* share);
 
 syncable::ModelTypeSet GetTypesWithEmptyProgressMarkerToken(
     syncable::ModelTypeSet types,
     sync_api::UserShare* share);
 
 const char* ConnectionStatusToString(ConnectionStatus status);
 
 // Returns the string representation of a PassphraseRequiredReason value.
 const char* PassphraseRequiredReasonToString(PassphraseRequiredReason reason);
 
 }  // namespace sync_api
 
 #endif  // SYNC_INTERNAL_API_SYNC_MANAGER_H_