Changeset 251620 in webkit

Timestamp:

Oct 25, 2019 6:10:59 PM (4 years ago)

Author:

yurys@chromium.org

Message:

Web Inspector: support emulateUserGesture parameter in Runtime.callFunctionOn
​https://bugs.webkit.org/show_bug.cgi?id=200262

Reviewed by Devin Rousso.

Source/JavaScriptCore:

• inspector/agents/InspectorRuntimeAgent.cpp:

(Inspector::InspectorRuntimeAgent::callFunctionOn):

• inspector/agents/InspectorRuntimeAgent.h:
• inspector/protocol/Runtime.json:

Source/WebCore:

Support emulateUserGesture in Runtime.callFunctionOn

Tests: inspector/runtime/callFunctionOn-emulateUserGesture-userIsInteracting.html

inspector/runtime/callFunctionOn-emulateUserGesture.html

• Sources.txt:
• WebCore.xcodeproj/project.pbxproj:
• inspector/agents/page/PageDebuggerAgent.cpp:

(WebCore::PageDebuggerAgent::evaluateOnCallFrame):

• inspector/agents/page/PageRuntimeAgent.cpp:

(WebCore::asBool):
(WebCore::PageRuntimeAgent::evaluate):
(WebCore::PageRuntimeAgent::callFunctionOn):

• inspector/agents/page/PageRuntimeAgent.h:
• inspector/agents/page/UserGestureEmulationScope.cpp: Added.

(WebCore::UserGestureEmulationScope::UserGestureEmulationScope): Extracted logic
of overriding user gesture into the scope object to share it between evaluate and
callFunctionOn as well as PageDebuggerAgent::evaluateOnCallFrame.
(WebCore::UserGestureEmulationScope::~UserGestureEmulationScope):

• inspector/agents/page/UserGestureEmulationScope.h: Added.

LayoutTests:

Supported emulateUserGesture in Runtime.callFunctionOn protocol command.

• TestExpectations:
• inspector/runtime/callFunctionOn-emulateUserGesture-expected.txt: Added.
• inspector/runtime/callFunctionOn-emulateUserGesture-userIsInteracting-expected.txt: Added.
• inspector/runtime/callFunctionOn-emulateUserGesture-userIsInteracting.html: Added.
• inspector/runtime/callFunctionOn-emulateUserGesture.html: Added.
• platform/wk2/TestExpectations:

Only enable the new test on WK2, as the user interaction state is only supported by WK2.

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/TestExpectations (modified) (1 diff)
• LayoutTests/inspector/runtime/callFunctionOn-emulateUserGesture-expected.txt (added)
• LayoutTests/inspector/runtime/callFunctionOn-emulateUserGesture-userIsInteracting-expected.txt (added)
• LayoutTests/inspector/runtime/callFunctionOn-emulateUserGesture-userIsInteracting.html (added)
• LayoutTests/inspector/runtime/callFunctionOn-emulateUserGesture.html (added)
• LayoutTests/platform/gtk/TestExpectations (modified) (1 diff)
• LayoutTests/platform/wk2/TestExpectations (modified) (1 diff)
• Source/JavaScriptCore/ChangeLog (modified) (1 diff)
• Source/JavaScriptCore/inspector/agents/InspectorRuntimeAgent.cpp (modified) (1 diff)
• Source/JavaScriptCore/inspector/agents/InspectorRuntimeAgent.h (modified) (1 diff)
• Source/JavaScriptCore/inspector/protocol/Runtime.json (modified) (1 diff)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/Sources.txt (modified) (1 diff)
• Source/WebCore/WebCore.xcodeproj/project.pbxproj (modified) (4 diffs)
• Source/WebCore/inspector/agents/page/PageDebuggerAgent.cpp (modified) (3 diffs)
• Source/WebCore/inspector/agents/page/PageRuntimeAgent.cpp (modified) (4 diffs)
• Source/WebCore/inspector/agents/page/PageRuntimeAgent.h (modified) (1 diff)
• Source/WebCore/inspector/agents/page/UserGestureEmulationScope.cpp (added)
• Source/WebCore/inspector/agents/page/UserGestureEmulationScope.h (added)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2019-10-25  Yury Semikhatsky  <yurys@chromium.org>
+
+        Web Inspector: support emulateUserGesture parameter in Runtime.callFunctionOn
+        https://bugs.webkit.org/show_bug.cgi?id=200262
+
+        Reviewed by Devin Rousso.
+
+        Supported emulateUserGesture in Runtime.callFunctionOn protocol command.
+
+        * TestExpectations:
+        * inspector/runtime/callFunctionOn-emulateUserGesture-expected.txt: Added.
+        * inspector/runtime/callFunctionOn-emulateUserGesture-userIsInteracting-expected.txt: Added.
+        * inspector/runtime/callFunctionOn-emulateUserGesture-userIsInteracting.html: Added.
+        * inspector/runtime/callFunctionOn-emulateUserGesture.html: Added.
+        * platform/wk2/TestExpectations:
+        Only enable the new test on WK2, as the user interaction state is only supported by WK2.
+
 2019-10-25  Megan Gardner  <megan_gardner@apple.com>
 

