Add two interfaces for ServiceWorkerProviderContext/ProviderHost

content/browser/service_worker/service_worker_provider_host.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/service_worker_provider_host.h"
 
 #include <utility>
 
 #include "base/feature_list.h"
 #include "base/guid.h"
@@ skipping 43 matching lines @@
       ResourceType resource_type)
       : ServiceWorkerRequestHandler(context,
                                     provider_host,
                                     blob_storage_context,
                                     resource_type) {}
   ~ServiceWorkerURLTrackingRequestHandler() override {}
 
   // Called via custom URLRequestJobFactory.
   net::URLRequestJob* MaybeCreateJob(
       net::URLRequest* request,
-      net::NetworkDelegate* network_delegate,
-      ResourceContext* resource_context) override {
+      net::NetworkDelegate* /* network_delegate */,
+      ResourceContext* /* resource_context */) override {
     // |provider_host_| may have been deleted when the request is resumed.
     if (!provider_host_)
       return nullptr;
     const GURL stripped_url = net::SimplifyUrlForRequest(request->url());
     provider_host_->SetDocumentUrl(stripped_url);
     provider_host_->SetTopmostFrameUrl(request->first_party_for_cookies());
     return nullptr;
   }
 
  private:
   DISALLOW_COPY_AND_ASSIGN(ServiceWorkerURLTrackingRequestHandler);
 };
 
+void RemoveProviderHost(base::WeakPtr<ServiceWorkerContextCore> context,
+                        int process_id,
+                        int provider_id) {
+  TRACE_EVENT0("ServiceWorker",
+               "ServiceWorkerProviderHost::RemoveProviderHost");
+  if (!context)
+    return;
+  if (!context->GetProviderHost(process_id, provider_id)) {
+    // PlzNavigate: in some cancellation of navigation cases, it is possible
+    // for the pre-created host to have been destroyed before being claimed by
+    // the renderer. The provider is then destroyed in the renderer, and no
+    // matching host will be found.
+    CHECK(IsBrowserSideNavigationEnabled() &&
+          ServiceWorkerUtils::IsBrowserAssignedProviderId(provider_id));
+    return;
+  }
+  context->RemoveProviderHost(process_id, provider_id);
+}
+
 }  // anonymous namespace
 
 ServiceWorkerProviderHost::OneShotGetReadyCallback::OneShotGetReadyCallback(
     const GetRegistrationForReadyCallback& callback)
     : callback(callback),
       called(false) {
 }
 
 ServiceWorkerProviderHost::OneShotGetReadyCallback::~OneShotGetReadyCallback() {
 }
 
 // static
 std::unique_ptr<ServiceWorkerProviderHost>
 ServiceWorkerProviderHost::PreCreateNavigationHost(
     base::WeakPtr<ServiceWorkerContextCore> context,
     bool are_ancestors_secure,
     const WebContentsGetter& web_contents_getter) {
   CHECK(IsBrowserSideNavigationEnabled());
   // Generate a new browser-assigned id for the host.
   int provider_id = g_next_navigation_provider_id--;
   auto host = base::WrapUnique(new ServiceWorkerProviderHost(
-      ChildProcessHost::kInvalidUniqueID, MSG_ROUTING_NONE, provider_id,
-      SERVICE_WORKER_PROVIDER_FOR_WINDOW, are_ancestors_secure, context,
-      nullptr));
+      ChildProcessHost::kInvalidUniqueID,
+      ServiceWorkerProviderHostInfo(provider_id, MSG_ROUTING_NONE,
+                                    SERVICE_WORKER_PROVIDER_FOR_WINDOW,
+                                    are_ancestors_secure),
+      context, nullptr));
   host->web_contents_getter_ = web_contents_getter;
   return host;
 }
 
 // static
 std::unique_ptr<ServiceWorkerProviderHost> ServiceWorkerProviderHost::Create(
     int process_id,
     ServiceWorkerProviderHostInfo info,
     base::WeakPtr<ServiceWorkerContextCore> context,
     ServiceWorkerDispatcherHost* dispatcher_host) {
   return base::WrapUnique(new ServiceWorkerProviderHost(
-      process_id, info.route_id, info.provider_id, info.type,
-      info.is_parent_frame_secure, context, dispatcher_host));
+      process_id, std::move(info), context, dispatcher_host));
 }
 
 void ServiceWorkerProviderHost::BindWorkerFetchContext(
     mojom::ServiceWorkerWorkerClientAssociatedPtrInfo client_ptr_info) {
   DCHECK(base::FeatureList::IsEnabled(features::kOffMainThreadFetch));
   mojom::ServiceWorkerWorkerClientAssociatedPtr client;
   client.Bind(std::move(client_ptr_info));
   client.set_connection_error_handler(
       base::Bind(&ServiceWorkerProviderHost::UnregisterWorkerFetchContext,
                  base::Unretained(this), client.get()));
 
   if (controlling_version_)
     client->SetControllerServiceWorker(controlling_version_->version_id());
 
   auto result = worker_clients_.insert(
       std::make_pair<mojom::ServiceWorkerWorkerClient*,
                      mojom::ServiceWorkerWorkerClientAssociatedPtr>(
           client.get(), std::move(client)));
   DCHECK(result.second);
 }
 
 void ServiceWorkerProviderHost::UnregisterWorkerFetchContext(
     mojom::ServiceWorkerWorkerClient* client) {
   DCHECK(worker_clients_.count(client));
   worker_clients_.erase(client);
 }
 
 ServiceWorkerProviderHost::ServiceWorkerProviderHost(
     int render_process_id,
-    int route_id,
-    int provider_id,
-    ServiceWorkerProviderType provider_type,
-    bool is_parent_frame_secure,
+    ServiceWorkerProviderHostInfo info,
     base::WeakPtr<ServiceWorkerContextCore> context,
     ServiceWorkerDispatcherHost* dispatcher_host)
     : client_uuid_(base::GenerateGUID()),
       render_process_id_(render_process_id),
