Web Inspector: Debugger: allow breakpoint actions to be evaluated as a user gesture

[Devin Rousso]

This could be useful for developers trying to "hot patch" their code with some extra functionality.

[Devin Rousso]

Created attachment 417326 [details]
Patch

[Devin Rousso]

Created attachment 417327 [details]
[Image] after Patch is applied

[EWS Watchlist]

This patch modifies the inspector protocol. Please ensure that any frontend changes appropriately use feature checks for new protocol features.

[BJ Burg]

Comment on attachment 417326 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=417326&action=review

r=me, nice work!

> LayoutTests/inspector/debugger/breakpoint-action-emulateUserGesture.html:14
> +        TestPage.addResult(window.internals.isProcessingUserGesture() ? "In User Gesture" : "Not in User Gesture");

What's the difference between .isProcessingUserGresture() here and .userIsInteracting() above?

> Source/JavaScriptCore/debugger/Debugger.cpp:618
> +    JSObject* scopeExtensionObject = m_client ? m_client->debuggerScopeExtensionObject(*this, globalObject, debuggerCallFrame) : nullptr;

Nice.

> Source/WebCore/inspector/agents/page/PageDebuggerAgent.cpp:126
> +        m_breakpointActionUserGestureEmulationScopeStack.append(makeUniqueRef<UserGestureEmulationScope>(m_inspectedPage, true));

What a mouthful. I like the stack idea though.

> Source/WebInspectorUI/UserInterface/Views/BreakpointActionView.js:139
> +            emulateUserGestureLabel.appendChild(document.createTextNode(WI.UIString("Emulate User Gesture")));

Please add a location to the UIString (@ Evaluate JavaScript breakpoint action menu in Sources tab)

> Source/WebInspectorUI/UserInterface/Views/LogContentView.js:84
> +            this._emulateUserGestureNavigationItem = new WI.CheckboxNavigationItem("emulate-in-user-gesture", WI.UIString("Emulate User Gesture"), WI.settings.emulateInUserGesture.value);

Please add a location to the UIString (@ Option in Console Tab)

[BJ Burg]

Please (create a task to) add this to the documentation as well. =)

[Joseph Pecoraro]

Comment on attachment 417326 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=417326&action=review

>> Source/JavaScriptCore/debugger/Debugger.cpp:618
>> +    JSObject* scopeExtensionObject = m_client ? m_client->debuggerScopeExtensionObject(*this, globalObject, debuggerCallFrame) : nullptr;
> 
> Nice.

+1

[Devin Rousso]

Comment on attachment 417326 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=417326&action=review

>> LayoutTests/inspector/debugger/breakpoint-action-emulateUserGesture.html:14
>> +        TestPage.addResult(window.internals.isProcessingUserGesture() ? "In User Gesture" : "Not in User Gesture");
> 
> What's the difference between .isProcessingUserGresture() here and .userIsInteracting() above?

`isProcessingUserGesture` is a WebCore concept whereas `userIsInteracting` is a WebKit (WebProcess) concept.  I believe the latter is necessary (in addition to the former) for more "native" interactions like showing the iOS keyboard when evaluating `input.click()` (see Bug 197269).

>> Source/WebInspectorUI/UserInterface/Views/BreakpointActionView.js:139
>> +            emulateUserGestureLabel.appendChild(document.createTextNode(WI.UIString("Emulate User Gesture")));
> 
> Please add a location to the UIString (@ Evaluate JavaScript breakpoint action menu in Sources tab)

👍

>> Source/WebInspectorUI/UserInterface/Views/LogContentView.js:84
>> +            this._emulateUserGestureNavigationItem = new WI.CheckboxNavigationItem("emulate-in-user-gesture", WI.UIString("Emulate User Gesture"), WI.settings.emulateInUserGesture.value);
> 
> Please add a location to the UIString (@ Option in Console Tab)

👍

[Devin Rousso]

Created attachment 417391 [details]
Patch

[EWS]

Committed r271373: <https://trac.webkit.org/changeset/271373>

All reviewed patches have been landed. Closing bug and clearing flags on attachment 417391 [details].

[Radar WebKit Bug Importer]

<rdar://problem/73008562>