Merge pull request #640 from OndraM/fix/chromedriver-hotfix

Disable W3C protocol in Chrome 75+

Author: OndraM

.travis.yml

@@ -13,7 +13,6 @@ env:
   global:
     - DISPLAY=:99.0
     - BROWSER_NAME="htmlunit"
-    - CHROMEDRIVER_VERSION="2.38"
 
 matrix:
   include:
@@ -34,15 +33,21 @@ matrix:
     - php: '5.6'
       env: DEPENDENCIES="--prefer-lowest"
 
-    # Add build to run tests against Firefox inside Travis environment
+    # Firefox inside Travis environment
     - php: '7.3'
       env: BROWSER_NAME="firefox"
       addons:
         firefox: "45.8.0esr"
 
-    # Add build to run tests against Chrome inside Travis environment
+    # Stable Chrome + Chromedriver 74 inside Travis environment
     - php: '7.3'
-      env: BROWSER_NAME="chrome" CHROME_HEADLESS="1"
+      env: BROWSER_NAME="chrome" CHROME_HEADLESS="1" CHROMEDRIVER_VERSION="74.0.3729.6"
+      addons:
+        chrome: stable
+
+    # Stable Chrome + Chromedriver 75+ inside Travis environment
+    - php: '7.3'
+      env: BROWSER_NAME="chrome" CHROME_HEADLESS="1" CHROMEDRIVER_VERSION="75.0.3770.8"
       addons:
         chrome: stable
 
@@ -56,15 +61,27 @@ matrix:
         sauce_connect: true
         jwt:
           secure: HPq5xFhosa1eSGnaRdJzeyEuaE0mhRlG1gf3G7+dKS0VniF30husSyrxZhbGCCKBGxmIySoAQzd43BCwL69EkUEVKDN87Cpid1Ce9KrSfU3cnN8XIb+4QINyy7x1a47RUAfaaOEx53TrW0ShalvjD+ZwDE8LrgagSox6KQ+nQLE=
+
     - php: '7.3'
-      env: SAUCELABS=1 BROWSER_NAME="chrome" VERSION="74.0" PLATFORM="Windows 10"
+      env: SAUCELABS=1 BROWSER_NAME="chrome" VERSION="74.0" PLATFORM="Windows 10" # 74 is the last version which don't use W3C WebDriver by default
       before_script:
         - php -S 127.0.0.1:8000 -t tests/functional/web/ &>>./logs/php-server.log &
         - until $(echo | nc localhost 8000); do sleep 1; echo waiting for PHP server on port 8000...; done; echo "PHP server started"
       addons:
         sauce_connect: true
         jwt:
           secure: HPq5xFhosa1eSGnaRdJzeyEuaE0mhRlG1gf3G7+dKS0VniF30husSyrxZhbGCCKBGxmIySoAQzd43BCwL69EkUEVKDN87Cpid1Ce9KrSfU3cnN8XIb+4QINyy7x1a47RUAfaaOEx53TrW0ShalvjD+ZwDE8LrgagSox6KQ+nQLE=
+
+    - php: '7.3'
+      env: SAUCELABS=1 BROWSER_NAME="chrome" VERSION="75.0" PLATFORM="Windows 10"
+      before_script:
+        - php -S 127.0.0.1:8000 -t tests/functional/web/ &>>./logs/php-server.log &
+        - until $(echo | nc localhost 8000); do sleep 1; echo waiting for PHP server on port 8000...; done; echo "PHP server started"
+      addons:
+        sauce_connect: true
+        jwt:
+          secure: HPq5xFhosa1eSGnaRdJzeyEuaE0mhRlG1gf3G7+dKS0VniF30husSyrxZhbGCCKBGxmIySoAQzd43BCwL69EkUEVKDN87Cpid1Ce9KrSfU3cnN8XIb+4QINyy7x1a47RUAfaaOEx53TrW0ShalvjD+ZwDE8LrgagSox6KQ+nQLE=
+
     - php: '7.3'
       env: SAUCELABS=1 BROWSER_NAME="MicrosoftEdge" VERSION="16.16299" PLATFORM="Windows 10"
       before_script:

lib/Remote/HttpCommandExecutor.php

@@ -273,6 +273,11 @@ public function execute(WebDriverCommand $command)
 
         if ($http_method === 'POST' && $params && is_array($params)) {
             $encoded_params = json_encode($params);
+        } elseif ($http_method === 'POST' && $encoded_params === null) {
+            // Workaround for bug https://bugs.chromium.org/p/chromedriver/issues/detail?id=2943 in Chrome 75.
+            // Chromedriver now erroneously does not allow POST body to be empty even for the JsonWire protocol.
+            // If the command POST is empty, here we send some dummy data as a workaround:
+            $encoded_params = json_encode(['_' => '_']);
         }
 
         curl_setopt($this->curl, CURLOPT_POSTFIELDS, $encoded_params);

lib/Remote/RemoteWebDriver.php

@@ -15,6 +15,7 @@
 
 namespace Facebook\WebDriver\Remote;
 
+use Facebook\WebDriver\Chrome\ChromeOptions;
 use Facebook\WebDriver\Interactions\WebDriverActions;
 use Facebook\WebDriver\JavaScriptExecutor;
 use Facebook\WebDriver\WebDriver;
@@ -102,6 +103,19 @@ public static function create(
 
         $desired_capabilities = self::castToDesiredCapabilitiesObject($desired_capabilities);
 
+        // Hotfix: W3C WebDriver protocol is not yet supported by php-webdriver, so we must force Chromedriver to
+        // not use the W3C protocol by default (which is what Chromedriver does starting with version 75).
+        if ($desired_capabilities->getBrowserName() === WebDriverBrowserType::CHROME) {
+            $currentChromeOptions = $desired_capabilities->getCapability(ChromeOptions::CAPABILITY);
+            $chromeOptions = !empty($currentChromeOptions) ? $currentChromeOptions : new ChromeOptions();
+
+            if (!isset($chromeOptions->toArray()['w3c'])) {
+                $chromeOptions->setExperimentalOption('w3c', false);
+            }
+
+            $desired_capabilities->setCapability(ChromeOptions::CAPABILITY, $chromeOptions);
+        }
+
         $executor = new HttpCommandExecutor($selenium_server_url, $http_proxy, $http_proxy_port);
         if ($connection_timeout_in_ms !== null) {
             $executor->setConnectionTimeout($connection_timeout_in_ms);