Changeset 287040 in webkit

Timestamp:

Dec 14, 2021, 12:11:03 PM (5 years ago)

Author:

achristensen@apple.com

Message:

Add _WKContentRuleListAction.redirected and .modifiedHeaders
​https://bugs.webkit.org/show_bug.cgi?id=234289

Reviewed by Tim Hatcher.

Source/WebCore:

These inform the UI process about new actions taken by the extension.

• contentextensions/ContentExtensionsBackend.cpp:

(WebCore::ContentExtensions::ContentExtensionsBackend::processContentRuleListsForLoad):
(WebCore::ContentExtensions::applyResultsToRequest):

• contentextensions/ContentRuleListResults.h:

(WebCore::ContentRuleListResults::shouldNotifyApplication const):
(WebCore::ContentRuleListResults::Result::encode const):
(WebCore::ContentRuleListResults::Result::decode):
(WebCore::ContentRuleListResults::Result::shouldNotifyApplication const): Deleted.

Source/WebKit:

• UIProcess/API/APIContentRuleListAction.cpp:

(API::ContentRuleListAction::redirected const):
(API::ContentRuleListAction::modifiedHeaders const):

• UIProcess/API/APIContentRuleListAction.h:
• UIProcess/API/Cocoa/_WKContentRuleListAction.h:
• UIProcess/API/Cocoa/_WKContentRuleListAction.mm:

(-[_WKContentRuleListAction redirected]):
(-[_WKContentRuleListAction modifiedHeaders]):

• WebProcess/WebCoreSupport/WebChromeClient.cpp:

(WebKit::WebChromeClient::contentRuleListNotification):

Tools:

• TestWebKitAPI/Tests/WebKitCocoa/WKContentExtensionStore.mm:

(checkURLs):
(TEST_F):

• TestWebKitAPI/cocoa/TestNavigationDelegate.h:
• TestWebKitAPI/cocoa/TestNavigationDelegate.mm:

(-[TestNavigationDelegate _webView:contentRuleListWithIdentifier:performedAction:forURL:]):

Location:

trunk

Files:

• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/contentextensions/ContentExtensionsBackend.cpp (modified) (1 diff)
• Source/WebCore/contentextensions/ContentRuleListResults.h (modified) (6 diffs)
• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/UIProcess/API/APIContentRuleListAction.cpp (modified) (1 diff)
• Source/WebKit/UIProcess/API/APIContentRuleListAction.h (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/_WKContentRuleListAction.h (modified) (1 diff)
• Source/WebKit/UIProcess/API/Cocoa/_WKContentRuleListAction.mm (modified) (1 diff)
• Source/WebKit/WebProcess/WebCoreSupport/WebChromeClient.cpp (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitCocoa/WKContentExtensionStore.mm (modified) (5 diffs)
• Tools/TestWebKitAPI/cocoa/TestNavigationDelegate.h (modified) (2 diffs)
• Tools/TestWebKitAPI/cocoa/TestNavigationDelegate.mm (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2021-12-14  Alex Christensen  <achristensen@webkit.org>
+
+        Add _WKContentRuleListAction.redirected and .modifiedHeaders
+        https://bugs.webkit.org/show_bug.cgi?id=234289
+
+        Reviewed by Tim Hatcher.
+
+        These inform the UI process about new actions taken by the extension.
+
+        * contentextensions/ContentExtensionsBackend.cpp:
+        (WebCore::ContentExtensions::ContentExtensionsBackend::processContentRuleListsForLoad):
+        (WebCore::ContentExtensions::applyResultsToRequest):
+        * contentextensions/ContentRuleListResults.h:
+        (WebCore::ContentRuleListResults::shouldNotifyApplication const):
+        (WebCore::ContentRuleListResults::Result::encode const):
+        (WebCore::ContentRuleListResults::Result::decode):
+        (WebCore::ContentRuleListResults::Result::shouldNotifyApplication const): Deleted.
+
 2021-12-14  Tyler Wilcock  <tyler_w@apple.com>
 

trunk/Source/WebCore/contentextensions/ContentExtensionsBackend.cpp

@@ -249 +249 @@
                 RELEASE_ASSERT_NOT_REACHED();
             }, [&] (const ModifyHeadersAction& action) {
-                if (initiatingDocumentLoader.allowsActiveContentRuleListActionsForURL(contentRuleListIdentifier, url))
+                if (initiatingDocumentLoader.allowsActiveContentRuleListActionsForURL(contentRuleListIdentifier, url)) {
+                    result.modifiedHeaders = true;
                     results.summary.modifyHeadersActions.append(action);
+                }
             }, [&] (const RedirectAction& redirectAction) {
-                if (initiatingDocumentLoader.allowsActiveContentRuleListActionsForURL(contentRuleListIdentifier, url))
+                if (initiatingDocumentLoader.allowsActiveContentRuleListActionsForURL(contentRuleListIdentifier, url)) {
+                    result.redirected = true;
                     results.summary.redirectActions.append({ redirectAction, m_contentExtensions.get(contentRuleListIdentifier)->extensionBaseURL() });
+                }
             }), action.data());
         }

