DevTools: Partially redesigned DevToolsAndroidBridge and AndroidDeviceManager

chrome/browser/devtools/device/devtools_android_bridge.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/devtools/device/devtools_android_bridge.h"
 
 #include <map>
 #include <vector>
 
 #include "base/base64.h"
@@ skipping 47 matching lines @@
 
 const int kMinVersionNewWithURL = 32;
 const int kNewPageNavigateDelayMs = 500;
 
 // DiscoveryRequest -----------------------------------------------------
 
 class DiscoveryRequest : public base::RefCountedThreadSafe<
     DiscoveryRequest,
     BrowserThread::DeleteOnUIThread> {
  public:
-  typedef base::Callback<void(DevToolsAndroidBridge::RemoteDevices*)> Callback;
+  typedef base::Callback<void(
+      scoped_ptr<DevToolsAndroidBridge::RemoteDevices>,
+      scoped_ptr<DevToolsAndroidBridge::DeviceHandleMap>,
+      scoped_ptr<DevToolsAndroidBridge::DeviceHandleMap>)> Callback;

[pfeldman, 2014/05/21 11:33:41]

This callback has complex signature, but very neutral name. Consider renaming?

 
   DiscoveryRequest(
       scoped_refptr<DevToolsAndroidBridge> android_bridge,
+      const DevToolsAndroidBridge::DeviceHandleMap& device_handles,
       AndroidDeviceManager* device_manager,
       base::MessageLoop* device_message_loop,
       const AndroidDeviceManager::DeviceProviders& device_providers,
       const Callback& callback);
 
  private:
   friend struct BrowserThread::DeleteOnThread<BrowserThread::UI>;
   friend class base::DeleteHelper<DiscoveryRequest>;
 
   virtual ~DiscoveryRequest();
 
   void ReceivedSerials(const std::vector<std::string>& serials);
   void ProcessSerials();
   void ReceivedDeviceInfo(const AndroidDeviceManager::DeviceInfo& device_info);
   void ProcessSockets();
   void ReceivedVersion(int result, const std::string& response);
   void ReceivedPages(int result, const std::string& response);
 
   std::string current_serial() const { return serials_.back(); }
 
   scoped_refptr<DevToolsAndroidBridge::RemoteBrowser> current_browser() const {
     return browsers_.back();
   }
 
   void NextBrowser();
   void NextDevice();
 
   void Respond();
 
+  scoped_refptr<DevToolsAndroidBridge::DeviceHandle>
+  FindDeviceHandle(const std::string& serial);
+
   scoped_refptr<DevToolsAndroidBridge> android_bridge_;
   AndroidDeviceManager* device_manager_;
   base::MessageLoop* device_message_loop_;
   Callback callback_;
   std::vector<std::string> serials_;
   DevToolsAndroidBridge::RemoteBrowsers browsers_;
   scoped_ptr<DevToolsAndroidBridge::RemoteDevices> remote_devices_;
+  scoped_ptr<DevToolsAndroidBridge::DeviceHandleMap> all_device_handles_;
+  scoped_ptr<DevToolsAndroidBridge::DeviceHandleMap> used_device_handles_;
 };
 
 DiscoveryRequest::DiscoveryRequest(
     scoped_refptr<DevToolsAndroidBridge> android_bridge,
+    const DevToolsAndroidBridge::DeviceHandleMap& device_handles,
     AndroidDeviceManager* device_manager,
     base::MessageLoop* device_message_loop,
     const AndroidDeviceManager::DeviceProviders& device_providers,
     const Callback& callback)
     : android_bridge_(android_bridge),
       device_manager_(device_manager),
       device_message_loop_(device_message_loop),
       callback_(callback) {
   remote_devices_.reset(new DevToolsAndroidBridge::RemoteDevices());
+  all_device_handles_.reset(
+      new DevToolsAndroidBridge::DeviceHandleMap(device_handles));
+  used_device_handles_.reset(new DevToolsAndroidBridge::DeviceHandleMap());
 
   device_message_loop_->PostTask(
       FROM_HERE, base::Bind(
           &AndroidDeviceManager::QueryDevices,
           device_manager_,
           device_providers,
           base::Bind(&DiscoveryRequest::ReceivedSerials, this)));
 }
 
 DiscoveryRequest::~DiscoveryRequest() {
@@ skipping 16 matching lines @@
     return;
   }
 
   if (device_manager_->IsConnected(current_serial())) {
     device_manager_->QueryDeviceInfo(current_serial(),
         base::Bind(&DiscoveryRequest::ReceivedDeviceInfo, this));
   } else {
     AndroidDeviceManager::DeviceInfo offline_info;
     offline_info.model = kModelOffline;
     remote_devices_->push_back(new DevToolsAndroidBridge::RemoteDevice(
-        android_bridge_, current_serial(), offline_info, false));
+        FindDeviceHandle(current_serial()), offline_info, false));
     NextDevice();
   }
 }
 
 void DiscoveryRequest::ReceivedDeviceInfo(
     const AndroidDeviceManager::DeviceInfo& device_info) {
   remote_devices_->push_back(new DevToolsAndroidBridge::RemoteDevice(
-          android_bridge_, current_serial(), device_info, true));
+      FindDeviceHandle(current_serial()), device_info, true));
   browsers_ = remote_devices_->back()->browsers();
   ProcessSockets();
 }
 
 void DiscoveryRequest::ProcessSockets() {
   DCHECK_EQ(device_message_loop_, base::MessageLoop::current());
   if (browsers_.size() == 0) {
     NextDevice();
     return;
   }
@@ skipping 57 matching lines @@
   browsers_.pop_back();
   ProcessSockets();
 }
 
 void DiscoveryRequest::NextDevice() {
   serials_.pop_back();
   ProcessSerials();
 }
 
 void DiscoveryRequest::Respond() {
-  callback_.Run(remote_devices_.release());
+  callback_.Run(remote_devices_.Pass(),
+                used_device_handles_.Pass(),
+                all_device_handles_.Pass());
+}
+
+scoped_refptr<DevToolsAndroidBridge::DeviceHandle>
+DiscoveryRequest::FindDeviceHandle(const std::string& serial) {
+  DevToolsAndroidBridge::DeviceHandleMap::iterator it =
+      all_device_handles_->find(serial);
+  scoped_refptr<DevToolsAndroidBridge::DeviceHandle> device_handle;
+  if (it != all_device_handles_->end()) {
+    device_handle = it->second;
+  } else {
+    device_handle = new DevToolsAndroidBridge::DeviceHandle(android_bridge_,
+                                                            serial);
+    (*all_device_handles_)[serial] = device_handle;
+  }
+  (*used_device_handles_)[serial] = device_handle;

[pfeldman, 2014/05/21 11:33:41]

So FindDeviceHandle makes it "used"? This is not clear from the method name.
What is used_device_handles_?

+  return device_handle;
 }
 
 // ProtocolCommand ------------------------------------------------------------
 
 class ProtocolCommand
     : public DevToolsAndroidBridge::AndroidWebSocket::Delegate {
  public:
   ProtocolCommand(
       scoped_refptr<DevToolsAndroidBridge::RemoteBrowser> browser,
       const std::string& debug_url,
@@ skipping 321 matching lines @@
                                 base::Closure callback) const {
   base::DictionaryValue params;
   params.SetString(kUrlParam, url);
   browser_->SendProtocolCommand(debug_url_, kPageNavigateCommand, &params,
                                 callback);
 }
 
 // DevToolsAndroidBridge::RemoteBrowser ---------------------------------------
 
 DevToolsAndroidBridge::RemoteBrowser::RemoteBrowser(
-    scoped_refptr<DevToolsAndroidBridge> android_bridge,
-    const std::string& serial,
+    scoped_refptr<DeviceHandle> device_handle,
     const AndroidDeviceManager::BrowserInfo& browser_info)
-    : android_bridge_(android_bridge),
-      serial_(serial),
+    : device_handle_(device_handle),
       socket_(browser_info.socket_name),
       display_name_(browser_info.display_name),
       type_(browser_info.type),
       page_descriptors_(new base::ListValue()) {
 }
 
 bool DevToolsAndroidBridge::RemoteBrowser::IsChrome() const {
   return type_ == AndroidDeviceManager::BrowserInfo::kTypeChrome;
 }
 
@@ skipping 29 matching lines @@
   }
   return result;
 }
 
 void DevToolsAndroidBridge::RemoteBrowser::SetPageDescriptors(
     const base::ListValue& list) {
   page_descriptors_.reset(list.DeepCopy());
 }
 
 static void RespondOnUIThread(
-    const DevToolsAndroidBridge::RemoteBrowser::JsonRequestCallback& callback,
+    const DevToolsAndroidBridge::JsonRequestCallback& callback,
     int result,
     const std::string& response) {
   if (callback.is_null())
     return;
   BrowserThread::PostTask(
       BrowserThread::UI, FROM_HERE, base::Bind(callback, result, response));
 }
 
 void DevToolsAndroidBridge::RemoteBrowser::SendJsonRequest(
     const std::string& request, const JsonRequestCallback& callback) {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
-  android_bridge_->device_message_loop()->PostTask(
-      FROM_HERE,
-      base::Bind(&AndroidDeviceManager::HttpQuery,
-                 android_bridge_->device_manager(), serial_, socket_, request,
-                 base::Bind(&RespondOnUIThread, callback)));
+  device_handle_->SendJsonRequest(socket_, request, callback);
 }
 
 void DevToolsAndroidBridge::RemoteBrowser::SendProtocolCommand(
     const std::string& debug_url,
     const std::string& method,
     base::DictionaryValue* params,
     const base::Closure callback) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   if (debug_url.empty())
     return;
   DevToolsProtocol::Command command(1, method, params);
   new ProtocolCommand(this, debug_url, command.Serialize(), callback);
 }
 
 void DevToolsAndroidBridge::RemoteBrowser::Open(
     const std::string& url,
     const DevToolsAndroidBridge::RemotePageCallback& callback) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   InnerOpen(url, base::Bind(&RemoteBrowser::RespondToOpenOnUIThread,
                             this, callback));
 }
 
 scoped_refptr<content::DevToolsAgentHost>
 DevToolsAndroidBridge::RemoteBrowser::GetAgentHost() {
   return AgentHostDelegate::GetOrCreateAgentHost(
-      "adb:" + serial_ + ":" + socket_, this, kBrowserTargetSocket);
+      "adb:" + device_handle_->serial() + ":" + socket_,
+      this,
+      kBrowserTargetSocket);
+}
+
+scoped_refptr<DevToolsAndroidBridge::AndroidWebSocket>
+DevToolsAndroidBridge::RemoteBrowser::CreateWebSocket(
+    const std::string& url,
+    DevToolsAndroidBridge::AndroidWebSocket::Delegate* delegate) {
+  return device_handle_->CreateWebSocket(socket_, url, delegate);
 }
 
 void DevToolsAndroidBridge::RemoteBrowser::RespondToOpenOnUIThread(
     const DevToolsAndroidBridge::RemotePageCallback& callback,
     int result,
     const std::string& response) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   if (result < 0) {
     callback.Run(NULL);
     return;
@@ skipping 59 matching lines @@
   if (value && value->GetAsDictionary(&dict)) {
     RemotePageTarget new_page(this, *dict);
     new_page.Navigate(url,
         base::Bind(&RespondOnUIThread, callback, result, response));
   }
 }
 
 DevToolsAndroidBridge::RemoteBrowser::~RemoteBrowser() {
 }
 
