Create ServiceWorkerProviderHost before starting worker

content/browser/service_worker/service_worker_provider_host.h

 // 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.
 
 #ifndef CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_PROVIDER_HOST_H_
 #define CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_PROVIDER_HOST_H_
 
 #include <stddef.h>
 #include <stdint.h>
 
@@ skipping 40 matching lines @@
 // running service worker.
 //
 // For client providers, there is a provider per document or a worker and the
 // lifetime of this object is tied to the lifetime of its document or the worker
 // in the renderer process. This class holds service worker state that is scoped
 // to an individual document or a worker.
 //
 // For providers hosting a running service worker, this class will observe
 // resource loads made directly by the service worker.
 //
-// A ServiceWorkerProviderHost instance is created when a
-// ServiceWorkerNetworkProvider is created on the renderer process, which
-// happens 1) when a document or worker (i.e., a service worker client) is
-// created, or 2) during service worker startup. Mojo's connection from
-// ServiceWorkerNetworkProvider is established on the creation time, and the
-// instance is destroyed on disconnection from the renderer side.
-// If PlzNavigate is turned on, an instance is pre-created on the browser
+// A ServiceWorkerProviderHost instance is possible to be created on the browser
+// and the renderer. 1) When it's for a document or worker (i.e., a service

[falken, 2017/06/14 08:10:35]

"created on the browser and the renderer" sounds like it can be created in the
renderer process.

How about:

A ServiceWorkerProviderHost is created in the following situations:
1) When it's for a document or worker...
2) When it's for a service worker context...
3) When PlzNavigate is turned on...

[shimazu, 2017/06/16 04:18:44]

Yeah, that looks great! Updated the comment.

+// worker client), the provider host is created when
+// ServiceWorkerNetworkProvider is created on the renderer process. Mojo's
+// connection from ServiceWorkerNetworkProvider is established on the creation
+// time.
+// 2) When it's for a service worker context, the provider host is created on
+// the browser process before launching the service worker's thread. Mojo's
+// connection to the renderer is established with the StartWorker message.
+// 3) When PlzNavigate is turned on, an instance is pre-created on the browser
 // before ServiceWorkerNetworkProvider is created on the renderer because
 // navigation is initiated on the browser side. In that case, establishment of
 // Mojo's connection will be deferred until ServiceWorkerNetworkProvider is
 // created on the renderer.
+// Destruction of the ServiceWorkerProviderHost instance happens on
+// disconnection of the Mojo's pipe from the renderer side regardless of what
+// the provider is for.
 class CONTENT_EXPORT ServiceWorkerProviderHost
     : public NON_EXPORTED_BASE(ServiceWorkerRegistration::Listener),
       public base::SupportsWeakPtr<ServiceWorkerProviderHost>,
       public NON_EXPORTED_BASE(mojom::ServiceWorkerProviderHost) {
  public:
   using GetRegistrationForReadyCallback =
       base::Callback<void(ServiceWorkerRegistration* reigstration)>;
 
   using WebContentsGetter = base::Callback<WebContents*(void)>;
 
   // PlzNavigate
   // Used to pre-create a ServiceWorkerProviderHost for a navigation. The
   // ServiceWorkerNetworkProvider will later be created in the renderer, should
   // the navigation succeed. |is_parent_frame_is_secure| should be true for main
   // frames. Otherwise it is true iff all ancestor frames of this frame have a
   // secure origin. |web_contents_getter| indicates the tab where the navigation
   // is occurring.
   static std::unique_ptr<ServiceWorkerProviderHost> PreCreateNavigationHost(
       base::WeakPtr<ServiceWorkerContextCore> context,
       bool are_ancestors_secure,
       const WebContentsGetter& web_contents_getter);
 
+  // Creates ServiceWorkerProviderHost for the worker's context. Information
+  // about the ServiceWorkerProviderHost is passed with the StartWorker message.

[falken, 2017/06/14 08:10:35]

The use of "context" here is confusing since the |context| param is not the
worker's context. Overall "context" is a really overloaded term for service
workers.

Recommend changing this to "PreCreateForHostedVersion".

// Creates a ServiceWorkerProviderHost for hosting a running service worker.

[kinuko, 2017/06/14 08:37:40]

Or PreCreateForController? (The version is actually not yet hosted yet...)

[shimazu, 2017/06/16 04:18:44]

Done.

+  static std::unique_ptr<ServiceWorkerProviderHost> PreCreateForWorkerContext(
+      ServiceWorkerVersion* hosted_version,
+      base::WeakPtr<ServiceWorkerContextCore> context);
+
   // Used to create a ServiceWorkerProviderHost when the renderer-side provider
   // is created. This ProviderHost will be created for the process specified by
   // |process_id|.
   static std::unique_ptr<ServiceWorkerProviderHost> Create(
       int process_id,
       ServiceWorkerProviderHostInfo info,
       base::WeakPtr<ServiceWorkerContextCore> context,
       ServiceWorkerDispatcherHost* dispatcher_host);
 
   ~ServiceWorkerProviderHost() override;
@@ skipping 89 matching lines @@
 
   // Associates to |registration| to listen for its version change events and
   // sets the controller. If |notify_controllerchange| is true, instructs the
   // renderer to dispatch a 'controllerchange' event.
   void AssociateRegistration(ServiceWorkerRegistration* registration,
                              bool notify_controllerchange);
 
   // Clears the associated registration and stop listening to it.
   void DisassociateRegistration();
 
-  void SetHostedVersion(ServiceWorkerVersion* version);
-
   // Returns a handler for a request, the handler may return NULL if
   // the request doesn't require special handling.
   std::unique_ptr<ServiceWorkerRequestHandler> CreateRequestHandler(
       FetchRequestMode request_mode,
       FetchCredentialsMode credentials_mode,
       FetchRedirectMode redirect_mode,
       ResourceType resource_type,
       RequestContextType request_context_type,
       RequestContextFrameType frame_type,
       base::WeakPtr<storage::BlobStorageContext> blob_storage_context,
@@ skipping 48 matching lines @@
     return dispatcher_host_;
   }
 
   // PlzNavigate
   // Completes initialization of provider hosts used for navigation requests.
   void CompleteNavigationInitialized(
       int process_id,
       ServiceWorkerProviderHostInfo info,
       ServiceWorkerDispatcherHost* dispatcher_host);
 
+  // Completes initialization of provider hosts for controllers.

[falken, 2017/06/14 08:10:35]

When is this called?

[falken, 2017/06/14 08:30:18]

(I mean to add something to the documentation like this is called after a
process is allocated for the worker.)

[shimazu, 2017/06/16 04:18:43]

Done.

+  virtual void CompleteStartWorkerPreparation(
+      int process_id,
+      mojom::ServiceWorkerProviderClientInfoPtr* provider_client_info);

[falken, 2017/06/14 08:10:35]

Does this mutate |provider_client_info|? If so, |out_provider_client_info| or
maybe just |out_info|

[shimazu, 2017/06/16 04:18:44]

Done.

+
   // Sends event messages to the renderer. Events for the worker are queued up
   // until the worker thread id is known via SetReadyToSendMessagesToWorker().
   void SendUpdateFoundMessage(
       int registration_handle_id);
   void SendSetVersionAttributesMessage(
       int registration_handle_id,
       ChangedVersionAttributesMask changed_mask,
       ServiceWorkerVersion* installing_version,
       ServiceWorkerVersion* waiting_version,
       ServiceWorkerVersion* active_version);
@@ skipping 15 matching lines @@
   // exceptional condition like it could no longer be read from the script
   // cache.
   void NotifyControllerLost();
 
   // Binds the ServiceWorkerWorkerClient of a dedicated (or shared) worker to
   // the parent frame's ServiceWorkerProviderHost. (This is used only when
   // off-main-thread-fetch is enabled.)
   void BindWorkerFetchContext(
       mojom::ServiceWorkerWorkerClientAssociatedPtrInfo client_ptr_info);
 
+ protected:
+  ServiceWorkerProviderHost(int process_id,
+                            ServiceWorkerProviderHostInfo info,
+                            base::WeakPtr<ServiceWorkerContextCore> context,
+                            ServiceWorkerDispatcherHost* dispatcher_host);
+
  private:
   friend class ForeignFetchRequestHandlerTest;
   friend class LinkHeaderServiceWorkerTest;
   friend class ServiceWorkerProviderHostTest;
   friend class ServiceWorkerWriteToCacheJobTest;
   friend class ServiceWorkerContextRequestHandlerTest;
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerWriteToCacheJobTest, Update_SameScript);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerWriteToCacheJobTest,
                            Update_SameSizeScript);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerWriteToCacheJobTest,
