DevTools: Capture async stacks for event listeners.

Source/core/inspector/AsyncCallStackTracker.cpp

 /*
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 15 matching lines @@
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "config.h"
 #include "core/inspector/AsyncCallStackTracker.h"
 
 #include "core/dom/ContextLifecycleObserver.h"
 #include "core/dom/ExecutionContext.h"
+#include "core/events/EventTarget.h"
+#include "core/events/RegisteredEventListener.h"
+#include "wtf/text/StringBuilder.h"
 
 namespace WebCore {
 
 class AsyncCallStackTracker::ExecutionContextData : public ContextLifecycleObserver {
     WTF_MAKE_FAST_ALLOCATED;
 public:
+    typedef std::pair<RegisteredEventListener, RefPtr<AsyncCallChain> > EventListenerAsyncCallChain;
+    typedef Vector<EventListenerAsyncCallChain, 1> EventListenerAsyncCallChainVector;
+    typedef HashMap<AtomicString, EventListenerAsyncCallChainVector> EventListenerAsyncCallChainVectorHashMap;
+
     ExecutionContextData(AsyncCallStackTracker* tracker, ExecutionContext* executionContext)
         : ContextLifecycleObserver(executionContext)
         , m_tracker(tracker)
     {
     }
 
     virtual void contextDestroyed() OVERRIDE
     {
         m_tracker->contextDestroyed(executionContext());
         ContextLifecycleObserver::contextDestroyed();
     }
 
+    void add(EventTarget* eventTarget, const AtomicString& eventType, const EventListenerAsyncCallChain& item)

[yurys, 2013/12/17 13:01:59]

addEventListenerData?

[aandrey, 2013/12/17 13:24:03]

Done.

+    {
+        HashMap<EventTarget*, EventListenerAsyncCallChainVectorHashMap>::iterator it = m_eventTargetCallChains.find(eventTarget);
+        if (it == m_eventTargetCallChains.end())
+            it = m_eventTargetCallChains.set(eventTarget, EventListenerAsyncCallChainVectorHashMap()).iterator;
+        EventListenerAsyncCallChainVectorHashMap& map = it->value;
+        EventListenerAsyncCallChainVectorHashMap::iterator it2 = map.find(eventType);
+        if (it2 == map.end())
+            it2 = map.set(eventType, EventListenerAsyncCallChainVector()).iterator;
+        it2->value.append(item);
+    }
+
+    void remove(EventTarget* eventTarget, const AtomicString& eventType, const RegisteredEventListener& item)
+    {
+        get(eventTarget, eventType, item, true);
+    }
+
+    PassRefPtr<AsyncCallChain> get(EventTarget* eventTarget, const AtomicString& eventType, const RegisteredEventListener& item, bool remove = false)
+    {
+        HashMap<EventTarget*, EventListenerAsyncCallChainVectorHashMap>::iterator it = m_eventTargetCallChains.find(eventTarget);
+        if (it == m_eventTargetCallChains.end())
+            return 0;
+        EventListenerAsyncCallChainVectorHashMap& map = it->value;
+        EventListenerAsyncCallChainVectorHashMap::iterator it2 = map.find(eventType);
+        if (it2 == map.end())
+            return 0;
+        RefPtr<AsyncCallChain> result;
+        EventListenerAsyncCallChainVector& vector = it2->value;
+        for (size_t i = 0; i < vector.size(); ++i) {
+            if (vector[i].first == item) {
+                result = vector[i].second;
+                if (remove) {
+                    vector.remove(i);
+                    if (vector.isEmpty())
+                        map.remove(it2);
+                    if (map.isEmpty())
+                        m_eventTargetCallChains.remove(it);
+                }
+                break;
+            }
+        }
+        return result.release();
+    }
+
 private:
     friend class AsyncCallStackTracker;

[yurys, 2013/12/17 13:01:59]

All these field should be public since ExecutionContextData is an implementation
detail of AsyncCallStackTracker

[aandrey, 2013/12/17 13:24:03]

Done.

     AsyncCallStackTracker* m_tracker;
     HashSet<int> m_intervalTimerIds;
     HashMap<int, RefPtr<AsyncCallChain> > m_timerCallChains;
     HashMap<int, RefPtr<AsyncCallChain> > m_animationFrameCallChains;
+    HashMap<EventTarget*, EventListenerAsyncCallChainVectorHashMap> m_eventTargetCallChains;
 };
 
 AsyncCallStackTracker::AsyncCallStack::AsyncCallStack(const String& description, const ScriptValue& callFrames)
     : m_description(description)
     , m_callFrames(callFrames)
 {
 }
 
 AsyncCallStackTracker::AsyncCallStack::~AsyncCallStack()
 {
@@ skipping 48 matching lines @@
     data->m_intervalTimerIds.remove(timerId);
     data->m_timerCallChains.remove(timerId);
 }
 
 void AsyncCallStackTracker::willFireTimer(ExecutionContext* context, int timerId)
 {
     ASSERT(context);
     if (!isEnabled())
         return;
     ASSERT(timerId > 0);
-    ASSERT(!m_currentAsyncCallChain);

[yurys, 2013/12/17 13:01:59]

Why did you remove this assert? Can it fail in a wrong place?

[aandrey, 2013/12/17 13:07:48]

We can receive nested willHandleEvent() callbacks, thus this ASSERT is not valid
there. I'm not sure about willFireTimer() though.

[aandrey, 2013/12/17 13:24:03]

Done.

[yurys, 2013/12/18 09:22:15]

I agree that it make sense for willHandleEvent which can be nested but how can
we get willFireTimer or willFireAnimationFrame nested in another event?

[aandrey, 2013/12/18 09:32:09]

I think they can not. Added those ASSERT's back.

     ExecutionContextData* data = m_executionContextDataMap.get(context);
     if (!data)
         return;
     if (data->m_intervalTimerIds.contains(timerId))
-        m_currentAsyncCallChain = data->m_timerCallChains.get(timerId);
+        setCurrentAsyncCallChain(data->m_timerCallChains.get(timerId));
     else
-        m_currentAsyncCallChain = data->m_timerCallChains.take(timerId);
+        setCurrentAsyncCallChain(data->m_timerCallChains.take(timerId));
 }
 
 void AsyncCallStackTracker::didRequestAnimationFrame(ExecutionContext* context, int callbackId, const ScriptValue& callFrames)
 {
     DEFINE_STATIC_LOCAL(String, requestAnimationFrameName, ("requestAnimationFrame"));
 
     ASSERT(context);
     ASSERT(isEnabled());
     if (!validateCallFrames(callFrames))
         return;
@@ skipping 10 matching lines @@
     if (ExecutionContextData* data = m_executionContextDataMap.get(context))
         data->m_animationFrameCallChains.remove(callbackId);
 }
 
 void AsyncCallStackTracker::willFireAnimationFrame(ExecutionContext* context, int callbackId)
 {
     ASSERT(context);
     if (!isEnabled())
         return;
     ASSERT(callbackId > 0);
-    ASSERT(!m_currentAsyncCallChain);
     if (ExecutionContextData* data = m_executionContextDataMap.get(context))
-        m_currentAsyncCallChain = data->m_animationFrameCallChains.take(callbackId);
+        setCurrentAsyncCallChain(data->m_animationFrameCallChains.take(callbackId));
+}
+
+void AsyncCallStackTracker::didAddEventListener(EventTarget* eventTarget, const AtomicString& eventType, EventListener* listener, bool useCapture, const ScriptValue& callFrames)
+{
+    ASSERT(eventTarget->executionContext());
+    ASSERT(isEnabled());
+    if (!validateCallFrames(callFrames))
+        return;
+
+    StringBuilder description;
+    description.append(eventTarget->interfaceName());
+    if (!description.isEmpty())
+        description.append(".");
+    if (listener->isAttribute()) {
+        description.append("on");
+        description.append(eventType);
+    } else {
+        description.append("addEventListener(\"");
+        description.append(eventType);
+        description.append("\")");
+    }
+
+    ExecutionContextData* data = createContextDataIfNeeded(eventTarget->executionContext());
+    data->add(eventTarget, eventType, std::make_pair(RegisteredEventListener(listener, useCapture), createAsyncCallChain(description.toString(), callFrames)));
+}
+
+void AsyncCallStackTracker::didRemoveEventListener(EventTarget* eventTarget, const AtomicString& eventType, EventListener* listener, bool useCapture)
+{
+    ASSERT(eventTarget->executionContext());
+    if (!isEnabled())
+        return;
+    if (ExecutionContextData* data = m_executionContextDataMap.get(eventTarget->executionContext()))
+        data->remove(eventTarget, eventType, RegisteredEventListener(listener, useCapture));
+}
+
+void AsyncCallStackTracker::didRemoveAllEventListeners(EventTarget* eventTarget)
+{
+    ASSERT(eventTarget->executionContext());
+    if (!isEnabled())
+        return;
+    if (ExecutionContextData* data = m_executionContextDataMap.get(eventTarget->executionContext()))
+        data->m_eventTargetCallChains.remove(eventTarget);
+}
+
+void AsyncCallStackTracker::willHandleEvent(EventTarget* eventTarget, const AtomicString& eventType, EventListener* listener, bool useCapture)
+{
+    ASSERT(eventTarget->executionContext());
+    if (!isEnabled())
+        return;
+    if (ExecutionContextData* data = m_executionContextDataMap.get(eventTarget->executionContext()))
+        setCurrentAsyncCallChain(data->get(eventTarget, eventType, RegisteredEventListener(listener, useCapture)));
 }
 
 void AsyncCallStackTracker::didFireAsyncCall()
 {
-    m_currentAsyncCallChain = 0;
+    setCurrentAsyncCallChain(0);
 }
 
 PassRefPtr<AsyncCallStackTracker::AsyncCallChain> AsyncCallStackTracker::createAsyncCallChain(const String& description, const ScriptValue& callFrames)
 {
     ASSERT(isEnabled());
     RefPtr<AsyncCallChain> chain = adoptRef(m_currentAsyncCallChain ? new AsyncCallStackTracker::AsyncCallChain(*m_currentAsyncCallChain) : new AsyncCallStackTracker::AsyncCallChain());
     ensureMaxAsyncCallChainDepth(chain.get(), m_maxAsyncCallStackDepth - 1);
     chain->m_callStacks.prepend(adoptRef(new AsyncCallStackTracker::AsyncCallStack(description, callFrames)));
     return chain.release();
 }
 
+void AsyncCallStackTracker::setCurrentAsyncCallChain(PassRefPtr<AsyncCallChain> chain)
+{
+    if (m_currentAsyncCallChain) {
+        m_nestedAsyncCallCount += chain ? 1 : -1;
+        if (!m_nestedAsyncCallCount)
+            m_currentAsyncCallChain = 0;
+    } else if (chain) {
+        m_currentAsyncCallChain = chain;
+        m_nestedAsyncCallCount = 1;
+    }
+}
+
 void AsyncCallStackTracker::ensureMaxAsyncCallChainDepth(AsyncCallChain* chain, unsigned maxDepth)
 {
     while (chain->m_callStacks.size() > maxDepth)
         chain->m_callStacks.removeLast();
 }
 
 bool AsyncCallStackTracker::validateCallFrames(const ScriptValue& callFrames)
 {
     return !callFrames.hasNoValue();
 }
@@ skipping 11 matching lines @@
     if (!data) {
         data = new AsyncCallStackTracker::ExecutionContextData(this, context);
         m_executionContextDataMap.set(context, data);
     }
     return data;
 }
 
 void AsyncCallStackTracker::clear()
 {
     m_currentAsyncCallChain = 0;
+    m_nestedAsyncCallCount = 0;
     Vector<ExecutionContextData*> contextsData;
     copyValuesToVector(m_executionContextDataMap, contextsData);
     m_executionContextDataMap.clear();
     for (Vector<ExecutionContextData*>::const_iterator it = contextsData.begin(); it != contextsData.end(); ++it)
         delete *it;
 }
 
 } // namespace WebCore