DevTools: response writers need to post to the UI while sending into streams.

content/shell/browser/shell_devtools_frontend.cc

 // Copyright 2013 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 "content/shell/browser/shell_devtools_frontend.h"
 
 #include "base/command_line.h"
 #include "base/json/json_reader.h"
 #include "base/json/json_writer.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/utf_string_conversions.h"
+#include "base/values.h"
+#include "content/public/browser/browser_thread.h"
 #include "content/public/browser/devtools_http_handler.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/content_client.h"
 #include "content/shell/browser/shell.h"
 #include "content/shell/browser/shell_browser_context.h"
 #include "content/shell/browser/shell_browser_main_parts.h"
 #include "content/shell/browser/shell_content_browser_client.h"
 #include "content/shell/browser/shell_devtools_manager_delegate.h"
 #include "content/shell/browser/webkit_test_controller.h"
 #include "content/shell/common/shell_switches.h"
 #include "net/base/io_buffer.h"
 #include "net/base/net_errors.h"
 #include "net/http/http_response_headers.h"
 #include "net/url_request/url_fetcher.h"
 #include "net/url_request/url_fetcher_response_writer.h"
 
 namespace content {
 
 namespace {
 
 
 // ResponseWriter -------------------------------------------------------------
 
 class ResponseWriter : public net::URLFetcherResponseWriter {
  public:
-  ResponseWriter(Shell* shell, int stream_id);
+  ResponseWriter(base::WeakPtr<ShellDevToolsFrontend> shell_devtools_,
+                 int stream_id);
   ~ResponseWriter() override;
 
   // URLFetcherResponseWriter overrides:
   int Initialize(const net::CompletionCallback& callback) override;
   int Write(net::IOBuffer* buffer,
             int num_bytes,
             const net::CompletionCallback& callback) override;
   int Finish(const net::CompletionCallback& callback) override;
 
  private:
-  Shell* shell_;
+  base::WeakPtr<ShellDevToolsFrontend> shell_devtools_;
   int stream_id_;
 
   DISALLOW_COPY_AND_ASSIGN(ResponseWriter);
 };
 
-ResponseWriter::ResponseWriter(Shell* shell,
-                               int stream_id)
-    : shell_(shell),
+ResponseWriter::ResponseWriter(
+    base::WeakPtr<ShellDevToolsFrontend> shell_devtools,
+    int stream_id)
+    : shell_devtools_(shell_devtools),
       stream_id_(stream_id) {
 }
 
 ResponseWriter::~ResponseWriter() {
 }
 
 int ResponseWriter::Initialize(const net::CompletionCallback& callback) {
   return net::OK;
 }
 
 int ResponseWriter::Write(net::IOBuffer* buffer,
                           int num_bytes,
                           const net::CompletionCallback& callback) {
-  base::StringValue chunk(std::string(buffer->data(), num_bytes));
-  std::string encoded;
-  base::JSONWriter::Write(&chunk, &encoded);
+  base::FundamentalValue* id = new base::FundamentalValue(stream_id_);
+  base::StringValue* chunk =
+      new base::StringValue(std::string(buffer->data(), num_bytes));
 
-  std::string code = base::StringPrintf(
-      "DevToolsAPI.streamWrite(%d, %s)", stream_id_, encoded.c_str());
-  shell_->web_contents()->GetMainFrame()->ExecuteJavaScript(
-      base::UTF8ToUTF16(code));
-
+  content::BrowserThread::PostTask(
+      content::BrowserThread::UI, FROM_HERE,
+      base::Bind(&ShellDevToolsFrontend::CallClientFunction,
+                 shell_devtools_, "DevToolsAPI.streamWrite",
+                 base::Owned(id), base::Owned(chunk), nullptr));
   return num_bytes;
 }
 
 int ResponseWriter::Finish(const net::CompletionCallback& callback) {
-  std::string code = base::StringPrintf(
-      "DevToolsAPI.streamFinish(%d)", stream_id_);
-  shell_->web_contents()->GetMainFrame()->ExecuteJavaScript(
-      base::UTF8ToUTF16(code));
+  base::FundamentalValue* id = new base::FundamentalValue(stream_id_);
+  content::BrowserThread::PostTask(
+      content::BrowserThread::UI, FROM_HERE,
+      base::Bind(&ShellDevToolsFrontend::CallClientFunction,
+                 shell_devtools_, "DevToolsAPI.streamFinish",
+                 base::Owned(id), nullptr, nullptr));
   return net::OK;
 }
 
 }  // namespace
 
 // This constant should be in sync with
 // the constant at devtools_ui_bindings.cc.
 const size_t kMaxMessageChunkSize = IPC::Channel::kMaximumMessageSize / 4;
 
 // static
@@ skipping 38 matching lines @@
   if (!agent_host_)
     return;
   agent_host_->DetachClient();
   agent_host_ = NULL;
 }
 
 ShellDevToolsFrontend::ShellDevToolsFrontend(Shell* frontend_shell,
                                              DevToolsAgentHost* agent_host)
     : WebContentsObserver(frontend_shell->web_contents()),
       frontend_shell_(frontend_shell),
