Attachment 8763788 Details for Bug 1217544

[patch] Part 2: ServiceWorkerRegistration

bug1217544.background.sync.part2.serviceworkerregistration.patch (text/plain), 12.59 KB, created by Fernando Jiménez Moreno [:ferjm]

(hide)

Description:

Filename:

MIME Type:

Creator: Fernando Jiménez Moreno [:ferjm]

Size: 12.59 KB

patch

obsolete

># HG changeset patch
># User Fernando Jimenez <ferjmoreno@gmail.com>
># Parent  33b4f9fbf29870ee17d443117d8d67b5e374a4c3
>Bug 1217544 - Implement one-off BackgroundSync API. Part 2: ServiceWorkerRegistration. r=baku
>
>diff --git a/dom/backgroundsync/BackgroundSync.cpp b/dom/backgroundsync/BackgroundSync.cpp
>--- a/dom/backgroundsync/BackgroundSync.cpp
>+++ b/dom/backgroundsync/BackgroundSync.cpp
>@@ -46,24 +46,25 @@ BackgroundSync::CreateOnMainThread(nsIGl
>   }
> 
>   RefPtr<BackgroundSync> ref = new BackgroundSync(aGlobal, principalInfo);
>   return ref.forget();
> }
> 
> // static
> already_AddRefed<BackgroundSync>
>-BackgroundSync::CreateOnWorker(WorkerPrivate* aWorkerPrivate)
>+BackgroundSync::CreateOnWorker(nsIGlobalObject* aGlobal,
>+                               WorkerPrivate* aWorkerPrivate)
> {
>   MOZ_ASSERT(aWorkerPrivate);
>   aWorkerPrivate->AssertIsOnWorkerThread();
> 
>   const PrincipalInfo& principalInfo = aWorkerPrivate->GetPrincipalInfo();
> 
>-  RefPtr<BackgroundSync> ref = new BackgroundSync(nullptr,
>+  RefPtr<BackgroundSync> ref = new BackgroundSync(aGlobal,
>                                                   principalInfo);
>   return ref.forget();
> }
> 
> BackgroundSync::BackgroundSync(nsIGlobalObject* aGlobal,
>                                const PrincipalInfo& aPrincipalInfo)
>   : mGlobal(aGlobal)
>   , mPrincipalInfo(new PrincipalInfo(aPrincipalInfo))
>@@ -84,17 +85,17 @@ BackgroundSync::WrapObject(JSContext* aC
> bool
> BackgroundSync::PrefEnabled(JSContext* aCx, JSObject* aObj)
> {
>   using mozilla::dom::workers::WorkerPrivate;
>   using mozilla::dom::workers::GetWorkerPrivateFromContext;
> 
>   // If we are on the main thread, then check the pref directly.
>   if (NS_IsMainThread()) {
>-    return Preferences::GetBool("dom.background.sync.enabled", false);
>+    return Preferences::GetBool("dom.backgroundSync.enabled", false);
>   }
> 
>   // Otherwise check the pref via the worker private helper.
>   WorkerPrivate* workerPrivate = GetWorkerPrivateFromContext(aCx);
>   if (!workerPrivate) {
>     return false;
>   }
> 
>diff --git a/dom/backgroundsync/BackgroundSync.h b/dom/backgroundsync/BackgroundSync.h
>--- a/dom/backgroundsync/BackgroundSync.h
>+++ b/dom/backgroundsync/BackgroundSync.h
>@@ -41,17 +41,18 @@ public:
>   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(BackgroundSync)
> 
>   static already_AddRefed<BackgroundSync>
>   CreateOnMainThread(nsIGlobalObject* aGlobal,
>                      nsIPrincipal* aPrincipal,
>                      ErrorResult& aRv);
> 
>   static already_AddRefed<BackgroundSync>
>-  CreateOnWorker(workers::WorkerPrivate* aWorkerPrivate);
>+  CreateOnWorker(nsIGlobalObject* aGlobal,
>+                 workers::WorkerPrivate* aWorkerPrivate);
> 
>   // Binding methods.
> 
>   nsIGlobalObject*
>   GetParentObject() const
>   {
>     return mGlobal;
>   }
>diff --git a/dom/webidl/ServiceWorkerRegistration.webidl b/dom/webidl/ServiceWorkerRegistration.webidl
>--- a/dom/webidl/ServiceWorkerRegistration.webidl
>+++ b/dom/webidl/ServiceWorkerRegistration.webidl
>@@ -27,9 +27,12 @@ interface ServiceWorkerRegistration : Ev
>   attribute EventHandler onupdatefound;
> };
> 
> partial interface ServiceWorkerRegistration {
> #ifndef MOZ_SIMPLEPUSH
>   [Throws, Exposed=(Window,Worker), Func="nsContentUtils::PushEnabled"]
>   readonly attribute PushManager pushManager;
> #endif
>+  [Throws, Exposed=(Window,Worker),
>+   Func="backgroundsync::BackgroundSync::PrefEnabled"]
>+  readonly attribute BackgroundSync sync;
> };
>diff --git a/dom/workers/ServiceWorkerRegistration.cpp b/dom/workers/ServiceWorkerRegistration.cpp
>--- a/dom/workers/ServiceWorkerRegistration.cpp
>+++ b/dom/workers/ServiceWorkerRegistration.cpp
>@@ -28,17 +28,21 @@
> #include "Workers.h"
> #include "WorkerScope.h"
> 
> #ifndef MOZ_SIMPLEPUSH
> #include "mozilla/dom/PushManagerBinding.h"
> #include "mozilla/dom/PushManager.h"
> #endif
> 
>+#include "mozilla/dom/BackgroundSyncBinding.h"
>+#include "mozilla/dom/backgroundsync/BackgroundSync.h"
>+
> using namespace mozilla::dom::workers;
>+using namespace mozilla::dom::backgroundsync;
> 
> namespace mozilla {
> namespace dom {
> 
> bool
> ServiceWorkerRegistrationVisible(JSContext* aCx, JSObject* aObj)
> {
>   if (NS_IsMainThread()) {
>@@ -87,20 +91,21 @@ ServiceWorkerRegistrationBase::ServiceWo
> NS_IMPL_ADDREF_INHERITED(ServiceWorkerRegistrationMainThread, ServiceWorkerRegistrationBase)
> NS_IMPL_RELEASE_INHERITED(ServiceWorkerRegistrationMainThread, ServiceWorkerRegistrationBase)
> 
> NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION_INHERITED(ServiceWorkerRegistrationMainThread)
> NS_INTERFACE_MAP_END_INHERITING(ServiceWorkerRegistrationBase)
> 
> #ifndef MOZ_SIMPLEPUSH
> NS_IMPL_CYCLE_COLLECTION_INHERITED(ServiceWorkerRegistrationMainThread, ServiceWorkerRegistrationBase,
>-                                   mPushManager,
>+                                   mPushManager, mBackgroundSync,
>                                    mInstallingWorker, mWaitingWorker, mActiveWorker);
> #else
> NS_IMPL_CYCLE_COLLECTION_INHERITED(ServiceWorkerRegistrationMainThread, ServiceWorkerRegistrationBase,
>+                                   mBackgroundSync,
>                                    mInstallingWorker, mWaitingWorker, mActiveWorker);
> #endif
> 
> ServiceWorkerRegistrationMainThread::ServiceWorkerRegistrationMainThread(nsPIDOMWindowInner* aWindow,
>                                                                          const nsAString& aScope)
>   : ServiceWorkerRegistrationBase(aWindow, aScope)
>   , mListeningForEvents(false)
> {
>@@ -777,16 +782,48 @@ ServiceWorkerRegistrationMainThread::Get
>   }
> 
>   RefPtr<PushManager> ret = mPushManager;
>   return ret.forget();
> 
> #endif /* ! MOZ_SIMPLEPUSH */
> }
> 
>+BackgroundSync*
>+ServiceWorkerRegistrationMainThread::GetSync(ErrorResult& aRv)
>+{
>+  AssertIsOnMainThread();
>+
>+  if (!mBackgroundSync) {
>+    nsCOMPtr<nsIGlobalObject> globalObject = do_QueryInterface(GetOwner());
>+
>+    if (!globalObject) {
>+      aRv.Throw(NS_ERROR_FAILURE);
>+      return nullptr;
>+    }
>+
>+    nsCOMPtr<nsIDocument> document = GetOwner()->GetExtantDoc();
>+    if (!document) {
>+      aRv.Throw(NS_ERROR_FAILURE);
>+      return nullptr;
>+    }
>+
>+    nsCOMPtr<nsIPrincipal> principal = document->NodePrincipal();
>+    if (!principal) {
>+      aRv.Throw(NS_ERROR_FAILURE);
>+      return nullptr;
>+    }
>+
>+    mBackgroundSync = BackgroundSync::CreateOnMainThread(globalObject, principal,
>+                                                         aRv);
>+  }
>+
>+  return mBackgroundSync;
>+}
>+
> ////////////////////////////////////////////////////
> // Worker Thread implementation
> class WorkerListener final : public ServiceWorkerRegistrationListener
> {
>   // Accessed on the main thread.
>   WorkerPrivate* mWorkerPrivate;
>   nsString mScope;
>   bool mListeningForEvents;
>@@ -901,23 +938,25 @@ NS_INTERFACE_MAP_END_INHERITING(ServiceW
> // Expanded macros since we need special behaviour to release the proxy.
> NS_IMPL_CYCLE_COLLECTION_CLASS(ServiceWorkerRegistrationWorkerThread)
> 
> NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED(ServiceWorkerRegistrationWorkerThread,
>                                                   ServiceWorkerRegistrationBase)
> #ifndef MOZ_SIMPLEPUSH
>   NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mPushManager)
> #endif
>+  NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mBackgroundSync)
> NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
> 
> NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN_INHERITED(ServiceWorkerRegistrationWorkerThread,
>                                                 ServiceWorkerRegistrationBase)
> #ifndef MOZ_SIMPLEPUSH
>   NS_IMPL_CYCLE_COLLECTION_UNLINK(mPushManager)
> #endif
>+  NS_IMPL_CYCLE_COLLECTION_UNLINK(mBackgroundSync)
>   tmp->ReleaseListener(RegistrationIsGoingAway);
> NS_IMPL_CYCLE_COLLECTION_UNLINK_END
> 
> ServiceWorkerRegistrationWorkerThread::ServiceWorkerRegistrationWorkerThread(WorkerPrivate* aWorkerPrivate,
>                                                                              const nsAString& aScope)
>   : ServiceWorkerRegistrationBase(nullptr, aScope)
>   , mWorkerPrivate(aWorkerPrivate)
> {
>@@ -1216,10 +1255,21 @@ ServiceWorkerRegistrationWorkerThread::G
>   }
> 
>   RefPtr<PushManager> ret = mPushManager;
>   return ret.forget();
> 
> #endif /* ! MOZ_SIMPLEPUSH */
> }
> 
>+BackgroundSync*
>+ServiceWorkerRegistrationWorkerThread::GetSync(ErrorResult& aRv)
>+{
>+  if (!mBackgroundSync) {
>+    mBackgroundSync = BackgroundSync::CreateOnWorker(
>+        mWorkerPrivate->GlobalScope(), mWorkerPrivate);
>+  }
>+
>+  return mBackgroundSync;
>+}
>+
> } // dom namespace
> } // mozilla namespace
>diff --git a/dom/workers/ServiceWorkerRegistration.h b/dom/workers/ServiceWorkerRegistration.h
>--- a/dom/workers/ServiceWorkerRegistration.h
>+++ b/dom/workers/ServiceWorkerRegistration.h
>@@ -24,16 +24,20 @@ class Promise;
> class PushManager;
> class WorkerListener;
> 
> namespace workers {
> class ServiceWorker;
> class WorkerPrivate;
> } // namespace workers
> 
>+namespace backgroundsync {
>+class BackgroundSync;
>+} // namespace backgroundsync
>+
> bool
> ServiceWorkerRegistrationVisible(JSContext* aCx, JSObject* aObj);
> 
> bool
> ServiceWorkerNotificationAPIVisible(JSContext* aCx, JSObject* aObj);
> 
> // Used by ServiceWorkerManager to notify ServiceWorkerRegistrations of
> // updatefound event and invalidating ServiceWorker instances.
>@@ -120,16 +124,19 @@ public:
>   GetWaiting() override;
> 
>   already_AddRefed<workers::ServiceWorker>
>   GetActive() override;
> 
>   already_AddRefed<PushManager>
>   GetPushManager(JSContext* aCx, ErrorResult& aRv);
> 
>+  backgroundsync::BackgroundSync*
>+  GetSync(ErrorResult& aRv);
>+
>   // DOMEventTargethelper
>   void DisconnectFromOwner() override
>   {
>     StopListeningForEvents();
>     ServiceWorkerRegistrationBase::DisconnectFromOwner();
>   }
> 
>   // ServiceWorkerRegistrationListener
>@@ -170,16 +177,18 @@ private:
>   // These three may change to a new worker at any time.
>   RefPtr<workers::ServiceWorker> mInstallingWorker;
>   RefPtr<workers::ServiceWorker> mWaitingWorker;
>   RefPtr<workers::ServiceWorker> mActiveWorker;
> 
> #ifndef MOZ_SIMPLEPUSH
>   RefPtr<PushManager> mPushManager;
> #endif
>+
>+  RefPtr<backgroundsync::BackgroundSync> mBackgroundSync;
> };
> 
> class ServiceWorkerRegistrationWorkerThread final : public ServiceWorkerRegistrationBase
>                                                   , public workers::WorkerFeature
> {
> public:
>   NS_DECL_ISUPPORTS_INHERITED
>   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(ServiceWorkerRegistrationWorkerThread,
>@@ -223,16 +232,19 @@ public:
>   }
> 
>   bool
>   Notify(workers::Status aStatus) override;
> 
>   already_AddRefed<PushManager>
>   GetPushManager(ErrorResult& aRv);
> 
>+  backgroundsync::BackgroundSync*
>+  GetSync(ErrorResult& aRv);
>+
> private:
>   enum Reason
>   {
>     RegistrationIsGoingAway = 0,
>     WorkerIsGoingAway,
>   };
> 
>   ~ServiceWorkerRegistrationWorkerThread();
>@@ -244,14 +256,16 @@ private:
>   ReleaseListener(Reason aReason);
> 
>   workers::WorkerPrivate* mWorkerPrivate;
>   RefPtr<WorkerListener> mListener;
> 
> #ifndef MOZ_SIMPLEPUSH
>   RefPtr<PushManager> mPushManager;
> #endif
>+
>+  RefPtr<backgroundsync::BackgroundSync> mBackgroundSync;
> };
> 
> } // namespace dom
> } // namespace mozilla
> 
> #endif /* mozilla_dom_ServiceWorkerRegistration_h */
>diff --git a/dom/workers/WorkerPrefs.h b/dom/workers/WorkerPrefs.h
>--- a/dom/workers/WorkerPrefs.h
>+++ b/dom/workers/WorkerPrefs.h
>@@ -28,17 +28,17 @@ WORKER_SIMPLE_PREF("dom.caches.enabled",
> WORKER_SIMPLE_PREF("dom.caches.testing.enabled", DOMCachesTestingEnabled, DOM_CACHES_TESTING)
> WORKER_SIMPLE_PREF("dom.performance.enable_user_timing_logging", PerformanceLoggingEnabled, PERFORMANCE_LOGGING_ENABLED)
> WORKER_SIMPLE_PREF("dom.webnotifications.enabled", DOMWorkerNotificationEnabled, DOM_WORKERNOTIFICATION)
> WORKER_SIMPLE_PREF("dom.webnotifications.serviceworker.enabled", DOMServiceWorkerNotificationEnabled, DOM_SERVICEWORKERNOTIFICATION)
> WORKER_SIMPLE_PREF("dom.serviceWorkers.enabled", ServiceWorkersEnabled, SERVICEWORKERS_ENABLED)
> WORKER_SIMPLE_PREF("dom.serviceWorkers.testing.enabled", ServiceWorkersTestingEnabled, SERVICEWORKERS_TESTING_ENABLED)
> WORKER_SIMPLE_PREF("dom.serviceWorkers.openWindow.enabled", OpenWindowEnabled, OPEN_WINDOW_ENABLED)
> WORKER_SIMPLE_PREF("dom.push.enabled", PushEnabled, PUSH_ENABLED)
>-WORKER_SIMPLE_PREF("dom.background.sync.enabled", BackgroundSyncEnabled, BACKGROUND_SYNC_ENABLED)
>+WORKER_SIMPLE_PREF("dom.backgroundSync.enabled", BackgroundSyncEnabled, BACKGROUND_SYNC_ENABLED)
> WORKER_SIMPLE_PREF("dom.requestcontext.enabled", RequestContextEnabled, REQUESTCONTEXT_ENABLED)
> WORKER_SIMPLE_PREF("gfx.offscreencanvas.enabled", OffscreenCanvasEnabled, OFFSCREENCANVAS_ENABLED)
> WORKER_PREF("dom.workers.latestJSVersion", JSVersionChanged)
> WORKER_PREF("intl.accept_languages", PrefLanguagesChanged)
> WORKER_PREF("general.appname.override", AppNameOverrideChanged)
> WORKER_PREF("general.appversion.override", AppVersionOverrideChanged)
> WORKER_PREF("general.platform.override", PlatformOverrideChanged)
> #ifdef JS_GC_ZEAL

Flags:

ferjm: review+

Actions: View | Diff | Review

Attachments on bug 1217544: 8705632 | 8705633 | 8705634 | 8707035 | 8712697 | 8712699 | 8712744 | 8712745 | 8712746 | 8721385 | 8721387 | 8721388 | 8721389 | 8721408 | 8727182 | 8731368 | 8731371 | 8731374 | 8731377 | 8733495 | 8733497 | 8736435 | 8736438 | 8743357 | 8743359 | 8743360 | 8743362 | 8743363 | 8743364 | 8743365 | 8743366 | 8759773 | 8763785 | 8763788 | 8763790 | 8763791 | 8763794 | 8763795 | 8763796 | 8763797 | 8763799 | 8777369 | 8777370 | 8777373 | 8777386 | 8777388 | 8777390 | 8777844 | 8788555 | 8788558 | 8788560 | 8788562 | 8788567 | 8788569 | 8788571 | 8788574 | 8788575 | 8788576 | 8832151 | 8832152 | 8832153 | 8832154 | 8832155 | 8832156 | 8832157 | 8832158 | 8832159 | 8832167 | 8832450 | 8866279 | 8866280 | 9053609