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
109 lines
3.3 KiB
C++
109 lines
3.3 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/. */
|
|
|
|
#include "mozilla/dom/PermissionStatus.h"
|
|
|
|
#include "mozilla/AsyncEventDispatcher.h"
|
|
#include "mozilla/Permission.h"
|
|
#include "mozilla/Services.h"
|
|
#include "nsIPermissionManager.h"
|
|
#include "PermissionUtils.h"
|
|
#include "PermissionStatusSink.h"
|
|
#include "nsGlobalWindowInner.h"
|
|
|
|
namespace mozilla::dom {
|
|
|
|
PermissionStatus::PermissionStatus(nsIGlobalObject* aGlobal,
|
|
PermissionName aName)
|
|
: DOMEventTargetHelper(aGlobal),
|
|
mName(aName),
|
|
mState(PermissionState::Denied) {
|
|
KeepAliveIfHasListenersFor(nsGkAtoms::onchange);
|
|
}
|
|
|
|
// https://w3c.github.io/permissions/#onchange-attribute and
|
|
// https://w3c.github.io/permissions/#query-method
|
|
RefPtr<PermissionStatus::SimplePromise> PermissionStatus::Init() {
|
|
mSink = CreateSink();
|
|
MOZ_ASSERT(mSink);
|
|
|
|
return mSink->Init()->Then(
|
|
GetCurrentSerialEventTarget(), __func__,
|
|
[self = RefPtr(this)](const PermissionStatusSink::PermissionStatePromise::
|
|
ResolveOrRejectValue& aResult) {
|
|
if (aResult.IsResolve()) {
|
|
self->mState = self->ComputeStateFromAction(aResult.ResolveValue());
|
|
return SimplePromise::CreateAndResolve(NS_OK, __func__);
|
|
}
|
|
|
|
return SimplePromise::CreateAndReject(aResult.RejectValue(), __func__);
|
|
});
|
|
}
|
|
|
|
PermissionStatus::~PermissionStatus() {
|
|
if (mSink) {
|
|
mSink->Disentangle();
|
|
mSink = nullptr;
|
|
}
|
|
}
|
|
|
|
JSObject* PermissionStatus::WrapObject(JSContext* aCx,
|
|
JS::Handle<JSObject*> aGivenProto) {
|
|
return PermissionStatus_Binding::Wrap(aCx, this, aGivenProto);
|
|
}
|
|
|
|
nsLiteralCString PermissionStatus::GetPermissionType() const {
|
|
return PermissionNameToType(mName);
|
|
}
|
|
|
|
// https://w3c.github.io/permissions/#dfn-permissionstatus-update-steps
|
|
void PermissionStatus::PermissionChanged(uint32_t aAction) {
|
|
PermissionState newState = ComputeStateFromAction(aAction);
|
|
if (mState == newState) {
|
|
return;
|
|
}
|
|
|
|
mState = newState;
|
|
|
|
// Step 4: Queue a task on the permissions task source to fire an
|
|
// event named change at status.
|
|
RefPtr<AsyncEventDispatcher> eventDispatcher =
|
|
new AsyncEventDispatcher(this, u"change"_ns, CanBubble::eNo);
|
|
eventDispatcher->PostDOMEvent();
|
|
}
|
|
|
|
void PermissionStatus::DisconnectFromOwner() {
|
|
IgnoreKeepAliveIfHasListenersFor(nsGkAtoms::onchange);
|
|
|
|
if (mSink) {
|
|
mSink->Disentangle();
|
|
mSink = nullptr;
|
|
}
|
|
|
|
DOMEventTargetHelper::DisconnectFromOwner();
|
|
}
|
|
|
|
void PermissionStatus::GetType(nsACString& aName) const {
|
|
aName.Assign(GetPermissionType());
|
|
}
|
|
|
|
already_AddRefed<PermissionStatusSink> PermissionStatus::CreateSink() {
|
|
RefPtr<PermissionStatusSink> sink =
|
|
new PermissionStatusSink(this, mName, GetPermissionType());
|
|
return sink.forget();
|
|
}
|
|
|
|
PermissionState PermissionStatus::ComputeStateFromAction(uint32_t aAction) {
|
|
nsCOMPtr<nsIGlobalObject> global = GetOwnerGlobal();
|
|
if (NS_WARN_IF(!global)) {
|
|
return PermissionState::Denied;
|
|
}
|
|
|
|
return ActionToPermissionState(aAction, mName, global);
|
|
}
|
|
|
|
} // namespace mozilla::dom
|