feat: Add chromedriverForwardBiDi capability (#1025)

Author: mykola-mokhnach

lib/commands/context/exports.js

@@ -107,6 +107,7 @@ export function assignContexts(webviewsMapping) {
  * @returns {Promise<void>}
  */
 export async function switchContext(name, webviewsMapping) {
+  this._bidiProxyUrl = null;
   // We have some options when it comes to webviews. If we want a
   // Chromedriver webview, we can only control one at a time.
   if (this.isChromedriverContext(name)) {
@@ -215,7 +216,7 @@ export async function startChromedriverProxy(context, webviewsMapping) {
     // we want to reconnect to it, not create a whole new one
     this.log.debug(`Found existing Chromedriver for context '${context}'. Using it.`);
     cd = this.sessionChromedrivers[context];
-    await setupExistingChromedriver.bind(this)(cd);
+    await setupExistingChromedriver.bind(this)(cd, context);
   } else {
     // XXX: this suppresses errors about putting arbitrary stuff on opts
     const opts = /** @type {any} */ (_.cloneDeep(this.opts));

lib/commands/context/helpers.js

@@ -222,6 +222,10 @@ function createChromedriverCaps(opts, deviceId, webViewDetails) {
     delete opts.chromeOptions.Arguments;
   }
 
+  if (opts.webSocketUrl && _.isNil(caps.chromeOptions.webSocketUrl)) {
+    caps.chromeOptions.webSocketUrl = opts.webSocketUrl;
+  }
+
   this.log.debug(
     'Precalculated Chromedriver capabilities: ' + JSON.stringify(caps.chromeOptions, null, 2),
   );
@@ -763,26 +767,52 @@ export async function setupNewChromedriver(opts, curDeviceId, context) {
   this.log.debug(
     `Before starting chromedriver, androidPackage is '${caps.chromeOptions.androidPackage}'`,
   );
-  await chromedriver.start(caps);
+  const sessionCaps = await chromedriver.start(caps);
+  updateBidiProxyUrl.bind(this)(sessionCaps, context);
   return chromedriver;
 }
 
 /**
  * @this {import('../../driver').AndroidDriver}
  * @template {Chromedriver} T
  * @param {T} chromedriver
+ * @param {string} context
  * @returns {Promise<T>}
  */
-export async function setupExistingChromedriver(chromedriver) {
+export async function setupExistingChromedriver(chromedriver, context) {
   // check the status by sending a simple window-based command to ChromeDriver
   // if there is an error, we want to recreate the ChromeDriver session
-  if (!(await chromedriver.hasWorkingWebview())) {
+  if (await chromedriver.hasWorkingWebview()) {
+    const cachedBidiProxyUrl = this._bidiProxyUrlCache.get(context);
+    if (cachedBidiProxyUrl) {
+      updateBidiProxyUrl.bind(this)({webSocketUrl: cachedBidiProxyUrl}, context);
+    }
+  } else {
     this.log.debug('ChromeDriver is not associated with a window. Re-initializing the session.');
-    await chromedriver.restart();
+    const sessionCaps = await chromedriver.restart();
+    updateBidiProxyUrl.bind(this)(sessionCaps, context);
   }
   return chromedriver;
 }
 
+/**
+ * @this {import('../../driver').AndroidDriver}
+ * @param {Record<string, any>} sessionCaps
+ * @param {string} context
+ * @returns {void}
+ */
+function updateBidiProxyUrl(sessionCaps, context) {
+  if (!this.opts?.chromedriverForwardBiDi || !sessionCaps?.webSocketUrl) {
+    return;
+  }
+
+  this._bidiProxyUrlCache.set(context, sessionCaps.webSocketUrl);
+  if (this._bidiProxyUrl !== sessionCaps.webSocketUrl) {
+    this._bidiProxyUrl = sessionCaps.webSocketUrl;
+    this.log.debug(`Updated Bidi Proxy URL to ${this._bidiProxyUrl}`);
+  }
+}
+
 /**
  * @this {import('../../driver').AndroidDriver}
  * @returns {boolean}

lib/constraints.ts

@@ -93,6 +93,9 @@ export const ANDROID_DRIVER_CONSTRAINTS = {
   chromedriverArgs: {
     isObject: true,
   },
+  chromedriverForwardBiDi: {
+    isBoolean: true,
+  },
   chromedriverExecutable: {
     isString: true,
   },

lib/driver.ts

@@ -208,6 +208,7 @@ import {mobileStartScreenStreaming, mobileStopScreenStreaming} from './commands/
 import {getSystemBars, mobilePerformStatusBarCommand} from './commands/system-bars';
 import {getDeviceTime, mobileGetDeviceTime} from './commands/time';
 import { executeMethodMap } from './execute-method-map';
+import { LRUCache } from 'lru-cache';
 
 export type AndroidDriverCaps = DriverCaps<AndroidDriverConstraints>;
 export type W3CAndroidDriverCaps = W3CDriverCaps<AndroidDriverConstraints>;
@@ -224,39 +225,28 @@ class AndroidDriver
   static executeMethodMap = executeMethodMap;
 
   jwpProxyAvoid: RouteMatcher[];
-
   adb: ADB;
-
   _settingsApp: SettingsApp;
-
   proxyReqRes?: (...args: any) => any;
-
   contexts?: string[];
-
   sessionChromedrivers: StringRecord<AppiumChromedriver>;
-
   chromedriver?: AppiumChromedriver;
-
   proxyCommand?: AndroidExternalDriver['proxyCommand'];
   jwpProxyActive: boolean;
   curContext: string;
-
   useUnlockHelperApp?: boolean;
-
   defaultIME?: string;
-
   _wasWindowAnimationDisabled?: boolean;
-
   _cachedActivityArgs: StringRecord;
-
   _screenStreamingProps?: StringRecord;
-
   _screenRecordingProperties?: StringRecord;
-
   _logcatWebsocketListener?: LogcatListener;
-
   _bidiServerLogListener?: (...args: any[]) => void;
-
+  _bidiProxyUrl: string | null = null;
+  _bidiProxyUrlCache: LRUCache<string, string> = new LRUCache({
+    max: 20,
+    updateAgeOnGet: true,
+  });
   opts: AndroidDriverOpts;
 
   constructor(opts: InitialOpts = {} as InitialOpts, shouldValidateCaps = true) {
@@ -276,8 +266,10 @@ class AndroidDriver
     this.curContext = this.defaultContextName();
     this.opts = opts as AndroidDriverOpts;
     this._cachedActivityArgs = {};
-    // @ts-ignore Remove it after min supported server version is ^2.14.0
-    this.doesSupportBidi = true;
+  }
+
+  get bidiProxyUrl(): string | null {
+    return this.opts.chromedriverForwardBiDi ? this._bidiProxyUrl : null;
   }
 
   get settingsApp(): SettingsApp {

package.json

@@ -51,7 +51,7 @@
     "@appium/support": "^7.0.0-rc.1",
     "@colors/colors": "^1.6.0",
     "appium-adb": "^14.0.0",
-    "appium-chromedriver": "^8.0.16",
+    "appium-chromedriver": "^8.0.18",
     "asyncbox": "^3.0.0",
     "axios": "^1.x",
     "bluebird": "^3.4.7",