[ServiceWorker] Associate interfaces.

content/browser/service_worker/embedded_worker_instance.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/browser/service_worker/embedded_worker_instance.h"
 
 #include <utility>
 
 #include "base/bind_helpers.h"
 #include "base/macros.h"
 #include "base/memory/ptr_util.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/threading/non_thread_safe.h"
 #include "base/trace_event/trace_event.h"
 #include "content/browser/devtools/service_worker_devtools_manager.h"
 #include "content/browser/service_worker/embedded_worker_registry.h"
 #include "content/browser/service_worker/embedded_worker_status.h"
 #include "content/browser/service_worker/service_worker_context_core.h"
 #include "content/common/content_switches_internal.h"
 #include "content/common/service_worker/embedded_worker_messages.h"
 #include "content/common/service_worker/embedded_worker_settings.h"
 #include "content/common/service_worker/embedded_worker_setup.mojom.h"
 #include "content/common/service_worker/embedded_worker_start_params.h"
 #include "content/common/service_worker/service_worker_types.h"
 #include "content/common/service_worker/service_worker_utils.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/content_browser_client.h"
 #include "content/public/browser/render_process_host.h"
+#include "content/public/common/associated_interface_provider.h"
 #include "content/public/common/child_process_host.h"
 #include "content/public/common/content_switches.h"
 #include "ipc/ipc_message.h"
 #include "url/gurl.h"
 
 namespace content {
 
 namespace {
 
 // When a service worker version's failure count exceeds
@@ skipping 32 matching lines @@
 }
 
 void SetupOnUI(
     int process_id,
     const ServiceWorkerContextCore* service_worker_context,
     const base::WeakPtr<ServiceWorkerContextCore>& service_worker_context_weak,
     int64_t service_worker_version_id,
     const GURL& url,
     const GURL& scope,
     bool is_installed,
-    mojom::EmbeddedWorkerInstanceClientRequest request,
-    const base::Callback<void(int worker_devtools_agent_route_id,
-                              bool wait_for_debugger)>& callback) {
+    const base::Callback<
+        void(int worker_devtools_agent_route_id,
+             bool wait_for_debugger,
+             mojom::EmbeddedWorkerInstanceClientAssociatedPtrInfo ptr_info)>&
+        callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
   int worker_devtools_agent_route_id = MSG_ROUTING_NONE;
   bool wait_for_debugger = false;
+  mojom::EmbeddedWorkerInstanceClientAssociatedPtr client_ptr;
   if (RenderProcessHost* rph = RenderProcessHost::FromID(process_id)) {
     // |rph| may be NULL in unit tests.
     worker_devtools_agent_route_id = rph->GetNextRoutingID();
     wait_for_debugger =
         ServiceWorkerDevToolsManager::GetInstance()->WorkerCreated(
             process_id, worker_devtools_agent_route_id,
             ServiceWorkerDevToolsManager::ServiceWorkerIdentifier(
                 service_worker_context, service_worker_context_weak,
                 service_worker_version_id, url, scope),
             is_installed);
-    if (request.is_pending())
-      rph->GetRemoteInterfaces()->GetInterface(std::move(request));
+
+    if (rph->GetChannel()) {
+      rph->GetChannel()->GetRemoteAssociatedInterface(&client_ptr);
+    } else {
+      // In unit tests we establish associated interface connections via
+      // MockRenderProcessHost.
+      DCHECK(rph->GetAssociatedInterfaceProviderForTesting());
+      rph->GetAssociatedInterfaceProviderForTesting()->GetInterface(
+          &client_ptr);
+    }
+  } else {
+    // No render process host, just connect to a dummy implementation to ensure
+    // client_ptr to be bound.
+    mojo::GetDummyProxyForTesting(&client_ptr);
   }
   BrowserThread::PostTask(
-      BrowserThread::IO,
-      FROM_HERE,
-      base::Bind(callback, worker_devtools_agent_route_id, wait_for_debugger));
+      BrowserThread::IO, FROM_HERE,
+      base::Bind(callback, worker_devtools_agent_route_id, wait_for_debugger,
+                 base::Passed(client_ptr.PassInterface())));
 }
 
 void SetupEventDispatcherOnUIThread(
     int process_id,
     int thread_id,
     mojom::ServiceWorkerEventDispatcherRequest request) {
   DCHECK(!ServiceWorkerUtils::IsMojoForServiceWorkerEnabled());
   RenderProcessHost* rph = RenderProcessHost::FromID(process_id);
-  // |rph| or its InterfaceProvider may be NULL in unit tests.
-  if (!rph || !rph->GetRemoteInterfaces())
+  // |rph| may be NULL in unit tests.
+  if (!rph)
     return;
-  mojom::EmbeddedWorkerSetupPtr setup;
-  rph->GetRemoteInterfaces()->GetInterface(&setup);
+  mojom::EmbeddedWorkerSetupAssociatedPtr setup;
+  if (rph->GetChannel()) {
+    rph->GetChannel()->GetRemoteAssociatedInterface(&setup);
+  } else {
+    // In unit tests we establish associated interface connections via
+    // MockRenderProcessHost.
+    DCHECK(rph->GetAssociatedInterfaceProviderForTesting());
+    rph->GetAssociatedInterfaceProviderForTesting()->GetInterface(&setup);
+  }
   setup->AttachServiceWorkerEventDispatcher(thread_id, std::move(request));
 }
 
 void CallDetach(EmbeddedWorkerInstance* instance) {
   // This could be called on the UI thread if |client_| still be valid when the
   // message loop on the UI thread gets destructed.
   // TODO(shimazu): Remove this after https://crbug.com/604762 is fixed
   if (!BrowserThread::CurrentlyOn(BrowserThread::IO)) {
     DCHECK(ServiceWorkerUtils::IsMojoForServiceWorkerEnabled());
     return;
@@ skipping 90 matching lines @@
 
 // A task to allocate a worker process and to send a start worker message. This
 // is created on EmbeddedWorkerInstance::Start(), owned by the instance and
 // destroyed on EmbeddedWorkerInstance::OnScriptEvaluated().
 // We can abort starting worker by destroying this task anytime during the
 // sequence.
 class EmbeddedWorkerInstance::StartTask {
  public:
   enum class ProcessAllocationState { NOT_ALLOCATED, ALLOCATING, ALLOCATED };
 
-  StartTask(EmbeddedWorkerInstance* instance,
-            const GURL& script_url,
-            mojom::EmbeddedWorkerInstanceClientRequest request)
+  StartTask(EmbeddedWorkerInstance* instance, const GURL& script_url)
       : instance_(instance),
-        request_(std::move(request)),
         state_(ProcessAllocationState::NOT_ALLOCATED),
         is_installed_(false),
         started_during_browser_startup_(false),
         weak_factory_(this) {
     TRACE_EVENT_ASYNC_BEGIN1("ServiceWorker", "EmbeddedWorkerInstance::Start",
                              this, "Script", script_url.spec());
   }
 
   ~StartTask() {
     DCHECK_CURRENTLY_ON(BrowserThread::IO);
@@ skipping 110 matching lines @@
     params->settings.data_saver_enabled = settings.data_saver_enabled;
 
     // Register the instance to DevToolsManager on UI thread.
     const int64_t service_worker_version_id = params->service_worker_version_id;
     const GURL& scope = params->scope;
     GURL script_url(params->script_url);
     BrowserThread::PostTask(
         BrowserThread::UI, FROM_HERE,
         base::Bind(&SetupOnUI, process_id, instance_->context_.get(),
                    instance_->context_, service_worker_version_id, script_url,
-                   scope, is_installed_, base::Passed(&request_),
+                   scope, is_installed_,
                    base::Bind(&StartTask::OnSetupOnUICompleted,
                               weak_factory_.GetWeakPtr(), base::Passed(&params),
                               is_new_process)));
   }
 
-  void OnSetupOnUICompleted(std::unique_ptr<EmbeddedWorkerStartParams> params,
-                            bool is_new_process,
-                            int worker_devtools_agent_route_id,
-                            bool wait_for_debugger) {
+  void OnSetupOnUICompleted(
+      std::unique_ptr<EmbeddedWorkerStartParams> params,
+      bool is_new_process,
+      int worker_devtools_agent_route_id,
+      bool wait_for_debugger,
+      mojom::EmbeddedWorkerInstanceClientAssociatedPtrInfo ptr_info) {
     DCHECK_CURRENTLY_ON(BrowserThread::IO);
     TRACE_EVENT_ASYNC_STEP_PAST0("ServiceWorker",
                                  "EmbeddedWorkerInstance::Start", this,
                                  "OnSetupOnUICompleted");
 
     // Notify the instance that it is registered to the devtools manager.
     instance_->OnRegisteredToDevToolsManager(
         is_new_process, worker_devtools_agent_route_id, wait_for_debugger);
 
     params->worker_devtools_agent_route_id = worker_devtools_agent_route_id;
     params->wait_for_debugger = wait_for_debugger;
 
     if (ServiceWorkerUtils::IsMojoForServiceWorkerEnabled())
-      SendMojoStartWorker(std::move(params));
+      SendMojoStartWorker(std::move(params), std::move(ptr_info));
     else
       SendStartWorker(std::move(params));
   }
 
   void SendStartWorker(std::unique_ptr<EmbeddedWorkerStartParams> params) {
     DCHECK_CURRENTLY_ON(BrowserThread::IO);
     ServiceWorkerStatusCode status = instance_->registry_->SendStartWorker(
         std::move(params), instance_->process_id());
     TRACE_EVENT_ASYNC_STEP_PAST1(
         "ServiceWorker", "EmbeddedWorkerInstance::Start", this,
         "SendStartWorker", "Status", ServiceWorkerStatusToString(status));
     if (status != SERVICE_WORKER_OK) {
       StatusCallback callback = start_callback_;
       start_callback_.Reset();
       instance_->OnStartFailed(callback, status);
       // |this| may be destroyed.
       return;
     }
     instance_->OnStartWorkerMessageSent();
 
     // |start_callback_| will be called via RunStartCallback() when the script
     // is evaluated.
   }
 
-  void SendMojoStartWorker(std::unique_ptr<EmbeddedWorkerStartParams> params) {
+  void SendMojoStartWorker(
+      std::unique_ptr<EmbeddedWorkerStartParams> params,
+      mojom::EmbeddedWorkerInstanceClientAssociatedPtrInfo ptr_info) {
     ServiceWorkerStatusCode status =
-        instance_->SendMojoStartWorker(std::move(params));
+        instance_->SendMojoStartWorker(std::move(params), std::move(ptr_info));
     if (status != SERVICE_WORKER_OK) {
       StatusCallback callback = start_callback_;
       start_callback_.Reset();
       instance_->OnStartFailed(callback, status);
       // |this| may be destroyed.
       return;
     }
   }
 
   // |instance_| must outlive |this|.
   EmbeddedWorkerInstance* instance_;
 
-  // Ownership is transferred by base::Passed() to a task after process
-  // allocation.
-  mojom::EmbeddedWorkerInstanceClientRequest request_;
-
   StatusCallback start_callback_;
   ProcessAllocationState state_;
 
   // Used for UMA.
   bool is_installed_;
   bool started_during_browser_startup_;
 
   base::WeakPtrFactory<StartTask> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(StartTask);
@@ skipping 32 matching lines @@
   starting_phase_ = ALLOCATING_PROCESS;
   network_accessed_for_script_ = false;
   for (auto& observer : listener_list_)
     observer.OnStarting();
 
   params->embedded_worker_id = embedded_worker_id_;
   params->worker_devtools_agent_route_id = MSG_ROUTING_NONE;
   params->wait_for_debugger = false;
   params->settings.v8_cache_options = GetV8CacheOptions();
 
-  mojom::EmbeddedWorkerInstanceClientRequest request;
-  if (ServiceWorkerUtils::IsMojoForServiceWorkerEnabled()) {
-    request = mojo::MakeRequest(&client_);
-    client_.set_connection_error_handler(
-        base::Bind(&CallDetach, base::Unretained(this)));
-  }
-
   pending_dispatcher_request_ = std::move(dispatcher_request);
 
-  inflight_start_task_.reset(
-      new StartTask(this, params->script_url, std::move(request)));
+  inflight_start_task_.reset(new StartTask(this, params->script_url));
   inflight_start_task_->Start(std::move(params), callback);
 }
 
 ServiceWorkerStatusCode EmbeddedWorkerInstance::Stop() {
   DCHECK(status_ == EmbeddedWorkerStatus::STARTING ||
          status_ == EmbeddedWorkerStatus::RUNNING)
       << static_cast<int>(status_);
 
   // Abort an inflight start task.
   inflight_start_task_.reset();
 
   ServiceWorkerStatusCode status = SERVICE_WORKER_ERROR_IPC_FAILED;
   if (ServiceWorkerUtils::IsMojoForServiceWorkerEnabled()) {
-    status = SERVICE_WORKER_OK;
-    client_->StopWorker(base::Bind(&EmbeddedWorkerRegistry::OnWorkerStopped,
-                                   base::Unretained(registry_.get()),
-                                   process_id(), embedded_worker_id()));
+    // |client_| may be not bound yet, or has become broken.
+    if (client_ && !client_.encountered_error()) {
+      status = SERVICE_WORKER_OK;
+      client_->StopWorker(base::Bind(&EmbeddedWorkerRegistry::OnWorkerStopped,
+                                     base::Unretained(registry_.get()),
+                                     process_id(), embedded_worker_id()));
+    }
   } else {
     status = registry_->StopWorker(process_id(), embedded_worker_id_);
   }
   UMA_HISTOGRAM_ENUMERATION("ServiceWorker.SendStopWorker.Status", status,
                             SERVICE_WORKER_ERROR_MAX_VALUE);
   // StopWorker could fail if we were starting up and don't have a process yet,
   // or we can no longer communicate with the process. So just detach.
   if (status != SERVICE_WORKER_OK) {
     OnDetached();
     return status;
@@ skipping 80 matching lines @@
   if (wait_for_debugger) {
     // We don't measure the start time when wait_for_debugger flag is set. So
     // we set the NULL time here.
     step_time_ = base::TimeTicks();
   }
   for (auto& observer : listener_list_)
     observer.OnRegisteredToDevToolsManager();
 }
 
 ServiceWorkerStatusCode EmbeddedWorkerInstance::SendMojoStartWorker(
-    std::unique_ptr<EmbeddedWorkerStartParams> params) {
+    std::unique_ptr<EmbeddedWorkerStartParams> params,
+    mojom::EmbeddedWorkerInstanceClientAssociatedPtrInfo ptr_info) {
   if (!context_)
     return SERVICE_WORKER_ERROR_ABORT;
+  DCHECK(ServiceWorkerUtils::IsMojoForServiceWorkerEnabled());
   DCHECK(pending_dispatcher_request_.is_pending());
+  DCHECK(ptr_info.is_valid());
+  client_.Bind(std::move(ptr_info));
+  client_.set_connection_error_handler(
+      base::Bind(&CallDetach, base::Unretained(this)));
   client_->StartWorker(*params, std::move(pending_dispatcher_request_));
   registry_->BindWorkerToProcess(process_id(), embedded_worker_id());
   TRACE_EVENT_ASYNC_STEP_PAST1("ServiceWorker", "EmbeddedWorkerInstance::Start",
                                this, "SendStartWorker", "Status", "mojo");
   OnStartWorkerMessageSent();
   return SERVICE_WORKER_OK;
 }
 
 void EmbeddedWorkerInstance::OnStartWorkerMessageSent() {
   if (!step_time_.is_null()) {
@@ skipping 319 matching lines @@
     case SCRIPT_READ_FINISHED:
       return "Script read finished";
     case STARTING_PHASE_MAX_VALUE:
       NOTREACHED();
   }
   NOTREACHED() << phase;
   return std::string();
 }
 
 }  // namespace content