trunk/LayoutTests/TestExpectations

@@ -915 +915 @@
 inspector/debugger/evaluateOnCallFrame-emulateUserGesture-userIsInteracting.html [ Skip ]
 inspector/runtime/evaluate-emulateUserGesture-userIsInteracting.html [ Skip ]
+inspector/runtime/callFunctionOn-emulateUserGesture-userIsInteracting.html [ Skip ]
 
 # Target domain is only present in WK2.

trunk/LayoutTests/platform/gtk/TestExpectations

@@ -2246 +2246 @@
 
 webkit.org/b/149916 http/tests/inspector/dom/disconnect-dom-tree-after-main-frame-navigation.html [ Pass Slow ]
-webkit.org/b/149916 inspector/codemirror/prettyprinting-css.html [ Pass Slow ]
-webkit.org/b/149916 inspector/codemirror/prettyprinting-javascript.html [ Pass Slow ]
 webkit.org/b/149916 inspector/console/clearMessages.html [ Pass Slow ]
 webkit.org/b/149916 inspector/console/command-line-api.html [ Pass Slow ]

trunk/LayoutTests/platform/wk2/TestExpectations

@@ -764 +764 @@
 inspector/debugger/evaluateOnCallFrame-emulateUserGesture-userIsInteracting.html [ Pass ]
 inspector/runtime/evaluate-emulateUserGesture-userIsInteracting.html [ Pass ]
+inspector/runtime/callFunctionOn-emulateUserGesture-userIsInteracting.html [ Pass ]
 
 # Target domain is only present in WebKit2.

trunk/Source/JavaScriptCore/ChangeLog

@@ +1 @@
+2019-10-25  Yury Semikhatsky  <yurys@chromium.org>
+
+        Web Inspector: support emulateUserGesture parameter in Runtime.callFunctionOn
+        https://bugs.webkit.org/show_bug.cgi?id=200262
+
+        Reviewed by Devin Rousso.
+
+        * inspector/agents/InspectorRuntimeAgent.cpp:
+        (Inspector::InspectorRuntimeAgent::callFunctionOn):
+        * inspector/agents/InspectorRuntimeAgent.h:
+        * inspector/protocol/Runtime.json:
+
 2019-10-24  Mark Lam  <mark.lam@apple.com>
 

trunk/Source/JavaScriptCore/inspector/agents/InspectorRuntimeAgent.cpp

@@ -156 +156 @@
 }
 