-
 // DevToolsAndroidBridge::RemoteDevice ----------------------------------------
 
 DevToolsAndroidBridge::RemoteDevice::RemoteDevice(
-    scoped_refptr<DevToolsAndroidBridge> android_bridge,
-    const std::string& serial,
+    scoped_refptr<DevToolsAndroidBridge::DeviceHandle> device_handle,
     const AndroidDeviceManager::DeviceInfo& device_info,
     bool connected)
-    : android_bridge_(android_bridge),
-      serial_(serial),
+    : device_handle_(device_handle),
       model_(device_info.model),
       connected_(connected),
       screen_size_(device_info.screen_size) {
   for (std::vector<AndroidDeviceManager::BrowserInfo>::const_iterator it =
       device_info.browser_info.begin();
       it != device_info.browser_info.end();
       ++it) {
     browsers_.push_back(new DevToolsAndroidBridge::RemoteBrowser(
-        android_bridge_, serial_, *it));
+        device_handle, *it));
   }
 }
 
 void DevToolsAndroidBridge::RemoteDevice::OpenSocket(
     const std::string& socket_name,
     const AndroidDeviceManager::SocketCallback& callback) {
-  android_bridge_->device_message_loop()->PostTask(FROM_HERE,
-      base::Bind(&AndroidDeviceManager::OpenSocket,
-                 android_bridge_->device_manager(),
-                 serial_,
-                 socket_name,
-                 callback));
+  device_handle_->OpenSocket(socket_name, callback);
 }
 
 DevToolsAndroidBridge::RemoteDevice::~RemoteDevice() {
 }
 
 // DevToolsAndroidBridge::HandlerThread ---------------------------------
 
 const char kDevToolsAdbBridgeThreadName[] = "Chrome_DevToolsADBThread";
 
 DevToolsAndroidBridge::HandlerThread*
