chrome://snippets-internals page for debugging NTP snippets.

chrome/browser/ui/webui/snippets_internals_message_handler.cc

Index: chrome/browser/ui/webui/snippets_internals_message_handler.cc
diff --git a/chrome/browser/ui/webui/snippets_internals_message_handler.cc b/chrome/browser/ui/webui/snippets_internals_message_handler.cc
new file mode 100644
index 0000000000000000000000000000000000000000..1ea9a6526a4c1acc24d62b576397697d3da8b230
--- /dev/null
+++ b/chrome/browser/ui/webui/snippets_internals_message_handler.cc
@@ -0,0 +1,223 @@
+// Copyright 2016 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/snippets_internals_message_handler.h"
+
+#include <memory>
+#include <set>
+#include <sstream>
+#include <vector>
+
+#include "base/bind.h"
+#include "base/bind_helpers.h"
+#include "base/command_line.h"
+#include "base/feature_list.h"
+#include "base/i18n/time_formatting.h"
+#include "base/logging.h"
+#include "base/strings/string_number_conversions.h"
+#include "base/strings/string_piece.h"
+#include "base/strings/string_split.h"
+#include "base/values.h"
+#include "chrome/browser/android/chrome_feature_list.h"
+#include "chrome/browser/ntp_snippets/ntp_snippets_service_factory.h"
+#include "chrome/browser/profiles/profile.h"
+#include "components/ntp_snippets/ntp_snippet.h"
+#include "components/ntp_snippets/switches.h"
+#include "content/public/browser/web_ui.h"
+
+namespace {
+
+std::unique_ptr<base::DictionaryValue> PrepareSnippet(
+    const ntp_snippets::NTPSnippet& snippet,
+    int index,
+    bool discarded) {
+  std::unique_ptr<base::DictionaryValue> entry(new base::DictionaryValue);
+  entry->SetString("title", snippet.title());
+  entry->SetString("siteTitle", snippet.site_title());
+  entry->SetString("snippet", snippet.snippet());
+  entry->SetString("published",
+                   TimeFormatShortDateAndTime(snippet.publish_date()));
+  entry->SetString("expires",
+                   TimeFormatShortDateAndTime(snippet.expiry_date()));
+  entry->SetString("url", snippet.url().spec());
+  entry->SetString("faviconUrl", snippet.favicon_url().spec());
+  entry->SetString("salientImageUrl", snippet.salient_image_url().spec());
+
+  if (discarded)
+    entry->SetString("id", "discarded-snippet-" + base::IntToString(index));
+  else
+    entry->SetString("id", "snippet-" + base::IntToString(index));
+
+  return entry;
+}
+
+} // namespace
+
+SnippetsInternalsMessageHandler::SnippetsInternalsMessageHandler() :
+    observer_(this) {}
+
+SnippetsInternalsMessageHandler::~SnippetsInternalsMessageHandler() {}
+
+void SnippetsInternalsMessageHandler::NTPSnippetsServiceShutdown() {}
+
+void SnippetsInternalsMessageHandler::NTPSnippetsServiceLoaded() {
+  ntp_snippets::NTPSnippetsService* ntp_snippets_service =
+        NTPSnippetsServiceFactory::GetInstance()->GetForProfile(
+            Profile::FromWebUI(web_ui()));
+
+  SendSnippets(ntp_snippets_service);
+  SendDiscardedSnippets(ntp_snippets_service);
+}
+
+void SnippetsInternalsMessageHandler::RegisterMessages() {
+  web_ui()->RegisterMessageCallback(
+      "loaded",
+      base::Bind(&SnippetsInternalsMessageHandler::HandleLoaded,
+                 base::Unretained(this)));
+
+  web_ui()->RegisterMessageCallback(
+      "clear", base::Bind(&SnippetsInternalsMessageHandler::HandleClear,
+                          base::Unretained(this)));
+
+  web_ui()->RegisterMessageCallback(
+      "download", base::Bind(&SnippetsInternalsMessageHandler::HandleDownload,
+                             base::Unretained(this)));
+
+  web_ui()->RegisterMessageCallback(
+      "clearDiscarded",
+      base::Bind(&SnippetsInternalsMessageHandler::HandleClearDiscarded,
+                 base::Unretained(this)));
+}
+
+void SnippetsInternalsMessageHandler::HandleLoaded(
+    const base::ListValue* args) {
+  DCHECK(args->empty());
+
+  ntp_snippets::NTPSnippetsService* ntp_snippets_service =
+      NTPSnippetsServiceFactory::GetInstance()->GetForProfile(
+          Profile::FromWebUI(web_ui()));
+
+  if (!observer_.IsObserving(ntp_snippets_service)) {

[Bernhard Bauer, 2016/04/14 16:50:25]

No braces for single-line bodies.

But more generally, needing to do this is a smell that something is wrong. Why
don't you register as an observer in the constructor?

[jkrcal, 2016/04/15 08:39:54]

Done (braces).

Well, I do not register it in the constructor because 
 - at that time, the page may not be loaded yet,
 - I need the page to be loaded before I can send it data,
 - thus, I would need to have some case distinctions in HandleLoaded and
NTPSnippetsServiceLoaded() to get the same behaviour.

All in all I think this is clearer. Feel free to argue further :)

[jkrcal, 2016/04/15 14:11:50]

By introducing a ntp_snippets_service_ member, your suggestion fits well.
Unfortunately, running the factory code to get the service in the constructor
causes a crash :|
Thus, I placed it back to the HandleLoaded function.

[Marc Treib, 2016/04/15 15:51:32]

Because web_ui() is null? Seems that is only valid when RegisterMessages gets
called:
https://code.google.com/p/chromium/codesearch#chromium/src/content/public/bro...

But IMO this is okay as-is.

[jkrcal, 2016/04/18 12:22:54]

Good point. I have moved it into the RegisterMessages function.

+    observer_.Add(ntp_snippets_service);
+  }
+  ntp_snippets_service->FetchSnippets();
+
+  SendInitialData(ntp_snippets_service);
+}
+
+void SnippetsInternalsMessageHandler::HandleClear(const base::ListValue* args) {
+  DCHECK_EQ(0u, args->GetSize());
+
+  ntp_snippets::NTPSnippetsService* ntp_snippets_service =
+      NTPSnippetsServiceFactory::GetInstance()->GetForProfile(
+          Profile::FromWebUI(web_ui()));
+
+  ntp_snippets_service->ClearSnippets();
+}
+
+void SnippetsInternalsMessageHandler::HandleClearDiscarded(
+    const base::ListValue* args) {
+  DCHECK_EQ(0u, args->GetSize());
+
+  ntp_snippets::NTPSnippetsService* ntp_snippets_service =
+      NTPSnippetsServiceFactory::GetInstance()->GetForProfile(
+          Profile::FromWebUI(web_ui()));
+
+  ntp_snippets_service->ClearDiscardedSnippets();
+  SendDiscardedSnippets(ntp_snippets_service);
+}
+
+void SnippetsInternalsMessageHandler::HandleDownload(
+    const base::ListValue* args) {
+  DCHECK_EQ(1u, args->GetSize());
+
+  std::string hosts_string;
+  args->GetString(0, &hosts_string);
+
+  std::vector<std::string> hosts_vector = base::SplitString(
+      hosts_string, " ", base::TRIM_WHITESPACE, base::SPLIT_WANT_NONEMPTY);
+  std::set<std::string> hosts(hosts_vector.begin(), hosts_vector.end());
+
+  ntp_snippets::NTPSnippetsService* ntp_snippets_service =
+      NTPSnippetsServiceFactory::GetInstance()->GetForProfile(
+          Profile::FromWebUI(web_ui()));
+
+  ntp_snippets_service->FetchSnippetsFromHosts(hosts);
+}
+
+void SnippetsInternalsMessageHandler::SendInitialData(
+    ntp_snippets::NTPSnippetsService* service){
+  SendHosts(service);
+
+  SendBoolean("flag-snippets", base::FeatureList::IsEnabled(
+                                   chrome::android::kNTPSnippetsFeature));
+
+  bool restricted = !base::CommandLine::ForCurrentProcess()->HasSwitch(
+      ntp_snippets::switches::kDontRestrict);
+  SendBoolean("switch-restrict-to-hosts", restricted);
+  const std::string help(restricted ? "cannot be empty"
+                                    : "unrestricted if empty");
+  SendString("hosts-help", help);
+}
+
+void SnippetsInternalsMessageHandler::SendSnippets(
+    ntp_snippets::NTPSnippetsService* service) {
+  std::unique_ptr<base::ListValue> snippets_list(new base::ListValue);
+
+  int index = 0;
+  for (auto& snippet : *service)
+    snippets_list->Append(PrepareSnippet(snippet, index++, false));
+
+  base::DictionaryValue result;
+  result.Set("list", std::move(snippets_list));
+  web_ui()->CallJavascriptFunction("chrome.snippets_internals.receiveSnippets",
+                                   result);
+}
+
+void SnippetsInternalsMessageHandler::SendDiscardedSnippets(
+    ntp_snippets::NTPSnippetsService* service) {
+  std::unique_ptr<base::ListValue> snippets_list(new base::ListValue);
+
+  int index = 0;
+  for (auto& snippet : service->discarded_snippets())
+    snippets_list->Append(PrepareSnippet(*snippet, index++, true));
+
+  base::DictionaryValue result;
+  result.Set("list", std::move(snippets_list));
+  web_ui()->CallJavascriptFunction(
+      "chrome.snippets_internals.receiveDiscardedSnippets", result);
+}
+
+void SnippetsInternalsMessageHandler::SendHosts(
+    ntp_snippets::NTPSnippetsService* service) {
+  std::unique_ptr<base::ListValue> hosts_list(new base::ListValue);
+
+  std::set<std::string> hosts = service->GetSuggestionsHosts();
+
+  for (const std::string& host : hosts) {
+    std::unique_ptr<base::DictionaryValue> entry(new base::DictionaryValue);
+    entry->SetString("url", host);
+
+    hosts_list->Append(std::move(entry));
+  }
+
+  base::DictionaryValue result;
+  result.Set("list", std::move(hosts_list));
+  web_ui()->CallJavascriptFunction("chrome.snippets_internals.receiveHosts",
+                                   result);
+}
+
+void SnippetsInternalsMessageHandler::SendBoolean(const std::string& name,
+                                                  bool value) {
+  SendString(name, value ? "True" : "False");
+}
+
+void SnippetsInternalsMessageHandler::SendString(const std::string& name,
+                                                 const std::string& value) {
+  base::StringValue string_name(name);
+  base::StringValue string_value(value);
+
+  web_ui()->CallJavascriptFunction("chrome.snippets_internals.receiveProperty",
+                                   string_name, string_value);
+}