appium-uiautomator2-driver 2.29.10 → 2.30.0

package/lib/execute-method-map.ts

@@ -0,0 +1,573 @@
+/**
+ * @privateRemarks This was created by hand from the type definitions in `lib/commands` here and in `appium-android-driver`.
+ * @module
+ */
+
+export const executeMethodMap = {
+  'mobile: shell': {
+    command: 'mobileShell',
+    params: {
+      required: ['command'],
+      optional: ['args', 'timeout', 'includeStderr'],
+    },
+  },
+  'mobile: execEmuConsoleCommand': {
+    command: 'mobileExecEmuConsoleCommand',
+    params: {
+      required: ['command'],
+      optional: ['execTimeout', 'connTimeout', 'initTimeout'],
+    },
+  },
+  'mobile: dragGesture': {
+    command: 'mobileDragGesture',
+    params: {
+      optional: ['elementId', 'startX', 'startY', 'endX', 'endY', 'speed'],
+    },
+  },
+  'mobile: flingGesture': {
+    command: 'mobileFlingGesture',
+    params: {
+      required: ['direction'],
+      optional: ['elementId', 'left', 'top', 'width', 'height', 'speed'],
+    },
+  },
+  'mobile: doubleClickGesture': {
+    command: 'mobileDoubleClickGesture',
+    params: {
+      optional: ['elementId', 'x', 'y'],
+    },
+  },
+  'mobile: clickGesture': {
+    command: 'mobileClickGesture',
+    params: {
+      optional: ['elementId', 'x', 'y'],
+    },
+  },
+  'mobile: longClickGesture': {
+    command: 'mobileLongClickGesture',
+    params: {
+      optional: ['elementId', 'x', 'y', 'duration'],
+    },
+  },
+  'mobile: pinchCloseGesture': {
+    command: 'mobilePinchCloseGesture',
+    params: {
+      required: ['percent'],
+      optional: ['elementId', 'left', 'top', 'width', 'height', 'speed'],
+    },
+  },
+  'mobile: pinchOpenGesture': {
+    command: 'mobilePinchOpenGesture',
+    params: {
+      required: ['percent'],
+      optional: ['elementId', 'left', 'top', 'width', 'height', 'speed'],
+    },
+  },
+  'mobile: swipeGesture': {
+    command: 'mobileSwipeGesture',
+    params: {
+      required: ['direction', 'percent'],
+      optional: ['elementId', 'left', 'top', 'width', 'height', 'speed'],
+    },
+  },
+  'mobile: scrollGesture': {
+    command: 'mobileScrollGesture',
+    params: {
+      required: ['direction', 'percent'],
+      optional: ['elementId', 'left', 'top', 'width', 'height', 'speed'],
+    },
+  },
+  'mobile: scrollBackTo': {
+    command: 'mobileScrollBackTo',
+    params: {
+      required: ['elementId', 'elementToId'],
+    },
+  },
+  'mobile: scroll': {
+    command: 'mobileScroll',
+    params: {
+      required: ['strategy', 'selector'],
+      optional: ['elementId', 'maxSwipes', 'element'],
+    },
+  },
+  'mobile: viewportScreenshot': {
+    command: 'mobileViewportScreenshot',
+  },
+  'mobile: viewportRect': {
+    command: 'mobileViewPortRect',
+  },
+
+  'mobile: deepLink': {
+    command: 'mobileDeepLink',
+    params: {
+      required: ['url', 'package'],
+      optional: ['waitForLaunch'],
+    },
+  },
+
+  'mobile: startLogsBroadcast': {
+    command: 'mobileStartLogsBroadcast',
+  },
+  'mobile: stopLogsBroadcast': {
+    command: 'mobileStopLogsBroadcast',
+  },
+
+  'mobile: acceptAlert': {
+    command: 'mobileAcceptAlert',
+    params: {
+      optional: ['buttonLabel'],
+    },
+  },
+  'mobile: dismissAlert': {
+    command: 'mobileDismissAlert',
+    params: {
+      optional: ['buttonLabel'],
+    },
+  },
+
+  'mobile: batteryInfo': {
+    command: 'mobileGetBatteryInfo',
+  },
+
+  'mobile: deviceInfo': {
+    command: 'mobileGetDeviceInfo',
+  },
+
+  'mobile: getDeviceTime': {
+    command: 'mobileGetDeviceTime',
+    params: {
+      optional: ['format'],
+    },
+  },
+
+  'mobile: changePermissions': {
+    command: 'mobileChangePermissions',
+    params: {
+      required: ['permissions'],
+      optional: ['appPackage', 'action', 'target'],
+    },
+  },
+  'mobile: getPermissions': {
+    command: 'mobileGetPermissions',
+    params: {
+      optional: ['type', 'appPackage'],
+    },
+  },
+
+  'mobile: performEditorAction': {
+    command: 'mobilePerformEditorAction',
+    params: {
+      required: ['action'],
+    },
+  },
+
+  'mobile: startScreenStreaming': {
+    command: 'mobileStartScreenStreaming',
+    params: {
+      optional: [
+        'width',
+        'height',
+        'bitrate',
+        'host',
+        'pathname',
+        'tcpPort',
+        'port',
+        'quality',
+        'considerRotation',
+        'logPipelineDetails',
+      ],
+    },
+  },
+  'mobile: stopScreenStreaming': {
+    command: 'mobileStopScreenStreaming',
+  },
+
+  'mobile: getNotifications': {
+    command: 'mobileGetNotifications',
+  },
+  'mobile: openNotifications': {
+    command: 'openNotifications',
+  },
+
+  'mobile: listSms': {
+    command: 'mobileListSms',
+    params: {
+      optional: ['max'],
+    },
+  },
+
+  'mobile: type': {
+    command: 'mobileType',
+    params: {
+      required: ['text'],
+    },
+  },
+  'mobile: replaceElementValue': {
+    command: 'mobileReplaceElementValue',
+    params: {
+      required: ['elementId', 'text'],
+    },
+  },
+
+  'mobile: pushFile': {
+    command: 'mobilePushFile',
+    params: {
+      required: ['payload', 'remotePath'],
+    },
+  },
+  'mobile: pullFile': {
+    command: 'mobilePullFile',
+    params: {
+      required: ['remotePath'],
+    },
+  },
+  'mobile: pullFolder': {
+    command: 'mobilePullFolder',
+    params: {
+      required: ['remotePath'],
+    },
+  },
+  'mobile: deleteFile': {
+    command: 'mobileDeleteFile',
+    params: {
+      required: ['remotePath'],
+    },
+  },
+
+  'mobile: isAppInstalled': {
+    command: 'mobileIsAppInstalled',
+    params: {
+      required: ['appId'],
+    },
+  },
+  'mobile: queryAppState': {
+    command: 'mobileQueryAppState',
+    params: {
+      required: ['appId'],
+    },
+  },
+  'mobile: activateApp': {
+    command: 'mobileActivateApp',
+    params: {
+      required: ['appId'],
+    },
+  },
+  'mobile: removeApp': {
+    command: 'mobileRemoveApp',
+    params: {
+      required: ['appId'],
+      optional: ['timeout', 'keepData'],
+    },
+  },
+  'mobile: terminateApp': {
+    command: 'mobileTerminateApp',
+    params: {
+      required: ['appId'],
+      optional: ['timeout'],
+    },
+  },
+  'mobile: installApp': {
+    command: 'mobileInstallApp',
+    params: {
+      required: ['appPath'],
+      optional: ['timeout', 'keepData'],
+    },
+  },
+  'mobile: clearApp': {
+    command: 'mobileClearApp',
+    params: {
+      required: ['appId'],
+    },
+  },
+  'mobile: backgroundApp': {
+    command: 'mobileBackgroundApp',
+    params: {
+      optional: ['seconds'],
+    },
+  },
+  'mobile: getCurrentActivity': {
+    command: 'getCurrentActivity',
+  },
+  'mobile: getCurrentPackage': {
+    command: 'getCurrentPackage',
+  },
+
+  'mobile: startActivity': {
+    command: 'mobileStartActivity',
+    params: {
+      optional: ['wait', 'stop', 'windowingMode', 'activityType', 'display'],
+    },
+  },
+  'mobile: startService': {
+    command: 'mobileStartService',
+    params: {
+      optional: [
+        'user',
+        'intent',
+        'action',
+        'package',
+        'uri',
+        'mimeType',
+        'identifier',
+        'component',
+        'categories',
+        'extras',
+        'flags',
+        'wait',
+        'stop',
+        'windowingMode',
+        'activityType',
+        'display',
+      ],
+    },
+  },
+  'mobile: stopService': {
+    command: 'mobileStopService',
+    params: {
+      optional: [
+        'user',
+        'intent',
+        'action',
+        'package',
+        'uri',
+        'mimeType',
+        'identifier',
+        'component',
+        'categories',
+        'extras',
+        'flags',
+      ],
+    },
+  },
+  'mobile: broadcast': {
+    command: 'mobileBroadcast',
+    params: {
+      optional: [
+        'user',
+        'intent',
+        'action',
+        'package',
+        'uri',
+        'mimeType',
+        'identifier',
+        'component',
+        'categories',
+        'extras',
+        'flags',
+        'receiverPermission',
+        'allowBackgroundActivityStarts',
+      ],
+    },
+  },
+
+  'mobile: getContexts': {
+    command: 'mobileGetContexts',
+  },
+
+  'mobile: getAppStrings': {
+    command: 'mobileGetAppStrings',
+    params: {
+      optional: ['language'],
+    },
+  },
+
+  'mobile: installMultipleApks': {
+    command: 'mobileInstallMultipleApks',
+    params: {
+      required: ['apks'],
+      optional: ['options'],
+    },
+  },
+
+  'mobile: lock': {
+    command: 'mobileLock',
+    params: {
+      optional: ['seconds'],
+    },
+  },
+  'mobile: unlock': {
+    command: 'mobileUnlock',
+    params: {
+      optional: ['key', 'type', 'strategy', 'timeoutMs'],
+    },
+  },
+  'mobile: isLocked': {
+    command: 'isLocked',
+  },
+
+  'mobile: refreshGpsCache': {
+    command: 'mobileRefreshGpsCache',
+    params: {
+      optional: ['timeoutMs'],
+    },
+  },
+
+  'mobile: startMediaProjectionRecording': {
+    command: 'mobileStartMediaProjectionRecording',
+    params: {
+      optional: ['resolution', 'maxDurationSec', 'priority', 'filename'],
+    },
+  },
+  'mobile: isMediaProjectionRecordingRunning': {
+    command: 'mobileIsMediaProjectionRecordingRunning',
+  },
+  'mobile: stopMediaProjectionRecording': {
+    command: 'mobileStopMediaProjectionRecording',
+    params: {
+      optional: [
+        'remotePath',
+        'user',
+        'pass',
+        'method',
+        'headers',
+        'fileFieldName',
+        'formFields',
+        'uploadTimeout',
+      ],
+    },
+  },
+
+  'mobile: getConnectivity': {
+    command: 'mobileGetConnectivity',
+    params: {
+      optional: ['services'],
+    },
+  },
+  'mobile: setConnectivity': {
+    command: 'mobileSetConnectivity',
+    params: {
+      optional: ['wifi', 'data', 'airplaneMode'],
+    },
+  },
+  'mobile: toggleGps': {
+    command: 'toggleLocationServices',
+  },
+  'mobile: isGpsEnabled': {
+    command: 'isLocationServicesEnabled',
+  },
+
+  'mobile: hideKeyboard': {
+    command: 'hideKeyboard',
+  },
+  'mobile: isKeyboardShown': {
+    command: 'isKeyboardShown',
+  },
+
+  'mobile: pressKey': {
+    command: 'mobilePressKey',
+    params: {
+      required: ['keycode'],
+      optional: ['metastate', 'flags', 'isLongPress'],
+    },
+  },
+
+  'mobile: getDisplayDensity': {
+    command: 'getDisplayDensity',
+  },
+  'mobile: getSystemBars': {
+    command: 'getSystemBars',
+  },
+
+  'mobile: fingerprint': {
+    command: 'mobileFingerprint',
+    params: {
+      required: ['fingerprintId'],
+    },
+  },
+  'mobile: sendSms': {
+    command: 'mobileSendSms',
+    params: {
+      required: ['phoneNumber', 'message'],
+    },
+  },
+  'mobile: gsmCall': {
+    command: 'mobileGsmCall',
+    params: {
+      required: ['phoneNumber', 'action'],
+    },
+  },
+  'mobile: gsmSignal': {
+    command: 'mobileGsmSignal',
+    params: {
+      required: ['strength'],
+    },
+  },
+  'mobile: gsmVoice': {
+    command: 'mobileGsmVoice',
+    params: {
+      required: ['state'],
+    },
+  },
+  'mobile: powerAc': {
+    command: 'mobilePowerAc',
+    params: {
+      required: ['state'],
+    },
+  },
+  'mobile: powerCapacity': {
+    command: 'mobilePowerCapacity',
+    params: {
+      required: ['percent'],
+    },
+  },
+  'mobile: networkSpeed': {
+    command: 'mobileNetworkSpeed',
+    params: {
+      required: ['speed'],
+    },
+  },
+  'mobile: sensorSet': {
+    command: 'sensorSet',
+    params: {
+      required: ['sensorType', 'value'],
+    },
+  },
+
+  'mobile: getPerformanceData': {
+    command: 'mobileGetPerformanceData',
+    params: {
+      required: ['packageName', 'dataType'],
+    },
+  },
+  'mobile: getPerformanceDataTypes': {
+    command: 'getPerformanceDataTypes',
+  },
+
+  'mobile: statusBar': {
+    command: 'mobilePerformStatusBarCommand',
+    params: {
+      required: ['command'],
+      optional: ['component'],
+    },
+  },
+
+  'mobile: screenshots': {
+    command: 'mobileScreenshots',
+    params: {
+      optional: ['displayId'],
+    },
+  },
+
+  'mobile: scheduleAction': {
+    command: 'mobileScheduleAction',
+    params: {
+      optional: ['opts'],
+    },
+  },
+
+  'mobile: getActionHistory': {
+    command: 'mobileGetActionHistory',
+    params: {
+      optional: ['opts'],
+    },
+  },
+
+  'mobile: unscheduleAction': {
+    command: 'mobileUnscheduleAction',
+    params: {
+      optional: ['opts'],
+    },
+  },
+} as const;
+
+export type Uiautomator2ExecuteMethodMap = typeof executeMethodMap;

