Web Automation: implement Set Storage Access endpoint #49692

burg · 2025-08-21T00:21:10Z

`19e1927`

Web Automation: implement Set Storage Access endpoint
https://bugs.webkit.org/show_bug.cgi?id=297368
rdar://158263193

Reviewed by Charlie Wolfe.

Add new endpoints for setting storage access permission state and
granting storage access to embedded frames for specific origins.

These methods will be called via Automation protocol to implement the
WebDriver Classic endpoints in safaridriver. In a future patch, the
WebAutomationSession methods will be used by the WebDriver BiDi permissions agent.

* Source/WebKit/UIProcess/Automation/Automation.json:
* Source/WebKit/UIProcess/Automation/WebAutomationSession.h:
* Source/WebKit/UIProcess/Automation/WebAutomationSession.cpp:
(WebKit::WebAutomationSession::setStorageAccessPermissionState):
(WebKit::WebAutomationSession::grantStorageAccess):

[WebDriver BiDi] add support for permissions.setPermission command
https://bugs.webkit.org/show_bug.cgi?id=265621
rdar://119346759

Reviewed by Charlie Wolfe.

Implement the remote end steps for Set Permission.

* Source/WebKit/CMakeLists.txt:
* Source/WebKit/DerivedSources-input.xcfilelist:
* Source/WebKit/DerivedSources.make:
* Source/WebKit/Sources.txt:
* Source/WebKit/UIProcess/Automation/BidiPermissionsAgent.cpp: Added.
(WebKit::BidiPermissionsAgent::BidiPermissionsAgent):
(WebKit::allPageProxiesFor):
(WebKit::BidiPermissionsAgent::setPermission):
Added. Defer to WebSiteDataStore and NetworkProcess for the actual implementation.

* Source/WebKit/UIProcess/Automation/BidiPermissionsAgent.h: Added.
* Source/WebKit/UIProcess/Automation/WebDriverBidiProcessor.cpp:
(WebKit::WebDriverBidiProcessor::WebDriverBidiProcessor):
Add BidiPermissionAgent.
* Source/WebKit/UIProcess/Automation/WebDriverBidiProcessor.h:
* Source/WebKit/UIProcess/Automation/protocol/BidiPermissions.json: Added.

* Source/WebKit/WebKit.xcodeproj/project.pbxproj:
Add new domain and associated derived sources and project entries.

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

a0fdd11

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows	Apple Internal
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win	✅ 🛠 ios-apple
	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	~~🧪 win-tests~~	✅ 🛠 mac-apple
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe		✅ 🛠 vision-apple
	✅ 🧪 ios-wk2-wpt		✅ 🛠 wpe-cairo
	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🛠 gtk
	✅ 🛠 vision	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	✅ 🧪 api-gtk
✅ 🛠 🧪 merge	✅ 🧪 vision-wk2	✅ 🧪 mac-intel-wk2	✅ 🛠 playstation
	✅ 🛠 tv	✅ 🛠 mac-safer-cpp
	✅ 🛠 tv-sim
	✅ 🛠 watch
	✅ 🛠 watch-sim

webkit-early-warning-system · 2025-08-21T00:21:17Z

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

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows	Apple Internal
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win	✅ 🛠 ios-apple
	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	💥 🧪 win-tests	✅ 🛠 mac-apple
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	❌ 🧪 api-wpe		✅ 🛠 vision-apple
	✅ 🧪 ios-wk2-wpt		✅ 🛠 wpe-cairo
	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🛠 gtk
	✅ 🛠 vision	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	✅ 🧪 api-gtk
	✅ 🧪 vision-wk2	✅ 🧪 mac-intel-wk2	✅ 🛠 playstation
	✅ 🛠 tv	✅ 🛠 mac-safer-cpp
	✅ 🛠 tv-sim
	✅ 🛠 watch
	✅ 🛠 watch-sim

Source/WebKit/UIProcess/Automation/Automation.json

Source/WebKit/UIProcess/Automation/BidiPermissionsAgent.cpp

Source/WebKit/UIProcess/Automation/WebAutomationSession.cpp

the-chenergy · 2025-08-25T17:53:51Z

Source/WebKit/UIProcess/Automation/BidiPermissionsAgent.cpp

