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 23 matching lines @@
 #include "content/public/browser/devtools_agent_host.h"
 #include "content/public/browser/devtools_external_agent_proxy.h"
 #include "content/public/browser/devtools_external_agent_proxy_delegate.h"
 #include "content/public/browser/user_metrics.h"
 #include "net/base/escape.h"
 
 using content::BrowserThread;
 
 namespace {
 
-const char kModelOffline[] = "Offline";
-
 const char kPageListRequest[] = "/json";
 const char kVersionRequest[] = "/json/version";
 const char kClosePageRequest[] = "/json/close/%s";
 const char kNewPageRequest[] = "/json/new";
 const char kNewPageRequestWithURL[] = "/json/new?%s";
 const char kActivatePageRequest[] = "/json/activate/%s";
 const char kBrowserTargetSocket[] = "/devtools/browser";
 const int kAdbPollingIntervalMs = 1000;
 
 const char kUrlParam[] = "url";
 const char kPageReloadCommand[] = "Page.reload";
 const char kPageNavigateCommand[] = "Page.navigate";
 
 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>)>
+      DiscoveryCallback;
+  typedef AndroidDeviceManager::Device Device;
+  typedef AndroidDeviceManager::Devices Devices;
 
   DiscoveryRequest(
       scoped_refptr<DevToolsAndroidBridge> android_bridge,
       AndroidDeviceManager* device_manager,
-      base::MessageLoop* device_message_loop,
+      scoped_refptr<base::MessageLoopProxy> device_message_loop,
       const AndroidDeviceManager::DeviceProviders& device_providers,
-      const Callback& callback);
+      const DiscoveryCallback& 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 ReceivedDevices(const Devices& devices);
+  void ProcessDevices();
   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<Device> current_device() { return devices_.back(); }
 
   scoped_refptr<DevToolsAndroidBridge::RemoteBrowser> current_browser() const {
     return browsers_.back();
   }
 
   void NextBrowser();
   void NextDevice();
 
   void Respond();
 
-  scoped_refptr<DevToolsAndroidBridge> android_bridge_;
-  AndroidDeviceManager* device_manager_;
-  base::MessageLoop* device_message_loop_;
-  Callback callback_;
-  std::vector<std::string> serials_;
+  DiscoveryCallback callback_;
+  Devices devices_;
   DevToolsAndroidBridge::RemoteBrowsers browsers_;
   scoped_ptr<DevToolsAndroidBridge::RemoteDevices> remote_devices_;
 };
 
 DiscoveryRequest::DiscoveryRequest(
     scoped_refptr<DevToolsAndroidBridge> android_bridge,
     AndroidDeviceManager* device_manager,
-    base::MessageLoop* device_message_loop,
+    scoped_refptr<base::MessageLoopProxy> 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) {
+    const DiscoveryCallback& callback)
+    : callback_(callback) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   remote_devices_.reset(new DevToolsAndroidBridge::RemoteDevices());
 
-  device_message_loop_->PostTask(
-      FROM_HERE, base::Bind(
-          &AndroidDeviceManager::QueryDevices,
-          device_manager_,
-          device_providers,
-          base::Bind(&DiscoveryRequest::ReceivedSerials, this)));
+  device_manager->QueryDevices(
+      device_message_loop,
+      device_providers,
+      base::Bind(&DiscoveryRequest::ReceivedDevices, this));
 }
 
 DiscoveryRequest::~DiscoveryRequest() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
 }
 
-void DiscoveryRequest::ReceivedSerials(
-    const std::vector<std::string>& serials) {
-  DCHECK_EQ(device_message_loop_, base::MessageLoop::current());
-  serials_ = serials;
-  ProcessSerials();
+void DiscoveryRequest::ReceivedDevices(const Devices& devices) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+  devices_ = devices;
+  ProcessDevices();
 }
 
