DevTools: remove DevToolsTargetDescriptor and its implementations, we are now based on devtools age…

components/devtools_http_handler/devtools_http_handler.cc

 // Copyright (c) 2012 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 <stddef.h>
 #include <stdint.h>
 
 #include <algorithm>
 #include <utility>
 
 #include "base/bind.h"
 #include "base/compiler_specific.h"
 #include "base/files/file_util.h"
 #include "base/json/json_writer.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/single_thread_task_runner.h"
 #include "base/stl_util.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/threading/thread.h"
 #include "base/values.h"
 #include "build/build_config.h"
 #include "components/devtools_discovery/devtools_discovery_manager.h"
 #include "components/devtools_http_handler/devtools_http_handler.h"
 #include "components/devtools_http_handler/devtools_http_handler_delegate.h"
 #include "content/public/browser/browser_thread.h"
-#include "content/public/browser/devtools_agent_host.h"
 #include "content/public/browser/devtools_external_agent_proxy_delegate.h"
 #include "content/public/common/url_constants.h"
 #include "content/public/common/user_agent.h"
 #include "net/base/escape.h"
 #include "net/base/io_buffer.h"
 #include "net/base/ip_endpoint.h"
 #include "net/base/net_errors.h"
 #include "net/server/http_server.h"
 #include "net/server/http_server_request_info.h"
 #include "net/server/http_server_response_info.h"
 #include "net/socket/server_socket.h"
 
 #if defined(OS_ANDROID)
 #include "base/android/build_info.h"
 #endif
 
 using content::BrowserThread;
 using content::DevToolsAgentHost;
 using content::DevToolsAgentHostClient;
-using devtools_discovery::DevToolsTargetDescriptor;
 
 namespace devtools_http_handler {
 
 namespace {
 
 const base::FilePath::CharType kDevToolsActivePortFileName[] =
     FILE_PATH_LITERAL("DevToolsActivePort");
 
 const char kDevToolsHandlerThreadName[] = "Chrome_DevToolsHandlerThread";
 
@@ skipping 255 matching lines @@
       agent_host_->DispatchProtocolMessage(this, message);
   }
 
  private:
   base::MessageLoop* const message_loop_;
   ServerWrapper* const server_wrapper_;
   const int connection_id_;
   scoped_refptr<DevToolsAgentHost> agent_host_;
 };
 
