feat: add chromedriverExecutableDir and autodownload support (#48)

* feat: add chromedriverExecutableDir and autodownload support

* set browser from UA if the browser was an empty

* fix bad reference

* add JSON.stringify

* Update README.md

Co-authored-by: Jonathan Lipps <[email protected]>

---------

Co-authored-by: Jonathan Lipps <[email protected]>

Author: KazuCocoa

README.md

@@ -36,7 +36,8 @@ package in your `package.json`)
 |`appium:appId`|[Required] The app package ID, if you want Appium to use an app already on the TV. Exclusive with `appium:app`|
 |`appium:app`|[Optional] An absolute path to your `.ipk` app file, if you want Appium to install the app.|
 |`appium:debuggerPort`|[Optional; default `9998`] The port on the device exposed for remote Chromium debugging.|
-|`appium:chromedriverExecutable`|[Optional] Most LG TVs run a very old version of Chrome. Because this driver uses Chromedriver under the hood, you'll need to have a very old version of Chromedriver handy that works with the version of Chrome backing the apps on your TV. In our testing, we've found Chromedriver 2.36 to work with most TVs. You need to tell the driver where you've installed this version of Chromedriver using the `appium:chromedriverExecutable` capability, passing in an absolute path to the Chromedriver binary.|
+|`appium:chromedriverExecutable`(*)|[Optional] Most LG TVs run a very old version of Chrome. Because this driver uses Chromedriver under the hood, you'll need to have a very old version of Chromedriver handy that works with the version of Chrome backing the apps on your TV. In our testing, we've found Chromedriver 2.36 to work with most TVs. You need to tell the driver where you've installed this version of Chromedriver using the `appium:chromedriverExecutable` capability, passing in an absolute path to the Chromedriver binary.|
+| `appium:chromedriverExecutableDir`(*) | [Optional] Full path to the folder where chromedriver executables are located. This folder is used then to store the downloaded chromedriver executables if automatic download is enabled with `chromedriver_autodownload` security flag. Please read [Automatic Discovery of Compatible Chromedriver in appium-uiautomator2-driver](https://github.com/appium/appium-uiautomator2-driver?tab=readme-ov-file#automatic-discovery-of-compatible-chromedriver) for more details. |
 |`appium:websocketPort`|[Optional; default `3000`] The websocket port on the device exposed for remote control|
 |`appium:websocketPortSecure`|[Optional; default `3001`] The secure websocket port on the device exposed for remote control|
 |`appium:useSecureWebsocket`|[Optional; default `false`] Flag that enables use of `websocketPortSecure` port, also starts WebSocket over https instead. **DISCLAIMER** Enabling this flag, it is required to set environment variable `export NODE_TLS_REJECT_UNAUTHORIZED=0`, which can be a potential security risk. A new session request might get `unable to get local issuer certificate` error message.|
@@ -49,6 +50,9 @@ package in your `package.json`)
 |`appium:rcMode`|[Optional; default `js`; must be `rc` or `js`] When the value is `js`, the `webos: pressKey` command will operate with JS executed via Chromedriver. Otherwise, keys will be sent using the websocket remote control API. Note that when `appium:remoteOnly` is set to true, the value of `appium:rcMode` will always behave as if set to `rc`.|
 |`appium:keyCooldown`|[Optional; default `750`] How long to wait in between remote key presses|
 
+(*) `appium:chromedriverExecutable` or `appium:chromedriverExecutableDir` are required. The chromedriver autodwonload works only when `appium:chromedriverExecutableDir` is provided.
+If both capabilities are given, `appium:chromedriverExecutableDir` will take priority.
+
 ## Supported Commands
 
 These are the WebDriver (and extension) commands supported by this driver. Note that in its normal

lib/constraints.js

