[WK2] Add initial implementation the Screen Wake Lock API behind an experimental flag #4733

cdumez · 2022-09-27T01:39:57Z

`95606b1`

[WK2] Add initial implementation the Screen Wake Lock API behind an experimental flag
https://bugs.webkit.org/show_bug.cgi?id=245712

Reviewed by Alex Christensen, Brent Fulgham and Geoffrey Garen.

Add initial implementation the Screen Wake Lock API for WebKit2, behind an experimental flag:
- https://w3c.github.io/screen-wake-lock

The implementation should be complete but it is currently behind an experimental feature flag
that is off by default.

Some tests are still failing. The reason for that seems to be that our support for Feature
Policy is only partial. In particular, we seem to support the `allow` attribute on iframes
but not the Feature-Policy HTTP header.

We also have to make a decision about whether or not we want to prompt the user when the
Website tries to take a screen wake lock and if we need an indicator in the browser UI.
Currently, my implementation only requires a user gesture.

* LayoutTests/TestExpectations:
* LayoutTests/imported/w3c/web-platform-tests/feature-policy/resources/feature-policy-screen-wakelock.html: Added.
* LayoutTests/imported/w3c/web-platform-tests/feature-policy/resources/featurepolicy.js:
(expect_reports):
* LayoutTests/imported/w3c/web-platform-tests/resources/testdriver-vendor.js:
(window.test_driver_internal.set_permission):
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/idlharness.https.window-expected.txt:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-active-document.https.window-expected.txt:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-disabled-by-feature-policy.https.sub-expected.txt:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-disabled-by-feature-policy.https.sub.html:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-by-feature-policy-attribute-redirect-on-load.https.sub-expected.txt:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-by-feature-policy-attribute-redirect-on-load.https.sub.html:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-by-feature-policy-attribute.https.sub-expected.txt:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-by-feature-policy-attribute.https.sub.html:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-by-feature-policy.https.sub-expected.txt:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-by-feature-policy.https.sub.html:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-on-self-origin-by-feature-policy.https.sub-expected.txt:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-on-self-origin-by-feature-policy.https.sub.html:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-onrelease.https-expected.txt:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-released.https-expected.txt:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-request-denied.https-expected.txt:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-type.https.window-expected.txt:
* LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelockpermissiondescriptor.https-expected.txt:
* LayoutTests/platform/mac-wk1/TestExpectations:
* LayoutTests/platform/win/TestExpectations:
* Source/WebCore/Modules/permissions/PermissionName.h:
* Source/WebCore/Modules/permissions/PermissionName.idl:
* Source/WebCore/Modules/screen-wake-lock/NavigatorScreenWakeLock.cpp:
(WebCore::NavigatorScreenWakeLock::NavigatorScreenWakeLock):
(WebCore::NavigatorScreenWakeLock::wakeLock):
* Source/WebCore/Modules/screen-wake-lock/NavigatorScreenWakeLock.h:
* Source/WebCore/Modules/screen-wake-lock/WakeLock.cpp:
(WebCore::WakeLock::WakeLock):
(WebCore::WakeLock::request):
(WebCore::WakeLock::document):
* Source/WebCore/Modules/screen-wake-lock/WakeLock.h:
(WebCore::WakeLock::create):
* Source/WebCore/Modules/screen-wake-lock/WakeLockManager.cpp: Added.
(WebCore::WakeLockManager::WakeLockManager):
(WebCore::WakeLockManager::~WakeLockManager):
(WebCore::WakeLockManager::addWakeLock):
(WebCore::WakeLockManager::removeWakeLock):
(WebCore::WakeLockManager::visibilityStateChanged):
(WebCore::WakeLockManager::releaseAllLocks):
* Source/WebCore/Modules/screen-wake-lock/WakeLockManager.h: Copied from Source/WebCore/Modules/screen-wake-lock/WakeLock.h.
* Source/WebCore/Modules/screen-wake-lock/WakeLockSentinel.cpp:
(WebCore::WakeLockSentinel::release):
(WebCore::WakeLockSentinel::virtualHasPendingActivity const):
(WebCore::WakeLockSentinel::eventListenersDidChange):
(WebCore::WakeLockSentinel::wakeLockManager):
* Source/WebCore/Modules/screen-wake-lock/WakeLockSentinel.h:
* Source/WebCore/Modules/screen-wake-lock/WakeLockType.h:
* Source/WebCore/Sources.txt:
* Source/WebCore/WebCore.xcodeproj/project.pbxproj:
* Source/WebCore/dom/Document.cpp:
(WebCore::Document::wakeLockManager):
(WebCore::Document::stopActiveDOMObjects):
* Source/WebCore/dom/Document.h:
* Source/WebCore/dom/TaskSource.h:
* Source/WebCore/html/FeaturePolicy.cpp:
(WebCore::policyTypeName):
(WebCore::FeaturePolicy::parse):
(WebCore::FeaturePolicy::allows const):
* Source/WebCore/html/FeaturePolicy.h:
* Source/WebKit/UIProcess/WebPageProxy.cpp:
(WebKit::WebPageProxy::queryPermission):
* Tools/WebKitTestRunner/InjectedBundle/Bindings/TestRunner.idl:
* Tools/WebKitTestRunner/InjectedBundle/InjectedBundle.cpp:
(WTR::InjectedBundle::setScreenWakeLockPermission):
* Tools/WebKitTestRunner/InjectedBundle/InjectedBundle.h:
* Tools/WebKitTestRunner/InjectedBundle/TestRunner.cpp:
(WTR::TestRunner::setScreenWakeLockPermission):
* Tools/WebKitTestRunner/InjectedBundle/TestRunner.h:
* Tools/WebKitTestRunner/TestController.cpp:
(WTR::TestController::handleQueryPermission):
(WTR::TestController::resetStateToConsistentValues):
(WTR::TestController::setScreenWakeLockPermission):
* Tools/WebKitTestRunner/TestController.h:
* Tools/WebKitTestRunner/TestInvocation.cpp:
(WTR::TestInvocation::didReceiveMessageFromInjectedBundle):

