Cherry-pick 259548.840@safari-7615-branch (259842c). <bug>

Cherry-pick 265168@main (8e5ddea). rdar://110919134 evaluateJavaScript: and callAsyncJavaScript: should not leave behind transient activation https://bugs.webkit.org/show_bug.cgi?id=258037 rdar://107102031 Reviewed by Ben Nham. JavaScript evaluated by the client app is executed as if from a user gesture, which is fine for now. But before this change, such JS left behind transient user activation for (currently) 5 seconds, which is not fine. Let's remove that sticky side effect. * Source/WTF/wtf/cocoa/RuntimeApplicationChecksCocoa.cpp: (WTF::computeSDKAlignedBehaviors): * Source/WTF/wtf/cocoa/RuntimeApplicationChecksCocoa.h: * Source/WebCore/bindings/js/ScriptController.cpp: (WebCore::ScriptController::executeScriptInWorld): (WebCore::ScriptController::executeAsynchronousUserAgentScriptInWorld): * Source/WebCore/dom/UserGestureIndicator.cpp: (WebCore::UserGestureToken::forEachImpactedDocument): * Source/WebCore/dom/UserGestureIndicator.h: * Tools/TestWebKitAPI/Tests/WebKitCocoa/AsyncFunction.mm: (TestWebKitAPI::TEST): Canonical link: https://commits.webkit.org/265168@main Canonical link: https://commits.webkit.org/259548.840@safari-7615-branch
WebKit · Jul 28, 2023 · 4876897 · 4876897
1 parent 20aeaf0
commit 4876897
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 1 deletion.
diff --git a/Source/WTF/wtf/cocoa/RuntimeApplicationChecksCocoa.h b/Source/WTF/wtf/cocoa/RuntimeApplicationChecksCocoa.h
@@ -104,6 +104,7 @@ enum class SDKAlignedBehavior {
     UIBackForwardSkipsHistoryItemsWithoutUserGesture,
     ProgrammaticFocusDuringUserScriptShowsInputViews,
     UsesGameControllerPhysicalInputProfile,
+    EvaluateJavaScriptWithoutTransientActivation,
 
     NumberOfBehaviors
 };