@@ -34,7 +34,9 @@ export const CAP_CONSTRAINTS = Object.freeze(
     },
     chromedriverExecutable: {
       isString: true,
-      //presence: true
+    },
+    chromedriverExecutableDir: {
+      isString: true,
     },
     autoExtendDevMode: {
       isBoolean: true,
@@ -72,4 +74,3 @@ export const DEFAULT_CAPS = Object.freeze(/** @type {const} */({
 /**
  * @typedef {typeof CAP_CONSTRAINTS} WebOsConstraints
  */
-

lib/driver.js

@@ -14,6 +14,7 @@ import {AsyncScripts, SyncScripts} from './scripts';
 // @ts-ignore
 import Chromedriver from 'appium-chromedriver';
 import getPort from 'get-port';
+import got from 'got';
 import {KEYMAP} from './keys';
 import log from './logger';
 import {LGRemoteKeys} from './remote/lg-remote-client';
@@ -26,6 +27,16 @@ export {KEYS} from './keys';
 // some app stays running (otherwise the TV might shut off)
 const DEV_MODE_ID = 'com.palmdts.devmode';
 
+/**
+ * A security flag to enable chromedriver auto download feature
+ */
+const CHROMEDRIVER_AUTODOWNLOAD_FEATURE = 'chromedriver_autodownload';
+
+/**
+ * To get chrome driver version in the UA
+ */
+const REGEXP_CHROME_VERSION_IN_UA = new RegExp('Chrome\\/(\\S+)');
+
 // don't proxy any 'appium' routes
 /** @type {RouteMatcher[]} */
 const NO_PROXY = [
@@ -99,6 +110,7 @@ export class WebOSDriver extends BaseDriver {
       deviceHost,
       debuggerPort,
       chromedriverExecutable,
+      chromedriverExecutableDir,
       appLaunchCooldown,
       remoteOnly,
       websocketPort,
@@ -172,7 +184,9 @@ export class WebOSDriver extends BaseDriver {
     await this.startChromedriver({
       debuggerHost: deviceHost,
       debuggerPort,
-      executable: chromedriverExecutable,
+      executable: /** @type {string} */ (chromedriverExecutable),
+      executableDir: /** @type {string} */ (chromedriverExecutableDir),
+      isAutodownloadEnabled: /** @type {Boolean} */ (this.#isChromedriverAutodownloadEnabled()),
     });
 
     log.info('Waiting for app launch to take effect');
@@ -186,18 +200,81 @@ export class WebOSDriver extends BaseDriver {
     return [sessionId, caps];
   }
 
+
+  /**
+   * Use UserAgent info for "Browser" if the chrome response did not include
+   * browser name properly.
+   * @param {object} browserVersionInfo
+   */
+  useUAForBrowserIfNotPresent(browserVersionInfo) {
+    if (!_.isEmpty(browserVersionInfo.Browser)) {
+      return browserVersionInfo;
+    }
+
+    const ua = browserVersionInfo['User-Agent'];
+    if (_.isEmpty(ua)) {
+      return browserVersionInfo;
+    }
+
+    const chromeVersion = ua.match(REGEXP_CHROME_VERSION_IN_UA);
+    if (_.isEmpty(chromeVersion)) {
+      return browserVersionInfo;
+    }
+
+    log.info(`The response did not have Browser, thus set the Browser value from UA as ${JSON.stringify(browserVersionInfo)}`);
+    browserVersionInfo.Browser = chromeVersion[0];
+    return browserVersionInfo;
+  }
+
+  /**
+   * Returns whether the session can enable autodownloadd feature.
+   * @returns {boolean}
+   */
+  #isChromedriverAutodownloadEnabled() {
+    if (this.isFeatureEnabled(CHROMEDRIVER_AUTODOWNLOAD_FEATURE)) {
+      return true;
+    }
+    this.log.debug(
+      `Automated Chromedriver download is disabled. ` +
+        `Use '${CHROMEDRIVER_AUTODOWNLOAD_FEATURE}' server feature to enable it`,
+    );
+    return false;
+  }
+
   /**
    * @param {StartChromedriverOptions} opts
    */
-  async startChromedriver({debuggerHost, debuggerPort, executable}) {
+  async startChromedriver({debuggerHost, debuggerPort, executable, executableDir, isAutodownloadEnabled}) {
+    const debuggerAddress = `${debuggerHost}:${debuggerPort}`;
+
+
+    let result;
+    if (executableDir) {
+      // get the result of chrome info to use auto detection.
+      try {
+        result = await got.get(`http://${debuggerAddress}/json/version`).json();
+        log.info(`The response of http://${debuggerAddress}/json/version was ${JSON.stringify(result)}`);
+        result = this.useUAForBrowserIfNotPresent(result);
+
+        // To respect the executableDir.
+        executable = undefined;
+      } catch (err) {
+        throw new errors.SessionNotCreatedError(
+          `Could not get the chrome browser information to detect proper chromedriver version. Error: ${err.message}`
+        );
+      }
+    }
+
     this.#chromedriver = new Chromedriver({
       // @ts-ignore bad types
       port: await getPort(),
       executable,
+      executableDir,
+      isAutodownloadEnabled,
+      // @ts-ignore
+      details: {info: result}
     });
 
-    const debuggerAddress = `${debuggerHost}:${debuggerPort}`;
-
     // XXX: goog:chromeOptions in newer versions, chromeOptions in older
     await this.#chromedriver.start({
       chromeOptions: {

lib/types.ts

@@ -50,7 +50,9 @@ export type Serializable = SerializableObject | Serializable[] | JsonPrimitive;
 export interface StartChromedriverOptions {
   debuggerHost: string;
   debuggerPort: number;
-  executable: string;
+  executable?: string;
+  executableDir?: string;
+  isAutodownloadEnabled: boolean;
 }
 
 /**