Canonical link: https://commits.webkit.org/255019@main

575238a

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	❌ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	~~🛠 mac-debug~~	✅ 🛠 gtk	💥 🛠 wincairo
✅ 🧪 webkitperl	⏳ 🧪 ios-wk2	✅ 🛠 mac-AS-debug	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	~~🧪 api-mac~~	✅ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk1
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2
✅ 🛠 🧪 merge	✅ 🛠 watch	~~🧪 mac-AS-debug-wk2~~
	✅ 🛠 watch-sim	✅ 🧪 mac-wk2-stress

webkit-early-warning-system · 2022-09-27T01:40:07Z

EWS run on previous version of this PR (hash 10319a4)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	⏳ 🛠 mac	✅ 🛠 wpe	⏳ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	⏳ 🛠 mac-debug	✅ 🛠 gtk	⏳ 🛠 wincairo
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	✅ 🛠 mac-AS-debug	❌ 🧪 gtk-wk2
	~~🧪 api-ios~~	⏳ 🧪 api-mac	~~🧪 api-gtk~~
⏳ 🛠 🧪 jsc	✅ 🛠 tv	⏳ 🧪 mac-wk1
	✅ 🛠 tv-sim	⏳ 🧪 mac-wk2
	✅ 🛠 watch	~~🧪 mac-AS-debug-wk2~~
	✅ 🛠 watch-sim	⏳ 🧪 mac-wk2-stress

cdumez · 2022-09-27T01:44:09Z

Upstream WPT PR: web-platform-tests/wpt#36088

webkit-early-warning-system · 2022-09-27T03:33:56Z

EWS run on previous version of this PR (hash faf5c8e)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	❌ 🛠 mac	✅ 🛠 wpe	❌ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	❌ 🛠 mac-debug	✅ 🛠 gtk	❌ 🛠 wincairo
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	❌ 🛠 mac-AS-debug	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	❌ 🧪 api-mac	✅ 🧪 api-gtk
	✅ 🛠 tv	❌ 🧪 mac-wk1
	✅ 🛠 tv-sim	❌ 🧪 mac-wk2
	✅ 🛠 watch	❌ 🧪 mac-AS-debug-wk2
	✅ 🛠 watch-sim	❌ 🧪 mac-wk2-stress

