DevTools: Support XHR async call stacks in the debugger.

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 17 matching lines @@
  * 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 "core/xml/XMLHttpRequest.h"
+#include "core/xml/XMLHttpRequestUpload.h"
+#include "wtf/text/AtomicStringHash.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;
@@ skipping 56 matching lines @@
         }
         return result.release();
     }
 
 public:
     AsyncCallStackTracker* m_tracker;
     HashSet<int> m_intervalTimerIds;
     HashMap<int, RefPtr<AsyncCallChain> > m_timerCallChains;
     HashMap<int, RefPtr<AsyncCallChain> > m_animationFrameCallChains;
     HashMap<EventTarget*, EventListenerAsyncCallChainVectorHashMap> m_eventTargetCallChains;
+    HashMap<EventTarget*, RefPtr<AsyncCallChain> > m_xhrCallChains;
 };
 
+static XMLHttpRequest* xmlHttpRequestFor(EventTarget* eventTarget)

[yurys, 2013/12/23 09:11:57]

toXmlHttpRequest ?

[aandrey, 2013/12/23 12:09:38]

Done.

+{
+    const AtomicString& interfaceName = eventTarget->interfaceName();
+    if (interfaceName == EventTargetNames::XMLHttpRequest)
+        return static_cast<XMLHttpRequest*>(eventTarget);
+    if (interfaceName == EventTargetNames::XMLHttpRequestUpload)
+        return static_cast<XMLHttpRequestUpload*>(eventTarget)->xmlHttpRequest();
+    return 0;
+}
+
 AsyncCallStackTracker::AsyncCallStack::AsyncCallStack(const String& description, const ScriptValue& callFrames)
     : m_description(description)
     , m_callFrames(callFrames)
 {
 }
 
 AsyncCallStackTracker::AsyncCallStack::~AsyncCallStack()
 {
 }
 