trunk/Source/WebCore/contentextensions/ContentRuleListResults.h

@@ -40 +40 @@
         bool madeHTTPS { false };
         bool blockedCookies { false };
+        bool modifiedHeaders { false };
+        bool redirected { false };
         Vector<String> notifications;
         
@@ -47 +49 @@
                 || madeHTTPS
                 || blockedCookies
+                || modifiedHeaders
+                || redirected
                 || !notifications.isEmpty();
         }
@@ -74 +78 @@
             || summary.madeHTTPS
             || summary.blockedCookies
+            || !summary.modifyHeadersActions.isEmpty()
+            || !summary.redirectActions.isEmpty()
             || summary.hasNotifications;
     }
@@ -106 +112 @@
     encoder << madeHTTPS;
     encoder << blockedCookies;
+    encoder << modifiedHeaders;
+    encoder << redirected;
     encoder << notifications;
 }
@@ -124 +132 @@
     decoder >> blockedCookies;
     if (!blockedCookies)
+        return std::nullopt;
+    
+    std::optional<bool> modifiedHeaders;
+    decoder >> modifiedHeaders;
+    if (!modifiedHeaders)
+        return std::nullopt;
+    
+    std::optional<bool> redirected;
+    decoder >> redirected;
+    if (!redirected)
         return std::nullopt;
     
@@ -135 +153 @@
         WTFMove(*madeHTTPS),
         WTFMove(*blockedCookies),
+        WTFMove(*modifiedHeaders),
+        WTFMove(*redirected),
         WTFMove(*notifications)
     }};

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2021-12-14  Alex Christensen  <achristensen@webkit.org>
+
+        Add _WKContentRuleListAction.redirected and .modifiedHeaders
+        https://bugs.webkit.org/show_bug.cgi?id=234289
+
+        Reviewed by Tim Hatcher.
+
+        * UIProcess/API/APIContentRuleListAction.cpp:
+        (API::ContentRuleListAction::redirected const):
+        (API::ContentRuleListAction::modifiedHeaders const):
+        * UIProcess/API/APIContentRuleListAction.h:
+        * UIProcess/API/Cocoa/_WKContentRuleListAction.h:
+        * UIProcess/API/Cocoa/_WKContentRuleListAction.mm:
+        (-[_WKContentRuleListAction redirected]):
+        (-[_WKContentRuleListAction modifiedHeaders]):
+        * WebProcess/WebCoreSupport/WebChromeClient.cpp:
+        (WebKit::WebChromeClient::contentRuleListNotification):
+
 2021-12-14  Alex Christensen  <achristensen@webkit.org>
 

trunk/Source/WebKit/UIProcess/API/APIContentRuleListAction.cpp

@@ -58 +58 @@
 }
 
