[Extensions + Blink] Account for user gesture in v8 function calls

third_party/WebKit/Source/web/tests/WebFrameTest.cpp

 /*
  * Copyright (C) 2010 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 317 matching lines @@
   EXPECT_EQ(webViewHelper.webView()->mainFrame()->firstChild(),
             WebLocalFrame::frameForContext(webViewHelper.webView()
                                                ->mainFrame()
                                                ->firstChild()
                                                ->mainWorldScriptContext()));
 }
 
 class ScriptExecutionCallbackHelper : public WebScriptExecutionCallback {
  public:
   explicit ScriptExecutionCallbackHelper(v8::Local<v8::Context> context)
-      : m_didComplete(false), m_context(context) {}
+      : m_didComplete(false), m_boolValue(false), m_context(context) {}
   ~ScriptExecutionCallbackHelper() {}
 
   bool didComplete() const { return m_didComplete; }
   const String& stringValue() const { return m_stringValue; }
+  bool boolValue() { return m_boolValue; }
 
  private:
   void completed(const WebVector<v8::Local<v8::Value>>& values) override {
     m_didComplete = true;
-    if (!values.isEmpty() && values[0]->IsString()) {
-      m_stringValue =
-          toCoreString(values[0]->ToString(m_context).ToLocalChecked());
+    if (!values.isEmpty()) {
+      if (values[0]->IsString()) {
+        m_stringValue =
+            toCoreString(values[0]->ToString(m_context).ToLocalChecked());
+      } else if (values[0]->IsBoolean()) {
+        m_boolValue = values[0].As<v8::Boolean>()->Value();
+      }
     }
   }
 
   bool m_didComplete;
   String m_stringValue;
+  bool m_boolValue;
   v8::Local<v8::Context> m_context;
 };
 
 TEST_P(ParameterizedWebFrameTest, RequestExecuteScript) {
   registerMockedHttpURLLoad("foo.html");
 
   FrameTestHelpers::WebViewHelper webViewHelper;
   webViewHelper.initializeAndLoad(m_baseURL + "foo.html", true);
 
   v8::HandleScope scope(v8::Isolate::GetCurrent());
   ScriptExecutionCallbackHelper callbackHelper(
       webViewHelper.webView()->mainFrame()->mainWorldScriptContext());
   webViewHelper.webView()
       ->mainFrame()
       ->toWebLocalFrame()
       ->requestExecuteScriptAndReturnValue(
           WebScriptSource(WebString("'hello';")), false, &callbackHelper);
   runPendingTasks();
   EXPECT_TRUE(callbackHelper.didComplete());
   EXPECT_EQ("hello", callbackHelper.stringValue());
 }
 
+TEST_P(ParameterizedWebFrameTest, RequestExecuteScriptWithUserGesture) {
+  registerMockedHttpURLLoad("foo.html");
+
+  FrameTestHelpers::WebViewHelper webViewHelper;
+  webViewHelper.initializeAndLoad(m_baseURL + "foo.html", true);
+
+  v8::HandleScope scope(v8::Isolate::GetCurrent());
+  ScriptExecutionCallbackHelper callbackHelper(
+      webViewHelper.webView()->mainFrame()->mainWorldScriptContext());
+
+  WebLocalFrameImpl* mainFrame = webViewHelper.webView()->mainFrameImpl();
+  Document* document = mainFrame->frame()->document();
+  mainFrame->requestExecuteScriptAndReturnValue(
+      WebScriptSource(WebString("document.body.webkitRequestFullscreen();")),
+      true, &callbackHelper);
+  runPendingTasks();
+  EXPECT_TRUE(callbackHelper.didComplete());
+  EXPECT_EQ(document->body(),

[Devlin, 2016/10/27 23:33:28]

I'd like to add this test (and a similar one for suspended user gesture), since
there don't seem to be any.  But it's failing at this line.  Any idea why?

[dcheng, 2016/10/28 17:24:17]

I think that's because there's no user gesture active, right? If the test puts a
user-gesture indicator on the stack, that should make this pass:
https://cs.chromium.org/chromium/src/third_party/WebKit/Source/web/tests/WebF...

[Devlin, 2016/10/28 20:31:37]

the "true" parameter in the requestExecuteScriptAndReturnValue means that it's
for a user gesture, which puts a gesture on the stack.  To be extra sure, I've
added another token here.  Neither make a difference - this still doesn't pass. 
My guess is it's something weird with using body rather than a different element
(which is what other tests seem to be doing), but I'm not sure why that is.

[Devlin, 2016/10/31 17:00:46]

FYI, I've removed this test since making it work was non-trivial and it's
orthogonal to this change.

+            Fullscreen::currentFullScreenElementFrom(*document));
+}
+
 TEST_P(ParameterizedWebFrameTest, SuspendedRequestExecuteScript) {
   registerMockedHttpURLLoad("foo.html");
   registerMockedHttpURLLoad("bar.html");
 
   FrameTestHelpers::WebViewHelper webViewHelper;
   webViewHelper.initializeAndLoad(m_baseURL + "foo.html", true);
 
   v8::HandleScope scope(v8::Isolate::GetCurrent());
   ScriptExecutionCallbackHelper callbackHelper(
       webViewHelper.webView()->mainFrame()->mainWorldScriptContext());
@@ skipping 10 matching lines @@
   EXPECT_FALSE(callbackHelper.didComplete());
 
   // If the frame navigates, pending scripts should be removed, but the callback
   // should always be ran.
   FrameTestHelpers::loadFrame(webViewHelper.webView()->mainFrame(),
                               m_baseURL + "bar.html");
   EXPECT_TRUE(callbackHelper.didComplete());
   EXPECT_EQ(String(), callbackHelper.stringValue());
 }
 
+TEST_P(ParameterizedWebFrameTest, RequestExecuteV8Function) {
+  registerMockedHttpURLLoad("foo.html");
+
+  FrameTestHelpers::WebViewHelper webViewHelper;
+  webViewHelper.initializeAndLoad(m_baseURL + "foo.html", true);
+
+  auto callback = [](const v8::FunctionCallbackInfo<v8::Value>& info) {
+    info.GetReturnValue().Set(v8String(info.GetIsolate(), "hello"));
+  };
+
+  v8::HandleScope scope(v8::Isolate::GetCurrent());
+  v8::Local<v8::Context> context =
+      webViewHelper.webView()->mainFrame()->mainWorldScriptContext();
+  ScriptExecutionCallbackHelper callbackHelper(context);
+  v8::Local<v8::Function> function =
+      v8::Function::New(context, callback).ToLocalChecked();
+  webViewHelper.webView()
+      ->mainFrame()
+      ->toWebLocalFrame()
+      ->requestExecuteV8Function(context, function,
+                                 v8::Undefined(context->GetIsolate()), 0,
+                                 nullptr, &callbackHelper);
+  runPendingTasks();
+  EXPECT_TRUE(callbackHelper.didComplete());
+  EXPECT_EQ("hello", callbackHelper.stringValue());
+}
+
+TEST_P(ParameterizedWebFrameTest, RequestExecuteV8FunctionWhileSuspended) {
+  registerMockedHttpURLLoad("foo.html");
+
+  FrameTestHelpers::WebViewHelper webViewHelper;
+  webViewHelper.initializeAndLoad(m_baseURL + "foo.html", true);
+
+  auto callback = [](const v8::FunctionCallbackInfo<v8::Value>& info) {
+    info.GetReturnValue().Set(v8String(info.GetIsolate(), "hello"));
+  };
+
+  v8::HandleScope scope(v8::Isolate::GetCurrent());
+  v8::Local<v8::Context> context =
+      webViewHelper.webView()->mainFrame()->mainWorldScriptContext();
+
+  // Suspend scheduled tasks so the script doesn't run.
+  WebLocalFrameImpl* mainFrame = webViewHelper.webView()->mainFrameImpl();
+  mainFrame->frame()->document()->suspendScheduledTasks();
+
+  ScriptExecutionCallbackHelper callbackHelper(context);
+  v8::Local<v8::Function> function =
+      v8::Function::New(context, callback).ToLocalChecked();
+  mainFrame->requestExecuteV8Function(context, function,
+                                      v8::Undefined(context->GetIsolate()), 0,
+                                      nullptr, &callbackHelper);
+  runPendingTasks();
+  EXPECT_FALSE(callbackHelper.didComplete());
+
+  mainFrame->frame()->document()->resumeScheduledTasks();
+  runPendingTasks();
+  EXPECT_TRUE(callbackHelper.didComplete());
+  EXPECT_EQ("hello", callbackHelper.stringValue());
+}
+
+TEST_P(ParameterizedWebFrameTest,
+       RequestExecuteV8FunctionWhileSuspendedWithUserGesture) {
+  registerMockedHttpURLLoad("foo.html");
+
+  FrameTestHelpers::WebViewHelper webViewHelper;
+  webViewHelper.initializeAndLoad(m_baseURL + "foo.html", true);
+
+  auto callback = [](const v8::FunctionCallbackInfo<v8::Value>& info) {
+    info.GetReturnValue().Set(v8::Boolean::New(
+        info.GetIsolate(), UserGestureIndicator::processingUserGesture()));
+  };
+
+  // Suspend scheduled tasks so the script doesn't run.
+  WebLocalFrameImpl* mainFrame = webViewHelper.webView()->mainFrameImpl();
+  Document* document = mainFrame->frame()->document();
+  document->suspendScheduledTasks();
+
+  v8::HandleScope scope(v8::Isolate::GetCurrent());
+  v8::Local<v8::Context> context =
+      webViewHelper.webView()->mainFrame()->mainWorldScriptContext();
+
+  std::unique_ptr<UserGestureIndicator> indicator =
+      wrapUnique(new UserGestureIndicator(DocumentUserGestureToken::create(
+          document, UserGestureToken::NewGesture)));
+  ScriptExecutionCallbackHelper callbackHelper(context);
+  v8::Local<v8::Function> function =
+      v8::Function::New(context, callback).ToLocalChecked();
+  mainFrame->requestExecuteV8Function(
+      mainFrame->mainWorldScriptContext(), function,
+      v8::Undefined(context->GetIsolate()), 0, nullptr, &callbackHelper);
+
+  runPendingTasks();
+  EXPECT_FALSE(callbackHelper.didComplete());
+
+  mainFrame->frame()->document()->resumeScheduledTasks();
+  runPendingTasks();
+  EXPECT_TRUE(callbackHelper.didComplete());
+  EXPECT_EQ(true, callbackHelper.boolValue());
+}
+
 TEST_P(ParameterizedWebFrameTest, IframeScriptRemovesSelf) {
   registerMockedHttpURLLoad("single_iframe.html");
   registerMockedHttpURLLoad("visible_iframe.html");
 
   FrameTestHelpers::WebViewHelper webViewHelper;
   webViewHelper.initializeAndLoad(m_baseURL + "single_iframe.html", true);
 
   v8::HandleScope scope(v8::Isolate::GetCurrent());
   ScriptExecutionCallbackHelper callbackHelper(
       webViewHelper.webView()->mainFrame()->mainWorldScriptContext());
@@ skipping 9844 matching lines @@
   webViewHelper.webView()->handleInputEvent(endEvent);
   webViewHelper.webView()->handleInputEvent(updateEvent);
 
   // Try a full Begin/Update/End cycle.
   webViewHelper.webView()->handleInputEvent(beginEvent);
   webViewHelper.webView()->handleInputEvent(updateEvent);
   webViewHelper.webView()->handleInputEvent(endEvent);
 }
 
 }  // namespace blink