-      route_id_(route_id),
       render_thread_id_(kDocumentMainThreadId),
-      provider_id_(provider_id),
-      provider_type_(provider_type),
-      is_parent_frame_secure_(is_parent_frame_secure),
+      info_(std::move(info)),
       context_(context),
       dispatcher_host_(dispatcher_host),
-      allow_association_(true) {
-  DCHECK_NE(SERVICE_WORKER_PROVIDER_UNKNOWN, provider_type_);
+      allow_association_(true),
+      binding_(this) {
+  DCHECK_NE(SERVICE_WORKER_PROVIDER_UNKNOWN, info_.type);
 
   // PlzNavigate
   CHECK(render_process_id != ChildProcessHost::kInvalidUniqueID ||
         IsBrowserSideNavigationEnabled());
 
-  if (provider_type_ == SERVICE_WORKER_PROVIDER_FOR_CONTROLLER) {
+  if (info_.type == SERVICE_WORKER_PROVIDER_FOR_CONTROLLER) {
     // Actual thread id is set when the service worker context gets started.
     render_thread_id_ = kInvalidEmbeddedWorkerThreadId;
   }
   context_->RegisterProviderHostByClientID(client_uuid_, this);
+
+  // PlzNavigate
+  // |client_| and |binding_| will be bound on CompleteNavigationInitialized.
+  if (IsBrowserSideNavigationEnabled()) {
+    DCHECK(!info.client_ptr_info.is_valid() && !info.host_request.is_pending());
+    return;
+  }
+
+  client_.Bind(std::move(info_.client_ptr_info));
+  binding_.Bind(std::move(info_.host_request));
+  binding_.set_connection_error_handler(base::Bind(
+      &RemoveProviderHost, context_, render_process_id, info_.provider_id));
 }
 
 ServiceWorkerProviderHost::~ServiceWorkerProviderHost() {
   if (context_)
     context_->UnregisterProviderHostByClientID(client_uuid_);
 
   // Clear docurl so the deferred activation of a waiting worker
   // won't associate the new version with a provider being destroyed.
   document_url_ = GURL();
   if (controlling_version_.get())
     controlling_version_->RemoveControllee(this);
 
   RemoveAllMatchingRegistrations();
 
   for (const GURL& pattern : associated_patterns_)
     DecreaseProcessReference(pattern);
 }
 
 int ServiceWorkerProviderHost::frame_id() const {
-  if (provider_type_ == SERVICE_WORKER_PROVIDER_FOR_WINDOW)
-    return route_id_;
+  if (info_.type == SERVICE_WORKER_PROVIDER_FOR_WINDOW)
+    return info_.route_id;
   return MSG_ROUTING_NONE;
 }
 
 bool ServiceWorkerProviderHost::IsContextSecureForServiceWorker() const {
   // |document_url_| may be empty if loading has not begun, or
   // ServiceWorkerRequestHandler didn't handle the load (because e.g. another
   // handler did first, or the initial request URL was such that
   // OriginCanAccessServiceWorkers returned false).
   if (!document_url_.is_valid())
     return false;
   if (!OriginCanAccessServiceWorkers(document_url_))
     return false;
 
   if (is_parent_frame_secure())
     return true;
 
   std::set<std::string> schemes;
   GetContentClient()->browser()->GetSchemesBypassingSecureContextCheckWhitelist(
       &schemes);
   return schemes.find(document_url().scheme()) != schemes.end();
 }
 
 void ServiceWorkerProviderHost::OnVersionAttributesChanged(
     ServiceWorkerRegistration* registration,
     ChangedVersionAttributesMask changed_mask,
-    const ServiceWorkerRegistrationInfo& info) {
+    const ServiceWorkerRegistrationInfo& /* info */) {
   if (!get_ready_callback_ || get_ready_callback_->called)
     return;
   if (changed_mask.active_changed() && registration->active_version()) {
     // Wait until the state change so we don't send the get for ready
     // registration complete message before set version attributes message.
     registration->active_version()->RegisterStatusChangeCallback(base::Bind(
           &ServiceWorkerProviderHost::ReturnRegistrationForReadyIfNeeded,
           AsWeakPtr()));
   }
 }
@@ skipping 68 matching lines @@
 
 void ServiceWorkerProviderHost::SetHostedVersion(
     ServiceWorkerVersion* version) {
   DCHECK(!IsProviderForClient());
   DCHECK_EQ(EmbeddedWorkerStatus::STARTING, version->running_status());
   DCHECK_EQ(render_process_id_, version->embedded_worker()->process_id());
   running_hosted_version_ = version;
 }
 
 bool ServiceWorkerProviderHost::IsProviderForClient() const {
-  switch (provider_type_) {
+  switch (info_.type) {
     case SERVICE_WORKER_PROVIDER_FOR_WINDOW:
     case SERVICE_WORKER_PROVIDER_FOR_WORKER:
     case SERVICE_WORKER_PROVIDER_FOR_SHARED_WORKER:
       return true;
     case SERVICE_WORKER_PROVIDER_FOR_CONTROLLER:
       return false;
     case SERVICE_WORKER_PROVIDER_UNKNOWN:
-      NOTREACHED() << provider_type_;
+      NOTREACHED() << info_.type;
   }
-  NOTREACHED() << provider_type_;
+  NOTREACHED() << info_.type;
   return false;
 }
 
 blink::WebServiceWorkerClientType ServiceWorkerProviderHost::client_type()
     const {
-  switch (provider_type_) {
+  switch (info_.type) {
     case SERVICE_WORKER_PROVIDER_FOR_WINDOW:
       return blink::kWebServiceWorkerClientTypeWindow;
     case SERVICE_WORKER_PROVIDER_FOR_WORKER:
       return blink::kWebServiceWorkerClientTypeWorker;
     case SERVICE_WORKER_PROVIDER_FOR_SHARED_WORKER:
       return blink::kWebServiceWorkerClientTypeSharedWorker;
     case SERVICE_WORKER_PROVIDER_FOR_CONTROLLER:
     case SERVICE_WORKER_PROVIDER_UNKNOWN:
-      NOTREACHED() << provider_type_;
+      NOTREACHED() << info_.type;
   }
-  NOTREACHED() << provider_type_;
+  NOTREACHED() << info_.type;
   return blink::kWebServiceWorkerClientTypeWindow;
 }
 
 void ServiceWorkerProviderHost::AssociateRegistration(
     ServiceWorkerRegistration* registration,
     bool notify_controllerchange) {
   CHECK(IsContextSecureForServiceWorker());
   DCHECK(CanAssociateRegistration(registration));
   associated_registration_ = registration;
   AddMatchingRegistration(registration);
@@ skipping 185 matching lines @@
   if (get_ready_callback_)
     return false;
   get_ready_callback_.reset(new OneShotGetReadyCallback(callback));
   ReturnRegistrationForReadyIfNeeded();
   return true;
 }
 
 std::unique_ptr<ServiceWorkerProviderHost>
 ServiceWorkerProviderHost::PrepareForCrossSiteTransfer() {
   DCHECK_NE(ChildProcessHost::kInvalidUniqueID, render_process_id_);
-  DCHECK_NE(MSG_ROUTING_NONE, route_id_);
+  DCHECK_NE(MSG_ROUTING_NONE, info_.route_id);
   DCHECK_EQ(kDocumentMainThreadId, render_thread_id_);
-  DCHECK_NE(SERVICE_WORKER_PROVIDER_UNKNOWN, provider_type_);
+  DCHECK_NE(SERVICE_WORKER_PROVIDER_UNKNOWN, info_.type);
 
-  std::unique_ptr<ServiceWorkerProviderHost> new_provider_host =
+  std::unique_ptr<ServiceWorkerProviderHost> replacement =
       base::WrapUnique(new ServiceWorkerProviderHost(
-          process_id(), frame_id(), provider_id(), provider_type(),
-          is_parent_frame_secure(), context_, dispatcher_host()));
+          process_id(),
+          ServiceWorkerProviderHostInfo(std::move(info_), binding_.Unbind(),
+                                        client_.PassInterface()),
+          context_, dispatcher_host()));
 
   for (const GURL& pattern : associated_patterns_)
     DecreaseProcessReference(pattern);
 
   for (auto& key_registration : matching_registrations_)
     DecreaseProcessReference(key_registration.second->pattern());
 
   if (associated_registration_.get()) {
     if (dispatcher_host_) {
       Send(new ServiceWorkerMsg_DisassociateRegistration(
           render_thread_id_, provider_id()));
     }
   }
 
   render_process_id_ = ChildProcessHost::kInvalidUniqueID;
-  route_id_ = MSG_ROUTING_NONE;
   render_thread_id_ = kInvalidEmbeddedWorkerThreadId;
-  provider_id_ = kInvalidServiceWorkerProviderId;
-  provider_type_ = SERVICE_WORKER_PROVIDER_UNKNOWN;
   dispatcher_host_ = nullptr;
-  return new_provider_host;
+  return replacement;
 }
 
 void ServiceWorkerProviderHost::CompleteCrossSiteTransfer(
-    int new_process_id,
-    int new_frame_id,
-    int new_provider_id,
-    ServiceWorkerProviderType new_provider_type,
-    ServiceWorkerDispatcherHost* new_dispatcher_host) {
+    ServiceWorkerProviderHost* provisional_host) {
   DCHECK_EQ(ChildProcessHost::kInvalidUniqueID, render_process_id_);
-  DCHECK_NE(ChildProcessHost::kInvalidUniqueID, new_process_id);
-  DCHECK_NE(MSG_ROUTING_NONE, new_frame_id);
+  DCHECK_NE(ChildProcessHost::kInvalidUniqueID, provisional_host->process_id());
+  DCHECK_NE(MSG_ROUTING_NONE, provisional_host->frame_id());
 
   render_thread_id_ = kDocumentMainThreadId;
-  provider_id_ = new_provider_id;
-  provider_type_ = new_provider_type;
+  info_.provider_id = provisional_host->provider_id();
+  info_.type = provisional_host->provider_type();
 
-  FinalizeInitialization(new_process_id, new_frame_id, new_dispatcher_host);
+  // Take the connection over from the provisional host.
+  DCHECK(!client_.is_bound());
+  DCHECK(!binding_.is_bound());
+  client_.Bind(provisional_host->client_.PassInterface());
+  binding_.Bind(provisional_host->binding_.Unbind());
+  binding_.set_connection_error_handler(
+      base::Bind(&RemoveProviderHost, context_, provisional_host->process_id(),
+                 provisional_host->provider_id()));
+
+  FinalizeInitialization(provisional_host->process_id(),
+                         provisional_host->frame_id(),
+                         provisional_host->dispatcher_host());
 }
 
 // PlzNavigate
 void ServiceWorkerProviderHost::CompleteNavigationInitialized(
     int process_id,
-    int frame_routing_id,
+    ServiceWorkerProviderHostInfo info,
     ServiceWorkerDispatcherHost* dispatcher_host) {
   CHECK(IsBrowserSideNavigationEnabled());
   DCHECK_EQ(ChildProcessHost::kInvalidUniqueID, render_process_id_);
-  DCHECK_EQ(SERVICE_WORKER_PROVIDER_FOR_WINDOW, provider_type_);
+  DCHECK_EQ(SERVICE_WORKER_PROVIDER_FOR_WINDOW, info_.type);
   DCHECK_EQ(kDocumentMainThreadId, render_thread_id_);
 
   DCHECK_NE(ChildProcessHost::kInvalidUniqueID, process_id);
-  DCHECK_NE(MSG_ROUTING_NONE, frame_routing_id);
+  DCHECK_EQ(info_.provider_id, info.provider_id);
+  DCHECK_NE(MSG_ROUTING_NONE, info.route_id);
 
-  FinalizeInitialization(process_id, frame_routing_id, dispatcher_host);
+  // Connect with the provider on the renderer.
+  DCHECK(!client_.is_bound());
+  DCHECK(!binding_.is_bound());
+  client_.Bind(std::move(info.client_ptr_info));
+  binding_.Bind(std::move(info.host_request));
+  binding_.set_connection_error_handler(
+      base::Bind(&RemoveProviderHost, context_, process_id, provider_id()));
+
+  FinalizeInitialization(process_id, info.route_id, dispatcher_host);
 }
 
 void ServiceWorkerProviderHost::SendUpdateFoundMessage(
     int registration_handle_id) {
   if (!dispatcher_host_)
     return;  // Could be nullptr in some tests.
 
   if (!IsReadyToSendMessages()) {
     queued_events_.push_back(
         base::Bind(&ServiceWorkerProviderHost::SendUpdateFoundMessage,
@@ skipping 151 matching lines @@
   DCHECK(dispatcher_host_);
   DCHECK(IsReadyToSendMessages());
   dispatcher_host_->Send(message);
 }
 
 void ServiceWorkerProviderHost::FinalizeInitialization(
     int process_id,
     int frame_routing_id,
     ServiceWorkerDispatcherHost* dispatcher_host) {
   render_process_id_ = process_id;
-  route_id_ = frame_routing_id;
+  info_.route_id = frame_routing_id;
   dispatcher_host_ = dispatcher_host;
 
   for (const GURL& pattern : associated_patterns_)
     IncreaseProcessReference(pattern);
 
   for (auto& key_registration : matching_registrations_)
     IncreaseProcessReference(key_registration.second->pattern());
 
   if (associated_registration_.get()) {
     SendAssociateRegistrationMessage();
     if (dispatcher_host_ && associated_registration_->active_version()) {
       Send(new ServiceWorkerMsg_SetControllerServiceWorker(
           render_thread_id_, provider_id(),
           GetOrCreateServiceWorkerHandle(
               associated_registration_->active_version()),
           false /* shouldNotifyControllerChange */,
           associated_registration_->active_version()->used_features()));
     }
   }
 }
 
 }  // namespace content