Changeset 243161 in webkit

Timestamp:

Mar 19, 2019, 12:31:31 PM (7 years ago)

Author:

Devin Rousso

Message:

Web Inspector: Provide $event in the console when paused on an event listener
​https://bugs.webkit.org/show_bug.cgi?id=188672

Reviewed by Timothy Hatcher.

Source/JavaScriptCore:

• inspector/InjectedScript.h:
• inspector/InjectedScript.cpp:

(Inspector::InjectedScript::setEventValue): Added.
(Inspector::InjectedScript::clearEventValue): Added.

• inspector/InjectedScriptManager.h:
• inspector/InjectedScriptManager.cpp:

(Inspector::InjectedScriptManager::clearEventValue): Added.

• inspector/InjectedScriptSource.js:

(WI.InjectedScript.prototype.setEventValue): Added.
(WI.InjectedScript.prototype.clearEventValue): Added.
(BasicCommandLineAPI):

Source/WebCore:

Implement similiar methods/logic as to the way that $exception is set.

• inspector/CommandLineAPIModuleSource.js:

(CommandLineAPI):

• inspector/InspectorInstrumentation.h:

(WebCore::InspectorInstrumentation::willHandleEvent):

• inspector/InspectorInstrumentation.cpp:

(WebCore::InspectorInstrumentation::willHandleEventImpl):
(WebCore::InspectorInstrumentation::didHandleEventImpl):

• inspector/agents/InspectorDOMDebuggerAgent.cpp:
• inspector/agents/InspectorDOMDebuggerAgent.h:

(WebCore::InspectorDOMDebuggerAgent::InspectorDOMDebuggerAgent):
(WebCore::InspectorDOMDebuggerAgent::willHandleEvent):
(WebCore::InspectorDOMDebuggerAgent::didHandleEvent): Added.

Source/WebInspectorUI:

• UserInterface/Controllers/JavaScriptRuntimeCompletionProvider.js:

(WI.JavaScriptRuntimeCompletionProvider.prototype.completionControllerCompletionsNeeded.receivedPropertyNames):

Location:

trunk/Source

Files:

• JavaScriptCore/ChangeLog (modified) (1 diff)
• JavaScriptCore/inspector/InjectedScript.cpp (modified) (1 diff)
• JavaScriptCore/inspector/InjectedScript.h (modified) (1 diff)
• JavaScriptCore/inspector/InjectedScriptManager.cpp (modified) (1 diff)
• JavaScriptCore/inspector/InjectedScriptManager.h (modified) (1 diff)
• JavaScriptCore/inspector/InjectedScriptSource.js (modified) (2 diffs)
• WebCore/ChangeLog (modified) (1 diff)
• WebCore/inspector/CommandLineAPIModuleSource.js (modified) (1 diff)
• WebCore/inspector/InspectorInstrumentation.cpp (modified) (2 diffs)
• WebCore/inspector/InspectorInstrumentation.h (modified) (3 diffs)
• WebCore/inspector/agents/InspectorDOMDebuggerAgent.cpp (modified) (4 diffs)
• WebCore/inspector/agents/InspectorDOMDebuggerAgent.h (modified) (3 diffs)
• WebInspectorUI/ChangeLog (modified) (1 diff)
• WebInspectorUI/UserInterface/Controllers/JavaScriptRuntimeCompletionProvider.js (modified) (1 diff)

trunk/Source/JavaScriptCore/ChangeLog

@@ +1 @@
+2019-03-19  Devin Rousso  <drousso@apple.com>
+
+        Web Inspector: Provide $event in the console when paused on an event listener
+        https://bugs.webkit.org/show_bug.cgi?id=188672
+
+        Reviewed by Timothy Hatcher.
+
+        * inspector/InjectedScript.h:
+        * inspector/InjectedScript.cpp:
+        (Inspector::InjectedScript::setEventValue): Added.
+        (Inspector::InjectedScript::clearEventValue): Added.
+
+        * inspector/InjectedScriptManager.h:
+        * inspector/InjectedScriptManager.cpp:
+        (Inspector::InjectedScriptManager::clearEventValue): Added.
+
+        * inspector/InjectedScriptSource.js:
+        (WI.InjectedScript.prototype.setEventValue): Added.
+        (WI.InjectedScript.prototype.clearEventValue): Added.
+        (BasicCommandLineAPI):
+
 2019-03-19  Devin Rousso  <drousso@apple.com>
 

