[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
@@ skipping 168 matching lines @@
   void DispatchFetchEvent(const ServiceWorkerFetchRequest& request,
                           const base::Closure& prepare_callback,
                           const FetchCallback& fetch_callback);
 
   // Sends sync event to the associated embedded worker and asynchronously calls
   // |callback| when it errors out or it gets a response from the worker to
   // notify completion.
   //
   // This must be called when the status() is ACTIVATED.
   void DispatchSyncEvent(const StatusCallback& callback);
+  void DispatchSyncEventOnUIThread(int render_process_id,
+                                   int thread_id,
+                                   const StatusCallback& callback);
+
+  // Handle callbacks from background sync events
+  void OnSyncEventFinished(const StatusCallback& callback,
+                           BackgroundSyncEventStatus status);
+  void FinishSyncEventOnIOThread(const StatusCallback& callback,
+                                 BackgroundSyncEventStatus status);
 
   // Sends notificationclick event to the associated embedded worker and
   // asynchronously calls |callback| when it errors out or it gets a response
   // from the worker to notify completion.
   //
   // This must be called when the status() is ACTIVATED.
   void DispatchNotificationClickEvent(
       const StatusCallback& callback,
       int64_t persistent_notification_id,
       const PlatformNotificationData& notification_data);
@@ skipping 125 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 41 matching lines @@
   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 85 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_;
   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_;
 
+  BackgroundSyncServiceClientPtr background_sync_client_;

[jkarlin, 2015/06/10 12:21:33]

Hmm, this whole class is IO and this one member is UI. Is it safe for this to be
deleted on the IO thread?

I recommend you make a new class that is to be accessed on the UI thread only
like so:

// All public methods must be called on UI thread. Can be constructed, owned,
and destructed on a separate thread.
class BackgroundSyncEventDispatcher : public
RefCountedThreadSafe<BackgroundSyncEventDispatcher,
BrowserThread::DeleteOnUIThread> {

public:
  // Dispatches the event and then runs |callback| on |task_runner| with the
result.
  DispatchSyncEvent(int render_process_id,
      int thread_id,
      const StatusCallback& callback, 
      const scoped_refptr<base::TaskRunner>& task_runner);

private:
  friend class base::RefCountedThreadSafe<BackgroundSyncEventDispatcher,
BrowserThread::DeleteOnUIThread>;
  ~BackgroundSyncEventDispatcher();

  BackgroundSyncServiceClientPtr background_sync_client_;
}

Then add a scoped_refptr<BackgroundSyncEventDispatcher> member to
ServiceWorkerVersion.

[iclelland, 2015/06/12 15:01:18]

Would a general ServiceWorkerEventDispatcher make more sense than a
BackgroundSyncEventDispatcher?
It may be premature, but if other services move to this model, then I think I'd
rather encourage authors to extend that class than create a PushEventDispatcher
class and a GeofenceEventDispatcher class, etc.

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