Not for review: Support sync init with missing or corrupt store

chrome/browser/sync/glue/sync_backend_host.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 CHROME_BROWSER_SYNC_GLUE_SYNC_BACKEND_HOST_H_
 #define CHROME_BROWSER_SYNC_GLUE_SYNC_BACKEND_HOST_H_
 #pragma once
 
 #include <string>
 
@@ skipping 153 matching lines @@
 
   // Called on |frontend_loop_| to kick off asynchronous initialization.
   // As a fallback when no cached auth information is available, try to
   // bootstrap authentication using |lsid|, if it isn't empty.
   // Optionally delete the Sync Data folder (if it's corrupt).
   // |report_unrecoverable_error_function| can be NULL.
   // Note: |unrecoverable_error_handler| may be invoked from any thread.
   void Initialize(SyncFrontend* frontend,
                   const WeakHandle<JsEventHandler>& event_handler,
                   const GURL& service_url,
-                  syncable::ModelTypeSet initial_types,
                   const sync_api::SyncCredentials& credentials,
                   bool delete_sync_data_folder,
                   UnrecoverableErrorHandler* unrecoverable_error_handler,
                   ReportUnrecoverableErrorFunction
                       report_unrecoverable_error_function);
 
   // Called from |frontend_loop| to update SyncCredentials.
   void UpdateCredentials(const sync_api::SyncCredentials& credentials);
 
   // This starts the SyncerThread running a Syncer object to communicate with
@@ skipping 98 matching lines @@
  protected:
   // The types and functions below are protected so that test
   // subclasses can use them.
   //
   // TODO(akalin): Figure out a better way for tests to hook into
   // SyncBackendHost.
 
   typedef base::Callback<sync_api::HttpPostProviderFactory*(void)>
       MakeHttpBridgeFactoryFn;
 
