[Sync] SyncEngine refactor part 1: interfaces.

components/browser_sync/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_PROFILE_SYNC_SERVICE_H_
 #define COMPONENTS_BROWSER_SYNC_PROFILE_SYNC_SERVICE_H_
 
 #include <memory>
 #include <set>
 #include <string>
@@ skipping 19 matching lines @@
 #include "components/signin/core/browser/signin_manager_base.h"
 #include "components/sync/base/experiments.h"
 #include "components/sync/base/model_type.h"
 #include "components/sync/base/sync_prefs.h"
 #include "components/sync/base/unrecoverable_error_handler.h"
 #include "components/sync/device_info/local_device_info_provider.h"
 #include "components/sync/driver/data_type_controller.h"
 #include "components/sync/driver/data_type_manager.h"
 #include "components/sync/driver/data_type_manager_observer.h"
 #include "components/sync/driver/data_type_status_table.h"
-#include "components/sync/driver/glue/sync_backend_host.h"
 #include "components/sync/driver/startup_controller.h"
 #include "components/sync/driver/sync_client.h"
-#include "components/sync/driver/sync_frontend.h"
 #include "components/sync/driver/sync_service.h"
 #include "components/sync/driver/sync_stopped_reporter.h"
 #include "components/sync/engine/events/protocol_event_observer.h"
 #include "components/sync/engine/model_safe_worker.h"
 #include "components/sync/engine/net/network_time_update_callback.h"
 #include "components/sync/engine/shutdown_reason.h"
+#include "components/sync/engine/sync_engine.h"
+#include "components/sync/engine/sync_engine_host.h"
 #include "components/sync/engine/sync_manager_factory.h"
 #include "components/sync/js/sync_js_controller.h"
 #include "components/sync/syncable/user_share.h"
 #include "components/version_info/version_info.h"
 #include "google_apis/gaia/google_service_auth_error.h"
 #include "google_apis/gaia/oauth2_token_service.h"
 #include "net/base/backoff_entry.h"
 #include "url/gurl.h"
 
 class Profile;
@@ skipping 105 matching lines @@
 //
 //   SetFirstSetupComplete() should be called once the user has finished setting
 //   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 syncer::SyncService,
-                           public syncer::SyncFrontend,
+                           public syncer::SyncEngineHost,
                            public syncer::SyncPrefObserver,
                            public syncer::DataTypeManagerObserver,
                            public syncer::UnrecoverableErrorHandler,
                            public KeyedService,
                            public OAuth2TokenService::Consumer,
                            public OAuth2TokenService::Observer,
                            public SigninManagerBase::Observer,
                            public GaiaCookieManagerService::Observer {
  public:
-  typedef syncer::SyncBackendHost::Status Status;
+  typedef syncer::SyncEngine::Status Status;
   typedef base::Callback<bool(void)> PlatformSyncAllowedProvider;
 
   enum SyncEventCodes {
     MIN_SYNC_EVENT_CODE = 0,
 
     // Events starting the sync service.
     START_FROM_NTP = 1,               // Sync was started from the ad in NTP
     START_FROM_WRENCH = 2,            // Sync was started from the Wrench menu.
     START_FROM_OPTIONS = 3,           // Sync was started from Wrench->Options.
     START_FROM_BOOKMARK_MANAGER = 4,  // Sync was started from Bookmark manager.
@@ skipping 155 matching lines @@
   virtual syncer::DeviceInfoTracker* GetDeviceInfoTracker() const;
 
   // Fills state_map with a map of current data types that are possible to
   // sync, as well as their states.
   void GetDataTypeControllerStates(
       syncer::DataTypeController::StateMap* state_map) const;
 
   // Called when asynchronous session restore has completed.
   void OnSessionRestoreComplete();
 
-  // SyncFrontend implementation.
+  // SyncEngineHost implementation.
   void OnBackendInitialized(
       const syncer::WeakHandle<syncer::JsBackend>& js_backend,
       const syncer::WeakHandle<syncer::DataTypeDebugInfoListener>&
           debug_info_listener,
       const std::string& cache_guid,
       bool success) override;
   void OnSyncCycleCompleted() override;
   void OnProtocolEvent(const syncer::ProtocolEvent& event) override;
   void OnDirectoryTypeCommitCounterUpdated(
       syncer::ModelType type,
@@ skipping 228 matching lines @@
   // Return SyncCredentials from the OAuth2TokenService.
   syncer::SyncCredentials GetCredentials();
 
   virtual syncer::WeakHandle<syncer::JsEventHandler> GetJsEventHandler();
 
   // Helper method for managing encryption UI.
   bool IsEncryptedDatatypeEnabled() const;
 
   // Helper for OnUnrecoverableError.
   // TODO(tim): Use an enum for |delete_sync_database| here, in ShutdownImpl,
-  // and in SyncBackendHost::Shutdown.
+  // and in SyncEngine::Shutdown.
   void OnUnrecoverableErrorImpl(const tracked_objects::Location& from_here,
                                 const std::string& message,
                                 bool delete_sync_database);
 
   // This is a cache of the last authentication response we received from the
   // sync server. The UI queries this to display appropriate messaging to the
   // user.
   GoogleServiceAuthError last_auth_error_;
 
   // Our asynchronous backend to communicate with sync components living on
   // other threads.
-  std::unique_ptr<syncer::SyncBackendHost> backend_;
+  std::unique_ptr<syncer::SyncEngine> backend_;
 
   // Was the last SYNC_PASSPHRASE_REQUIRED notification sent because it
   // was required for encryption, decryption with a cached passphrase, or
   // because a new passphrase is required?
   syncer::PassphraseRequiredReason passphrase_required_reason_;
 
  private:
   enum UnrecoverableErrorReason {
     ERROR_REASON_UNSET,
     ERROR_REASON_SYNCER,
@@ skipping 198 matching lines @@
   // 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.
   syncer::DataTypeController::TypeMap data_type_controllers_;
 
-  // Whether the SyncBackendHost has been initialized.
+  // Whether the SyncEngine has been initialized.
   bool backend_initialized_;

[skym, 2016/12/02 20:54:54]

Should his be engine_initialized_? Also, does this mean we've round tripped to
the sync thread and the directory is up? Or we just have passed the init args to
the UI thread facade of the engine?

[maxbogue, 2016/12/02 23:59:27]

As I said in the CL description, PSS naming updates will be coming in a followup
because there are so many. It means a round-trip has been done.

[skym, 2016/12/03 00:03:47]

Ah, that's fair. And when I asked what this means, I was trying to imply that
the comment should make that clear, sorry my wording was bad. But I can wait for
the next CL to bug you about this again :)

 
   // 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_;
 
   // Set to true if a signin has completed but we're still waiting for the
   // backend to refresh its credentials.
   bool is_auth_in_progress_;
 
@@ skipping 151 matching lines @@
   base::WeakPtrFactory<ProfileSyncService> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(ProfileSyncService);
 };
 
 bool ShouldShowActionOnUI(const syncer::SyncProtocolError& error);
 
 }  // namespace browser_sync
 
 #endif  // COMPONENTS_BROWSER_SYNC_PROFILE_SYNC_SERVICE_H_