webkit-early-warning-system · 2022-09-27T16:43:19Z

EWS run on previous version of this PR (hash 66d5776)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	⏳ 🛠 mac	✅ 🛠 wpe	⏳ 🛠 🧪 win
	✅ 🛠 ios-sim	⏳ 🛠 mac-debug	✅ 🛠 gtk	⏳ 🛠 wincairo
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	✅ 🛠 mac-AS-debug	~~🧪 gtk-wk2~~
	~~🧪 api-ios~~	⏳ 🧪 api-mac	~~🧪 api-gtk~~
	✅ 🛠 tv	⏳ 🧪 mac-wk1
	✅ 🛠 tv-sim	⏳ 🧪 mac-wk2
	✅ 🛠 watch	~~🧪 mac-AS-debug-wk2~~
	✅ 🛠 watch-sim	⏳ 🧪 mac-wk2-stress

webkit-early-warning-system · 2022-09-27T18:58:46Z

EWS run on previous version of this PR (hash d0a8f72)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	⏳ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	⏳ 🛠 mac-debug	✅ 🛠 gtk	⏳ 🛠 wincairo
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	✅ 🛠 mac-AS-debug	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	✅ 🧪 api-mac	✅ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk1
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2
	✅ 🛠 watch	~~🧪 mac-AS-debug-wk2~~
	✅ 🛠 watch-sim	✅ 🧪 mac-wk2-stress

marcoscaceres · 2022-09-28T01:18:59Z

Source/WebCore/Modules/screen-wake-lock/WakeLock.cpp

+    }
+
+    // We should be requesting permission but at the moment, we merely require a user gesture.
+    bool hasUserGesture = UserGestureIndicator::processingUserGesture(document);


Should we use/consume transient activation instead?

I updated the patch to use transient activation. Let me know if you think we should consume instead.

