sync: Report GetUpdate triggers to the server

sync/engine/download_updates_command.cc

 // Copyright 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 "sync/engine/download_updates_command.h"
 
 #include <string>
 
 #include "base/command_line.h"
 #include "sync/engine/syncer.h"
 #include "sync/engine/syncer_proto_util.h"
 #include "sync/internal_api/public/base/model_type_invalidation_map.h"
+#include "sync/sessions/nudge_tracker.h"
 #include "sync/syncable/directory.h"
 #include "sync/syncable/nigori_handler.h"
 #include "sync/syncable/syncable_read_transaction.h"
 
 using sync_pb::DebugInfo;
 
 namespace syncer {
 using sessions::StatusController;
 using sessions::SyncSession;
 using std::string;
@@ skipping 20 matching lines @@
       update_response.get_updates().encryption_keys(),
       &trans);
 
   DVLOG(1) << "GetUpdates returned "
            << update_response.get_updates().encryption_keys_size()
            << "encryption keys. Nigori keystore key "
            << (success ? "" : "not ") << "updated.";
   return (success ? SYNCER_OK : SERVER_RESPONSE_VALIDATION_FAILED);
 }
 
+sync_pb::SyncEnums::GetUpdatesOrigin ConvertGetUpdateSourceToOrigin(
+    sync_pb::GetUpdatesCallerInfo::GetUpdatesSource source) {
+  switch (source) {
+    // Configurations:
+    case sync_pb::GetUpdatesCallerInfo::NEWLY_SUPPORTED_DATATYPE:
+      return sync_pb::SyncEnums::NEWLY_SUPPORTED_DATATYPE;
+    case sync_pb::GetUpdatesCallerInfo::MIGRATION:
+      return sync_pb::SyncEnums::MIGRATION;
+    case sync_pb::GetUpdatesCallerInfo::RECONFIGURATION:
+      return sync_pb::SyncEnums::RECONFIGURATION;
+
+    // Poll, which never overlaps with anything else:
+    case sync_pb::GetUpdatesCallerInfo::PERIODIC:
+      return sync_pb::SyncEnums::PERIODIC;
+
+    // Overlapping normal-mode sources (fall-through is intentional):
+    case sync_pb::GetUpdatesCallerInfo::LOCAL:
+    case sync_pb::GetUpdatesCallerInfo::NOTIFICATION:
+    case sync_pb::GetUpdatesCallerInfo::DATATYPE_REFRESH:
+      return sync_pb::SyncEnums::GU_TRIGGER;
+
+    // Deprecated or invalid (fall-through is intentional):
+    case sync_pb::GetUpdatesCallerInfo::UNKNOWN:
+    case sync_pb::GetUpdatesCallerInfo::FIRST_UPDATE:
+    case sync_pb::GetUpdatesCallerInfo::SYNC_CYCLE_CONTINUATION:
+    case sync_pb::GetUpdatesCallerInfo::NEW_CLIENT:
+      NOTREACHED();
+      return sync_pb::SyncEnums::UNKNOWN_ORIGIN;
+  }
+}
+
 }  // namespace
 
 SyncerError DownloadUpdatesCommand::ExecuteImpl(SyncSession* session) {
   sync_pb::ClientToServerMessage client_to_server_message;
   sync_pb::ClientToServerResponse update_response;
 
   client_to_server_message.set_share(session->context()->account_name());
   client_to_server_message.set_message_contents(
       sync_pb::ClientToServerMessage::GET_UPDATES);
   sync_pb::GetUpdatesMessage* get_updates =
       client_to_server_message.mutable_get_updates();
   get_updates->set_create_mobile_bookmarks_folder(
       create_mobile_bookmarks_folder_);
 
+  sync_pb::SyncEnums::GetUpdatesOrigin origin =
+      ConvertGetUpdateSourceToOrigin(session->source().updates_source);
+
   syncable::Directory* dir = session->context()->directory();
 
   // Request updates for all enabled types.
   const ModelTypeSet enabled_types =
       GetRoutingInfoTypes(session->context()->routing_info());
   DVLOG(1) << "Getting updates for types "
            << ModelTypeSetToString(enabled_types);
   DCHECK(!enabled_types.Empty());
 
   const ModelTypeInvalidationMap& invalidation_map =
       session->source().types;
   for (ModelTypeSet::Iterator it = enabled_types.First();
        it.Good(); it.Inc()) {
     if (ProxyTypes().Has(it.Get()))
       continue;
     sync_pb::DataTypeProgressMarker* progress_marker =
         get_updates->add_from_progress_marker();
     dir->GetDownloadProgress(it.Get(), progress_marker);
 
     // Set notification hint if present.
     ModelTypeInvalidationMap::const_iterator find_it =
         invalidation_map.find(it.Get());
     if (find_it != invalidation_map.end()) {
       progress_marker->set_notification_hint(find_it->second.payload);
     }
+
+    if (session->nudge_tracker()) {
+      DCHECK_EQ(sync_pb::SyncEnums::GU_TRIGGER, origin);

[tim (not reviewing), 2013/05/06 21:29:04]

The real question we're asking is "What kind of GU is being requested here?". It
would flow more clearly if we ask that, rather than inferring it.

if (origin == sync_pb::SyncEnums::GU_TRIGGER) {
  session->nudge_tracker()->FillProtoMessage(
      ...;
} else {
  DCHECK(!session->nudge_tracker());
}

[rlarocque, 2013/05/07 18:45:39]

Done.

+      session->nudge_tracker()->FillProtoMessage(
+          it.Get(),
+          progress_marker->mutable_get_update_triggers());
+    } else {
+      DCHECK_NE(sync_pb::SyncEnums::GU_TRIGGER, origin);
+    }
   }
 
   bool need_encryption_key = false;
   if (session->context()->keystore_encryption_enabled()) {
     syncable::Directory* dir = session->context()->directory();
     syncable::ReadTransaction trans(FROM_HERE, dir);
     syncable::NigoriHandler* nigori_handler = dir->GetNigoriHandler();
     need_encryption_key = nigori_handler->NeedKeystoreKey(&trans);
     get_updates->set_need_encryption_key(need_encryption_key);
 
   }
 
   // We want folders for our associated types, always.  If we were to set
   // this to false, the server would send just the non-container items
   // (e.g. Bookmark URLs but not their containing folders).
   get_updates->set_fetch_folders(true);
 
   // Set GetUpdatesMessage.GetUpdatesCallerInfo information.
   get_updates->mutable_caller_info()->set_source(
       session->source().updates_source);
   get_updates->mutable_caller_info()->set_notifications_enabled(
       session->context()->notifications_enabled());
 
+  // Set the new and improved version of source, too.
+  get_updates->set_get_updates_origin(origin);
+
   DebugInfo* debug_info = client_to_server_message.mutable_debug_info();
 
   AppendClientDebugInfoIfNeeded(session, debug_info);
 
   SyncerError result = SyncerProtoUtil::PostClientToServerMessage(
       &client_to_server_message,
       &update_response,
       session);
 
   DVLOG(2) << SyncerProtoUtil::ClientToServerResponseDebugString(
@@ skipping 34 matching lines @@
     // could be null in some unit tests.
     if (session->context()->debug_info_getter()) {
       session->context()->debug_info_getter()->GetAndClearDebugInfo(
           debug_info);
     }
     session->mutable_status_controller()->set_debug_info_sent();
   }
 }
 
 }  // namespace syncer