[SYNC] Refactor SyncSourceInfo and add support in chrome invalidation client ...

chrome/browser/sync/sessions/sync_session.h

 // Copyright (c) 2010 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.
 
 // A class representing an attempt to synchronize the local syncable data
 // store with a sync server. A SyncSession instance is passed as a stateful
 // bundle to and from various SyncerCommands with the goal of converging the
 // client view of data with that of the server. The commands twiddle with
 // session status in response to events and hiccups along the way, set and
 // query session progress with regards to conflict resolution and applying
 // server updates, and access the SyncSessionContext for the current session
 // via SyncSession instances.
 
 #ifndef CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_H_
 #define CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_H_
 #pragma once
 
+#include <map>
+#include <string>
 #include <utility>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/scoped_ptr.h"
 #include "base/time.h"
+#include "chrome/browser/sync/engine/model_safe_worker.h"

[akalin, 2011/01/24 22:17:29]

I think you can forward declare ModelSafeRoutingInfo here and move this include
to the .cc file.

[Nicolas Zea, 2011/01/25 00:29:14]

ModelSafeRoutingInfo is a typedef, so can't be forward declared (unless i
redefine the typedef here itself, but that seems to defeat the purpose).
Anyways, there were other uses of the type in here, so I just turned it back to
how it was.

[akalin, 2011/01/26 01:15:17]

Ah, actually if it's a typedef, then we should include model_safe_worker.h here.

 #include "chrome/browser/sync/sessions/ordered_commit_set.h"
 #include "chrome/browser/sync/sessions/session_state.h"
 #include "chrome/browser/sync/sessions/status_controller.h"
 #include "chrome/browser/sync/sessions/sync_session_context.h"
+#include "chrome/browser/sync/syncable/model_type.h"
 #include "chrome/browser/sync/util/extensions_activity_monitor.h"
 
 namespace syncable {
 class WriteTransaction;
 }
 
 namespace browser_sync {
 class ModelSafeWorker;
 
 namespace sessions {
-typedef std::pair<sync_pb::GetUpdatesCallerInfo::GetUpdatesSource,
-    syncable::ModelTypeBitSet> SyncSourceInfo;
+
+// A container that contains a set of datatypes with possible string payloads.
+typedef std::map<syncable::ModelType, std::string> ModelTypeMap;

[akalin, 2011/01/24 22:17:29]

ModelTypeMap is a bit generic -- how about ModelTypePayloadMap or
TypePayloadMap?

[Nicolas Zea, 2011/01/25 00:29:14]

Done.

+
+// Helper utils for building ModelTypeMaps.
+void BuildModelTypeMapFromModelTypeBitSet(

[akalin, 2011/01/24 22:17:29]

These names are a bit long.  I suggest:

ModelTypeBitSetToTypePayloadMap()
RoutingInfoToTypePayloadMap()

Also, I think it's safer to make it return the TypePayloadMap directly.

[Nicolas Zea, 2011/01/25 00:29:14]

Done.

+    const syncable::ModelTypeBitSet& types,
+    const std::string& payload,
+    ModelTypeMap* map);
+void BuildModelTypeMapFromModelSafeRoutingInfo(
+    const ModelSafeRoutingInfo& routes,
+    const std::string& payload,
+    ModelTypeMap* map);
+
+// A container for the source of a sync session. This includes the update
+// source, the datatypes triggering the sync session, and possible session
+// specific payloads which should be sent to the server.
+struct SyncSourceInfo {
+  SyncSourceInfo();
+  SyncSourceInfo(
+      const sync_pb::GetUpdatesCallerInfo::GetUpdatesSource& u,
+      const ModelTypeMap& t);
+
+  sync_pb::GetUpdatesCallerInfo::GetUpdatesSource updates_source;
+  ModelTypeMap types;
+};
 
 class SyncSession {
  public:
   // The Delegate services events that occur during the session requiring an
   // explicit (and session-global) action, as opposed to events that are simply
   // recorded in per-session state.
   class Delegate {
    public:
     // The client was throttled and should cease-and-desist syncing activity
     // until the specified time.
@@ skipping 113 matching lines @@
 
  private:
   SyncSession* session_;
   DISALLOW_COPY_AND_ASSIGN(ScopedSetSessionWriteTransaction);
 };
 
 }  // namespace sessions
 }  // namespace browser_sync
 
 #endif  // CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_H_