ServiceWorker: Enqueue state change events until the worker thread gets ready

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 <set>
 #include <vector>
 
@@ skipping 27 matching lines @@
 // object is tied to the lifetime of its document in the renderer process.
 // This class holds service worker state that is scoped to an individual
 // document.
 //
 // Note this class can also host a running service worker, in which
 // case it will observe resource loads made directly by the service worker.
 class CONTENT_EXPORT ServiceWorkerProviderHost
     : public NON_EXPORTED_BASE(ServiceWorkerRegistration::Listener),
       public base::SupportsWeakPtr<ServiceWorkerProviderHost> {
  public:
+  typedef ServiceWorkerProviderHost self;

[falken, 2015/01/28 13:42:09]

comment: This pattern doesn't look idiomatic in Chromium codebase (outside some
Service Worker and sync file system classes :) ... is it really worth the level
of indirection... and is it even ok per style guide to have this lowercase type?
I'm not strongly opposed, just seems a bit off.

[nhiroki, 2015/01/28 14:08:30]

To wrap the line at 80 columns, I just copied it from other sites without
thinking. This seems no longer necessary, so I just removed.

   typedef base::Callback<void(bool)> FocusCallback;
 
   ServiceWorkerProviderHost(int render_process_id,
                             int render_frame_id,
                             int provider_id,
                             base::WeakPtr<ServiceWorkerContextCore> context,
                             ServiceWorkerDispatcherHost* dispatcher_host);
   virtual ~ServiceWorkerProviderHost();
 
   int process_id() const { return render_process_id_; }
@@ skipping 96 matching lines @@
   void PrepareForCrossSiteTransfer();
   void CompleteCrossSiteTransfer(
       int new_process_id,
       int new_frame_id,
       int new_provider_id,
       ServiceWorkerDispatcherHost* dispatcher_host);
   ServiceWorkerDispatcherHost* dispatcher_host() const {
     return dispatcher_host_;
   }
 
   // Called from ServiceWorkerRegistrationHandle.

[kinuko, 2015/01/28 07:13:11]

Can we put a bit more descriptive comments for these SendXXX()?
('Called from YYY' is not really informative, and it'd be better to also mention
that this may queue up messages)

[nhiroki, 2015/01/28 13:43:22]

Done.

   void SendUpdateFoundMessage(
       const ServiceWorkerRegistrationObjectInfo& object_info);
   void SendSetVersionAttributesMessage(
       int registration_handle_id,
       ChangedVersionAttributesMask changed_mask,
       ServiceWorkerVersion* installing_version,
       ServiceWorkerVersion* waiting_version,
       ServiceWorkerVersion* active_version);
 
   // Called from ServiceWorkerHandle.
   void SendServiceWorkerStateChangedMessage(
       int worker_handle_id,
       blink::WebServiceWorkerState state);
 
+  // Sets the thread id and flushes queued events.
+  void SetReadyToSend(int render_thread_id);

[kinuko, 2015/01/28 07:13:11]

SetReadyToSendMessagesToRenderer ? (or ToWorker, maybe, as it's only used for
SWs)

[falken, 2015/01/28 13:42:09]

+1, it'd be nice to have a more descriptive name and summarize the gist of the
design doc in a comment here so the motivation is understood: events for the
worker are queued up until the worker thread id is known.

[nhiroki, 2015/01/28 13:43:22]

Done.

[nhiroki, 2015/01/28 14:08:30]

Updated.

+
  private:
   friend class ServiceWorkerProviderHostTest;
   friend class ServiceWorkerWriteToCacheJobTest;
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerContextRequestHandlerTest,
                            UpdateBefore24Hours);
   FRIEND_TEST_ALL_PREFIXES(ServiceWorkerContextRequestHandlerTest,
                            UpdateAfter24Hours);
 
   // ServiceWorkerRegistration::Listener overrides.
   void OnRegistrationFailed(ServiceWorkerRegistration* registration) override;
   void OnSkippedWaiting(ServiceWorkerRegistration* registration) override;
 
   // Sets the controller version field to |version| or if |version| is NULL,
   // clears the field.
   void SetControllerVersionAttribute(ServiceWorkerVersion* version);
 
   void SendAssociateRegistrationMessage();
 
   // Increase/decrease this host's process reference for |pattern|.
   void IncreaseProcessReference(const GURL& pattern);
   void DecreaseProcessReference(const GURL& pattern);
 
+  bool IsReadyToSend() const;
+  void Send(IPC::Message* message) const;
+
   int render_process_id_;
   int render_frame_id_;
+  int render_thread_id_;
   int provider_id_;
   GURL document_url_;
   GURL topmost_frame_url_;
 
   std::vector<GURL> associated_patterns_;
   scoped_refptr<ServiceWorkerRegistration> associated_registration_;
 
   scoped_refptr<ServiceWorkerVersion> controlling_version_;
   scoped_refptr<ServiceWorkerVersion> running_hosted_version_;
   base::WeakPtr<ServiceWorkerContextCore> context_;
   ServiceWorkerDispatcherHost* dispatcher_host_;
   bool allow_association_;
 
+  std::vector<base::Closure> queued_events_;
+
   DISALLOW_COPY_AND_ASSIGN(ServiceWorkerProviderHost);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_PROVIDER_HOST_H_