[Sync] Add support for server controlled nudge delays

sync/engine/syncer_unittest.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.
 //
 // Syncer unit tests. Unfortunately a lot of these tests
 // are outdated and need to be reworked and updated.
 
 #include <algorithm>
 #include <limits>
 #include <list>
@@ skipping 194 matching lines @@
     return false;
   }
   virtual void OnReceivedLongPollIntervalUpdate(
       const base::TimeDelta& new_interval) OVERRIDE {
     last_long_poll_interval_received_ = new_interval;
   }
   virtual void OnReceivedShortPollIntervalUpdate(
       const base::TimeDelta& new_interval) OVERRIDE {
     last_short_poll_interval_received_ = new_interval;
   }
-  virtual void OnReceivedSessionsCommitDelay(
-      const base::TimeDelta& new_delay) OVERRIDE {
-    last_sessions_commit_delay_seconds_ = new_delay;
+  virtual void OnReceivedCustomNudgeDelays(
+      const std::map<ModelType, base::TimeDelta>& delay_map) OVERRIDE {
+    std::map<ModelType, base::TimeDelta>::const_iterator iter =
+        delay_map.find(SESSIONS);
+    if (iter != delay_map.end() && iter->second > base::TimeDelta())
+      last_sessions_commit_delay_ = iter->second;
+    iter = delay_map.find(BOOKMARKS);
+    if (iter != delay_map.end() && iter->second > base::TimeDelta())
+      last_bookmarks_commit_delay_ = iter->second;
   }
   virtual void OnReceivedClientInvalidationHintBufferSize(
       int size) OVERRIDE {
     last_client_invalidation_hint_buffer_size_ = size;
   }
   virtual void OnReceivedGuRetryDelay(const base::TimeDelta& delay) OVERRIDE {}
   virtual void OnReceivedMigrationRequest(ModelTypeSet types) OVERRIDE {}
   virtual void OnProtocolEvent(const ProtocolEvent& event) OVERRIDE {}
   virtual void OnSyncProtocolError(const SyncProtocolError& error) OVERRIDE {}
 
@@ skipping 357 matching lines @@
   Syncer* syncer_;
 
   scoped_ptr<SyncSession> session_;
   TypeDebugInfoCache debug_info_cache_;
   MockNudgeHandler mock_nudge_handler_;
   scoped_ptr<ModelTypeRegistry> model_type_registry_;
   scoped_ptr<SyncSessionContext> context_;
   bool saw_syncer_event_;
   base::TimeDelta last_short_poll_interval_received_;
   base::TimeDelta last_long_poll_interval_received_;
-  base::TimeDelta last_sessions_commit_delay_seconds_;
+  base::TimeDelta last_sessions_commit_delay_;
+  base::TimeDelta last_bookmarks_commit_delay_;
   int last_client_invalidation_hint_buffer_size_;
   std::vector<scoped_refptr<ModelSafeWorker> > workers_;
 
   ModelTypeSet enabled_datatypes_;
   sessions::NudgeTracker nudge_tracker_;
   scoped_ptr<MockDebugInfoGetter> debug_info_getter_;
 
   DISALLOW_COPY_AND_ASSIGN(SyncerTest);
 };
 
