45eb7e06ce
This commit exposes the Permissions API to DOM Workers. It achieves this goal by introducing a thread-safe bridge between `PermissionStatus` and the `PermissionObserver`: the `PermissionStatusSink` object. Actors: - The `PermissionObserver` is a main-thread-only singleton that monitors permission change events and propagates the notification to the right sink objects. - The `PermissionStatus` is the DOM object exposed to the global. It's not thread-safe. - The `PermissionStatusSink` is the new bridge introduced by this commit. The `PermissionStatusSink` lifetime: - This object is kept alive on the current thread by the `PermissionStatus` and on the main thread by the `PermissionObserver`. - The `PermissionStatus` creates the object on its creation thread. When `PermissionStatus` object is released (or disconnected from the owner, it disentangles itself from the `PermissionStatusSink`. The disentangle operation triggers the un-registration procedure from the `PermissionObserver` on the main thread. - A weak `WorkerRef` is used to monitor the worker's lifetime. Permission change notification: - When the `PermissionObserver` is notified for a permission-change event, it notifies all the `PermissionStatusSink`. This happens on the main thread (see `MaybeUpdatedByOnMainThread` and `MaybeUpdatedByNotifyOnlyOnMainThread`). - Using `MozPromise`, the `PermissionStatusSink` computes the permission action (`PermissionChangedOnMainThread`) on the main thread, then informs the parent `PermissionStatus` object on its creation thread. - The `PermissionStatus` object converts the action to the DOM `PermissionState` and dispatches an event. Differential Revision: https://phabricator.services.mozilla.com/D224594
82 lines
2.7 KiB
C++
82 lines
2.7 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
* You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef mozilla_dom_PermissionStatusSink_h
|
|
#define mozilla_dom_PermissionStatusSink_h
|
|
|
|
#include "mozilla/dom/PermissionsBinding.h"
|
|
#include "mozilla/dom/PermissionStatusBinding.h"
|
|
#include "mozilla/MozPromise.h"
|
|
#include "mozilla/Mutex.h"
|
|
#include "nsIPermission.h"
|
|
|
|
class nsPIDOMWindowInner;
|
|
|
|
namespace mozilla::dom {
|
|
|
|
class PermissionObserver;
|
|
class PermissionStatus;
|
|
class WeakWorkerRef;
|
|
|
|
class PermissionStatusSink {
|
|
public:
|
|
using PermissionStatePromise = MozPromise<uint32_t, nsresult, true>;
|
|
|
|
NS_INLINE_DECL_THREADSAFE_REFCOUNTING(PermissionStatusSink)
|
|
|
|
PermissionStatusSink(PermissionStatus* aPermissionStatus,
|
|
PermissionName aPermissionName,
|
|
const nsACString& aPermissionType);
|
|
|
|
RefPtr<PermissionStatePromise> Init();
|
|
|
|
// These functions should be called when an permission is updated which may
|
|
// change the state of this PermissionStatus. MaybeUpdatedByOnMainThread
|
|
// accepts the permission object itself that is update. When the permission's
|
|
// key is not same-origin with this object's owner window/worker, such as for
|
|
// secondary-keyed permissions like `3rdPartyFrameStorage^...`,
|
|
// MaybeUpdatedByNotifyOnlyOnMainThread will be called with the updated
|
|
// window/worker as an argument. MaybeUpdatedByNotifyOnly must be defined by
|
|
// PermissionStatus inheritors that are double-keyed.
|
|
virtual bool MaybeUpdatedByOnMainThread(nsIPermission* aPermission);
|
|
virtual bool MaybeUpdatedByNotifyOnlyOnMainThread(
|
|
nsPIDOMWindowInner* aInnerWindow);
|
|
|
|
void PermissionChangedOnMainThread();
|
|
|
|
PermissionName Name() const { return mPermissionName; }
|
|
|
|
void Disentangle();
|
|
|
|
protected:
|
|
virtual ~PermissionStatusSink();
|
|
|
|
virtual RefPtr<PermissionStatePromise> ComputeStateOnMainThread();
|
|
|
|
RefPtr<PermissionStatePromise> ComputeStateOnMainThreadInternal(
|
|
nsPIDOMWindowInner* aWindow);
|
|
|
|
nsCOMPtr<nsISerialEventTarget> mSerialEventTarget;
|
|
nsCOMPtr<nsIPrincipal> mPrincipalForPermission;
|
|
|
|
RefPtr<PermissionObserver> mObserver;
|
|
|
|
RefPtr<PermissionStatus> mPermissionStatus;
|
|
|
|
Mutex mMutex;
|
|
|
|
// Protected by mutex.
|
|
// Created and released on worker-thread. Used also on main-thread.
|
|
RefPtr<WeakWorkerRef> mWorkerRef MOZ_GUARDED_BY(mMutex);
|
|
|
|
PermissionName mPermissionName;
|
|
nsCString mPermissionType;
|
|
};
|
|
|
|
} // namespace mozilla::dom
|
|
|
|
#endif // mozilla_dom_permissionstatusSink_h
|