-void InspectorRuntimeAgent::callFunctionOn(ErrorString& errorString, const String& objectId, const String& expression, const JSON::Array* optionalArguments, const bool* doNotPauseOnExceptionsAndMuteConsole, const bool* returnByValue, const bool* generatePreview, RefPtr<Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown)
+void InspectorRuntimeAgent::callFunctionOn(ErrorString& errorString, const String& objectId, const String& expression, const JSON::Array* optionalArguments, const bool* doNotPauseOnExceptionsAndMuteConsole, const bool* returnByValue, const bool* generatePreview, const bool* /* emulateUserGesture */, RefPtr<Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown)
 {
     InjectedScript injectedScript = m_injectedScriptManager.injectedScriptForObjectId(objectId);

trunk/Source/JavaScriptCore/inspector/agents/InspectorRuntimeAgent.h

@@ -64 +64 @@
     void evaluate(ErrorString&, const String& expression, const String* objectGroup, const bool* includeCommandLineAPI, const bool* doNotPauseOnExceptionsAndMuteConsole, const int* executionContextId, const bool* returnByValue, const bool* generatePreview, const bool* saveResult, const bool* emulateUserGesture, RefPtr<Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown, Optional<int>& savedResultIndex) override;
     void awaitPromise(const String& promiseObjectId, const bool* returnByValue, const bool* generatePreview, const bool* saveResult, Ref<AwaitPromiseCallback>&&) final;
-    void callFunctionOn(ErrorString&, const String& objectId, const String& expression, const JSON::Array* optionalArguments, const bool* doNotPauseOnExceptionsAndMuteConsole, const bool* returnByValue, const bool* generatePreview, RefPtr<Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown) final;
+    void callFunctionOn(ErrorString&, const String& objectId, const String& expression, const JSON::Array* optionalArguments, const bool* doNotPauseOnExceptionsAndMuteConsole, const bool* returnByValue, const bool* generatePreview, const bool* emulateUserGesture, RefPtr<Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown) override;
     void releaseObject(ErrorString&, const ErrorString& objectId) final;
     void getPreview(ErrorString&, const String& objectId, RefPtr<Protocol::Runtime::ObjectPreview>&) final;

trunk/Source/JavaScriptCore/inspector/protocol/Runtime.json

@@ -254 +254 @@
                 { "name": "doNotPauseOnExceptionsAndMuteConsole", "type": "boolean", "optional": true, "description": "Specifies whether function call should stop on exceptions and mute console. Overrides setPauseOnException state." },
                 { "name": "returnByValue", "type": "boolean", "optional": true, "description": "Whether the result is expected to be a JSON object which should be sent by value." },
-                { "name": "generatePreview", "type": "boolean", "optional": true, "description": "Whether preview should be generated for the result." }
+                { "name": "generatePreview", "type": "boolean", "optional": true, "description": "Whether preview should be generated for the result." },
+                { "name": "emulateUserGesture", "type": "boolean", "optional": true, "description": "Whether the expression should be considered to be in a user gesture or not." }
             ],
             "returns": [

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2019-10-25  Yury Semikhatsky  <yurys@chromium.org>
+
+        Web Inspector: support emulateUserGesture parameter in Runtime.callFunctionOn
+        https://bugs.webkit.org/show_bug.cgi?id=200262
+
+        Reviewed by Devin Rousso.
+
+        Support emulateUserGesture in Runtime.callFunctionOn
+
+        Tests: inspector/runtime/callFunctionOn-emulateUserGesture-userIsInteracting.html
+               inspector/runtime/callFunctionOn-emulateUserGesture.html
+
+        * Sources.txt:
+        * WebCore.xcodeproj/project.pbxproj:
+        * inspector/agents/page/PageDebuggerAgent.cpp:
+        (WebCore::PageDebuggerAgent::evaluateOnCallFrame):
+        * inspector/agents/page/PageRuntimeAgent.cpp:
+        (WebCore::asBool):
+        (WebCore::PageRuntimeAgent::evaluate):
+        (WebCore::PageRuntimeAgent::callFunctionOn):
+        * inspector/agents/page/PageRuntimeAgent.h:
+        * inspector/agents/page/UserGestureEmulationScope.cpp: Added.
+        (WebCore::UserGestureEmulationScope::UserGestureEmulationScope): Extracted logic
+        of overriding user gesture into the scope object to share it between evaluate and
+        callFunctionOn as well as PageDebuggerAgent::evaluateOnCallFrame.
+        (WebCore::UserGestureEmulationScope::~UserGestureEmulationScope):
+        * inspector/agents/page/UserGestureEmulationScope.h: Added.
+
 2019-10-25  Zalan Bujtas  <zalan@apple.com>
 

trunk/Source/WebCore/Sources.txt

@@ -1405 +1405 @@
 inspector/agents/page/PageNetworkAgent.cpp
 inspector/agents/page/PageRuntimeAgent.cpp
+inspector/agents/page/UserGestureEmulationScope.cpp
 
 inspector/agents/worker/ServiceWorkerAgent.cpp

trunk/Source/WebCore/WebCore.xcodeproj/project.pbxproj

@@ -4882 +4882 @@
                 F12171F516A8CED2000053CA /* WebVTTElement.cpp in Sources */ = {isa = PBXBuildFile; fileRef = F12171F316A8BC63000053CA /* WebVTTElement.cpp */; };
                 F12171F616A8CF0B000053CA /* WebVTTElement.h in Headers */ = {isa = PBXBuildFile; fileRef = F12171F416A8BC63000053CA /* WebVTTElement.h */; };
+                F32BDCD92363AACA0073B6AE /* UserGestureEmulationScope.h in Headers */ = {isa = PBXBuildFile; fileRef = F32BDCD72363AACA0073B6AE /* UserGestureEmulationScope.h */; };
                 F344C7141125B82C00F26EEE /* InspectorFrontendClient.h in Headers */ = {isa = PBXBuildFile; fileRef = F344C7121125B82C00F26EEE /* InspectorFrontendClient.h */; settings = {ATTRIBUTES = (Private, ); }; };
                 F344C75311294D9D00F26EEE /* InspectorFrontendClientLocal.h in Headers */ = {isa = PBXBuildFile; fileRef = F344C75211294D9D00F26EEE /* InspectorFrontendClientLocal.h */; settings = {ATTRIBUTES = (Private, ); }; };
@@ -15241 +15242 @@
                 F12171F316A8BC63000053CA /* WebVTTElement.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = WebVTTElement.cpp; sourceTree = "<group>"; };
                 F12171F416A8BC63000053CA /* WebVTTElement.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = WebVTTElement.h; sourceTree = "<group>"; };
+                F32BDCD52363AAC90073B6AE /* UserGestureEmulationScope.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = UserGestureEmulationScope.cpp; sourceTree = "<group>"; };
+                F32BDCD72363AACA0073B6AE /* UserGestureEmulationScope.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = UserGestureEmulationScope.h; sourceTree = "<group>"; };
                 F344C7121125B82C00F26EEE /* InspectorFrontendClient.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = InspectorFrontendClient.h; sourceTree = "<group>"; };
                 F344C75211294D9D00F26EEE /* InspectorFrontendClientLocal.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = InspectorFrontendClientLocal.h; sourceTree = "<group>"; };
@@ -22780 +22783 @@
                                 A5B81CC11FAA44B70037D1E6 /* PageRuntimeAgent.cpp */,
                                 A5B81CBF1FAA44B70037D1E6 /* PageRuntimeAgent.h */,
+                                F32BDCD52363AAC90073B6AE /* UserGestureEmulationScope.cpp */,
+                                F32BDCD72363AACA0073B6AE /* UserGestureEmulationScope.h */,
                         );
                         path = page;
