Implement declarativeNetRequest.setExtensionActionOptions #21305

b-weinstein · 2023-12-04T23:42:42Z

`c26e66f`

Implement declarativeNetRequest.setExtensionActionOptions
https://bugs.webkit.org/show_bug.cgi?id=265829
rdar://118476776

Reviewed by Timothy Hatcher.

This API has two use cases:
1) To opt an extension into a behavior where the extension's action shows the number of blocked resources on the current page
2) To manually increment or decrement this badged number

It's a bit unfortunate that these two disparate behaviors are combined into one API, but here we are. This PR implements both of
them and adds tests for them.

* Source/WebKit/UIProcess/Cocoa/NavigationState.mm:
(WebKit::NavigationState::NavigationClient::contentRuleListNotification): Call into the WebExtensionController.
* Source/WebKit/UIProcess/Extensions/Cocoa/API/WebExtensionContextAPIDeclarativeNetRequestCocoa.mm:
(WebKit::WebExtensionContext::shouldDisplayBlockedResourceCountAsBadgeText): Returns whether or not the blocked resource count should be the badge text.
(WebKit::WebExtensionContext::saveShouldDisplayBlockedResourceCountAsBadgeText): Sets whether or not the blocked resource count should be the badge
text, and saves to disk.
(WebKit::WebExtensionContext::incrementActionCountForTab): Get the action for the tab and increment the blocked resource count.
(WebKit::WebExtensionContext::declarativeNetRequestDisplayActionCountAsBadgeText): Call saveShouldDisplayBlockedResourceCountAsBadgeText with the new value, and
clear any blocked resource counts if the flag is turned off.
(WebKit::WebExtensionContext::declarativeNetRequestIncrementActionCount): Call into incrementActionCountForTab after finding the tab.
* Source/WebKit/UIProcess/Extensions/Cocoa/WebExtensionActionCocoa.mm:
(WebKit::WebExtensionAction::clearCustomizations): Clear the blocked resource count.
(WebKit::WebExtensionAction::clearBlockedResourceCount): Ditto.
(WebKit::WebExtensionAction::badgeText const): If we have a blocked resource count - use it as the badge text.
(WebKit::WebExtensionAction::incrementBlockedResourceCount): Modify the blocked resource count member variable.
* Source/WebKit/UIProcess/Extensions/Cocoa/WebExtensionControllerCocoa.mm:
(WebKit::WebExtensionController::handleContentRuleListNotification): Iterate over all of the actions, find the extension if it exists, and call incrementActionCountForTab.
* Source/WebKit/UIProcess/Extensions/WebExtensionAction.h:
* Source/WebKit/UIProcess/Extensions/WebExtensionContext.h:
* Source/WebKit/UIProcess/Extensions/WebExtensionContext.messages.in:
* Source/WebKit/UIProcess/Extensions/WebExtensionController.h:
* Source/WebKit/WebProcess/Extensions/API/Cocoa/WebExtensionAPIDeclarativeNetRequestCocoa.mm:
(WebKit::WebExtensionAPIDeclarativeNetRequest::setExtensionActionOptions): Perform object validation and call into the UI process based on if flavor (1) or (2) was called.
* Tools/TestWebKitAPI/Tests/WebKitCocoa/WKWebExtensionAPIDeclarativeNetRequest.mm:
(TestWebKitAPI::TEST):

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

dfb2ff0

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~~	✅ 🛠 gtk
	✅ 🧪 api-ios	~~🧪 mac-wk2~~	~~🧪 gtk-wk2~~
	~~🛠 tv~~	~~🧪 mac-AS-debug-wk2~~	~~🧪 api-gtk~~
	✅ 🛠 tv-sim
✅ 🛠 🧪 merge	✅ 🛠 watch
	✅ 🛠 watch-sim

webkit-early-warning-system · 2023-12-04T23:42:57Z

EWS run on previous version of this PR (hash 4791e6b)

Details

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	✅ 🛠 gtk
	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 tv	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 api-gtk
	✅ 🛠 tv-sim
	✅ 🛠 watch
	✅ 🛠 watch-sim

...ce/WebKit/UIProcess/Extensions/Cocoa/API/WebExtensionContextAPIDeclarativeNetRequestCocoa.mm

xeenon · 2023-12-04T23:52:58Z

Source/WebKit/UIProcess/Extensions/Cocoa/WebExtensionActionCocoa.mm

Should this still take the count to zero? What do other browsers do?

