Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Remote Inspection] Add SPI to make it possible to inspect content under targeted elements #26328

Merged
merged 1 commit into from
Mar 22, 2024
Merged

[Remote Inspection] Add SPI to make it possible to inspect content under targeted elements #26328

merged 1 commit into from
Mar 22, 2024

Conversation

whsieh
Copy link
Member

@whsieh whsieh commented Mar 22, 2024 •
edited by webkit-early-warning-system
Loading

10f56d8

[Remote Inspection] Add SPI to make it possible to inspect content under targeted elements
https://bugs.webkit.org/show_bug.cgi?id=271475

Reviewed by Aditya Keerthi.

Introduce `-_adjustVisibilityForTargetedElements:completionHandler:`, and hook it up to the newly-
landed visibility adjustment infrastructure in WebCore. See below for more details.

* LayoutTests/TestExpectations:
* LayoutTests/fast/element-targeting/basic-element-targeting-expected.html: Added.
* LayoutTests/fast/element-targeting/basic-element-targeting.html: Added.
* LayoutTests/platform/ios-wk2/TestExpectations:
* LayoutTests/platform/mac-wk2/TestExpectations:

Add a test directory (and basic test) to exercise this new SPI.

* LayoutTests/resources/ui-helper.js:
(window.UIHelper.requestRenderedTextForSelector):
(window.UIHelper.adjustVisibilityForFrontmostTarget):
(window.UIHelper):

Add a testing hook that allows layout tests to exercise element targeting.

* Source/WebCore/page/ElementTargeting.cpp:
(WebCore::setNeedsVisibilityAdjustmentRecursive):
(WebCore::adjustVisibilityForTargetedElements):
* Source/WebCore/page/ElementTargeting.h:
* Source/WebKit/UIProcess/API/Cocoa/WKWebView.mm:
(-[WKWebView _adjustVisibilityForTargetedElements:completionHandler:]):
* Source/WebKit/UIProcess/API/Cocoa/WKWebViewPrivate.h:
* Source/WebKit/UIProcess/WebPageProxy.cpp:
(WebKit::WebPageProxy::adjustVisibilityForTargetedElements):

Add plumbing through `WebPageProxy` and `WebPage`, down into WebCore.

* Source/WebKit/UIProcess/WebPageProxy.h:
* Source/WebKit/WebProcess/WebPage/WebPage.cpp:
(WebKit::WebPage::adjustVisibilityForTargetedElements):
* Source/WebKit/WebProcess/WebPage/WebPage.h:
* Source/WebKit/WebProcess/WebPage/WebPage.messages.in:
* Tools/TestRunnerShared/UIScriptContext/Bindings/UIScriptController.idl:
* Tools/TestRunnerShared/UIScriptContext/UIScriptController.h:
(WTR::UIScriptController::adjustVisibilityForFrontmostTarget):
* Tools/WebKitTestRunner/cocoa/UIScriptControllerCocoa.h:
* Tools/WebKitTestRunner/cocoa/UIScriptControllerCocoa.mm:
(WTR::UIScriptControllerCocoa::adjustVisibilityForFrontmostTarget):

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

108c944

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

@whsieh whsieh self-assigned this Mar 22, 2024
@whsieh whsieh added the Platform Portability improvements and other general platform improvements not driven directly by site bugs. label Mar 22, 2024
@webkit-early-warning-system
Copy link
Collaborator

webkit-early-warning-system commented Mar 22, 2024 •
edited
Loading

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

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

@webkit-ews-buildbot webkit-ews-buildbot added the merging-blocked Applied to prevent a change from being merged label Mar 22, 2024
@whsieh whsieh removed the merging-blocked Applied to prevent a change from being merged label Mar 22, 2024
@webkit-early-warning-system
Copy link
Collaborator

webkit-early-warning-system commented Mar 22, 2024 •
edited
Loading

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

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

@webkit-ews-buildbot webkit-ews-buildbot added the merging-blocked Applied to prevent a change from being merged label Mar 22, 2024
@whsieh whsieh removed the merging-blocked Applied to prevent a change from being merged label Mar 22, 2024
@webkit-early-warning-system
Copy link
Collaborator

webkit-early-warning-system commented Mar 22, 2024 •
edited
Loading

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

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

@webkit-early-warning-system
Copy link
Collaborator

webkit-early-warning-system commented Mar 22, 2024 •
edited
Loading

EWS run on current version of this PR (hash 108c944)

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

szewai
szewai reviewed Mar 22, 2024
View reviewed changes
Source/WebCore/page/ElementTargeting.cpp
Comment on lines +362 to +367
bool changed = false;
for (auto& element : elements) {
if (setNeedsVisibilityAdjustmentRecursive(element))
changed = true;
}
return changed;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

