"excludeMatches" array in scripting.registerContentScripts() API is ignored

kiaraarose · kiaraarose · commit 242d59d0bf07 · 2025-04-02T09:22:47.000-07:00
https://bugs.webkit.org/show_bug.cgi?id=290858 rdar://145489255 Reviewed by Timothy Hatcher. Add the excluded match pattern to the excludeMatchPatterns set. * Source/WebKit/UIProcess/Extensions/Cocoa/API/WebExtensionContextAPIScriptingCocoa.mm: (WebKit::WebExtensionContext::createInjectedContentForScripts): * Tools/TestWebKitAPI/Tests/WebKitCocoa/WKWebExtensionAPIScripting.mm: (TestWebKitAPI::TEST(WKWebExtensionAPIScripting, RegisteredScriptExcludesMatches)): Canonical link: https://commits.webkit.org/293106@main
diff --git a/Source/WebKit/UIProcess/Extensions/Cocoa/API/WebExtensionContextAPIScriptingCocoa.mm b/Source/WebKit/UIProcess/Extensions/Cocoa/API/WebExtensionContextAPIScriptingCocoa.mm
@@ -419,6 +419,8 @@
                 *errorMessage = toErrorString(callingAPIName, nullString(), @"script with ID '%@' has an invalid exclude match pattern '%@'", (NSString *)scriptID, matchPatternString);
                 return false;
             }
+
+            excludeMatchPatterns.add(matchPattern.releaseNonNull());
         }
 
         InjectedContentData injectedContentData;
diff --git a/Tools/TestWebKitAPI/Tests/WebKitCocoa/WKWebExtensionAPIScripting.mm b/Tools/TestWebKitAPI/Tests/WebKitCocoa/WKWebExtensionAPIScripting.mm
@@ -1235,6 +1235,65 @@
     [manager run];
 }
 
+TEST(WKWebExtensionAPIScripting, RegisteredScriptExcludeMatches)
+{
+    TestWebKitAPI::HTTPServer server({
+        { "/"_s, { { { "Content-Type"_s, "text/html"_s } }, ""_s } }
+    }, TestWebKitAPI::HTTPServer::Protocol::Http);
+
+    auto *backgroundScript = Util::constructScript(@[
+        @"browser.webNavigation.onCompleted.addListener(async () => {",
+
+        @"  var expectedResults = [{",
+        @"    id: '1',",
+        @"    js: ['changeBackgroundColorScript.js'],",
+        @"    matches: ['*://*/*'],",
+        @"    persistAcrossSessions: true,",
+        @"    excludeMatches: ['*://*.example.com/*']",
+        @"  }]",
+
+        @"  await browser.scripting.registerContentScripts([{ id: '1', matches: ['*://*/*'], js: ['changeBackgroundColorScript.js'], excludeMatches: ['*://*.example.com/*']}])",
+
+        @"  var results = await browser.scripting.getRegisteredContentScripts()",
+        @"  browser.test.assertDeepEq(results, expectedResults)",
+
+        @"  results = await browser.scripting.getRegisteredContentScripts({ 'ids': ['1'] })",
+        @"  browser.test.assertDeepEq(results, expectedResults)",
+
+        @"  await browser.scripting.unregisterContentScripts()",
+
+        @"  browser.test.notifyPass()",
+        @"})",
+
+        @"browser.test.sendMessage('Load Tab')",
+    ]);
+
+    static auto *resources = @{
+        @"background.js": backgroundScript,
+        @"changeBackgroundColorScript.js": changeBackgroundColorScript,
+    };
+
+    auto manager = Util::loadExtension(scriptingManifest, resources);
+    auto *testContext = manager.get().context;
+
+    // Confirm that the script can't be injected on example.com.
+    auto *exampleURL = [NSURL URLWithString:@"https://example.com/"];
+    EXPECT_FALSE([testContext hasInjectedContentForURL:exampleURL]);
+
+    auto *urlRequest = server.requestWithLocalhost();
+    auto *url = urlRequest.URL;
+
+    auto *matchPattern = [WKWebExtensionMatchPattern matchPatternWithScheme:url.scheme host:url.host path:@"/*"];
+    [testContext setPermissionStatus:WKWebExtensionContextPermissionStatusGrantedExplicitly forPermission:WKWebExtensionPermissionWebNavigation];
+    [testContext setPermissionStatus:WKWebExtensionContextPermissionStatusGrantedExplicitly forMatchPattern:matchPattern];
+
+    [manager runUntilTestMessage:@"Load Tab"];
+
+    [manager.get().defaultTab.webView loadRequest:urlRequest];
+
+    [manager run];
+}
+
 TEST(WKWebExtensionAPIScripting, InjectedOnlyOnce)
 {
     TestWebKitAPI::HTTPServer server({

Original file line number	Diff line number	Diff line change
`@@ -419,6 +419,8 @@`
`419`	`419`	`errorMessage = toErrorString(callingAPIName, nullString(), @"script with ID '%@' has an invalid exclude match pattern '%@'", (NSString )scriptID, matchPatternString);`
`420`	`420`	`return false;`
`421`	`421`	`}`
	`422`	`+`
	`423`	`+ excludeMatchPatterns.add(matchPattern.releaseNonNull());`
`422`	`424`	`}`
`423`	`425`
`424`	`426`	`InjectedContentData injectedContentData;`