trunk/Source/JavaScriptCore/inspector/InjectedScript.cpp

@@ -348 +348 @@
 }
 
+void InjectedScript::setEventValue(JSC::JSValue value)
+{
+    ASSERT(!hasNoValue());
+    Deprecated::ScriptFunctionCall function(injectedScriptObject(), "setEventValue"_s, inspectorEnvironment()->functionCallHandler());
+    function.appendArgument(value);
+    makeCall(function);
+}
+
+void InjectedScript::clearEventValue()
+{
+    ASSERT(!hasNoValue());
+    Deprecated::ScriptFunctionCall function(injectedScriptObject(), "clearEventValue"_s, inspectorEnvironment()->functionCallHandler());
+    makeCall(function);
+}
+
 void InjectedScript::setExceptionValue(JSC::JSValue value)
 {

trunk/Source/JavaScriptCore/inspector/InjectedScript.h

@@ -81 +81 @@
     RefPtr<Protocol::Runtime::ObjectPreview> previewValue(JSC::JSValue) const;
 
+    void setEventValue(JSC::JSValue);
+    void clearEventValue();
+
     void setExceptionValue(JSC::JSValue);
     void clearExceptionValue();

trunk/Source/JavaScriptCore/inspector/InjectedScriptManager.cpp

@@ -123 +123 @@
 }
 
+void InjectedScriptManager::clearEventValue()
+{
+    for (auto& injectedScript : m_idToInjectedScript.values())
+        injectedScript.clearEventValue();
+}
+
 void InjectedScriptManager::clearExceptionValue()
 {

trunk/Source/JavaScriptCore/inspector/InjectedScriptManager.h

@@ -61 +61 @@
     InjectedScript injectedScriptForObjectId(const String& objectId);
     void releaseObjectGroup(const String& objectGroup);
+    void clearEventValue();
     void clearExceptionValue();
 

trunk/Source/JavaScriptCore/inspector/InjectedScriptSource.js

@@ -354 +354 @@
     }
 
