appium-android-driver 7.8.3 → 8.0.1

package/lib/driver.ts

@@ -11,17 +11,205 @@ import type {
 } from '@appium/types';
 import _ from 'lodash';
 import ADB from 'appium-adb';
+import type {LogcatListener} from 'appium-adb';
 import type {default as AppiumChromedriver} from 'appium-chromedriver';
 import {BaseDriver} from 'appium/driver';
 import ANDROID_DRIVER_CONSTRAINTS, {AndroidDriverConstraints} from './constraints';
-import {helpers} from './helpers';
 import {newMethodMap} from './method-map';
-import { SettingsApp } from 'io.appium.settings';
+import {SettingsApp} from 'io.appium.settings';
+import {parseArray, removeAllSessionWebSocketHandlers} from './utils';
+import {CHROME_BROWSER_PACKAGE_ACTIVITY} from './commands/context/helpers';
+import {
+  getContexts,
+  setContext,
+  getCurrentContext,
+  defaultContextName,
+  assignContexts,
+  switchContext,
+  defaultWebviewName,
+  isWebContext,
+  isChromedriverContext,
+  startChromedriverProxy,
+  onChromedriverStop,
+  stopChromedriverProxies,
+  suspendChromedriverProxy,
+  startChromeSession,
+  mobileGetContexts,
+} from './commands/context/exports';
+import {
+  getDeviceInfoFromCaps,
+  createADB,
+  getLaunchInfo,
+  initDevice,
+} from './commands/device/common';
+import {
+  fingerprint,
+  mobileFingerprint,
+  sendSMS,
+  mobileSendSms,
+  gsmCall,
+  mobileGsmCall,
+  gsmSignal,
+  mobileGsmSignal,
+  gsmVoice,
+  mobileGsmVoice,
+  powerAC,
+  mobilePowerAc,
+  powerCapacity,
+  mobilePowerCapacity,
+  networkSpeed,
+  mobileNetworkSpeed,
+  sensorSet,
+} from './commands/device/emulator-actions';
+import {mobileExecEmuConsoleCommand} from './commands/device/emulator-console';
+import {
+  getThirdPartyPackages,
+  uninstallOtherPackages,
+  installOtherApks,
+  installApk,
+  resetApp,
+  background,
+  getCurrentActivity,
+  getCurrentPackage,
+  mobileClearApp,
+  mobileInstallApp,
+  installApp,
+  mobileActivateApp,
+  mobileIsAppInstalled,
+  mobileQueryAppState,
+  mobileRemoveApp,
+  mobileTerminateApp,
+  terminateApp,
+  removeApp,
+  activateApp,
+  queryAppState,
+  isAppInstalled,
+} from './commands/app-management';
+import {mobileGetUiMode, mobileSetUiMode} from './commands/appearance';
+import {mobileDeviceidle} from './commands/deviceidle';
+import {
+  getAttribute,
+  getName,
+  elementDisplayed,
+  elementEnabled,
+  elementSelected,
+  setElementValue,
+  doSetElementValue,
+  replaceValue,
+  setValueImmediate,
+  click,
+  getLocationInView,
+  getText,
+  getLocation,
+  getSize,
+} from './commands/element';
+import {execute, executeMobile} from './commands/execute';
+import {
+  pullFile,
+  mobilePullFile,
+  pullFolder,
+  mobilePullFolder,
+  pushFile,
+  mobilePushFile,
+  mobileDeleteFile,
+} from './commands/file-actions';
+import {findElOrEls, doFindElementOrEls} from './commands/find';
+import {
+  setGeoLocation,
+  getGeoLocation,
+  mobileRefreshGpsCache,
+  toggleLocationServices,
+  isLocationServicesEnabled,
+} from './commands/geolocation';
+import {
+  isIMEActivated,
+  availableIMEEngines,
+  getActiveIMEEngine,
+  activateIMEEngine,
+  deactivateIMEEngine,
+} from './commands/ime';
+import {
+  startActivity,
+  mobileBroadcast,
+  mobileStartService,
+  mobileStopService,
+} from './commands/intent';
+import {
+  hideKeyboard,
+  isKeyboardShown,
+  keys,
+  doSendKeys,
+  pressKeyCode,
+  longPressKeyCode,
+  mobilePerformEditorAction,
+} from './commands/keyboard';
+import {lock, unlock, mobileLock, mobileUnlock, isLocked} from './commands/lock/exports';
+import {
+  supportedLogTypes,
+  mobileStartLogsBroadcast,
+  mobileStopLogsBroadcast,
+  getLogTypes,
+  getLog,
+} from './commands/log';
+import {
+  mobileIsMediaProjectionRecordingRunning,
+  mobileStartMediaProjectionRecording,
+  mobileStopMediaProjectionRecording,
+} from './commands/media-projection';
+import {mobileSendTrimMemory} from './commands/memory';
+import {
+  getWindowRect,
+  getWindowSize,
+  getDisplayDensity,
+  mobileGetNotifications,
+  mobileListSms,
+  openNotifications,
+  setUrl,
+} from './commands/misc';
+import {
+  getNetworkConnection,
+  isWifiOn,
+  mobileGetConnectivity,
+  mobileSetConnectivity,
+  setNetworkConnection,
+  setWifiState,
+  setDataState,
+  toggleData,
+  toggleFlightMode,
+  toggleWiFi,
+} from './commands/network';
+import {
+  getPerformanceData,
+  getPerformanceDataTypes,
+  mobileGetPerformanceData,
+} from './commands/performance';
+import {mobileChangePermissions, mobileGetPermissions} from './commands/permissions';
+import {startRecordingScreen, stopRecordingScreen} from './commands/recordscreen';
+import {getStrings, ensureDeviceLocale} from './commands/resources';
+import {mobileShell} from './commands/shell';
+import {mobileStartScreenStreaming, mobileStopScreenStreaming} from './commands/streamscreen';
+import {getSystemBars, mobilePerformStatusBarCommand} from './commands/system-bars';
+import {getDeviceTime, mobileGetDeviceTime} from './commands/time';
+import {
+  tap,
+  touchLongClick,
+  touchDown,
+  touchUp,
+  touchMove,
+  doSwipe,
+  doTouchDrag,
+  doTouchAction,
+  performMultiAction,
+  performTouch,
+  doPerformMultiAction,
+} from './commands/touch';
 
 export type AndroidDriverCaps = DriverCaps<AndroidDriverConstraints>;
 export type W3CAndroidDriverCaps = W3CDriverCaps<AndroidDriverConstraints>;
 export type AndroidDriverOpts = DriverOpts<AndroidDriverConstraints>;
 