I think it should be able to take it to zero - that would clear the badge text.

I mean, if m_blockedResourceCount is 1, and amount is -2, should it just reset m_blockedResourceCount to 0? Right now it will stay at 1 with the return.

I will see what Chrome does.

What you described is what Chrome does. I will make that change.

xeenon · 2023-12-04T23:54:00Z

Source/WebKit/UIProcess/Extensions/Cocoa/WebExtensionControllerCocoa.mm

You should move this out of the loops, since it is the same for all results.

Is it? Getting the tab seems to require the context, and what happens if one specific extension doesn't have access to a tab?

If they are the same, then I'm fine moving this out of the loop - how would you recommend getting the tab for one particular extension?

Source/WebKit/UIProcess/Extensions/WebExtensionAction.h

Tools/TestWebKitAPI/TestWebKitAPI.xcodeproj/xcshareddata/xcschemes/TestWebKitAPI.xcscheme

webkit-early-warning-system · 2023-12-05T17:37:01Z

Starting EWS tests for 5b216e1. Live statuses available at the PR page, #21305

webkit-early-warning-system · 2023-12-05T17:37:02Z

EWS run on previous version of this PR (hash 5b216e1)

Details

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~~	✅ 🛠 gtk
⏳ 🛠 🧪 jsc	✅ 🧪 api-ios	~~🧪 mac-wk2~~	⏳ 🧪 gtk-wk2
⏳ 🛠 🧪 jsc-arm64	⏳ 🛠 tv	⏳ 🧪 mac-AS-debug-wk2	⏳ 🧪 api-gtk
	✅ 🛠 tv-sim
~~🛠 🧪 merge~~	✅ 🛠 watch
	⏳ 🛠 watch-sim

webkit-early-warning-system · 2023-12-05T18:15:11Z

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

Details

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~~	✅ 🛠 gtk
	✅ 🧪 api-ios	~~🧪 mac-wk2~~	~~🧪 gtk-wk2~~
	~~🛠 tv~~	~~🧪 mac-AS-debug-wk2~~	~~🧪 api-gtk~~
	✅ 🛠 tv-sim
✅ 🛠 🧪 merge	✅ 🛠 watch
	✅ 🛠 watch-sim

https://bugs.webkit.org/show_bug.cgi?id=265829 rdar://118476776 Reviewed by Timothy Hatcher. This API has two use cases: 1) To opt an extension into a behavior where the extension's action shows the number of blocked resources on the current page 2) To manually increment or decrement this badged number It's a bit unfortunate that these two disparate behaviors are combined into one API, but here we are. This PR implements both of them and adds tests for them. * Source/WebKit/UIProcess/Cocoa/NavigationState.mm: (WebKit::NavigationState::NavigationClient::contentRuleListNotification): Call into the WebExtensionController. * Source/WebKit/UIProcess/Extensions/Cocoa/API/WebExtensionContextAPIDeclarativeNetRequestCocoa.mm: (WebKit::WebExtensionContext::shouldDisplayBlockedResourceCountAsBadgeText): Returns whether or not the blocked resource count should be the badge text. (WebKit::WebExtensionContext::saveShouldDisplayBlockedResourceCountAsBadgeText): Sets whether or not the blocked resource count should be the badge text, and saves to disk. (WebKit::WebExtensionContext::incrementActionCountForTab): Get the action for the tab and increment the blocked resource count. (WebKit::WebExtensionContext::declarativeNetRequestDisplayActionCountAsBadgeText): Call saveShouldDisplayBlockedResourceCountAsBadgeText with the new value, and clear any blocked resource counts if the flag is turned off. (WebKit::WebExtensionContext::declarativeNetRequestIncrementActionCount): Call into incrementActionCountForTab after finding the tab. * Source/WebKit/UIProcess/Extensions/Cocoa/WebExtensionActionCocoa.mm: (WebKit::WebExtensionAction::clearCustomizations): Clear the blocked resource count. (WebKit::WebExtensionAction::clearBlockedResourceCount): Ditto. (WebKit::WebExtensionAction::badgeText const): If we have a blocked resource count - use it as the badge text. (WebKit::WebExtensionAction::incrementBlockedResourceCount): Modify the blocked resource count member variable. * Source/WebKit/UIProcess/Extensions/Cocoa/WebExtensionControllerCocoa.mm: (WebKit::WebExtensionController::handleContentRuleListNotification): Iterate over all of the actions, find the extension if it exists, and call incrementActionCountForTab. * Source/WebKit/UIProcess/Extensions/WebExtensionAction.h: * Source/WebKit/UIProcess/Extensions/WebExtensionContext.h: * Source/WebKit/UIProcess/Extensions/WebExtensionContext.messages.in: * Source/WebKit/UIProcess/Extensions/WebExtensionController.h: * Source/WebKit/WebProcess/Extensions/API/Cocoa/WebExtensionAPIDeclarativeNetRequestCocoa.mm: (WebKit::WebExtensionAPIDeclarativeNetRequest::setExtensionActionOptions): Perform object validation and call into the UI process based on if flavor (1) or (2) was called. * Tools/TestWebKitAPI/Tests/WebKitCocoa/WKWebExtensionAPIDeclarativeNetRequest.mm: (TestWebKitAPI::TEST): Canonical link: https://commits.webkit.org/271561@main