+    setEventValue(value)
+    {
+        this._eventValue = value;
+    }
+
+    clearEventValue()
+    {
+        delete this._eventValue;
+    }
+
     setExceptionValue(value)
     {
@@ -1447 +1457 @@
     this.$exception = injectedScript._exceptionValue;
 
+    if ("_eventValue" in injectedScript)
+        this.$event = injectedScript._eventValue;
+    else if ("$event" in this)
+        delete this.$event;
+
     // $1-$99
     for (let i = 1; i <= injectedScript._savedResults.length; ++i)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2019-03-19  Devin Rousso  <drousso@apple.com>
+
+        Web Inspector: Provide $event in the console when paused on an event listener
+        https://bugs.webkit.org/show_bug.cgi?id=188672
+
+        Reviewed by Timothy Hatcher.
+
+        Implement similiar methods/logic as to the way that `$exception` is set.
+
+        * inspector/CommandLineAPIModuleSource.js:
+        (CommandLineAPI):
+
+        * inspector/InspectorInstrumentation.h:
+        (WebCore::InspectorInstrumentation::willHandleEvent):
+        * inspector/InspectorInstrumentation.cpp:
+        (WebCore::InspectorInstrumentation::willHandleEventImpl):
+        (WebCore::InspectorInstrumentation::didHandleEventImpl):
+
+        * inspector/agents/InspectorDOMDebuggerAgent.cpp:
+        * inspector/agents/InspectorDOMDebuggerAgent.h:
+        (WebCore::InspectorDOMDebuggerAgent::InspectorDOMDebuggerAgent):
+        (WebCore::InspectorDOMDebuggerAgent::willHandleEvent):
+        (WebCore::InspectorDOMDebuggerAgent::didHandleEvent): Added.
+
 2019-03-19  Devin Rousso  <drousso@apple.com>
 

trunk/Source/WebCore/inspector/CommandLineAPIModuleSource.js

@@ -48 +48 @@
 {
     this.$_ = injectedScript._lastResult;
+    this.$event = injectedScript._eventValue;
     this.$exception = injectedScript._exceptionValue;
 

trunk/Source/WebCore/inspector/InspectorInstrumentation.cpp

@@ -397 +397 @@
 }
 
-void InspectorInstrumentation::willHandleEventImpl(InstrumentingAgents& instrumentingAgents, const Event& event, const RegisteredEventListener& listener)
+void InspectorInstrumentation::willHandleEventImpl(InstrumentingAgents& instrumentingAgents, Event& event, const RegisteredEventListener& listener)
 {
     if (PageDebuggerAgent* pageDebuggerAgent = instrumentingAgents.pageDebuggerAgent())
@@ -410 +410 @@
     if (InspectorDebuggerAgent* debuggerAgent = instrumentingAgents.inspectorDebuggerAgent())
         debuggerAgent->didDispatchAsyncCall();
+
+    if (InspectorDOMDebuggerAgent* domDebuggerAgent = instrumentingAgents.inspectorDOMDebuggerAgent())
+        domDebuggerAgent->didHandleEvent();
 }
 

trunk/Source/WebCore/inspector/InspectorInstrumentation.h

@@ -154 +154 @@
     static InspectorInstrumentationCookie willDispatchEvent(Document&, const Event&, bool hasEventListeners);
     static void didDispatchEvent(const InspectorInstrumentationCookie&);
-    static void willHandleEvent(ScriptExecutionContext&, const Event&, const RegisteredEventListener&);
+    static void willHandleEvent(ScriptExecutionContext&, Event&, const RegisteredEventListener&);
     static void didHandleEvent(ScriptExecutionContext&);
     static InspectorInstrumentationCookie willDispatchEventOnWindow(Frame*, const Event&, DOMWindow&);
@@ -346 +346 @@
     static bool isEventListenerDisabledImpl(InstrumentingAgents&, EventTarget&, const AtomicString& eventType, EventListener&, bool capture);
     static InspectorInstrumentationCookie willDispatchEventImpl(InstrumentingAgents&, Document&, const Event&, bool hasEventListeners);
-    static void willHandleEventImpl(InstrumentingAgents&, const Event&, const RegisteredEventListener&);
+    static void willHandleEventImpl(InstrumentingAgents&, Event&, const RegisteredEventListener&);
     static void didHandleEventImpl(InstrumentingAgents&);
     static void didDispatchEventImpl(const InspectorInstrumentationCookie&);
@@ -801 +801 @@
 }
 
-inline void InspectorInstrumentation::willHandleEvent(ScriptExecutionContext& context, const Event& event, const RegisteredEventListener& listener)
+inline void InspectorInstrumentation::willHandleEvent(ScriptExecutionContext& context, Event& event, const RegisteredEventListener& listener)
 {
     FAST_RETURN_IF_NO_FRONTENDS(void());

trunk/Source/WebCore/inspector/agents/InspectorDOMDebuggerAgent.cpp

@@ -38 +38 @@
 #include "InspectorDOMAgent.h"
 #include "InstrumentingAgents.h"
+#include "JSEvent.h"
 #include "RegisteredEventListener.h"
 #include <JavaScriptCore/ContentSearchUtilities.h>
+#include <JavaScriptCore/InjectedScript.h>
+#include <JavaScriptCore/InjectedScriptManager.h>
 #include <JavaScriptCore/InspectorFrontendDispatchers.h>
 #include <JavaScriptCore/RegularExpression.h>
@@ -66 +69 @@
     : InspectorAgentBase("DOMDebugger"_s, context)
     , m_backendDispatcher(Inspector::DOMDebuggerBackendDispatcher::create(context.backendDispatcher, this))
+    , m_injectedScriptManager(context.injectedScriptManager)
     , m_domAgent(domAgent)
     , m_debuggerAgent(debuggerAgent)
@@ -366 +370 @@
 }
 