package/lib/method-map.ts

@@ -0,0 +1,11 @@
+import {AndroidDriver} from 'appium-android-driver';
+
+export const newMethodMap = {
+  ...AndroidDriver.newMethodMap,
+  '/session/:sessionId/appium/device/get_clipboard': {
+    POST: {
+      command: 'getClipboard',
+      payloadParams: {optional: ['contentType']},
+    },
+  },
+} as const;

package/lib/types.ts

@@ -0,0 +1,59 @@
+import type {DriverCaps, DriverOpts, W3CDriverCaps} from '@appium/types';
+import type {AndroidSettings} from 'appium-android-driver';
+import type {EmptyObject} from 'type-fest';
+import type {RelativeRect} from './commands/types';
+import type {Uiautomator2Constraints} from './constraints';
+
+export type Uiautomator2DriverOpts = DriverOpts<Uiautomator2Constraints>;
+
+export type Uiautomator2DriverCaps = DriverCaps<Uiautomator2Constraints>;
+
+export type W3CUiautomator2DriverCaps = W3CDriverCaps<Uiautomator2Constraints>;
+
+export interface Uiautomator2DeviceInfo {
+  deviceApiLevel: number;
+  deviceScreenSize: string;
+  deviceScreenDensity: string;
+  deviceModel: string;
+  deviceManufacturer: string;
+  platformVersion: string;
+}
+
+export interface Uiautomator2SessionInfo {
+  deviceName: string;
+  deviceUDID: string;
+}
+
+export interface Uiautomator2DeviceDetails {
+  pixelRatio: string;
+  statBarHeight: number;
+  viewportRect: RelativeRect;
+}
+
+export interface Uiautomator2ServerInfo {
+  platform: 'LINUX';
+  webStorageEnabled: false;
+  takesScreenshot: true;
+  javascriptEnabled: true;
+  databaseEnabled: false;
+  networkConnectionEnabled: true;
+  locationContextEnabled: false;
+  warnings: EmptyObject;
+  desired: Uiautomator2DriverCaps;
+}
+
+export interface Uiautomator2StartSessionOpts
+  extends Uiautomator2DriverCaps,
+    Uiautomator2ServerInfo {}
+
+export interface Uiautomator2SessionCaps
+  extends Uiautomator2ServerInfo,
+    Uiautomator2SessionInfo,
+    Uiautomator2DeviceInfo,
+    Uiautomator2DeviceDetails {}
+
+export type Uiautomator2CreateResult = [string, Uiautomator2SessionCaps];
+
+export interface Uiautomator2Settings extends AndroidSettings {
+  allowInvisibleElements: boolean;
+}

