Convert element to NodeElement from execute result

Author: mvorisek

composer.json

@@ -22,7 +22,7 @@
         "php":                       ">=7.2",
         "ext-json": "*",
         "behat/mink":                "^1.9@dev",
-        "instaclick/php-webdriver":  "^1.4"
+        "instaclick/php-webdriver":  "^1.4.13"
     },
     "require-dev": {
         "mink/driver-testsuite": "dev-master",

src/Selenium2Driver.php

@@ -10,6 +10,7 @@
 
 namespace Behat\Mink\Driver;
 
+use Behat\Mink\Element\NodeElement;
 use Behat\Mink\Exception\DriverException;
 use Behat\Mink\Selector\Xpath\Escaper;
 use WebDriver\Element;
@@ -27,6 +28,8 @@
  */
 class Selenium2Driver extends CoreDriver
 {
+    public const XPATH_WEBDRIVER_ELEMENT_PREFIX = 'webdriver-element--JZPOYwW6bl1bVmyK--';
+
     /**
      * Whether the browser has been started
      * @var boolean
@@ -246,6 +249,68 @@ protected static function charToOptions($char, $modifier = null)
         return json_encode($options);
     }
 
+    /**
+     * Serialize execute arguments (containing web elements)
+     *
+     * @see https://w3c.github.io/webdriver/#executing-script
+     *
+     * @param array $args
+     *
+     * @return array
+     */
+    private function serializeExecuteArguments(array $args)
+    {
+        foreach ($args as $k => $v) {
+            if ($v instanceof NodeElement) {
+                if (strpos($v->getXpath(), self::XPATH_WEBDRIVER_ELEMENT_PREFIX) === 0) {
+                    [$elementUrlEncoded, $elementIdEncoded] = explode(
+                        '--',
+                        substr($v->getXpath(), strlen(self::XPATH_WEBDRIVER_ELEMENT_PREFIX)),
+                        2
+                    );
+
+                    $args[$k] = new Element(base64_decode($elementUrlEncoded), base64_decode($elementIdEncoded));
+                } else {
+                    $args[$k] = $this->findElement($v->getXpath());
+                }
+            } elseif (is_array($v)) {
+                $args[$k] = $this->serializeExecuteArguments($v);
+            }
+        }
+
+        return $args;
+    }
+
+    /**
+     * Unserialize execute result (containing web elements)
+     *
+     * @param mixed $data
+     *
+     * @return mixed
+     */
+    private function unserializeExecuteResult($data)
+    {
+        if ($data instanceof Element) {
+            $minkSession = \Closure::bind(function () {
+                return $this->session;
+            }, $this, CoreDriver::class)();
+
+            return new NodeElement(
+                self::XPATH_WEBDRIVER_ELEMENT_PREFIX
+                    . base64_encode($data->getURL())
+                    . '--'
+                    . base64_encode($data->getID()),
+                $minkSession
+            );
+        } elseif (is_array($data)) {
+            foreach ($data as $k => $v) {
+                $data[$k] = $this->unserializeExecuteResult($v);
+            }
+        }
+
+        return $data;
+    }
+
     /**
      * Executes JS on a given element - pass in a js script string and {{ELEMENT}} will
      * be replaced with a reference to the result of the $xpath query
@@ -281,14 +346,14 @@ private function executeJsOnElement(Element $element, $script, $sync = true)
 
         $options = array(
             'script' => $script,
-            'args'   => array(array('ELEMENT' => $element->getID())),
+            'args'   => array(array('ELEMENT' => $element)),
         );
 
-        if ($sync) {
-            return $this->wdSession->execute($options);
-        }
+        $result = $sync
+            ? $this->wdSession->execute($options)
+            : $this->wdSession->execute_async($options);
 
-        return $this->wdSession->execute_async($options);
+        return $this->unserializeExecuteResult($result);
     }
 
     /**
@@ -951,39 +1016,50 @@ public function dragTo($sourceXpath, $destinationXpath)
     /**
      * {@inheritdoc}
      */
-    public function executeScript($script)
+    public function executeScript($script, array $args = [])
     {
         if (preg_match('/^function[\s\(]/', $script)) {
             $script = preg_replace('/;$/', '', $script);
             $script = '(' . $script . ')';
         }
 
-        $this->wdSession->execute(array('script' => $script, 'args' => array()));
+        $this->wdSession->execute(array(
+            'script' => $script,
+            'args' => $this->serializeExecuteArguments($args),
+        ));
     }
 
     /**
      * {@inheritdoc}
      */
-    public function evaluateScript($script)
+    public function evaluateScript($script, array $args = [])
     {
         if (0 !== strpos(trim($script), 'return ')) {
             $script = 'return ' . $script;
         }
 
-        return $this->wdSession->execute(array('script' => $script, 'args' => array()));
+        $result = $this->wdSession->execute(array(
+            'script' => $script,
+            'args' => $this->serializeExecuteArguments($args),
+        ));
+
+        return $this->unserializeExecuteResult($result);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function wait($timeout, $condition)
+    public function wait($timeout, $condition, array $args = [])
     {
         $script = 'return (' . rtrim($condition, " \t\n\r;") . ');';
         $start = microtime(true);
         $end = $start + $timeout / 1000.0;
 
         do {
-            $result = $this->wdSession->execute(array('script' => $script, 'args' => array()));
+            $result = $this->wdSession->execute(array(
+                'script' => $script,
+                'args' => $this->serializeExecuteArguments($args),
+            ));
             if ($result) {
               break;
             }