DevTools: Implement async call stacks for Promises.

Source/bindings/v8/custom/V8PromiseCustom.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 27 matching lines @@
 #include "bindings/v8/ScriptFunctionCall.h"
 #include "bindings/v8/ScriptState.h"
 #include "bindings/v8/V8Binding.h"
 #include "bindings/v8/V8HiddenPropertyName.h"
 #include "bindings/v8/V8PerIsolateData.h"
 #include "bindings/v8/V8ScriptRunner.h"
 #include "bindings/v8/WrapperTypeInfo.h"
 #include "core/dom/Document.h"
 #include "core/dom/ExecutionContextTask.h"
 #include "core/frame/DOMWindow.h"
+#include "core/inspector/InspectorInstrumentation.h"
 #include "core/workers/WorkerGlobalScope.h"
 #include "platform/Task.h"
 #include "wtf/Deque.h"
 #include "wtf/Functional.h"
 #include "wtf/Noncopyable.h"
 #include "wtf/PassOwnPtr.h"
 
 namespace WebCore {
 
 namespace {
@@ skipping 125 matching lines @@
     }
 
     ASSERT(!derivedPromise.IsEmpty());
     derivedPromises->Set(derivedPromises->Length(), derivedPromise);
 
     // Since they are treated as a tuple,
     // we need to guaranteed that the length of these arrays are same.
     ASSERT(fulfillCallbacks->Length() == rejectCallbacks->Length() && rejectCallbacks->Length() == derivedPromises->Length());
 }
 
