[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}

components/gcm_driver/fake_gcm_client.cc

@@ -148,6 +148,13 @@ std::string FakeGCMClient::GetInstanceIDData(const std::string& app_id) {
   return std::string();
 }
 
+void FakeGCMClient::AddHeartbeatInterval(const std::string& scope,
+                                         int interval_ms) {
+}
+
+void FakeGCMClient::RemoveHeartbeatInterval(const std::string& scope) {
+}
+
 void FakeGCMClient::PerformDelayedStart() {
   DCHECK(ui_thread_->RunsTasksOnCurrentThread());
 

components/gcm_driver/fake_gcm_client.h

@@ -60,6 +60,8 @@ class FakeGCMClient : public GCMClient {
                          const std::string& instance_id_data) override;
   void RemoveInstanceIDData(const std::string& app_id) override;
   std::string GetInstanceIDData(const std::string& app_id) override;
+  void AddHeartbeatInterval(const std::string& scope, int interval_ms) override;
+  void RemoveHeartbeatInterval(const std::string& scope) override;
 
   // Initiate the start that has been delayed.
   // Called on UI thread.

components/gcm_driver/fake_gcm_driver.cc

@@ -102,4 +102,11 @@ InstanceIDStore* FakeGCMDriver::GetInstanceIDStore() {
   return NULL;
 }
 
+void FakeGCMDriver::AddHeartbeatInterval(const std::string& scope,
+                                         int interval_ms) {
+}
+
+void FakeGCMDriver::RemoveHeartbeatInterval(const std::string& scope) {
+}
+
 }  // namespace gcm

components/gcm_driver/fake_gcm_driver.h

@@ -42,6 +42,8 @@ class FakeGCMDriver : public GCMDriver {
   void SetLastTokenFetchTime(const base::Time& time) override;
   void WakeFromSuspendForHeartbeat(bool wake) override;
   InstanceIDStore* GetInstanceIDStore() override;
+  void AddHeartbeatInterval(const std::string& scope, int interval_ms) override;
+  void RemoveHeartbeatInterval(const std::string& scope) override;
 
  protected:
   // GCMDriver implementation:

components/gcm_driver/gcm_client.h

@@ -320,6 +320,14 @@ class GCMClient {
   // Retrieves the Instance ID data for a specific app from the persistent
   // store.
   virtual std::string GetInstanceIDData(const std::string& app_id) = 0;
+
+  // Gets and sets custom heartbeat interval for the MCS connection.
+  // |scope| is used to identify the component that requests a custom interval
+  // to be set, and allows that component to later revoke the setting. It should
+  // be unique.
+  virtual void AddHeartbeatInterval(const std::string& scope,
+                                    int interval_ms) = 0;
+  virtual void RemoveHeartbeatInterval(const std::string& scope) = 0;
 };
 
 }  // namespace gcm

components/gcm_driver/gcm_client_impl.cc

@@ -556,6 +556,17 @@ std::string GCMClientImpl::GetInstanceIDData(const std::string& app_id) {
   return iter->second;
 }
 
+void GCMClientImpl::AddHeartbeatInterval(const std::string& scope,
+                                         int interval_ms) {
+  DCHECK(mcs_client_);
+  mcs_client_->AddHeartbeatInterval(scope, interval_ms);
+}
+
+void GCMClientImpl::RemoveHeartbeatInterval(const std::string& scope) {
+  DCHECK(mcs_client_);
+  mcs_client_->RemoveHeartbeatInterval(scope);
+}
+
 void GCMClientImpl::StartCheckin() {
   // Make sure no checkin is in progress.
   if (checkin_request_.get())

components/gcm_driver/gcm_client_impl.h

@@ -130,6 +130,8 @@ class GCMClientImpl
                          const std::string& instance_id_data) override;
   void RemoveInstanceIDData(const std::string& app_id) override;
   std::string GetInstanceIDData(const std::string& app_id) override;
+  void AddHeartbeatInterval(const std::string& scope, int interval_ms) override;
+  void RemoveHeartbeatInterval(const std::string& scope) override;
 
   // GCMStatsRecorder::Delegate implemenation.
   void OnActivityRecorded() override;

components/gcm_driver/gcm_driver.h