@@ skipping 47 matching lines @@
     data->m_intervalTimerIds.remove(timerId);
     data->m_timerCallChains.remove(timerId);
 }
 
 void AsyncCallStackTracker::willFireTimer(ExecutionContext* context, int timerId)
 {
     ASSERT(context);
     ASSERT(isEnabled());
     ASSERT(timerId > 0);
     ASSERT(!m_currentAsyncCallChain);
-    ExecutionContextData* data = m_executionContextDataMap.get(context);
-    if (!data)
-        return;
-    if (data->m_intervalTimerIds.contains(timerId))
-        setCurrentAsyncCallChain(data->m_timerCallChains.get(timerId));
-    else
-        setCurrentAsyncCallChain(data->m_timerCallChains.take(timerId));
+    if (ExecutionContextData* data = m_executionContextDataMap.get(context)) {
+        if (data->m_intervalTimerIds.contains(timerId))
+            setCurrentAsyncCallChain(data->m_timerCallChains.get(timerId));
+        else
+            setCurrentAsyncCallChain(data->m_timerCallChains.take(timerId));
+    } else {
+        setCurrentAsyncCallChain(0);

[yurys, 2013/12/23 09:11:57]

Can we test this branch?

[aandrey, 2013/12/23 12:09:38]

Added new test: LayoutTests/inspector/debugger/async-callstack-middle-run.html

[yurys, 2013/12/23 12:40:31]

Thank you!

+    }
 }
 
 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 13 matching lines @@
 }
 
 void AsyncCallStackTracker::willFireAnimationFrame(ExecutionContext* context, int callbackId)
 {
     ASSERT(context);
     ASSERT(isEnabled());
     ASSERT(callbackId > 0);
     ASSERT(!m_currentAsyncCallChain);
     if (ExecutionContextData* data = m_executionContextDataMap.get(context))
         setCurrentAsyncCallChain(data->m_animationFrameCallChains.take(callbackId));
+    else
+        setCurrentAsyncCallChain(0);
 }
 
 void AsyncCallStackTracker::didAddEventListener(EventTarget* eventTarget, const AtomicString& eventType, EventListener* listener, bool useCapture, const ScriptValue& callFrames)
 {
     ASSERT(eventTarget->executionContext());
     ASSERT(isEnabled());
-    if (!validateCallFrames(callFrames))
+    if (!validateCallFrames(callFrames) || xmlHttpRequestFor(eventTarget))
         return;
 
     StringBuilder description;
     description.append(eventTarget->interfaceName());
     if (!description.isEmpty())
         description.append(".");
     if (listener->isAttribute()) {
         description.append("on");
         description.append(eventType);
     } else {
@@ skipping 19 matching lines @@
     ASSERT(eventTarget->executionContext());
     ASSERT(isEnabled());
     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());
     ASSERT(isEnabled());
+    if (XMLHttpRequest* xhr = xmlHttpRequestFor(eventTarget)) {
+        willHandleXHREvent(xhr, eventTarget, eventType);
+        return;
+    }
     if (ExecutionContextData* data = m_executionContextDataMap.get(eventTarget->executionContext()))
         setCurrentAsyncCallChain(data->findEventListenerData(eventTarget, eventType, RegisteredEventListener(listener, useCapture)));
+    else
+        setCurrentAsyncCallChain(0);
+}
+
+void AsyncCallStackTracker::willLoadXHR(XMLHttpRequest* xhr, const ScriptValue& callFrames)
+{
+    DEFINE_STATIC_LOCAL(String, xhrSendName, ("XMLHttpRequest.send"));

[yurys, 2013/12/23 09:11:57]

This is not thread-safe and may be called on Worker's thread.

[aandrey, 2013/12/23 12:09:38]

Done. I also removed other DEFINE_STATIC_LOCAL's

+
+    ASSERT(xhr->executionContext());
+    ASSERT(isEnabled());
+    if (!validateCallFrames(callFrames))
+        return;
+    ExecutionContextData* data = createContextDataIfNeeded(xhr->executionContext());
+    data->m_xhrCallChains.set(xhr, createAsyncCallChain(xhrSendName, callFrames));
+}
+
+void AsyncCallStackTracker::willHandleXHREvent(XMLHttpRequest* xhr, EventTarget* eventTarget, const AtomicString& eventType)
+{
+    ASSERT(xhr->executionContext());
+    ASSERT(isEnabled());
+    if (ExecutionContextData* data = m_executionContextDataMap.get(xhr->executionContext())) {
+        if (xhr == eventTarget && eventType == EventTypeNames::loadend)

[yurys, 2013/12/23 09:11:57]

What is xhr == eventTarget? Is it check for upload vs download?

[aandrey, 2013/12/23 12:09:38]

Yes, essentially.
The "loadend" on XHR is the corresponding "did" event to willLoadXHR. We should
store XHR data between the two.

[yurys, 2013/12/23 12:40:31]

Consider assigning it to a named variable like isUpload = (xhr != eventTarget);
for better readability.

[aandrey, 2013/12/23 13:01:29]

Assigned to isXHRDownload.

+            setCurrentAsyncCallChain(data->m_xhrCallChains.take(xhr));
+        else
+            setCurrentAsyncCallChain(data->m_xhrCallChains.get(xhr));
+    } else {
+        setCurrentAsyncCallChain(0);
+    }
 }
 
 void AsyncCallStackTracker::didFireAsyncCall()
 {
-    setCurrentAsyncCallChain(0);
+    clearCurrentAsyncCallChain();
 }
 
 PassRefPtr<AsyncCallStackTracker::AsyncCallChain> AsyncCallStackTracker::createAsyncCallChain(const String& description, const ScriptValue& callFrames)
 {
     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;
+        ++m_nestedAsyncCallCount;
     } else if (chain) {
         m_currentAsyncCallChain = chain;
         m_nestedAsyncCallCount = 1;
     }
 }
 
+void AsyncCallStackTracker::clearCurrentAsyncCallChain()
+{
+    if (!m_nestedAsyncCallCount)
+        return;
+    --m_nestedAsyncCallCount;
+    if (!m_nestedAsyncCallCount)
+        m_currentAsyncCallChain.clear();
+}
+
 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();
 }
 
 AsyncCallStackTracker::ExecutionContextData* AsyncCallStackTracker::createContextDataIfNeeded(ExecutionContext* context)
 {
     ExecutionContextData* data = m_executionContextDataMap.get(context);
     if (!data) {
         data = new AsyncCallStackTracker::ExecutionContextData(this, context);
         m_executionContextDataMap.set(context, data);
     }
     return data;
 }
 
 void AsyncCallStackTracker::clear()
 {
-    m_currentAsyncCallChain = 0;
+    m_currentAsyncCallChain.clear();
     m_nestedAsyncCallCount = 0;
     ExecutionContextDataMap copy;
     m_executionContextDataMap.swap(copy);
     for (ExecutionContextDataMap::const_iterator it = copy.begin(); it != copy.end(); ++it)
         delete it->value;
 }
 
 } // namespace WebCore