+const EMULATOR_PATTERN = /\bemulator\b/i;
+
 type AndroidExternalDriver = ExternalDriver<AndroidDriverConstraints>;
 class AndroidDriver
   extends BaseDriver<AndroidDriverConstraints, StringRecord>
@@ -34,9 +222,7 @@ class AndroidDriver
 
   _settingsApp: SettingsApp;
 
-  unlocker: typeof helpers.unlocker;
-
-  apkStrings: StringRecord<StringRecord<string>>;
+  apkStrings: StringRecord;
 
   proxyReqRes?: (...args: any) => any;
 
@@ -56,6 +242,14 @@ class AndroidDriver
 
   _wasWindowAnimationDisabled?: boolean;
 
+  _cachedActivityArgs: StringRecord;
+
+  _screenStreamingProps?: StringRecord;
+
+  _screenRecordingProperties?: StringRecord;
+
+  _logcatWebsocketListener?: LogcatListener;
+
   opts: AndroidDriverOpts;
 
   constructor(opts: InitialOpts = {} as InitialOpts, shouldValidateCaps = true) {
@@ -72,27 +266,275 @@ class AndroidDriver
     this.sessionChromedrivers = {};
     this.jwpProxyActive = false;
     this.apkStrings = {};
-    this.unlocker = helpers.unlocker;
 
     this.curContext = this.defaultContextName();
     this.opts = opts as AndroidDriverOpts;
+    this._cachedActivityArgs = {};
   }
 
