[Background Sync] Use Mojo IPC to fire background sync events

content/browser/service_worker/service_worker_version.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_VERSION_H_
 #define CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_VERSION_H_
 
 #include <map>
 #include <queue>
 #include <set>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/callback.h"
 #include "base/gtest_prod_util.h"
 #include "base/id_map.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/observer_list.h"
 #include "base/timer/timer.h"
 #include "content/browser/service_worker/embedded_worker_instance.h"
 #include "content/browser/service_worker/service_worker_script_cache_map.h"
+#include "content/common/background_sync_service.mojom.h"
 #include "content/common/content_export.h"
 #include "content/common/service_worker/service_worker_status_code.h"
 #include "content/common/service_worker/service_worker_types.h"
 #include "third_party/WebKit/public/platform/WebGeofencingEventType.h"
 #include "third_party/WebKit/public/platform/WebServiceWorkerEventResult.h"
 
 // Windows headers will redefine SendMessage.
 #ifdef SendMessage
 #undef SendMessage
 #endif
 
 class GURL;
 
 namespace blink {
 struct WebCircularGeofencingRegion;
 }
 
 namespace net {
 class HttpResponseInfo;
 }
 
 namespace content {
 
 class EmbeddedWorkerRegistry;
 class ServiceWorkerContextCore;
+class ServiceWorkerMojoEventDispatcher;
 class ServiceWorkerProviderHost;
 class ServiceWorkerRegistration;
 class ServiceWorkerURLRequestJob;
 struct NavigatorConnectClient;
 struct PlatformNotificationData;
 struct ServiceWorkerClientInfo;
 struct ServiceWorkerVersionInfo;
 struct TransferredMessagePort;
 
 // This class corresponds to a specific version of a ServiceWorker
@@ skipping 288 matching lines @@
   class Metrics;
   class PingController;
 
   typedef ServiceWorkerVersion self;
   using ServiceWorkerClients = std::vector<ServiceWorkerClientInfo>;
 
   enum RequestType {
     REQUEST_ACTIVATE,
     REQUEST_INSTALL,
     REQUEST_FETCH,
-    REQUEST_SYNC,
     REQUEST_NOTIFICATION_CLICK,
     REQUEST_PUSH,
     REQUEST_GEOFENCING,
     REQUEST_CROSS_ORIGIN_CONNECT
   };
 
   struct RequestInfo {
     RequestInfo(int id, RequestType type);
     ~RequestInfo();
     int id;
@@ skipping 18 matching lines @@
                          int line_number,
                          int column_number,
                          const GURL& source_url) override;
   void OnReportConsoleMessage(int source_identifier,
                               int message_level,
                               const base::string16& message,
                               int line_number,
                               const GURL& source_url) override;
   bool OnMessageReceived(const IPC::Message& message) override;
 
+  // Handle callbacks from background sync events
+  void OnSyncEventFinished(const StatusCallback& callback,
+                           ServiceWorkerStatusCode status);
+
   void OnStartSentAndScriptEvaluated(ServiceWorkerStatusCode status);
 
   void DispatchInstallEventAfterStartWorker(const StatusCallback& callback);
   void DispatchActivateEventAfterStartWorker(const StatusCallback& callback);
 
   void DispatchMessageEventInternal(
       const base::string16& message,
       const std::vector<TransferredMessagePort>& sent_message_ports,
       const StatusCallback& callback);
 
   // Message handlers.
 
   // This corresponds to the spec's matchAll(options) steps.
   void OnGetClients(int request_id,
                     const ServiceWorkerClientQueryOptions& options);
 
   void OnActivateEventFinished(int request_id,
                                blink::WebServiceWorkerEventResult result);
   void OnInstallEventFinished(int request_id,
                               blink::WebServiceWorkerEventResult result);
   void OnFetchEventFinished(int request_id,
                             ServiceWorkerFetchEventResult result,
                             const ServiceWorkerResponse& response);
-  void OnSyncEventFinished(int request_id,
-                           blink::WebServiceWorkerEventResult result);
   void OnNotificationClickEventFinished(int request_id);
   void OnPushEventFinished(int request_id,
                            blink::WebServiceWorkerEventResult result);
   void OnGeofencingEventFinished(int request_id);
   void OnCrossOriginConnectEventFinished(int request_id,
                                          bool accept_connection);
   void OnOpenWindow(int request_id, GURL url);
   void DidOpenWindow(int request_id,
                      int render_process_id,
                      int render_frame_id);
@@ skipping 52 matching lines @@
 
   // Stops the worker if it is idle (has no in-flight requests) or timed out
   // ping.
   void StopWorkerIfIdle();
   bool HasInflightRequests() const;
 
   // RecordStartWorkerResult is added as a start callback by StartTimeoutTimer
   // and records metrics about startup.
   void RecordStartWorkerResult(ServiceWorkerStatusCode status);
 
+  void StopIfRedundant();
+
   template <typename IDMAP>
   void RemoveCallbackAndStopIfRedundant(IDMAP* callbacks, int request_id);
 
   template <typename CallbackType>
   int AddRequest(const CallbackType& callback,
                  IDMap<CallbackType, IDMapOwnPointer>* callback_map,
                  RequestType request_type);
 
   bool OnRequestTimeout(const RequestInfo& info);
   void SetAllRequestTimes(const base::TimeTicks& ticks);
@@ skipping 13 matching lines @@
   scoped_ptr<EmbeddedWorkerInstance> embedded_worker_;
   std::vector<StatusCallback> start_callbacks_;
   std::vector<StatusCallback> stop_callbacks_;
   std::vector<base::Closure> status_change_callbacks_;
 
   // Message callbacks. (Update HasInflightRequests() too when you update this
   // list.)
   IDMap<StatusCallback, IDMapOwnPointer> activate_callbacks_;
   IDMap<StatusCallback, IDMapOwnPointer> install_callbacks_;
   IDMap<FetchCallback, IDMapOwnPointer> fetch_callbacks_;
-  IDMap<StatusCallback, IDMapOwnPointer> sync_callbacks_;

[jkarlin, 2015/06/17 15:17:29]

You're going to need to keep this, for the reasons pointed out in the source
file.

[iclelland, 2015/06/18 16:01:14]

As we discussed, I've reinstated all of the callback accounting in this class
for sync events. (Applies to all sync_callbacks_-related comments)

   IDMap<StatusCallback, IDMapOwnPointer> notification_click_callbacks_;
   IDMap<StatusCallback, IDMapOwnPointer> push_callbacks_;
   IDMap<StatusCallback, IDMapOwnPointer> geofencing_callbacks_;
   IDMap<CrossOriginConnectCallback, IDMapOwnPointer>
       cross_origin_connect_callbacks_;
 
   std::set<const ServiceWorkerURLRequestJob*> streaming_url_request_jobs_;
 
   std::map<std::string, ServiceWorkerProviderHost*> controllee_map_;
   // Will be null while shutting down.
@@ skipping 24 matching lines @@
 
   // The status when StartWorker was invoked. Used for UMA.
   Status prestart_status_ = NEW;
   // If not OK, the reason that StartWorker failed. Used for
   // running |start_callbacks_|.
   ServiceWorkerStatusCode start_worker_status_ = SERVICE_WORKER_OK;
 
   scoped_ptr<PingController> ping_controller_;
   scoped_ptr<Metrics> metrics_;
 
+  scoped_ptr<ServiceWorkerMojoEventDispatcher> mojo_event_dispatcher_;

[jkarlin, 2015/06/17 15:17:29]

Why a scoped_ptr? This could just be a member.

[iclelland, 2015/06/18 16:01:14]

No good reason, I suppose; I've untangled the #include dependencies to make this
a member now.
Done.

+
   base::WeakPtrFactory<ServiceWorkerVersion> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(ServiceWorkerVersion);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_VERSION_H_