diff --git a/Source/WebCore/bindings/js/ScriptController.cpp b/Source/WebCore/bindings/js/ScriptController.cpp
@@ -594,6 +594,20 @@ ValueOrException ScriptController::executeScriptInWorld(DOMWrapperWorld& world,
 
     UserGestureIndicator gestureIndicator(parameters.forceUserGesture == ForceUserGesture::Yes ? std::optional<ProcessingUserGestureState>(ProcessingUserGesture) : std::nullopt, m_frame.document());
 
+#if PLATFORM(COCOA)
+    if (linkedOnOrAfterSDKWithBehavior(SDKAlignedBehavior::EvaluateJavaScriptWithoutTransientActivation)) {
+        // Script executed by the user agent under simulated user gesture should not leave behind transient activation
+        if (parameters.forceUserGesture == ForceUserGesture::Yes && UserGestureIndicator::currentUserGesture()) {
+            UserGestureIndicator::currentUserGesture()->addDestructionObserver([](UserGestureToken& token) {
+                token.forEachImpactedDocument([](Document& document) {
+                    if (auto* window = document.domWindow())
+                        window->consumeTransientActivation();
+                });
+            });
+        }
+    }
+#endif
+
     if (!canExecuteScripts(AboutToExecuteScript) || isPaused())
         return makeUnexpected(ExceptionDetails { "Cannot execute JavaScript in this document"_s });
 
@@ -710,9 +724,10 @@ ValueOrException ScriptController::executeUserAgentScriptInWorld(DOMWrapperWorld
 
 void ScriptController::executeAsynchronousUserAgentScriptInWorld(DOMWrapperWorld& world, RunJavaScriptParameters&& parameters, ResolveFunction&& resolveCompletionHandler)
 {
+    auto runAsAsyncFunction = parameters.runAsAsyncFunction;
     auto result = executeScriptInWorld(world, WTFMove(parameters));
 
-    if (parameters.runAsAsyncFunction == RunAsAsyncFunction::No || !result || !result.value().isObject()) {
+    if (runAsAsyncFunction == RunAsAsyncFunction::No || !result || !result.value().isObject()) {
         resolveCompletionHandler(result);
         return;
     }

diff --git a/Source/WebCore/dom/UserGestureIndicator.cpp b/Source/WebCore/dom/UserGestureIndicator.cpp
@@ -100,6 +100,11 @@ bool UserGestureToken::isValidForDocument(const Document& document) const
     return m_documentsImpactedByUserGesture.contains(document);
 }
 
+void UserGestureToken::forEachImpactedDocument(Function<void(Document&)>&& function)
+{
+    m_documentsImpactedByUserGesture.forEach(function);
+}
+
 UserGestureIndicator::UserGestureIndicator(std::optional<ProcessingUserGestureState> state, Document* document, UserGestureType gestureType, ProcessInteractionStyle processInteractionStyle)
     : m_previousToken { currentToken() }
 {

diff --git a/Source/WebCore/dom/UserGestureIndicator.h b/Source/WebCore/dom/UserGestureIndicator.h
@@ -105,6 +105,8 @@ class UserGestureToken : public RefCounted<UserGestureToken>, public CanMakeWeak
 
     bool isValidForDocument(const Document&) const;
 
+    void forEachImpactedDocument(Function<void(Document&)>&&);
+
 private:
     UserGestureToken(ProcessingUserGestureState, UserGestureType, Document*);
 

diff --git a/Tools/TestWebKitAPI/Tests/WebKitCocoa/AsyncFunction.mm b/Tools/TestWebKitAPI/Tests/WebKitCocoa/AsyncFunction.mm
@@ -29,6 +29,7 @@
 #import "Test.h"
 #import "TestUIDelegate.h"
 #import "TestWKWebView.h"
+#import "WKWebViewConfigurationExtras.h"
 #import <WebKit/WKContentWorld.h>
 #import <WebKit/WKFrameInfo.h>
 #import <WebKit/WKProcessPoolPrivate.h>
@@ -320,5 +321,41 @@
     EXPECT_EQ([webView _webProcessIdentifier], pid);
 }
 
+TEST(AsyncFunction, TransientActivation)
+{
+    WKWebViewConfiguration *configuration = [WKWebViewConfiguration _test_configurationWithTestPlugInClassName:@"WebProcessPlugInWithInternals" configureJSCForTesting:YES];
+    auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600) configuration:configuration addToWindow:NO]);
+
+    [webView synchronouslyLoadHTMLString:@"Hello"];
+
+    __block bool done = false;
+    [webView _evaluateJavaScriptWithoutUserGesture:@"window.internals.hasTransientActivation()" completionHandler:^(id result, NSError *error) {
+        EXPECT_NULL(error);
+        EXPECT_TRUE([result isKindOfClass:[NSNumber class]]);
+        EXPECT_TRUE([result isEqualToNumber:@0]);
+        done = true;
+    }];
+    TestWebKitAPI::Util::run(&done);
+    done = false;
+
+    [webView callAsyncJavaScript:@"return window.internals.hasTransientActivation()" arguments:nil inFrame:nil inContentWorld:WKContentWorld.pageWorld completionHandler:^(id result, NSError *error) {
+        EXPECT_NULL(error);
+        EXPECT_TRUE([result isKindOfClass:[NSNumber class]]);
+        EXPECT_TRUE([result isEqualToNumber:@1]);
+        done = true;
+    }];
+    TestWebKitAPI::Util::run(&done);
+    done = false;
+
+    [webView _evaluateJavaScriptWithoutUserGesture:@"window.internals.hasTransientActivation()" completionHandler:^(id result, NSError *error) {
+        EXPECT_NULL(error);
+        EXPECT_TRUE([result isKindOfClass:[NSNumber class]]);
+        EXPECT_TRUE([result isEqualToNumber:@0]);
+        done = true;
+    }];
+    TestWebKitAPI::Util::run(&done);
+    done = false;
 }
 
+} // namespace TestWebKitAPI
+