Add option to open the DevTools window for ServiceWorker on start in serviceworker-internals.

content/browser/devtools/embedded_worker_devtools_manager.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 "content/browser/devtools/embedded_worker_devtools_manager.h"
 
 #include "content/browser/devtools/devtools_manager_impl.h"
 #include "content/browser/devtools/devtools_protocol.h"
 #include "content/browser/devtools/devtools_protocol_constants.h"
 #include "content/browser/devtools/ipc_devtools_agent_host.h"
@@ skipping 38 matching lines @@
 
 bool EmbeddedWorkerDevToolsManager::ServiceWorkerIdentifier::Matches(
     const ServiceWorkerIdentifier& other) const {
   return service_worker_context_ == other.service_worker_context_ &&
          service_worker_version_id_ == other.service_worker_version_id_;
 }
 
 EmbeddedWorkerDevToolsManager::WorkerInfo::WorkerInfo(
     const SharedWorkerInstance& instance)
     : shared_worker_instance_(new SharedWorkerInstance(instance)),
+      debug_on_start_(false),
       state_(WORKER_UNINSPECTED),
       agent_host_(NULL) {
 }
 
 EmbeddedWorkerDevToolsManager::WorkerInfo::WorkerInfo(
-    const ServiceWorkerIdentifier& service_worker_id)
+    const ServiceWorkerIdentifier& service_worker_id,
+    bool debug_on_start)
     : service_worker_id_(new ServiceWorkerIdentifier(service_worker_id)),
+      debug_on_start_(debug_on_start),
       state_(WORKER_UNINSPECTED),
       agent_host_(NULL) {
 }
 
 bool EmbeddedWorkerDevToolsManager::WorkerInfo::Matches(
     const SharedWorkerInstance& other) {
   if (!shared_worker_instance_)
     return false;
   return shared_worker_instance_->Matches(other);
 }
 
 bool EmbeddedWorkerDevToolsManager::WorkerInfo::Matches(
     const ServiceWorkerIdentifier& other) {
   if (!service_worker_id_)
     return false;
   return service_worker_id_->Matches(other);
 }
 
 EmbeddedWorkerDevToolsManager::WorkerInfo::~WorkerInfo() {
 }
 
 class EmbeddedWorkerDevToolsManager::EmbeddedWorkerDevToolsAgentHost
     : public IPCDevToolsAgentHost,
       public IPC::Listener {
  public:
-  explicit EmbeddedWorkerDevToolsAgentHost(WorkerId worker_id)
-      : worker_id_(worker_id), worker_attached_(true) {
+  explicit EmbeddedWorkerDevToolsAgentHost(WorkerId worker_id,
+                                           bool debug_on_start)
+      : worker_id_(worker_id),
+        worker_attached_(true) {
     AddRef();
     if (RenderProcessHost* host = RenderProcessHost::FromID(worker_id_.first))
       host->AddRoute(worker_id_.second, this);
   }
 
   // DevToolsAgentHost override.
   virtual bool IsWorker() const OVERRIDE { return true; }
 
   // IPCDevToolsAgentHost implementation.
   virtual void SendMessageToAgent(IPC::Message* message) OVERRIDE {
@@ skipping 72 matching lines @@
 
   WorkerInfoMap::iterator it = workers_.find(id);
   if (it == workers_.end())
     return NULL;
 
   WorkerInfo* info = it->second;
   if (info->state() != WORKER_UNINSPECTED)
     return info->agent_host();
 
   EmbeddedWorkerDevToolsAgentHost* agent_host =
-      new EmbeddedWorkerDevToolsAgentHost(id);
+      new EmbeddedWorkerDevToolsAgentHost(id, info->debug_on_start());
   info->set_agent_host(agent_host);
   info->set_state(WORKER_INSPECTED);
   return agent_host;
 }
 
 DevToolsAgentHost*
 EmbeddedWorkerDevToolsManager::GetDevToolsAgentHostForServiceWorker(
     const ServiceWorkerIdentifier& service_worker_id) {
   WorkerInfoMap::iterator it = FindExistingServiceWorkerInfo(service_worker_id);
   if (it == workers_.end())
     return NULL;
   return GetDevToolsAgentHostForWorker(it->first.first, it->first.second);
 }
 
-EmbeddedWorkerDevToolsManager::EmbeddedWorkerDevToolsManager() {
+EmbeddedWorkerDevToolsManager::EmbeddedWorkerDevToolsManager()
+    : debug_service_worker_on_start_(false) {
 }
 
 EmbeddedWorkerDevToolsManager::~EmbeddedWorkerDevToolsManager() {
 }
 
 bool EmbeddedWorkerDevToolsManager::SharedWorkerCreated(
     int worker_process_id,
     int worker_route_id,
     const SharedWorkerInstance& instance) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   const WorkerId id(worker_process_id, worker_route_id);
   WorkerInfoMap::iterator it = FindExistingSharedWorkerInfo(instance);
   if (it == workers_.end()) {
     scoped_ptr<WorkerInfo> info(new WorkerInfo(instance));
     workers_.set(id, info.Pass());
     return false;
   }
   MoveToPausedState(id, it);
   return true;
 }
 
 bool EmbeddedWorkerDevToolsManager::ServiceWorkerCreated(
     int worker_process_id,
     int worker_route_id,
     const ServiceWorkerIdentifier& service_worker_id) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   const WorkerId id(worker_process_id, worker_route_id);
   WorkerInfoMap::iterator it = FindExistingServiceWorkerInfo(service_worker_id);
   if (it == workers_.end()) {
-    scoped_ptr<WorkerInfo> info(new WorkerInfo(service_worker_id));
+    scoped_ptr<WorkerInfo> info(
+        new WorkerInfo(service_worker_id, debug_service_worker_on_start_));
     workers_.set(id, info.Pass());
-    return false;
+    return debug_service_worker_on_start_;
   }
   MoveToPausedState(id, it);
   return true;
 }
 
 void EmbeddedWorkerDevToolsManager::WorkerDestroyed(int worker_process_id,
                                                     int worker_route_id) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   const WorkerId id(worker_process_id, worker_route_id);
   WorkerInfoMap::iterator it = workers_.find(id);
@@ skipping 17 matching lines @@
               devtools::Worker::disconnectedFromWorker::kName, NULL)
               ->Serialize();
       DevToolsManagerImpl::GetInstance()->DispatchOnInspectorFrontend(
           agent_host, notification);
       agent_host->DetachFromWorker();
       break;
     }
     case WORKER_TERMINATED:
       NOTREACHED();
       break;
