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

content/browser/service_worker/service_worker_version.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_version.h"
 
 #include "base/command_line.h"
 #include "base/memory/ref_counted.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/stl_util.h"
@@ skipping 18 matching lines @@
 #include "content/public/browser/content_browser_client.h"
 #include "content/public/browser/page_navigator.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/common/child_process_host.h"
 #include "content/public/common/content_client.h"
 #include "content/public/common/content_switches.h"
 #include "content/public/common/result_codes.h"
+#include "content/public/common/service_registry.h"
 #include "net/http/http_response_headers.h"
 #include "net/http/http_response_info.h"
 
 namespace content {
 
 using StatusCallback = ServiceWorkerVersion::StatusCallback;
 using ServiceWorkerClients = std::vector<ServiceWorkerClientInfo>;
 using GetClientsCallback =
     base::Callback<void(scoped_ptr<ServiceWorkerClients>)>;
 
@@ skipping 681 matching lines @@
   if (running_status() != RUNNING) {
     // Schedule calling this method after starting the worker.
     StartWorker(base::Bind(&RunTaskAfterStartWorker,
                            weak_factory_.GetWeakPtr(), callback,
                            base::Bind(&self::DispatchSyncEvent,
                                       weak_factory_.GetWeakPtr(),
                                       callback)));
     return;
   }
 
-  int request_id = AddRequest(callback, &sync_callbacks_, REQUEST_SYNC);
-  ServiceWorkerStatusCode status = embedded_worker_->SendMessage(
-      ServiceWorkerMsg_SyncEvent(request_id));
-  if (status != SERVICE_WORKER_OK) {
-    sync_callbacks_.Remove(request_id);
-    RunSoon(base::Bind(callback, status));
+  // We can only get the embedded worker's process and thread ids on the IO
+  // thread, but we need to be on the UI thread to get the the mojo service
+  // registry from the RenderProcessHost.
+  BrowserThread::PostTask(
+      BrowserThread::UI, FROM_HERE,
+      base::Bind(&ServiceWorkerVersion::DispatchSyncEventOnUIThread,
+                 /* IS this the right one? */ base::Unretained(this),

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

No, this is not safe. base::Unretained should rarely be used. See
https://www.chromium.org/developers/design-documents/threading for more
information. 

If you use the class I suggested in a comment in the header file, you'll be
calling that and since it's RefCountedThreadSafe it'll work fine. The function
you call will want a callback for when the event finishes. You can give that
callback a 'this' pointer since it's RefCounted and will be run on the IO
thread.

+                 embedded_worker_->process_id(), embedded_worker_->thread_id(),
+                 callback));
+}
+
+void ServiceWorkerVersion::DispatchSyncEventOnUIThread(
+    int render_process_id,
+    int thread_id,
+    const StatusCallback& callback) {
+  DCHECK_CURRENTLY_ON(BrowserThread::UI);
+  // TODO(iclelland): Replace this with the real event registration details
+  content::SyncRegistrationPtr TEMP_null_event(
+      content::SyncRegistration::New());
+
+  RenderProcessHost* host = RenderProcessHost::FromID(render_process_id);
+  content::ServiceRegistry* registry = host->GetServiceRegistry();
+  if (!registry)
+    return;
+
+  if (!background_sync_client_.get())
+    registry->ConnectToRemoteService(mojo::GetProxy(&background_sync_client_));
+  background_sync_client_->Sync(
+      TEMP_null_event.Pass(), thread_id,
+      base::Bind(&ServiceWorkerVersion::OnSyncEventFinished,
+                 weak_factory_.GetWeakPtr(), callback));
+}
+
+void ServiceWorkerVersion::OnSyncEventFinished(
+    const StatusCallback& callback,
+    BackgroundSyncEventStatus result) {
+  DCHECK_CURRENTLY_ON(BrowserThread::UI);
+  TRACE_EVENT0("ServiceWorker", "ServiceWorkerVersion::OnSyncEventFinished")
+  BrowserThread::PostTask(
+      BrowserThread::IO, FROM_HERE,
+      base::Bind(&ServiceWorkerVersion::FinishSyncEventOnIOThread,
+                 /* IS this the right one? */ base::Unretained(this), callback,
+                 result));
+}
+
+void ServiceWorkerVersion::FinishSyncEventOnIOThread(
+    const StatusCallback& callback,
+    BackgroundSyncEventStatus result) {
+  DCHECK_CURRENTLY_ON(BrowserThread::IO);
+  ServiceWorkerStatusCode status = SERVICE_WORKER_OK;
+  if (!base::CommandLine::ForCurrentProcess()->HasSwitch(
+          switches::kEnableServiceWorkerSync)) {
+    // Avoid potential race condition where flag is disabled after a sync event
+    // was dispatched
+    status = SERVICE_WORKER_ERROR_ABORT;
+  } else if (result == BACKGROUND_SYNC_EVENT_STATUS_REJECTED) {
+    status = SERVICE_WORKER_ERROR_EVENT_WAITUNTIL_REJECTED;
+  } else if (result == BACKGROUND_SYNC_EVENT_STATUS_ABORT) {
+    status = SERVICE_WORKER_ERROR_ABORT;
+  }
+
+  scoped_refptr<ServiceWorkerVersion> protect(this);
+  callback.Run(status);
+
+  RestartTick(&idle_time_);
+  // TODO(iclelland) factor this out of RemoveCallbackAndStopIfRedundant
+  if (is_redundant()) {
+    // The stop should be already scheduled, but try to stop immediately, in
+    // order to release worker resources soon.
+    StopWorkerIfIdle();
   }
 }
 
 void ServiceWorkerVersion::DispatchNotificationClickEvent(
     const StatusCallback& callback,
     int64_t persistent_notification_id,
     const PlatformNotificationData& notification_data) {
   DCHECK_EQ(ACTIVATED, status()) << status();
   if (running_status() != RUNNING) {
     // Schedule calling this method after starting the worker.
@@ skipping 333 matching lines @@
   // callbacks for events).
   // TODO(kinuko): Consider if we want to add queue+resend mechanism here.
   RunIDMapCallbacks(&activate_callbacks_,
                     SERVICE_WORKER_ERROR_ACTIVATE_WORKER_FAILED);
   RunIDMapCallbacks(&install_callbacks_,
                     SERVICE_WORKER_ERROR_INSTALL_WORKER_FAILED);
   RunIDMapCallbacks(&fetch_callbacks_,
                     SERVICE_WORKER_ERROR_FAILED,
                     SERVICE_WORKER_FETCH_EVENT_RESULT_FALLBACK,
                     ServiceWorkerResponse());
-  RunIDMapCallbacks(&sync_callbacks_,
-                    SERVICE_WORKER_ERROR_FAILED);
   RunIDMapCallbacks(&notification_click_callbacks_,
                     SERVICE_WORKER_ERROR_FAILED);
   RunIDMapCallbacks(&push_callbacks_,
                     SERVICE_WORKER_ERROR_FAILED);
   RunIDMapCallbacks(&geofencing_callbacks_,
                     SERVICE_WORKER_ERROR_FAILED);
   RunIDMapCallbacks(&cross_origin_connect_callbacks_,
                     SERVICE_WORKER_ERROR_FAILED,
                     false);
 
@@ skipping 36 matching lines @@
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(ServiceWorkerVersion, message)
     IPC_MESSAGE_HANDLER(ServiceWorkerHostMsg_GetClients,
                         OnGetClients)
     IPC_MESSAGE_HANDLER(ServiceWorkerHostMsg_ActivateEventFinished,
                         OnActivateEventFinished)
     IPC_MESSAGE_HANDLER(ServiceWorkerHostMsg_InstallEventFinished,
                         OnInstallEventFinished)
     IPC_MESSAGE_HANDLER(ServiceWorkerHostMsg_FetchEventFinished,
                         OnFetchEventFinished)
-    IPC_MESSAGE_HANDLER(ServiceWorkerHostMsg_SyncEventFinished,
-                        OnSyncEventFinished)
     IPC_MESSAGE_HANDLER(ServiceWorkerHostMsg_NotificationClickEventFinished,
                         OnNotificationClickEventFinished)
     IPC_MESSAGE_HANDLER(ServiceWorkerHostMsg_PushEventFinished,
                         OnPushEventFinished)
     IPC_MESSAGE_HANDLER(ServiceWorkerHostMsg_GeofencingEventFinished,
                         OnGeofencingEventFinished)
     IPC_MESSAGE_HANDLER(ServiceWorkerHostMsg_CrossOriginConnectEventFinished,
                         OnCrossOriginConnectEventFinished)
     IPC_MESSAGE_HANDLER(ServiceWorkerHostMsg_OpenWindow,
                         OnOpenWindow)
@@ skipping 151 matching lines @@
 
   // TODO(kinuko): Record other event statuses too.
   const bool handled = (result == SERVICE_WORKER_FETCH_EVENT_RESULT_RESPONSE);
   metrics_->RecordEventStatus(handled);
 
   scoped_refptr<ServiceWorkerVersion> protect(this);
   callback->Run(SERVICE_WORKER_OK, result, response);
   RemoveCallbackAndStopIfRedundant(&fetch_callbacks_, request_id);
 }
 
-void ServiceWorkerVersion::OnSyncEventFinished(
-    int request_id,
-    blink::WebServiceWorkerEventResult result) {
-  TRACE_EVENT1("ServiceWorker",
-               "ServiceWorkerVersion::OnSyncEventFinished",
-               "Request id", request_id);
-  StatusCallback* callback = sync_callbacks_.Lookup(request_id);
-  if (!callback) {
-    NOTREACHED() << "Got unexpected message: " << request_id;
-    return;
-  }
-
-  ServiceWorkerStatusCode status = SERVICE_WORKER_OK;
-  if (!base::CommandLine::ForCurrentProcess()->HasSwitch(
-          switches::kEnableServiceWorkerSync)) {
-    // Avoid potential race condition where flag is disabled after a sync event
-    // was dispatched
-    status = SERVICE_WORKER_ERROR_ABORT;
-  } else if (result == blink::WebServiceWorkerEventResultRejected) {
-    status = SERVICE_WORKER_ERROR_EVENT_WAITUNTIL_REJECTED;
-  }
-
-  scoped_refptr<ServiceWorkerVersion> protect(this);
-  callback->Run(status);
-  RemoveCallbackAndStopIfRedundant(&sync_callbacks_, request_id);
-}
-
 void ServiceWorkerVersion::OnNotificationClickEventFinished(
     int request_id) {
   TRACE_EVENT1("ServiceWorker",
                "ServiceWorkerVersion::OnNotificationClickEventFinished",
                "Request id", request_id);
   StatusCallback* callback = notification_click_callbacks_.Lookup(request_id);
   if (!callback) {
     NOTREACHED() << "Got unexpected message: " << request_id;
     return;
   }
@@ skipping 524 matching lines @@
   // forcibly fail pending callbacks so no one is stuck waiting
   // for the worker.
   embedded_worker_->StopIfIdle();
 }
 
 bool ServiceWorkerVersion::HasInflightRequests() const {
   return
     !activate_callbacks_.IsEmpty() ||
     !install_callbacks_.IsEmpty() ||
     !fetch_callbacks_.IsEmpty() ||
-    !sync_callbacks_.IsEmpty() ||
     !notification_click_callbacks_.IsEmpty() ||
     !push_callbacks_.IsEmpty() ||
     !geofencing_callbacks_.IsEmpty() ||
     !cross_origin_connect_callbacks_.IsEmpty() ||
     !streaming_url_request_jobs_.empty();
 }
 
 void ServiceWorkerVersion::RecordStartWorkerResult(
     ServiceWorkerStatusCode status) {
   base::TimeTicks start_time = start_time_;
@@ skipping 60 matching lines @@
       return RunIDMapCallback(&activate_callbacks_, info.id,
                               SERVICE_WORKER_ERROR_TIMEOUT);
     case REQUEST_INSTALL:
       return RunIDMapCallback(&install_callbacks_, info.id,
                               SERVICE_WORKER_ERROR_TIMEOUT);
     case REQUEST_FETCH:
       return RunIDMapCallback(
           &fetch_callbacks_, info.id, SERVICE_WORKER_ERROR_TIMEOUT,
           /* The other args are ignored for non-OK status. */
           SERVICE_WORKER_FETCH_EVENT_RESULT_FALLBACK, ServiceWorkerResponse());
-    case REQUEST_SYNC:
-      return RunIDMapCallback(&sync_callbacks_, info.id,
-                              SERVICE_WORKER_ERROR_TIMEOUT);
     case REQUEST_NOTIFICATION_CLICK:
       return RunIDMapCallback(&notification_click_callbacks_, info.id,
                               SERVICE_WORKER_ERROR_TIMEOUT);
     case REQUEST_PUSH:
       return RunIDMapCallback(&push_callbacks_, info.id,
                               SERVICE_WORKER_ERROR_TIMEOUT);
     case REQUEST_GEOFENCING:
       return RunIDMapCallback(&geofencing_callbacks_, info.id,
                               SERVICE_WORKER_ERROR_TIMEOUT);
     case REQUEST_CROSS_ORIGIN_CONNECT:
@@ skipping 35 matching lines @@
         return SERVICE_WORKER_ERROR_ABORT;
       default:
         return SERVICE_WORKER_ERROR_NETWORK;
     }
   }
 
   return default_code;
 }
 
 }  // namespace content