@@ skipping 33 matching lines @@
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   instance_ = NULL;
   if (!thread_)
     return;
   // Shut down thread on FILE thread to join into IO.
   BrowserThread::PostTask(
       BrowserThread::FILE, FROM_HERE,
       base::Bind(&HandlerThread::StopThread, thread_));
 }
 
+// DevToolsAndroidBridge::DeviceHandle ----------------------------------------
+
+DevToolsAndroidBridge::DeviceHandle::DeviceHandle(
+    scoped_refptr<DevToolsAndroidBridge> android_bridge,
+    const std::string& serial)
+    : android_bridge_(android_bridge),
+      serial_(serial) {
+}
+
+void DevToolsAndroidBridge::DeviceHandle::SendJsonRequest(

[pfeldman, 2014/05/21 11:33:41]

::HttpQuery?

+    const std::string& socket,
+    const std::string& request,
+    const JsonRequestCallback& callback) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+  android_bridge_->device_message_loop()->PostTask(
+      FROM_HERE,
+      base::Bind(&AndroidDeviceManager::HttpQuery,
+                 android_bridge_->device_manager(),
+                 serial_,
+                 socket,
+                 request,
+                 base::Bind(&RespondOnUIThread, callback)));
+}
+
+void DevToolsAndroidBridge::DeviceHandle::OpenSocket(
+    const std::string& socket_name,
+    const AndroidDeviceManager::SocketCallback& callback) {
+  android_bridge_->device_message_loop()->PostTask(FROM_HERE,

[pfeldman, 2014/05/21 11:33:41]

DCHECK thread.

+      base::Bind(&AndroidDeviceManager::OpenSocket,
+                 android_bridge_->device_manager(),
+                 serial_,
+                 socket_name,
+                 callback));
+}
+
+DevToolsAndroidBridge::DeviceHandle::~DeviceHandle() {
+  android_bridge_->device_message_loop()->PostTask(FROM_HERE,

[pfeldman, 2014/05/21 11:33:41]

ditto

+      base::Bind(&AndroidDeviceManager::ReleaseDevice,
+                 android_bridge_->device_manager(),
+                 serial_));
+}
+
 // DevToolsAndroidBridge ------------------------------------------------------
 
 DevToolsAndroidBridge::DevToolsAndroidBridge(Profile* profile)
     : profile_(profile),
       handler_thread_(HandlerThread::GetInstance()) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   pref_change_registrar_.Init(profile_->GetPrefs());
   pref_change_registrar_.Add(prefs::kDevToolsDiscoverUsbDevicesEnabled,
       base::Bind(&DevToolsAndroidBridge::CreateDeviceProviders,
                  base::Unretained(this)));