@@ -32466 +32471 @@
                                 003F1FEA11E6AB43008258D9 /* UserContentTypes.h in Headers */,
                                 BCACF3BD1072921A00C0C8A3 /* UserContentURLPattern.h in Headers */,
+                                F32BDCD92363AACA0073B6AE /* UserGestureEmulationScope.h in Headers */,
                                 2542F4DB1166C25A00E89A86 /* UserGestureIndicator.h in Headers */,
                                 9920398318B95BC600B39AF9 /* UserInputBridge.h in Headers */,

trunk/Source/WebCore/inspector/agents/page/PageDebuggerAgent.cpp

@@ -34 +34 @@
 
 #include "CachedResource.h"
-#include "Chrome.h"
-#include "ChromeClient.h"
 #include "Document.h"
 #include "Frame.h"
@@ -45 +43 @@
 #include "ScriptExecutionContext.h"
 #include "ScriptState.h"
-#include "UserGestureIndicator.h"
+#include "UserGestureEmulationScope.h"
 #include <JavaScriptCore/InjectedScript.h>
 #include <JavaScriptCore/InjectedScriptManager.h>
@@ -72 +70 @@
 void PageDebuggerAgent::evaluateOnCallFrame(ErrorString& errorString, const String& callFrameId, const String& expression, const String* objectGroup, const bool* includeCommandLineAPI, const bool* doNotPauseOnExceptionsAndMuteConsole, const bool* returnByValue, const bool* generatePreview, const bool* saveResult, const bool* emulateUserGesture, RefPtr<Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown, Optional<int>& savedResultIndex)
 {
-    auto& pageChromeClient = m_inspectedPage.chrome().client();
-
     auto shouldEmulateUserGesture = emulateUserGesture && *emulateUserGesture;
-
-    Optional<ProcessingUserGestureState> userGestureState = shouldEmulateUserGesture ? Optional<ProcessingUserGestureState>(ProcessingUserGesture) : WTF::nullopt;
-    UserGestureIndicator gestureIndicator(userGestureState);
-
-    bool userWasInteracting = false;
-    if (shouldEmulateUserGesture) {
-        userWasInteracting = pageChromeClient.userIsInteracting();
-        if (!userWasInteracting)
-            pageChromeClient.setUserIsInteracting(true);
-    }
+    UserGestureEmulationScope userGestureScope(m_inspectedPage, shouldEmulateUserGesture);
 
     WebDebuggerAgent::evaluateOnCallFrame(errorString, callFrameId, expression, objectGroup, includeCommandLineAPI, doNotPauseOnExceptionsAndMuteConsole, returnByValue, generatePreview, saveResult, emulateUserGesture, result, wasThrown, savedResultIndex);
-
-    if (shouldEmulateUserGesture && !userWasInteracting && pageChromeClient.userIsInteracting())
-        pageChromeClient.setUserIsInteracting(false);
 }
 