@@ skipping 10 matching lines @@
 
   struct OneShotGetReadyCallback {
     GetRegistrationForReadyCallback callback;
     bool called;
 
     explicit OneShotGetReadyCallback(
         const GetRegistrationForReadyCallback& callback);
     ~OneShotGetReadyCallback();
   };
 
-  ServiceWorkerProviderHost(int process_id,
-                            ServiceWorkerProviderHostInfo info,
-                            base::WeakPtr<ServiceWorkerContextCore> context,
-                            ServiceWorkerDispatcherHost* dispatcher_host);
-
   // ServiceWorkerRegistration::Listener overrides.
   void OnVersionAttributesChanged(
       ServiceWorkerRegistration* registration,
       ChangedVersionAttributesMask changed_mask,
       const ServiceWorkerRegistrationInfo& info) override;
   void OnRegistrationFailed(ServiceWorkerRegistration* registration) override;
   void OnRegistrationFinishedUninstalling(
       ServiceWorkerRegistration* registration) override;
   void OnSkippedWaiting(ServiceWorkerRegistration* registration) override;
 
@@ skipping 13 matching lines @@
 
   // Increase/decrease this host's process reference for |pattern|.
   void IncreaseProcessReference(const GURL& pattern);
   void DecreaseProcessReference(const GURL& pattern);
 
   void ReturnRegistrationForReadyIfNeeded();
 
   bool IsReadyToSendMessages() const;
   void Send(IPC::Message* message) const;
 
+  // Sets the version hosted by this provider. This method should be used only
+  // for provider hosts for controllers.
+  void SetHostedVersion(ServiceWorkerVersion* version);
+
   // Notifies the information about the controller and associated registration
   // to the provider on the renderer. This is for cross site transfer and
   // browser side navigation which need to decide which process will handle the
   // request later.
   void NotifyControllerToAssociatedProvider();
 
   // Clears the information of the ServiceWorkerWorkerClient of dedicated (or
   // shared) worker, when the connection to the worker is disconnected.
   void UnregisterWorkerFetchContext(mojom::ServiceWorkerWorkerClient*);
 
@@ skipping 51 matching lines @@
   std::unordered_map<mojom::ServiceWorkerWorkerClient*,
                      mojom::ServiceWorkerWorkerClientAssociatedPtr>
       worker_clients_;
 
   DISALLOW_COPY_AND_ASSIGN(ServiceWorkerProviderHost);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_PROVIDER_HOST_H_