package/lib/uiautomator2.js

@@ -24,6 +24,9 @@ const INSTRUMENTATION_TARGET = `${SERVER_TEST_PACKAGE_ID}/androidx.test.runner.A
 const instrumentationLogger = logger.getLogger('Instrumentation');
 
 class UIA2Proxy extends JWProxy {
+  /** @type {boolean} */
+  didInstrumentationExit;
+
   async proxyCommand (url, method, body = null) {
     if (this.didInstrumentationExit) {
       throw new errors.InvalidContextError(
@@ -36,6 +39,21 @@ class UIA2Proxy extends JWProxy {
 }
 
 class UiAutomator2Server {
+  /** @type {string} */
+  host;
+
+  /** @type {number} */
+  systemPort;
+
+  /** @type {import('appium-adb').ADB} */
+  adb;
+
+  /** @type {boolean} */
+  disableWindowAnimation;
+
+  /** @type {boolean|undefined} */
+  disableSuppressAccessibilityService;
+
   constructor (log, opts = {}) {
     for (let req of REQD_PARAMS) {
       if (!opts || !util.hasValue(opts[req])) {
@@ -192,6 +210,7 @@ class UiAutomator2Server {
         intervalMs: 1000,
       });
     } catch (err) {
+      // @ts-ignore It is ok if the attribute does not exist
       this.log.error(`Unable to find instrumentation target '${INSTRUMENTATION_TARGET}': ${(pmError || {}).message}`);
       if (pmOutput) {
         this.log.debug('Available targets:');
@@ -271,10 +290,10 @@ class UiAutomator2Server {
       cmd.push('--no-window-animation');
     }
     if (_.isBoolean(this.disableSuppressAccessibilityService)) {
-      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);
+    cmd.push('-e', 'disableAnalytics', 'true');
     cmd.push(INSTRUMENTATION_TARGET);
     const instrumentationProcess = this.adb.createSubProcess(['shell', ...cmd]);
     instrumentationProcess.on('output', (stdout, stderr) => {

package/lib/utils.js

@@ -4,12 +4,12 @@ import { errors } from 'appium/driver';
 /**
  * Assert the presence of particular keys in the given object
  *
- * @template {Object} T
+ * @template {Record<string, any>} T
  * @param {string|string[]} argNames one or more key names
  * @param {T} opts the object to check
  * @returns {T} the same given object
  */
-export function requireArgs (argNames, opts = {}) {
+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`);