-void InspectorDOMDebuggerAgent::willHandleEvent(const Event& event, const RegisteredEventListener& registeredEventListener)
-{
-    if (!m_debuggerAgent->breakpointsActive())
-        return;
+void InspectorDOMDebuggerAgent::willHandleEvent(Event& event, const RegisteredEventListener& registeredEventListener)
+{
+    if (!m_debuggerAgent->breakpointsActive())
+        return;
+
+    auto state = event.target()->scriptExecutionContext()->execState();
+    auto injectedScript = m_injectedScriptManager.injectedScriptFor(state);
+    ASSERT(!injectedScript.hasNoValue());
+    {
+        JSC::JSLockHolder lock(state);
+
+        injectedScript.setEventValue(toJS(state, deprecatedGlobalObjectForPrototype(state), event));
+    }
 
     bool shouldPause = m_debuggerAgent->pauseOnNextStatementEnabled() || m_eventBreakpoints.contains(std::make_pair(Inspector::Protocol::DOMDebugger::EventBreakpointType::Listener, event.type()));
@@ -388 +401 @@
 
     m_debuggerAgent->schedulePauseOnNextStatement(Inspector::DebuggerFrontendDispatcher::Reason::EventListener, WTFMove(eventData));
+}
+
+void InspectorDOMDebuggerAgent::didHandleEvent()
+{
+    m_injectedScriptManager.clearEventValue();
 }
 

trunk/Source/WebCore/inspector/agents/InspectorDOMDebuggerAgent.h

@@ -39 +39 @@
 #include <wtf/text/WTFString.h>
 
+namespace Inspector {
+class InjectedScriptManager;
+}
+
 namespace WebCore {
 
@@ -75 +79 @@
     void willFetch(const String& url);
     void frameDocumentUpdated(Frame&);
-    void willHandleEvent(const Event&, const RegisteredEventListener&);
+    void willHandleEvent(Event&, const RegisteredEventListener&);
+    void didHandleEvent();
     void willFireTimer(bool oneShot);
     void willFireAnimationFrame();
@@ -99 +104 @@
 
     RefPtr<Inspector::DOMDebuggerBackendDispatcher> m_backendDispatcher;
+    Inspector::InjectedScriptManager& m_injectedScriptManager;
     InspectorDOMAgent* m_domAgent { nullptr };
     Inspector::InspectorDebuggerAgent* m_debuggerAgent { nullptr };

trunk/Source/WebInspectorUI/ChangeLog

@@ +1 @@
+2019-03-19  Devin Rousso  <drousso@apple.com>
+
+        Web Inspector: Provide $event in the console when paused on an event listener
+        https://bugs.webkit.org/show_bug.cgi?id=188672
+
+        Reviewed by Timothy Hatcher.
+
+        * UserInterface/Controllers/JavaScriptRuntimeCompletionProvider.js:
+        (WI.JavaScriptRuntimeCompletionProvider.prototype.completionControllerCompletionsNeeded.receivedPropertyNames):
+
 2019-03-19  Devin Rousso  <drousso@apple.com>
 

trunk/Source/WebInspectorUI/UserInterface/Controllers/JavaScriptRuntimeCompletionProvider.js

@@ -222 +222 @@
                 if (WI.debuggerManager.paused) {
                     let targetData = WI.debuggerManager.dataForTarget(WI.runtimeManager.activeExecutionContext.target);
-                    if (targetData.pauseReason === WI.DebuggerManager.PauseReason.Exception)
+                    if (targetData.pauseReason === WI.DebuggerManager.PauseReason.EventListener)
+                        commandLineAPI.push("$event");
+                    else if (targetData.pauseReason === WI.DebuggerManager.PauseReason.Exception)
                         commandLineAPI.push("$exception");
                 }