sync: Report GetUpdate triggers to the server

sync/engine/sync_scheduler_impl.cc

Index: sync/engine/sync_scheduler_impl.cc
diff --git a/sync/engine/sync_scheduler_impl.cc b/sync/engine/sync_scheduler_impl.cc
index 2b2a127b7f8120c9f2a4117b32b7ef2081b26117..0ad6580bf4bae78c9aadd56d0c5b622f9ba40548 100644
--- a/sync/engine/sync_scheduler_impl.cc
+++ b/sync/engine/sync_scheduler_impl.cc
@@ -227,7 +227,8 @@ void SyncSchedulerImpl::Start(Mode mode) {
   mode_ = mode;
   AdjustPolling(UPDATE_INTERVAL);  // Will kick start poll timer if needed.
 
-  if (old_mode != mode_ && mode_ == NORMAL_MODE && !nudge_tracker_.IsEmpty()) {
+  if (old_mode != mode_ && mode_ == NORMAL_MODE &&
+      nudge_tracker_.SyncRequired()) {
     // We just got back to normal mode.  Let's try to run the work that was
     // queued up while we were configuring.
     DoNudgeSyncSessionJob(NORMAL_PRIORITY);
@@ -354,53 +355,55 @@ bool SyncSchedulerImpl::CanRunNudgeJobNow(JobPriority priority) {
   return true;
 }
 
-void SyncSchedulerImpl::ScheduleNudgeAsync(
+void SyncSchedulerImpl::ScheduleLocalNudge(
     const TimeDelta& desired_delay,
-    NudgeSource source, ModelTypeSet types,
+    ModelTypeSet types,
     const tracked_objects::Location& nudge_location) {
   DCHECK(CalledOnValidThread());
+  DCHECK(!types.Empty());
+
   SDVLOG_LOC(nudge_location, 2)
-      << "Nudge scheduled with delay "
-      << desired_delay.InMilliseconds() << " ms, "
-      << "source " << GetNudgeSourceString(source) << ", "
-      << "types " << ModelTypeSetToString(types);
+      << "Scheduling sync because of local change to "
+      << ModelTypeSetToString(types);
+  UpdateNudgeTimeRecords(types);
+  nudge_tracker_.RecordLocalChange(types);
+  ScheduleNudgeImpl(desired_delay, nudge_location);
+}
 
-  ModelTypeInvalidationMap invalidation_map =
-      ModelTypeSetToInvalidationMap(types, std::string());
-  SyncSchedulerImpl::ScheduleNudgeImpl(desired_delay,
-                                       GetUpdatesFromNudgeSource(source),
-                                       invalidation_map,
-                                       nudge_location);
+void SyncSchedulerImpl::ScheduleLocalRefreshRequest(
+    const TimeDelta& desired_delay,
+    ModelTypeSet types,
+    const tracked_objects::Location& nudge_location) {
+  DCHECK(CalledOnValidThread());
+  DCHECK(!types.Empty());
+
+  SDVLOG_LOC(nudge_location, 2)
+      << "Scheduling sync because of local refresch request for "
+      << ModelTypeSetToString(types);
+  nudge_tracker_.RecordLocalRefreshRequest(types);
+  ScheduleNudgeImpl(desired_delay, nudge_location);
 }
 
-void SyncSchedulerImpl::ScheduleNudgeWithStatesAsync(
+void SyncSchedulerImpl::ScheduleInvalidation(

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

ScheduleInvalidationNudge seems better, to distinguish it from something that
sounds like it might call directly into ticl.

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

Done.

     const TimeDelta& desired_delay,
-    NudgeSource source, const ModelTypeInvalidationMap& invalidation_map,
+    const ModelTypeInvalidationMap& invalidation_map,
     const tracked_objects::Location& nudge_location) {
   DCHECK(CalledOnValidThread());
+  DCHECK(!invalidation_map.empty());
+
   SDVLOG_LOC(nudge_location, 2)
-      << "Nudge scheduled with delay "
-      << desired_delay.InMilliseconds() << " ms, "
-      << "source " << GetNudgeSourceString(source) << ", "
-      << "payloads "
+      << "Scheduling sync because we received invalidation for "
       << ModelTypeInvalidationMapToString(invalidation_map);
-
-  SyncSchedulerImpl::ScheduleNudgeImpl(desired_delay,
-                                       GetUpdatesFromNudgeSource(source),
-                                       invalidation_map,
-                                       nudge_location);
+  nudge_tracker_.RecordRemoteInvalidation(invalidation_map);
+  ScheduleNudgeImpl(desired_delay, nudge_location);
 }
 
-
 // TODO(zea): Consider adding separate throttling/backoff for datatype
 // refresh requests.
 void SyncSchedulerImpl::ScheduleNudgeImpl(
     const TimeDelta& delay,
-    GetUpdatesCallerInfo::GetUpdatesSource source,
-    const ModelTypeInvalidationMap& invalidation_map,
     const tracked_objects::Location& nudge_location) {
   DCHECK(CalledOnValidThread());
-  DCHECK(!invalidation_map.empty()) << "Nudge scheduled for no types!";
 
   if (no_scheduling_allowed_) {
     NOTREACHED() << "Illegal to schedule job while session in progress.";
@@ -415,16 +418,7 @@ void SyncSchedulerImpl::ScheduleNudgeImpl(
 
   SDVLOG_LOC(nudge_location, 2)
       << "In ScheduleNudgeImpl with delay "
-      << delay.InMilliseconds() << " ms, "
-      << "source " << GetUpdatesSourceString(source) << ", "
-      << "payloads "
-      << ModelTypeInvalidationMapToString(invalidation_map);
-
-  SyncSourceInfo info(source, invalidation_map);
-  UpdateNudgeTimeRecords(info);
-
-  // Coalesce the new nudge information with any existing information.
-  nudge_tracker_.CoalesceSources(info);
+      << delay.InMilliseconds() << " ms";
 
   if (!CanRunNudgeJobNow(NORMAL_PRIORITY))
     return;
@@ -473,7 +467,10 @@ void SyncSchedulerImpl::DoNudgeSyncSessionJob(JobPriority priority) {
 
   DVLOG(2) << "Will run normal mode sync cycle with routing info "
            << ModelSafeRoutingInfoToString(session_context_->routing_info());
-  SyncSession session(session_context_, this, nudge_tracker_.source_info());
+  SyncSession session(session_context_,
+                      this,
+                      nudge_tracker_.source_info(),
+                      &nudge_tracker_);
   bool premature_exit = !syncer_->SyncShare(&session, SYNCER_BEGIN, SYNCER_END);
   AdjustPolling(FORCE_RESET);
 
@@ -484,7 +481,7 @@ void SyncSchedulerImpl::DoNudgeSyncSessionJob(JobPriority priority) {
   if (success) {
     // That cycle took care of any outstanding work we had.
     SDVLOG(2) << "Nudge succeeded.";
-    nudge_tracker_.Reset();
+    nudge_tracker_.RecordSuccessfulSyncCycle();
     scheduled_nudge_time_ = base::TimeTicks();
 
     // If we're here, then we successfully reached the server.  End all backoff.
@@ -581,27 +578,19 @@ void SyncSchedulerImpl::DoPollSyncSessionJob() {
   }
 }
 
-void SyncSchedulerImpl::UpdateNudgeTimeRecords(const SyncSourceInfo& info) {
+void SyncSchedulerImpl::UpdateNudgeTimeRecords(ModelTypeSet types) {
   DCHECK(CalledOnValidThread());
-
-  // We are interested in recording time between local nudges for datatypes.
-  // TODO(tim): Consider tracking LOCAL_NOTIFICATION as well.
-  if (info.updates_source != GetUpdatesCallerInfo::LOCAL)
-    return;
-
   base::TimeTicks now = TimeTicks::Now();
   // Update timing information for how often datatypes are triggering nudges.
-  for (ModelTypeInvalidationMap::const_iterator iter = info.types.begin();
-       iter != info.types.end();
-       ++iter) {
-    base::TimeTicks previous = last_local_nudges_by_model_type_[iter->first];
-    last_local_nudges_by_model_type_[iter->first] = now;
+  for (ModelTypeSet::Iterator iter = types.First(); iter.Good(); iter.Inc()) {
+    base::TimeTicks previous = last_local_nudges_by_model_type_[iter.Get()];
+    last_local_nudges_by_model_type_[iter.Get()] = now;
     if (previous.is_null())
       continue;
 
 #define PER_DATA_TYPE_MACRO(type_str) \
     SYNC_FREQ_HISTOGRAM("Sync.Freq" type_str, now - previous);
-    SYNC_DATA_TYPE_HISTOGRAM(iter->first);
+    SYNC_DATA_TYPE_HISTOGRAM(iter.Get());
 #undef PER_DATA_TYPE_MACRO
   }
 }
@@ -693,7 +682,7 @@ void SyncSchedulerImpl::TryCanaryJob() {
   if (mode_ == CONFIGURATION_MODE && pending_configure_params_) {
     SDVLOG(2) << "Found pending configure job; will run as canary";
     DoConfigurationSyncSessionJob(CANARY_PRIORITY);
-  } else if (mode_ == NORMAL_MODE && !nudge_tracker_.IsEmpty()) {
+  } else if (mode_ == NORMAL_MODE && nudge_tracker_.SyncRequired()) {

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

Tangential question, would NORMAL_MODE be better renamed to NUDGE_MODE?

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

I actually like the name NORMAL_MODE.  I think it does a good job of
communicating the most important property of that mode (that it's the "normal"
state of the scheduler), even if it doesn't explain what the mode does.  

NUDGE_MODE doesn't make a lot of sense unless you already understand what a
"nudge" is.  

[tim (not reviewing), 2013/05/07 20:34:13]

Fair, I like NORMAL_MODE as well.

     SDVLOG(2) << "Found pending nudge job; will run as canary";
     DoNudgeSyncSessionJob(CANARY_PRIORITY);
   } else {
@@ -813,6 +802,11 @@ void SyncSchedulerImpl::OnSyncProtocolError(
 void SyncSchedulerImpl::SetNotificationsEnabled(bool notifications_enabled) {
   DCHECK(CalledOnValidThread());
   session_context_->set_notifications_enabled(notifications_enabled);
+  if (notifications_enabled) {
+    nudge_tracker_.InvalidationsEnabled();
+  } else {
+    nudge_tracker_.InvalidationsDisabled();
+  }
 }
 
 base::TimeDelta SyncSchedulerImpl::GetSessionsCommitDelay() const {