+class TaskPerformScopeForInstrumentation {
+public:
+    TaskPerformScopeForInstrumentation(ExecutionContext* context, ExecutionContextTask* task)
+        : m_cookie(InspectorInstrumentation::willPerformPromiseTask(context, task))
+    {
+    }
+
+    ~TaskPerformScopeForInstrumentation()
+    {
+        InspectorInstrumentation::didPerformPromiseTask(m_cookie);
+    }
+
+private:
+    InspectorInstrumentationCookie m_cookie;
+};
+
 class CallHandlerTask FINAL : public ExecutionContextTask {
 public:
-    CallHandlerTask(v8::Handle<v8::Object> promise, v8::Handle<v8::Function> handler, v8::Handle<v8::Value> argument, v8::Isolate* isolate, ExecutionContext* context)
+    CallHandlerTask(v8::Handle<v8::Object> promise, v8::Handle<v8::Function> handler, v8::Handle<v8::Value> argument, V8PromiseCustom::PromiseState originatorState, v8::Isolate* isolate, ExecutionContext* context)
         : m_promise(isolate, promise)
         , m_handler(isolate, handler)
         , m_argument(isolate, argument)
         , m_requestState(context)
     {
         ASSERT(!m_promise.isEmpty());
         ASSERT(!m_handler.isEmpty());
         ASSERT(!m_argument.isEmpty());
+        InspectorInstrumentation::didPostPromiseTask(context, this, originatorState == V8PromiseCustom::Fulfilled);
     }
     virtual ~CallHandlerTask() { }
 
     virtual void performTask(ExecutionContext*) OVERRIDE;
 
 private:
     ScopedPersistent<v8::Object> m_promise;
     ScopedPersistent<v8::Function> m_handler;
     ScopedPersistent<v8::Value> m_argument;
     DOMRequestState m_requestState;
 };
 
 void CallHandlerTask::performTask(ExecutionContext* context)
 {
+    TaskPerformScopeForInstrumentation performTaskScope(context, this);

[yhirano, 2014/01/15 13:28:55]

Can you place this statement after L240?
It is good not to touch a stopped context.

[aandrey, 2014/01/15 14:49:53]

Will be memory leak, as we need to clean up our internal instrumentation data.

We do not execute any of the ExecutionContext method. Instrumentation classes
will be accessed via: toDocument(context)->page()->inspectorController(), which
should be harmless even on stopped contexts.

+
     ASSERT(context);
     if (context->activeDOMObjectsAreStopped())
         return;
 
     DOMRequestState::Scope scope(m_requestState);
     v8::Isolate* isolate = m_requestState.isolate();
     v8::Handle<v8::Value> info[] = { m_argument.newLocal(isolate) };
     v8::TryCatch trycatch;
     v8::Local<v8::Value> value = V8ScriptRunner::callFunction(m_handler.newLocal(isolate), context, v8::Undefined(isolate), WTF_ARRAY_LENGTH(info), info, isolate);
     if (value.IsEmpty()) {
         V8PromiseCustom::reject(m_promise.newLocal(isolate), trycatch.Exception(), isolate);
     } else {
         V8PromiseCustom::resolve(m_promise.newLocal(isolate), value, isolate);
     }
 }
 
 class UpdateDerivedTask FINAL : public ExecutionContextTask {
 public:
     UpdateDerivedTask(v8::Handle<v8::Object> promise, v8::Handle<v8::Function> onFulfilled, v8::Handle<v8::Function> onRejected, v8::Handle<v8::Object> originatorValueObject, v8::Isolate* isolate, ExecutionContext* context)
         : m_promise(isolate, promise)
         , m_onFulfilled(isolate, onFulfilled)
         , m_onRejected(isolate, onRejected)
         , m_originatorValueObject(isolate, originatorValueObject)
         , m_requestState(context)
     {
         ASSERT(!m_promise.isEmpty());
         ASSERT(!m_originatorValueObject.isEmpty());
+        InspectorInstrumentation::didPostPromiseTask(context, this, true);

[yhirano, 2014/01/14 04:54:38]

Why is the third parameter always true?

[aandrey, 2014/01/14 05:35:53]

This indicates that the Promise originatorState is Fulfilled. It's always the
case for UpdateDerivedTask.

     }
     virtual ~UpdateDerivedTask() { }
 
     virtual void performTask(ExecutionContext*) OVERRIDE;
 
 private:
     ScopedPersistent<v8::Object> m_promise;
     ScopedPersistent<v8::Function> m_onFulfilled;
     ScopedPersistent<v8::Function> m_onRejected;
     ScopedPersistent<v8::Object> m_originatorValueObject;
     DOMRequestState m_requestState;
 };
 
 void UpdateDerivedTask::performTask(ExecutionContext* context)
 {
+    TaskPerformScopeForInstrumentation performTaskScope(context, this);

[yhirano, 2014/01/15 13:28:55]

ditto as L236

+
     ASSERT(context);
     if (context->activeDOMObjectsAreStopped())
         return;
 
     DOMRequestState::Scope scope(m_requestState);
     v8::Isolate* isolate = m_requestState.isolate();
     v8::Local<v8::Object> originatorValueObject = m_originatorValueObject.newLocal(isolate);
     v8::Local<v8::Value> coercedAlready = originatorValueObject->GetHiddenValue(V8HiddenPropertyName::thenableHiddenPromise(isolate));
     if (!coercedAlready.IsEmpty() && coercedAlready->IsObject()) {
         ASSERT(V8PromiseCustom::isPromise(coercedAlready.As<v8::Object>(), isolate));
@@ skipping 136 matching lines @@
         }
 
         m_derivedStack.append(Derived::create(derivedPromise, onFulfilled, onRejected, promise, isolate));
     }
     clearDerived(internal, isolate);
 }
 
 void PromisePropagator::updateDerivedFromValue(v8::Handle<v8::Object> derivedPromise, v8::Handle<v8::Function> onFulfilled, v8::Handle<v8::Value> value, v8::Isolate* isolate)
 {
     if (!onFulfilled.IsEmpty()) {
-        V8PromiseCustom::callHandler(derivedPromise, onFulfilled, value, isolate);
+        V8PromiseCustom::callHandler(derivedPromise, onFulfilled, value, V8PromiseCustom::Fulfilled, isolate);
     } else {
         setValue(derivedPromise, value, isolate);
     }
 }
 
 void PromisePropagator::updateDerivedFromReason(v8::Handle<v8::Object> derivedPromise, v8::Handle<v8::Function> onRejected, v8::Handle<v8::Value> reason, v8::Isolate* isolate)
 {
     if (!onRejected.IsEmpty()) {
-        V8PromiseCustom::callHandler(derivedPromise, onRejected, reason, isolate);
+        V8PromiseCustom::callHandler(derivedPromise, onRejected, reason, V8PromiseCustom::Rejected, isolate);
     } else {
         setReason(derivedPromise, reason, isolate);
     }
 }
 
 void PromisePropagator::updateDerived(v8::Handle<v8::Object> derivedPromise, v8::Handle<v8::Function> onFulfilled, v8::Handle<v8::Function> onRejected, v8::Handle<v8::Object> originator, v8::Isolate* isolate)
 {
     v8::Local<v8::Object> originatorInternal = V8PromiseCustom::getInternal(originator);
     V8PromiseCustom::PromiseState originatorState = V8PromiseCustom::getState(originatorInternal);
     ASSERT(originatorState == V8PromiseCustom::Fulfilled || originatorState == V8PromiseCustom::Rejected);
@@ skipping 340 matching lines @@
         createClosure(promiseRejectCallback, promise, isolate)
     };
     v8::TryCatch trycatch;
     if (V8ScriptRunner::callFunction(then, getExecutionContext(), thenable, WTF_ARRAY_LENGTH(argv), argv, isolate).IsEmpty()) {
         reject(promise, trycatch.Exception(), isolate);
     }
     thenable->SetHiddenValue(V8HiddenPropertyName::thenableHiddenPromise(isolate), promise);
     return promise;
 }
 
-void V8PromiseCustom::callHandler(v8::Handle<v8::Object> promise, v8::Handle<v8::Function> handler, v8::Handle<v8::Value> argument, v8::Isolate* isolate)
+void V8PromiseCustom::callHandler(v8::Handle<v8::Object> promise, v8::Handle<v8::Function> handler, v8::Handle<v8::Value> argument, PromiseState originatorState, v8::Isolate* isolate)
 {
+    ASSERT(originatorState == Fulfilled || originatorState == Rejected);
     ExecutionContext* executionContext = getExecutionContext();
     ASSERT(executionContext && executionContext->isContextThread());
-    executionContext->postTask(adoptPtr(new CallHandlerTask(promise, handler, argument, isolate, executionContext)));
+    executionContext->postTask(adoptPtr(new CallHandlerTask(promise, handler, argument, originatorState, isolate, executionContext)));
 }
 
 } // namespace WebCore