webkit-commit-queue · 2023-12-05T19:13:26Z

Committed 271561@main (c26e66f): https://commits.webkit.org/271561@main

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

b-weinstein requested review from cdumez and xeenon as code owners December 4, 2023 23:42

b-weinstein self-assigned this Dec 4, 2023

b-weinstein added the WebKit Extensions Bugs related to extension support. label Dec 4, 2023

xeenon reviewed Dec 4, 2023

View reviewed changes

...ce/WebKit/UIProcess/Extensions/Cocoa/API/WebExtensionContextAPIDeclarativeNetRequestCocoa.mm Outdated Show resolved Hide resolved

xeenon reviewed Dec 4, 2023

View reviewed changes

...ce/WebKit/UIProcess/Extensions/Cocoa/API/WebExtensionContextAPIDeclarativeNetRequestCocoa.mm Outdated Show resolved Hide resolved

xeenon reviewed Dec 4, 2023

View reviewed changes

Source/WebKit/UIProcess/Extensions/WebExtensionAction.h Outdated Show resolved Hide resolved

xeenon reviewed Dec 4, 2023

View reviewed changes

Tools/TestWebKitAPI/TestWebKitAPI.xcodeproj/xcshareddata/xcschemes/TestWebKitAPI.xcscheme Outdated Show resolved Hide resolved

xeenon approved these changes Dec 4, 2023

View reviewed changes

webkit-ews-buildbot added the merging-blocked Applied to prevent a change from being merged label Dec 5, 2023

b-weinstein force-pushed the eng/Implement-declarativeNetRequest-setExtensionActionOptions branch from 4791e6b to 5b216e1 Compare December 5, 2023 17:36

b-weinstein added the merge-queue Applied to send a pull request to merge-queue label Dec 5, 2023

b-weinstein removed merging-blocked Applied to prevent a change from being merged merge-queue Applied to send a pull request to merge-queue labels Dec 5, 2023

b-weinstein force-pushed the eng/Implement-declarativeNetRequest-setExtensionActionOptions branch from 5b216e1 to dfb2ff0 Compare December 5, 2023 18:15

b-weinstein added the merge-queue Applied to send a pull request to merge-queue label Dec 5, 2023

webkit-commit-queue force-pushed the eng/Implement-declarativeNetRequest-setExtensionActionOptions branch from dfb2ff0 to c26e66f Compare December 5, 2023 19:13

webkit-commit-queue merged commit c26e66f into WebKit:main Dec 5, 2023

webkit-commit-queue removed the merge-queue Applied to send a pull request to merge-queue label Dec 5, 2023

Implement declarativeNetRequest.setExtensionActionOptions #21305

Implement declarativeNetRequest.setExtensionActionOptions #21305

Uh oh!

Conversation

b-weinstein commented Dec 4, 2023 • edited by webkit-early-warning-system Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

c26e66f

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xeenon Dec 4, 2023

Choose a reason for hiding this comment

Uh oh!

b-weinstein Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

xeenon Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

b-weinstein Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

b-weinstein Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

xeenon Dec 4, 2023 • 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!

b-weinstein Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

webkit-early-warning-system commented Dec 5, 2023

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

webkit-commit-queue commented Dec 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

b-weinstein commented Dec 4, 2023 •

edited by webkit-early-warning-system

Loading

`c26e66f`

webkit-early-warning-system commented Dec 4, 2023 •

edited

Loading

xeenon Dec 4, 2023 •

edited

Loading

webkit-early-warning-system commented Dec 5, 2023 •

edited

Loading

webkit-early-warning-system commented Dec 5, 2023 •

edited

Loading