sync: Add --enable-sync-sessions-v2 and necessary plumbing to use SessionsSyncManager.

chrome/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 CHROME_BROWSER_SYNC_PROFILE_SYNC_SERVICE_H_
 #define CHROME_BROWSER_SYNC_PROFILE_SYNC_SERVICE_H_
 
 #include <string>
 #include <utility>
 #include <vector>
@@ skipping 13 matching lines @@
 #include "chrome/browser/sync/glue/data_type_controller.h"
 #include "chrome/browser/sync/glue/data_type_encryption_handler.h"
 #include "chrome/browser/sync/glue/data_type_manager.h"
 #include "chrome/browser/sync/glue/data_type_manager_observer.h"
 #include "chrome/browser/sync/glue/failed_data_types_handler.h"
 #include "chrome/browser/sync/glue/sync_backend_host.h"
 #include "chrome/browser/sync/glue/sync_frontend.h"
 #include "chrome/browser/sync/glue/synced_device_tracker.h"
 #include "chrome/browser/sync/profile_sync_service_base.h"
 #include "chrome/browser/sync/profile_sync_service_observer.h"
+#include "chrome/browser/sync/sessions2/sessions_sync_manager.h"
 #include "chrome/browser/sync/sync_prefs.h"
 #include "components/browser_context_keyed_service/browser_context_keyed_service.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/browser/notification_types.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 "sync/internal_api/public/base/model_type.h"
 #include "sync/internal_api/public/engine/model_safe_worker.h"
 #include "sync/internal_api/public/sync_manager_factory.h"
 #include "sync/internal_api/public/util/experiments.h"
 #include "sync/internal_api/public/util/unrecoverable_error_handler.h"
 #include "sync/js/sync_js_controller.h"
 #include "url/gurl.h"
 
 class Profile;
 class ProfileOAuth2TokenService;
 class ProfileSyncComponentsFactory;
 class SigninManagerBase;
 class SyncGlobalError;
 
 namespace browser_sync {
 class BackendMigrator;
 class ChangeProcessor;
 class DataTypeManager;
 class DeviceInfo;
+class FaviconCache;
 class JsController;
+class OpenTabsUIDelegate;
 class SessionModelAssociator;
 
 namespace sessions {
 class SyncSessionSnapshot;
 }  // namespace sessions
 }  // namespace browser_sync
 
 namespace syncer {
 class BaseTransaction;
 struct SyncCredentials;
 struct UserShare;
 }  // namespace syncer
 
 namespace sync_pb {
 class EncryptedData;
 }  // namespace sync_pb
 
+using browser_sync::SessionsSyncManager;
+
 // ProfileSyncService is the layer between browser subsystems like bookmarks,
 // and the sync backend.  Each subsystem is logically thought of as being
 // a sync datatype.
 //
 // Individual datatypes can, at any point, be in a variety of stages of being
 // "enabled".  Here are some specific terms for concepts used in this class:
 //
 //   'Registered' (feature suppression for a datatype)
 //
 //      When a datatype is registered, the user has the option of syncing it.
@@ skipping 63 matching lines @@
 //   called while the user is actively configuring their account, and then
 //   SetSetupInProgress(false) should be called when configuration is complete.
 //   When SetSyncSetupCompleted() == false, but SetSetupInProgress(true) has
 //   been called, then the sync engine knows not to download any user data.
 //
 //   When initial sync is complete, the UI code should call
 //   SetSyncSetupCompleted() followed by SetSetupInProgress(false) - this will
 //   tell the sync engine that setup is completed and it can begin downloading
 //   data from the sync server.
 //
