appium-uiautomator2-driver 8.2.0 → 8.2.2

package/lib/logger.ts

@@ -1,4 +1,4 @@
-import {logger} from 'appium/support.js';
 import type {AppiumLogger} from '@appium/types';
+import {logger} from 'appium/support.js';
 
 export const log: AppiumLogger = logger.getLogger('UiAutomator2');

package/lib/session-claim-handler.ts

@@ -1,7 +1,9 @@
+import {setTimeout as delay} from 'node:timers/promises';
+
 import type {AppiumLogger, IAppiumIpc, IIpcSubscription, IpcMessage} from '@appium/types';
 import {node, util} from 'appium/support.js';
 import {waitForCondition} from 'asyncbox';
-import {setTimeout as delay} from 'node:timers/promises';
+
 import type {AndroidUiautomator2Driver} from './driver.js';
 import {memoize} from './utils/index.js';
 
@@ -21,10 +23,7 @@ export class SessionClaimHandler {
   private static readonly CONTENTION_PROBE_MS = 10;
   private static readonly RELEASE_WAIT_MS = 15000;
 
-  private readonly subscriptionsBySessionId = new Map<
-    string,
-    IIpcSubscription<SessionUdidIpcMessage>
-  >();
+  private readonly subscriptionsBySessionId = new Map<string, IIpcSubscription<SessionUdidIpcMessage>>();
 
   constructor(private readonly getIpc: IpcProvider) {}
 
@@ -64,9 +63,7 @@ export class SessionClaimHandler {
   async claimSessionUdid(driver: AndroidUiautomator2Driver): Promise<void> {
     const ipc = await this.getIpc();
     if (!ipc) {
-      driver.log.debug(
-        'Driver-instance IPC is unavailable. Skipping publication of the session udid.',
-      );
+      driver.log.debug('Driver-instance IPC is unavailable. Skipping publication of the session udid.');
       return;
     }
 
@@ -99,14 +96,10 @@ export class SessionClaimHandler {
     });
 
     try {
-      await ipc.publish<SessionUdidIpcMessage>(
-        SessionClaimHandler.CLAIMED_TOPIC,
-        this.getPublisherId(driver),
-        {
-          udid,
-          sessionId,
-        },
-      );
+      await ipc.publish<SessionUdidIpcMessage>(SessionClaimHandler.CLAIMED_TOPIC, this.getPublisherId(driver), {
+        udid,
+        sessionId,
+      });
       await delay(SessionClaimHandler.CONTENTION_PROBE_MS);
 
       if (contendingSessionIds.size === 0) {
@@ -114,21 +107,16 @@ export class SessionClaimHandler {
       }
 
       try {
-        await waitForCondition(
-          () => [...contendingSessionIds].every((id) => releasedSessionIds.has(id)),
-          {
-            waitMs: SessionClaimHandler.RELEASE_WAIT_MS,
-            intervalMs: 50,
-          },
-        );
+        await waitForCondition(() => [...contendingSessionIds].every((id) => releasedSessionIds.has(id)), {
+          waitMs: SessionClaimHandler.RELEASE_WAIT_MS,
+          intervalMs: 50,
+        });
         driver.log.debug(
           `Received release confirmation from ` +
             `${util.pluralize('session', contendingSessionIds.size, true)} for udid '${udid}'`,
         );
       } catch {
-        const pendingSessionIds = [...contendingSessionIds].filter(
-          (id) => !releasedSessionIds.has(id),
-        );
+        const pendingSessionIds = [...contendingSessionIds].filter((id) => !releasedSessionIds.has(id));
         driver.log.warn(
           `Timed out after ${SessionClaimHandler.RELEASE_WAIT_MS}ms waiting for ` +
             `${util.pluralize('session', pendingSessionIds.length, true)} ` +
@@ -177,9 +165,7 @@ export class SessionClaimHandler {
       await this.publishSessionUdidContended(driver, udid);
     } catch (err) {
       const msg = err instanceof Error ? err.message : String(err);
-      driver.log.warn(
-        `Could not publish udid contention message for session '${driver.sessionId}': ${msg}`,
-      );
+      driver.log.warn(`Could not publish udid contention message for session '${driver.sessionId}': ${msg}`);
     }
 
     driver.log.warn(
@@ -192,30 +178,20 @@ export class SessionClaimHandler {
     await this.terminateSessionOnRequest(driver, udid);
   }
 
-  private async publishSessionUdidContended(
-    driver: AndroidUiautomator2Driver,
-    udid: string,
-  ): Promise<void> {
+  private async publishSessionUdidContended(driver: AndroidUiautomator2Driver, udid: string): Promise<void> {
     const ipc = await this.getIpc();
     const sessionId = driver.sessionId ?? undefined;
     if (!ipc || !udid || !sessionId) {
       return;
     }
 
-    await ipc.publish<SessionUdidIpcMessage>(
-      SessionClaimHandler.CONTENDED_TOPIC,
-      this.getPublisherId(driver),
-      {
-        udid,
-        sessionId,
-      },
-    );
+    await ipc.publish<SessionUdidIpcMessage>(SessionClaimHandler.CONTENDED_TOPIC, this.getPublisherId(driver), {
+      udid,
+      sessionId,
+    });
   }
 
-  private async terminateSessionOnRequest(
-    driver: AndroidUiautomator2Driver,
-    udid: string,
-  ): Promise<void> {
+  private async terminateSessionOnRequest(driver: AndroidUiautomator2Driver, udid: string): Promise<void> {
     const sessionId = driver.sessionId ?? undefined;
     const publisherId = sessionId ? this.getPublisherId(driver) : undefined;
     const {log} = driver;

package/lib/types.ts

@@ -1,4 +1,5 @@
 import type {DriverCaps, DriverOpts, W3CDriverCaps} from '@appium/types';
+
 import type {RelativeRect} from './commands/types.js';
 import type {Uiautomator2Constraints} from './constraints.js';
 
@@ -41,8 +42,7 @@ export interface Uiautomator2ServerInfo {
   desired: Uiautomator2DriverCaps;
 }
 
-export interface Uiautomator2StartSessionOpts
-  extends Uiautomator2DriverCaps, Uiautomator2ServerInfo {}
+export interface Uiautomator2StartSessionOpts extends Uiautomator2DriverCaps, Uiautomator2ServerInfo {}
 
 export interface Uiautomator2SessionCaps
   extends Uiautomator2ServerInfo, Uiautomator2SessionInfo, Partial<Uiautomator2DeviceDetails> {}

package/lib/uiautomator2-server/core.ts

@@ -1,22 +1,16 @@
-import {JWProxy, errors} from 'appium/driver.js';
-import {sleep, waitForCondition} from 'asyncbox';
+import type {AppiumLogger, StringRecord, HTTPMethod, HTTPBody, ProxyResponse, ProxyOptions} from '@appium/types';
+import type {ADB, InstallState} from 'appium-adb';
 import {
   SERVER_APK_PATH as apkPath,
   TEST_APK_PATH as testApkPath,
   version as serverVersion,
 } from 'appium-uiautomator2-server';
+import {JWProxy, errors} from 'appium/driver.js';
 import {util, timing} from 'appium/support.js';
-import type {
-  AppiumLogger,
-  StringRecord,
-  HTTPMethod,
-  HTTPBody,
-  ProxyResponse,
-  ProxyOptions,
-} from '@appium/types';
+import {sleep, waitForCondition} from 'asyncbox';
 import axios from 'axios';
-import type {ADB, InstallState} from 'appium-adb';
 import type {SubProcess} from 'teen_process';
+
 import {SERVER_PACKAGE_ID, SERVER_TEST_PACKAGE_ID} from './packages.js';
 
 const SERVER_LAUNCH_TIMEOUT_MS = 30000;
@@ -147,11 +141,8 @@ export class UiAutomator2Server {
     const shouldUninstallServerPackages = this.shouldUninstallServerPackages(packagesInfo);
     // Install must always follow uninstall. Also, perform the install if
     // any of server packages is not installed or is outdated
-    const shouldInstallServerPackages =
-      shouldUninstallServerPackages || this.shouldInstallServerPackages(packagesInfo);
-    this.log.info(
-      `Server packages are ${shouldInstallServerPackages ? '' : 'not '}going to be (re)installed`,
-    );
+    const shouldInstallServerPackages = shouldUninstallServerPackages || this.shouldInstallServerPackages(packagesInfo);
+    this.log.info(`Server packages are ${shouldInstallServerPackages ? '' : 'not '}going to be (re)installed`);
     if (shouldInstallServerPackages && shouldUninstallServerPackages) {
       this.log.info('Full packages reinstall is going to be performed');
     }
@@ -183,9 +174,7 @@ export class UiAutomator2Server {
   async startSession(caps: StringRecord): Promise<void> {
     await this.cleanupAutomationLeftovers();
     if (caps.skipServerInstallation) {
-      this.log.info(
-        `'skipServerInstallation' is set. Attempting to use UIAutomator2 server from the device`,
-      );
+      this.log.info(`'skipServerInstallation' is set. Attempting to use UIAutomator2 server from the device`);
     } else {
       this.log.info(`Starting UIAutomator2 server ${serverVersion}`);
       this.log.info(`Using UIAutomator2 server from '${apkPath}' and test from '${testApkPath}'`);
@@ -248,8 +237,7 @@ export class UiAutomator2Server {
     }
 
     this.log.debug(
-      `The initialization of the instrumentation process took ` +
-        `${timer.getDuration().asMilliSeconds.toFixed(0)}ms`,
+      `The initialization of the instrumentation process took ` + `${timer.getDuration().asMilliSeconds.toFixed(0)}ms`,
     );
     await this.jwproxy.command('/session', 'POST', {
       capabilities: {
@@ -266,8 +254,7 @@ export class UiAutomator2Server {
       await this.jwproxy.command('/', 'DELETE');
     } catch (err: any) {
       this.log.warn(
-        `Did not get the confirmation of UiAutomator2 server session deletion. ` +
-          `Original error: ${err.message}`,
+        `Did not get the confirmation of UiAutomator2 server session deletion. ` + `Original error: ${err.message}`,
       );
     }
 
@@ -283,10 +270,7 @@ export class UiAutomator2Server {
     }
 
     try {
-      await Promise.all([
-        this.adb.forceStop(SERVER_PACKAGE_ID),
-        this.adb.forceStop(SERVER_TEST_PACKAGE_ID),
-      ]);
+      await Promise.all([this.adb.forceStop(SERVER_PACKAGE_ID), this.adb.forceStop(SERVER_TEST_PACKAGE_ID)]);
     } catch {}
   }
 
@@ -302,10 +286,7 @@ export class UiAutomator2Server {
       // since it does not contain any version info
       resultInfo.installState = this.adb.APP_INSTALL_STATE.SAME_VERSION_INSTALLED;
     } else if (appId === SERVER_PACKAGE_ID) {
-      resultInfo.installState = await this.adb.getApplicationInstallState(
-        resultInfo.appPath,
-        appId,
-      );
+      resultInfo.installState = await this.adb.getApplicationInstallState(resultInfo.appPath, appId);
     }
 
     return resultInfo;
@@ -330,10 +311,9 @@ export class UiAutomator2Server {
       ({installState}) => installState !== this.adb.APP_INSTALL_STATE.NOT_INSTALLED,
     );
     const isAnyComponentNotInstalledOrNewer = packagesInfo.some(({installState}) =>
-      [
-        this.adb.APP_INSTALL_STATE.NOT_INSTALLED,
-        this.adb.APP_INSTALL_STATE.NEWER_VERSION_INSTALLED,
-      ].includes(installState),
+      [this.adb.APP_INSTALL_STATE.NOT_INSTALLED, this.adb.APP_INSTALL_STATE.NEWER_VERSION_INSTALLED].includes(
+        installState,
+      ),
     );
     return isAnyComponentInstalled && isAnyComponentNotInstalledOrNewer;
   }
@@ -347,10 +327,9 @@ export class UiAutomator2Server {
    */
   private shouldInstallServerPackages(packagesInfo: PackageInfo[] = []): boolean {
     return packagesInfo.some(({installState}) =>
-      [
-        this.adb.APP_INSTALL_STATE.NOT_INSTALLED,
-        this.adb.APP_INSTALL_STATE.OLDER_VERSION_INSTALLED,
-      ].includes(installState),
+      [this.adb.APP_INSTALL_STATE.NOT_INSTALLED, this.adb.APP_INSTALL_STATE.OLDER_VERSION_INSTALLED].includes(
+        installState,
+      ),
     );
   }
 
@@ -390,9 +369,7 @@ export class UiAutomator2Server {
       );
     } catch {
       const errorMessage = (pmError as any)?.message || 'Unknown error';
-      this.log.error(
-        `Unable to find instrumentation target '${INSTRUMENTATION_TARGET}': ${errorMessage}`,
-      );
+      this.log.error(`Unable to find instrumentation target '${INSTRUMENTATION_TARGET}': ${errorMessage}`);
       if (pmOutput) {
         this.log.debug('Available targets:');
         for (const line of pmOutput.split('\n')) {
@@ -408,11 +385,7 @@ export class UiAutomator2Server {
       cmd.push('--no-window-animation');
     }
     if (typeof this.disableSuppressAccessibilityService === 'boolean') {
-      cmd.push(
-        '-e',
-        'DISABLE_SUPPRESS_ACCESSIBILITY_SERVICES',
-        `${this.disableSuppressAccessibilityService}`,
-      );
+      cmd.push('-e', 'DISABLE_SUPPRESS_ACCESSIBILITY_SERVICES', `${this.disableSuppressAccessibilityService}`);
     }
     // Disable Google analytics to prevent possible fatal exception
     cmd.push('-e', 'disableAnalytics', 'true');
@@ -424,9 +397,7 @@ export class UiAutomator2Server {
       );
     }
     this.instrumentationProcess.once('exit', (code: number | null, signal: string | null) => {
-      this.log.debug(
-        `[Instrumentation] The process has exited with code ${code}, signal ${signal}`,
-      );
+      this.log.debug(`[Instrumentation] The process has exited with code ${code}, signal ${signal}`);
       this.jwproxy.didInstrumentationExit = true;
     });
     await this.instrumentationProcess.start(0);
@@ -444,9 +415,7 @@ export class UiAutomator2Server {
   }
 
   private async cleanupAutomationLeftovers(strictCleanup: boolean = false): Promise<void> {
-    this.log.debug(
-      `Performing ${strictCleanup ? 'strict' : 'shallow'} cleanup of automation leftovers`,
-    );
+    this.log.debug(`Performing ${strictCleanup ? 'strict' : 'shallow'} cleanup of automation leftovers`);
 
     const serverBase = `http://${this.host}:${this.systemPort}`;
     try {
@@ -459,9 +428,7 @@ export class UiAutomator2Server {
       const activeSessionIds = value.map(({id}) => id).filter(Boolean);
       if (activeSessionIds.length) {
         this.log.debug(`The following obsolete sessions are still running: ${activeSessionIds}`);
-        this.log.debug(
-          `Cleaning up ${util.pluralize('obsolete session', activeSessionIds.length, true)}`,
-        );
+        this.log.debug(`Cleaning up ${util.pluralize('obsolete session', activeSessionIds.length, true)}`);
         await Promise.all(
           activeSessionIds.map((id: string) =>
             axios.delete(`${serverBase}/session/${id}`, {
@@ -479,10 +446,7 @@ export class UiAutomator2Server {
     }
 
     try {
-      await Promise.all([
-        this.adb.forceStop(SERVER_PACKAGE_ID),
-        this.adb.forceStop(SERVER_TEST_PACKAGE_ID),
-      ]);
+      await Promise.all([this.adb.forceStop(SERVER_PACKAGE_ID), this.adb.forceStop(SERVER_TEST_PACKAGE_ID)]);
     } catch {}
     if (strictCleanup) {
       // https://github.com/appium/appium/issues/10749

package/lib/uiautomator2-server/session.ts

@@ -1,11 +1,13 @@
+import os from 'node:os';
+import path from 'node:path';
+
 import type {Orientation, StringRecord} from '@appium/types';
-import {SETTINGS_HELPER_ID} from 'io.appium.settings';
 import {util} from 'appium/support.js';
 import {retryInterval} from 'asyncbox';
-import os from 'node:os';
-import path from 'node:path';
+import {SETTINGS_HELPER_ID} from 'io.appium.settings';
 import {checkPortStatus, findAPortNotInUse} from 'portscanner';
 import type {ExecError} from 'teen_process';
+
 import type {AndroidUiautomator2Driver} from '../driver.js';
 import type {
   EmptyObject,
@@ -23,10 +25,10 @@ const DEVICE_PORT_RANGE = [8200, 8299];
 
 // The guard is needed to avoid dynamic system port allocation conflicts for
 // parallel driver sessions
-const DEVICE_PORT_ALLOCATION_GUARD = util.getLockFileGuard(
-  path.resolve(os.tmpdir(), 'uia2_device_port_guard'),
-  {timeout: 25, tryRecovery: true},
-);
+const DEVICE_PORT_ALLOCATION_GUARD = util.getLockFileGuard(path.resolve(os.tmpdir(), 'uia2_device_port_guard'), {
+  timeout: 25,
+  tryRecovery: true,
+});
 
 // This is the port that UiAutomator2 listens to on the device. We will forward
 // one of the ports above on the system to this port on the device.
@@ -112,9 +114,7 @@ export async function releaseMjpegServerPort(this: AndroidUiautomator2Driver) {
 }
 
 /** Runs device preparation steps before the UiAutomator2 server session starts. */
-export async function performPreExecSetup(
-  this: AndroidUiautomator2Driver,
-): Promise<StringRecord | undefined> {
+export async function performPreExecSetup(this: AndroidUiautomator2Driver): Promise<StringRecord | undefined> {
   const apiLevel = await this.adb.getApiLevel();
   if (apiLevel < MIN_SUPPORTED_API_LEVEL) {
     throw this.log.errorWithException('UIAutomator2 only supports Android 8.0 (Oreo) and above');
@@ -144,9 +144,7 @@ export async function performPreExecSetup(
   if (util.hasValue(this.opts.gpsEnabled)) {
     preflightPromises.push(
       (async () => {
-        this.log.info(
-          `Trying to ${this.opts.gpsEnabled ? 'enable' : 'disable'} gps location provider`,
-        );
+        this.log.info(`Trying to ${this.opts.gpsEnabled ? 'enable' : 'disable'} gps location provider`);
         await this.adb.toggleGPSLocationProvider(Boolean(this.opts.gpsEnabled));
       })(),
     );
@@ -327,17 +325,10 @@ export async function initServer(this: AndroidUiautomator2Driver) {
   } else {
     await this.uiautomator2.installServerApk(this.opts.uiautomator2ServerInstallTimeout);
     try {
-      await this.requireAdb().addToDeviceIdleWhitelist(
-        SETTINGS_HELPER_ID,
-        SERVER_PACKAGE_ID,
-        SERVER_TEST_PACKAGE_ID,
-      );
+      await this.requireAdb().addToDeviceIdleWhitelist(SETTINGS_HELPER_ID, SERVER_PACKAGE_ID, SERVER_TEST_PACKAGE_ID);
     } catch (e) {
       const err = e as ExecError;
-      this.log.warn(
-        `Cannot add server packages to the Doze whitelist. Original error: ` +
-          (err.stderr || err.message),
-      );
+      this.log.warn(`Cannot add server packages to the Doze whitelist. Original error: ` + (err.stderr || err.message));
     }
   }
 

package/lib/utils/app.ts

@@ -1,4 +1,5 @@
 import path from 'node:path';
+
 import type {ADB} from 'appium-adb';
 import {fs, system} from 'appium/support.js';
 

package/lib/utils/mjpeg.ts

@@ -1,10 +1,4 @@
-import {
-  Transform,
-  Writable,
-  type Readable,
-  type TransformCallback,
-  type WritableOptions,
-} from 'node:stream';
+import {Transform, Writable, type Readable, type TransformCallback, type WritableOptions} from 'node:stream';
 
 import {logger} from 'appium/support.js';
 import axios from 'axios';
@@ -144,11 +138,7 @@ export class MJpegStream extends Writable {
    * @param errorHandler - additional function that will be called in the case of any errors
    * @param options - Options to pass to the Writable constructor
    */
-  constructor(
-    mJpegUrl: string,
-    errorHandler: (err: Error) => void = noop,
-    options: WritableOptions = {},
-  ) {
+  constructor(mJpegUrl: string, errorHandler: (err: Error) => void = noop, options: WritableOptions = {}) {
     super(options);
     this.errorHandler = errorHandler;
     this.url = mJpegUrl;
@@ -216,12 +206,9 @@ export class MJpegStream extends Writable {
         } else {
           message = String(e);
         }
-        throw new Error(
-          `Cannot connect to the MJPEG stream at ${url}. Original error: ${message}`,
-          {
-            cause: e,
-          },
-        );
+        throw new Error(`Cannot connect to the MJPEG stream at ${url}. Original error: ${message}`, {
+          cause: e,
+        });
       }
     } finally {
       clearTimeout(connectTimeoutId);
@@ -238,9 +225,7 @@ export class MJpegStream extends Writable {
       this.lastChunk = null;
       // No-op if start() has already resolved; only rejects a still-pending start().
       this.registerStartFailure?.(
-        new Error(
-          `The connection to the MJPEG stream at ${url} has been closed before any frame was received`,
-        ),
+        new Error(`The connection to the MJPEG stream at ${url} has been closed before any frame was received`),
       );
     };
 
@@ -249,8 +234,7 @@ export class MJpegStream extends Writable {
       this.registerStartSuccess = resolve;
       this.registerStartFailure = reject;
       timeoutId = setTimeout(
-        () =>
-          reject(new Error(`Waited ${serverTimeout}ms but the MJPEG server never sent any images`)),
+        () => reject(new Error(`Waited ${serverTimeout}ms but the MJPEG server never sent any images`)),
         serverTimeout,
       );
     });
@@ -286,11 +270,7 @@ export class MJpegStream extends Writable {
   }
 
   /* eslint-disable promise/prefer-await-to-callbacks -- Writable._write is callback-based */
-  override _write(
-    chunk: Buffer | string,
-    _encoding: BufferEncoding,
-    callback: (error?: Error | null) => void,
-  ): void {
+  override _write(chunk: Buffer | string, _encoding: BufferEncoding, callback: (error?: Error | null) => void): void {
     this.lastChunk = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);
     this.updateCount++;
     if (this.registerStartSuccess) {

package/lib/utils/object.ts

@@ -2,10 +2,7 @@
  * Assigns own enumerable properties of `source` onto `target` only where `target[key] === undefined`
  * (lodash `defaults` semantics).
  */
-export function assignDefaults<T extends Record<string, unknown>>(
-  target: T,
-  source: Record<string, unknown>,
-): void {
+export function assignDefaults<T extends Record<string, unknown>>(target: T, source: Record<string, unknown>): void {
   for (const key of Object.keys(source)) {
     if (target[key] === undefined) {
       (target as Record<string, unknown>)[key] = source[key];