Make sure that chromeOptions is an object when empty

Author: oleg-andreyev

lib/Chrome/ChromeOptions.php

@@ -117,17 +117,19 @@ public function toCapabilities()
     }
 
     /**
-     * @return array
+     * @return \ArrayObject|array
      */
     public function toArray()
     {
-        $options = $this->experimentalOptions;
-
         // The selenium server expects a 'dictionary' instead of a 'list' when
         // reading the chrome option. However, an empty array in PHP will be
-        // converted to a 'list' instead of a 'dictionary'. To fix it, we always
-        // set the 'binary' to avoid returning an empty array.
-        $options['binary'] = $this->binary;
+        // converted to a 'list' instead of a 'dictionary'. To fix it, we work
+        // with `ArrayObject`
+        $options = new \ArrayObject($this->experimentalOptions);
+
+        if (!empty($this->binary)) {
+            $options['binary'] = $this->binary;
+        }
 
         if (!empty($this->arguments)) {
             $options['args'] = $this->arguments;

lib/Remote/DesiredCapabilities.php

@@ -235,9 +235,11 @@ public function toW3cCompatibleArray()
         // Convert ChromeOptions
         if (array_key_exists(ChromeOptions::CAPABILITY, $ossCapabilities)) {
             if (array_key_exists(ChromeOptions::CAPABILITY_W3C, $ossCapabilities)) {
-                $w3cCapabilities[ChromeOptions::CAPABILITY_W3C] = array_merge_recursive(
-                    $ossCapabilities[ChromeOptions::CAPABILITY],
-                    $ossCapabilities[ChromeOptions::CAPABILITY_W3C]
+                $w3cCapabilities[ChromeOptions::CAPABILITY_W3C] = new \ArrayObject(
+                    array_merge_recursive(
+                        (array) $ossCapabilities[ChromeOptions::CAPABILITY],
+                        (array) $ossCapabilities[ChromeOptions::CAPABILITY_W3C]
+                    )
                 );
             } else {
                 $w3cCapabilities[ChromeOptions::CAPABILITY_W3C] = $ossCapabilities[ChromeOptions::CAPABILITY];

tests/unit/Remote/DesiredCapabilitiesTest.php

@@ -213,15 +213,24 @@ public function provideW3cCapabilities()
                     'vendor:prefix' => 'vendor extension should be kept',
                 ],
             ],
+            'chromeOptions should be an object if empty' => [
+                new DesiredCapabilities([
+                    ChromeOptions::CAPABILITY => new ChromeOptions(),
+                ]),
+                [
+                    'goog:chromeOptions' => new \ArrayObject(),
+                ],
+            ],
             'chromeOptions should be converted' => [
                 new DesiredCapabilities([
                     ChromeOptions::CAPABILITY => $chromeOptions,
                 ]),
                 [
-                    'goog:chromeOptions' => [
-                        'args' => ['--headless'],
-                        'binary' => '',
-                    ],
+                    'goog:chromeOptions' => new \ArrayObject(
+                        [
+                            'args' => ['--headless'],
+                        ]
+                    ),
                 ],
             ],
             'chromeOptions should be merged if already defined' => [
@@ -233,11 +242,12 @@ public function provideW3cCapabilities()
                     ],
                 ]),
                 [
-                    'goog:chromeOptions' => [
-                        'args' => ['--headless', 'window-size=1024,768'],
-                        'binary' => '',
-                        'debuggerAddress' => '127.0.0.1:38947',
-                    ],
+                    'goog:chromeOptions' => new \ArrayObject(
+                        [
+                            'args' => ['--headless', 'window-size=1024,768'],
+                            'debuggerAddress' => '127.0.0.1:38947',
+                        ]
+                    ),
                 ],
             ],
             'firefox_profile should be converted' => [