BackgroundSyncManager tracks client registrations

content/browser/background_sync/background_sync_service_impl.cc

 // Copyright 2015 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/background_sync/background_sync_service_impl.h"
 
 #include "base/memory/weak_ptr.h"
+#include "base/stl_util.h"
 #include "content/browser/background_sync/background_sync_context_impl.h"
-#include "content/browser/background_sync/background_sync_registration.h"
+#include "content/browser/background_sync/client_background_sync_registration.h"
 #include "content/public/browser/browser_thread.h"
 
 namespace content {
 
 namespace {
 
 // TODO(iclelland): Move these converters to mojo::TypeConverter template
 // specializations.
 
 BackgroundSyncRegistrationOptions ToBackgroundSyncRegistrationOptions(
@@ skipping 61 matching lines @@
 
 COMPILE_ASSERT_MATCHING_ENUM(BACKGROUND_SYNC_PERIODICITY_PERIODIC,
                              SyncPeriodicity::SYNC_PERIODIC);
 COMPILE_ASSERT_MATCHING_ENUM(BACKGROUND_SYNC_PERIODICITY_ONE_SHOT,
                              SyncPeriodicity::SYNC_ONE_SHOT);
 COMPILE_ASSERT_MATCHING_ENUM(BACKGROUND_SYNC_PERIODICITY_MAX,
                              SyncPeriodicity::SYNC_ONE_SHOT);
 
 BackgroundSyncServiceImpl::~BackgroundSyncServiceImpl() {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
+  BackgroundSyncManager* background_sync_manager =
+      background_sync_context_->background_sync_manager();
+  DCHECK(background_sync_manager);
 }
 
 BackgroundSyncServiceImpl::BackgroundSyncServiceImpl(
     BackgroundSyncContextImpl* background_sync_context,
     mojo::InterfaceRequest<BackgroundSyncService> request)
     : background_sync_context_(background_sync_context),
       binding_(this, request.Pass()),
       weak_ptr_factory_(this) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   DCHECK(background_sync_context);
@@ skipping 21 matching lines @@
   DCHECK(background_sync_manager);
   background_sync_manager->Register(
       sw_registration_id, mgr_options,
       base::Bind(&BackgroundSyncServiceImpl::OnRegisterResult,
                  weak_ptr_factory_.GetWeakPtr(), callback));
 }
 
 void BackgroundSyncServiceImpl::Unregister(
     BackgroundSyncPeriodicity periodicity,
     int64_t id,
-    const mojo::String& tag,
     int64_t sw_registration_id,
     const UnregisterCallback& callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   BackgroundSyncManager* background_sync_manager =
       background_sync_context_->background_sync_manager();
   DCHECK(background_sync_manager);
-  background_sync_manager->Unregister(
-      sw_registration_id, tag, content::SYNC_ONE_SHOT, id,
+
+  ClientBackgroundSyncRegistration* registration =
+      hosted_registrations_.Lookup(id);
+  if (!registration) {
+    callback.Run(BACKGROUND_SYNC_ERROR_NOT_ALLOWED);
+    return;
+  }
+
+  registration->Unregister(
+      sw_registration_id,
       base::Bind(&BackgroundSyncServiceImpl::OnUnregisterResult,
                  weak_ptr_factory_.GetWeakPtr(), callback));
 }
 
 void BackgroundSyncServiceImpl::GetRegistration(
     BackgroundSyncPeriodicity periodicity,
     const mojo::String& tag,
     int64_t sw_registration_id,
     const GetRegistrationCallback& callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
@@ skipping 25 matching lines @@
     int64_t sw_registration_id,
     const GetPermissionStatusCallback& callback) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 
   // TODO(iclelland): Implement a real policy. This is a stub implementation.
   // OneShot: crbug.com/482091
   // Periodic: crbug.com/482093
   callback.Run(BACKGROUND_SYNC_ERROR_NONE, PERMISSION_STATUS_GRANTED);
 }
 
+void BackgroundSyncServiceImpl::TrackRegistration(
+    SyncRegistrationPtr sync_registration) {
+  // Registrations that the client acquires without the
+  // BackgroundSyncServiceImpl's knowing are registered here.
+  BackgroundSyncManager* background_sync_manager =
+      background_sync_context_->background_sync_manager();
+  DCHECK(background_sync_manager);
+
+  if (hosted_registrations_.Lookup(sync_registration->id)) {
+    // TODO(jkarlin): Abort client.
+    LOG(WARNING) << "Client attempted to track an already tracked registration";
+    return;
+  }
+
+  BackgroundSyncRegistrationOptions options =
+      ToBackgroundSyncRegistrationOptions(sync_registration);
+
+  scoped_ptr<ClientBackgroundSyncRegistration> registration(
+      new ClientBackgroundSyncRegistration(background_sync_manager));
+  *registration->options() = options;
+  registration->set_id(sync_registration->id);
+
+  if (!registration->IsValid()) {
+    // TODO(jkarlin): Abort client.
+    LOG(WARNING) << "Client attempted to track a non-existant registration";
+    return;
+  }
+
+  hosted_registrations_.AddWithID(registration.release(),
+                                  sync_registration->id);
+}
+
+void BackgroundSyncServiceImpl::ReleaseRegistration(int64_t sync_id) {
+  if (!hosted_registrations_.Lookup(sync_id)) {
+    // TODO(jkarlin): Abort client.
+    LOG(WARNING) << "Client attempted to release non-existing registration";
+    return;
+  }
+
+  hosted_registrations_.Remove(sync_id);
+}
+
 void BackgroundSyncServiceImpl::OnRegisterResult(
     const RegisterCallback& callback,
     BackgroundSyncStatus status,
-    const BackgroundSyncRegistration& result) {
+    scoped_ptr<ClientBackgroundSyncRegistration> result) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
-  SyncRegistrationPtr mojoResult = ToMojoRegistration(result);
+  ClientBackgroundSyncRegistration* result_ptr = result.get();
+
+  if (status != BACKGROUND_SYNC_STATUS_OK) {
+    callback.Run(static_cast<content::BackgroundSyncError>(status),
+                 SyncRegistrationPtr(content::SyncRegistration::New()));
+    return;
+  }
+
+  hosted_registrations_.AddWithID(result.release(), result_ptr->id());
+  SyncRegistrationPtr mojoResult = ToMojoRegistration(*result_ptr);
   callback.Run(static_cast<content::BackgroundSyncError>(status),
                mojoResult.Pass());
 }
 
 void BackgroundSyncServiceImpl::OnUnregisterResult(
     const UnregisterCallback& callback,
     BackgroundSyncStatus status) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   callback.Run(static_cast<content::BackgroundSyncError>(status));
 }
 
 void BackgroundSyncServiceImpl::OnGetRegistrationsResult(
     const GetRegistrationsCallback& callback,
     BackgroundSyncStatus status,
-    const std::vector<BackgroundSyncRegistration>& result_registrations) {
+    scoped_ptr<ScopedVector<ClientBackgroundSyncRegistration>>
+        result_registrations) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   mojo::Array<content::SyncRegistrationPtr> mojo_registrations(0);
-  for (const auto& registration : result_registrations)
-    mojo_registrations.push_back(ToMojoRegistration(registration));
+  for (ClientBackgroundSyncRegistration* registration : *result_registrations) {
+    hosted_registrations_.AddWithID(registration, registration->id());

[michaeln, 2015/08/19 01:56:01]

Does this leak (for the lifetime of the renderer process) if script logic
running on a renderer's worker thread does call
WebSomething->releaseRegistration?

[jkarlin, 2015/08/19 12:47:06]

Yes. See https://codereview.chromium.org/1299903002/ for how the render process
calls releaseRegistration when SyncRegistration and PeriodicSyncRegistration
objects are collected.

+    mojo_registrations.push_back(ToMojoRegistration(*registration));
+  }
+
+  result_registrations->weak_clear();
+
   callback.Run(static_cast<content::BackgroundSyncError>(status),
                mojo_registrations.Pass());
 }
 
 }  // namespace content