feat: parse msedge as well as chromedriver (#297)

* feat: parse msedge as well as chromedriver

* fix lint

* tweak comment

* fix load module

* fix review

* tune

* update readme

* tweak

* use this.driverVersion

* update readme

* add comment

* tweak

* add try/catch for safe, tune log

* calls stop

Author: KazuCocoa

README.md

@@ -3,17 +3,27 @@ appium-chromedriver
 
 [![Release](https://github.com/appium/appium-chromedriver/actions/workflows/publish.js.yml/badge.svg)](https://github.com/appium/appium-chromedriver/actions/workflows/publish.js.yml)
 
-Node.js wrapper around [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/).
+Node.js wrapper around [Chromedriver](https://sites.google.com/chromium.org/driver/)
+and [Microsoft Edge WebDriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/).
+The Microsoft Edge WebDriver support is since v5.4.0.
 This wrapper is not used directly in Appium, but rather by various Android drivers to automate
 Chrome/Chromium-based browsers
 and web views using Hybrid Mode approach. Check the corresponding driver tutorials to get
 more details on it.
 
 > **Note**
 >
-> The normal use of this package is via an Appium driver such as [UiAutomator2](https://github.com/appium/appium-uiautomator2-driver/) and not directly.
+> This package is intended to be used as a helper module for Appium drivers such as
+> [UiAutomator2](https://github.com/appium/appium-uiautomator2-driver/) and
+> [appium-chromium-driver](https://github.com/appium/appium-chromium-driver).
+> It was not created for standalone usage.
 > Please ensure you know what you are doing before using this package directly.
 
+> **Note**
+>
+> This package can work with Microsoft Edge WebDriver as well, but the support is limited.
+> For example, automatic downloads do not work for Microsoft Edge WebDriver.
+
 ## Skipping binary installation
 
 By default, upon installation the package downloads the most recent known Chromedriver version from

lib/chromedriver.js

@@ -28,6 +28,7 @@ const CHROME_BUNDLE_ID = 'com.android.chrome';
 const WEBVIEW_SHELL_BUNDLE_ID = 'org.chromium.webview_shell';
 const WEBVIEW_BUNDLE_IDS = ['com.google.android.webview', 'com.android.webview'];
 const VERSION_PATTERN = /([\d.]+)/;
+const WEBDRIVER_VERSION_PATTERN = /Starting (ChromeDriver|Microsoft Edge WebDriver) ([.\d]+)/;
 
 const CD_VERSION_TIMEOUT = 5000;
 
@@ -84,6 +85,9 @@ class Chromedriver extends events.EventEmitter {
     /** @type {any} */
     this.capabilities = {};
     this.desiredProtocol = PROTOCOLS.MJSONWP;
+
+    // Store the running driver version
+    this.driverVersion = /** @type {string|null} */ null;
   }
 
   get log() {
@@ -498,22 +502,29 @@ class Chromedriver extends events.EventEmitter {
   }
 
   /**
-   *
-   * @param {string} [cdVersion]
+   * Sync the WebDriver protocol if current on going protocol is W3C or MJSONWP.
+   * Does nothing if this.driverVersion was null.
    */
-  syncProtocol(cdVersion) {
-    const coercedVersion = semver.coerce(cdVersion);
+  syncProtocol() {
+    if (this.driverVersion === null) {
+      // Keep the default protocol if the driverVersion was unsure.
+      return;
+    }
+
+    const coercedVersion = semver.coerce(this.driverVersion);
     if (!coercedVersion || coercedVersion.major < MIN_CD_VERSION_WITH_W3C_SUPPORT) {
       this.log.debug(
-        `Chromedriver v. ${cdVersion} does not fully support ${PROTOCOLS.W3C} protocol. ` +
+        `The WebDriver v. ${this.driverVersion} does not fully support ${PROTOCOLS.W3C} protocol. ` +
           `Defaulting to ${PROTOCOLS.MJSONWP}`
       );
       return;
     }
+
+    // Check only chromeOptions for now.
     const chromeOptions = getCapValue(this.capabilities, 'chromeOptions', {});
     if (chromeOptions.w3c === false) {
       this.log.info(
-        `Chromedriver v. ${cdVersion} supports ${PROTOCOLS.W3C} protocol, ` +
+        `The WebDriver v. ${this.driverVersion} supports ${PROTOCOLS.W3C} protocol, ` +
           `but ${PROTOCOLS.MJSONWP} one has been explicitly requested`
       );
       return;
@@ -525,6 +536,38 @@ class Chromedriver extends events.EventEmitter {
     this.capabilities = toW3cCapNames(this.capabilities);
   }
 
+  /**
+   * Sync the protocol by reading the given output
+   *
+   * @param {string} out The output of WebDriver process start
+   */
+  detectWebDriverProtocol(out) {
+    if (this.driverVersion) {
+      // Nothing is done if the protocol was already detected
+      return;
+    }
+
+    // also print chromedriver version to logs
+    // will output something like
+    //  Starting ChromeDriver 2.33.506106 (8a06c39c4582fbfbab6966dbb1c38a9173bfb1a2) on port 9515
+    // Or MSEdge:
+    //  Starting Microsoft Edge WebDriver 111.0.1661.41 (57be51b50d1be232a9e8186a10017d9e06b1fd16) on port 9515
+    const match = WEBDRIVER_VERSION_PATTERN.exec(out);
+    if (match && match.length === 3) {
+      this.log.debug(`${match[1]} version: '${match[2]}'`);
+      this.driverVersion = match[2];
+      try {
+        this.syncProtocol();
+      } catch (e) {
+        this.driverVersion = null;
+        this.log.error(`Failed to sync the protocol as '${e}'. Stopping the driver process.`);
+        this.stop();
+      }
+      // Does not print else condition log since the log could be
+      // very noisy when this.verbose option is true.
+    }
+  }
+
   /**
    *
    * @param {object} caps
@@ -589,14 +632,7 @@ class Chromedriver extends events.EventEmitter {
           this.log.debug(`Webview version: '${webviewVersion}'`);
         }
 
-        // also print chromedriver version to logs
-        // will output something like
-        //  Starting ChromeDriver 2.33.506106 (8a06c39c4582fbfbab6966dbb1c38a9173bfb1a2) on port 9515
-        match = /Starting ChromeDriver ([.\d]+)/.exec(out);
-        if (match) {
-          this.log.debug(`Chromedriver version: '${match[1]}'`);
-          this.syncProtocol(match[1]);
-        }
+        this.detectWebDriverProtocol(out);
 
         // give the output if it is requested
         if (this.verbose) {
@@ -613,6 +649,7 @@ class Chromedriver extends events.EventEmitter {
 
       // handle out-of-bound exit by simply emitting a stopped state
       this.proc.on('exit', (code, signal) => {
+        this.driverVersion = null;
         processIsAlive = false;
         if (
           this.state !== Chromedriver.STATE_STOPPED &&