+                continue;
+
+            bool granted = state == Inspector::Protocol::BidiPermissions::PermissionState::Granted;
+            page->protectedWebsiteDataStore()->setStorageAccessPermissionForTesting(granted, page->identifier(), topFrameOrigin.string(), (embeddedOriginIsWildcard ? topFrameOrigin : embeddedOrigin).string(), [aggregator] () { });


Suggested change

page->protectedWebsiteDataStore()->setStorageAccessPermissionForTesting(granted, page->identifier(), topFrameOrigin.string(), (embeddedOriginIsWildcard ? topFrameOrigin : embeddedOrigin).string(), [aggregator] () { });

page->protectedWebsiteDataStore()->setStorageAccessPermissionForTesting(granted, page->identifier(), topFrameOrigin.string(), (embeddedOriginIsWildcard ? topFrameOrigin : embeddedOrigin).string(), [aggregator]() { });

Source/WebKit/UIProcess/Automation/BidiPermissionsAgent.cpp

the-chenergy · 2025-08-25T18:10:43Z

Source/WebKit/UIProcess/Automation/BidiPermissionsAgent.cpp

+        bool embeddedOriginIsWildcard = subFrameURLString == "*"_s;
+        auto embeddedOrigin = RegistrableDomain { URL { subFrameURLString } };
+
+        auto aggregator = WTF::CallbackAggregator::create([callback = WTFMove(callback)]() mutable {


Should either this lambda or the one below also capture a protectedThis = Ref { *this }?

I wrote that before, but I removed it because the code doesn't actually use this in the callback. We have captured a ref to backendDispatcher in the generated lambda glue code that calls into the agent method.

m_agent->setPermission(in_descriptor.releaseNonNull(), in_origin, *in_state, in_opt_userContext, [backendDispatcher = m_backendDispatcher.copyRef(), ...

So it shouldn't be necessary to protect this, as BackendDispatcher and FrontendRounter will gracefully stop sending responses when there's no more frontends connected. In the WebDriver BiDi case, the BidiProcessor owns both frontend and backend dispatcher. So, if a callback outlasts the processor itself, sendResponse will dead end at the frontend router that doesn't have any connections.

I did a deep dive on the refcounting situation and i don't see the need to protect the agent as its owned by the processor. Plus, in the WebDriver BiDi case, the processor is used as a fake "connection" so that it can forward events and command responses through to WebAutomationSession::sendBidiMessage.

webkit-early-warning-system · 2025-08-26T18:41:59Z

EWS run on previous version of this PR (hash 10c0b6f)

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows	Apple Internal
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win	✅ 🛠 ios-apple
	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	❌ 🧪 win-tests	✅ 🛠 mac-apple
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe		✅ 🛠 vision-apple
	✅ 🧪 ios-wk2-wpt		✅ 🛠 wpe-cairo
	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🛠 gtk
	✅ 🛠 vision	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	✅ 🧪 api-gtk
	✅ 🧪 vision-wk2	✅ 🧪 mac-intel-wk2	✅ 🛠 playstation
	✅ 🛠 tv	✅ 🛠 mac-safer-cpp
	✅ 🛠 tv-sim
	✅ 🛠 watch
	✅ 🛠 watch-sim

AnujPanta1 · 2025-08-27T20:14:52Z

Source/WebKit/UIProcess/Automation/protocol/BidiPermissions.json

+            "description": "Simulates user modification of a PermissionDescriptor's permission state.",
+            "spec": "https://www.w3.org/TR/permissions/#webdriver-bidi-command-permissions-setPermission",
+            "wpt": "https://github.com/web-platform-tests/wpt/tree/master/webdriver/tests/bidi/permissions/set",
+            "async": true,


Nit: async usually at the bottom

AnujPanta1 · 2025-08-27T20:16:22Z

Source/WebKit/UIProcess/Automation/protocol/BidiPermissions.json

+            "name": "setPermission",
+            "description": "Simulates user modification of a PermissionDescriptor's permission state.",
+            "spec": "https://www.w3.org/TR/permissions/#webdriver-bidi-command-permissions-setPermission",
+            "wpt": "https://github.com/web-platform-tests/wpt/tree/master/webdriver/tests/bidi/permissions/set",


Link seems buggy ? I don't see a permissions bidi suite

Good catch, this is the correct link:
https://github.com/web-platform-tests/wpt/tree/master/webdriver/tests/bidi/external/permissions/set_permission

it's in a separate external directory because it's defined externally from the main bidi spec.

charliewolfe · 2025-08-27T20:19:04Z

Please also update the title to indicate this includes WebDriver Classic and the set storage access command.

webkit-early-warning-system · 2025-08-28T18:21:38Z

EWS run on previous version of this PR (hash 4230afb)

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows	Apple Internal
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win	✅ 🛠 ios-apple
	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	✅ 🧪 win-tests	✅ 🛠 mac-apple
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe		✅ 🛠 vision-apple
	✅ 🧪 ios-wk2-wpt		✅ 🛠 wpe-cairo
	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🛠 gtk
	✅ 🛠 vision	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	✅ 🧪 api-gtk
❌ 🛠 🧪 merge	✅ 🧪 vision-wk2	✅ 🧪 mac-intel-wk2	✅ 🛠 playstation
	✅ 🛠 tv	✅ 🛠 mac-safer-cpp
	✅ 🛠 tv-sim
	✅ 🛠 watch
	✅ 🛠 watch-sim

webkit-commit-queue · 2025-08-28T22:16:32Z

This change contains multiple commits which are not squashed together, blocking PR #49692. Please squash the commits to land.

webkit-early-warning-system · 2025-09-04T01:56:46Z

EWS run on current version of this PR (hash a0fdd11)

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows	Apple Internal
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win	✅ 🛠 ios-apple
	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	~~🧪 win-tests~~	✅ 🛠 mac-apple
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe		✅ 🛠 vision-apple
	✅ 🧪 ios-wk2-wpt		✅ 🛠 wpe-cairo
	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🛠 gtk
	✅ 🛠 vision	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	✅ 🧪 api-gtk
✅ 🛠 🧪 merge	✅ 🧪 vision-wk2	✅ 🧪 mac-intel-wk2	✅ 🛠 playstation
	✅ 🛠 tv	✅ 🛠 mac-safer-cpp
	✅ 🛠 tv-sim
	✅ 🛠 watch
	✅ 🛠 watch-sim

https://bugs.webkit.org/show_bug.cgi?id=297368 rdar://158263193 Reviewed by Charlie Wolfe. Add new endpoints for setting storage access permission state and granting storage access to embedded frames for specific origins. These methods will be called via Automation protocol to implement the WebDriver Classic endpoints in safaridriver. In a future patch, the WebAutomationSession methods will be used by the WebDriver BiDi permissions agent. * Source/WebKit/UIProcess/Automation/Automation.json: * Source/WebKit/UIProcess/Automation/WebAutomationSession.h: * Source/WebKit/UIProcess/Automation/WebAutomationSession.cpp: (WebKit::WebAutomationSession::setStorageAccessPermissionState): (WebKit::WebAutomationSession::grantStorageAccess): [WebDriver BiDi] add support for permissions.setPermission command https://bugs.webkit.org/show_bug.cgi?id=265621 rdar://119346759 Reviewed by Charlie Wolfe. Implement the remote end steps for Set Permission. * Source/WebKit/CMakeLists.txt: * Source/WebKit/DerivedSources-input.xcfilelist: * Source/WebKit/DerivedSources.make: * Source/WebKit/Sources.txt: * Source/WebKit/UIProcess/Automation/BidiPermissionsAgent.cpp: Added. (WebKit::BidiPermissionsAgent::BidiPermissionsAgent): (WebKit::allPageProxiesFor): (WebKit::BidiPermissionsAgent::setPermission): Added. Defer to WebSiteDataStore and NetworkProcess for the actual implementation. * Source/WebKit/UIProcess/Automation/BidiPermissionsAgent.h: Added. * Source/WebKit/UIProcess/Automation/WebDriverBidiProcessor.cpp: (WebKit::WebDriverBidiProcessor::WebDriverBidiProcessor): Add BidiPermissionAgent. * Source/WebKit/UIProcess/Automation/WebDriverBidiProcessor.h: * Source/WebKit/UIProcess/Automation/protocol/BidiPermissions.json: Added. * Source/WebKit/WebKit.xcodeproj/project.pbxproj: Add new domain and associated derived sources and project entries. Canonical link: https://commits.webkit.org/299547@main

webkit-commit-queue · 2025-09-04T09:07:24Z

Committed 299547@main (19e1927): https://commits.webkit.org/299547@main

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

burg requested a review from cdumez as a code owner August 21, 2025 00:21

burg self-assigned this Aug 21, 2025

burg added the Tools / Tests Tools in the Tools directory, build issues, test infrastructure, and bugs in test cases label Aug 21, 2025

burg requested review from sysrqb, charliewolfe, annevk, dcrousso, yury-s, patrickangle, the-chenergy and AnujPanta1 August 23, 2025 20:25

dcrousso reviewed Aug 25, 2025

View reviewed changes

the-chenergy reviewed Aug 25, 2025

View reviewed changes

Source/WebKit/UIProcess/Automation/BidiPermissionsAgent.cpp Show resolved Hide resolved

the-chenergy reviewed Aug 25, 2025

View reviewed changes

burg force-pushed the eng/bburg/wk265521-webdriver-bidi-set-permission branch from e7a9ddc to 10c0b6f Compare August 26, 2025 18:41

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

AnujPanta1 reviewed Aug 27, 2025

View reviewed changes

charliewolfe approved these changes Aug 27, 2025

View reviewed changes

AnujPanta1 reviewed Aug 27, 2025

View reviewed changes

burg removed the merging-blocked Applied to prevent a change from being merged label Aug 28, 2025

burg force-pushed the eng/bburg/wk265521-webdriver-bidi-set-permission branch from 10c0b6f to 4230afb Compare August 28, 2025 18:21

burg changed the title ~~[WebDriver BiDi] add support for permissions.setPermission command~~ Web Automation: add support for permissions.setPermission command Aug 28, 2025

burg added the merge-queue Applied to send a pull request to merge-queue label Aug 28, 2025

webkit-commit-queue removed the merge-queue Applied to send a pull request to merge-queue label Aug 28, 2025

webkit-commit-queue added the merging-blocked Applied to prevent a change from being merged label Aug 28, 2025

burg removed the merging-blocked Applied to prevent a change from being merged label Sep 4, 2025

burg changed the title ~~Web Automation: add support for permissions.setPermission command~~ Web Automation: implement Set Storage Access endpoint Sep 4, 2025

burg force-pushed the eng/bburg/wk265521-webdriver-bidi-set-permission branch from 4230afb to a0fdd11 Compare September 4, 2025 01:56

burg added New Bugs Unclassified bugs are placed in this component until the correct component can be determined. and removed Tools / Tests Tools in the Tools directory, build issues, test infrastructure, and bugs in test cases labels Sep 4, 2025

burg added the merge-queue Applied to send a pull request to merge-queue label Sep 4, 2025

webkit-commit-queue force-pushed the eng/bburg/wk265521-webdriver-bidi-set-permission branch from a0fdd11 to 19e1927 Compare September 4, 2025 09:07

webkit-commit-queue merged commit 19e1927 into WebKit:main Sep 4, 2025

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

	page->protectedWebsiteDataStore()->setStorageAccessPermissionForTesting(granted, page->identifier(), topFrameOrigin.string(), (embeddedOriginIsWildcard ? topFrameOrigin : embeddedOrigin).string(), [aggregator] () { });
	page->protectedWebsiteDataStore()->setStorageAccessPermissionForTesting(granted, page->identifier(), topFrameOrigin.string(), (embeddedOriginIsWildcard ? topFrameOrigin : embeddedOrigin).string(), [aggregator]() { });

Web Automation: implement Set Storage Access endpoint #49692

Web Automation: implement Set Storage Access endpoint #49692

Uh oh!

Conversation

burg commented Aug 21, 2025 • edited by webkit-early-warning-system Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

19e1927

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

the-chenergy Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

the-chenergy Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

burg Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

AnujPanta1 Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

AnujPanta1 Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

burg Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

charliewolfe commented Aug 27, 2025

Uh oh!

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

Uh oh!

Uh oh!

webkit-commit-queue commented Aug 28, 2025

Uh oh!

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

Uh oh!

Uh oh!

webkit-commit-queue commented Sep 4, 2025

Uh oh!

Uh oh!

burg commented Aug 21, 2025 •

edited by webkit-early-warning-system

Loading

`19e1927`

webkit-early-warning-system commented Aug 21, 2025 •

edited

Loading

the-chenergy Aug 25, 2025 •

edited

Loading

webkit-early-warning-system commented Aug 26, 2025 •

edited

Loading

webkit-early-warning-system commented Aug 28, 2025 •

edited

Loading

webkit-early-warning-system commented Sep 4, 2025 •

edited

Loading