Link GCM heartbeat with wake on wifi preference

components/gcm_driver/gcm_driver_desktop.cc

 // Copyright 2014 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.
 
 #include "components/gcm_driver/gcm_driver_desktop.h"
 
 #include <utility>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/files/file_path.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/metrics/histogram.h"
 #include "base/sequenced_task_runner.h"
 #include "base/threading/sequenced_worker_pool.h"
 #include "components/gcm_driver/gcm_account_mapper.h"
 #include "components/gcm_driver/gcm_app_handler.h"
 #include "components/gcm_driver/gcm_channel_status_syncer.h"
 #include "components/gcm_driver/gcm_client_factory.h"
 #include "components/gcm_driver/gcm_delayed_task_controller.h"
 #include "components/gcm_driver/system_encryptor.h"
 #include "google_apis/gcm/engine/account_mapping.h"
 #include "net/base/ip_endpoint.h"
 #include "net/url_request/url_request_context_getter.h"
 
+#if defined(OS_CHROMEOS)
+#include "components/timers/alarm_timer.h"
+#include "google_apis/gcm/engine/heartbeat_manager.h"
+#include "google_apis/gcm/engine/mcs_client.h"
+#endif
+
 namespace gcm {
 
 class GCMDriverDesktop::IOWorker : public GCMClient::Delegate {
  public:
   // Called on UI thread.
   IOWorker(const scoped_refptr<base::SequencedTaskRunner>& ui_thread,
            const scoped_refptr<base::SequencedTaskRunner>& io_thread);
   virtual ~IOWorker();
 
   // Overridden from GCMClient::Delegate:
@@ skipping 37 matching lines @@
             const std::string& receiver_id,
             const GCMClient::OutgoingMessage& message);
   void GetGCMStatistics(bool clear_logs);
   void SetGCMRecording(bool recording);
 
   void SetAccountTokens(
       const std::vector<GCMClient::AccountTokenInfo>& account_tokens);
   void UpdateAccountMapping(const AccountMapping& account_mapping);
   void RemoveAccountMapping(const std::string& account_id);
   void SetLastTokenFetchTime(const base::Time& time);
+  void WakeFromSuspendForHeartbeat(bool wake);
 
   // For testing purpose. Can be called from UI thread. Use with care.
   GCMClient* gcm_client_for_testing() const { return gcm_client_.get(); }
 
  private:
   scoped_refptr<base::SequencedTaskRunner> ui_thread_;
   scoped_refptr<base::SequencedTaskRunner> io_thread_;
 
   base::WeakPtr<GCMDriverDesktop> service_;
 
@@ skipping 240 matching lines @@
     gcm_client_->RemoveAccountMapping(account_id);
 }
 
 void GCMDriverDesktop::IOWorker::SetLastTokenFetchTime(const base::Time& time) {
   DCHECK(io_thread_->RunsTasksOnCurrentThread());
 
   if (gcm_client_.get())
     gcm_client_->SetLastTokenFetchTime(time);
 }
 
+void GCMDriverDesktop::IOWorker::WakeFromSuspendForHeartbeat(bool wake) {
+#if defined(OS_CHROMEOS)
+  DCHECK(io_thread_->RunsTasksOnCurrentThread());
+  DCHECK(gcm_client_->GetMCSClient());
+
+  scoped_ptr<base::Timer> timer;
+  if (wake)
+    timer.reset(new timers::AlarmTimer(true, false));
+  else
+    timer.reset(new base::Timer(true, false));
+
+  gcm_client_->GetMCSClient()->heartbeat_manager()->UpdateHeartbeatTimer(
+      timer.Pass());
+#endif
+}
+
 GCMDriverDesktop::GCMDriverDesktop(
     scoped_ptr<GCMClientFactory> gcm_client_factory,
     const GCMClient::ChromeBuildInfo& chrome_build_info,
     const std::string& channel_status_request_url,
     const std::string& user_agent,
     PrefService* prefs,
     const base::FilePath& store_path,
     const scoped_refptr<net::URLRequestContextGetter>& request_context,
     const scoped_refptr<base::SequencedTaskRunner>& ui_thread,
     const scoped_refptr<base::SequencedTaskRunner>& io_thread,
@@ skipping 298 matching lines @@
 
   last_token_fetch_time_ = time;
 
   io_thread_->PostTask(
       FROM_HERE,
       base::Bind(&GCMDriverDesktop::IOWorker::SetLastTokenFetchTime,
                  base::Unretained(io_worker_.get()),
                  time));
 }
 
