fix: FirefoxManager should keep default capabilities when they are not explicitely set

Author: tucksaun

src/ProcessManager/FirefoxManager.php

@@ -99,30 +99,37 @@ private function getDefaultArguments(): array
 
     private function buildCapabilities(): DesiredCapabilities
     {
-        $firefoxOptions = [];
+        $capabilities = DesiredCapabilities::firefox();
+        $firefoxOptions = $capabilities->getCapability(FirefoxOptions::CAPABILITY);
+
         if (isset($_SERVER['PANTHER_FIREFOX_BINARY'])) {
-            $firefoxOptions['binary'] = $_SERVER['PANTHER_FIREFOX_BINARY'];
+            $firefoxOptions->setOption('binary', $_SERVER['PANTHER_FIREFOX_BINARY']);
         }
         if ($this->arguments) {
-            $firefoxOptions['args'] = $this->arguments;
+            $firefoxOptions->addArguments($this->arguments);
         }
 
-        $capabilities = DesiredCapabilities::firefox();
-        $capabilities->setCapability('moz:firefoxOptions', $firefoxOptions);
-
         // Prefer reduced motion, see https://developer.mozilla.org/fr/docs/Web/CSS/@media/prefers-reduced-motion
-        /** @var FirefoxOptions|array $firefoxOptions */
-        $firefoxOptions = $capabilities->getCapability('moz:firefoxOptions') ?? [];
-        $firefoxOptions = $firefoxOptions instanceof FirefoxOptions ? $firefoxOptions->toArray() : $firefoxOptions;
         if (!filter_var($_SERVER['PANTHER_NO_REDUCED_MOTION'] ?? false, \FILTER_VALIDATE_BOOLEAN)) {
-            $firefoxOptions['prefs']['ui.prefersReducedMotion'] = 1;
+            $firefoxOptions->setPreference('ui.prefersReducedMotion', 1);
         } else {
-            $firefoxOptions['prefs']['ui.prefersReducedMotion'] = 0;
+            $firefoxOptions->setPreference('ui.prefersReducedMotion', 0);
         }
-        $capabilities->setCapability('moz:firefoxOptions', $firefoxOptions);
 
         foreach ($this->options['capabilities'] as $capability => $value) {
-            $capabilities->setCapability($capability, $value);
+            if (FirefoxOptions::CAPABILITY !== $capability) {
+                $capabilities->setCapability($capability, $value);
+                continue;
+            }
+
+            if (isset($value[FirefoxOptions::OPTION_ARGS])) {
+                $firefoxOptions->addArguments($value[FirefoxOptions::OPTION_ARGS]);
+            }
+            if (isset($value[FirefoxOptions::OPTION_PREFS])) {
+                foreach ($value[FirefoxOptions::OPTION_PREFS] as $preference => $preferenceValue) {
+                    $firefoxOptions->setPreference($preference, $preferenceValue);
+                }
+            }
         }
 
         return $capabilities;

tests/ProcessManager/FirefoxManagerTest.php

@@ -13,6 +13,8 @@
 
 namespace Symfony\Component\Panther\Tests\ProcessManager;
 
+use Facebook\WebDriver\Firefox\FirefoxOptions;
+use Facebook\WebDriver\Remote\DesiredCapabilities;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Panther\Exception\RuntimeException;
 use Symfony\Component\Panther\ProcessManager\FirefoxManager;
@@ -68,4 +70,54 @@ public function testMultipleInstances(): void
         $driver1->quit();
         $driver2->quit();
     }
+
+    public function testCanOverrideOptions(): void
+    {
+        $manager = new FirefoxManager(null, null, [
+            'capabilities' => [
+                'platform' => 'LINUX',
+                'browserName' => 'firefox-esr',
+                'moz:firefoxOptions' => [
+                    'prefs' => [
+                        'devtools.console.stdout.content' => true,
+                        'reader.parse-on-load.enabled' => true,
+                    ],
+                    'args' => [
+                        '--new-instance',
+                    ],
+                ],
+            ],
+        ]);
+        $refl = new \ReflectionMethod($manager, 'buildCapabilities');
+        $refl->setAccessible(true);
+        $capabilities = $refl->invoke($manager);
+
+        $this->assertInstanceOf(DesiredCapabilities::class, $capabilities);
+        $this->assertEquals('LINUX', $capabilities->getCapability('platform'));
+        $this->assertEquals('firefox-esr', $capabilities->getCapability('browserName'));
+
+        $this->assertInstanceOf(FirefoxOptions::class, $capabilities->getCapability('moz:firefoxOptions'));
+        $mozFirefoxOptions = $capabilities->getCapability('moz:firefoxOptions')->toArray();
+        $this->assertArrayHasKey('prefs', $mozFirefoxOptions);
+
+        // // our preferences should be set
+        $this->assertArrayHasKey('devtools.console.stdout.content', $mozFirefoxOptions['prefs']);
+        $this->assertTrue($mozFirefoxOptions['prefs']['devtools.console.stdout.content']);
+
+        // but the default one should still be there
+        $this->assertArrayHasKey('ui.prefersReducedMotion', $mozFirefoxOptions['prefs']);
+        $this->assertEquals('1', $mozFirefoxOptions['prefs']['ui.prefersReducedMotion']);
+        $this->assertArrayHasKey('devtools.jsonview.enabled', $mozFirefoxOptions['prefs']);
+        $this->assertFalse($mozFirefoxOptions['prefs']['devtools.jsonview.enabled']);
+
+        // except if we override then
+        $this->assertArrayHasKey('reader.parse-on-load.enabled', $mozFirefoxOptions['prefs']);
+        $this->assertTrue($mozFirefoxOptions['prefs']['reader.parse-on-load.enabled']);
+
+        // default arguments should still be there
+        $this->assertContains('--headless', $mozFirefoxOptions['args']);
+
+        // but our custom one should be there too
+        $this->assertContains('--new-instance', $mozFirefoxOptions['args']);
+    }
 }