+bool ContentRuleListAction::redirected() const
+{
+    return m_result.redirected;
+}
+
+bool ContentRuleListAction::modifiedHeaders() const
+{
+    return m_result.modifiedHeaders;
+}
+
 const Vector<WTF::String>& ContentRuleListAction::notifications() const
 {

trunk/Source/WebKit/UIProcess/API/APIContentRuleListAction.h

@@ -41 +41 @@
     bool madeHTTPS() const;
     bool blockedCookies() const;
+    bool redirected() const;
+    bool modifiedHeaders() const;
     const Vector<WTF::String>& notifications() const;
 

trunk/Source/WebKit/UIProcess/API/Cocoa/_WKContentRuleListAction.h

@@ -33 +33 @@
 @property (nonatomic, readonly) BOOL blockedCookies;
 @property (nonatomic, readonly) BOOL madeHTTPS;
+@property (nonatomic, readonly) BOOL redirected WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
+@property (nonatomic, readonly) BOOL modifiedHeaders WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
 @property (nonatomic, readonly, copy) NSArray<NSString *> *notifications;
 

trunk/Source/WebKit/UIProcess/API/Cocoa/_WKContentRuleListAction.mm

@@ -69 +69 @@
 }
 
+- (BOOL)redirected
+{
+#if ENABLE(CONTENT_EXTENSIONS)
+    return _action->redirected();
+#else
+    return NO;
+#endif
+}
+
+- (BOOL)modifiedHeaders
+{
+#if ENABLE(CONTENT_EXTENSIONS)
+    return _action->modifiedHeaders();
+#else
+    return NO;
+#endif
+}
+
 - (NSArray<NSString *> *)notifications
 {

trunk/Source/WebKit/WebProcess/WebCoreSupport/WebChromeClient.cpp

@@ -1003 +1003 @@
 {
 #if ENABLE(CONTENT_EXTENSIONS)
-    ASSERT(results.shouldNotifyApplication());
     m_page.send(Messages::WebPageProxy::ContentRuleListNotification(url, results));
 #endif

trunk/Tools/ChangeLog

@@ +1 @@
+2021-12-14  Alex Christensen  <achristensen@webkit.org>
+
+        Add _WKContentRuleListAction.redirected and .modifiedHeaders
+        https://bugs.webkit.org/show_bug.cgi?id=234289
+
+        Reviewed by Tim Hatcher.
+
+        * TestWebKitAPI/Tests/WebKitCocoa/WKContentExtensionStore.mm:
+        (checkURLs):
+        (TEST_F):
+        * TestWebKitAPI/cocoa/TestNavigationDelegate.h:
+        * TestWebKitAPI/cocoa/TestNavigationDelegate.mm:
+        (-[TestNavigationDelegate _webView:contentRuleListWithIdentifier:performedAction:forURL:]):
+
 2021-12-14  Alex Christensen  <achristensen@webkit.org>
 

trunk/Tools/TestWebKitAPI/Tests/WebKitCocoa/WKContentExtensionStore.mm

@@ -35 +35 @@
 #import <WebKit/WKUserContentControllerPrivate.h>
 #import <WebKit/WKWebpagePreferencesPrivate.h>
+#import <WebKit/_WKContentRuleListAction.h>
 #import <WebKit/_WKUserContentExtensionStore.h>
 #import <WebKit/_WKUserContentFilter.h>
 #import <wtf/RetainPtr.h>
 #import <wtf/Vector.h>
+#import <wtf/text/WTFString.h>
 
 class WKContentRuleListStoreTest : public testing::Test {
@@ -504 +506 @@
     };
     return delegate;
+}
+
+static void checkURLs(const Vector<String>& actual, const Vector<String>& expected)
+{
+    EXPECT_EQ(actual.size(), expected.size());
+    for (size_t i = 0; i < std::min(actual.size(), expected.size()); i++)
+        EXPECT_WK_STREQ(actual[i], expected[i]);
 }
 
@@ -563 +572 @@
     [configuration setURLSchemeHandler:handler.get() forURLScheme:@"testscheme"];
     auto webView = adoptNS([[WKWebView alloc] initWithFrame:NSZeroRect configuration:configuration.get()]);
-    webView.get().navigationDelegate = navigationDelegateAllowingActiveActionsOnTestHost().get();
+    auto delegate = navigationDelegateAllowingActiveActionsOnTestHost().get();
+    webView.get().navigationDelegate = delegate;
+    __block bool receivedActionNotification { false };
+    __block Vector<String> urls;
+    delegate.contentRuleListPerformedAction = ^(WKWebView *, NSString *identifier, _WKContentRuleListAction *action, NSURL *url) {
+        urls.append(url.absoluteString);
+        EXPECT_TRUE(action.modifiedHeaders);
+        receivedActionNotification = true;
+    };
     [webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"testscheme://testhost/main.html"]]];
     TestWebKitAPI::Util::run(&receivedAllRequests);