+void GCMDriverDesktop::WakeFromSuspendForHeartbeat(bool wake) {
+  DCHECK(ui_thread_->RunsTasksOnCurrentThread());
+
+  if (!IsStarted()) {
+    // The GCM service has not been started yet, either because the user has not
+    // signed in or because no apps/extensions are using GCM.  Queue this task
+    // to run whenever GCM does start up.
+    gcm_started_callback_ =

[Nicolas Zea, 2014/12/05 00:53:05]

I don't think we need a generic callback here until other tasks might actually
be run. We can just cache the wake value in a boolean
wake_from_suspend_enabled_, and pass that to the GCMClient when (or just after)
it gets created.

[Chirantan Ekbote, 2014/12/05 21:49:05]

Done.

+        base::Bind(&GCMDriverDesktop::WakeFromSuspendForHeartbeat,
+                   weak_ptr_factory_.GetWeakPtr(),
+                   wake);
+    return;
+  }
+
+  if (!delayed_task_controller_->CanRunTaskWithoutDelay()) {
+    // The GCM service has started but the client is not ready yet.
+    delayed_task_controller_->AddTask(
+        base::Bind(&GCMDriverDesktop::WakeFromSuspendForHeartbeat,
+                   weak_ptr_factory_.GetWeakPtr(),
+                   wake));
+    return;
+  }
+
+  // The GCMClient is ready so we can go ahead and post this task to the
+  // IOWorker.
+  io_thread_->PostTask(
+      FROM_HERE,
+      base::Bind(&GCMDriverDesktop::IOWorker::WakeFromSuspendForHeartbeat,
+                 base::Unretained(io_worker_.get()),
+                 wake));
+}
+
 void GCMDriverDesktop::SetAccountTokens(
     const std::vector<GCMClient::AccountTokenInfo>& account_tokens) {
   DCHECK(ui_thread_->RunsTasksOnCurrentThread());
 
   account_mapper_->SetAccountTokens(account_tokens);
 
   io_thread_->PostTask(
       FROM_HERE,
       base::Bind(&GCMDriverDesktop::IOWorker::SetAccountTokens,
                  base::Unretained(io_worker_.get()),
@@ skipping 35 matching lines @@
 
   // Note that we need to pass weak pointer again since the existing weak
   // pointer in IOWorker might have been invalidated when check-out occurs.
   io_thread_->PostTask(
       FROM_HERE,
       base::Bind(&GCMDriverDesktop::IOWorker::Start,
                  base::Unretained(io_worker_.get()),
                  weak_ptr_factory_.GetWeakPtr()));
 
   gcm_started_ = true;
+  if (!gcm_started_callback_.is_null()) {
+    gcm_started_callback_.Run();
+    gcm_started_callback_.Reset();
+  }
+
   return GCMClient::SUCCESS;
 }
 
 void GCMDriverDesktop::RemoveCachedData() {
   DCHECK(ui_thread_->RunsTasksOnCurrentThread());
   // Remove all the queued tasks since they no longer make sense after
   // GCM service is stopped.
   weak_ptr_factory_.InvalidateWeakPtrs();
 
   gcm_started_ = false;
@@ skipping 91 matching lines @@
   DCHECK(ui_thread_->RunsTasksOnCurrentThread());
 
   // Normally request_gcm_statistics_callback_ would not be null.
   if (!request_gcm_statistics_callback_.is_null())
     request_gcm_statistics_callback_.Run(stats);
   else
     LOG(WARNING) << "request_gcm_statistics_callback_ is NULL.";
 }
 
 }  // namespace gcm
-