@@ skipping 13 matching lines @@
     RequestDeviceList();
 }
 
 void DevToolsAndroidBridge::RemoveDeviceListListener(
     DeviceListListener* listener) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   DeviceListListeners::iterator it = std::find(
       device_list_listeners_.begin(), device_list_listeners_.end(), listener);
   DCHECK(it != device_list_listeners_.end());
   device_list_listeners_.erase(it);
-  if (device_list_listeners_.empty() && device_manager_) {
-    device_message_loop()->PostTask(FROM_HERE,
-        base::Bind(&AndroidDeviceManager::Stop, device_manager_));
-  }
+  if (device_list_listeners_.empty() && device_manager_)
+    device_handles_.clear();
 }
 
 void DevToolsAndroidBridge::AddDeviceCountListener(
     DeviceCountListener* listener) {
   device_count_listeners_.push_back(listener);
   if (device_count_listeners_.size() == 1 && device_manager_)
     RequestDeviceCount();
 }
 
 void DevToolsAndroidBridge::RemoveDeviceCountListener(
     DeviceCountListener* listener) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   DeviceCountListeners::iterator it = std::find(
       device_count_listeners_.begin(), device_count_listeners_.end(), listener);
   DCHECK(it != device_count_listeners_.end());
   device_count_listeners_.erase(it);
 }
 
 // static
 bool DevToolsAndroidBridge::HasDevToolsWindow(const std::string& agent_id) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   return g_host_delegates.Get().find(agent_id) != g_host_delegates.Get().end();
 }
 
