redo session initialization - potential compat-buster

Author: robocoder

lib/WebDriver/WebDriver.php

@@ -45,44 +45,47 @@ protected function methods()
     /**
      * {@inheritdoc}
      */
-    public function session($requiredCapabilities = Browser::FIREFOX, $desiredCapabilities = array())
+    public function session($browserName = Browser::FIREFOX, $desiredCapabilities = null, $requiredCapabilities = null)
     {
-        if ($this->legacy) {
-            // for backwards compatibility when the only required capability was browser name
-            if (! is_array($requiredCapabilities)) {
-                $desiredCapabilities[Capability::BROWSER_NAME] = $requiredCapabilities ?: Browser::FIREFOX;
+        // default to W3C WebDriver API
+        $firstMatch = $desiredCapabilities ?: array();
+        $firstMatch[] = array('browserName' => Browser::CHROME);
 
-                $requiredCapabilities = array();
-            }
+        if ($browserName !== Browser::CHROME) {
+            $firstMatch[] = array('browserName' => $browserName);
+        }
+
+        $parameters = array('capabilities' => array('firstMatch' => $firstMatch));
 
-            // required
-            $parameters = array(
-                'desiredCapabilities' => array_merge($desiredCapabilities, $requiredCapabilities)
+        if (is_array($requiredCapabilities) && count($requiredCapabilities)) {
+            $parameters['capabilities']['alwaysMatch'] = $requiredCapabilities;
+        }
+
+        try {
+            $result = $this->curl(
+                'POST',
+                '/session',
+                $parameters,
+                array(CURLOPT_FOLLOWLOCATION => true)
             );
+        } catch (\Exception $e) {
+            // fallback to legacy JSON Wire Protocol
+            $capabilities = $desiredCapabilities ?: array();
+            $capabilities[Capability::BROWSER_NAME] = $browserName;
+
+            $parameters = array('desiredCapabilities' => $capabilities);
 
-            // optional
-            if (! empty($requiredCapabilities)) {
+            if (is_array($requiredCapabilities) && count($requiredCapabilities)) {
                 $parameters['requiredCapabilities'] = $requiredCapabilities;
             }
-        } else {
-            if (! is_array($requiredCapabilities)) {
-                $parameters = array(
-                    'capabilities' => array(
-                        'firstMatch' => array(
-                            array('browserName' => Browser::CHROME),
-                            array('browserName' => Browser::FIREFOX)
-                        )
-                    )
-                );
-            }
-        }
 
-        $result = $this->curl(
-            'POST',
-            '/session',
-            $parameters,
-            array(CURLOPT_FOLLOWLOCATION => true)
-        );
+            $result = $this->curl(
+                'POST',
+                '/session',
+                $parameters,
+                array(CURLOPT_FOLLOWLOCATION => true)
+            );
+        }
 
         $capabilities = isset($result['value']['capabilities']) ? $result['value']['capabilities'] : null;
         $this->legacy = ! $capabilities;
@@ -94,7 +97,12 @@ public function session($requiredCapabilities = Browser::FIREFOX, $desiredCapabi
     }
 
     /**
-     * {@inheritdoc}
+     * Get Sessions: /sessions (GET)
+     * Get list of currently active sessions
+     *
+     * @deprecated
+     *
+     * @return array an array of \WebDriver\Session objects
      */
     public function sessions()
     {

lib/WebDriver/WebDriverInterface.php

@@ -34,20 +34,11 @@ interface WebDriverInterface
      * New Session: /session (POST)
      * Get session object for chaining
      *
-     * @param array|string $requiredCapabilities Required capabilities (or browser name)
-     * @param array        $desiredCapabilities  Desired capabilities
+     * @param string $browserName          Preferred browser
+     * @param array  $desiredCapabilities  Optional desired capabilities
+     * @param array  $requiredCapabilities Optional required capabilities
      *
      * @return \WebDriver\Session
      */
-    public function session($requiredCapabilities = Browser::FIREFOX, $desiredCapabilities = array());
-
-    /**
-     * Get Sessions: /sessions (GET)
-     * Get list of currently active sessions
-     *
-     * @deprecated
-     *
-     * @return array an array of \WebDriver\Session objects
-     */
-    public function sessions();
+    public function session($browserName = Browser::FIREFOX, $desiredCapabilities = null, $requiredCapabilities = null);
 }