[GCM] Wiring heartbeat interval calls to GCMDriver

Wires the call to Add/RemoveHeartbeatInterval through:
* GCMDriver/Desktop/Android/Fake
* GCMDriverDesktop::IOWorker
* GCMClient/Impl to MCSClient
* Adding loading of persisted interval in MCSClient

BUG=481174

Review URL: https://codereview.chromium.org/1124783002

Cr-Commit-Position: refs/heads/master@{#329750}

4 files changed, 271 insertions, 73 deletions

diff --git a/google_apis/gcm/engine/gcm_store.cc b/google_apis/gcm/engine/gcm_store.cc
index 6f5ab0e..c698528 100644
--- a/google_apis/gcm/engine/gcm_store.cc
+++ b/google_apis/gcm/engine/gcm_store.cc
@@ -26,6 +26,7 @@ void GCMStore::LoadResult::Reset() {
   last_token_fetch_time = base::Time::FromInternalValue(0LL);
   last_checkin_accounts.clear();
   account_mappings.clear();
+  heartbeat_intervals.clear();
   success = false;
   instance_id_data.clear();
 }
diff --git a/google_apis/gcm/engine/mcs_client.cc b/google_apis/gcm/engine/mcs_client.cc
index 3b1016d..9b4607d 100644
--- a/google_apis/gcm/engine/mcs_client.cc
+++ b/google_apis/gcm/engine/mcs_client.cc
@@ -276,6 +276,12 @@ void MCSClient::Initialize(
         collapse_key_map_[collapse_key] = packet_info;
     }
   }