-  get settingsApp() {
+  get settingsApp(): SettingsApp {
     if (!this._settingsApp) {
       this._settingsApp = new SettingsApp({adb: this.adb});
     }
     return this._settingsApp;
   }
 
-  isEmulator() {
-    return helpers.isEmulator(this.adb, this.opts);
+  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.errorAndThrow(
+          `The desired should not include both of an 'appPackage' and a 'browserName'`,
+        );
+      }
+    }
+
+    if (caps.uninstallOtherPackages) {
+      try {
+        parseArray(caps.uninstallOtherPackages);
+      } catch (e) {
+        throw this.log.errorAndThrow(
+          `Could not parse "uninstallOtherPackages" capability: ${(e as Error).message}`,
+        );
+      }
+    }
+
+    return true;
   }
 
-  get isChromeSession() {
-    return helpers.isChromeBrowser(String(this.opts.browserName));
+  override async deleteSession(sessionId?: string | null) {
+    if (this.server) {
+      await removeAllSessionWebSocketHandlers(this.server, sessionId);
+    }
+
+    await super.deleteSession(sessionId);
   }
+
+  getContexts = getContexts;
+  getCurrentContext = getCurrentContext;
+  defaultContextName = defaultContextName;
+  assignContexts = assignContexts;
+  switchContext = switchContext;
+  defaultWebviewName = defaultWebviewName;
+  isChromedriverContext = isChromedriverContext;
+  startChromedriverProxy = startChromedriverProxy;
+  stopChromedriverProxies = stopChromedriverProxies;
+  suspendChromedriverProxy = suspendChromedriverProxy;
+  startChromeSession = startChromeSession;
+  onChromedriverStop = onChromedriverStop;
+  isWebContext = isWebContext;
+  mobileGetContexts = mobileGetContexts;
+  setContext = setContext as any as (this: AndroidDriver, name?: string) => Promise<void>;
+
+  getDeviceInfoFromCaps = getDeviceInfoFromCaps;
+  createADB = createADB;
+  getLaunchInfo = getLaunchInfo;
+  initDevice = initDevice;
+
+  fingerprint = fingerprint;
+  mobileFingerprint = mobileFingerprint;
+  sendSMS = sendSMS;
+  mobileSendSms = mobileSendSms;
+  gsmCall = gsmCall;
+  mobileGsmCall = mobileGsmCall;
+  gsmSignal = gsmSignal;
+  mobileGsmSignal = mobileGsmSignal;
+  gsmVoice = gsmVoice;
+  mobileGsmVoice = mobileGsmVoice;
+  powerAC = powerAC;
+  mobilePowerAc = mobilePowerAc;
+  powerCapacity = powerCapacity;
+  mobilePowerCapacity = mobilePowerCapacity;
+  networkSpeed = networkSpeed;
+  mobileNetworkSpeed = mobileNetworkSpeed;
+  sensorSet = sensorSet;
+
+  mobileExecEmuConsoleCommand = mobileExecEmuConsoleCommand;
+
+  getThirdPartyPackages = getThirdPartyPackages;
+  uninstallOtherPackages = uninstallOtherPackages;
+  installOtherApks = installOtherApks;
+  installApk = installApk;
+  resetApp = resetApp;
+  background = background;
+  getCurrentActivity = getCurrentActivity;
+  getCurrentPackage = getCurrentPackage;
+  mobileClearApp = mobileClearApp;
+  mobileInstallApp = mobileInstallApp;
+  installApp = installApp;
+  mobileActivateApp = mobileActivateApp;
+  mobileIsAppInstalled = mobileIsAppInstalled;
+  mobileQueryAppState = mobileQueryAppState;
+  mobileRemoveApp = mobileRemoveApp;
+  mobileTerminateApp = mobileTerminateApp;
+  terminateApp = terminateApp;
+  removeApp = removeApp;
+  activateApp = activateApp;
+  queryAppState = queryAppState;
+  isAppInstalled = isAppInstalled;
+
+  mobileGetUiMode = mobileGetUiMode;
+  mobileSetUiMode = mobileSetUiMode;
+
+  mobileDeviceidle = mobileDeviceidle;
+
+  getAttribute = getAttribute;
+  getName = getName;
+  elementDisplayed = elementDisplayed;
+  elementEnabled = elementEnabled;
+  elementSelected = elementSelected;
+  setElementValue = setElementValue;
+  doSetElementValue = doSetElementValue;
+  replaceValue = replaceValue;
+  setValueImmediate = setValueImmediate;
+  click = click;
+  getLocationInView = getLocationInView;
+  getText = getText;
+  getLocation = getLocation;
+  getSize = getSize;
+
+  execute = execute;
+  executeMobile = executeMobile;
+
+  pullFile = pullFile;
+  mobilePullFile = mobilePullFile;
+  pullFolder = pullFolder;
+  mobilePullFolder = mobilePullFolder;
+  pushFile = pushFile;
+  mobilePushFile = mobilePushFile;
+  mobileDeleteFile = mobileDeleteFile;
+
+  findElOrEls = findElOrEls;
+  doFindElementOrEls = doFindElementOrEls;
+
+  setGeoLocation = setGeoLocation;
+  getGeoLocation = getGeoLocation;
+  mobileRefreshGpsCache = mobileRefreshGpsCache;
+  toggleLocationServices = toggleLocationServices;
+  isLocationServicesEnabled = isLocationServicesEnabled;
+
+  isIMEActivated = isIMEActivated;
+  availableIMEEngines = availableIMEEngines;
+  getActiveIMEEngine = getActiveIMEEngine;
+  activateIMEEngine = activateIMEEngine;
+  deactivateIMEEngine = deactivateIMEEngine;
+
+  startActivity = startActivity as unknown as (
+    appPackage: string,
+    appActivity: string,
+    appWaitPackage?: string,
+    appWaitActivity?: string,
+    intentAction?: string,
+    intentCategory?: string,
+    intentFlags?: string,
+    optionalIntentArguments?: string,
+    dontStopAppOnReset?: boolean,
+  ) => Promise<void>;
+  mobileBroadcast = mobileBroadcast;
+  mobileStartService = mobileStartService;
+  mobileStopService = mobileStopService;
+
+  hideKeyboard = hideKeyboard;
+  isKeyboardShown = isKeyboardShown;
+  keys = keys;
+  doSendKeys = doSendKeys;
+  pressKeyCode = pressKeyCode;
+  longPressKeyCode = longPressKeyCode;
+  mobilePerformEditorAction = mobilePerformEditorAction;
+
+  lock = lock;
+  unlock = unlock;
+  mobileLock = mobileLock;
+  mobileUnlock = mobileUnlock;
+  isLocked = isLocked;
+
+  supportedLogTypes = supportedLogTypes;
+  mobileStartLogsBroadcast = mobileStartLogsBroadcast;
+  mobileStopLogsBroadcast = mobileStopLogsBroadcast;
+  getLogTypes = getLogTypes;
+  getLog = getLog;
+
+  mobileIsMediaProjectionRecordingRunning = mobileIsMediaProjectionRecordingRunning;
+  mobileStartMediaProjectionRecording = mobileStartMediaProjectionRecording;
+  mobileStopMediaProjectionRecording = mobileStopMediaProjectionRecording;
+
+  mobileSendTrimMemory = mobileSendTrimMemory;
+
+  getWindowRect = getWindowRect;
+  getWindowSize = getWindowSize;
+  getDisplayDensity = getDisplayDensity;
+  mobileGetNotifications = mobileGetNotifications;
+  mobileListSms = mobileListSms;
+  openNotifications = openNotifications;
+  setUrl = setUrl;
+
+  getNetworkConnection = getNetworkConnection;
+  isWifiOn = isWifiOn;
+  mobileGetConnectivity = mobileGetConnectivity;
+  mobileSetConnectivity = mobileSetConnectivity;
+  setNetworkConnection = setNetworkConnection;
+  setWifiState = setWifiState;
+  setDataState = setDataState;
+  toggleData = toggleData;
+  toggleFlightMode = toggleFlightMode;
+  toggleWiFi = toggleWiFi;
+
+  getPerformanceData = getPerformanceData;
+  getPerformanceDataTypes = getPerformanceDataTypes;
+  mobileGetPerformanceData = mobileGetPerformanceData;
+
+  mobileChangePermissions = mobileChangePermissions;
+  mobileGetPermissions = mobileGetPermissions;
+
+  startRecordingScreen = startRecordingScreen;
+  stopRecordingScreen = stopRecordingScreen;
+
+  getStrings = getStrings;
+  ensureDeviceLocale = ensureDeviceLocale;
+
+  mobileShell = mobileShell;
+
+  mobileStartScreenStreaming = mobileStartScreenStreaming;
+  mobileStopScreenStreaming = mobileStopScreenStreaming;
+
+  getSystemBars = getSystemBars;
+  mobilePerformStatusBarCommand = mobilePerformStatusBarCommand;
+
+  getDeviceTime = getDeviceTime;
+  mobileGetDeviceTime = mobileGetDeviceTime;
+
+  tap = tap;
+  touchLongClick = touchLongClick;
+  touchDown = touchDown;
+  touchUp = touchUp;
+  touchMove = touchMove;
+  doSwipe = doSwipe;
+  doTouchDrag = doTouchDrag;
+  doTouchAction = doTouchAction;
+  performMultiAction = performMultiAction;
+  performTouch = performTouch;
+  doPerformMultiAction = doPerformMultiAction;
 }
 