@@ skipping 2993 matching lines @@
   }
 }
 
 TEST_F(SyncerTest, TestClientCommandDuringUpdate) {
   using sync_pb::ClientCommand;
 
   ClientCommand* command = new ClientCommand();
   command->set_set_sync_poll_interval(8);
   command->set_set_sync_long_poll_interval(800);
   command->set_sessions_commit_delay_seconds(3141);
+  sync_pb::CustomNudgeDelay* bookmark_delay =
+      command->add_custom_nudge_delays();
+  bookmark_delay->set_datatype_id(
+      GetSpecificsFieldNumberFromModelType(BOOKMARKS));
+  bookmark_delay->set_delay_ms(950);
   command->set_client_invalidation_hint_buffer_size(11);
   mock_server_->AddUpdateDirectory(1, 0, "in_root", 1, 1,
                                    foreign_cache_guid(), "-1");
   mock_server_->SetGUClientCommand(command);
   SyncShareNudge();
 
-  EXPECT_TRUE(TimeDelta::FromSeconds(8) ==
-              last_short_poll_interval_received_);
-  EXPECT_TRUE(TimeDelta::FromSeconds(800) ==
-              last_long_poll_interval_received_);
-  EXPECT_TRUE(TimeDelta::FromSeconds(3141) ==
-              last_sessions_commit_delay_seconds_);
+  EXPECT_EQ(TimeDelta::FromSeconds(8), last_short_poll_interval_received_);
+  EXPECT_EQ(TimeDelta::FromSeconds(800), last_long_poll_interval_received_);
+  EXPECT_EQ(TimeDelta::FromSeconds(3141), last_sessions_commit_delay_);
+  EXPECT_EQ(TimeDelta::FromMilliseconds(950), last_bookmarks_commit_delay_);
   EXPECT_EQ(11, last_client_invalidation_hint_buffer_size_);
 
   command = new ClientCommand();
   command->set_set_sync_poll_interval(180);
   command->set_set_sync_long_poll_interval(190);
   command->set_sessions_commit_delay_seconds(2718);
+  bookmark_delay = command->add_custom_nudge_delays();
+  bookmark_delay->set_datatype_id(
+      GetSpecificsFieldNumberFromModelType(BOOKMARKS));
+  bookmark_delay->set_delay_ms(1050);
   command->set_client_invalidation_hint_buffer_size(9);
-  mock_server_->AddUpdateDirectory(1, 0, "in_root", 1, 1,
-                                   foreign_cache_guid(), "-1");
+  mock_server_->AddUpdateDirectory(
+      1, 0, "in_root", 1, 1, foreign_cache_guid(), "-1");
   mock_server_->SetGUClientCommand(command);
   SyncShareNudge();
 
-  EXPECT_TRUE(TimeDelta::FromSeconds(180) ==
-              last_short_poll_interval_received_);
-  EXPECT_TRUE(TimeDelta::FromSeconds(190) ==
-              last_long_poll_interval_received_);
-  EXPECT_TRUE(TimeDelta::FromSeconds(2718) ==
-              last_sessions_commit_delay_seconds_);
+  EXPECT_EQ(TimeDelta::FromSeconds(180), last_short_poll_interval_received_);
+  EXPECT_EQ(TimeDelta::FromSeconds(190), last_long_poll_interval_received_);
+  EXPECT_EQ(TimeDelta::FromSeconds(2718), last_sessions_commit_delay_);
+  EXPECT_EQ(TimeDelta::FromMilliseconds(1050), last_bookmarks_commit_delay_);
   EXPECT_EQ(9, last_client_invalidation_hint_buffer_size_);
 }
 
 TEST_F(SyncerTest, TestClientCommandDuringCommit) {
   using sync_pb::ClientCommand;
 
   ClientCommand* command = new ClientCommand();
   command->set_set_sync_poll_interval(8);
   command->set_set_sync_long_poll_interval(800);
   command->set_sessions_commit_delay_seconds(3141);
+  sync_pb::CustomNudgeDelay* bookmark_delay =
+      command->add_custom_nudge_delays();
+  bookmark_delay->set_datatype_id(
+      GetSpecificsFieldNumberFromModelType(BOOKMARKS));
+  bookmark_delay->set_delay_ms(950);
   command->set_client_invalidation_hint_buffer_size(11);
   CreateUnsyncedDirectory("X", "id_X");
   mock_server_->SetCommitClientCommand(command);
   SyncShareNudge();
 
-  EXPECT_TRUE(TimeDelta::FromSeconds(8) ==
-              last_short_poll_interval_received_);
-  EXPECT_TRUE(TimeDelta::FromSeconds(800) ==
-              last_long_poll_interval_received_);
-  EXPECT_TRUE(TimeDelta::FromSeconds(3141) ==
-              last_sessions_commit_delay_seconds_);
+  EXPECT_EQ(TimeDelta::FromSeconds(8), last_short_poll_interval_received_);
+  EXPECT_EQ(TimeDelta::FromSeconds(800), last_long_poll_interval_received_);
+  EXPECT_EQ(TimeDelta::FromSeconds(3141), last_sessions_commit_delay_);
+  EXPECT_EQ(TimeDelta::FromMilliseconds(950), last_bookmarks_commit_delay_);
   EXPECT_EQ(11, last_client_invalidation_hint_buffer_size_);
 
   command = new ClientCommand();
   command->set_set_sync_poll_interval(180);
   command->set_set_sync_long_poll_interval(190);
   command->set_sessions_commit_delay_seconds(2718);
+  bookmark_delay = command->add_custom_nudge_delays();
+  bookmark_delay->set_datatype_id(
+      GetSpecificsFieldNumberFromModelType(BOOKMARKS));
+  bookmark_delay->set_delay_ms(1050);
   command->set_client_invalidation_hint_buffer_size(9);
   CreateUnsyncedDirectory("Y", "id_Y");
   mock_server_->SetCommitClientCommand(command);
   SyncShareNudge();
 
-  EXPECT_TRUE(TimeDelta::FromSeconds(180) ==
-              last_short_poll_interval_received_);
-  EXPECT_TRUE(TimeDelta::FromSeconds(190) ==
-              last_long_poll_interval_received_);
-  EXPECT_TRUE(TimeDelta::FromSeconds(2718) ==
-              last_sessions_commit_delay_seconds_);
+  EXPECT_EQ(TimeDelta::FromSeconds(180), last_short_poll_interval_received_);
+  EXPECT_EQ(TimeDelta::FromSeconds(190), last_long_poll_interval_received_);
+  EXPECT_EQ(TimeDelta::FromSeconds(2718), last_sessions_commit_delay_);
+  EXPECT_EQ(TimeDelta::FromMilliseconds(1050), last_bookmarks_commit_delay_);
   EXPECT_EQ(9, last_client_invalidation_hint_buffer_size_);
 }
 
 TEST_F(SyncerTest, EnsureWeSendUpOldParent) {
   syncable::Id folder_one_id = ids_.FromNumber(1);
   syncable::Id folder_two_id = ids_.FromNumber(2);
 
   mock_server_->AddUpdateDirectory(folder_one_id, TestIdFactory::root(),
       "folder_one", 1, 1, foreign_cache_guid(), "-1");
   mock_server_->AddUpdateDirectory(folder_two_id, TestIdFactory::root(),
@@ skipping 1344 matching lines @@
     EXPECT_EQ("xyz", final_monitor_records["xyz"].extension_id);
     EXPECT_EQ(2049U, final_monitor_records["ABC"].bookmark_write_count);
     EXPECT_EQ(4U,    final_monitor_records["xyz"].bookmark_write_count);
   } else {
     EXPECT_TRUE(final_monitor_records.empty())
         << "Should not restore records after successful bookmark commit.";
   }
 }
 
 }  // namespace syncer