Revert "Revert 142517 - [Sync] Refactor sync configuration logic."

chrome/browser/sync/glue/sync_backend_host.cc

 // 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.
 
 #include "build/build_config.h"
 
 #include "chrome/browser/sync/glue/sync_backend_host.h"
 
 #include <algorithm>
 #include <map>
@@ skipping 334 matching lines @@
     return user_agent;
   }
 
   user_agent += version_info.Version();
   user_agent += " (" + version_info.LastChange() + ")";
   if (!version_info.IsOfficialBuild())
     user_agent += "-devel";
   return user_agent;
 }
 
-syncer::HttpPostProviderFactory* MakeHttpBridgeFactory(
+scoped_ptr<syncer::HttpPostProviderFactory> MakeHttpBridgeFactory(
     const scoped_refptr<net::URLRequestContextGetter>& getter) {
-  return new syncer::HttpBridgeFactory(getter, MakeUserAgentForSyncApi());
+  return scoped_ptr<syncer::HttpPostProviderFactory>(
+      new syncer::HttpBridgeFactory(getter, MakeUserAgentForSyncApi()));
 }
 
 }  // namespace
 
 void SyncBackendHost::Initialize(
     SyncFrontend* frontend,
     const syncer::WeakHandle<syncer::JsEventHandler>& event_handler,
     const GURL& sync_service_url,
     syncer::ModelTypeSet initial_types,
     const SyncCredentials& credentials,
     bool delete_sync_data_folder,
+    syncer::SyncManagerFactory* sync_manager_factory,
     syncer::UnrecoverableErrorHandler* unrecoverable_error_handler,
     syncer::ReportUnrecoverableErrorFunction
         report_unrecoverable_error_function) {
-  if (!sync_thread_.Start())
+  if (!StartSyncThread())
     return;
 
   frontend_ = frontend;
   DCHECK(frontend);
 
   syncer::ModelTypeSet initial_types_with_nigori(initial_types);
   CHECK(sync_prefs_.get());
   if (sync_prefs_->HasSyncSetupCompleted()) {
     initial_types_with_nigori.Put(syncer::NIGORI);
   }
@@ skipping 14 matching lines @@
       routing_info,
       workers,
       &extensions_activity_monitor_,
       event_handler,
       sync_service_url,
       base::Bind(&MakeHttpBridgeFactory,
                  make_scoped_refptr(profile_->GetRequestContext())),
       credentials,
       &chrome_sync_notification_bridge_,
       &sync_notifier_factory_,
+      sync_manager_factory,
       delete_sync_data_folder,
       sync_prefs_->GetEncryptionBootstrapToken(),
       syncer::SyncManager::NON_TEST,
       unrecoverable_error_handler,
       report_unrecoverable_error_function));
 }
 
 void SyncBackendHost::UpdateCredentials(const SyncCredentials& credentials) {
   sync_thread_.message_loop()->PostTask(FROM_HERE,
       base::Bind(&SyncBackendHost::Core::DoUpdateCredentials, core_.get(),
@@ skipping 174 matching lines @@
   syncer::ModelTypeSet types_to_add_with_nigori = types_to_add;
   syncer::ModelTypeSet types_to_remove_with_nigori = types_to_remove;
   if (nigori_state == WITH_NIGORI) {
     types_to_add_with_nigori.Put(syncer::NIGORI);
     types_to_remove_with_nigori.Remove(syncer::NIGORI);
   } else {
     types_to_add_with_nigori.Remove(syncer::NIGORI);
     types_to_remove_with_nigori.Put(syncer::NIGORI);
   }
   // Only one configure is allowed at a time (DataTypeManager handles user
-  // changes that happen while the syncer is reconfiguraing, and will only
+  // changes that happen while the syncer is reconfiguring, and will only
   // trigger another call to ConfigureDataTypes once the current reconfiguration
   // completes).
   DCHECK_GT(initialization_state_, NOT_INITIALIZED);
 
   // The new set of enabled types is types_to_add_with_nigori + the
   // previously enabled types (on restart, the preferred types are already
   // enabled) - types_to_remove_with_nigori. After reconfiguring the registrar,
   // the new routing info will reflect the set of enabled types.
   syncer::ModelSafeRoutingInfo routing_info;
   registrar_->ConfigureDataTypes(types_to_add_with_nigori,
@@ skipping 93 matching lines @@
 void SyncBackendHost::GetModelSafeRoutingInfo(
     syncer::ModelSafeRoutingInfo* out) const {
   if (initialized()) {
     CHECK(registrar_.get());
     registrar_->GetModelSafeRoutingInfo(out);
   } else {
     NOTREACHED();
   }
 }
 
+bool SyncBackendHost::StartSyncThread() {
+  if (!sync_thread_.IsRunning())
+    return sync_thread_.Start();
+  return true;
+}
+
 void SyncBackendHost::InitCore(const DoInitializeOptions& options) {
   sync_thread_.message_loop()->PostTask(FROM_HERE,
       base::Bind(&SyncBackendHost::Core::DoInitialize, core_.get(), options));
 }
 
 void SyncBackendHost::RequestConfigureSyncer(
     syncer::ConfigureReason reason,
     syncer::ModelTypeSet types_to_config,
     const syncer::ModelSafeRoutingInfo& routing_info,
     const base::Callback<void(syncer::ModelTypeSet)>& ready_task,
@@ skipping 40 matching lines @@
     SyncBackendRegistrar* registrar,
     const syncer::ModelSafeRoutingInfo& routing_info,
     const std::vector<syncer::ModelSafeWorker*>& workers,
     syncer::ExtensionsActivityMonitor* extensions_activity_monitor,
     const syncer::WeakHandle<syncer::JsEventHandler>& event_handler,
     const GURL& service_url,
     MakeHttpBridgeFactoryFn make_http_bridge_factory_fn,
     const syncer::SyncCredentials& credentials,
     ChromeSyncNotificationBridge* chrome_sync_notification_bridge,
     syncer::SyncNotifierFactory* sync_notifier_factory,
+    syncer::SyncManagerFactory* sync_manager_factory,
     bool delete_sync_data_folder,
     const std::string& restored_key_for_bootstrapping,
     syncer::SyncManager::TestingMode testing_mode,
     syncer::UnrecoverableErrorHandler* unrecoverable_error_handler,
     syncer::ReportUnrecoverableErrorFunction
         report_unrecoverable_error_function)
     : sync_loop(sync_loop),
       registrar(registrar),
       routing_info(routing_info),
       workers(workers),
       extensions_activity_monitor(extensions_activity_monitor),
       event_handler(event_handler),
       service_url(service_url),
       make_http_bridge_factory_fn(make_http_bridge_factory_fn),
       credentials(credentials),
       chrome_sync_notification_bridge(chrome_sync_notification_bridge),
       sync_notifier_factory(sync_notifier_factory),
+      sync_manager_factory(sync_manager_factory),
       delete_sync_data_folder(delete_sync_data_folder),
       restored_key_for_bootstrapping(restored_key_for_bootstrapping),
       testing_mode(testing_mode),
       unrecoverable_error_handler(unrecoverable_error_handler),
       report_unrecoverable_error_function(
           report_unrecoverable_error_function) {
 }
 
 SyncBackendHost::DoInitializeOptions::~DoInitializeOptions() {}
 
@@ skipping 146 matching lines @@
 
   // Make sure that the directory exists before initializing the backend.
   // If it already exists, this will do no harm.
   bool success = file_util::CreateDirectory(sync_data_folder_path_);
   DCHECK(success);
 
   DCHECK(!registrar_);
   registrar_ = options.registrar;
   DCHECK(registrar_);
 
-  sync_manager_.reset(new syncer::SyncManager(name_));
+  sync_manager_ = options.sync_manager_factory->CreateSyncManager(name_);
   sync_manager_->AddObserver(this);
   success = sync_manager_->Init(
       sync_data_folder_path_,
       options.event_handler,
       options.service_url.host() + options.service_url.path(),
       options.service_url.EffectiveIntPort(),
       options.service_url.SchemeIsSecure(),
       BrowserThread::GetBlockingPool(),
-      options.make_http_bridge_factory_fn.Run(),
+      options.make_http_bridge_factory_fn.Run().Pass(),
       options.routing_info,
       options.workers,
       options.extensions_activity_monitor,
       options.registrar /* as SyncManager::ChangeDelegate */,
       options.credentials,
-      new BridgedSyncNotifier(
+      scoped_ptr<syncer::SyncNotifier>(new BridgedSyncNotifier(
           options.chrome_sync_notification_bridge,
-          options.sync_notifier_factory->CreateSyncNotifier()),
+          options.sync_notifier_factory->CreateSyncNotifier())),
       options.restored_key_for_bootstrapping,
       options.testing_mode,
       &encryptor_,
       options.unrecoverable_error_handler,
       options.report_unrecoverable_error_function);
   LOG_IF(ERROR, !success) << "Syncapi initialization failed!";
 
   // Now check the command line to see if we need to simulate an
   // unrecoverable error for testing purpose. Note the error is thrown
   // only if the initialization succeeded. Also it makes sense to use this
@@ skipping 150 matching lines @@
 }
 
 void SyncBackendHost::OnNigoriDownloadRetry() {
   DCHECK_EQ(MessageLoop::current(), frontend_loop_);
   if (!frontend_)
     return;
 
   frontend_->OnSyncConfigureRetry();
 }
 
+namespace {
+
+syncer::ModelTypeSet GetPartiallySyncedTypes(
+      syncer::SyncManager* sync_manager) {
+    syncer::ModelTypeSet partially_synced_types =

[rlarocque, 2012/07/09 19:22:58]

This indentation doesn't look right.

[Nicolas Zea, 2012/07/09 19:42:50]

Done.

+        syncer::ModelTypeSet::All();
+    partially_synced_types.RemoveAll(sync_manager->InitialSyncEndedTypes());
+    partially_synced_types.RemoveAll(
+        sync_manager->GetTypesWithEmptyProgressMarkerToken(
+            syncer::ModelTypeSet::All()));
+    return partially_synced_types;
+}
+
+}  // namespace
+
 void SyncBackendHost::HandleInitializationCompletedOnFrontendLoop(
     const syncer::WeakHandle<syncer::JsBackend>& js_backend, bool success) {
   DCHECK_NE(NOT_ATTEMPTED, initialization_state_);
   if (!frontend_)
     return;
 
   // We've at least created the sync manager at this point, but if that is all
   // we've done we're just beginning the initialization process.
   if (initialization_state_ == CREATING_SYNC_MANAGER)
     initialization_state_ = NOT_INITIALIZED;
 
   DCHECK_EQ(MessageLoop::current(), frontend_loop_);
   if (!success) {
     initialization_state_ = NOT_INITIALIZED;
     frontend_->OnBackendInitialized(
         syncer::WeakHandle<syncer::JsBackend>(), false);
     return;
   }
 
   // Run initialization state machine.
   switch (initialization_state_) {
-    case NOT_INITIALIZED:
+    case NOT_INITIALIZED: {
+      NigoriState nigori_state;
+      syncer::ModelTypeSet partially_synced_types = GetPartiallySyncedTypes(
+          core_->sync_manager());
+
+      // Although it's possible for any type to be in a partially downloaded
+      // state, we only care about nigori as it's the only one we download
+      // before the backend is fully initialized. Other types will be
+      // re-downloaded at configuration time, at which point we can handle
+      // migrations and other events.
+      UMA_HISTOGRAM_COUNTS("Sync.PartiallySyncedTypes",
+                           partially_synced_types.Size());
+
+      if (partially_synced_types.Has(syncer::NIGORI)) {
+        // Configure without nigori to force it to be cleaned (
+        // SyncBackendRegistrar will remove nigori from routing info as part
+        // of the configuration).
+        nigori_state = WITHOUT_NIGORI;
+        initialization_state_ = CLEANING_NIGORI;
+      } else {
+        // Normal configuration. Will do nothing if the nigori is already
+        // downloaded and applied.
+        nigori_state = WITH_NIGORI;
+        initialization_state_ = DOWNLOADING_NIGORI;
+      }
+      ConfigureDataTypes(

[rlarocque, 2012/07/09 19:22:58]

I don't like the nigori_state variable, or the fact that there are two ways to
call ConfigureDataTypes(WITH_NIGORI).  We should talk about refactoring this.

[Nicolas Zea, 2012/07/09 19:42:50]

Can you be more specific about what you dislike? There are two ways because
there are two states, which I think makes sense, although I suppose this way is
a bit more "simple state machine"-y.

[rlarocque, 2012/07/09 20:30:22]

Resolved offline.

The summary is that I wanted to see Configure(WITH_NIGORI) and
Configure(WITHOUT_NIGORI) treated as if they were two separate functions.  In
other words, no using a boolean value to switch between them.

Making that change alone would make things look a bit odd, triggering more
refactoring.

We decided that this version is good enough as is.

+          syncer::CONFIGURE_REASON_NEW_CLIENT,
+          syncer::ModelTypeSet(),
+          syncer::ModelTypeSet(),
+          nigori_state,
+          // Calls back into this function.
+          base::Bind(
+              &SyncBackendHost::
+                  HandleNigoriConfigurationCompletedOnFrontendLoop,
+              weak_ptr_factory_.GetWeakPtr(), js_backend),
+          base::Bind(&SyncBackendHost::OnNigoriDownloadRetry,
+                     weak_ptr_factory_.GetWeakPtr()));
+      break;
+    }
+    case CLEANING_NIGORI: {
+      syncer::ModelTypeSet partially_synced_types = GetPartiallySyncedTypes(
+          core_->sync_manager());
+      if (partially_synced_types.Has(syncer::NIGORI)) {
+        // We apparently failed to clean the nigori somehow. Attempting
+        // to continue could lead to crashes (see bug 133219), so we fail
+        // gracefully instead by triggering an unrecoverable error.
+        LOG(ERROR) << "Failed to cleanup partial nigori.";
+        initialization_state_ = NOT_INITIALIZED;
+        frontend_->OnBackendInitialized(
+            syncer::WeakHandle<syncer::JsBackend>(), false);
+        return;
+      }
+
       initialization_state_ = DOWNLOADING_NIGORI;
       ConfigureDataTypes(
           syncer::CONFIGURE_REASON_NEW_CLIENT,
           syncer::ModelTypeSet(),
           syncer::ModelTypeSet(),
           WITH_NIGORI,
           // Calls back into this function.
           base::Bind(
               &SyncBackendHost::
                   HandleNigoriConfigurationCompletedOnFrontendLoop,
               weak_ptr_factory_.GetWeakPtr(), js_backend),
           base::Bind(&SyncBackendHost::OnNigoriDownloadRetry,
                      weak_ptr_factory_.GetWeakPtr()));
       break;
+    }
     case DOWNLOADING_NIGORI:
       initialization_state_ = REFRESHING_NIGORI;
       // Triggers OnEncryptedTypesChanged() and OnEncryptionComplete()
       // if necessary.
       RefreshNigori(
           base::Bind(
               &SyncBackendHost::
                   HandleInitializationCompletedOnFrontendLoop,
               weak_ptr_factory_.GetWeakPtr(), js_backend, true));
       break;
@@ skipping 161 matching lines @@
       FROM_HERE,
       base::Bind(&SyncBackendHost::Core::DoRefreshNigori,
                  core_.get(), sync_thread_done_callback));
 }
 
 #undef SDVLOG
 
 #undef SLOG
 
 }  // namespace browser_sync