trunk/Source/WebCore/inspector/agents/page/PageRuntimeAgent.cpp

@@ -33 +33 @@
 #include "PageRuntimeAgent.h"
 
-#include "Chrome.h"
-#include "ChromeClient.h"
 #include "Document.h"
 #include "Frame.h"
@@ -45 +43 @@
 #include "ScriptState.h"
 #include "SecurityOrigin.h"
-#include "UserGestureIndicator.h"
+#include "UserGestureEmulationScope.h"
 #include <JavaScriptCore/InjectedScript.h>
 #include <JavaScriptCore/InjectedScriptManager.h>
@@ -51 +49 @@
 using Inspector::Protocol::Runtime::ExecutionContextDescription;
 
-
 namespace WebCore {
 
 using namespace Inspector;
+
+static bool asBool(const bool* b)
+{
+    return b && *b;
+}
 
 PageRuntimeAgent::PageRuntimeAgent(PageAgentContext& context)
@@ -167 +169 @@
 void PageRuntimeAgent::evaluate(ErrorString& errorString, const String& expression, const String* objectGroup, const bool* includeCommandLineAPI, const bool* doNotPauseOnExceptionsAndMuteConsole, const int* executionContextId, const bool* returnByValue, const bool* generatePreview, const bool* saveResult, const bool* emulateUserGesture, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown, Optional<int>& savedResultIndex)
 {
-    auto& pageChromeClient = m_inspectedPage.chrome().client();
+    UserGestureEmulationScope userGestureScope(m_inspectedPage, asBool(emulateUserGesture));
+    InspectorRuntimeAgent::evaluate(errorString, expression, objectGroup, includeCommandLineAPI, doNotPauseOnExceptionsAndMuteConsole, executionContextId, returnByValue, generatePreview, saveResult, emulateUserGesture, result, wasThrown, savedResultIndex);
+}
 
-    auto shouldEmulateUserGesture = emulateUserGesture && *emulateUserGesture;
-
-    Optional<ProcessingUserGestureState> userGestureState = shouldEmulateUserGesture ? Optional<ProcessingUserGestureState>(ProcessingUserGesture) : WTF::nullopt;
-    UserGestureIndicator gestureIndicator(userGestureState);
-
-    bool userWasInteracting = false;
-    if (shouldEmulateUserGesture) {
-        userWasInteracting = pageChromeClient.userIsInteracting();
-        if (!userWasInteracting)
-            pageChromeClient.setUserIsInteracting(true);
-    }
-
-    InspectorRuntimeAgent::evaluate(errorString, expression, objectGroup, includeCommandLineAPI, doNotPauseOnExceptionsAndMuteConsole, executionContextId, returnByValue, generatePreview, saveResult, emulateUserGesture, result, wasThrown, savedResultIndex);
-
-    if (shouldEmulateUserGesture && !userWasInteracting && pageChromeClient.userIsInteracting())
-        pageChromeClient.setUserIsInteracting(false);
+void PageRuntimeAgent::callFunctionOn(ErrorString& errorString, const String& objectId, const String& expression, const JSON::Array* optionalArguments, const bool* doNotPauseOnExceptionsAndMuteConsole, const bool* returnByValue, const bool* generatePreview, const bool* emulateUserGesture, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown)
+{
+    UserGestureEmulationScope userGestureScope(m_inspectedPage, asBool(emulateUserGesture));
+    InspectorRuntimeAgent::callFunctionOn(errorString, objectId, expression, optionalArguments, doNotPauseOnExceptionsAndMuteConsole, returnByValue, generatePreview, emulateUserGesture, result, wasThrown);
 }
 

trunk/Source/WebCore/inspector/agents/page/PageRuntimeAgent.h

@@ -58 +58 @@
     void disable(ErrorString&) override;
     void evaluate(ErrorString&, const String& expression, const String* objectGroup, const bool* includeCommandLineAPI, const bool* doNotPauseOnExceptionsAndMuteConsole, const int* executionContextId, const bool* returnByValue, const bool* generatePreview, const bool* saveResult, const bool* emulateUserGesture, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown, Optional<int>& savedResultIndex) override;
+    void callFunctionOn(ErrorString&, const String& objectId, const String& expression, const JSON::Array* optionalArguments, const bool* doNotPauseOnExceptionsAndMuteConsole, const bool* returnByValue, const bool* generatePreview, const bool* emulateUserGesture, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result, Optional<bool>& wasThrown) override;
 
     // InspectorInstrumentation