appium-android-driver 13.1.2 → 13.2.0

package/lib/commands/streamscreen.ts

@@ -1,6 +1,5 @@
 import {fs, logger, system, util} from '@appium/support';
 import {waitForCondition} from 'asyncbox';
-import B from 'bluebird';
 import _ from 'lodash';
 import {spawn} from 'node:child_process';
 import http from 'node:http';
@@ -139,65 +138,75 @@ export async function mobileStartScreenStreaming(
 
   let mjpegSocket: net.Socket | undefined;
   let mjpegServer: http.Server | undefined;
-  try {
-    await new B<void>((resolve, reject) => {
-      mjpegSocket = net.createConnection(tcpPort, TCP_HOST, () => {
-        this.log.info(`Successfully connected to MJPEG stream at tcp://${TCP_HOST}:${tcpPort}`);
-        mjpegServer = http.createServer((req, res) => {
-          const remoteAddress = extractRemoteAddress(req);
-          const currentPathname = url.parse(String(req.url)).pathname;
+  let mjpegConnectTimeoutId: ReturnType<typeof setTimeout> | undefined;
+  const mjpegConnectTimeoutPromise = new Promise<never>((_resolve, reject) => {
+    mjpegConnectTimeoutId = setTimeout(
+      () =>
+        reject(
+          new Error(
+            `Cannot connect to the streaming server within ${STREAMING_STARTUP_TIMEOUT_MS}ms`,
+          ),
+        ),
+      STREAMING_STARTUP_TIMEOUT_MS,
+    );
+  });
+  const mjpegServerReadyPromise = new Promise<void>((resolve, reject) => {
+    mjpegSocket = net.createConnection(tcpPort, TCP_HOST, () => {
+      this.log.info(`Successfully connected to MJPEG stream at tcp://${TCP_HOST}:${tcpPort}`);
+      mjpegServer = http.createServer((req, res) => {
+        const remoteAddress = extractRemoteAddress(req);
+        const currentPathname = extractSafePathnameFromUrl(req.url);
+        this.log.info(
+          `Got an incoming screen broadcasting request from ${remoteAddress} ` +
+            `(${req.headers['user-agent'] || 'User Agent unknown'}) at ${currentPathname}`,
+        );
+
+        if (pathname && currentPathname !== pathname) {
           this.log.info(
-            `Got an incoming screen broadcasting request from ${remoteAddress} ` +
-              `(${req.headers['user-agent'] || 'User Agent unknown'}) at ${currentPathname}`,
+            'Rejecting the broadcast request since it does not match the given pathname',
           );
-
-          if (pathname && currentPathname !== pathname) {
-            this.log.info(
-              'Rejecting the broadcast request since it does not match the given pathname',
-            );
-            res.writeHead(404, {
-              Connection: 'close',
-              'Content-Type': 'text/plain; charset=utf-8',
-            });
-            res.write(`'${currentPathname}' did not match any known endpoints`);
-            res.end();
-            return;
-          }
-
-          this.log.info('Starting MJPEG broadcast');
-          res.writeHead(200, {
-            'Cache-Control':
-              'no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0',
-            Pragma: 'no-cache',
+          res.writeHead(404, {
             Connection: 'close',
-            'Content-Type': `multipart/x-mixed-replace; boundary=${BOUNDARY_STRING}`,
+            'Content-Type': 'text/plain; charset=utf-8',
           });
+          res.write(`'${currentPathname}' did not match any known endpoints`);
+          res.end();
+          return;
+        }
 
-          if (mjpegSocket) {
-            mjpegSocket.pipe(res);
-          }
+        this.log.info('Starting MJPEG broadcast');
+        res.writeHead(200, {
+          'Cache-Control':
+            'no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0',
+          Pragma: 'no-cache',
+          Connection: 'close',
+          'Content-Type': `multipart/x-mixed-replace; boundary=${BOUNDARY_STRING}`,
         });
-        mjpegServer.on('error', (e) => {
-          this.log.warn(e);
-          reject(e);
-        });
-        mjpegServer.on('close', () => {
-          this.log.debug(`MJPEG server at http://${host}:${port} has been closed`);
-        });
-        mjpegServer.on('listening', () => {
-          this.log.info(`Successfully started MJPEG server at http://${host}:${port}`);
-          resolve();
-        });
-        mjpegServer.listen(port, host);
+
+        if (mjpegSocket) {
+          mjpegSocket.pipe(res);
+        }
       });
-      mjpegSocket.on('error', (e) => {
-        this.log.error(e);
+      mjpegServer.on('error', (e) => {
+        this.log.warn(e);
         reject(e);
       });
-    }).timeout(
-      STREAMING_STARTUP_TIMEOUT_MS,
-      `Cannot connect to the streaming server within ${STREAMING_STARTUP_TIMEOUT_MS}ms`,
-    );
+      mjpegServer.on('close', () => {
+        this.log.debug(`MJPEG server at http://${host}:${port} has been closed`);
+      });
+      mjpegServer.on('listening', () => {
+        this.log.info(`Successfully started MJPEG server at http://${host}:${port}`);
+        resolve();
+      });
+      mjpegServer.listen(port, host);
+    });
+    mjpegSocket.on('error', (e) => {
+      this.log.error(e);
+      reject(e);
+    });
+  });
+  try {
+    await Promise.race([mjpegServerReadyPromise, mjpegConnectTimeoutPromise]);
   } catch (e) {
     if (deviceStreamingProc.kill(0)) {
       deviceStreamingProc.kill();
@@ -212,6 +221,10 @@ export async function mobileStartScreenStreaming(
       mjpegServer.close();
     }
     throw e;
+  } finally {
+    if (mjpegConnectTimeoutId !== undefined) {
+      clearTimeout(mjpegConnectTimeoutId);
+    }
   }
 
   this._screenStreamingProps = {
@@ -303,7 +316,7 @@ async function verifyStreamingRequirements(adb: ADB): Promise<void> {
       })(),
     );
   }
-  await B.all(gstreamerCheckPromises);
+  await Promise.all(gstreamerCheckPromises);
 
   const moduleCheckPromises: Promise<void>[] = [];
   for (const [name, modName] of _.toPairs(REQUIRED_GST_PLUGINS)) {
@@ -319,7 +332,7 @@ async function verifyStreamingRequirements(adb: ADB): Promise<void> {
       })(),
     );
   }
-  await B.all(moduleCheckPromises);
+  await Promise.all(moduleCheckPromises);
 }
 
 const deviceInfoRegexes = [
@@ -499,6 +512,17 @@ async function initGstreamerPipeline(
   return gstreamerPipeline;
 }
 
+/**
+ * WHATWG URL parsing can throw on malformed input; HTTP servers must not throw synchronously in request handlers.
+ */
+function extractSafePathnameFromUrl(requestUrl: string | undefined): string {
+  try {
+    return new url.URL(String(requestUrl ?? '/'), 'http://127.0.0.1').pathname;
+  } catch {
+    return '/';
+  }
+}
+
 /**
  * @privateRemarks This may need to be future-proofed, as `IncomingMessage.connection` is deprecated and its `socket` prop is likely private
  */

package/lib/commands/system-bars.ts

@@ -22,6 +22,11 @@ const DEFAULT_WINDOW_PROPERTIES: WindowProperties = {
   height: 0,
 };
 
+interface SystemBarsResult {
+  statusBar?: WindowProperties;
+  navigationBar?: WindowProperties;
+}
+
 /**
  * Gets the system bars (status bar and navigation bar) properties.
  *
@@ -86,8 +91,6 @@ export async function mobilePerformStatusBarCommand(
   return await action();
 }
 
-// #region Internal helpers
-
 /**
  * Parses window properties from adb dumpsys output
  *
@@ -185,10 +188,3 @@ export function parseWindows(this: AndroidDriver, lines: string): SystemBarsResu
   }
   return result;
 }
-
-// #endregion
-
-interface SystemBarsResult {
-  statusBar?: WindowProperties;
-  navigationBar?: WindowProperties;
-}

package/lib/driver.ts

@@ -240,97 +240,6 @@ class AndroidDriver
   });
   opts: AndroidDriverOpts;
 
-  constructor(opts: InitialOpts = {} as InitialOpts, shouldValidateCaps = true) {
-    super(opts, shouldValidateCaps);
-
-    this.locatorStrategies = [
-      'xpath',
-      'id',
-      'class name',
-      'accessibility id',
-      '-android uiautomator',
-    ];
-    this.desiredCapConstraints = _.cloneDeep(ANDROID_DRIVER_CONSTRAINTS);
-    this.sessionChromedrivers = {};
-    this.jwpProxyActive = false;
-
-    this.curContext = this.defaultContextName();
-    this.opts = opts as AndroidDriverOpts;
-    this._cachedActivityArgs = {};
-  }
-
-  get bidiProxyUrl(): string | null {
-    return this.opts.chromedriverForwardBiDi ? this._bidiProxyUrl : null;
-  }
-
-  get settingsApp(): SettingsApp {
-    if (!this._settingsApp || this._settingsApp.adb !== this.adb) {
-      this._settingsApp = new SettingsApp({adb: this.adb});
-    }
-    return this._settingsApp;
-  }
-
-  isEmulator(): boolean {
-    const possibleNames = [this.opts?.udid, this.adb?.curDeviceId];
-    return !!this.opts?.avd || possibleNames.some((x) => EMULATOR_PATTERN.test(String(x)));
-  }
-
-  get isChromeSession(): boolean {
-    return _.includes(
-      Object.keys(CHROME_BROWSER_PACKAGE_ACTIVITY),
-      (this.opts.browserName || '').toLowerCase(),
-    );
-  }
-
-  override validateDesiredCaps(caps: any): caps is AndroidDriverCaps {
-    if (!super.validateDesiredCaps(caps)) {
-      return false;
-    }
-
-    if (caps.browserName) {
-      if (caps.app) {
-        // warn if the capabilities have both `app` and `browser, although this is common with selenium grid
-        this.log.warn(
-          `The desired capabilities should generally not include both an 'app' and a 'browserName'`,
-        );
-      }
-      if (caps.appPackage) {
-        throw this.log.errorWithException(
-          `The desired should not include both of an 'appPackage' and a 'browserName'`,
-        );
-      }
-    }
-
-    if (caps.uninstallOtherPackages) {
-      try {
-        parseArray(caps.uninstallOtherPackages);
-      } catch (e) {
-        throw this.log.errorWithException(
-          `Could not parse "uninstallOtherPackages" capability: ${(e as Error).message}`,
-        );
-      }
-    }
-
-    return true;
-  }
-
-  override async deleteSession(sessionId?: string | null) {
-    await removeAllSessionWebSocketHandlers.bind(this)();
-
-    try {
-      this.adb?.logcat?.removeAllListeners();
-      await this.adb?.stopLogcat();
-    } catch (e) {
-      this.log.warn(`Cannot stop the logcat process. Original error: ${e.message}`);
-    }
-
-    if (this._bidiServerLogListener) {
-      this.log.unwrap().off('log', this._bidiServerLogListener);
-    }
-
-    await super.deleteSession(sessionId);
-  }
-
   getContexts = getContexts;
   getCurrentContext = getCurrentContext;
   defaultContextName = defaultContextName;
@@ -542,6 +451,97 @@ class AndroidDriver
   reset = reset;
   closeApp = closeApp;
   launchApp = launchApp;
+
+  constructor(opts: InitialOpts = {} as InitialOpts, shouldValidateCaps = true) {
+    super(opts, shouldValidateCaps);
+
+    this.locatorStrategies = [
+      'xpath',
+      'id',
+      'class name',
+      'accessibility id',
+      '-android uiautomator',
+    ];
+    this.desiredCapConstraints = _.cloneDeep(ANDROID_DRIVER_CONSTRAINTS);
+    this.sessionChromedrivers = {};
+    this.jwpProxyActive = false;
+
+    this.curContext = this.defaultContextName();
+    this.opts = opts as AndroidDriverOpts;
+    this._cachedActivityArgs = {};
+  }
+
+  get bidiProxyUrl(): string | null {
+    return this.opts.chromedriverForwardBiDi ? this._bidiProxyUrl : null;
+  }
+
+  get settingsApp(): SettingsApp {
+    if (!this._settingsApp || this._settingsApp.adb !== this.adb) {
+      this._settingsApp = new SettingsApp({adb: this.adb});
+    }
+    return this._settingsApp;
+  }
+
+  get isChromeSession(): boolean {
+    return _.includes(
+      Object.keys(CHROME_BROWSER_PACKAGE_ACTIVITY),
+      (this.opts.browserName || '').toLowerCase(),
+    );
+  }
+
+  isEmulator(): boolean {
+    const possibleNames = [this.opts?.udid, this.adb?.curDeviceId];
+    return !!this.opts?.avd || possibleNames.some((x) => EMULATOR_PATTERN.test(String(x)));
+  }
+
+  override validateDesiredCaps(caps: any): caps is AndroidDriverCaps {
+    if (!super.validateDesiredCaps(caps)) {
+      return false;
+    }
+
+    if (caps.browserName) {
+      if (caps.app) {
+        // warn if the capabilities have both `app` and `browser, although this is common with selenium grid
+        this.log.warn(
+          `The desired capabilities should generally not include both an 'app' and a 'browserName'`,
+        );
+      }
+      if (caps.appPackage) {
+        throw this.log.errorWithException(
+          `The desired should not include both of an 'appPackage' and a 'browserName'`,
+        );
+      }
+    }
+
+    if (caps.uninstallOtherPackages) {
+      try {
+        parseArray(caps.uninstallOtherPackages);
+      } catch (e) {
+        throw this.log.errorWithException(
+          `Could not parse "uninstallOtherPackages" capability: ${(e as Error).message}`,
+        );
+      }
+    }
+
+    return true;
+  }
+
+  override async deleteSession(sessionId?: string | null) {
+    await removeAllSessionWebSocketHandlers.bind(this)();
+
+    try {
+      this.adb?.logcat?.removeAllListeners();
+      await this.adb?.stopLogcat();
+    } catch (e) {
+      this.log.warn(`Cannot stop the logcat process. Original error: ${e.message}`);
+    }
+
+    if (this._bidiServerLogListener) {
+      this.log.unwrap().off('log', this._bidiServerLogListener);
+    }
+
+    await super.deleteSession(sessionId);
+  }
 }
 
 export {AndroidDriver};

package/lib/utils.ts

@@ -11,6 +11,13 @@ export const GET_SERVER_LOGS_FEATURE = 'get_server_logs';
 export const SET_STYLUS_HANDWRITING_FEATURE = 'set_stylus_handwriting';
 const COLOR_CODE_PATTERN = /\u001b\[(\d+(;\d+)*)?m/g; // eslint-disable-line no-control-regex
 
+interface LogEntryWithPrefix {
+  message: string;
+  prefix?: string;
+  timestamp?: number;
+  level?: string;
+}
+
 /**
  * Assert the presence of particular keys in the given object
  *
@@ -65,13 +72,6 @@ export async function removeAllSessionWebSocketHandlers(this: AndroidDriver): Pr
   }
 }
 
-interface LogEntryWithPrefix {
-  message: string;
-  prefix?: string;
-  timestamp?: number;
-  level?: string;
-}
-
 /**
  *
  * @param x

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-android-driver",
-  "version": "13.1.2",
+  "version": "13.2.0",
   "description": "Android UiAutomator and Chrome support for Appium",
   "keywords": [
     "appium",
@@ -53,7 +53,6 @@
     "appium-chromedriver": "^8.2.25",
     "asyncbox": "^6.1.0",
     "axios": "^1.x",
-    "bluebird": "^3.4.7",
     "io.appium.settings": "^7.0.4",
     "lodash": "^4.17.4",
     "lru-cache": "^11.1.0",
@@ -70,7 +69,6 @@
     "@appium/types": "^1.0.0-rc.1",
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@types/bluebird": "^3.5.38",
     "@types/lodash": "^4.14.194",
     "@types/mocha": "^10.0.1",
     "@types/node": "^25.0.0",