I would favor not consuming in this case; but we can have that discussion in the standards github. (I've commented there already.)

webkit-early-warning-system · 2022-09-28T02:11:43Z

EWS run on previous version of this PR (hash 8afd079)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	⏳ 🛠 mac	⏳ 🛠 wpe	⏳ 🛠 🧪 win
	✅ 🛠 ios-sim	⏳ 🛠 mac-debug	⏳ 🛠 gtk	⏳ 🛠 wincairo
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	⏳ 🛠 mac-AS-debug	⏳ 🧪 gtk-wk2
	~~🧪 api-ios~~	⏳ 🧪 api-mac	⏳ 🧪 api-gtk
⏳ 🛠 🧪 jsc	✅ 🛠 tv	⏳ 🧪 mac-wk1	✅ 🛠 jsc-armv7
	⏳ 🛠 tv-sim	⏳ 🧪 mac-wk2	~~🧪 jsc-armv7-tests~~
	⏳ 🛠 watch	⏳ 🧪 mac-AS-debug-wk2	✅ 🛠 jsc-mips
	✅ 🛠 watch-sim	⏳ 🧪 mac-wk2-stress	~~🧪 jsc-mips-tests~~

webkit-early-warning-system · 2022-09-28T02:19:24Z

Starting EWS tests for a6e3d1a. Live statuses available at the PR page, #4733

webkit-early-warning-system · 2022-09-28T02:19:24Z

EWS run on previous version of this PR (hash a6e3d1a)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	⏳ 🛠 mac-debug	✅ 🛠 gtk	✅ 🛠 wincairo
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	✅ 🛠 mac-AS-debug	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	✅ 🧪 api-mac	✅ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk1
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2
	✅ 🛠 watch	~~🧪 mac-AS-debug-wk2~~
	✅ 🛠 watch-sim	✅ 🧪 mac-wk2-stress

webkit-early-warning-system · 2022-09-28T15:49:19Z

EWS run on previous version of this PR (hash 7254884)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	⏳ 🛠 🧪 win
	✅ 🛠 ios-sim	⏳ 🛠 mac-debug	✅ 🛠 gtk	⏳ 🛠 wincairo
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	✅ 🛠 mac-AS-debug	❌ 🧪 gtk-wk2
	✅ 🧪 api-ios	✅ 🧪 api-mac	~~🧪 api-gtk~~
	✅ 🛠 tv	✅ 🧪 mac-wk1
	✅ 🛠 tv-sim	❌ 🧪 mac-wk2
	✅ 🛠 watch	~~🧪 mac-AS-debug-wk2~~
	✅ 🛠 watch-sim	✅ 🧪 mac-wk2-stress

webkit-early-warning-system · 2022-09-28T20:37:05Z

Starting EWS tests for 74f691f. Live statuses available at the PR page, #4733

webkit-early-warning-system · 2022-09-28T20:37:06Z

EWS run on previous version of this PR (hash 74f691f)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	⏳ 🛠 ios	⏳ 🛠 mac	⏳ 🛠 wpe	⏳ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	⏳ 🛠 mac-debug	⏳ 🛠 gtk	⏳ 🛠 wincairo
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	⏳ 🛠 mac-AS-debug	⏳ 🧪 gtk-wk2
	~~🧪 api-ios~~	⏳ 🧪 api-mac	⏳ 🧪 api-gtk
	⏳ 🛠 tv	⏳ 🧪 mac-wk1
	⏳ 🛠 tv-sim	⏳ 🧪 mac-wk2
	⏳ 🛠 watch	⏳ 🧪 mac-AS-debug-wk2
	✅ 🛠 watch-sim	⏳ 🧪 mac-wk2-stress

webkit-early-warning-system · 2022-09-28T20:38:44Z

EWS run on current version of this PR (hash 6a683aa)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
🧪 style	⏳ 🛠 ios	⏳ 🛠 mac	⏳ 🛠 wpe	⏳ 🛠 🧪 win
⏳ 🧪 bindings	⏳ 🛠 ios-sim	⏳ 🛠 mac-debug	⏳ 🛠 gtk	⏳ 🛠 wincairo
⏳ 🧪 webkitperl	⏳ 🧪 ios-wk2	⏳ 🛠 mac-AS-debug	⏳ 🧪 gtk-wk2
	⏳ 🧪 api-ios	⏳ 🧪 api-mac	⏳ 🧪 api-gtk
🛠 🧪 jsc	🛠 tv	⏳ 🧪 mac-wk1
	⏳ 🛠 tv-sim	⏳ 🧪 mac-wk2
	⏳ 🛠 watch	⏳ 🧪 mac-AS-debug-wk2	🛠 jsc-mips
	⏳ 🛠 watch-sim	⏳ 🧪 mac-wk2-stress	🧪 jsc-mips-tests

webkit-early-warning-system · 2022-09-28T20:38:44Z

EWS run on previous version of this PR (hash 6a683aa)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	❌ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	⏳ 🛠 mac-debug	✅ 🛠 gtk	❌ 🛠 wincairo
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	✅ 🛠 mac-AS-debug	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	✅ 🧪 api-mac	✅ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk1
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2
	✅ 🛠 watch	✅ 🧪 mac-AS-debug-wk2
	✅ 🛠 watch-sim	✅ 🧪 mac-wk2-stress

cdumez · 2022-09-29T16:30:49Z

Ping review?

geoffreygaren · 2022-09-29T17:24:56Z

Source/WebCore/Modules/screen-wake-lock/WakeLockManager.cpp

+
+WakeLockManager::~WakeLockManager()
+{
+    m_document.unregisterForVisibilityStateChangedCallbacks(*this);


I wish we could use a weak map for this instead.

Not sure what you mean. It is already a WeakHashSet:
WeakHashSet<VisibilityChangeClient> m_visibilityStateCallbackClients;

This doesn't mean we shouldn't remove the client when it is gone as far as I know. Our WeakHashSet implementation doesn't aggressively prune dead entries.

I see: We do use WeakHashSet here, but WeakHashSet does not have amortizedCleanupIfNeeded(), like WeakHashMap does.

Maybe we should add amortizedCleanupIfNeeded() to WeakHashSet.

geoffreygaren

r=me

webkit-early-warning-system · 2022-09-29T17:32:12Z

EWS run on current version of this PR (hash 575238a)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
🧪 style	🛠 ios	⏳ 🛠 mac	⏳ 🛠 wpe	⏳ 🛠 🧪 win
🧪 bindings	⏳ 🛠 ios-sim	⏳ 🛠 mac-debug	⏳ 🛠 gtk	⏳ 🛠 wincairo
⏳ 🧪 webkitperl	⏳ 🧪 ios-wk2	⏳ 🛠 mac-AS-debug	⏳ 🧪 gtk-wk2
	⏳ 🧪 api-ios	⏳ 🧪 api-mac	⏳ 🧪 api-gtk
⏳ 🛠 🧪 jsc	⏳ 🛠 tv	⏳ 🧪 mac-wk1	⏳ 🛠 jsc-armv7
	⏳ 🛠 tv-sim	⏳ 🧪 mac-wk2	⏳ 🧪 jsc-armv7-tests
	⏳ 🛠 watch	⏳ 🧪 mac-AS-debug-wk2
	⏳ 🛠 watch-sim	⏳ 🧪 mac-wk2-stress

webkit-early-warning-system · 2022-09-29T17:32:13Z

EWS run on current version of this PR (hash 575238a)

Misc	iOS, tvOS & watchOS	macOS	Linux	Windows
❌ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	❌ 🛠 🧪 win
✅ 🧪 bindings	✅ 🛠 ios-sim	~~🛠 mac-debug~~	✅ 🛠 gtk	💥 🛠 wincairo
✅ 🧪 webkitperl	⏳ 🧪 ios-wk2	✅ 🛠 mac-AS-debug	✅ 🧪 gtk-wk2
	✅ 🧪 api-ios	~~🧪 api-mac~~	✅ 🧪 api-gtk
	✅ 🛠 tv	✅ 🧪 mac-wk1
	✅ 🛠 tv-sim	✅ 🧪 mac-wk2
✅ 🛠 🧪 merge	✅ 🛠 watch	~~🧪 mac-AS-debug-wk2~~
	✅ 🛠 watch-sim	✅ 🧪 mac-wk2-stress

achristensen07 · 2022-09-29T17:39:16Z

Source/WebCore/Modules/screen-wake-lock/NavigatorScreenWakeLock.cpp

@@ -61,7 +62,7 @@ WakeLock& NavigatorScreenWakeLock::wakeLock(Navigator& navigator)
 WakeLock& NavigatorScreenWakeLock::wakeLock()
 {
    if (!m_wakeLock)
-        m_wakeLock = WakeLock::create();
+        m_wakeLock = WakeLock::create(downcast<Document>(m_navigator.scriptExecutionContext()));


Why do we need to downcast this here? It's just passed to the ContextDestructionObserver constructor.

I am purposefully using tight typing (Document instead of ScriptExecutionContext) to make it clear that WakeLock is only exposed to Window contexts and not workers.

I am not trying to future proof it to make it work with workers because I don't know that there is such plan. In particular, the spec doesn't currently expose this to workers. Also, if somebody were to add support for workers, there would likely be a lot more work involved than just changing the type here.

achristensen07 · 2022-09-29T17:41:37Z

Source/WebCore/Modules/screen-wake-lock/WakeLock.cpp

 {
-    promise->reject(Exception { NotSupportedError });
+    return downcast<Document>(scriptExecutionContext());


To be conservative, could we return null if it's not a Document? (just in case someone in the future adds this to workers)

I think downcast<> does just return nullptr if the type is wrong?

But the type is not wrong. The WakeLock constructor takes a Document (because WakeLock is not exposed to workers) and thus its script execution context is always a Document.

achristensen07 · 2022-09-29T17:44:04Z

Source/WebCore/Modules/screen-wake-lock/WakeLockManager.h

+private:
+    void visibilityStateChanged() final;
+
+    Document& m_document;


This is safe right now because the Document owns WakeLockManager with a std::unique_ptr. We could make this a little more future-proof and make this a WeakPtr to protect against someone in the future making WakeLockManager RefCounted.

I hesitated. The reason I went this way is that it makes it clear the document cannot be null. With WeakPtr, it is tempting to null check it everywhere.

brentfulgham · 2022-09-29T20:52:52Z

Source/WebCore/Modules/screen-wake-lock/WakeLock.cpp

 {
-    promise->reject(Exception { NotSupportedError });
+    return downcast<Document>(scriptExecutionContext());


I think downcast<> does just return nullptr if the type is wrong?

brentfulgham · 2022-09-29T20:54:10Z

Source/WebCore/Modules/screen-wake-lock/WakeLock.cpp


 namespace WebCore {

-WakeLock::WakeLock() = default;
+WakeLock::WakeLock(Document* document)
+    : ContextDestructionObserver(document)


It's funny that this paradigm seems to support the concept of being a context destruction observer for a nullptr.

brentfulgham · 2022-09-29T21:00:20Z

Source/WebCore/Modules/screen-wake-lock/WakeLockManager.cpp

+        return;
+
+    switch (type) {
+    case WakeLockType::Screen:


It seems silly and inefficient to have a WakeLockType enum with a single value. I realize that this is how the specification is defined, but it is strange! Why pay the cost of a switch/case/branch here when it can never be anything else?

I wrote it this way to match the spec and for future extensibility as different types of lock can be supported (I think Blink has a system lock for e.g.). Hopefully the compiler is smart enough to optimize this out but if it isn't, this is not hot code at all.

…xperimental flag https://bugs.webkit.org/show_bug.cgi?id=245712 Reviewed by Alex Christensen, Brent Fulgham and Geoffrey Garen. Add initial implementation the Screen Wake Lock API for WebKit2, behind an experimental flag: - https://w3c.github.io/screen-wake-lock The implementation should be complete but it is currently behind an experimental feature flag that is off by default. Some tests are still failing. The reason for that seems to be that our support for Feature Policy is only partial. In particular, we seem to support the `allow` attribute on iframes but not the Feature-Policy HTTP header. We also have to make a decision about whether or not we want to prompt the user when the Website tries to take a screen wake lock and if we need an indicator in the browser UI. Currently, my implementation only requires a user gesture. * LayoutTests/TestExpectations: * LayoutTests/imported/w3c/web-platform-tests/feature-policy/resources/feature-policy-screen-wakelock.html: Added. * LayoutTests/imported/w3c/web-platform-tests/feature-policy/resources/featurepolicy.js: (expect_reports): * LayoutTests/imported/w3c/web-platform-tests/resources/testdriver-vendor.js: (window.test_driver_internal.set_permission): * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/idlharness.https.window-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-active-document.https.window-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-disabled-by-feature-policy.https.sub-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-disabled-by-feature-policy.https.sub.html: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-by-feature-policy-attribute-redirect-on-load.https.sub-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-by-feature-policy-attribute-redirect-on-load.https.sub.html: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-by-feature-policy-attribute.https.sub-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-by-feature-policy-attribute.https.sub.html: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-by-feature-policy.https.sub-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-by-feature-policy.https.sub.html: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-on-self-origin-by-feature-policy.https.sub-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-enabled-on-self-origin-by-feature-policy.https.sub.html: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-onrelease.https-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-released.https-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-request-denied.https-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelock-type.https.window-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/screen-wake-lock/wakelockpermissiondescriptor.https-expected.txt: * LayoutTests/platform/mac-wk1/TestExpectations: * LayoutTests/platform/win/TestExpectations: * Source/WebCore/Modules/permissions/PermissionName.h: * Source/WebCore/Modules/permissions/PermissionName.idl: * Source/WebCore/Modules/screen-wake-lock/NavigatorScreenWakeLock.cpp: (WebCore::NavigatorScreenWakeLock::NavigatorScreenWakeLock): (WebCore::NavigatorScreenWakeLock::wakeLock): * Source/WebCore/Modules/screen-wake-lock/NavigatorScreenWakeLock.h: * Source/WebCore/Modules/screen-wake-lock/WakeLock.cpp: (WebCore::WakeLock::WakeLock): (WebCore::WakeLock::request): (WebCore::WakeLock::document): * Source/WebCore/Modules/screen-wake-lock/WakeLock.h: (WebCore::WakeLock::create): * Source/WebCore/Modules/screen-wake-lock/WakeLockManager.cpp: Added. (WebCore::WakeLockManager::WakeLockManager): (WebCore::WakeLockManager::~WakeLockManager): (WebCore::WakeLockManager::addWakeLock): (WebCore::WakeLockManager::removeWakeLock): (WebCore::WakeLockManager::visibilityStateChanged): (WebCore::WakeLockManager::releaseAllLocks): * Source/WebCore/Modules/screen-wake-lock/WakeLockManager.h: Copied from Source/WebCore/Modules/screen-wake-lock/WakeLock.h. * Source/WebCore/Modules/screen-wake-lock/WakeLockSentinel.cpp: (WebCore::WakeLockSentinel::release): (WebCore::WakeLockSentinel::virtualHasPendingActivity const): (WebCore::WakeLockSentinel::eventListenersDidChange): (WebCore::WakeLockSentinel::wakeLockManager): * Source/WebCore/Modules/screen-wake-lock/WakeLockSentinel.h: * Source/WebCore/Modules/screen-wake-lock/WakeLockType.h: * Source/WebCore/Sources.txt: * Source/WebCore/WebCore.xcodeproj/project.pbxproj: * Source/WebCore/dom/Document.cpp: (WebCore::Document::wakeLockManager): (WebCore::Document::stopActiveDOMObjects): * Source/WebCore/dom/Document.h: * Source/WebCore/dom/TaskSource.h: * Source/WebCore/html/FeaturePolicy.cpp: (WebCore::policyTypeName): (WebCore::FeaturePolicy::parse): (WebCore::FeaturePolicy::allows const): * Source/WebCore/html/FeaturePolicy.h: * Source/WebKit/UIProcess/WebPageProxy.cpp: (WebKit::WebPageProxy::queryPermission): * Tools/WebKitTestRunner/InjectedBundle/Bindings/TestRunner.idl: * Tools/WebKitTestRunner/InjectedBundle/InjectedBundle.cpp: (WTR::InjectedBundle::setScreenWakeLockPermission): * Tools/WebKitTestRunner/InjectedBundle/InjectedBundle.h: * Tools/WebKitTestRunner/InjectedBundle/TestRunner.cpp: (WTR::TestRunner::setScreenWakeLockPermission): * Tools/WebKitTestRunner/InjectedBundle/TestRunner.h: * Tools/WebKitTestRunner/TestController.cpp: (WTR::TestController::handleQueryPermission): (WTR::TestController::resetStateToConsistentValues): (WTR::TestController::setScreenWakeLockPermission): * Tools/WebKitTestRunner/TestController.h: * Tools/WebKitTestRunner/TestInvocation.cpp: (WTR::TestInvocation::didReceiveMessageFromInjectedBundle): Canonical link: https://commits.webkit.org/255019@main

webkit-commit-queue · 2022-09-30T02:26:49Z

Committed 255019@main (95606b1): https://commits.webkit.org/255019@main

Reviewed commits have been landed. Closing PR #4733 and removing active labels.

cdumez self-assigned this Sep 27, 2022

cdumez added WebCore JavaScript Bugs in the JavaScript support that WebCore layers on top of JavaScriptCore. WebKit Nightly Build labels Sep 27, 2022

webkit-ews-buildbot added the merging-blocked Applied to prevent a change from being merged label Sep 27, 2022

cdumez removed the merging-blocked Applied to prevent a change from being merged label Sep 27, 2022

cdumez force-pushed the screen_wake_lock_implementation branch from 10319a4 to faf5c8e Compare September 27, 2022 03:33

cdumez force-pushed the screen_wake_lock_implementation branch from faf5c8e to 66d5776 Compare September 27, 2022 16:42

cdumez force-pushed the screen_wake_lock_implementation branch from 66d5776 to d0a8f72 Compare September 27, 2022 18:58

cdumez marked this pull request as ready for review September 27, 2022 23:30

cdumez requested review from rniwa and JonWBedard as code owners September 27, 2022 23:30

cdumez requested review from brentfulgham, achristensen07 and geoffreygaren September 27, 2022 23:31

cdumez assigned darinadler and unassigned darinadler Sep 27, 2022

cdumez requested a review from darinadler September 27, 2022 23:40

marcoscaceres reviewed Sep 28, 2022

View reviewed changes

cdumez force-pushed the screen_wake_lock_implementation branch from d0a8f72 to 8afd079 Compare September 28, 2022 02:11

cdumez force-pushed the screen_wake_lock_implementation branch from 8afd079 to a6e3d1a Compare September 28, 2022 02:19

cdumez force-pushed the screen_wake_lock_implementation branch from a6e3d1a to 7254884 Compare September 28, 2022 15:49

webkit-ews-buildbot added the merging-blocked Applied to prevent a change from being merged label Sep 28, 2022

cdumez removed the merging-blocked Applied to prevent a change from being merged label Sep 28, 2022

cdumez force-pushed the screen_wake_lock_implementation branch from 7254884 to 74f691f Compare September 28, 2022 20:35

cdumez force-pushed the screen_wake_lock_implementation branch from 74f691f to 6a683aa Compare September 28, 2022 20:38

geoffreygaren reviewed Sep 29, 2022

View reviewed changes

geoffreygaren approved these changes Sep 29, 2022

View reviewed changes

cdumez force-pushed the screen_wake_lock_implementation branch from 6a683aa to 575238a Compare September 29, 2022 17:31

achristensen07 approved these changes Sep 29, 2022

View reviewed changes

brentfulgham approved these changes Sep 29, 2022

View reviewed changes

cdumez added the merge-queue Applied to send a pull request to merge-queue label Sep 30, 2022

webkit-commit-queue force-pushed the screen_wake_lock_implementation branch from 575238a to 95606b1 Compare September 30, 2022 02:26

webkit-commit-queue merged commit 95606b1 into WebKit:main Sep 30, 2022

webkit-commit-queue removed the merge-queue Applied to send a pull request to merge-queue label Sep 30, 2022

cdumez deleted the screen_wake_lock_implementation branch September 30, 2022 14:39

[WK2] Add initial implementation the Screen Wake Lock API behind an experimental flag #4733

[WK2] Add initial implementation the Screen Wake Lock API behind an experimental flag #4733

Uh oh!

Conversation

cdumez commented Sep 27, 2022 • edited by webkit-early-warning-system Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cdumez commented Sep 27, 2022

Uh oh!

webkit-early-warning-system commented Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

webkit-early-warning-system commented Sep 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 28, 2022

Uh oh!

webkit-early-warning-system commented Sep 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 28, 2022

Uh oh!

webkit-early-warning-system commented Sep 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cdumez commented Sep 29, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

geoffreygaren left a comment

Choose a reason for hiding this comment

Uh oh!

webkit-early-warning-system commented Sep 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cdumez commented Sep 27, 2022 •

edited by webkit-early-warning-system

Loading

webkit-early-warning-system commented Sep 27, 2022 •

edited

Loading

webkit-early-warning-system commented Sep 27, 2022 •

edited

Loading

webkit-early-warning-system commented Sep 27, 2022 •

edited

Loading

webkit-early-warning-system commented Sep 27, 2022 •

edited

Loading

webkit-early-warning-system commented Sep 28, 2022 •

edited

Loading

webkit-early-warning-system commented Sep 28, 2022 •

edited

Loading

webkit-early-warning-system commented Sep 28, 2022 •

edited

Loading

webkit-early-warning-system commented Sep 28, 2022 •

edited

Loading

webkit-early-warning-system commented Sep 28, 2022 •

edited

Loading

webkit-early-warning-system commented Sep 28, 2022 •

edited

Loading

webkit-early-warning-system commented Sep 29, 2022 •

edited

Loading

webkit-early-warning-system commented Sep 29, 2022 •

edited

Loading