Return operation name in prefetch request callback and add internal page hookup

chrome/browser/ui/webui/offline/offline_internals_ui_message_handler.cc

 // 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/offline/offline_internals_ui_message_handler.h"
 
 #include <stdint.h>
 #include <stdlib.h>
 
 #include <algorithm>
 #include <utility>
 
 #include "base/bind.h"
 #include "base/guid.h"
 #include "base/memory/ptr_util.h"
 #include "base/strings/string_number_conversions.h"
+#include "base/strings/string_split.h"
+#include "base/strings/string_util.h"
+#include "base/strings/stringprintf.h"
 #include "base/values.h"
 #include "chrome/browser/android/offline_pages/offline_page_model_factory.h"
 #include "chrome/browser/android/offline_pages/prefetch/prefetch_background_task.h"
 #include "chrome/browser/android/offline_pages/request_coordinator_factory.h"
 #include "chrome/browser/offline_pages/prefetch/prefetch_service_factory.h"
 #include "chrome/browser/profiles/profile.h"
+#include "chrome/common/channel_info.h"
+#include "chrome/common/chrome_content_client.h"
 #include "components/offline_pages/core/client_namespace_constants.h"
 #include "components/offline_pages/core/offline_page_feature.h"
+#include "components/offline_pages/core/prefetch/generate_page_bundle_request.h"
+#include "components/offline_pages/core/prefetch/get_operation_request.h"
 #include "components/offline_pages/core/prefetch/prefetch_service.h"
 #include "content/public/browser/web_ui.h"
 #include "net/base/network_change_notifier.h"
 
 namespace offline_internals {
 
-OfflineInternalsUIMessageHandler::OfflineInternalsUIMessageHandler()
-    : offline_page_model_(nullptr),
-      request_coordinator_(nullptr),
-      prefetch_service_(nullptr),
-      weak_ptr_factory_(this) {}
+namespace {
 
-OfflineInternalsUIMessageHandler::~OfflineInternalsUIMessageHandler() {}
-
-std::string OfflineInternalsUIMessageHandler::GetStringFromDeletePageResult(
+std::string GetStringFromDeletePageResult(
     offline_pages::DeletePageResult value) {
   switch (value) {
     case offline_pages::DeletePageResult::SUCCESS:
       return "Success";
     case offline_pages::DeletePageResult::CANCELLED:
       return "Cancelled";
     case offline_pages::DeletePageResult::STORE_FAILURE:
       return "Store failure";
     case offline_pages::DeletePageResult::DEVICE_FAILURE:
       return "Device failure";
     case offline_pages::DeletePageResult::NOT_FOUND:
       return "Not found";
     case offline_pages::DeletePageResult::RESULT_COUNT:
       break;
   }
   NOTREACHED();
   return "Unknown";
 }
 
-std::string OfflineInternalsUIMessageHandler::GetStringFromDeleteRequestResults(
+std::string GetStringFromDeleteRequestResults(
     const offline_pages::MultipleItemStatuses& results) {
   // If any requests failed, return "failure", else "success".
   for (const auto& result : results) {
     if (result.second == offline_pages::ItemActionStatus::STORE_ERROR)
       return "Store failure, could not delete one or more requests";
   }
 
   return "Success";
 }
 
-std::string OfflineInternalsUIMessageHandler::GetStringFromSavePageStatus() {
+std::string GetStringFromSavePageStatus() {
   return "Available";
 }
 
+std::string GetStringFromPrefetchRequestStatus(
+    offline_pages::PrefetchRequestStatus status) {
+  switch (status) {
+    case offline_pages::PrefetchRequestStatus::SUCCESS:
+      return "Success";
+    case offline_pages::PrefetchRequestStatus::SHOULD_RETRY_WITHOUT_BACKOFF:
+      return "Retry w/out backoff";
+    case offline_pages::PrefetchRequestStatus::SHOULD_RETRY_WITH_BACKOFF:
+      return "Retry w/ backoff";
+    case offline_pages::PrefetchRequestStatus::SHOULD_SUSPEND:
+      return "Suspend";
+    default:
+      NOTREACHED();
+      return "Unknown";
+  }
+}
+
+std::string GetStringRenderPageInfoList(
+    const std::vector<offline_pages::RenderPageInfo>& pages) {

[dpapad, 2017/06/12 23:29:20]

Why is this function generating a stringified version of the data structure to
be passed to JS? Can you just pass a plain object, that comes out as a normal JS
object on the other side?

[jianli, 2017/06/12 23:48:15]

I don't think JS needs to know anything about the object. Here we only want to
dump the result.

+  std::string str("[\n");
+  bool first = true;
+  for (const auto& page : pages) {
+    if (first)
+      first = false;
+    else
+      str += ",\n";
+    str += base::StringPrintf(
+        "  {\n"
+        "    url: \"%s\",\n"
+        "    redirect_url: \"%s\",\n"
+        "    status: %d,\n"
+        "    body_name: \"%s\",\n"
+        "    body_length: %lld\n"
+        "  }",
+        page.url.c_str(), page.redirect_url.c_str(),
+        static_cast<int>(page.status), page.body_name.c_str(),
+        page.body_length);
+  }
+  str += "\n]";
+  return str;
+}
+
+}  // namespace
+
+OfflineInternalsUIMessageHandler::OfflineInternalsUIMessageHandler()
+    : offline_page_model_(nullptr),
+      request_coordinator_(nullptr),
+      prefetch_service_(nullptr),
+      weak_ptr_factory_(this) {}
+
+OfflineInternalsUIMessageHandler::~OfflineInternalsUIMessageHandler() {}
+
 void OfflineInternalsUIMessageHandler::HandleDeleteSelectedPages(
     const base::ListValue* args) {
   std::string callback_id;
   CHECK(args->GetString(0, &callback_id));
 
   std::vector<int64_t> offline_ids;
   const base::ListValue* offline_ids_from_arg;
   args->GetList(1, &offline_ids_from_arg);
 
   for (size_t i = 0; i < offline_ids_from_arg->GetSize(); i++) {
@@ skipping 166 matching lines @@
     const base::ListValue* args) {
   AllowJavascript();
   const base::Value* callback_id;
   CHECK(args->Get(0, &callback_id));
 
   offline_pages::PrefetchBackgroundTask::Cancel();
 
   ResolveJavascriptCallback(*callback_id, base::Value("Cancelled."));
 }
 
+void OfflineInternalsUIMessageHandler::HandleGeneratePageBundle(
+    const base::ListValue* args) {
+  AllowJavascript();
+  std::string callback_id;
+  CHECK(args->GetString(0, &callback_id));
+
+  std::string data;
+  CHECK(args->GetString(1, &data));
+  std::vector<std::string> page_urls = base::SplitStringUsingSubstr(
+      data, ",", base::TRIM_WHITESPACE, base::SPLIT_WANT_NONEMPTY);
+
+  generate_page_bundle_request_.reset(
+      new offline_pages::GeneratePageBundleRequest(
+          GetUserAgent(), "GCM ID", 1000000, page_urls, chrome::GetChannel(),
+          Profile::FromWebUI(web_ui())->GetRequestContext(),
+          base::Bind(
+              &OfflineInternalsUIMessageHandler::HandlePrefetchRequestCallback,
+              weak_ptr_factory_.GetWeakPtr(), callback_id)));
+}
+
+void OfflineInternalsUIMessageHandler::HandleGetOperation(
+    const base::ListValue* args) {
+  AllowJavascript();
+  std::string callback_id;
+  CHECK(args->GetString(0, &callback_id));
+
+  std::string name;
+  CHECK(args->GetString(1, &name));
+  base::TrimWhitespaceASCII(name, base::TRIM_ALL, &name);
+
+  get_operation_request_.reset(new offline_pages::GetOperationRequest(
+      name, chrome::GetChannel(),
+      Profile::FromWebUI(web_ui())->GetRequestContext(),
+      base::Bind(
+          &OfflineInternalsUIMessageHandler::HandlePrefetchRequestCallback,
+          weak_ptr_factory_.GetWeakPtr(), callback_id)));
+}
+
+void OfflineInternalsUIMessageHandler::HandlePrefetchRequestCallback(
+    std::string callback_id,
+    offline_pages::PrefetchRequestStatus status,
+    const std::string& operation_name,
+    const std::vector<offline_pages::RenderPageInfo>& pages) {
+  ResolveJavascriptCallback(
+      base::Value(callback_id),
+      base::Value(GetStringFromPrefetchRequestStatus(status) + "\n" +

[dpapad, 2017/06/12 23:29:20]

Same question. Why are we "encoding" the result in a custom formatted string?
Can we just pass back an object, and let the JS side handle the formatting?

[jianli, 2017/06/12 23:48:15]

I think we only want to dump the result for debugging purpose. We don't want to
complicate the JS code to know about all the details. 

+                  operation_name + "\n" + GetStringRenderPageInfoList(pages)));
+}
+
 void OfflineInternalsUIMessageHandler::HandleSetRecordRequestQueue(
     const base::ListValue* args) {
   AllowJavascript();
   bool should_record;
   CHECK(args->GetBoolean(0, &should_record));
   if (request_coordinator_)
     request_coordinator_->GetLogger()->SetIsLogging(should_record);
 }
 
 void OfflineInternalsUIMessageHandler::HandleSetRecordPrefetchService(
@@ skipping 123 matching lines @@
       base::Bind(&OfflineInternalsUIMessageHandler::HandleGetNetworkStatus,
                  weak_ptr_factory_.GetWeakPtr()));
   web_ui()->RegisterMessageCallback(
       "scheduleNwake",
       base::Bind(&OfflineInternalsUIMessageHandler::HandleScheduleNwake,
                  weak_ptr_factory_.GetWeakPtr()));
   web_ui()->RegisterMessageCallback(
       "cancelNwake",
       base::Bind(&OfflineInternalsUIMessageHandler::HandleCancelNwake,
                  weak_ptr_factory_.GetWeakPtr()));
+  web_ui()->RegisterMessageCallback(
+      "generatePageBundle",
+      base::Bind(&OfflineInternalsUIMessageHandler::HandleGeneratePageBundle,
+                 weak_ptr_factory_.GetWeakPtr()));
+  web_ui()->RegisterMessageCallback(
+      "getOperation",
+      base::Bind(&OfflineInternalsUIMessageHandler::HandleGetOperation,
+                 weak_ptr_factory_.GetWeakPtr()));
 
   // Get the offline page model associated with this web ui.
   Profile* profile = Profile::FromWebUI(web_ui());
   offline_page_model_ =
       offline_pages::OfflinePageModelFactory::GetForBrowserContext(profile);
   request_coordinator_ =
       offline_pages::RequestCoordinatorFactory::GetForBrowserContext(profile);
   prefetch_service_ =
       offline_pages::PrefetchServiceFactory::GetForBrowserContext(profile);
 }
 
 }  // namespace offline_internals