[DevTools] Add awaitPromise flag for Runtime.callFunctionOn protocol method

third_party/WebKit/Source/platform/v8_inspector/V8RuntimeAgentImpl.cpp

 /*
  * Copyright (C) 2011 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 45 matching lines @@
     if (hasError)
         *errorString = "Internal error";
     return hasError;
 }
 
 namespace {
 
 template<typename Callback>
 class ProtocolPromiseHandler {
 public:
-    static void add(V8DebuggerImpl* debugger, int contextGroupId, const String16& promiseObjectId, std::unique_ptr<Callback> callback, bool returnByValue, bool generatePreview)
+    static void add(V8DebuggerImpl* debugger, v8::Local<v8::Context> context, v8::Local<v8::Value> value, int contextGroupId, int executionContextId, const String16& objectGroup, bool returnByValue, bool generatePreview, std::unique_ptr<Callback> callback)
     {
-        ErrorString errorString;
-        InjectedScript::ObjectScope scope(&errorString, debugger, contextGroupId, promiseObjectId);
-        if (!scope.initialize()) {
-            callback->sendFailure(errorString);
-            return;
-        }
-        if (!scope.object()->IsPromise()) {
+        if (!value->IsPromise()) {

[dgozman, 2016/08/02 16:52:51]

Since you already do this check in 2 out of 3 methods manually, let's move it to
the last one, and pass v8::Local<v8::Promise> here.

[kozy, 2016/08/02 17:31:38]

Done.

             callback->sendFailure("Could not find promise with given id");
             return;
         }
+        Callback* rawCallback = callback.get();
+        ProtocolPromiseHandler<Callback>* handler = new ProtocolPromiseHandler(debugger, contextGroupId, executionContextId, objectGroup, returnByValue, generatePreview, std::move(callback));
+        v8::Local<v8::Value> wrapper = handler->m_wrapper.Get(debugger->isolate());
+        v8::Local<v8::Promise> promise = v8::Local<v8::Promise>::Cast(value);
 
-        Callback* rawCallback = callback.get();
-        ProtocolPromiseHandler<Callback>* handler = new ProtocolPromiseHandler(debugger, contextGroupId, promiseObjectId, std::move(callback), returnByValue, generatePreview);
-        v8::Local<v8::Value> wrapper = handler->m_wrapper.Get(debugger->isolate());
-        v8::Local<v8::Promise> promise = v8::Local<v8::Promise>::Cast(scope.object());
-
-        v8::Local<v8::Function> thenCallbackFunction = v8::Function::New(scope.context(), thenCallback, wrapper, 0, v8::ConstructorBehavior::kThrow).ToLocalChecked();
-        if (promise->Then(scope.context(), thenCallbackFunction).IsEmpty()) {
+        v8::Local<v8::Function> thenCallbackFunction = v8::Function::New(context, thenCallback, wrapper, 0, v8::ConstructorBehavior::kThrow).ToLocalChecked();
+        if (promise->Then(context, thenCallbackFunction).IsEmpty()) {
             rawCallback->sendFailure("Internal error");
             return;
         }
-        v8::Local<v8::Function> catchCallbackFunction = v8::Function::New(scope.context(), catchCallback, wrapper, 0, v8::ConstructorBehavior::kThrow).ToLocalChecked();
-        if (promise->Catch(scope.context(), catchCallbackFunction).IsEmpty()) {
+        v8::Local<v8::Function> catchCallbackFunction = v8::Function::New(context, catchCallback, wrapper, 0, v8::ConstructorBehavior::kThrow).ToLocalChecked();
+        if (promise->Catch(context, catchCallbackFunction).IsEmpty()) {
             rawCallback->sendFailure("Internal error");
             return;
         }
     }
-
 private:
     static void thenCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
     {
         ProtocolPromiseHandler<Callback>* handler = static_cast<ProtocolPromiseHandler<Callback>*>(info.Data().As<v8::External>()->Value());
         DCHECK(handler);
         v8::Local<v8::Value> value = info.Length() > 0 ? info[0] : v8::Local<v8::Value>::Cast(v8::Undefined(info.GetIsolate()));
         handler->m_callback->sendSuccess(handler->wrapObject(value), Maybe<bool>(), Maybe<protocol::Runtime::ExceptionDetails>());
     }
 
     static void catchCallback(const v8::FunctionCallbackInfo<v8::Value>& info)
     {
         ProtocolPromiseHandler<Callback>* handler = static_cast<ProtocolPromiseHandler<Callback>*>(info.Data().As<v8::External>()->Value());
         DCHECK(handler);
         v8::Local<v8::Value> value = info.Length() > 0 ? info[0] : v8::Local<v8::Value>::Cast(v8::Undefined(info.GetIsolate()));
 
         std::unique_ptr<protocol::Runtime::ExceptionDetails> exceptionDetails;
         std::unique_ptr<V8StackTraceImpl> stack = handler->m_debugger->captureStackTraceImpl(true);
         if (stack) {
             exceptionDetails = protocol::Runtime::ExceptionDetails::create()
                 .setText("Promise was rejected")
                 .setLineNumber(!stack->isEmpty() ? stack->topLineNumber() : 0)
                 .setColumnNumber(!stack->isEmpty() ? stack->topColumnNumber() : 0)
                 .setScriptId(!stack->isEmpty() ? stack->topScriptId() : String16())
                 .setStackTrace(stack->buildInspectorObjectImpl())
                 .build();
         }
         handler->m_callback->sendSuccess(handler->wrapObject(value), true, std::move(exceptionDetails));
     }
 
-    ProtocolPromiseHandler(V8DebuggerImpl* debugger, int contextGroupId, const String16& promiseObjectId, std::unique_ptr<Callback> callback, bool returnByValue, bool generatePreview)
+    ProtocolPromiseHandler(V8DebuggerImpl* debugger, int contextGroupId, int executionContextId, const String16& objectGroup, bool returnByValue, bool generatePreview, std::unique_ptr<Callback> callback)
         : m_debugger(debugger)
         , m_contextGroupId(contextGroupId)
-        , m_promiseObjectId(promiseObjectId)
-        , m_callback(std::move(callback))
+        , m_executionContextId(executionContextId)
+        , m_objectGroup(objectGroup)
         , m_returnByValue(returnByValue)
         , m_generatePreview(generatePreview)
+        , m_callback(std::move(callback))
         , m_wrapper(debugger->isolate(), v8::External::New(debugger->isolate(), this))
     {
         m_wrapper.SetWeak(this, cleanup, v8::WeakCallbackType::kParameter);
     }
 
     static void cleanup(const v8::WeakCallbackInfo<ProtocolPromiseHandler<Callback>>& data)
     {
         if (!data.GetParameter()->m_wrapper.IsEmpty()) {
             data.GetParameter()->m_wrapper.Reset();
             data.SetSecondPassCallback(cleanup);
         } else {
             data.GetParameter()->m_callback->sendFailure("Promise was collected");
             delete data.GetParameter();
         }
     }
 
     std::unique_ptr<protocol::Runtime::RemoteObject> wrapObject(v8::Local<v8::Value> value)
     {
         ErrorString errorString;
-        InjectedScript::ObjectScope scope(&errorString, m_debugger, m_contextGroupId, m_promiseObjectId);
+        InjectedScript::ContextScope scope(&errorString, m_debugger, m_contextGroupId, m_executionContextId);
         if (!scope.initialize()) {
             m_callback->sendFailure(errorString);
             return nullptr;
         }
-        std::unique_ptr<protocol::Runtime::RemoteObject> wrappedValue = scope.injectedScript()->wrapObject(&errorString, value, scope.objectGroupName(), m_returnByValue, m_generatePreview);
+        std::unique_ptr<protocol::Runtime::RemoteObject> wrappedValue = scope.injectedScript()->wrapObject(&errorString, value, m_objectGroup, m_returnByValue, m_generatePreview);
         if (!wrappedValue) {
             m_callback->sendFailure(errorString);
             return nullptr;
         }
         return wrappedValue;
     }
 
     V8DebuggerImpl* m_debugger;
     int m_contextGroupId;
-    String16 m_promiseObjectId;
-    std::unique_ptr<Callback> m_callback;
+    int m_executionContextId;
+    String16 m_objectGroup;
     bool m_returnByValue;
     bool m_generatePreview;
+    std::unique_ptr<Callback> m_callback;
     v8::Global<v8::External> m_wrapper;
 };
 
+template<typename Callback>
+bool wrapEvaluateResultAsync(InjectedScript* injectedScript, v8::MaybeLocal<v8::Value> maybeResultValue, const v8::TryCatch& tryCatch, const String16& objectGroup, bool returnByValue, bool generatePreview, Callback* callback)
+{
+    std::unique_ptr<RemoteObject> result;
+    Maybe<bool> wasThrown;
+    Maybe<protocol::Runtime::ExceptionDetails> exceptionDetails;
+
+    ErrorString errorString;
+    injectedScript->wrapEvaluateResult(&errorString,
+        maybeResultValue,
+        tryCatch,
+        objectGroup,
+        returnByValue,
+        generatePreview,
+        &result,
+        &wasThrown,
+        &exceptionDetails);
+    if (errorString.isEmpty()) {
+        callback->sendSuccess(std::move(result), wasThrown, exceptionDetails);
+        return true;
+    }
+    callback->sendFailure(errorString);
+    return false;
+}
+
 } // namespace
 
 V8RuntimeAgentImpl::V8RuntimeAgentImpl(V8InspectorSessionImpl* session, protocol::FrontendChannel* FrontendChannel, protocol::DictionaryValue* state)
     : m_session(session)
     , m_state(state)
     , m_frontend(FrontendChannel)
     , m_debugger(session->debugger())
     , m_enabled(false)
 {
 }
@@ skipping 56 matching lines @@
 
     if (evalIsDisabled)
         scope.context()->AllowCodeGenerationFromStrings(false);
 
     // Re-initialize after running client's code, as it could have destroyed context or session.
     if (!scope.initialize()) {
         callback->sendFailure(errorString);
         return;
     }
 
-    std::unique_ptr<RemoteObject> result;
-    Maybe<bool> wasThrown;
-    Maybe<protocol::Runtime::ExceptionDetails> exceptionDetails;
-
-    scope.injectedScript()->wrapEvaluateResult(&errorString,
-        maybeResultValue,
-        scope.tryCatch(),
-        objectGroup.fromMaybe(""),
-        returnByValue.fromMaybe(false) && !awaitPromise.fromMaybe(false),
-        generatePreview.fromMaybe(false) && !awaitPromise.fromMaybe(false),
-        &result,
-        &wasThrown,
-        &exceptionDetails);
-    if (!errorString.isEmpty()) {
-        callback->sendFailure(errorString);
+    if (!awaitPromise.fromMaybe(false) || scope.tryCatch().HasCaught()) {
+        wrapEvaluateResultAsync(scope.injectedScript(), maybeResultValue, scope.tryCatch(), objectGroup.fromMaybe(""), returnByValue.fromMaybe(false), generatePreview.fromMaybe(false), callback.get());
         return;
     }
 
-    if (!awaitPromise.fromMaybe(false) || wasThrown.fromMaybe(false)) {
-        callback->sendSuccess(std::move(result), wasThrown, exceptionDetails);
-        return;
-    }
-
     if (maybeResultValue.IsEmpty()) {
         callback->sendFailure("Internal error");
         return;
     }
 
     if (!maybeResultValue.ToLocalChecked()->IsPromise()) {
         callback->sendFailure("Result of expression is not a promise.");
         return;
     }
 
-    ProtocolPromiseHandler<EvaluateCallback>::add(m_debugger, m_session->contextGroupId(), result->getObjectId(String16()), std::move(callback), returnByValue.fromMaybe(false), generatePreview.fromMaybe(false));
+    ProtocolPromiseHandler<EvaluateCallback>::add(
+        m_debugger,
+        scope.context(),
+        maybeResultValue.ToLocalChecked(),
+        m_session->contextGroupId(),
+        scope.injectedScript()->context()->contextId(),
+        objectGroup.fromMaybe(""),
+        returnByValue.fromMaybe(false),
+        generatePreview.fromMaybe(false),
+        std::move(callback));
 }
 
 void V8RuntimeAgentImpl::awaitPromise(
     const String16& promiseObjectId,
     const Maybe<bool>& returnByValue,
     const Maybe<bool>& generatePreview,
     std::unique_ptr<AwaitPromiseCallback> callback)
 {
-    ProtocolPromiseHandler<AwaitPromiseCallback>::add(m_debugger, m_session->contextGroupId(), promiseObjectId, std::move(callback), returnByValue.fromMaybe(false), generatePreview.fromMaybe(false));
+    ErrorString errorString;
+    InjectedScript::ObjectScope scope(&errorString, m_debugger, m_session->contextGroupId(), promiseObjectId);
+    if (!scope.initialize()) {
+        callback->sendFailure(errorString);
+        return;
+    }
+    ProtocolPromiseHandler<AwaitPromiseCallback>::add(
+        m_debugger,
+        scope.context(),
+        scope.object(),
+        m_session->contextGroupId(),
+        scope.injectedScript()->context()->contextId(),
+        scope.objectGroupName(),
+        returnByValue.fromMaybe(false),
+        generatePreview.fromMaybe(false),
+        std::move(callback));
 }
 
-void V8RuntimeAgentImpl::callFunctionOn(ErrorString* errorString,
+void V8RuntimeAgentImpl::callFunctionOn(
     const String16& objectId,
     const String16& expression,
     const Maybe<protocol::Array<protocol::Runtime::CallArgument>>& optionalArguments,
     const Maybe<bool>& doNotPauseOnExceptionsAndMuteConsole,
     const Maybe<bool>& returnByValue,
     const Maybe<bool>& generatePreview,
     const Maybe<bool>& userGesture,
-    std::unique_ptr<RemoteObject>* result,
-    Maybe<bool>* wasThrown)
+    const Maybe<bool>& awaitPromise,
+    std::unique_ptr<CallFunctionOnCallback> callback)
 {
-    InjectedScript::ObjectScope scope(errorString, m_debugger, m_session->contextGroupId(), objectId);
-    if (!scope.initialize())
+    ErrorString errorString;
+    InjectedScript::ObjectScope scope(&errorString, m_debugger, m_session->contextGroupId(), objectId);
+    if (!scope.initialize()) {
+        callback->sendFailure(errorString);
         return;
+    }
 
     std::unique_ptr<v8::Local<v8::Value>[]> argv = nullptr;
     int argc = 0;
     if (optionalArguments.isJust()) {
         protocol::Array<protocol::Runtime::CallArgument>* arguments = optionalArguments.fromJust();
         argc = arguments->length();
         argv.reset(new v8::Local<v8::Value>[argc]);
         for (int i = 0; i < argc; ++i) {
             v8::Local<v8::Value> argumentValue;
-            if (!scope.injectedScript()->resolveCallArgument(errorString, arguments->get(i)).ToLocal(&argumentValue))
+            if (!scope.injectedScript()->resolveCallArgument(&errorString, arguments->get(i)).ToLocal(&argumentValue)) {
+                callback->sendFailure(errorString);
                 return;
+            }
             argv[i] = argumentValue;
         }
     }
 
     if (doNotPauseOnExceptionsAndMuteConsole.fromMaybe(false))
         scope.ignoreExceptionsAndMuteConsole();
     if (userGesture.fromMaybe(false))
         scope.pretendUserGesture();
 
     v8::MaybeLocal<v8::Value> maybeFunctionValue = m_debugger->compileAndRunInternalScript(scope.context(), toV8String(m_debugger->isolate(), "(" + expression + ")"));
     // Re-initialize after running client's code, as it could have destroyed context or session.
-    if (!scope.initialize())
+    if (!scope.initialize()) {
+        callback->sendFailure(errorString);
         return;
+    }
 
     if (scope.tryCatch().HasCaught()) {
-        scope.injectedScript()->wrapEvaluateResult(errorString, maybeFunctionValue, scope.tryCatch(), scope.objectGroupName(), false, false, result, wasThrown, nullptr);
+        wrapEvaluateResultAsync(scope.injectedScript(), maybeFunctionValue, scope.tryCatch(), scope.objectGroupName(), false, false, callback.get());
         return;
     }
 
     v8::Local<v8::Value> functionValue;
     if (!maybeFunctionValue.ToLocal(&functionValue) || !functionValue->IsFunction()) {
-        *errorString = "Given expression does not evaluate to a function";
+        callback->sendFailure("Given expression does not evaluate to a function");
         return;
     }
 
     v8::MaybeLocal<v8::Value> maybeResultValue = m_debugger->callFunction(functionValue.As<v8::Function>(), scope.context(), scope.object(), argc, argv.get());
     // Re-initialize after running client's code, as it could have destroyed context or session.
-    if (!scope.initialize())
+    if (!scope.initialize()) {
+        callback->sendFailure(errorString);
         return;
+    }
 
-    scope.injectedScript()->wrapEvaluateResult(errorString, maybeResultValue, scope.tryCatch(), scope.objectGroupName(), returnByValue.fromMaybe(false), generatePreview.fromMaybe(false), result, wasThrown, nullptr);
+    if (!awaitPromise.fromMaybe(false) || scope.tryCatch().HasCaught()) {
+        wrapEvaluateResultAsync(scope.injectedScript(), maybeResultValue, scope.tryCatch(), scope.objectGroupName(), returnByValue.fromMaybe(false), generatePreview.fromMaybe(false), callback.get());
+        return;
+    }
+
+    if (maybeResultValue.IsEmpty()) {
+        callback->sendFailure("Internal error");
+        return;
+    }
+
+    if (!maybeResultValue.ToLocalChecked()->IsPromise()) {
+        callback->sendFailure("Result of expression is not a promise.");

[dgozman, 2016/08/02 16:52:51]

Result of the function call is not a promise.

[kozy, 2016/08/02 17:31:38]

Done.

+        return;
+    }
+
+    ProtocolPromiseHandler<CallFunctionOnCallback>::add(
+        m_debugger,
+        scope.context(),
+        maybeResultValue.ToLocalChecked(),
+        m_session->contextGroupId(),
+        scope.injectedScript()->context()->contextId(),
+        scope.objectGroupName(),
+        returnByValue.fromMaybe(false),
+        generatePreview.fromMaybe(false),
+        std::move(callback));
 }
 
 void V8RuntimeAgentImpl::getProperties(
     ErrorString* errorString,
     const String16& objectId,
     const Maybe<bool>& ownProperties,
     const Maybe<bool>& accessorPropertiesOnly,
     const Maybe<bool>& generatePreview,
     std::unique_ptr<protocol::Array<protocol::Runtime::PropertyDescriptor>>* result,
     Maybe<protocol::Array<protocol::Runtime::InternalPropertyDescriptor>>* internalProperties,
@@ skipping 232 matching lines @@
         reportMessage(message, true);
 }
 
 void V8RuntimeAgentImpl::reportMessage(V8ConsoleMessage* message, bool generatePreview)
 {
     message->reportToFrontend(&m_frontend, m_session, generatePreview);
     m_frontend.flush();
 }
 
 } // namespace blink