Track merged nudge sources

sync/protocol/client_debug_info.proto

 // 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.
 //
 // Sync protocol for debug info clients can send to the sync server.
 
 syntax = "proto2";
 
 option optimize_for = LITE_RUNTIME;
 option retain_unknown_fields = true;
 
 package sync_pb;
 
 import "get_updates_caller_info.proto";
 
+// Per-type hint information.
+message TypeHint {
+  // The data type this hint applied to.
+  optional int32 data_type_id = 1;
+
+  // Whether or not a valid hint is provided.
+  optional bool has_valid_hint = 2;
+}
+
+// Information about the source that triggered a sync.
+message SourceInfo {
+  // An enum indicating the reason for the nudge.
+  optional GetUpdatesCallerInfo.GetUpdatesSource source = 1;
+
+  // The per-type hint information associated with the nudge.
+  repeated TypeHint type_hint = 2;
+}
+
 // The additional info here is from the StatusController. They get sent when
 // the event SYNC_CYCLE_COMPLETED  is sent.
 message SyncCycleCompletedEventInfo {
   // optional bool syncer_stuck = 1; // Was always false, now obsolete.
 
   // The client has never set these values correctly.  It set
   // num_blocking_conflicts to the total number of conflicts detected and set
   // num_non_blocking_conflicts to the number of blocking (aka. simple)
   // conflicts.
   //
   // These counters have been deprecated to avoid further confusion.  The newer
   // counters provide more detail and are less buggy.
   optional int32 num_blocking_conflicts = 2 [deprecated = true];
   optional int32 num_non_blocking_conflicts = 3 [deprecated = true];
 
   // These new conflict counters replace the ones above.
   optional int32 num_encryption_conflicts = 4;
   optional int32 num_hierarchy_conflicts = 5;
   optional int32 num_simple_conflicts = 6; // No longer sent since M24.
   optional int32 num_server_conflicts = 7;
 
   // Counts to track the effective usefulness of our GetUpdate requests.
   optional int32 num_updates_downloaded = 8;
   optional int32 num_reflected_updates_downloaded = 9;
   optional GetUpdatesCallerInfo caller_info = 10;

[Nicolas Zea, 2012/11/30 21:46:37]

out of curiosity, should this field be deprecated now?

[rlarocque, 2012/11/30 21:53:09]

I'll admit it's a bit redundant.  This will tell us what the client actually
sent up in the previously completed sync cycle.  The newly added counters below
will tell us all the sources that were merged together to form the caller_info
that was eventually sent.  

Although it should be possible to derive caller_info from source_info, it's not
trivial.  And I can foresee sawzall queries where we might want one or the
other.  Storing both will make some queries more convenient.

I think we should keep both for now and audit these fields once the scheduler
refactor is complete.

+
+  // A list of all the sources that were merged into this session.
+  //
+  // Some scenarios, notably mode switches and canary jobs, can spuriously add
+  // back-to-back duplicate sources to this list.
+  repeated SourceInfo source_info = 11;
 }
 
 // Datatype specifics statistics gathered at association time.
 message DatatypeAssociationStats {
   // The datatype that was associated.
   optional int32 data_type_id = 1;
 
   // The state of the world before association.
   optional int32 num_local_items_before_association = 2;
   optional int32 num_sync_items_before_association = 3;
@@ skipping 67 matching lines @@
   // Whether cryptographer is ready to encrypt and decrypt data.
   optional bool cryptographer_ready = 2;
 
   // Cryptographer has pending keys which indicates the correct passphrase
   // has not been provided yet.
   optional bool cryptographer_has_pending_keys = 3;
 
   // Indicates client has dropped some events to save bandwidth.
   optional bool events_dropped = 4;
 }