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
75 lines
2.2 KiB
C++
75 lines
2.2 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_PermissionStatus_h_
|
|
#define mozilla_dom_PermissionStatus_h_
|
|
|
|
#include "mozilla/dom/PermissionsBinding.h"
|
|
#include "mozilla/dom/PermissionStatusBinding.h"
|
|
#include "mozilla/DOMEventTargetHelper.h"
|
|
#include "mozilla/MozPromise.h"
|
|
|
|
namespace mozilla::dom {
|
|
|
|
class PermissionStatusSink;
|
|
|
|
class PermissionStatus : public DOMEventTargetHelper {
|
|
friend class PermissionStatusSink;
|
|
|
|
public:
|
|
using SimplePromise = MozPromise<nsresult, nsresult, true>;
|
|
|
|
PermissionStatus(nsIGlobalObject* aGlobal, PermissionName aName);
|
|
|
|
JSObject* WrapObject(JSContext* aCx,
|
|
JS::Handle<JSObject*> aGivenProto) override;
|
|
|
|
PermissionState State() const { return mState; }
|
|
void SetState(PermissionState aState) { mState = aState; }
|
|
|
|
IMPL_EVENT_HANDLER(change)
|
|
|
|
void DisconnectFromOwner() override;
|
|
|
|
PermissionName Name() const { return mName; }
|
|
|
|
void GetType(nsACString& aName) const;
|
|
|
|
RefPtr<SimplePromise> Init();
|
|
|
|
protected:
|
|
~PermissionStatus();
|
|
|
|
/**
|
|
* This method returns the internal permission type, which should be equal to
|
|
* the permission name for all but the MIDI permission because of the SysEx
|
|
* support: internally, we have both "midi" and "midi-sysex" permission types
|
|
* but we only have a "midi" (public) permission name.
|
|
*
|
|
* Note: the `MidiPermissionDescriptor` descriptor has an optional `sysex`
|
|
* boolean, which is used to determine whether to return "midi" or
|
|
* "midi-sysex" for the MIDI permission.
|
|
*/
|
|
virtual nsLiteralCString GetPermissionType() const;
|
|
|
|
private:
|
|
virtual already_AddRefed<PermissionStatusSink> CreateSink();
|
|
|
|
void PermissionChanged(uint32_t aAction);
|
|
|
|
PermissionState ComputeStateFromAction(uint32_t aAction);
|
|
|
|
PermissionName mName;
|
|
RefPtr<PermissionStatusSink> mSink;
|
|
|
|
protected:
|
|
PermissionState mState;
|
|
};
|
|
|
|
} // namespace mozilla::dom
|
|
|
|
#endif // mozilla_dom_permissionstatus_h_
|