appium-android-driver 13.3.4 → 14.0.0

package/lib/commands/geolocation.ts

@@ -2,9 +2,9 @@ import {asyncmap} from 'asyncbox';
 import {fs, tempDir} from '@appium/support';
 import path from 'node:path';
 import type {Location} from '@appium/types';
+import {getThirdPartyPackages} from './app-management.js';
+import type {AndroidDriver} from '../driver.js';
 import {SETTINGS_HELPER_ID} from 'io.appium.settings';
-import {getThirdPartyPackages} from './app-management';
-import type {AndroidDriver} from '../driver';
 
 // The value close to zero, but not zero, is needed
 // to trick JSON generation and send a float value instead of an integer,

package/lib/commands/gestures.ts

@@ -1,7 +1,6 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import {errors} from 'appium/driver';
+import {errors} from 'appium/driver.js';
 import type {StringRecord} from '@appium/types';
-import type {AndroidDriver} from '../driver';
+import type {AndroidDriver} from '../driver.js';
 
 /**
  * Performs a series of actions (gestures) on the device.
@@ -11,5 +10,6 @@ import type {AndroidDriver} from '../driver';
  * @throws {errors.NotImplementedError} This method is not implemented.
  */
 export async function performActions(this: AndroidDriver, actions: StringRecord[]): Promise<void> {
+  void actions;
   throw new errors.NotImplementedError('Not implemented');
 }

package/lib/commands/image-injection.ts

@@ -1,8 +1,8 @@
-import {errors} from 'appium/driver';
+import {errors} from 'appium/driver.js';
 import path from 'node:path';
 import {fs, tempDir} from '@appium/support';
 import crypto from 'node:crypto';
-import type {AndroidDriver} from '../driver';
+import type {AndroidDriver} from '../driver.js';
 
 const EMULATOR_RESOURCES_ROOT = ['emulator', 'resources'];
 const CONFIG_NAME = 'Toren1BD.posters';

package/lib/commands/ime.ts