-void DiscoveryRequest::ProcessSerials() {
-  DCHECK_EQ(device_message_loop_, base::MessageLoop::current());
-  if (serials_.size() == 0) {
-    BrowserThread::PostTask(
-        BrowserThread::UI, FROM_HERE,
-        base::Bind(&DiscoveryRequest::Respond, this));
+void DiscoveryRequest::ProcessDevices() {
+  if (devices_.size() == 0) {
+    Respond();
     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));
-    NextDevice();
-  }
+  current_device()->QueryDeviceInfo(
+      base::Bind(&DiscoveryRequest::ReceivedDeviceInfo, this));
 }
 
 void DiscoveryRequest::ReceivedDeviceInfo(
     const AndroidDeviceManager::DeviceInfo& device_info) {
-  remote_devices_->push_back(new DevToolsAndroidBridge::RemoteDevice(
-          android_bridge_, current_serial(), device_info, true));
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+  remote_devices_->push_back(
+      new DevToolsAndroidBridge::RemoteDevice(current_device(), device_info));
   browsers_ = remote_devices_->back()->browsers();
   ProcessSockets();
 }
 
 void DiscoveryRequest::ProcessSockets() {
-  DCHECK_EQ(device_message_loop_, base::MessageLoop::current());
   if (browsers_.size() == 0) {
     NextDevice();
     return;
   }
 
-  device_manager_->HttpQuery(
-      current_serial(),
+  current_device()->SendJsonRequest(
       current_browser()->socket(),
       kVersionRequest,
       base::Bind(&DiscoveryRequest::ReceivedVersion, this));
 }
 
 void DiscoveryRequest::ReceivedVersion(int result,
                                        const std::string& response) {
-  DCHECK_EQ(device_message_loop_, base::MessageLoop::current());
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   if (result < 0) {
     NextBrowser();
     return;
   }
 
   // Parse version, append to package name if available,
   scoped_ptr<base::Value> value(base::JSONReader::Read(response));
   base::DictionaryValue* dict;
   if (value && value->GetAsDictionary(&dict)) {
     std::string browser;
     if (dict->GetString("Browser", &browser)) {
       std::vector<std::string> parts;
       Tokenize(browser, "/", &parts);
       if (parts.size() == 2)
         current_browser()->set_version(parts[1]);
       else
         current_browser()->set_version(browser);
     }
     std::string package;
     if (dict->GetString("Android-Package", &package)) {
       current_browser()->set_display_name(
           AdbDeviceInfoQuery::GetDisplayName(current_browser()->socket(),
                                              package));
     }
   }
 
-  device_manager_->HttpQuery(
-      current_serial(),
+  current_device()->SendJsonRequest(
       current_browser()->socket(),
       kPageListRequest,
       base::Bind(&DiscoveryRequest::ReceivedPages, this));
 }
 
 void DiscoveryRequest::ReceivedPages(int result,
                                      const std::string& response) {
-  DCHECK_EQ(device_message_loop_, base::MessageLoop::current());
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   if (result >= 0) {
     scoped_ptr<base::Value> value(base::JSONReader::Read(response));
     base::ListValue* list_value;
     if (value && value->GetAsList(&list_value))
       current_browser()->SetPageDescriptors(*list_value);
   }
   NextBrowser();
 }
 
 void DiscoveryRequest::NextBrowser() {
   browsers_.pop_back();
   ProcessSockets();
 }
 
 void DiscoveryRequest::NextDevice() {
-  serials_.pop_back();
-  ProcessSerials();
+  devices_.pop_back();
+  ProcessDevices();
 }
 
 void DiscoveryRequest::Respond() {
-  callback_.Run(remote_devices_.release());
+  callback_.Run(remote_devices_.Pass());
 }
 
 // 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<Device> device,
     const AndroidDeviceManager::BrowserInfo& browser_info)
-    : android_bridge_(android_bridge),
-      serial_(serial),
+    : device_(device),
       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_->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_->serial() + ":" + socket_, this, kBrowserTargetSocket);
+}
+
+scoped_refptr<DevToolsAndroidBridge::AndroidWebSocket>
+DevToolsAndroidBridge::RemoteBrowser::CreateWebSocket(
+    const std::string& url,
+    DevToolsAndroidBridge::AndroidWebSocket::Delegate* delegate) {
+  return device_->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,
-    const AndroidDeviceManager::DeviceInfo& device_info,
-    bool connected)
-    : android_bridge_(android_bridge),
-      serial_(serial),
+    scoped_refptr<AndroidDeviceManager::Device> device,
+    const AndroidDeviceManager::DeviceInfo& device_info)
+    : device_(device),
       model_(device_info.model),
-      connected_(connected),
+      connected_(device_info.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));
+    browsers_.push_back(new DevToolsAndroidBridge::RemoteBrowser(device, *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_->OpenSocket(socket_name, callback);
 }
 
 DevToolsAndroidBridge::RemoteDevice::~RemoteDevice() {
 }
 
 // DevToolsAndroidBridge::HandlerThread ---------------------------------
 
 const char kDevToolsAdbBridgeThreadName[] = "Chrome_DevToolsADBThread";
 
 DevToolsAndroidBridge::HandlerThread*
@@ skipping 12 matching lines @@
   instance_ = this;
   thread_ = new base::Thread(kDevToolsAdbBridgeThreadName);
   base::Thread::Options options;
   options.message_loop_type = base::MessageLoop::TYPE_IO;
   if (!thread_->StartWithOptions(options)) {
     delete thread_;
     thread_ = NULL;
   }
 }
 
-base::MessageLoop* DevToolsAndroidBridge::HandlerThread::message_loop() {
-  return thread_ ? thread_->message_loop() : NULL;
+scoped_refptr<base::MessageLoopProxy>
+DevToolsAndroidBridge::HandlerThread::message_loop() {
+  return thread_ ? thread_->message_loop_proxy() : NULL;
 }
 
 // static
 void DevToolsAndroidBridge::HandlerThread::StopThread(
     base::Thread* thread) {
   thread->Stop();
 }
 
 DevToolsAndroidBridge::HandlerThread::~HandlerThread() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
@@ skipping 11 matching lines @@
 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)));
   CreateDeviceProviders();
   base::PostTaskAndReplyWithResult(
-      device_message_loop()->message_loop_proxy(),
+      device_message_loop(),
       FROM_HERE,
       base::Bind(&AndroidDeviceManager::Create),
       base::Bind(&DevToolsAndroidBridge::CreatedDeviceManager, this));
 }
 
 void DevToolsAndroidBridge::AddDeviceListListener(
     DeviceListListener* listener) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   device_list_listeners_.push_back(listener);
   if (device_list_listeners_.size() == 1 && device_manager_)
     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())
+    devices_.clear();
 }
 
 void DevToolsAndroidBridge::AddDeviceCountListener(
     DeviceCountListener* listener) {
   device_count_listeners_.push_back(listener);
   if (device_count_listeners_.size() == 1 && device_manager_)
     RequestDeviceCount();
 }
 
 void DevToolsAndroidBridge::RemoveDeviceCountListener(
@@ skipping 41 matching lines @@
 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) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
 
-  scoped_ptr<RemoteDevices> devices(devices_ptr);
-
   if (device_list_listeners_.empty())
     return;
 
+  devices_ = *devices;
+
   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_));
   }
 }