-static bool TimeComparator(const DevToolsTargetDescriptor* desc1,
-                           const DevToolsTargetDescriptor* desc2) {
-  return desc1->GetAgentHost()->GetLastActivityTime() >
-         desc2->GetAgentHost()->GetLastActivityTime();
+static bool TimeComparator(scoped_refptr<DevToolsAgentHost> host1,
+                           scoped_refptr<DevToolsAgentHost> host2) {
+  return host1->GetLastActivityTime() > host2->GetLastActivityTime();
 }
 
 // DevToolsHttpHandler::ServerSocketFactory ----------------------------------
 
 std::unique_ptr<net::ServerSocket>
 DevToolsHttpHandler::ServerSocketFactory::CreateForHttpServer() {
   return nullptr;
 }
 
 std::unique_ptr<net::ServerSocket>
 DevToolsHttpHandler::ServerSocketFactory::CreateForTethering(
     std::string* name) {
   return nullptr;
 }
 
 // DevToolsHttpHandler -------------------------------------------------------
 
 DevToolsHttpHandler::~DevToolsHttpHandler() {
   TerminateOnUI(thread_, server_wrapper_, socket_factory_);
-  base::STLDeleteValues(&descriptor_map_);
-  base::STLDeleteValues(&connection_to_client_);
 }
 
 GURL DevToolsHttpHandler::GetFrontendURL(const std::string& path) {
   if (!server_ip_address_)
     return GURL();
   return GURL(std::string("http://") + server_ip_address_->ToString() +
               (path.empty() ? frontend_url_ : path));
 }
 
 static std::string PathWithoutParams(const std::string& path) {
@@ skipping 212 matching lines @@
 #if defined(OS_ANDROID)
     version.SetString("Android-Package",
         base::android::BuildInfo::GetInstance()->package_name());
 #endif
     SendJson(connection_id, net::HTTP_OK, &version, std::string());
     return;
   }
 
   if (command == "list") {
     std::string host = info.headers["host"];
-    DevToolsTargetDescriptor::List descriptors =
+    DevToolsAgentHost::List agent_hosts =
         devtools_discovery::DevToolsDiscoveryManager::GetInstance()->
             GetDescriptors();
-    std::sort(descriptors.begin(), descriptors.end(), TimeComparator);
-    base::STLDeleteValues(&descriptor_map_);
+    std::sort(agent_hosts.begin(), agent_hosts.end(), TimeComparator);
+    agent_host_map_.clear();
     base::ListValue list_value;
-    for (DevToolsTargetDescriptor* descriptor : descriptors) {
-      descriptor_map_[descriptor->GetAgentHost()->GetId()] = descriptor;
-      list_value.Append(SerializeDescriptor(*descriptor, host));
+    for (auto& agent_host : agent_hosts) {
+      agent_host_map_[agent_host->GetId()] = agent_host;
+      list_value.Append(SerializeDescriptor(agent_host, host));
     }
     SendJson(connection_id, net::HTTP_OK, &list_value, std::string());
     return;
   }
 
   if (command == "new") {
     GURL url(net::UnescapeURLComponent(
         query, net::UnescapeRule::URL_SPECIAL_CHARS_EXCEPT_PATH_SEPARATORS |
                    net::UnescapeRule::PATH_SEPARATORS));
     if (!url.is_valid())
       url = GURL(url::kAboutBlankURL);
-    std::unique_ptr<DevToolsTargetDescriptor> descriptor =
+    scoped_refptr<DevToolsAgentHost> agent_host =
         devtools_discovery::DevToolsDiscoveryManager::GetInstance()->CreateNew(
             url);
-    if (!descriptor) {
+    if (!agent_host) {
       SendJson(connection_id,
                net::HTTP_INTERNAL_SERVER_ERROR,
                NULL,
                "Could not create new page");
       return;
     }
     std::string host = info.headers["host"];
     std::unique_ptr<base::DictionaryValue> dictionary(
-        SerializeDescriptor(*descriptor.get(), host));
+        SerializeDescriptor(agent_host, host));
     SendJson(connection_id, net::HTTP_OK, dictionary.get(), std::string());
-    const std::string target_id = descriptor->GetAgentHost()->GetId();
-    descriptor_map_[target_id] = descriptor.release();
+    const std::string target_id = agent_host->GetId();
+    agent_host_map_[target_id] = agent_host;
     return;
   }
 
   if (command == "activate" || command == "close") {
-    DevToolsTargetDescriptor* descriptor = GetDescriptor(target_id);
-    if (!descriptor) {
+    scoped_refptr<DevToolsAgentHost> agent_host = GetAgentHost(target_id);
+    if (!agent_host) {
       SendJson(connection_id,
                net::HTTP_NOT_FOUND,
                NULL,
                "No such target id: " + target_id);
       return;
     }
 
     if (command == "activate") {
-      if (descriptor->GetAgentHost()->Activate()) {
+      if (agent_host->Activate()) {
         SendJson(connection_id, net::HTTP_OK, NULL, "Target activated");
       } else {
         SendJson(connection_id,
                  net::HTTP_INTERNAL_SERVER_ERROR,
                  NULL,
                  "Could not activate target id: " + target_id);
       }
       return;
     }
 
     if (command == "close") {
-      if (descriptor->GetAgentHost()->Close()) {
+      if (agent_host->Close()) {
         SendJson(connection_id, net::HTTP_OK, NULL, "Target is closing");
       } else {
         SendJson(connection_id,
                  net::HTTP_INTERNAL_SERVER_ERROR,
                  NULL,
                  "Could not close target id: " + target_id);
       }
       return;
     }
   }
   SendJson(connection_id,
            net::HTTP_NOT_FOUND,
            NULL,
            "Unknown command: " + command);
   return;
 }
 
-DevToolsTargetDescriptor* DevToolsHttpHandler::GetDescriptor(
+scoped_refptr<DevToolsAgentHost> DevToolsHttpHandler::GetAgentHost(
     const std::string& target_id) {
-  DescriptorMap::const_iterator it = descriptor_map_.find(target_id);
-  if (it == descriptor_map_.end())
-    return nullptr;
-  return it->second;
+  DescriptorMap::const_iterator it = agent_host_map_.find(target_id);
+  return it != agent_host_map_.end() ? it->second : nullptr;
 }
 
 void DevToolsHttpHandler::OnThumbnailRequest(
     int connection_id, const std::string& target_id) {
-  DevToolsTargetDescriptor* descriptor = GetDescriptor(target_id);
+  scoped_refptr<DevToolsAgentHost> agent_host = GetAgentHost(target_id);
   GURL page_url;
-  if (descriptor)
-    page_url = descriptor->GetAgentHost()->GetURL();
+  if (agent_host)
+    page_url = agent_host->GetURL();
   std::string data = delegate_->GetPageThumbnailData(page_url);
   if (!data.empty())
     Send200(connection_id, data, "image/png");
   else
     Send404(connection_id);
 }
 
 void DevToolsHttpHandler::OnDiscoveryPageRequest(int connection_id) {
   std::string response = delegate_->GetDiscoveryPageHTML();
   Send200(connection_id, response, "text/html; charset=UTF-8");
@@ skipping 38 matching lines @@
     return;
   }
 
   if (!base::StartsWith(request.path, kPageUrlPrefix,
                         base::CompareCase::SENSITIVE)) {
     Send404(connection_id);
     return;
   }
 
   std::string target_id = request.path.substr(strlen(kPageUrlPrefix));
-  DevToolsTargetDescriptor* descriptor = GetDescriptor(target_id);
-  scoped_refptr<DevToolsAgentHost> agent =
-      descriptor ? descriptor->GetAgentHost() : nullptr;
-  if (!agent.get()) {
+  scoped_refptr<DevToolsAgentHost> agent = GetAgentHost(target_id);
+  if (!agent) {
     Send500(connection_id, "No such target id: " + target_id);
     return;
   }
 
   if (agent->IsAttached()) {
     Send500(connection_id,
             "Target with given id is being inspected: " + target_id);
     return;
   }
 
@@ skipping 142 matching lines @@
     const net::HttpServerRequestInfo& request) {
   if (!thread_)
     return;
   thread_->task_runner()->PostTask(
       FROM_HERE,
       base::Bind(&ServerWrapper::AcceptWebSocket,
                  base::Unretained(server_wrapper_), connection_id, request));
 }
 
 base::DictionaryValue* DevToolsHttpHandler::SerializeDescriptor(
-    const DevToolsTargetDescriptor& descriptor,
+    scoped_refptr<DevToolsAgentHost> agent_host,

[dcheng, 2016/08/26 21:43:44]

Btw, I might be missing something, but I'm a bit confused why this is passed by
scoped_refptr: SerializeDescriptor() doesn't appear to retain a reference to
this or pass it off to anything. So a raw pointer would have been sufficient
(and makes it clear that no ownership is moving)

[pfeldman, 2016/08/26 22:31:32]

Moving ownership is only essential for movable / unique_ptr. I prefer to include
scoped_refptr<> into the signature for all refcounted objects so that it was
clear whether they can be retained.

     const std::string& host) {
   base::DictionaryValue* dictionary = new base::DictionaryValue;
-  scoped_refptr<content::DevToolsAgentHost> agent_host =
-      descriptor.GetAgentHost();
   std::string id = agent_host->GetId();
   dictionary->SetString(kTargetIdField, id);
   std::string parent_id = agent_host->GetParentId();
   if (!parent_id.empty())
     dictionary->SetString(kTargetParentIdField, parent_id);
   dictionary->SetString(kTargetTypeField, agent_host->GetType());
   dictionary->SetString(kTargetTitleField,
                         net::EscapeForHTML(agent_host->GetTitle()));
   dictionary->SetString(kTargetDescriptionField, agent_host->GetDescription());
 
@@ skipping 19 matching lines @@
         id.c_str(),
         host);
     dictionary->SetString(
         kTargetDevtoolsFrontendUrlField, devtools_frontend_url);
   }
 
   return dictionary;
 }
 
 }  // namespace devtools_http_handler