-class ProfileSyncService : public ProfileSyncServiceBase,
-                           public browser_sync::SyncFrontend,
-                           public browser_sync::SyncPrefObserver,
-                           public browser_sync::DataTypeManagerObserver,
-                           public syncer::UnrecoverableErrorHandler,
-                           public content::NotificationObserver,
-                           public BrowserContextKeyedService,
-                           public browser_sync::DataTypeEncryptionHandler,
-                           public OAuth2TokenService::Consumer,
-                           public OAuth2TokenService::Observer {
+class ProfileSyncService
+    : public ProfileSyncServiceBase,
+      public browser_sync::SyncFrontend,
+      public browser_sync::SyncPrefObserver,
+      public browser_sync::DataTypeManagerObserver,
+      public syncer::UnrecoverableErrorHandler,
+      public content::NotificationObserver,
+      public BrowserContextKeyedService,
+      public browser_sync::DataTypeEncryptionHandler,
+      public OAuth2TokenService::Consumer,
+      public OAuth2TokenService::Observer,
+      public SessionsSyncManager::SyncInternalApiDelegate {
  public:
   typedef browser_sync::SyncBackendHost::Status Status;
 
   // Status of sync server connection, sync token and token request.
   struct SyncTokenStatus {
     SyncTokenStatus();
     ~SyncTokenStatus();
 
     // Sync server connection status reported by sync backend.
     base::Time connection_status_update_time;
@@ skipping 110 matching lines @@
   // Registers a data type controller with the sync service.  This
   // makes the data type controller available for use, it does not
   // enable or activate the synchronization of the data type (see
   // ActivateDataType).  Takes ownership of the pointer.
   void RegisterDataTypeController(
       browser_sync::DataTypeController* data_type_controller);
 
   // Returns the session model associator associated with this type, but only if
   // the associator is running.  If it is doing anything else, it will return
   // null.
-  // TODO(zea): Figure out a better way to expose this to the UI elements that
-  // need it.
-  virtual browser_sync::SessionModelAssociator* GetSessionModelAssociator();
+  //
+  // ### DONT USE THIS ANYMORE! ***

[rlarocque, 2013/11/18 23:20:08]

That's a pretty strong comment.

nit: Could you be consistent in the use of * vs #?

[tim (not reviewing), 2013/11/20 18:38:57]

Yeah, I want to be a bit scary :)  I'll be removing this Real Soon Now with any
luck.

+  // If you think you want to use this, think again! Can you use
+  // GetOpenTabsUIDelegate instead?
+  // TODO(tim): Remove this method.
+  virtual browser_sync::SessionModelAssociator*
+      GetSessionModelAssociatorDeprecated();
 
+  // Return the active OpenTabsUIDelegate. If sessions is not enabled or not
+  // currently syncing, returns NULL.
+  virtual browser_sync::OpenTabsUIDelegate* GetOpenTabsUIDelegate();
+
+  // Returns the SyncableService for syncer::SESSIONS.
+  virtual syncer::SyncableService* GetSessionsSyncableService();
+
+  // SyncInternalApiDelegate implementation.
+  //
   // Returns sync's representation of the local device info.
   // Return value is an empty scoped_ptr if the device info is unavailable.
-  virtual scoped_ptr<browser_sync::DeviceInfo> GetLocalDeviceInfo() const;
+  virtual scoped_ptr<browser_sync::DeviceInfo> GetLocalDeviceInfo()
+      const OVERRIDE;
+
+  // Gets the guid for the local device. Can be used by other layers to
+  // to distinguish sync data that belongs to the local device vs data
+  // that belongs to remote devices. Returns empty string if sync is not
+  // initialized.
+  virtual std::string GetLocalDeviceGUID() const OVERRIDE;

[rlarocque, 2013/11/18 23:20:08]

Is this the sync cache GUID?  If so, could you rename this method to make that
more explicit?  You might also want to mention the lifetime of this ID (It gets
reset when we sign out and sign back in to sync, or when we receive a birthday
error, etc.)

The reason I make this comment is that there's more than one client GUID. 
Invalidations has its own ID with its own lifecycle.  

[tim (not reviewing), 2013/11/20 18:38:57]

Good point.  I actually had it called CacheGuid (see sessions_sync_manager.h),
but since I wrote that patch someone checked in this method in
ProfileSyncService and I decided to consolidate them.  But I'll change and
update the callsites of this method.

 
   // Returns sync's representation of the device info for a client identified
   // by |client_id|. Return value is an empty scoped ptr if the device info
   // is unavailable.
   virtual scoped_ptr<browser_sync::DeviceInfo> GetDeviceInfo(
       const std::string& client_id) const;
 
   // Gets the device info for all devices signed into the account associated
   // with this profile.
   virtual ScopedVector<browser_sync::DeviceInfo> GetAllSignedInDevices() const;
 
-  // Gets the partnership guid for the local device. Can be used by other
-  // layers to distinguish sync data that belongs to the local device vs
-  // data that belong to remote devices. Returns null if sync is not
-  // initialized.
-  virtual std::string GetLocalDeviceGUID() const;
-
   // Notifies the observer of any device info changes.
   virtual void AddObserverForDeviceInfoChange(
       browser_sync::SyncedDeviceTracker::Observer* observer);
 
   // Removes the observer from device info notification.
   virtual void RemoveObserverForDeviceInfoChange(
       browser_sync::SyncedDeviceTracker::Observer* observer);
 
   // Fills state_map with a map of current data types that are possible to
   // sync, as well as their states.
@@ skipping 332 matching lines @@
 
   // Called when a datatype (SyncableService) has a need for sync to start
   // ASAP, presumably because a local change event has occurred but we're
   // still in deferred start mode, meaning the SyncableService hasn't been
   // told to MergeDataAndStartSyncing yet.
   void OnDataTypeRequestsSyncStartup(syncer::ModelType type);
 
   // Return sync token status.
   SyncTokenStatus GetSyncTokenStatus() const;
 
+  browser_sync::FaviconCache* GetFaviconCache();
+
  protected:
   // Used by test classes that derive from ProfileSyncService.
   virtual browser_sync::SyncBackendHost* GetBackendForTest();
 
   // Helper to configure the priority data types.
   void ConfigurePriorityDataTypes();
 
   // Helper to install and configure a data type manager.
   void ConfigureDataTypeManager();
 
@@ skipping 319 matching lines @@
   base::WeakPtrFactory<ProfileSyncService> weak_factory_;
 
   // States related to sync token and connection.
   base::Time connection_status_update_time_;
   syncer::ConnectionStatus connection_status_;
   base::Time token_request_time_;
   base::Time token_receive_time_;
   GoogleServiceAuthError last_get_token_error_;
   base::Time next_token_request_time_;
 
+  scoped_ptr<SessionsSyncManager> sessions_sync_manager_;
+
   DISALLOW_COPY_AND_ASSIGN(ProfileSyncService);
 };
 
 bool ShouldShowActionOnUI(
     const syncer::SyncProtocolError& error);
 
 
 #endif  // CHROME_BROWSER_SYNC_PROFILE_SYNC_SERVICE_H_