[executeAsyncScript]

Implement executeAsyncScript in RemoteWebDriver.
Add interface JavaScriptExecutor.

This is done by our bootcamper, glh@fb!

Author: whhone

lib/JavaScriptExecutor.php

@@ -0,0 +1,47 @@
+<?hh
+// Copyright 2004-present Facebook. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * WebDriver interface implemented by drivers that support JavaScript.
+ */
+interface JavaScriptExecutor {
+
+  /**
+   * Inject a snippet of JavaScript into the page for execution in the context
+   * of the currently selected frame. The executed script is assumed to be
+   * synchronous and the result of evaluating the script will be returned.
+   *
+   * @param string $script The script to inject.
+   * @param array $arguments The arguments of the script.
+   * @return mixed The return value of the script.
+   */
+  public function executeScript($script, array $arguments = array());
+
+  /**
+   * Inject a snippet of JavaScript into the page for asynchronous execution in
+   * the context of the currently selected frame.
+   *
+   * The driver will pass a callback as the last argument to the snippet, and
+   * block until the callback is invoked.
+   *
+   * @see WebDriverExecuteAsyncScriptTestCase
+   *
+   * @param string $script The script to inject.
+   * @param array $arguments The arguments of the script.
+   * @return mixed The value passed by the script to the callback.
+   */
+  public function executeAsyncScript($script, array $arguments = array());
+
+}

lib/WebDriver.php

@@ -96,17 +96,6 @@ public function getWindowHandles();
    */
   public function quit();
 
-  /**
-   * Inject a snippet of JavaScript into the page for execution in the context
-   * of the currently selected frame. The executed script is assumed to be
-   * synchronous and the result of evaluating the script will be returned.
-   *
-   * @param string $script The script to inject.
-   * @param array $arguments The arguments of the script.
-   * @return mixed The return value of the script.
-   */
-  public function executeScript($script, array $arguments = array());
-
   /**
    * Take a screenshot of the current page.
    *

lib/__init__.php

@@ -15,6 +15,7 @@
 
 // interface
 require_once('WebDriverSearchContext.php');
+require_once('JavaScriptExecutor.php');
 require_once('WebDriver.php');
 require_once('WebDriverElement.php');
 require_once('WebDriverCommandExecutor.php');

lib/remote/HttpCommandExecutor.php

@@ -35,6 +35,7 @@ class HttpCommandExecutor implements WebDriverCommandExecutor {
     'elementFindElement' =>     array('method' => 'POST', 'url' => '/session/:sessionId/element/:id/element'),
     'elementFindElements' =>    array('method' => 'POST', 'url' => '/session/:sessionId/element/:id/elements'),
     'executeScript' =>          array('method' => 'POST', 'url' => '/session/:sessionId/execute'),
+    'executeAsyncScript' =>     array('method' => 'POST', 'url' => '/session/:sessionId/execute_async'),
     'findElement' =>            array('method' => 'POST', 'url' => '/session/:sessionId/element'),
     'findElements' =>           array('method' => 'POST', 'url' => '/session/:sessionId/elements'),
     'focusFrame' =>             array('method' => 'POST',  'url' => '/session/:sessionId/frame'),

lib/remote/RemoteWebDriver.php

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-class RemoteWebDriver implements WebDriver {
+class RemoteWebDriver implements WebDriver, JavaScriptExecutor {
 
   protected $executor;
   protected $mouse;
@@ -246,8 +246,28 @@ public function executeScript($script, array $arguments = array()) {
       'script' => $script,
       'args' => $this->prepareScriptArguments($arguments),
     );
-    $response = $this->executor->execute('executeScript', $params);
-    return $response;
+    return $this->executor->execute('executeScript', $params);
+  }
+
+  /**
+   * Inject a snippet of JavaScript into the page for asynchronous execution in
+   * the context of the currently selected frame.
+   *
+   * The driver will pass a callback as the last argument to the snippet, and
+   * block until the callback is invoked.
+   *
+   * @see WebDriverExecuteAsyncScriptTestCase
+   *
+   * @param string $script The script to inject.
+   * @param array $arguments The arguments of the script.
+   * @return mixed The value passed by the script to the callback.
+   */
+  public function executeAsyncScript($script, array $arguments = array()) {
+    $params = array(
+      'script' => $script,
+      'args' => $this->prepareScriptArguments($arguments),
+    );
+    return $this->executor->execute('executeAsyncScript', $params);
   }
 
   /**

lib/support/events/EventFiringWebDriver.php

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-class EventFiringWebDriver implements WebDriver {
+class EventFiringWebDriver implements WebDriver, JavaScriptExecutor {
 
   /**
    * @var WebDriver
@@ -134,6 +134,12 @@ public function findElement(WebDriverBy $by) {
    * @throws WebDriverException
    */
   public function executeScript($script, array $arguments = array()) {
+    if (!$this->driver instanceof JavaScriptExecutor) {
+      throw new UnsupportedOperationException(
+        'driver does not implement JavaScriptExecutor',
+      );
+    }
+
     $this->dispatch('beforeScript', $script, $this);
     try {
       $result = $this->driver->executeScript($script, $arguments);
@@ -144,6 +150,29 @@ public function executeScript($script, array $arguments = array()) {
     return $result;
   }
 
+  /**
+   * @param       $script
+   * @param array $arguments
+   * @return mixed
+   * @throws WebDriverException
+   */
+  public function executeAsyncScript($script, array $arguments = array()) {
+    if (!$this->driver instanceof JavaScriptExecutor) {
+      throw new UnsupportedOperationException(
+        'driver does not implement JavaScriptExecutor',
+      );
+    }
+
+    $this->dispatch('beforeScript', $script, $this);
+    try {
+      $result = $this->driver->executeAsyncScript($script, $arguments);
+    } catch (WebDriverException $exception) {
+      $this->dispatchOnException($exception);
+    }
+    $this->dispatch('afterScript', $script, $this);
+    return $result;
+  }
+
   /**
    * @return $this
    * @throws WebDriverException