+
+  // Establish if there is any custom client interval persisted from the last
+  // run and set it on the heartbeat manager.
+  custom_heartbeat_intervals_.swap(load_result->heartbeat_intervals);
+  int min_interval_ms = GetMinHeartbeatIntervalMs();
+  heartbeat_manager_.SetClientHeartbeatIntervalMs(min_interval_ms);
 }
 
 void MCSClient::Login(uint64 android_id, uint64 security_token) {
@@ -380,19 +386,25 @@ void MCSClient::AddHeartbeatInterval(const std::string& scope,
     return;
 
   custom_heartbeat_intervals_[scope] = interval_ms;
-  // TODO(fgorski): Save in the gcm store as well.
+  gcm_store_->AddHeartbeatInterval(scope, interval_ms,
+                                   base::Bind(&MCSClient::OnGCMUpdateFinished,
+                                              weak_ptr_factory_.GetWeakPtr()));
 
-  int min_interval_ms = GetMinCustomHeartbeatInterval();
+  int min_interval_ms = GetMinHeartbeatIntervalMs();
   heartbeat_manager_.SetClientHeartbeatIntervalMs(min_interval_ms);
 }
 
 void MCSClient::RemoveHeartbeatInterval(const std::string& scope) {
   custom_heartbeat_intervals_.erase(scope);
-  int min_interval = GetMinCustomHeartbeatInterval();
+  gcm_store_->RemoveHeartbeatInterval(
+      scope, base::Bind(&MCSClient::OnGCMUpdateFinished,
+                        weak_ptr_factory_.GetWeakPtr()));
+
+  int min_interval = GetMinHeartbeatIntervalMs();
   heartbeat_manager_.SetClientHeartbeatIntervalMs(min_interval);
 }
 
-int MCSClient::GetMinCustomHeartbeatInterval() {
+int MCSClient::GetMinHeartbeatIntervalMs() {
   if (custom_heartbeat_intervals_.empty())
     return kNoCustomHeartbeat;
 
diff --git a/google_apis/gcm/engine/mcs_client.h b/google_apis/gcm/engine/mcs_client.h
index a81bcbe..8d35fd4 100644
--- a/google_apis/gcm/engine/mcs_client.h
+++ b/google_apis/gcm/engine/mcs_client.h
@@ -160,8 +160,8 @@ class GCM_EXPORT MCSClient {
   void AddHeartbeatInterval(const std::string& scope, int interval_ms);
   void RemoveHeartbeatInterval(const std::string& scope);
 
-  HeartbeatManager& GetHeartbeatManagerForTesting() {
-    return heartbeat_manager_;
+  HeartbeatManager* GetHeartbeatManagerForTesting() {
+    return &heartbeat_manager_;
   }
 
  private:
@@ -225,8 +225,9 @@ class GCM_EXPORT MCSClient {
   // any associated state).
   MCSPacketInternal PopMessageForSend();
 
-  // Gets the minimum interval from the map of scopes to intervals.
-  int GetMinCustomHeartbeatInterval();
+  // Gets the minimum interval from the map of scopes to intervals in
+  // milliseconds.
+  int GetMinHeartbeatIntervalMs();
 
   // Local version string. Sent on login.
   const std::string version_string_;
diff --git a/google_apis/gcm/engine/mcs_client_unittest.cc b/google_apis/gcm/engine/mcs_client_unittest.cc
index 1b6d2ef..644c702 100644
--- a/google_apis/gcm/engine/mcs_client_unittest.cc
+++ b/google_apis/gcm/engine/mcs_client_unittest.cc
@@ -113,8 +113,11 @@ class MCSClientTest : public testing::Test {
   void InitializeClient();
   void StoreCredentials();
   void LoginClient(const std::vector<std::string>& acknowledged_ids);
+  void LoginClientWithHeartbeat(
+      const std::vector<std::string>& acknowledged_ids,
+      int heartbeat_interval_ms);
   void AddExpectedLoginRequest(const std::vector<std::string>& acknowledged_ids,
-                               int custom_heartbeat_interval);
+                               int heartbeat_interval_ms);
 
   base::SimpleTestClock* clock() { return &clock_; }
   TestMCSClient* mcs_client() const { return mcs_client_.get(); }
@@ -209,7 +212,13 @@ void MCSClientTest::InitializeClient() {
 
 void MCSClientTest::LoginClient(
     const std::vector<std::string>& acknowledged_ids) {
-  AddExpectedLoginRequest(acknowledged_ids, 0);
+  LoginClientWithHeartbeat(acknowledged_ids, 0);
+}
+
+void MCSClientTest::LoginClientWithHeartbeat(
+    const std::vector<std::string>& acknowledged_ids,
+    int heartbeat_interval_ms) {
+  AddExpectedLoginRequest(acknowledged_ids, heartbeat_interval_ms);
   mcs_client_->Login(kAndroidId, kSecurityToken);
   run_loop_->Run();
   run_loop_.reset(new base::RunLoop());
@@ -217,15 +226,15 @@ void MCSClientTest::LoginClient(
 
 void MCSClientTest::AddExpectedLoginRequest(
     const std::vector<std::string>& acknowledged_ids,
-    int custom_heartbeat_interval) {
+    int heartbeat_interval_ms) {
   scoped_ptr<mcs_proto::LoginRequest> login_request =
       BuildLoginRequest(kAndroidId, kSecurityToken, "");
   for (size_t i = 0; i < acknowledged_ids.size(); ++i)
     login_request->add_received_persistent_id(acknowledged_ids[i]);
-  if (custom_heartbeat_interval) {
+  if (heartbeat_interval_ms) {
     mcs_proto::Setting* setting = login_request->add_setting();
     setting->set_name("hbping");
-    setting->set_value(base::IntToString(custom_heartbeat_interval));
+    setting->set_value(base::IntToString(heartbeat_interval_ms));
   }
   GetFakeHandler()->ExpectOutgoingMessage(
       MCSMessage(kLoginRequestTag, login_request.Pass()));
@@ -898,97 +907,272 @@ TEST_F(MCSClientTest, CollapseKeysDifferentUser) {
   PumpLoop();
 }
 
-// Tests adding and removing custom heartbeat interval.
-TEST_F(MCSClientTest, CustomHeartbeatInterval) {
+// Test case for setting a custom heartbeat interval, when it is too short.
+// Covers both connection restart and storing of custom intervals.
+TEST_F(MCSClientTest, CustomHeartbeatIntervalTooShort) {
   BuildMCSClient();
   InitializeClient();
   LoginClient(std::vector<std::string>());
+  PumpLoop();
+  StoreCredentials();
 
-  TestConnectionListener test_connection_listener;
-  connection_factory()->SetConnectionListener(&test_connection_listener);
-
-  HeartbeatManager& hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  HeartbeatManager* hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
   // By default custom client interval is not set.
-  EXPECT_FALSE(hb_manager.HasClientHeartbeatInterval());
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
 
   const std::string component_1 = "component1";
   int interval_ms = 30 * 1000;  // 30 seconds, too low.
   mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
   // Setting was too low so it was ignored.
-  EXPECT_FALSE(hb_manager.HasClientHeartbeatInterval());
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
+
+  // Restore and check again to make sure that nothing was set in store.
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), 0);
+  PumpLoop();
+
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
+}
 
-  interval_ms = 60 * 60 * 1000;  // 1 hour, too high.
+// Test case for setting a custom heartbeat interval, when it is too long.
+// Covers both connection restart and storing of custom intervals.
+TEST_F(MCSClientTest, CustomHeartbeatIntervalTooLong) {
+  BuildMCSClient();
+  InitializeClient();
+  LoginClient(std::vector<std::string>());
+  PumpLoop();
+  StoreCredentials();
+
+  HeartbeatManager* hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+
+  const std::string component_1 = "component1";
+  int interval_ms = 60 * 60 * 1000;  // 1 hour, too high.
   mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
   // Setting was too high, again it was ignored.
-  EXPECT_FALSE(hb_manager.HasClientHeartbeatInterval());
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
+
+  // Restore and check again to make sure that nothing was set in store.
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), 0);
+  PumpLoop();
+
+  // Setting was too high, again it was ignored.
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
+}
 
-  int expected_disconnect_counter = 0;
-  EXPECT_EQ(expected_disconnect_counter,
-            test_connection_listener.get_disconnect_counter());
+// Tests adding and removing custom heartbeat interval.
+// Covers both connection restart and storing of custom intervals.
+TEST_F(MCSClientTest, CustomHeartbeatIntervalSingleInterval) {
+  BuildMCSClient();
+  InitializeClient();
+  LoginClient(std::vector<std::string>());
+  PumpLoop();
+  StoreCredentials();
+
+  TestConnectionListener test_connection_listener;
+  connection_factory()->SetConnectionListener(&test_connection_listener);
+
+  HeartbeatManager* hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+
+  const std::string component_1 = "component1";
+  int interval_ms = 5 * 60 * 1000;  // 5 minutes. A valid setting.
 
-  interval_ms = 5 * 60 * 1000;  // 5 minutes. A valid setting.
   AddExpectedLoginRequest(std::vector<std::string>(), interval_ms);
   mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
-  // Setting was OK. HearbeatManager should get that setting now.
-  EXPECT_TRUE(hb_manager.HasClientHeartbeatInterval());
-  EXPECT_EQ(interval_ms, hb_manager.GetClientHeartbeatIntervalMs());
+  PumpLoop();
+
+  // Interval was OK. HearbeatManager should get that setting now.
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
+  EXPECT_EQ(1, test_connection_listener.get_disconnect_counter());
+
+  // Check that setting was persisted and will take effect upon restart.
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), interval_ms);
+  PumpLoop();
+
+  // HB manger uses the shortest persisted interval after restart.
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
+
+  mcs_client()->RemoveHeartbeatInterval(component_1);
+  PumpLoop();
+
+  // Check that setting was persisted and will take effect upon restart.
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), 0);
+  PumpLoop();
+
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_FALSE(hb_manager->HasClientHeartbeatInterval());
+}
+
+// Tests adding custom heartbeat interval before connection is initialized.
+TEST_F(MCSClientTest, CustomHeartbeatIntervalSetBeforeInitialize) {
+  BuildMCSClient();
+
+  const std::string component_1 = "component1";
+  int interval_ms = 5 * 60 * 1000;  // 5 minutes. A valid setting.
+  mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), interval_ms);
+  HeartbeatManager* hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+}
+
+// Tests adding custom heartbeat interval after connection is initialized, but
+// but before login is sent.
+TEST_F(MCSClientTest, CustomHeartbeatIntervalSetBeforeLogin) {
+  BuildMCSClient();
+
+  const std::string component_1 = "component1";
+  int interval_ms = 5 * 60 * 1000;  // 5 minutes. A valid setting.
+  InitializeClient();
+  mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
+  LoginClientWithHeartbeat(std::vector<std::string>(), interval_ms);
+  HeartbeatManager* hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+}
+
+// Tests situation when two heartbeat intervals are set and second is longer.
+// Covers both connection restart and storing of custom intervals.
+TEST_F(MCSClientTest, CustomHeartbeatIntervalSecondIntervalLonger) {
+  BuildMCSClient();
+  InitializeClient();
+  LoginClient(std::vector<std::string>());
+  PumpLoop();
+  StoreCredentials();
+
+  TestConnectionListener test_connection_listener;
+  connection_factory()->SetConnectionListener(&test_connection_listener);
+
+  HeartbeatManager* hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
 
-  ++expected_disconnect_counter;
-  EXPECT_EQ(expected_disconnect_counter,
-            test_connection_listener.get_disconnect_counter());
+  const std::string component_1 = "component1";
+  int interval_ms = 5 * 60 * 1000;  // 5 minutes. A valid setting.
+
+  AddExpectedLoginRequest(std::vector<std::string>(), interval_ms);
+  mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
+  PumpLoop();
 
   const std::string component_2 = "component2";
   int other_interval_ms = 10 * 60 * 1000;  // 10 minutes. A valid setting.
   mcs_client()->AddHeartbeatInterval(component_2, other_interval_ms);
-  // Setting was OK, but higher than the previous setting and HearbeatManager
-  // will not be updated.
-  EXPECT_TRUE(hb_manager.HasClientHeartbeatInterval());
-  EXPECT_EQ(interval_ms, hb_manager.GetClientHeartbeatIntervalMs());
-  // No connection reset expected.
-  EXPECT_EQ(expected_disconnect_counter,
-            test_connection_listener.get_disconnect_counter());
+  PumpLoop();
+
+  // Interval was OK, but longer. HearbeatManager will use the first one.
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
+  EXPECT_EQ(1, test_connection_listener.get_disconnect_counter());
+
+  // Check that setting was persisted and will take effect upon restart.
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), interval_ms);
+  PumpLoop();
 
-  other_interval_ms = 3 * 60 * 1000;  // 3 minutes. A valid setting.
+  // HB manger uses the shortest persisted interval after restart.
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
+}
+
+// Tests situation when two heartbeat intervals are set and second is shorter.
+// Covers both connection restart and storing of custom intervals.
+TEST_F(MCSClientTest, CustomHeartbeatIntervalSecondIntervalShorter) {
+  BuildMCSClient();
+  InitializeClient();
+  LoginClient(std::vector<std::string>());
+  PumpLoop();
+  StoreCredentials();
+
+  TestConnectionListener test_connection_listener;
+  connection_factory()->SetConnectionListener(&test_connection_listener);
+
+  HeartbeatManager* hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+
+  const std::string component_1 = "component1";
+  int interval_ms = 5 * 60 * 1000;  // 5 minutes. A valid setting.
+
+  AddExpectedLoginRequest(std::vector<std::string>(), interval_ms);
+  mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
+  PumpLoop();
+
+  const std::string component_2 = "component2";
+  int other_interval_ms = 3 * 60 * 1000;  // 3 minutes. A valid setting.
   AddExpectedLoginRequest(std::vector<std::string>(), other_interval_ms);
   mcs_client()->AddHeartbeatInterval(component_2, other_interval_ms);
-  // Setting was OK and lower then present setting. HearbeatManager should get
-  // that setting now.
-  EXPECT_TRUE(hb_manager.HasClientHeartbeatInterval());
-  EXPECT_EQ(other_interval_ms, hb_manager.GetClientHeartbeatIntervalMs());
-  ++expected_disconnect_counter;
-  EXPECT_EQ(expected_disconnect_counter,
-            test_connection_listener.get_disconnect_counter());
+  PumpLoop();
+  // Interval was OK. HearbeatManager should get that setting now.
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(other_interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
+  EXPECT_EQ(2, test_connection_listener.get_disconnect_counter());
 
-  mcs_client()->RemoveHeartbeatInterval(component_2);
-  // Removing the lowest setting reverts to second lowest.
-  EXPECT_TRUE(hb_manager.HasClientHeartbeatInterval());
-  EXPECT_EQ(interval_ms, hb_manager.GetClientHeartbeatIntervalMs());
-  // No connection reset expected.
-  EXPECT_EQ(expected_disconnect_counter,
-            test_connection_listener.get_disconnect_counter());
+  // Check that setting was persisted and will take effect upon restart.
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), other_interval_ms);
+  PumpLoop();
 