@@ -169,6 +169,28 @@ class GCMDriver {
   // Supports saving the Instance ID data in the GCM store.
   virtual InstanceIDStore* GetInstanceIDStore() = 0;
 
+  // Adds or removes a custom client requested heartbeat interval. If multiple
+  // components set that setting, the lowest setting will be used. If the
+  // setting is outside of GetMax/MinClientHeartbeatIntervalMs() it will be
+  // ignored. If a new setting is less than the currently used, the connection
+  // will be reset with the new heartbeat. Client that no longer require
+  // aggressive heartbeats, should remove their requested interval. Heartbeats
+  // set this way survive connection/Chrome restart.
+  //
+  // GCM Driver can decide to postpone the action until Client is properly
+  // initialized, hence this setting can be called at any time.
+  //
+  // Server can overwrite the setting to a different value.
+  //
+  // |scope| is used to identify the component that requests a custom interval
+  // to be set, and allows that component to later revoke the setting.
+  // |interval_ms| should be between 2 minues and 15 minues (28 minues on
+  // cellular networks). For details check
+  // GetMin/MaxClientHeartbeatItnervalMs() in HeartbeatManager.
+  virtual void AddHeartbeatInterval(const std::string& scope,
+                                    int interval_ms) = 0;
+  virtual void RemoveHeartbeatInterval(const std::string& scope) = 0;
+
  protected:
   // Ensures that the GCM service starts (if necessary conditions are met).
   virtual GCMClient::Result EnsureStarted(GCMClient::StartMode start_mode) = 0;

components/gcm_driver/gcm_driver_android.cc

@@ -167,6 +167,13 @@ InstanceIDStore* GCMDriverAndroid::GetInstanceIDStore() {
   return NULL;
 }
 
+void GCMDriverAndroid::AddHeartbeatInterval(const std::string& scope,
+                                            int interval_ms) {
+}
+
+void GCMDriverAndroid::RemoveHeartbeatInterval(const std::string& scope) {
+}
+
 GCMClient::Result GCMDriverAndroid::EnsureStarted(
     GCMClient::StartMode start_mode) {
   // TODO(johnme): Maybe we should check if GMS is available?

components/gcm_driver/gcm_driver_android.h

@@ -65,6 +65,8 @@ class GCMDriverAndroid : public GCMDriver {
   void SetLastTokenFetchTime(const base::Time& time) override;
   void WakeFromSuspendForHeartbeat(bool wake) override;
   InstanceIDStore* GetInstanceIDStore() override;
+  void AddHeartbeatInterval(const std::string& scope, int interval_ms) override;
+  void RemoveHeartbeatInterval(const std::string& scope) override;
 
  protected:
   // GCMDriver implementation:

components/gcm_driver/gcm_driver_desktop.cc

@@ -91,6 +91,8 @@ class GCMDriverDesktop::IOWorker : public GCMClient::Delegate {
                          const std::string& instance_id_data);
   void RemoveInstanceIDData(const std::string& app_id);
   void GetInstanceIDData(const std::string& app_id);
+  void AddHeartbeatInterval(const std::string& scope, int interval_ms);
+  void RemoveHeartbeatInterval(const std::string& scope);
 
   // For testing purpose. Can be called from UI thread. Use with care.
   GCMClient* gcm_client_for_testing() const { return gcm_client_.get(); }
@@ -392,6 +394,18 @@ void GCMDriverDesktop::IOWorker::WakeFromSuspendForHeartbeat(bool wake) {
 #endif
 }
 
+void GCMDriverDesktop::IOWorker::AddHeartbeatInterval(const std::string& scope,
+                                                      int interval_ms) {
+  DCHECK(io_thread_->RunsTasksOnCurrentThread());
+  gcm_client_->AddHeartbeatInterval(scope, interval_ms);
+}
+
+void GCMDriverDesktop::IOWorker::RemoveHeartbeatInterval(
+    const std::string& scope) {
+  DCHECK(io_thread_->RunsTasksOnCurrentThread());
+  gcm_client_->RemoveHeartbeatInterval(scope);
+}
+
 GCMDriverDesktop::GCMDriverDesktop(
     scoped_ptr<GCMClientFactory> gcm_client_factory,
     const GCMClient::ChromeBuildInfo& chrome_build_info,
@@ -768,6 +782,49 @@ void GCMDriverDesktop::WakeFromSuspendForHeartbeat(bool wake) {
                  wake_from_suspend_enabled_));
 }
 
+void GCMDriverDesktop::AddHeartbeatInterval(const std::string& scope,
+                                            int interval_ms) {
+  DCHECK(ui_thread_->RunsTasksOnCurrentThread());
+
+  // The GCM service has not been initialized.
+  if (!delayed_task_controller_)
+    return;
+
+  if (!delayed_task_controller_->CanRunTaskWithoutDelay()) {
+    // The GCM service was initialized but has not started yet.
+    delayed_task_controller_->AddTask(
+        base::Bind(&GCMDriverDesktop::AddHeartbeatInterval,
+                   weak_ptr_factory_.GetWeakPtr(), scope, interval_ms));
+    return;
+  }
+
+  io_thread_->PostTask(
+      FROM_HERE,
+      base::Bind(&GCMDriverDesktop::IOWorker::AddHeartbeatInterval,
+                 base::Unretained(io_worker_.get()), scope, interval_ms));
+}
+
+void GCMDriverDesktop::RemoveHeartbeatInterval(const std::string& scope) {
+  DCHECK(ui_thread_->RunsTasksOnCurrentThread());
+
+  // The GCM service has not been initialized.
+  if (!delayed_task_controller_)
+    return;
+
+  if (!delayed_task_controller_->CanRunTaskWithoutDelay()) {
+    // The GCM service was initialized but has not started yet.
+    delayed_task_controller_->AddTask(
+        base::Bind(&GCMDriverDesktop::RemoveHeartbeatInterval,
+                   weak_ptr_factory_.GetWeakPtr(), scope));
+    return;
+  }
+
+  io_thread_->PostTask(
+      FROM_HERE,
+      base::Bind(&GCMDriverDesktop::IOWorker::RemoveHeartbeatInterval,
+                 base::Unretained(io_worker_.get()), scope));
+}
+
 void GCMDriverDesktop::SetAccountTokens(
     const std::vector<GCMClient::AccountTokenInfo>& account_tokens) {
   DCHECK(ui_thread_->RunsTasksOnCurrentThread());

components/gcm_driver/gcm_driver_desktop.h

@@ -85,6 +85,8 @@ class GCMDriverDesktop : public GCMDriver,
   void SetLastTokenFetchTime(const base::Time& time) override;
   void WakeFromSuspendForHeartbeat(bool wake) override;
   InstanceIDStore* GetInstanceIDStore() override;
+  void AddHeartbeatInterval(const std::string& scope, int interval_ms) override;
+  void RemoveHeartbeatInterval(const std::string& scope) override;
 
   // InstanceIDStore overrides:
   void AddInstanceIDData(const std::string& app_id,

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();
 }

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;
 

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_;