appium 2.13.1 → 2.14.0

package/build/lib/appium.d.ts

@@ -131,69 +131,6 @@ export class AppiumDriver extends DriverCore<{
      * @returns {StringRecord|undefined} Arguments object. If none, `undefined`
      */
     getCliArgsForDriver(extName: string): StringRecord | undefined;
-    /**
-     * Initialize a new bidi connection and set up handlers
-     * @param {import('ws').WebSocket} ws The websocket connection object
-     * @param {import('http').IncomingMessage} req The connection pathname, which might include the session id
-     */
-    onBidiConnection(ws: import("ws").WebSocket, req: import("http").IncomingMessage): void;
-    /**
-     * Initialize a new bidi connection
-     * @param {import('ws').WebSocket} ws The websocket connection object
-     * @param {import('http').IncomingMessage} req The connection pathname, which might include the session id
-     */
-    initBidiSocket(ws: import("ws").WebSocket, req: import("http").IncomingMessage): {
-        bidiHandlerDriver: AppiumDriver | import("@appium/types").ExternalDriver<import("@appium/types").Constraints, string, import("@appium/types").StringRecord, import("@appium/types").StringRecord, import("@appium/types").DefaultCreateSessionResult<import("@appium/types").Constraints>, void, import("@appium/types").StringRecord>;
-        proxyClient: WebSocket.WebSocket | null;
-        send: (data: string | Buffer) => Promise<void>;
-        sendToProxy: ((data: string | Buffer) => Promise<void>) | null;
-        logSocketErr: (err: Error) => void;
-    };
-    /**
-     * Set up handlers on upstream bidi socket we are proxying to/from
-     *
-     * @param {import('ws').WebSocket | null} proxyClient - the websocket connection to/from the
-     * upstream socket (the one we're proxying to/from)
-     * @param {import('ws').WebSocket} ws - the websocket connection to/from the client
-     * @param {(data: string | Buffer) => Promise<void>} send - a method used to send data to the
-     * client
-     */
-    initBidiProxyHandlers(proxyClient: import("ws").WebSocket | null, ws: import("ws").WebSocket, send: (data: string | Buffer) => Promise<void>): void;
-    /**
-     * Set up handlers on the bidi socket connection to the client
-     *
-     * @param {import('ws').WebSocket} ws - the websocket connection to/from the client
-     * @param {import('ws').WebSocket | null} proxyClient - the websocket connection to/from the
-     * upstream socket (the one we're proxying to/from, if we're proxying)
-     * @param {(data: string | Buffer) => Promise<void>} send - a method used to send data to the
-     * client
-     * @param {((data: string | Buffer) => Promise<void>) | null} sendToProxy - a method used to send data to the
-     * upstream socket
-     * @param {import('@appium/types').ExternalDriver | AppiumDriver} bidiHandlerDriver - the driver
-     * handling the bidi commands
-     * @param {(err: Error) => void} logSocketErr - a special prefixed logger
-     */
-    initBidiSocketHandlers(ws: import("ws").WebSocket, proxyClient: import("ws").WebSocket | null, send: (data: string | Buffer) => Promise<void>, sendToProxy: ((data: string | Buffer) => Promise<void>) | null, bidiHandlerDriver: import("@appium/types").ExternalDriver | AppiumDriver, logSocketErr: (err: Error) => void): void;
-    /**
-     * Set up bidi event listeners
-     *
-     * @param {import('ws').WebSocket} ws - the websocket connection to/from the client
-     * @param {import('@appium/types').ExternalDriver | AppiumDriver} bidiHandlerDriver - the driver
-     * handling the bidi commands
-     * @param {(data: string | Buffer) => Promise<void>} send - a method used to send data to the
-     * client
-     */
-    initBidiEventListeners(ws: import("ws").WebSocket, bidiHandlerDriver: import("@appium/types").ExternalDriver | AppiumDriver, send: (data: string | Buffer) => Promise<void>): void;
-    /**
-     * @param {Buffer} data
-     * @param {ExternalDriver | AppiumDriver} driver
-     */
-    onBidiMessage(data: Buffer, driver: ExternalDriver | AppiumDriver): Promise<any>;
-    /**
-     * Log a bidi server error
-     * @param {Error} err
-     */
-    onBidiServerError(err: Error): void;
     /**
      * Create a new session
      * @param {W3CAppiumDriverCaps} jsonwpCaps JSONWP formatted desired capabilities
@@ -289,6 +226,9 @@ export class AppiumDriver extends DriverCore<{
     }>;
     proxyActive(sessionId: any): boolean;
     canProxy(sessionId: any): boolean;
+    onBidiConnection: typeof bidiHelpers.onBidiConnection;
+    onBidiMessage: typeof bidiHelpers.onBidiMessage;
+    onBidiServerError: typeof bidiHelpers.onBidiServerError;
 }
 declare namespace desiredCapabilityConstraints {
     namespace automationName {
@@ -303,6 +243,6 @@ declare namespace desiredCapabilityConstraints {
     }
 }
 import { DriverCore } from '@appium/base-driver';
-import WebSocket from 'ws';
+import * as bidiHelpers from './bidi';
 export {};
 //# sourceMappingURL=appium.d.ts.map

package/build/lib/appium.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"appium.d.ts","sourceRoot":"","sources":["../../lib/appium.js"],"names":[],"mappings":"AAyxCA;;;GAGG;AACH;IAME,cAOC;IAZD;;OAEG;IACH,MAFU,QAAQ,CAAC,MAAM,CAAC,CAEgB;CAU3C;yBAKY,OAAO,eAAe,EAAE,UAAU;yBAClC,OAAO,eAAe,EAAE,UAAU;0BAClC,OAAO,eAAe,EAAE,WAAW;2BACnC,OAAO,eAAe,EAAE,YAAY;4BACpC,OAAO,eAAe,EAAE,aAAa;2BACrC,OAAO,2BAA2B,EAAE,YAAY;yBAChD,OAAO,eAAe,EAAE,UAAU;yBAClC,OAAO,eAAe,EAAE,UAAU;2BAClC,OAAO,eAAe,EAAE,YAAY;6BACpC,OAAO,eAAe,EAAE,cAAc;0BACtC,OAAO,eAAe,EAAE,WAAW;qBACnC,OAAO,eAAe,EAAE,MAAM;0BAC9B,OAAO,eAAe,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,MAAM,CAAC;mCAInE,OAAO,eAAe,EAAE,eAAe,CAAC,uBAAuB,EACzE,0BAA0B,EAAE,0BAA0B,CAAC;yCAI7C,oBAAoB,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,IAAI,EAC9D,OAAS,eAAe,EAAE,UAAU,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAC,SAAS,CAAC,CAAC;iBAIrD,CAAC,SAAd,WAAY,IACb,OAAO,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC;yCAI/B,oBAAoB,CAAC,IAAI,CAAC;;;;;iCAM1B,CAAC;;;;;sCAQD,OAAO,4BAA4B;kCACnC,OAAO,eAAe,EAAE,aAAa,CAAC,uBAAuB,CAAC;AA5yC3E;;GAEG;AACH;;;;;;;;;;IA+DE;;OAEG;IACH,kBAFW,OAAO,eAAe,EAAE,UAAU,CAAC,uBAAuB,CAAC,EAkCrE;IAjGD;;;;;OAKG;IACH,UAFU,MAAM,CAAC,MAAM,EAAC,cAAc,CAAC,CAE9B;IAET;;;;;OAKG;IACH,gBAFU,MAAM,CAAC,MAAM,EAAC,cAAc,EAAE,CAAC,CAE1B;IASf;;;OAGG;IACH,eAFU,GAAG,CAAC,WAAW,EAAC,MAAM,CAAC,CAEnB;IAEd;;;OAGG;IACH,gBAFU,MAAM,CAAC,MAAM,EAAC,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC,CAErC;IAEf;;;OAGG;IACH,oBAFU,YAAY,CAAC,WAAW,CAAC,EAAE,CAElB;IAEnB,2BAA2B;IAC3B,cADW,YAAY,CACV;IAEb,2BAA2B;IAC3B,QADW,YAAY,CAChB;IAEP,uDAAuD;IACvD,aADW,MAAM,CAAC,MAAM,EAAE,OAAO,IAAI,EAAE,SAAS,EAAE,CAAC,CACvC;IAEZ,qDAAqD;IACrD,kBADW,MAAM,CAAC,MAAM,EAAE,OAAO,IAAI,EAAE,SAAS,CAAC,CAChC;IAEjB;;;OAGG;IACH,gCAHU,uBAAuB,CAGX;IAEtB,0EAA0E;IAC1E,MADW,OAAO,eAAe,EAAE,UAAU,CAAC,uBAAuB,CAAC,CACjE;IA0BH,yBAA4B;IA+B9B,uCAGC;IAED,uUAEC;IAGD;;;;OAeC;IAED;;OAEG;IACH,kBAFW,MAAM,GAAC,IAAI,iBAQrB;IAED;;sBAG6B,OAAO,eAAe,EAAE,UAAU,CAAC,GAAG,CAAC;SAEnE;IAED,+FAiBC;IAED;;;;OAIG;IACH,6BAHW,MAAM,GACJ,YAAY,CAIxB;IAED;;;;;;;;OAQG;IACH,6BAHW,MAAM,GACJ,YAAY,GAAC,SAAS,CAclC;IAED;;;;OAIG;IACH,qBAHW,OAAO,IAAI,EAAE,SAAS,OACtB,OAAO,MAAM,EAAE,eAAe,QA4BxC;IAED;;;;OAIG;IACH,mBAHW,OAAO,IAAI,EAAE,SAAS,OACtB,OAAO,MAAM,EAAE,eAAe;;;qBAiFZ,MAAM,GAAC,MAAM;6BAAb,MAAM,GAAC,MAAM;4BARP,KAAK;MAyBvC;IAED;;;;;;;;OAQG;IACH,mCANW,OAAO,IAAI,EAAE,SAAS,GAAG,IAAI,MAE7B,OAAO,IAAI,EAAE,SAAS,QACtB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,QAyClD;IAED;;;;;;;;;;;;;OAaG;IACH,2BAXW,OAAO,IAAI,EAAE,SAAS,eACtB,OAAO,IAAI,EAAE,SAAS,GAAG,IAAI,QAE7B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,eAExC,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,qBAEjD,OAAO,eAAe,EAAE,cAAc,GAAG,YAAY,gBAErD,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,QA6C9B;IAED;;;;;;;;OAQG;IACH,2BANW,OAAO,IAAI,EAAE,SAAS,qBACtB,OAAO,eAAe,EAAE,cAAc,GAAG,YAAY,QAErD,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,QAyClD;IAED;;;OAGG;IACH,oBAHW,MAAM,UACN,cAAc,GAAG,YAAY,gBAoCvC;IAED;;;OAGG;IACH,uBAFW,KAAK,QAIf;IAED;;;;;;OAMG;IACH,0BALW,mBAAmB,YACnB,mBAAmB,oBACnB,mBAAmB,GACjB,OAAO,CAAC,0BAA0B,CAAC,CAkM/C;IAED;;;;OAIG;IACH,wCAHW,cAAc,kBACd,MAAM,QAsChB;IAED;;;;;;OAMG;IACH,qCALW,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,GAAC,CAAC,KAAI,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,GACpD,OAAO,CAAC,UAAU,EAAE,CAAC,CAmBjC;IAED;;OAEG;IACH,yBAFW,MAAM;;;;;;;;OA6ChB;IAED;;OAEG;IACH,8BAFW,MAAM,QAuBhB;IAED,4CAqBC;IAED;;;;;OAKG;IACH,8BAHY,MAAM,OAAA,SAejB;IAED;;;;;;;;;OASG;IACH,wBAJW,MAAM,cACL,MAAM,OAAA,SASjB;IAED;;;OAGG;IACH,yBAFa,MAAM,EAAE,CAWpB;IAED;;;;;OAKG;IACH,oBAJW,MAAM,WACF,GAAG,EAAA,GACL,OAAO,CAAC;QAAC,KAAK,EAAE,GAAG,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,WAAW,EAAE,eAAe,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAyJ1I;IAED;;;;;;;YAwBC;IAED;;;aAoBC;IAED;;;;;;;OAwBC;IAED,qCAGC;IAYD,kCAGC;CACF;;;;;;;;;;;;;2BA/uCM,qBAAqB;sBAcN,IAAI"}
+{"version":3,"file":"appium.d.ts","sourceRoot":"","sources":["../../lib/appium.js"],"names":[],"mappings":"AAg7BA;;;GAGG;AACH;IAME,cAOC;IAZD;;OAEG;IACH,MAFU,QAAQ,CAAC,MAAM,CAAC,CAEgB;CAU3C;yBAKY,OAAO,eAAe,EAAE,UAAU;yBAClC,OAAO,eAAe,EAAE,UAAU;0BAClC,OAAO,eAAe,EAAE,WAAW;2BACnC,OAAO,eAAe,EAAE,YAAY;4BACpC,OAAO,eAAe,EAAE,aAAa;2BACrC,OAAO,2BAA2B,EAAE,YAAY;yBAChD,OAAO,eAAe,EAAE,UAAU;yBAClC,OAAO,eAAe,EAAE,UAAU;2BAClC,OAAO,eAAe,EAAE,YAAY;6BACpC,OAAO,eAAe,EAAE,cAAc;0BACtC,OAAO,eAAe,EAAE,WAAW;qBACnC,OAAO,eAAe,EAAE,MAAM;0BAC9B,OAAO,eAAe,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,MAAM,CAAC;mCAInE,OAAO,eAAe,EAAE,eAAe,CAAC,uBAAuB,EACzE,0BAA0B,EAAE,0BAA0B,CAAC;yCAI7C,oBAAoB,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,IAAI,EAC9D,OAAS,eAAe,EAAE,UAAU,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAC,SAAS,CAAC,CAAC;iBAIrD,CAAC,SAAd,WAAY,IACb,OAAO,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC;yCAI/B,oBAAoB,CAAC,IAAI,CAAC;;;;;iCAM1B,CAAC;;;;;sCAQD,OAAO,4BAA4B;kCACnC,OAAO,eAAe,EAAE,aAAa,CAAC,uBAAuB,CAAC;AA98B3E;;GAEG;AACH;;;;;;;;;;IA+DE;;OAEG;IACH,kBAFW,OAAO,eAAe,EAAE,UAAU,CAAC,uBAAuB,CAAC,EAkCrE;IAjGD;;;;;OAKG;IACH,UAFU,MAAM,CAAC,MAAM,EAAC,cAAc,CAAC,CAE9B;IAET;;;;;OAKG;IACH,gBAFU,MAAM,CAAC,MAAM,EAAC,cAAc,EAAE,CAAC,CAE1B;IASf;;;OAGG;IACH,eAFU,GAAG,CAAC,WAAW,EAAC,MAAM,CAAC,CAEnB;IAEd;;;OAGG;IACH,gBAFU,MAAM,CAAC,MAAM,EAAC,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC,CAErC;IAEf;;;OAGG;IACH,oBAFU,YAAY,CAAC,WAAW,CAAC,EAAE,CAElB;IAEnB,2BAA2B;IAC3B,cADW,YAAY,CACV;IAEb,2BAA2B;IAC3B,QADW,YAAY,CAChB;IAEP,uDAAuD;IACvD,aADW,MAAM,CAAC,MAAM,EAAE,OAAO,IAAI,EAAE,SAAS,EAAE,CAAC,CACvC;IAEZ,qDAAqD;IACrD,kBADW,MAAM,CAAC,MAAM,EAAE,OAAO,IAAI,EAAE,SAAS,CAAC,CAChC;IAEjB;;;OAGG;IACH,gCAHU,uBAAuB,CAGX;IAEtB,0EAA0E;IAC1E,MADW,OAAO,eAAe,EAAE,UAAU,CAAC,uBAAuB,CAAC,CACjE;IA0BH,yBAA4B;IA+B9B,uCAGC;IAED,uUAEC;IAED;;;;OAeC;IAED;;OAEG;IACH,kBAFW,MAAM,GAAC,IAAI,iBAQrB;IAED;;sBAG6B,OAAO,eAAe,EAAE,UAAU,CAAC,GAAG,CAAC;SAEnE;IAED,+FAiBC;IAED;;;;OAIG;IACH,6BAHW,MAAM,GACJ,YAAY,CAIxB;IAED;;;;;;;;OAQG;IACH,6BAHW,MAAM,GACJ,YAAY,GAAC,SAAS,CAclC;IAED;;;;;;OAMG;IACH,0BALW,mBAAmB,YACnB,mBAAmB,oBACnB,mBAAmB,GACjB,OAAO,CAAC,0BAA0B,CAAC,CAsM/C;IAED;;;;OAIG;IACH,wCAHW,cAAc,kBACd,MAAM,QAsChB;IAED;;;;;;OAMG;IACH,qCALW,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,GAAC,CAAC,KAAI,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,GACpD,OAAO,CAAC,UAAU,EAAE,CAAC,CAmBjC;IAED;;OAEG;IACH,yBAFW,MAAM;;;;;;;;OA6ChB;IAED;;OAEG;IACH,8BAFW,MAAM,QAuBhB;IAED,4CAqBC;IAED;;;;;OAKG;IACH,8BAHY,MAAM,OAAA,SAejB;IAED;;;;;;;;;OASG;IACH,wBAJW,MAAM,cACL,MAAM,OAAA,SASjB;IAED;;;OAGG;IACH,yBAFa,MAAM,EAAE,CAWpB;IAED;;;;;OAKG;IACH,oBAJW,MAAM,WACF,GAAG,EAAA,GACL,OAAO,CAAC;QAAC,KAAK,EAAE,GAAG,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,WAAW,EAAE,eAAe,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,CAAC,CA2J1I;IAED;;;;;;;YAyBC;IAED;;;aAoBC;IAED;;;;;;;OAwBC;IAED,qCAGC;IAYD,kCAGC;IAED,sDAAgD;IAChD,gDAA0C;IAC1C,wDAAkD;CACnD;;;;;;;;;;;;;2BA55BM,qBAAqB;6BAWC,QAAQ"}

package/build/lib/appium.js

@@ -1,12 +1,43 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppiumDriver = exports.NoDriverProxyCommandError = void 0;
-/* eslint-disable no-unused-vars */
 const lodash_1 = __importDefault(require("lodash"));
-const bluebird_1 = __importDefault(require("bluebird"));
 const config_1 = require("./config");
 const base_driver_1 = require("@appium/base-driver");
 const async_lock_1 = __importDefault(require("async-lock"));
@@ -14,11 +45,7 @@ const utils_1 = require("./utils");
 const support_1 = require("@appium/support");
 const schema_1 = require("./schema");
 const constants_1 = require("./constants");
-const ws_1 = __importDefault(require("ws"));
-const node_os_1 = __importDefault(require("node:os"));
-const MIN_WS_CODE_VAL = 1000;
-const MAX_WS_CODE_VAL = 1015;
-const WS_FALLBACK_CODE = 1011; // server encountered an error while fulfilling request
+const bidiHelpers = __importStar(require("./bidi"));
 const desiredCapabilityConstraints = /** @type {const} */ ({
     automationName: {
         presence: true,
@@ -47,6 +74,9 @@ class AppiumDriver extends base_driver_1.DriverCore {
             process.env.APPIUM_TMP_DIR = opts.tmpDir;
         }
         super(opts);
+        this.onBidiConnection = bidiHelpers.onBidiConnection;
+        this.onBidiMessage = bidiHelpers.onBidiMessage;
+        this.onBidiServerError = bidiHelpers.onBidiServerError;
         this.args = { ...opts };
         this.sessions = {};
         this.pendingDrivers = {};
@@ -92,7 +122,6 @@ class AppiumDriver extends base_driver_1.DriverCore {
     driverForSession(sessionId) {
         return this.sessions[sessionId];
     }
-    // eslint-disable-next-line require-await
     async getStatus() {
         // https://www.w3.org/TR/webdriver/#dfn-status
         const statusObj = this._isShuttingDown
@@ -166,294 +195,6 @@ class AppiumDriver extends base_driver_1.DriverCore {
             }
         }
     }
-    /**
-     * Initialize a new bidi connection and set up handlers
-     * @param {import('ws').WebSocket} ws The websocket connection object
-     * @param {import('http').IncomingMessage} req The connection pathname, which might include the session id
-     */
-    onBidiConnection(ws, req) {
-        // TODO put bidi-related functionality into a mixin/helper class
-        // wrap all of the handler logic with exception handling so if something blows up we can log
-        // and close the websocket
-        try {
-            const { bidiHandlerDriver, proxyClient, send, sendToProxy, logSocketErr } = this.initBidiSocket(ws, req);
-            this.initBidiSocketHandlers(ws, proxyClient, send, sendToProxy, bidiHandlerDriver, logSocketErr);
-            this.initBidiProxyHandlers(proxyClient, ws, send);
-            this.initBidiEventListeners(ws, bidiHandlerDriver, send);
-        }
-        catch (err) {
-            this.log.error(err);
-            try {
-                ws.close();
-            }
-            catch (ign) { }
-        }
-    }
-    /**
-     * Initialize a new bidi connection
-     * @param {import('ws').WebSocket} ws The websocket connection object
-     * @param {import('http').IncomingMessage} req The connection pathname, which might include the session id
-     */
-    initBidiSocket(ws, req) {
-        let outOfBandErrorPrefix = '';
-        const pathname = req.url;
-        if (!pathname) {
-            throw new Error('Invalid connection request: pathname missing from request');
-        }
-        const bidiSessionRe = new RegExp(`${constants_1.BIDI_BASE_PATH}/([^/]+)$`);
-        const bidiNoSessionRe = new RegExp(`${constants_1.BIDI_BASE_PATH}/?$`);
-        const sessionMatch = bidiSessionRe.exec(pathname);
-        const noSessionMatch = bidiNoSessionRe.exec(pathname);
-        if (!sessionMatch && !noSessionMatch) {
-            throw new Error(`Got websocket connection for path ${pathname} but didn't know what to do with it. ` +
-                `Ignoring and will close the connection`);
-        }
-        // Let's figure out which driver is going to handle this socket connection. It's either going
-        // to be a driver matching a session id appended to the bidi base path, or this umbrella driver
-        // (if no session id is included in the bidi connection request)
-        /** @type {import('@appium/types').ExternalDriver | AppiumDriver} */
-        let bidiHandlerDriver;
-        /** @type {import('ws').WebSocket | null} */
-        let proxyClient = null;
-        if (sessionMatch) {
-            // If we found a session id, see if it matches an active session
-            const sessionId = sessionMatch[1];
-            bidiHandlerDriver = this.sessions[sessionId];
-            if (!bidiHandlerDriver) {
-                // The session ID sent in doesn't match an active session; just ignore this socket
-                // connection in that case
-                throw new Error(`Got bidi connection request for session with id ${sessionId} which is closed ` +
-                    `or does not exist. Closing the socket connection.`);
-            }
-            const driverName = bidiHandlerDriver.constructor.name;
-            outOfBandErrorPrefix = `[session ${sessionId}] `;
-            this.log.info(`Bidi websocket connection made for session ${sessionId}`);
-            // store this socket connection for later removal on session deletion. theoretically there
-            // can be multiple sockets per session
-            if (!this.bidiSockets[sessionId]) {
-                this.bidiSockets[sessionId] = [];
-            }
-            this.bidiSockets[sessionId].push(ws);
-            const bidiProxyUrl = bidiHandlerDriver.bidiProxyUrl;
-            if (bidiProxyUrl) {
-                try {
-                    new URL(bidiProxyUrl);
-                }
-                catch (ign) {
-                    throw new Error(`Got request for ${driverName} to proxy bidi connections to upstream socket with ` +
-                        `url ${bidiProxyUrl}, but this was not a valid url`);
-                }
-                this.log.info(`Bidi connection for ${driverName} will be proxied to ${bidiProxyUrl}`);
-                proxyClient = new ws_1.default(bidiProxyUrl);
-                this.bidiProxyClients[sessionId] = proxyClient;
-            }
-        }
-        else {
-            this.log.info('Bidi websocket connection made to main server');
-            // no need to store the socket connection if it's to the main server since it will just
-            // stay open as long as the server itself is and will close when the server closes.
-            bidiHandlerDriver = this; // eslint-disable-line @typescript-eslint/no-this-alias
-        }
-        const logSocketErr = (/** @type {Error} */ err) => this.log.error(`${outOfBandErrorPrefix}${err}`);
-        // This is a function which wraps the 'send' method on a web socket for two reasons:
-        // 1. Make it async-await friendly
-        // 2. Do some logging if there's a send error
-        const sendFactory = (/** @type {import('ws').WebSocket} */ socket) => {
-            const socketSend = bluebird_1.default.promisify(socket.send, { context: socket });
-            return async (/** @type {string|Buffer} */ data) => {
-                try {
-                    await socketSend(data);
-                }
-                catch (err) {
-                    logSocketErr(err);
-                }
-            };
-        };
-        // Construct our send method for sending messages to the client
-        const send = sendFactory(ws);
-        // Construct a conditional send method for proxying messages from the client to an upstream
-        // bidi socket server (e.g. on a browser)
-        const sendToProxy = proxyClient ? sendFactory(proxyClient) : null;
-        return { bidiHandlerDriver, proxyClient, send, sendToProxy, logSocketErr };
-    }
-    /**
-     * Set up handlers on upstream bidi socket we are proxying to/from
-     *
-     * @param {import('ws').WebSocket | null} proxyClient - the websocket connection to/from the
-     * upstream socket (the one we're proxying to/from)
-     * @param {import('ws').WebSocket} ws - the websocket connection to/from the client
-     * @param {(data: string | Buffer) => Promise<void>} send - a method used to send data to the
-     * client
-     */
-    initBidiProxyHandlers(proxyClient, ws, send) {
-        // Set up handlers for events that might come from the upstream bidi socket connection if
-        // we're in proxy mode
-        if (proxyClient) {
-            // Here we're receiving a message from the upstream socket server. We want to pass it on to
-            // the client
-            proxyClient.on('message', async (/** @type {Buffer|string} */ data) => {
-                const logData = lodash_1.default.truncate(data.toString('utf8'), { length: base_driver_1.MAX_LOG_BODY_LENGTH });
-                this.log.debug(`<-- BIDI Received data from proxied bidi socket, sending to client. Data: ${logData}`);
-                await send(data);
-            });
-            // If the upstream socket server closes the connection, should close the connection to the
-            // client as well
-            proxyClient.on('close', (code, reason) => {
-                this.log.debug(`Upstream bidi socket closed connection (code ${code}, reason: '${reason}'). ` +
-                    `Closing proxy connection to client`);
-                if (!lodash_1.default.isNumber(code)) {
-                    code = parseInt(code, 10);
-                }
-                if (lodash_1.default.isNaN(code) || code < MIN_WS_CODE_VAL || code > MAX_WS_CODE_VAL) {
-                    this.log.warn(`Received code ${code} from upstream socket, but this is not a valid ` +
-                        `websocket code. Rewriting to ${WS_FALLBACK_CODE} for ws compatibility`);
-                    code = WS_FALLBACK_CODE;
-                }
-                ws.close(code, reason);
-            });
-            proxyClient.on('error', (err) => {
-                this.log.error(`Got error on upstream bidi socket connection: ${err}`);
-            });
-        }
-    }
-    /**
-     * Set up handlers on the bidi socket connection to the client
-     *
-     * @param {import('ws').WebSocket} ws - the websocket connection to/from the client
-     * @param {import('ws').WebSocket | null} proxyClient - the websocket connection to/from the
-     * upstream socket (the one we're proxying to/from, if we're proxying)
-     * @param {(data: string | Buffer) => Promise<void>} send - a method used to send data to the
-     * client
-     * @param {((data: string | Buffer) => Promise<void>) | null} sendToProxy - a method used to send data to the
-     * upstream socket
-     * @param {import('@appium/types').ExternalDriver | AppiumDriver} bidiHandlerDriver - the driver
-     * handling the bidi commands
-     * @param {(err: Error) => void} logSocketErr - a special prefixed logger
-     */
-    initBidiSocketHandlers(ws, proxyClient, send, sendToProxy, bidiHandlerDriver, logSocketErr) {
-        ws.on('error', (err) => {
-            // Can't do much with random errors on the connection other than log them
-            logSocketErr(err);
-        });
-        ws.on('open', () => {
-            this.log.info('Bidi websocket connection is now open');
-        });
-        // Now set up handlers for the various events that might happen on the websocket connection
-        // coming from the client
-        // First is incoming messages from the client
-        ws.on('message', async (/** @type {Buffer} */ data) => {
-            if (proxyClient) {
-                const logData = lodash_1.default.truncate(data.toString('utf8'), { length: base_driver_1.MAX_LOG_BODY_LENGTH });
-                this.log.debug(`--> BIDI Received data from client, sending to upstream bidi socket. Data: ${logData}`);
-                // if we're meant to proxy to an upstream bidi socket, just do that
-                // @ts-ignore sendToProxy is never null if proxyClient is truthy, but ts doesn't know
-                // that
-                await sendToProxy(data.toString('utf8'));
-            }
-            else {
-                const res = await this.onBidiMessage(data, bidiHandlerDriver);
-                await send(JSON.stringify(res));
-            }
-        });
-        // Next consider if the client closes the socket connection on us
-        ws.on('close', (code, reason) => {
-            // Not sure if we need to do anything here if the client closes the websocket connection.
-            // Probably if a session was started via the socket, and the socket closes, we should end the
-            // associated session to free up resources. But otherwise, for sockets attached to existing
-            // sessions, doing nothing is probably right.
-            this.log.debug(`Bidi socket connection closed (code ${code}, reason: '${reason}')`);
-            // If we're proxying, might as well close the upstream connection and clean it up
-            if (proxyClient) {
-                this.log.debug('Also closing bidi proxy socket connection');
-                proxyClient.close(code, reason);
-            }
-        });
-    }
-    /**
-     * Set up bidi event listeners
-     *
-     * @param {import('ws').WebSocket} ws - the websocket connection to/from the client
-     * @param {import('@appium/types').ExternalDriver | AppiumDriver} bidiHandlerDriver - the driver
-     * handling the bidi commands
-     * @param {(data: string | Buffer) => Promise<void>} send - a method used to send data to the
-     * client
-     */
-    initBidiEventListeners(ws, bidiHandlerDriver, send) {
-        // If the driver emits a bidi event that should maybe get sent to the client, check to make
-        // sure the client is subscribed and then pass it on
-        let eventListener = async ({ context, method, params }) => {
-            // if the driver didn't specify a context, use the empty context
-            if (!context) {
-                context = '';
-            }
-            if (!method || !params) {
-                throw new Error(`Driver emitted a bidi event that was malformed. Require method and params keys ` +
-                    `(with optional context). But instead received: ${JSON.stringify({
-                        context,
-                        method,
-                        params,
-                    })}`);
-            }
-            if (ws.readyState !== ws_1.default.OPEN) {
-                // if the websocket is not still 'open', then we can ignore sending these events
-                if (ws.readyState > ws_1.default.OPEN) {
-                    // if the websocket is closed or closing, we can remove this listener as well to avoid
-                    // leaks
-                    bidiHandlerDriver.eventEmitter.removeListener(constants_1.BIDI_EVENT_NAME, eventListener);
-                }
-                return;
-            }
-            if (bidiHandlerDriver.bidiEventSubs[method]?.includes(context)) {
-                this.log.info(`<-- BIDI EVENT ${method} (context: '${context}', params: ${JSON.stringify(params)})`);
-                // now we can send the event onto the socket
-                const ev = { type: 'event', context, method, params };
-                await send(JSON.stringify(ev));
-            }
-        };
-        bidiHandlerDriver.eventEmitter.on(constants_1.BIDI_EVENT_NAME, eventListener);
-    }
-    /**
-     * @param {Buffer} data
-     * @param {ExternalDriver | AppiumDriver} driver
-     */
-    async onBidiMessage(data, driver) {
-        let resMessage, id, method, params;
-        const dataTruncated = lodash_1.default.truncate(data.toString(), { length: 100 });
-        try {
-            try {
-                ({ id, method, params } = JSON.parse(data.toString('utf8')));
-            }
-            catch (err) {
-                throw new base_driver_1.errors.InvalidArgumentError(`Could not parse Bidi command '${dataTruncated}': ${err.message}`);
-            }
-            driver.log.info(`--> BIDI message #${id}`);
-            if (!method) {
-                throw new base_driver_1.errors.InvalidArgumentError(`Missing method for BiDi operation in '${dataTruncated}'`);
-            }
-            if (!params) {
-                throw new base_driver_1.errors.InvalidArgumentError(`Missing params for BiDi operation in '${dataTruncated}`);
-            }
-            const result = await driver.executeBidiCommand(method, params);
-            // https://w3c.github.io/webdriver-bidi/#protocol-definition
-            resMessage = {
-                id,
-                type: 'success',
-                result,
-            };
-        }
-        catch (err) {
-            resMessage = err.bidiErrObject(id);
-        }
-        driver.log.info(`<-- BIDI message #${id}`);
-        return resMessage;
-    }
-    /**
-     * Log a bidi server error
-     * @param {Error} err
-     */
-    onBidiServerError(err) {
-        this.log.error(`Error from bidi websocket server: ${err}`);
-    }
     /**
      * Create a new session
      * @param {W3CAppiumDriverCaps} jsonwpCaps JSONWP formatted desired capabilities
@@ -520,6 +261,9 @@ class AppiumDriver extends base_driver_1.DriverCore {
                     `enabled unless explicitly disabled by --deny-insecure`);
                 driverInstance.relaxedSecurityEnabled = true;
             }
+            // We also want to assign any new Bidi Commands that the driver has specified, including all
+            // the standard bidi commands
+            driverInstance.updateBidiCommands(InnerDriver.newBidiCommands ?? {});
             if (!lodash_1.default.isEmpty(this.args.denyInsecure)) {
                 this.log.info('Explicitly preventing use of insecure features:');
                 this.args.denyInsecure.map((a) => this.log.info(`    ${a}`));
@@ -587,7 +331,7 @@ class AppiumDriver extends base_driver_1.DriverCore {
             if (dCaps.webSocketUrl && driverInstance.doesSupportBidi) {
                 const { address, port, basePath } = this.args;
                 const scheme = `ws${this.server.isSecure() ? 's' : ''}`;
-                const host = determineBiDiHost(address);
+                const host = bidiHelpers.determineBiDiHost(address);
                 const bidiUrl = `${scheme}://${host}:${port}${basePath}${constants_1.BIDI_BASE_PATH}/${innerSessionId}`;
                 this.log.info(`Upstream driver responded with webSocketUrl ${dCaps.webSocketUrl}, will rewrite to ` +
                     `${bidiUrl} for response to client`);
@@ -870,7 +614,9 @@ class AppiumDriver extends base_driver_1.DriverCore {
             // if we're running with plugins, make sure we log that the default behavior is actually
             // happening so we can tell when the plugin call chain is unwrapping to the default behavior
             // if that's what happens
-            plugins.length && this.log.info(`Executing default handling behavior for command '${cmd}'`);
+            if (plugins.length) {
+                this.log.info(`Executing default handling behavior for command '${cmd}'`);
+            }
             // if we make it here, we know that the default behavior is handled
             cmdHandledBy.default = true;
             if (reqForProxy) {
@@ -931,8 +677,9 @@ class AppiumDriver extends base_driver_1.DriverCore {
         return res;
     }
     wrapCommandWithPlugins({ driver, cmd, args, next, cmdHandledBy, plugins }) {
-        plugins.length &&
+        if (plugins.length) {
             this.log.info(`Plugins which can handle cmd '${cmd}': ${plugins.map((p) => p.name)}`);
+        }
         // now we can go through each plugin and wrap `next` around its own handler, passing the *old*
         // next in so that it can call it if it wants to
         for (const plugin of plugins) {
@@ -1019,23 +766,6 @@ exports.AppiumDriver = AppiumDriver;
 function isAppiumDriverCommand(cmd) {
     return !(0, base_driver_1.isSessionCommand)(cmd) || cmd === base_driver_1.DELETE_SESSION_COMMAND;
 }
-/**
- * Clients cannot use broadcast addresses, like 0.0.0.0 or ::
- * to create connections. Thus we prefer a hostname if such
- * address is provided or the actual address of a non-local interface,
- * in case the host only has one such interface.
- *
- * @param {string} address
- * @returns {string}
- */
-function determineBiDiHost(address) {
-    if (!(0, utils_1.isBroadcastIp)(address)) {
-        return address;
-    }
-    const nonLocalInterfaces = (0, utils_1.fetchInterfaces)(address === utils_1.V4_BROADCAST_IP ? 4 : 6)
-        .filter((iface) => !iface.internal);
-    return nonLocalInterfaces.length === 1 ? nonLocalInterfaces[0].address : node_os_1.default.hostname();
-}
 /**
  * Thrown when Appium tried to proxy a command using a driver's `proxyCommand` method but the
  * method did not exist