+    TestWebKitAPI::Util::run(&receivedActionNotification);
+    checkURLs(urls, {
+        "testscheme://testhost/main.html",
+        "testscheme://testhost/fetch.txt"
+    });
     
     // FIXME: Appending to the User-Agent replaces the user agent because we haven't added the user agent yet when processing the request.
@@ -668 +690 @@
     [configuration setURLSchemeHandler:handler.get() forURLScheme:@"othertestscheme"];
     auto webView = adoptNS([[WKWebView alloc] initWithFrame:NSZeroRect configuration:configuration.get()]);
-    webView.get().navigationDelegate = navigationDelegateAllowingActiveActionsOnTestHost().get();
+    auto delegate = navigationDelegateAllowingActiveActionsOnTestHost().get();
+    webView.get().navigationDelegate = delegate;
+    __block bool receivedActionNotification { false };
+    __block Vector<String> urlsFromCallback;
+    delegate.contentRuleListPerformedAction = ^(WKWebView *, NSString *identifier, _WKContentRuleListAction *action, NSURL *url) {
+        urlsFromCallback.append(url.absoluteString);
+        EXPECT_TRUE(action.redirected);
+        receivedActionNotification = true;
+    };
+
     [webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"testscheme://testhost/main.html"]]];
     TestWebKitAPI::Util::run(&receivedAllRequests);
-
-    Vector<const char*> expectedRequestedURLs {
+    TestWebKitAPI::Util::run(&receivedActionNotification);
+
+    Vector<String> expectedRequestedURLs {
         "testscheme://testhost/main.html",
         "othertestscheme://not-testhost/1-redirected.txt",
@@ -686 +718 @@
     for (size_t i = 0; i < expectedRequestedURLs.size(); i++)
         EXPECT_WK_STREQ(expectedRequestedURLs[i], [[urls objectAtIndex:i] absoluteString]);
+
+    expectedRequestedURLs.remove(0);
+    expectedRequestedURLs[1] = "testscheme://testhost:123/2.txt";
+    checkURLs(urlsFromCallback, expectedRequestedURLs);
 }
 

trunk/Tools/TestWebKitAPI/cocoa/TestNavigationDelegate.h

@@ -27 +27 @@
 #import <WebKit/WebKit.h>
 
+@class _WKContentRuleListAction;
+
 @interface TestNavigationDelegate : NSObject <WKNavigationDelegate>
 
@@ -39 +41 @@
 @property (nonatomic, copy) void (^webContentProcessDidTerminate)(WKWebView *);
 @property (nonatomic, copy) void (^didReceiveAuthenticationChallenge)(WKWebView *, NSURLAuthenticationChallenge *, void (^)(NSURLSessionAuthChallengeDisposition, NSURLCredential *));
+@property (nonatomic, copy) void (^contentRuleListPerformedAction)(WKWebView *, NSString *, _WKContentRuleListAction *, NSURL *);
 
 - (void)waitForDidStartProvisionalNavigation;

trunk/Tools/TestWebKitAPI/cocoa/TestNavigationDelegate.mm

@@ -170 +170 @@
 }
 
+- (void)_webView:(WKWebView *)webView contentRuleListWithIdentifier:(NSString *)identifier performedAction:(_WKContentRuleListAction *)action forURL:(NSURL *)url
+{
+    if (_contentRuleListPerformedAction)
+        _contentRuleListPerformedAction(webView, identifier, action, url);
+}
+
 @end