+  struct PendingConfigureDataTypesState {
+    PendingConfigureDataTypesState();
+    ~PendingConfigureDataTypesState();
+
+    // The ready_task will be run when configuration is done with the
+    // set of all types that failed configuration (i.e., if its
+    // argument is non-empty, then an error was encountered).
+    base::Callback<void(syncable::ModelTypeSet)> ready_task;
+
+    // The retry callback will be run when the download failed due to a
+    // transient error. This is to notify DTM so it can apropriately inform
+    // the UI. Note: The retry_callback will be run only once and after
+    // that we will not notify DTM until the sync is successful or in a
+    // permanent error state.
+    base::Callback<void()> retry_callback;
+
+    // The set of types that we are waiting to be initially synced in a
+    // configuration cycle.
+    syncable::ModelTypeSet types_to_add;
+
+    // Additional details about which types were added.
+    syncable::ModelTypeSet added_types;
+    sync_api::ConfigureReason reason;
+    bool retry_in_progress;
+  };
+
   struct DoInitializeOptions {
     DoInitializeOptions(
         MessageLoop* sync_loop,
         SyncBackendRegistrar* registrar,
         const ModelSafeRoutingInfo& routing_info,
         const std::vector<ModelSafeWorker*>& workers,
         ExtensionsActivityMonitor* extensions_activity_monitor,
         const WeakHandle<JsEventHandler>& event_handler,
         const GURL& service_url,
         MakeHttpBridgeFactoryFn make_http_bridge_factory_fn,
@@ skipping 32 matching lines @@
 
   // Called from Core::OnSyncCycleCompleted to handle updating frontend
   // thread components.
   void HandleSyncCycleCompletedOnFrontendLoop(
       const sessions::SyncSessionSnapshot& snapshot);
 
   // Called to finish the job of ConfigureDataTypes once the syncer is in
   // configuration mode.
   void FinishConfigureDataTypesOnFrontendLoop();
 
-  bool IsDownloadingNigoriForTest() const;
+  scoped_ptr<PendingConfigureDataTypesState> pending_download_state_;

[rlarocque, 2012/06/04 20:07:09]

The moves in this file were necessary to make pending_download_state_ and
pending_config_mode_state_ protected instead of private, so they could be
accessed by the unit tests.

+  scoped_ptr<PendingConfigureDataTypesState> pending_config_mode_state_;
 
  private:
   // The real guts of SyncBackendHost, to keep the public client API clean.
   class Core;
 
   // An enum representing the steps to initializing the SyncBackendHost.
   enum InitializationState {
     NOT_ATTEMPTED,
     CREATING_SYNC_MANAGER,  // We're waiting for the first callback from the
                             // sync thread to inform us that the sync manager
                             // has been created.
     NOT_INITIALIZED,        // Initialization hasn't completed, but we've
                             // constructed a SyncManager.
     DOWNLOADING_NIGORI,     // The SyncManager is initialized, but
                             // we're fetching encryption information.
     REFRESHING_NIGORI,      // The SyncManager is initialized, and we
                             // have the encryption information, but we
                             // still need to refresh encryption. Also, we need
                             // to update the device information in the nigori.
     INITIALIZED,            // Initialization is complete.
   };
 
-  struct PendingConfigureDataTypesState {
-    PendingConfigureDataTypesState();
-    ~PendingConfigureDataTypesState();
-
-    // The ready_task will be run when configuration is done with the
-    // set of all types that failed configuration (i.e., if its
-    // argument is non-empty, then an error was encountered).
-    base::Callback<void(syncable::ModelTypeSet)> ready_task;
-
-    // The retry callback will be run when the download failed due to a
-    // transient error. This is to notify DTM so it can apropriately inform
-    // the UI. Note: The retry_callback will be run only once and after
-    // that we will not notify DTM until the sync is successful or in a
-    // permanent error state.
-    base::Callback<void()> retry_callback;
-
-    // The set of types that we are waiting to be initially synced in a
-    // configuration cycle.
-    syncable::ModelTypeSet types_to_add;
-
-    // Additional details about which types were added.
-    syncable::ModelTypeSet added_types;
-    sync_api::ConfigureReason reason;
-    bool retry_in_progress;
-  };
-
   // Checks if we have received a notice to turn on experimental datatypes
   // (via the nigori node) and informs the frontend if that is the case.
   // Note: it is illegal to call this before the backend is initialized.
   void AddExperimentalTypes();
 
   // Downloading of nigori failed and will be retried.
   virtual void OnNigoriDownloadRetry();
 
   // InitializationComplete passes through the SyncBackendHost to forward
   // on to |frontend_|, and so that tests can intercept here if they need to
@@ skipping 56 matching lines @@
   // frontend UI components.
   void HandleConnectionStatusChangeOnFrontendLoop(
       sync_api::ConnectionStatus status);
 
   // Called when configuration of the Nigori node has completed as
   // part of the initialization process.
   void HandleNigoriConfigurationCompletedOnFrontendLoop(
       const WeakHandle<JsBackend>& js_backend,
       syncable::ModelTypeSet failed_configuration_types);
 
+  // Called when the SyncManager has been constructed and initialized.
+  void HandleSyncManagerInitializationOnFrontendLoop(
+      const WeakHandle<JsBackend>& js_backend, bool success,
+      syncable::ModelTypeSet initial_sync_ended_types);
+
   // Must be called on |frontend_loop_|.  |done_callback| is called on
   // |frontend_loop_|.
   void RefreshNigori(const base::Closure& done_callback);
 
   // Handles stopping the core's SyncManager, accounting for whether
   // initialization is done yet.
   void StopSyncManagerForShutdown(const base::Closure& closure);
 
   base::WeakPtrFactory<SyncBackendHost> weak_ptr_factory_;
 
@@ skipping 22 matching lines @@
 
   sync_notifier::SyncNotifierFactory sync_notifier_factory_;
 
   ChromeExtensionsActivityMonitor extensions_activity_monitor_;
 
   scoped_ptr<SyncBackendRegistrar> registrar_;
 
   // The frontend which we serve (and are owned by).
   SyncFrontend* frontend_;
 
-  scoped_ptr<PendingConfigureDataTypesState> pending_download_state_;
-  scoped_ptr<PendingConfigureDataTypesState> pending_config_mode_state_;
-
   // We cache the cryptographer's pending keys whenever NotifyPassphraseRequired
   // is called. This way, before the UI calls SetDecryptionPassphrase on the
   // syncer, it can avoid the overhead of an asynchronous decryption call and
   // give the user immediate feedback about the passphrase entered by first
   // trying to decrypt the cached pending keys on the UI thread. Note that
   // SetDecryptionPassphrase can still fail after the cached pending keys are
   // successfully decrypted if the pending keys have changed since the time they
   // were cached.
   sync_pb::EncryptedData cached_pending_keys_;
 
   // UI-thread cache of the last SyncSessionSnapshot received from syncapi.
   sessions::SyncSessionSnapshot last_snapshot_;
 
   DISALLOW_COPY_AND_ASSIGN(SyncBackendHost);
 };
 
 }  // namespace browser_sync
 
 #endif  // CHROME_BROWSER_SYNC_GLUE_SYNC_BACKEND_HOST_H_