-      agent_host_(agent_host) {
+      agent_host_(agent_host),
+      weak_factory_(this) {
 }
 
 ShellDevToolsFrontend::~ShellDevToolsFrontend() {
   for (const auto& pair : pending_requests_)
     delete pair.first;
 }
 
 void ShellDevToolsFrontend::RenderViewCreated(
     RenderViewHost* render_view_host) {
   if (!frontend_host_) {
@@ skipping 21 matching lines @@
     return;
   std::string method;
   base::ListValue* params = NULL;
   base::DictionaryValue* dict = NULL;
   scoped_ptr<base::Value> parsed_message(base::JSONReader::Read(message));
   if (!parsed_message ||
       !parsed_message->GetAsDictionary(&dict) ||
       !dict->GetString("method", &method)) {
     return;
   }
-  int id = 0;
-  dict->GetInteger("id", &id);
+  int request_id = 0;
+  dict->GetInteger("id", &request_id);
   dict->GetList("params", &params);
 
   std::string browser_message;
   if (method == "sendMessageToBrowser" && params &&
       params->GetSize() == 1 && params->GetString(0, &browser_message)) {
     agent_host_->DispatchProtocolMessage(browser_message);
   } else if (method == "loadCompleted") {
     web_contents()->GetMainFrame()->ExecuteJavaScript(

[dgozman, 2015/02/28 18:12:05]

Use CallClientFunction.

[pfeldman, 2015/02/28 18:38:13]

I'd need to wrap true into fundamental value, which is going to bloat it.

         base::ASCIIToUTF16("DevToolsAPI.setUseSoftMenu(true);"));
   } else if (method == "loadNetworkResource" && params->GetSize() == 3) {
     // TODO(pfeldman): handle some of the embedder messages in content.
     std::string url;
     std::string headers;
     int stream_id;
     if (!params->GetString(0, &url) ||
         !params->GetString(1, &headers) ||
         !params->GetInteger(2, &stream_id)) {
       return;
     }
+
     GURL gurl(url);
     if (!gurl.is_valid()) {
-      std::string code = base::StringPrintf(
-          "DevToolsAPI.embedderMessageAck(%d, { statusCode: 404 });", id);
-      web_contents()->GetMainFrame()->ExecuteJavaScript(
-          base::UTF8ToUTF16(code));
+      base::DictionaryValue response;
+      response.SetInteger("statusCode", 404);
+      SendMessageAck(request_id, &response);
       return;
     }
 
     net::URLFetcher* fetcher =
         net::URLFetcher::Create(gurl, net::URLFetcher::GET, this);
-    pending_requests_[fetcher] = id;
+    pending_requests_[fetcher] = request_id;
     fetcher->SetRequestContext(web_contents()->GetBrowserContext()->
         GetRequestContext());
     fetcher->SetExtraRequestHeaders(headers);
     fetcher->SaveResponseWithWriter(scoped_ptr<net::URLFetcherResponseWriter>(
-        new ResponseWriter(frontend_shell(), stream_id)));
+        new ResponseWriter(weak_factory_.GetWeakPtr(), stream_id)));
     fetcher->Start();
     return;
   } else {
     return;
   }
 
-  if (id) {
-    std::string code = "DevToolsAPI.embedderMessageAck(" +
-        base::IntToString(id) + ",\"\");";
-    base::string16 javascript = base::UTF8ToUTF16(code);
-    web_contents()->GetMainFrame()->ExecuteJavaScript(javascript);
-  }
+  if (request_id)
+    SendMessageAck(request_id, nullptr);
 }
 
 void ShellDevToolsFrontend::HandleMessageFromDevToolsFrontendToBackend(
     const std::string& message) {
   if (agent_host_)
     agent_host_->DispatchProtocolMessage(message);
 }
 
 void ShellDevToolsFrontend::DispatchProtocolMessage(
     DevToolsAgentHost* agent_host, const std::string& message) {
@@ skipping 28 matching lines @@
   net::HttpResponseHeaders* rh = source->GetResponseHeaders();
   response.SetInteger("statusCode", rh ? rh->response_code() : 200);
   response.Set("headers", headers);
 
   void* iterator = NULL;
   std::string name;
   std::string value;
   while (rh && rh->EnumerateHeaderLines(&iterator, &name, &value))
     headers->SetString(name, value);
 
-  std::string json;
-  base::JSONWriter::Write(&response, &json);
-
-  std::string message = base::StringPrintf(
-      "DevToolsAPI.embedderMessageAck(%d, %s)",
-      it->second,
-      json.c_str());
-  web_contents()->GetMainFrame()->
-      ExecuteJavaScript(base::UTF8ToUTF16(message));
-
+  SendMessageAck(it->second, &response);
   pending_requests_.erase(it);
   delete source;
 }
 
+void ShellDevToolsFrontend::CallClientFunction(
+    const std::string& function_name,
+    const base::Value* arg1,
+    const base::Value* arg2,
+    const base::Value* arg3) {
+  std::string javascript = function_name + "(";
+  if (arg1) {
+    std::string json;
+    base::JSONWriter::Write(arg1, &json);
+    javascript.append(json);
+    if (arg2) {
+      base::JSONWriter::Write(arg2, &json);
+      javascript.append(", ").append(json);
+      if (arg3) {
+        base::JSONWriter::Write(arg3, &json);
+        javascript.append(", ").append(json);
+      }
+    }
+  }
+  javascript.append(");");
+  web_contents()->GetMainFrame()->ExecuteJavaScript(
+      base::UTF8ToUTF16(javascript));
+}
+
+void ShellDevToolsFrontend::SendMessageAck(int request_id,
+                                           const base::Value* arg) {
+  base::FundamentalValue id_value(request_id);
+  CallClientFunction("DevToolsAPI.embedderMessageAck",
+                     &id_value, arg, nullptr);
+}
+
 void ShellDevToolsFrontend::AttachTo(WebContents* inspected_contents) {
   DisconnectFromTarget();
   agent_host_ = DevToolsAgentHost::GetOrCreateFor(inspected_contents);
 }
 
 void ShellDevToolsFrontend::AgentHostClosed(
     DevToolsAgentHost* agent_host, bool replaced) {
   frontend_shell_->Close();
 }
 
 }  // namespace content