-export {commands as androidCommands} from './commands';
 export {AndroidDriver};

package/lib/index.ts

@@ -2,21 +2,9 @@ import {install} from 'source-map-support';
 install();
 
 import {AndroidDriver} from './driver';
-export type * from './commands';
+export type * from './commands/types';
 export {ANDROID_DRIVER_CONSTRAINTS as commonCapConstraints} from './constraints';
 export * from './driver';
 export * as doctor from './doctor/checks';
-export {
-  SETTINGS_HELPER_ID as SETTINGS_HELPER_PKG_ID,
-  default as androidHelpers
-} from './helpers/android';
-export type * from './helpers/types';
-export {
-  CHROMIUM_WIN,
-  NATIVE_WIN,
-  WEBVIEW_BASE,
-  WEBVIEW_WIN,
-  default as webviewHelpers,
-} from './helpers/webview';
 
 export default AndroidDriver;

package/lib/logger.js

@@ -1,4 +1,4 @@
-import { logger } from '@appium/support';
+import {logger} from '@appium/support';
 const log = logger.getLogger('AndroidDriver');
 
 export default log;

package/lib/method-map.js

@@ -37,14 +37,6 @@ export const newMethodMap = /** @type {const} */ ({
       payloadParams: {required: ['elements']},
     },
   },