-    case WORKER_PAUSED: {
+    case WORKER_PAUSED_FOR_REATTACH: {
       scoped_ptr<WorkerInfo> worker_info = workers_.take_and_erase(it);
       worker_info->set_state(WORKER_TERMINATED);
       const WorkerId old_id = worker_info->agent_host()->worker_id();
       workers_.set(old_id, worker_info.Pass());
       break;
     }
   }
 }
 
 void EmbeddedWorkerDevToolsManager::WorkerContextStarted(int worker_process_id,
                                                          int worker_route_id) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   const WorkerId id(worker_process_id, worker_route_id);
   WorkerInfoMap::iterator it = workers_.find(id);
   DCHECK(it != workers_.end());
   WorkerInfo* info = it->second;
-  if (info->state() != WORKER_PAUSED)
+  if (info->state() != WORKER_PAUSED_FOR_REATTACH) {
+    if (!info->debug_on_start())

[yurys, 2014/05/27 12:02:31]

Why is it not enough to check debug_service_worker_on_start_ here instead of
storing its value on WorkerInfo?

[horo, 2014/05/27 12:29:27]

It is because debug_service_worker_on_start_ could be changed between
ServiceWorkerCreated and WorkerContextStarted are called.

If we only check debug_service_worker_on_start_ here, in the following
situations the ServiceWorker will remain paused forever.
- The user enables debug_service_worker_on_start_.
- Start ServiceWorker.
- ServiceWorkerCreated returns true -> ServiceWorker will be started in paused
state.
- The user disables debug_service_worker_on_start_.
- ServiceWorker finishes loading script.
- WorkerContextStarted is called. -> Don't start DevTools because
debug_service_worker_on_start_ is false.

[yurys, 2014/05/27 14:22:48]

I see. That makes sense. I'd rather we used a new state
(WORKER_PAUSED_FOR_DEBUG_ON_START?) instead of introducing a new field on
WorkerInfo, wdyt? Otherwise LGTM.

+      return;
+    RenderProcessHost* rph = RenderProcessHost::FromID(worker_process_id);
+    scoped_refptr<DevToolsAgentHost> agent_host(
+        GetDevToolsAgentHostForWorker(worker_process_id, worker_route_id));
+    DevToolsManagerImpl::GetInstance()->Inspect(rph->GetBrowserContext(),
+                                                agent_host.get());
     return;
+  }
   info->agent_host()->ReattachToWorker(id);
   info->set_state(WORKER_INSPECTED);
 }
 
 void EmbeddedWorkerDevToolsManager::RemoveInspectedWorkerData(
     EmbeddedWorkerDevToolsAgentHost* agent_host) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   const WorkerId id(agent_host->worker_id());
   scoped_ptr<WorkerInfo> worker_info = workers_.take_and_erase(id);
   if (worker_info) {
     DCHECK_EQ(WORKER_TERMINATED, worker_info->state());
     return;
   }
   for (WorkerInfoMap::iterator it = workers_.begin(); it != workers_.end();
        ++it) {
     if (it->second->agent_host() == agent_host) {
-      DCHECK_EQ(WORKER_PAUSED, it->second->state());
+      DCHECK_EQ(WORKER_PAUSED_FOR_REATTACH, it->second->state());
       SendMessageToWorker(
           it->first,
           new DevToolsAgentMsg_ResumeWorkerContext(it->first.second));
       it->second->set_agent_host(NULL);
       it->second->set_state(WORKER_UNINSPECTED);
       return;
     }
   }
 }
 
@@ skipping 17 matching lines @@
       break;
   }
   return it;
 }
 
 void EmbeddedWorkerDevToolsManager::MoveToPausedState(
     const WorkerId& id,
     const WorkerInfoMap::iterator& it) {
   DCHECK_EQ(WORKER_TERMINATED, it->second->state());
   scoped_ptr<WorkerInfo> info = workers_.take_and_erase(it);
-  info->set_state(WORKER_PAUSED);
+  info->set_state(WORKER_PAUSED_FOR_REATTACH);
   workers_.set(id, info.Pass());
 }
 
 void EmbeddedWorkerDevToolsManager::ResetForTesting() {
   workers_.clear();
 }
 
 }  // namespace content