-  mcs_client()->RemoveHeartbeatInterval(component_1);
-  // Removing all of the intervals, removes it from the HeartbeatManager.
-  EXPECT_FALSE(hb_manager.HasClientHeartbeatInterval());
-  // No connection reset expected.
-  EXPECT_EQ(expected_disconnect_counter,
-            test_connection_listener.get_disconnect_counter());
+  // HB manger uses the shortest persisted interval after restart.
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(other_interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
+}
 
-  mcs_client()->AddHeartbeatInterval(component_2, other_interval_ms);
+// Tests situation shorter of two intervals is removed.
+// Covers both connection restart and storing of custom intervals.
+TEST_F(MCSClientTest, CustomHeartbeatIntervalRemoveShorterInterval) {
+  BuildMCSClient();
+  InitializeClient();
+  LoginClient(std::vector<std::string>());
+  PumpLoop();
+  StoreCredentials();
+
+  TestConnectionListener test_connection_listener;
+  connection_factory()->SetConnectionListener(&test_connection_listener);
+
+  HeartbeatManager* hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+
+  const std::string component_1 = "component1";
+  int interval_ms = 5 * 60 * 1000;  // 5 minutes. A valid setting.
+
+  AddExpectedLoginRequest(std::vector<std::string>(), interval_ms);
   mcs_client()->AddHeartbeatInterval(component_1, interval_ms);
-  EXPECT_TRUE(hb_manager.HasClientHeartbeatInterval());
-  EXPECT_EQ(other_interval_ms, hb_manager.GetClientHeartbeatIntervalMs());
-  // No connection reset expected.
-  EXPECT_EQ(expected_disconnect_counter,
-            test_connection_listener.get_disconnect_counter());
+  PumpLoop();
 
-  // Removing interval other than lowest does not change anything.
-  mcs_client()->RemoveHeartbeatInterval(component_1);
-  EXPECT_TRUE(hb_manager.HasClientHeartbeatInterval());
-  EXPECT_EQ(other_interval_ms, hb_manager.GetClientHeartbeatIntervalMs());
+  const std::string component_2 = "component2";
+  int other_interval_ms = 3 * 60 * 1000;  // 3 minutes. A valid setting.
+  AddExpectedLoginRequest(std::vector<std::string>(), other_interval_ms);
+  mcs_client()->AddHeartbeatInterval(component_2, other_interval_ms);
+  PumpLoop();
+
+  mcs_client()->RemoveHeartbeatInterval(component_2);
+  PumpLoop();
+
+  // Removing the lowest setting reverts to second lowest.
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
   // No connection reset expected.
-  EXPECT_EQ(expected_disconnect_counter,
-            test_connection_listener.get_disconnect_counter());
+  EXPECT_EQ(2, test_connection_listener.get_disconnect_counter());
+
+  // Check that setting was persisted and will take effect upon restart.
+  BuildMCSClient();
+  InitializeClient();
+  LoginClientWithHeartbeat(std::vector<std::string>(), interval_ms);
+  PumpLoop();
+
+  // HB manger uses the shortest persisted interval after restart.
+  hb_manager = mcs_client()->GetHeartbeatManagerForTesting();
+  EXPECT_TRUE(hb_manager->HasClientHeartbeatInterval());
+  EXPECT_EQ(interval_ms, hb_manager->GetClientHeartbeatIntervalMs());
 }
 
 } // namespace