@@ -1,6 +1,6 @@
-import {errors} from 'appium/driver';
-import type {AndroidDriver} from '../driver';
-import {SET_STYLUS_HANDWRITING_FEATURE} from '../utils';
+import {errors} from 'appium/driver.js';
+import type {AndroidDriver} from '../driver.js';
+import {SET_STYLUS_HANDWRITING_FEATURE} from '../utils.js';
 
 /**
  * Checks if an IME (Input Method Editor) is activated.

package/lib/commands/intent.ts

@@ -1,7 +1,7 @@
-import {errors} from 'appium/driver';
+import {errors} from 'appium/driver.js';
 import {util} from '@appium/support';
-import type {AndroidDriver} from '../driver';
-import type {IntentOpts} from './types';
+import type {AndroidDriver} from '../driver.js';
+import type {IntentOpts} from './types.js';
 
 const NO_VALUE_ARG_TYPE = 'sn';
 const SUPPORTED_EXTRA_TYPES = [

package/lib/commands/keyboard.ts

@@ -1,7 +1,7 @@
-import {errors} from 'appium/driver';
+import {errors} from 'appium/driver.js';
 import {UNICODE_IME, EMPTY_IME} from 'io.appium.settings';
-import type {AndroidDriver} from '../driver';
-import type {SendKeysOpts} from './types';
+import type {AndroidDriver} from '../driver.js';
+import type {SendKeysOpts} from './types.js';
 
 /**
  * Hides the on-screen keyboard.

package/lib/commands/legacy.ts

@@ -1,5 +1,5 @@
-import {errors} from 'appium/driver';
-import type {AndroidDriver} from '../driver';
+import {errors} from 'appium/driver.js';
+import type {AndroidDriver} from '../driver.js';
 
 const ISSUE_URL = 'https://github.com/appium/appium/issues/15807';
 

package/lib/commands/lock/exports.ts

@@ -14,9 +14,9 @@ import {
   fingerprintUnlock,
   toCredentialType,
   verifyUnlock,
-} from './helpers';
-import type {AndroidDriver, AndroidDriverCaps} from '../../driver';
-import type {UnlockType} from '../types';
+} from './helpers.js';
+import type {AndroidDriver, AndroidDriverCaps} from '../../driver.js';
+import type {UnlockType} from '../types.js';
 
 /**
  * Locks the device and optionally unlocks it after a specified number of seconds.

package/lib/commands/lock/helpers.ts

@@ -2,8 +2,8 @@ import {util} from '@appium/support';
 import {sleep, waitForCondition} from 'asyncbox';
 import type {ADB} from 'appium-adb';
 import type {Position, StringRecord} from '@appium/types';
-import type {AndroidDriver, AndroidDriverCaps} from '../../driver';
-import type {UnlockType, FastUnlockOptions} from '../types';
+import type {AndroidDriver, AndroidDriverCaps} from '../../driver.js';
+import type {UnlockType, FastUnlockOptions} from '../types.js';
 
 export const PIN_UNLOCK = 'pin';
 export const PIN_UNLOCK_KEY_EVENT = 'pinWithKeyEvent';

package/lib/commands/log.ts

@@ -1,6 +1,6 @@
-import {DEFAULT_WS_PATHNAME_PREFIX, BaseDriver} from 'appium/driver';
+import {DEFAULT_WS_PATHNAME_PREFIX, BaseDriver} from 'appium/driver.js';
 import os from 'node:os';
-import WebSocket from 'ws';
+import {WebSocket, WebSocketServer} from 'ws';
 import type {AppiumServer, WSServer} from '@appium/types';
 import type {EventEmitter} from 'node:events';
 import type {ADB} from 'appium-adb';
@@ -10,11 +10,11 @@ import {
   toLogRecord,
   nativeLogEntryToSeleniumEntry,
   type LogEntry,
-} from '../utils';
-import {NATIVE_WIN} from './context/helpers';
-import {BIDI_EVENT_NAME} from './bidi/constants';
-import {makeLogEntryAddedEvent} from './bidi/models';
-import type {AndroidDriver} from '../driver';
+} from '../utils.js';
+import {NATIVE_WIN} from './context/helpers.js';
+import {BIDI_EVENT_NAME} from './bidi/constants.js';
+import {makeLogEntryAddedEvent} from './bidi/models.js';
+import type {AndroidDriver} from '../driver.js';
 import {util} from '@appium/support';
 
 export const supportedLogTypes = {
@@ -62,9 +62,12 @@ export async function mobileStartLogsBroadcast(this: AndroidDriver): Promise<voi
       `${JSON.stringify(server.address())} to ${pathname}`,
   );
   // https://github.com/websockets/ws/blob/master/doc/ws.md
-  const wss = new WebSocket.Server({
+  const wss = new WebSocketServer({
     noServer: true,
   });
+  // Tracks every currently connected listener socket so log lines get
+  // broadcast to all of them, not just the one that connected first.
+  const connectedSockets = new Set<WebSocket>();
   wss.on('connection', (ws, req) => {
     if (req) {
       const remoteIp = util.isEmpty(req.headers['x-forwarded-for'])
@@ -75,17 +78,21 @@ export async function mobileStartLogsBroadcast(this: AndroidDriver): Promise<voi
       this.log.debug('Established a new logcat listener web socket connection');
     }
 
+    connectedSockets.add(ws);
     if (!this._logcatWebsocketListener) {
       this._logcatWebsocketListener = (logRecord: LogEntry) => {
-        if (ws?.readyState === WebSocket.OPEN) {
-          ws.send(logRecord.message);
+        for (const socket of connectedSockets) {
+          if (socket.readyState === WebSocket.OPEN) {
+            socket.send(logRecord.message);
+          }
         }
       };
     }
     this.adb.setLogcatListener(this._logcatWebsocketListener);
 
     ws.on('close', (code, reason) => {
-      if (this._logcatWebsocketListener) {
+      connectedSockets.delete(ws);
+      if (connectedSockets.size === 0 && this._logcatWebsocketListener) {
         try {
           this.adb.removeLogcatListener(this._logcatWebsocketListener);
         } catch {}

package/lib/commands/media-projection.ts

@@ -3,9 +3,9 @@ import type {NetOptions, HttpUploadOptions} from '@appium/support';
 import dayjs from 'dayjs';
 import path from 'node:path';
 import type {HTTPMethod, StringRecord} from '@appium/types';
-import type {AndroidDriver} from '../driver';
+import type {AndroidDriver} from '../driver.js';
 import type {ADB} from 'appium-adb';
-import type {FormFields} from './types';
+import type {FormFields} from './types.js';
 
 // https://github.com/appium/io.appium.settings#internal-audio--video-recording
 const DEFAULT_EXT = '.mp4';

package/lib/commands/memory.ts

@@ -1,6 +1,6 @@
-import {errors} from 'appium/driver';
-import type {AndroidDriver} from '../driver';
-import type {TrimMemoryLevel} from './types';
+import {errors} from 'appium/driver.js';
+import type {AndroidDriver} from '../driver.js';
+import type {TrimMemoryLevel} from './types.js';
 
 /**
  * Simulates the onTrimMemory() event for the given package.

package/lib/commands/misc.ts

@@ -1,7 +1,7 @@
-import {errors} from 'appium/driver';
+import {errors} from 'appium/driver.js';
 import type {Size, Rect, StringRecord} from '@appium/types';
-import type {AndroidDriver} from '../driver';
-import type {SmsListResult, ListSmsOpts} from './types';
+import type {AndroidDriver} from '../driver.js';
+import type {SmsListResult, ListSmsOpts} from './types.js';
 
 /**
  * Gets the window size.

package/lib/commands/network.ts

@@ -1,7 +1,7 @@
-import {errors} from 'appium/driver';
+import {errors} from 'appium/driver.js';
 import {util} from '@appium/support';
-import type {AndroidDriver} from '../driver';
-import type {ServiceType, GetConnectivityResult} from './types';
+import type {AndroidDriver} from '../driver.js';
+import type {ServiceType, GetConnectivityResult} from './types.js';
 
 const AIRPLANE_MODE_MASK = 0b001;
 const WIFI_MASK = 0b010;

package/lib/commands/nfc.ts

@@ -1,6 +1,6 @@
-import {errors} from 'appium/driver';
-import type {AndroidDriver} from '../driver';
-import type {NfcAction} from './types';
+import {errors} from 'appium/driver.js';
+import type {AndroidDriver} from '../driver.js';
+import type {NfcAction} from './types.js';
 
 const SUPPORTED_ACTIONS = {
   ENABLE: 'enable',

package/lib/commands/performance.ts

@@ -1,7 +1,7 @@
 import {retryInterval} from 'asyncbox';
 import type {ExecError} from 'teen_process';
-import type {AndroidDriver} from '../driver';
-import type {PerformanceDataType} from './types';
+import type {AndroidDriver} from '../driver.js';
+import type {PerformanceDataType} from './types.js';
 import {util} from '@appium/support';
 
 export const NETWORK_KEYS = [
@@ -187,7 +187,7 @@ export async function getMemoryInfo(
       }
     }
     if (valDict.totalPrivateDirty && valDict.totalPrivateDirty !== 'nodex') {
-      const headers = structuredClone(MEMORY_KEYS);
+      const headers = [...MEMORY_KEYS];
       const values = headers.map((header) => valDict[header]);
       return [headers, values];
     }
@@ -458,7 +458,7 @@ export async function getBatteryInfo(this: AndroidDriver, retries: number = 2):
     const power = parseInt((data.split(':')[1] || '').trim(), 10);
 
     if (!Number.isNaN(power)) {
-      return [structuredClone(BATTERY_KEYS), [power.toString()]];
+      return [[...BATTERY_KEYS], [power.toString()]];
     } else {
       throw new Error(`Unable to parse battery data: '${data}'`);
     }

package/lib/commands/permissions.ts

@@ -1,6 +1,6 @@
-import {errors} from 'appium/driver';
-import {ADB_SHELL_FEATURE} from '../utils';
-import type {AndroidDriver} from '../driver';
+import {errors} from 'appium/driver.js';
+import {ADB_SHELL_FEATURE} from '../utils.js';
+import type {AndroidDriver} from '../driver.js';
 import {util} from '@appium/support';
 
 const ALL_PERMISSIONS_MAGIC = 'all';

package/lib/commands/recordscreen.ts

@@ -3,13 +3,13 @@ import type {NetOptions, HttpUploadOptions} from '@appium/support';
 import {waitForCondition} from 'asyncbox';
 import path from 'node:path';
 import {exec} from 'teen_process';
-import type {AndroidDriver} from '../driver';
+import type {AndroidDriver} from '../driver.js';
 import type {ADB} from 'appium-adb';
 import type {
   StartScreenRecordingOpts,
   StopScreenRecordingOpts,
   ScreenRecordingProperties,
-} from './types';
+} from './types.js';
 
 const RETRY_PAUSE = 300;
 const RETRY_TIMEOUT = 5000;
@@ -65,7 +65,7 @@ export async function startRecordingScreen(
   if (this._screenRecordingProperties) {
     // XXX: this doesn't need to be done in serial, does it?
     const props = this._screenRecordingProperties;
-    for (const record of props.records || []) {
+    for (const record of props?.records || []) {
       await this.adb.rimraf(record);
     }
     this._screenRecordingProperties = undefined;
@@ -136,7 +136,7 @@ export async function stopRecordingScreen(
     return '';
   }
 
-  if (props.recordingProcess?.isRunning) {
+  if (props?.recordingProcess?.isRunning) {
     try {
       await props.recordingProcess.stop('SIGINT', PROCESS_SHUTDOWN_TIMEOUT);
     } catch {
@@ -157,7 +157,7 @@ export async function stopRecordingScreen(
   const tmpRoot = await tempDir.openDir();
   try {
     const localRecords: string[] = [];
-    for (const pathOnDevice of props.records) {
+    for (const pathOnDevice of props?.records || []) {
       const relativePath = path.resolve(tmpRoot, path.posix.basename(pathOnDevice));
       localRecords.push(relativePath);
       await this.adb.pull(pathOnDevice, relativePath, {timeout: ADB_PULL_TIMEOUT});

package/lib/commands/resources.ts

@@ -1,7 +1,7 @@
 import {fs, tempDir, util} from '@appium/support';
 import type {StringRecord} from '@appium/types';
-import type {AndroidDriver, AndroidDriverOpts} from '../driver';
-import type {Locale} from './types';
+import type {AndroidDriver, AndroidDriverOpts} from '../driver.js';
+import type {Locale} from './types.js';
 
 /**
  * Gets the localized strings from the application.

package/lib/commands/shell.ts

@@ -1,9 +1,9 @@
 import {util} from '@appium/support';
-import {errors} from 'appium/driver';
+import {errors} from 'appium/driver.js';
 import {exec} from 'teen_process';
 import type {ExecError} from 'teen_process';
-import {ADB_SHELL_FEATURE} from '../utils';
-import type {AndroidDriver} from '../driver';
+import {ADB_SHELL_FEATURE} from '../utils.js';
+import type {AndroidDriver} from '../driver.js';
 
 /**
  * Executes a shell command on the device via ADB.

package/lib/commands/streamscreen.ts

@@ -6,10 +6,10 @@ import net from 'node:net';
 import url from 'node:url';
 import {checkPortStatus} from 'portscanner';
 import {SubProcess, exec} from 'teen_process';
-import type {AndroidDriver} from '../driver';
+import type {AndroidDriver} from '../driver.js';
 import type {ADB} from 'appium-adb';
 import type {AppiumLogger} from '@appium/types';
-import type {DeviceInfo, InitGStreamerPipelineOpts} from './types';
+import type {DeviceInfo, InitGStreamerPipelineOpts} from './types.js';
 
 const RECORDING_INTERVAL_SEC = 5;
 const STREAMING_STARTUP_TIMEOUT_MS = 5000;
@@ -225,11 +225,13 @@ export async function mobileStartScreenStreaming(
     }
   }
 
+  // Both are guaranteed to be set at this point, since mjpegServerReadyPromise
+  // only resolves after the MJPEG server has started listening.
   this._screenStreamingProps = {
     deviceStreamingProc,
     gstreamerPipeline,
-    mjpegSocket,
-    mjpegServer,
+    mjpegSocket: mjpegSocket as net.Socket,
+    mjpegServer: mjpegServer as http.Server,
   };
 }
 

package/lib/commands/system-bars.ts

@@ -1,7 +1,7 @@
-import {errors} from 'appium/driver';
+import {errors} from 'appium/driver.js';
 import type {StringRecord} from '@appium/types';
-import type {AndroidDriver} from '../driver';
-import type {StatusBarCommand, WindowProperties} from './types';
+import type {AndroidDriver} from '../driver.js';
+import type {StatusBarCommand, WindowProperties} from './types.js';
 import {util} from '@appium/support';
 
 const WINDOW_TITLE_PATTERN = /^\s+Window\s#\d+\sWindow\{[0-9a-f]+\s\w+\s([\w-]+)\}:$/;
@@ -142,14 +142,14 @@ export function parseWindowProperties(
 export function parseWindows(this: AndroidDriver, lines: string): SystemBarsResult {
   const windows: StringRecord<string[]> = {};
   let currentWindowName: string | null = null;
-  for (const line of lines.split('\n').map((line) => String(line)?.trimEnd())) {
-    const match = WINDOW_TITLE_PATTERN.exec(line as any);
+  for (const line of lines.split('\n').map((line) => line.trimEnd())) {
+    const match = WINDOW_TITLE_PATTERN.exec(line);
     if (match) {
       currentWindowName = match[1];
       windows[currentWindowName] = [];
       continue;
     }
-    if (String(line)?.trim()?.length === 0) {
+    if (line.trim().length === 0) {
       currentWindowName = null;
       continue;
     }

package/lib/commands/time.ts

@@ -1,7 +1,7 @@
 import dayjs from 'dayjs';
-import utc from 'dayjs/plugin/utc';
-import customParseFormat from 'dayjs/plugin/customParseFormat';
-import type {AndroidDriver} from '../driver';
+import utc from 'dayjs/plugin/utc.js';
+import customParseFormat from 'dayjs/plugin/customParseFormat.js';
+import type {AndroidDriver} from '../driver.js';
 
 dayjs.extend(utc);
 dayjs.extend(customParseFormat);

package/lib/commands/types.ts

@@ -1,7 +1,10 @@
 import type {HTTPMethod, StringRecord} from '@appium/types';
-import type {AndroidDriverCaps} from '../driver';
+import type {AndroidDriverCaps} from '../driver.js';
 import type {SubProcess} from 'teen_process';
 import type {timing} from '@appium/support';
+import type {ChildProcess} from 'node:child_process';
+import type {Socket} from 'node:net';
+import type {Server} from 'node:http';
 
 /**
  * @privateRemarks probably better defined in `appium-adb`
@@ -451,6 +454,17 @@ export interface InitGStreamerPipelineOpts {
   considerRotation?: boolean;
   logPipelineDetails?: boolean;
 }
+
+/**
+ * The screen streaming process handles cached on the driver instance
+ * while a `mobile: startScreenStreaming` session is active.
+ */
+export interface ScreenStreamingProps {
+  deviceStreamingProc: ChildProcess;
+  gstreamerPipeline: SubProcess;
+  mjpegSocket: Socket;
+  mjpegServer: Server;
+}
 export interface WindowProperties {
   /**
    * Whether the window is visible

package/lib/constraints.ts

@@ -212,6 +212,9 @@ export const ANDROID_DRIVER_CONSTRAINTS = {
   skipDeviceInitialization: {
     isBoolean: true,
   },
+  skipSettingsAppReinstall: {
+    isBoolean: true,
+  },
   remoteAppsCacheLimit: {
     isNumber: true,
   },

package/lib/doctor/checks.ts

@@ -1,4 +1,4 @@
-import {resolveExecutablePath} from './utils';
+import {resolveExecutablePath} from './utils.js';
 import {system, fs, doctor, console} from '@appium/support';
 import path from 'node:path';
 import {getAndroidBinaryPath, getSdkRootFromEnv} from 'appium-adb';