-  '/session/:sessionId/touch/flick': {
-    POST: {
-      command: 'flick',
-      payloadParams: {
-        optional: ['element', 'xspeed', 'yspeed', 'xoffset', 'yoffset', 'speed'],
-      },
-    },
-  },
   '/session/:sessionId/touch/perform': {
     POST: {
       command: 'performTouch',
@@ -178,9 +170,6 @@ export const newMethodMap = /** @type {const} */ ({
   },
   '/session/:sessionId/appium/device/system_bars': {GET: {command: 'getSystemBars'}},
   '/session/:sessionId/appium/device/display_density': {GET: {command: 'getDisplayDensity'}},
-  '/session/:sessionId/appium/app/launch': {POST: {command: 'launchApp'}},
-  '/session/:sessionId/appium/app/close': {POST: {command: 'closeApp'}},
-  '/session/:sessionId/appium/app/reset': {POST: {command: 'reset'}},
   '/session/:sessionId/appium/app/background': {
     POST: {
       command: 'background',

package/lib/utils.js

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import { errors } from 'appium/driver';
+import {errors} from 'appium/driver';
 
 export const ADB_SHELL_FEATURE = 'adb_shell';
 
@@ -10,11 +10,48 @@ export const ADB_SHELL_FEATURE = 'adb_shell';
  * @param {any} opts the object to check
  * @returns {Record<string, any>} the same given object
  */
-export function requireArgs (argNames, opts) {
-  for (const argName of (_.isArray(argNames) ? argNames : [argNames])) {
+export function requireArgs(argNames, opts) {
+  for (const argName of _.isArray(argNames) ? argNames : [argNames]) {
     if (!_.has(opts, argName)) {
       throw new errors.InvalidArgumentError(`'${argName}' argument must be provided`);
     }
   }
   return opts;
 }
+
+/**
+ *
+ * @param {string | string[]} cap
+ * @returns {string[]}
+ */
+export function parseArray(cap) {
+  let parsedCaps;
+  try {
+    // @ts-ignore this is fine
+    parsedCaps = JSON.parse(cap);
+  } catch (ign) {}
+
+  if (_.isArray(parsedCaps)) {
+    return parsedCaps;
+  } else if (_.isString(cap)) {
+    return [cap];
+  }
+
+  throw new Error(`must provide a string or JSON Array; received ${cap}`);
+}
+
+/**
+ * @param {import('@appium/types').AppiumServer} server
+ * @param {string?} [sessionId]
+ * @returns {Promise<void>}
+ */
+export async function removeAllSessionWebSocketHandlers(server, sessionId) {
+  if (!server || !_.isFunction(server.getWebSocketHandlers)) {
+    return;
+  }
+
+  const activeHandlers = await server.getWebSocketHandlers(sessionId);
+  for (const pathname of _.keys(activeHandlers)) {
+    await server.removeWebSocketHandler(pathname);
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-android-driver",
-  "version": "7.8.3",
+  "version": "8.0.1",
   "description": "Android UiAutomator and Chrome support for Appium",
   "keywords": [
     "appium",
@@ -115,7 +115,7 @@
     "mocha": "^10.0.0",
     "prettier": "^3.0.1",
     "rimraf": "^5.0.0",
-    "semantic-release": "^22.0.5",
+    "semantic-release": "^23.0.0",
     "sinon": "^17.0.0",
     "ts-node": "^10.9.1",
     "typescript": "~5.2",

package/build/lib/commands/actions.d.ts

@@ -1,8 +0,0 @@
-export default ActionsMixin;
-export type ADB = import('appium-adb').ADB;
-/**
- * @type {import('./mixins').ActionsMixin & ThisType<import('../driver').AndroidDriver>}
- * @satisfies {import('@appium/types').ExternalDriver}
- */
-declare const ActionsMixin: import('./mixins').ActionsMixin & ThisType<import('../driver').AndroidDriver>;
-//# sourceMappingURL=actions.d.ts.map

package/build/lib/commands/actions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../lib/commands/actions.js"],"names":[],"mappings":";kBAkPa,OAAO,YAAY,EAAE,GAAG;AAvOrC;;;GAGG;AACH,4BAHU,OAAO,UAAU,EAAE,YAAY,GAAG,SAAS,OAAO,WAAW,EAAE,aAAa,CAAC,CA+NrF"}