+void DevToolsAndroidBridge::IsConnectedForTest(const std::string& serial,
+    const base::Callback<void(bool)>& callback) {
+  base::PostTaskAndReplyWithResult(
+      device_message_loop()->message_loop_proxy(),
+      FROM_HERE,
+      base::Bind(&AndroidDeviceManager::IsConnected, device_manager_, serial),
+      callback);
+}
+
 DevToolsAndroidBridge::~DevToolsAndroidBridge() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   DCHECK(device_list_listeners_.empty());
   DCHECK(device_count_listeners_.empty());
   if (device_manager_) {
     AndroidDeviceManager* raw_ptr = device_manager_.get();
     device_manager_->AddRef();
     device_manager_ = NULL;
     device_message_loop()->ReleaseSoon(FROM_HERE, raw_ptr);
   }
 }
 
 void DevToolsAndroidBridge::RequestDeviceList() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   DCHECK(device_manager_);
 
   if (device_list_listeners_.empty())
     return;
 
   new DiscoveryRequest(
       this,
+      device_handles_,

[pfeldman, 2014/05/21 11:33:41]

What is device_handles_? What is used_device_handles?

       device_manager(),
       device_message_loop(),
       device_providers_,
       base::Bind(&DevToolsAndroidBridge::ReceivedDeviceList, this));
 }
 
 void DevToolsAndroidBridge::CreatedDeviceManager(
     scoped_refptr<AndroidDeviceManager> device_manager) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   device_manager_ = device_manager;
   if (!device_list_listeners_.empty())
     RequestDeviceList();
   if (!device_count_listeners_.empty())
     RequestDeviceCount();
 }
 
-void DevToolsAndroidBridge::ReceivedDeviceList(RemoteDevices* devices_ptr) {
+void DevToolsAndroidBridge::ReceivedDeviceList(
+    scoped_ptr<RemoteDevices> devices,
+    scoped_ptr<DeviceHandleMap> used_device_handles,
+    scoped_ptr<DeviceHandleMap> all_device_handles) {

[pfeldman, 2014/05/21 11:33:41]

Is this field unused?

   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
 
-  scoped_ptr<RemoteDevices> devices(devices_ptr);
-
   if (device_list_listeners_.empty())
     return;
 
+  device_handles_ = *used_device_handles.get();
+
   DeviceListListeners copy(device_list_listeners_);
   for (DeviceListListeners::iterator it = copy.begin(); it != copy.end(); ++it)
     (*it)->DeviceListChanged(*devices.get());
 
   BrowserThread::PostDelayedTask(
       BrowserThread::UI,
       FROM_HERE,
       base::Bind(&DevToolsAndroidBridge::RequestDeviceList, this),
       base::TimeDelta::FromMilliseconds(kAdbPollingIntervalMs));
 }
@@ skipping 40 matching lines @@
   PrefService* service = profile_->GetPrefs();
   const PrefService::Preference* pref =
       service->FindPreference(prefs::kDevToolsDiscoverUsbDevicesEnabled);
   const base::Value* pref_value = pref->GetValue();
 
   bool enabled;
   if (pref_value->GetAsBoolean(&enabled) && enabled) {
     device_providers_.push_back(new UsbDeviceProvider(profile_));
   }
 }