return WTF::anyOf(elements, [&] (auto& element) {
    return setNeedsVisibilityAdjustmentRecursive(element);
});

Copy link
Member Author

@whsieh whsieh Mar 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's actually not quite what I want (since I want to continue calling setNeedsVisibilityAdjustmentRecursive on the full list of elements, even if changed already becomes true). I'll leave this as-is (unless there's another more elegant way to write this?)

(Edit: to clarify, WTF::anyOf will bail early when the lambda returns true on the first element)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah got it; sounds good!

@whsieh whsieh added the merge-queue Applied to send a pull request to merge-queue label Mar 22, 2024
@whsieh
[Remote Inspection] Add SPI to make it possible to inspect content un…
10f56d8 
…der targeted elements

https://bugs.webkit.org/show_bug.cgi?id=271475

Reviewed by Aditya Keerthi.

Introduce `-_adjustVisibilityForTargetedElements:completionHandler:`, and hook it up to the newly-
landed visibility adjustment infrastructure in WebCore. See below for more details.

* LayoutTests/TestExpectations:
* LayoutTests/fast/element-targeting/basic-element-targeting-expected.html: Added.
* LayoutTests/fast/element-targeting/basic-element-targeting.html: Added.
* LayoutTests/platform/ios-wk2/TestExpectations:
* LayoutTests/platform/mac-wk2/TestExpectations:

Add a test directory (and basic test) to exercise this new SPI.

* LayoutTests/resources/ui-helper.js:
(window.UIHelper.requestRenderedTextForSelector):
(window.UIHelper.adjustVisibilityForFrontmostTarget):
(window.UIHelper):

Add a testing hook that allows layout tests to exercise element targeting.

* Source/WebCore/page/ElementTargeting.cpp:
(WebCore::setNeedsVisibilityAdjustmentRecursive):
(WebCore::adjustVisibilityForTargetedElements):
* Source/WebCore/page/ElementTargeting.h:
* Source/WebKit/UIProcess/API/Cocoa/WKWebView.mm:
(-[WKWebView _adjustVisibilityForTargetedElements:completionHandler:]):
* Source/WebKit/UIProcess/API/Cocoa/WKWebViewPrivate.h:
* Source/WebKit/UIProcess/WebPageProxy.cpp:
(WebKit::WebPageProxy::adjustVisibilityForTargetedElements):

Add plumbing through `WebPageProxy` and `WebPage`, down into WebCore.

* Source/WebKit/UIProcess/WebPageProxy.h:
* Source/WebKit/WebProcess/WebPage/WebPage.cpp:
(WebKit::WebPage::adjustVisibilityForTargetedElements):
* Source/WebKit/WebProcess/WebPage/WebPage.h:
* Source/WebKit/WebProcess/WebPage/WebPage.messages.in:
* Tools/TestRunnerShared/UIScriptContext/Bindings/UIScriptController.idl:
* Tools/TestRunnerShared/UIScriptContext/UIScriptController.h:
(WTR::UIScriptController::adjustVisibilityForFrontmostTarget):
* Tools/WebKitTestRunner/cocoa/UIScriptControllerCocoa.h:
* Tools/WebKitTestRunner/cocoa/UIScriptControllerCocoa.mm:
(WTR::UIScriptControllerCocoa::adjustVisibilityForFrontmostTarget):

Canonical link: https://commits.webkit.org/276573@main
@webkit-commit-queue
Copy link
Collaborator

Committed 276573@main (10f56d8): https://commits.webkit.org/276573@main

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

@webkit-commit-queue webkit-commit-queue merged commit 10f56d8 into WebKit:main Mar 22, 2024
@webkit-commit-queue webkit-commit-queue removed the merge-queue Applied to send a pull request to merge-queue label Mar 22, 2024
@whsieh whsieh deleted the eng/271475 branch March 22, 2024 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@szewai szewai szewai left review comments

@pxlcoder pxlcoder pxlcoder approved these changes

@cdumez cdumez Awaiting requested review from cdumez cdumez is a code owner

@JonWBedard JonWBedard Awaiting requested review from JonWBedard JonWBedard is a code owner

@hortont424 hortont424 Awaiting requested review from hortont424

@rr-codes rr-codes Awaiting requested review from rr-codes

@aprotyas aprotyas Awaiting requested review from aprotyas

@megangardner megangardner Awaiting requested review from megangardner

Assignees

@whsieh whsieh

Labels
Platform Portability improvements and other general platform improvements not driven directly by site bugs.
Projects
None yet
Milestone
No milestone
6 participants
@whsieh @webkit-early-warning-system @webkit-commit-queue @pxlcoder @szewai @webkit-ews-buildbot