Add activity recording capability to gcm internals page. User can refresh, start/stop recording, an…

chrome/browser/ui/webui/gcm_internals_ui.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 "chrome/browser/ui/webui/gcm_internals_ui.h"
 
+#include <vector>
+
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/format_macros.h"
 #include "base/memory/weak_ptr.h"
 #include "base/strings/stringprintf.h"
 #include "base/values.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/services/gcm/gcm_profile_service.h"
 #include "chrome/browser/services/gcm/gcm_profile_service_factory.h"
 #include "chrome/common/url_constants.h"
 #include "content/public/browser/web_ui.h"
 #include "content/public/browser/web_ui_controller.h"
 #include "content/public/browser/web_ui_data_source.h"
 #include "content/public/browser/web_ui_message_handler.h"
 #include "google_apis/gcm/gcm_client.h"
 #include "grit/browser_resources.h"
 
 namespace {
 
+void SetCheckinInfos(
+    const std::vector<gcm::GCMStatsRecorder::CheckinActivity>& checkins,
+    base::ListValue* checkinInfo) {
+  for (std::vector<gcm::GCMStatsRecorder::CheckinActivity>::const_iterator it =
+         checkins.begin();
+       it < checkins.end();

[jianli, 2014/03/18 23:53:23]

nit: !=

[juyik, 2014/03/20 01:09:53]

Done.

+       ++it) {
+    base::ListValue* row = new base::ListValue();
+    checkinInfo->Append(row);
+
+    row->AppendDouble(it->time.ToJsTime());
+    row->AppendString(it->GetTypeString());
+    row->AppendString(base::StringPrintf("%" PRId64, it->android_id));
+    row->AppendString(it->details);
+  }
+}
+
+void SetRegisterInfo(
+    const std::vector<gcm::GCMStatsRecorder::RegisterActivity>& registers,
+    base::ListValue* registerInfo) {
+  for (std::vector<gcm::GCMStatsRecorder::RegisterActivity>::const_iterator it =
+         registers.begin();
+       it < registers.end();
+       ++it) {
+    base::ListValue* row = new base::ListValue();
+    registerInfo->Append(row);
+
+    row->AppendDouble(it->time.ToJsTime());
+    row->AppendString(it->GetTypeString());
+    row->AppendString(it->app_id);
+    row->AppendString(it->sender_id);
+    row->AppendString(it->details);
+  }
+}
+
+void SetSendInfo(
+    const std::vector<gcm::GCMStatsRecorder::SendMessageActivity>& sends,
+    base::ListValue* sendInfo) {
+  std::vector<gcm::GCMStatsRecorder::SendMessageActivity>::const_iterator it =
+     sends.begin();
+  for (; it < sends.end(); ++it) {
+    base::ListValue* row = new base::ListValue();
+    sendInfo->Append(row);
+
+    row->AppendDouble(it->time.ToJsTime());
+    row->AppendString(it->GetTypeString());
+    row->AppendString(it->app_id);
+    row->AppendString(it->receiver_id);
+    row->AppendString(it->message_id);
+    row->AppendString(it->details);
+  }
+}
+
+void SetReceiveInfo(
+    const std::vector<gcm::GCMStatsRecorder::ReceiveMessageActivity>& receives,
+    base::ListValue* sendInfo) {
+  std::vector<gcm::GCMStatsRecorder::ReceiveMessageActivity>::const_iterator
+      it = receives.begin();
+  for (; it < receives.end(); ++it) {
+    base::ListValue* row = new base::ListValue();
+    sendInfo->Append(row);
+
+    row->AppendDouble(it->time.ToJsTime());
+    row->AppendString(it->GetTypeString());
+    row->AppendString(it->sender_id);
+    row->AppendString(it->app_id);
+    row->AppendInteger(it->message_size);
+    row->AppendString(it->details);
+  }
+}
+
 // Class acting as a controller of the chrome://gcm-internals WebUI.
 class GcmInternalsUIMessageHandler : public content::WebUIMessageHandler {
  public:
   GcmInternalsUIMessageHandler();
   virtual ~GcmInternalsUIMessageHandler();
 
   // WebUIMessageHandler implementation.
   virtual void RegisterMessages() OVERRIDE;
 
  private:
   // Return all of the GCM related infos to the gcm-internals page by calling
   // Javascript callback function
   // |gcm-internals.returnInfo()|.
   void ReturnResults(Profile* profile, gcm::GCMProfileService* profile_service,
                      const gcm::GCMClient::GCMStatistics* stats) const;
 
   // Request all of the GCM related infos through gcm profile service.
   void RequestAllInfo(const base::ListValue* args);
 
+  // Enables/disables GCM activity recording through gcm profile service.
+  void SetRecording(const base::ListValue* args);
+
   // Callback function of the request for all gcm related infos.
   void RequestGCMStatisticsFinished(
       const gcm::GCMClient::GCMStatistics& args) const;
 
   // Factory for creating references in callbacks.
   base::WeakPtrFactory<GcmInternalsUIMessageHandler> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(GcmInternalsUIMessageHandler);
 };
 
 GcmInternalsUIMessageHandler::GcmInternalsUIMessageHandler()
     : weak_ptr_factory_(this) {}
 
 GcmInternalsUIMessageHandler::~GcmInternalsUIMessageHandler() {}
 
 void GcmInternalsUIMessageHandler::ReturnResults(
     Profile* profile,
     gcm::GCMProfileService* profile_service,
     const gcm::GCMClient::GCMStatistics* stats) const {
   base::DictionaryValue results;
+  results.SetBoolean("isRecording", stats->is_recording);
   base::DictionaryValue* device_info = new base::DictionaryValue();
   results.Set("deviceInfo", device_info);
 
   device_info->SetBoolean("profileServiceCreated", profile_service != NULL);
   device_info->SetString("gcmEnabledState",
       gcm::GCMProfileService::GetGCMEnabledStateString(
           gcm::GCMProfileService::GetGCMEnabledState(profile)));
   if (profile_service) {
     device_info->SetString("signedInUserName",
                            profile_service->SignedInUserName());
     device_info->SetBoolean("gcmClientReady",
                             profile_service->IsGCMClientReady());
   }
   if (stats) {
     device_info->SetBoolean("gcmClientCreated", stats->gcm_client_created);
     device_info->SetString("gcmClientState", stats->gcm_client_state);
     device_info->SetBoolean("connectionClientCreated",
                             stats->connection_client_created);
+    device_info->SetString("appIdsCached", stats->app_ids_cached);
     if (stats->connection_client_created)
       device_info->SetString("connectionState", stats->connection_state);
     if (stats->android_id > 0) {
       device_info->SetString("androidId",
           base::StringPrintf("0x%" PRIx64, stats->android_id));
     }
+    if (stats->send_queue_size > 0)
+      device_info->SetInteger("sendQueueSize", stats->send_queue_size);
+    if (stats->unacked_queue_size > 0)
+      device_info->SetInteger("unackedQueueSize", stats->unacked_queue_size);
+
+    if (stats->checkins.size() > 0) {
+      base::ListValue* checkinInfo = new base::ListValue();
+      results.Set("checkinInfo", checkinInfo);
+      SetCheckinInfos(stats->checkins, checkinInfo);
+    }
+    if (stats->registers.size() > 0) {
+      base::ListValue* registerInfo = new base::ListValue();
+      results.Set("registerInfo", registerInfo);
+      SetRegisterInfo(stats->registers, registerInfo);
+    }
+    if (stats->sent_messages.size() > 0) {
+      base::ListValue* sendInfo = new base::ListValue();
+      results.Set("sendInfo", sendInfo);
+      SetSendInfo(stats->sent_messages, sendInfo);
+    }
+    if (stats->received_messages.size() > 0) {
+      base::ListValue* receiveInfo = new base::ListValue();
+      results.Set("receiveInfo", receiveInfo);
+      SetReceiveInfo(stats->received_messages, receiveInfo);
+    }
   }
   web_ui()->CallJavascriptFunction("gcmInternals.setGcmInternalsInfo",
                                    results);
 }
 
 void GcmInternalsUIMessageHandler::RequestAllInfo(
     const base::ListValue* args) {
+  if (args->GetSize() != 1) {
+    NOTREACHED();
+    return;
+  }
+  bool clear_logs = false;
+  if (!args->GetBoolean(0, &clear_logs)) {
+    NOTREACHED();
+    return;
+  }
+
   Profile* profile = Profile::FromWebUI(web_ui());
   gcm::GCMProfileService* profile_service =
     gcm::GCMProfileServiceFactory::GetForProfile(profile);
+
+  if (!profile_service) {

[fgorski, 2014/03/18 21:28:37]

this is the place we identified as a problem.

[juyik, 2014/03/20 01:09:53]

I looked into it deeper and now it doesn't seemed to be the cause. For example
when I opened an incognito window the information does show, while the profile
service was null. Then Jian and I found out that  username_ being empty is
causing the problem.

+    ReturnResults(profile, NULL, NULL);
+  } else {
+    profile_service->RequestGCMStatistics(
+        base::Bind(&GcmInternalsUIMessageHandler::RequestGCMStatisticsFinished,
+                   weak_ptr_factory_.GetWeakPtr()),
+        clear_logs);
+  }
+}
+
+void GcmInternalsUIMessageHandler::SetRecording(const base::ListValue* args) {
+  if (args->GetSize() != 1) {
+    NOTREACHED();
+    return;
+  }
+  bool recording = false;
+  if (!args->GetBoolean(0, &recording)) {
+    NOTREACHED();
+    return;
+  }
+
+  Profile* profile = Profile::FromWebUI(web_ui());
+  gcm::GCMProfileService* profile_service =
+    gcm::GCMProfileServiceFactory::GetForProfile(profile);
 
   if (!profile_service) {
     ReturnResults(profile, NULL, NULL);
   } else {
-    profile_service->RequestGCMStatistics(base::Bind(
-        &GcmInternalsUIMessageHandler::RequestGCMStatisticsFinished,
-        weak_ptr_factory_.GetWeakPtr()));
+    // Get fresh stats after changing recording setting.
+    profile_service->SetGCMRecording(
+        base::Bind(
+            &GcmInternalsUIMessageHandler::RequestGCMStatisticsFinished,
+            weak_ptr_factory_.GetWeakPtr()),
+        recording);
   }
 }
 
 void GcmInternalsUIMessageHandler::RequestGCMStatisticsFinished(
     const gcm::GCMClient::GCMStatistics& stats) const {
   Profile* profile = Profile::FromWebUI(web_ui());
   DCHECK(profile);
   gcm::GCMProfileService* profile_service =
       gcm::GCMProfileServiceFactory::GetForProfile(profile);
   DCHECK(profile_service);
   ReturnResults(profile, profile_service, &stats);
 }
 
 void GcmInternalsUIMessageHandler::RegisterMessages() {
   web_ui()->RegisterMessageCallback(
       "getGcmInternalsInfo",
       base::Bind(&GcmInternalsUIMessageHandler::RequestAllInfo,
                  base::Unretained(this)));
+  web_ui()->RegisterMessageCallback(
+      "setGcmInternalsRecording",
+      base::Bind(&GcmInternalsUIMessageHandler::SetRecording,
+                 base::Unretained(this)));
 }
 
 }  // namespace
 
 GCMInternalsUI::GCMInternalsUI(content::WebUI* web_ui)
     : content::WebUIController(web_ui) {
   // Set up the chrome://gcm-internals source.
   content::WebUIDataSource* html_source =
       content::WebUIDataSource::Create(chrome::kChromeUIGCMInternalsHost);
   html_source->SetUseJsonJSFormatV2();
 
   html_source->SetJsonPath("strings.js");
 
   // Add required resources.
   html_source->AddResourcePath("gcm_internals.css", IDR_GCM_INTERNALS_CSS);
   html_source->AddResourcePath("gcm_internals.js", IDR_GCM_INTERNALS_JS);
   html_source->SetDefaultResource(IDR_GCM_INTERNALS_HTML);
 
   Profile* profile = Profile::FromWebUI(web_ui);
   content::WebUIDataSource::Add(profile, html_source);
 
   web_ui->AddMessageHandler(new GcmInternalsUIMessageHandler());
 }
 
 GCMInternalsUI::~GCMInternalsUI() {}