appium-android-driver 7.7.0 → 7.8.1

package/lib/commands/media-projection.js

@@ -1,24 +1,12 @@
-// @ts-check
-
-import {fs, net, tempDir, util} from '@appium/support';
-import {waitForCondition} from 'asyncbox';
-import B from 'bluebird';
+import {fs, net, util} from '@appium/support';
 import _ from 'lodash';
 import moment from 'moment';
 import path from 'node:path';
-import {SETTINGS_HELPER_PKG_ID} from '../helpers';
 import {mixin} from './mixins';
 
 // https://github.com/appium/io.appium.settings#internal-audio--video-recording
 const DEFAULT_EXT = '.mp4';
-const RECORDING_STARTUP_TIMEOUT_MS = 3 * 1000;
-const RECORDING_STOP_TIMEOUT_MS = 3 * 1000;
 const MIN_API_LEVEL = 29;
-const RECORDING_SERVICE_NAME = `${SETTINGS_HELPER_PKG_ID}/.recorder.RecorderService`;
-const RECORDING_ACTIVITY_NAME = `${SETTINGS_HELPER_PKG_ID}/io.appium.settings.Settings`;
-const RECORDING_ACTION_START = `${SETTINGS_HELPER_PKG_ID}.recording.ACTION_START`;
-const RECORDING_ACTION_STOP = `${SETTINGS_HELPER_PKG_ID}.recording.ACTION_STOP`;
-const RECORDINGS_ROOT = `/storage/emulated/0/Android/data/${SETTINGS_HELPER_PKG_ID}/files`;
 const DEFAULT_FILENAME_FORMAT = 'YYYY-MM-DDTHH-mm-ss';
 
 /**
@@ -82,109 +70,6 @@ async function verifyMediaProjectionRecordingIsSupported(adb) {
   }
 }
 
-class MediaProjectionRecorder {
-  /**
-   * @param {ADB} adb
-   */
-  constructor(adb) {
-    this.adb = adb;
-  }
-
-  async isRunning() {
-    const stdout = await this.adb.shell([
-      'dumpsys',
-      'activity',
-      'services',
-      RECORDING_SERVICE_NAME,
-    ]);
-    return stdout.includes(RECORDING_SERVICE_NAME);
-  }
-
-  /**
-   *
-   * @param {import('./types').StartMediaProjectionRecordingOpts} opts
-   * @returns {Promise<boolean>}
-   */
-  async start(opts = {}) {
-    if (await this.isRunning()) {
-      return false;
-    }
-
-    await this.cleanup();
-    const {filename, maxDurationSec, priority, resolution} = opts;
-    const args = ['am', 'start', '-n', RECORDING_ACTIVITY_NAME, '-a', RECORDING_ACTION_START];
-    if (filename) {
-      args.push('--es', 'filename', filename);
-    }
-    if (maxDurationSec) {
-      args.push('--es', 'max_duration_sec', `${maxDurationSec}`);
-    }
-    if (priority) {
-      args.push('--es', 'priority', priority);
-    }
-    if (resolution) {
-      args.push('--es', 'resolution', resolution);
-    }
-    await this.adb.shell(args);
-    await new B((resolve, reject) => {
-      setTimeout(async () => {
-        if (!(await this.isRunning())) {
-          return reject(
-            new Error(
-              `The media projection recording is not running after ${RECORDING_STARTUP_TIMEOUT_MS}ms. ` +
-                `Please check the logcat output for more details.`
-            )
-          );
-        }
-        resolve();
-      }, RECORDING_STARTUP_TIMEOUT_MS);
-    });
-    return true;
-  }
-
-  async cleanup() {
-    await this.adb.shell([`rm -f ${RECORDINGS_ROOT}/*`]);
-  }
-
-  async pullRecent() {
-    const recordings = await this.adb.ls(RECORDINGS_ROOT, ['-tr']);
-    if (_.isEmpty(recordings)) {
-      return null;
-    }
-
-    const dstPath = path.join(await tempDir.openDir(), recordings[0]);
-    // increase timeout to 5 minutes because it might take a while to pull a large video file
-    await this.adb.pull(`${RECORDINGS_ROOT}/${recordings[0]}`, dstPath, {timeout: 300000});
-    return dstPath;
-  }
-
-  async stop() {
-    if (!(await this.isRunning())) {
-      return false;
-    }
-
-    await this.adb.shell([
-      'am',
-      'start',
-      '-n',
-      RECORDING_ACTIVITY_NAME,
-      '-a',
-      RECORDING_ACTION_STOP,
-    ]);
-    try {
-      await waitForCondition(async () => !(await this.isRunning()), {
-        waitMs: RECORDING_STOP_TIMEOUT_MS,
-        intervalMs: 500,
-      });
-    } catch (e) {
-      throw new Error(
-        `The attempt to stop the current media projection recording timed out after ` +
-          `${RECORDING_STOP_TIMEOUT_MS}ms`
-      );
-    }
-    return true;
-  }
-}
 /**
  * @type {import('./mixins').MediaProjectionMixin & ThisType<import('../driver').AndroidDriver>}
  * @satisfies {import('@appium/types').ExternalDriver}
@@ -194,7 +79,7 @@ const MediaProjectionMixin = {
     await verifyMediaProjectionRecordingIsSupported(this.adb);
 
     const {resolution, priority, maxDurationSec, filename} = options;
-    const recorder = new MediaProjectionRecorder(this.adb);
+    const recorder = this.settingsApp.makeMediaProjectionRecorder();
     const fname = adjustMediaExtension(filename || moment().format(DEFAULT_FILENAME_FORMAT));
     const didStart = await recorder.start({
       resolution,
@@ -215,14 +100,14 @@ const MediaProjectionMixin = {
   async mobileIsMediaProjectionRecordingRunning() {
     await verifyMediaProjectionRecordingIsSupported(this.adb);
 
-    const recorder = new MediaProjectionRecorder(this.adb);
+    const recorder = this.settingsApp.makeMediaProjectionRecorder();
     return await recorder.isRunning();
   },
 
   async mobileStopMediaProjectionRecording(options = {}) {
     await verifyMediaProjectionRecordingIsSupported(this.adb);
 
-    const recorder = new MediaProjectionRecorder(this.adb);
+    const recorder = this.settingsApp.makeMediaProjectionRecorder();
     if (await recorder.stop()) {
       this.log.info(
         'Successfully stopped a media projection recording. Pulling the recorded media'

package/lib/commands/mixins.ts

@@ -14,7 +14,6 @@ import type {
   ADB,
   InstallOptions,
   LogcatListener,
-  SmsListResult,
   UninstallOptions,
 } from 'appium-adb';
 import type Chromedriver from 'appium-chromedriver';
@@ -564,15 +563,15 @@ export interface GeneralMixin {
   /**
    * Retrieves the list of recent system notifications.
    *
-   * @returns See the documentation on `adb.getNotifications` for more details
+   * @returns See the documentation on `io.appium.settings -> getNotifications` for more details
    */
   mobileGetNotifications(): Promise<StringRecord>;
 
   /**
    * Retrieves the list of recent SMS messages with their properties.
-   * @returns See the documentation on `adb.getSmsList` for more details
+   * @returns See the documentation on `io.appium.settings -> getSmsList` for more details
    */
-  mobileListSms(opts: types.ListSmsOpts): Promise<SmsListResult>;
+  mobileListSms(opts: types.ListSmsOpts): Promise<types.SmsListResult>;
 
   /**
    * Unlocks the device if it is locked. Noop if the device's screen is not locked.
@@ -711,6 +710,7 @@ export interface NetworkMixin {
    * decoupling to override behaviour in other drivers like UiAutomator2.
    */
   setWifiState(state: boolean): Promise<void>;
+  setDataState(state: boolean): Promise<void>;
   toggleData(): Promise<void>;
   toggleWiFi(): Promise<void>;
   toggleFlightMode(): Promise<void>;

package/lib/commands/network.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import {mixin} from './mixins';
 import _ from 'lodash';
 import {errors} from 'appium/driver';
@@ -67,10 +65,10 @@ const NetworkMixin = {
     /** @type {(Promise<any>|(() => Promise<any>))[]} */
     const setters = [];
     if (!_.isUndefined(wifi) && currentState.wifi !== Boolean(wifi)) {
-      setters.push(this.adb.setWifiState(wifi, this.isEmulator()));
+      setters.push(this.setWifiState(wifi));
     }
     if (!_.isUndefined(data) && currentState.data !== Boolean(data)) {
-      setters.push(this.adb.setDataState(data, this.isEmulator()));
+      setters.push(this.setDataState(data));
     }
     if (!_.isUndefined(airplaneMode) && currentState.airplaneMode !== Boolean(airplaneMode)) {
       setters.push(async () => {
@@ -170,26 +168,30 @@ const NetworkMixin = {
           `${shouldEnableDataConnection ? 'enabled' : 'disabled'}`
       );
     } else {
-      await this.adb.setDataState(shouldEnableDataConnection, this.isEmulator());
+      await this.setDataState(shouldEnableDataConnection);
     }
 
     return await this.getNetworkConnection();
   },
 
-  async setWifiState(wifi) {
-    await this.adb.setWifiState(wifi, this.isEmulator());
+  async setWifiState(isOn) {
+    await this.settingsApp.setWifiState(isOn, this.isEmulator());
+  },
+
+  async setDataState(isOn) {
+    await this.settingsApp.setDataState(isOn, this.isEmulator());
   },
 
   async toggleData() {
-    let data = !(await this.adb.isDataOn());
-    this.log.info(`Turning network data ${data ? 'on' : 'off'}`);
-    await this.adb.setWifiAndData({data}, this.isEmulator());
+    const isOn = await this.adb.isDataOn();
+    this.log.info(`Turning network data ${!isOn ? 'on' : 'off'}`);
+    await this.setDataState(!isOn);
   },
 
   async toggleWiFi() {
-    let wifi = !(await this.adb.isWifiOn());
-    this.log.info(`Turning WiFi ${wifi ? 'on' : 'off'}`);
-    await this.adb.setWifiAndData({wifi}, this.isEmulator());
+    const isOn = await this.adb.isWifiOn();
+    this.log.info(`Turning WiFi ${!isOn ? 'on' : 'off'}`);
+    await this.setWifiState(!isOn);
   },
 
   async toggleFlightMode() {
@@ -206,7 +208,7 @@ const NetworkMixin = {
   },
 
   async setGeoLocation(location) {
-    await this.adb.setGeoLocation(location, this.isEmulator());
+    await this.settingsApp.setGeoLocation(location, this.isEmulator());
     try {
       return await this.getGeoLocation();
     } catch (e) {
@@ -224,11 +226,11 @@ const NetworkMixin = {
 
   async mobileRefreshGpsCache(opts = {}) {
     const {timeoutMs} = opts;
-    await this.adb.refreshGeoLocationCache(timeoutMs);
+    await this.settingsApp.refreshGeoLocationCache(timeoutMs);
   },
 
   async getGeoLocation() {
-    const {latitude, longitude, altitude} = await this.adb.getGeoLocation();
+    const {latitude, longitude, altitude} = await this.settingsApp.getGeoLocation();
     return {
       latitude: parseFloat(String(latitude)) || GEO_EPSILON,
       longitude: parseFloat(String(longitude)) || GEO_EPSILON,

package/lib/commands/types.ts

@@ -1130,3 +1130,21 @@ export interface GetUiModeOpts {
    */
   mode: string;
 }
+
+export interface SmsListResultItem {
+  id: string;
+  address: string;
+  person: string|null;
+  date: string;
+  read: string;
+  status: string;
+  type: string;
+  subject: string|null;
+  body: string;
+  serviceCenter: string|null;
+}
+
+export interface SmsListResult {
+  items: SmsListResultItem[];
+  total: number;
+}

package/lib/driver.ts

@@ -16,6 +16,7 @@ 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';
 
 export type AndroidDriverCaps = DriverCaps<AndroidDriverConstraints>;
 export type W3CAndroidDriverCaps = W3CDriverCaps<AndroidDriverConstraints>;
@@ -31,6 +32,8 @@ class AndroidDriver
 
   adb: ADB;
 
+  _settingsApp: SettingsApp;
+
   unlocker: typeof helpers.unlocker;
 
   apkStrings: StringRecord<StringRecord<string>>;
@@ -75,6 +78,13 @@ class AndroidDriver
     this.opts = opts as AndroidDriverOpts;
   }
 
+  get settingsApp() {
+    if (!this._settingsApp) {
+      this._settingsApp = new SettingsApp({adb: this.adb});
+    }
+    return this._settingsApp;
+  }
+
   isEmulator() {
     return helpers.isEmulator(this.adb, this.opts);
   }

package/lib/helpers/android.ts

@@ -4,7 +4,13 @@ import type {AppiumServer, StringRecord} from '@appium/types';
 import {ADB} from 'appium-adb';
 import {retryInterval, waitForCondition} from 'asyncbox';
 import B from 'bluebird';
-import {path as settingsApkPath} from 'io.appium.settings';
+import {
+  path as SETTINGS_APK_PATH,
+  SettingsApp,
+  SETTINGS_HELPER_ID,
+  UNICODE_IME,
+  EMPTY_IME,
+} from 'io.appium.settings';
 import _ from 'lodash';
 import {EOL} from 'node:os';
 import path from 'node:path';
@@ -57,8 +63,6 @@ const CHROME_BROWSER_PACKAGE_ACTIVITY = {
     activity: 'com.google.android.apps.chrome.Main',
   },
 } as const;
-const SETTINGS_HELPER_PKG_ID = 'io.appium.settings';
-const SETTING_NOTIFICATIONS_LISTENER_SERVICE = `${SETTINGS_HELPER_PKG_ID}/.NLService`;
 const EMULATOR_PATTERN = /\bemulator\b/i;
 // These constants are in sync with
 // https://developer.apple.com/documentation/xctest/xcuiapplicationstate/xcuiapplicationstaterunningbackground?language=objc
@@ -68,7 +72,6 @@ const APP_STATE = {
   RUNNING_IN_BACKGROUND: 3,
   RUNNING_IN_FOREGROUND: 4,
 } as const;
-const EMPTY_IME = `${SETTINGS_HELPER_PKG_ID}/.EmptyIME`;
 
 function ensureNetworkSpeed(adb: ADB, networkSpeed: string) {
   if (networkSpeed.toUpperCase() in adb.NETWORK_SPEED) {
@@ -344,13 +347,8 @@ const AndroidHelpers: AndroidHelpers = {
   },
 
   async ensureDeviceLocale(adb, language, country, script) {
-    if (!_.isString(language) && !_.isString(country)) {
-      logger.warn(`setDeviceLanguageCountry requires language or country.`);
-      logger.warn(`Got language: '${language}' and country: '${country}'`);
-      return;
-    }
-
-    await adb.setDeviceLanguageCountry(language, country, script);
+    const settingsApp = new SettingsApp({adb});
+    await settingsApp.setDeviceLocale(language!, country!, script);
 
     if (!(await adb.ensureCurrentLocale(language, country, script))) {
       const message = script
@@ -686,10 +684,9 @@ const AndroidHelpers: AndroidHelpers = {
     const defaultIME = await adb.defaultIME();
 
     logger.debug(`Unsetting previous IME ${defaultIME}`);
-    const appiumIME = `${SETTINGS_HELPER_PKG_ID}/.UnicodeIME`;
-    logger.debug(`Setting IME to '${appiumIME}'`);
-    await adb.enableIME(appiumIME);
-    await adb.setIME(appiumIME);
+    logger.debug(`Setting IME to '${UNICODE_IME}'`);
+    await adb.enableIME(UNICODE_IME);
+    await adb.setIME(UNICODE_IME);
     return defaultIME;
   },
 
@@ -755,7 +752,7 @@ const AndroidHelpers: AndroidHelpers = {
         await adb.shell([
           'appops',
           'set',
-          resultPkgs[0] ?? SETTINGS_HELPER_PKG_ID,
+          resultPkgs[0] ?? SETTINGS_HELPER_ID,
           'android:mock_location',
           'deny',
         ]);
@@ -793,65 +790,61 @@ const AndroidHelpers: AndroidHelpers = {
     logger.debug('Pushing settings apk to device...');
 
     try {
-      await AndroidHelpers.installHelperApp(adb, settingsApkPath, SETTINGS_HELPER_PKG_ID);
+      await AndroidHelpers.installHelperApp(adb, SETTINGS_APK_PATH, SETTINGS_HELPER_ID);
     } catch (err) {
       if (throwError) {
         throw err;
       }
 
       logger.warn(
-        `Ignored error while installing '${settingsApkPath}': ` +
+        `Ignored error while installing '${SETTINGS_APK_PATH}': ` +
           `'${(err as Error).message}'. Features that rely on this helper ` +
           'require the apk such as toggle WiFi and getting location ' +
           'will raise an error if you try to use them.'
       );
     }
 
+    const settingsApp = new SettingsApp({adb});
     // Reinstall would stop the settings helper process anyway, so
     // there is no need to continue if the application is still running
-    if (await adb.isSettingsAppServiceRunningInForeground()) {
+    if (await settingsApp.isRunningInForeground()) {
       logger.debug(
-        `${SETTINGS_HELPER_PKG_ID} is already running. ` +
+        `${SETTINGS_HELPER_ID} is already running. ` +
           `There is no need to reset its permissions.`
       );
       return;
     }
 
-    const apiLevel = await adb.getApiLevel();
-    if (apiLevel >= 29) {
-      // https://github.com/appium/io.appium.settings#internal-audio--video-recording
-      try {
-        await adb.shell(['appops', 'set', SETTINGS_HELPER_PKG_ID, 'PROJECT_MEDIA', 'allow']);
-      } catch (err) {
-        logger.debug((err as Error).message);
-      }
-      try {
-        await adb.shell([
-          'cmd',
-          'notification',
-          'allow_listener',
-          SETTING_NOTIFICATIONS_LISTENER_SERVICE,
-        ]);
-      } catch (err) {
-        logger.debug((err as Error).message);
+    const fixSettingsAppPermissionsForLegacyApis = async () => {
+      if (await adb.getApiLevel() > 23) {
+        return;
       }
-    }
-    if (apiLevel <= 23) {
+
       // Android 6- devices should have granted permissions
       // https://github.com/appium/appium/pull/11640#issuecomment-438260477
       const perms = ['SET_ANIMATION_SCALE', 'CHANGE_CONFIGURATION', 'ACCESS_FINE_LOCATION'];
-      logger.info(`Granting permissions ${perms} to '${SETTINGS_HELPER_PKG_ID}'`);
+      logger.info(`Granting permissions ${perms} to '${SETTINGS_HELPER_ID}'`);
       await adb.grantPermissions(
-        SETTINGS_HELPER_PKG_ID,
+        SETTINGS_HELPER_ID,
         perms.map((x) => `android.permission.${x}`)
       );
+    };
+
+    try {
+      await B.all([
+        settingsApp.adjustNotificationsPermissions(),
+        settingsApp.adjustMediaProjectionServicePermissions(),
+        fixSettingsAppPermissionsForLegacyApis(),
+      ]);
+    } catch (e) {
+      logger.debug(e.stack);
     }
 
     // launch io.appium.settings app due to settings failing to be set
     // if the app is not launched prior to start the session on android 7+
     // see https://github.com/appium/appium/issues/8957
     try {
-      await adb.requireRunningSettingsApp({
+      await settingsApp.requireRunning({
         timeout: AndroidHelpers.isEmulator(adb, opts) ? 30000 : 5000,
       });
     } catch (err) {
@@ -1003,7 +996,7 @@ const AndroidHelpers: AndroidHelpers = {
 
     if (!AndroidHelpers.isEmulator(adb, opts)) {
       if (mockLocationApp || _.isUndefined(mockLocationApp)) {
-        await AndroidHelpers.setMockLocationApp(adb, mockLocationApp || SETTINGS_HELPER_PKG_ID);
+        await AndroidHelpers.setMockLocationApp(adb, mockLocationApp || SETTINGS_HELPER_ID);
       } else {
         await AndroidHelpers.resetMockLocation(adb);
       }
@@ -1156,5 +1149,5 @@ const AndroidHelpers: AndroidHelpers = {
 };
 
 export const helpers = AndroidHelpers;
-export {APP_STATE, SETTINGS_HELPER_PKG_ID, ensureNetworkSpeed, prepareAvdArgs};
+export {APP_STATE, SETTINGS_HELPER_ID, ensureNetworkSpeed, prepareAvdArgs};
 export default AndroidHelpers;

package/lib/index.ts

@@ -6,7 +6,10 @@ export type * from './commands';
 export {ANDROID_DRIVER_CONSTRAINTS as commonCapConstraints} from './constraints';
 export * from './driver';
 export * as doctor from './doctor/checks';
-export {SETTINGS_HELPER_PKG_ID, default as androidHelpers} from './helpers/android';
+export {
+  SETTINGS_HELPER_ID as SETTINGS_HELPER_PKG_ID,
+  default as androidHelpers
+} from './helpers/android';
 export type * from './helpers/types';
 export {
   CHROMIUM_WIN,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-android-driver",
-  "version": "7.7.0",
+  "version": "7.8.1",
   "description": "Android UiAutomator and Chrome support for Appium",
   "keywords": [
     "appium",
@@ -57,12 +57,12 @@
   "dependencies": {
     "@appium/support": "^4.2.0",
     "@colors/colors": "^1.6.0",
-    "appium-adb": "^11.1.0",
+    "appium-adb": "^12.0.0",
     "appium-chromedriver": "^5.5.1",
     "asyncbox": "^3.0.0",
     "axios": "^1.x",
     "bluebird": "^3.4.7",
-    "io.appium.settings": "^5.3.0",
+    "io.appium.settings": "^5.7.1",
     "lodash": "^4.17.4",
     "lru-cache": "^10.0.1",
     "moment": "^2.24.0",

package/build/lib/stubs.d.ts

@@ -1,7 +0,0 @@
-/**
- * This module contains delcaration stubs for dependencies that are untyped.
- * @module
- */
-declare module 'io.appium.settings';
-export {};
-//# sourceMappingURL=stubs.d.ts.map

package/build/lib/stubs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"stubs.d.ts","sourceRoot":"","sources":["../../lib/stubs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,QAAQ,oBAAoB,CAAC"}

package/build/lib/stubs.js

@@ -1,7 +0,0 @@
-"use strict";
-/**
- * This module contains delcaration stubs for dependencies that are untyped.
- * @module
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=stubs.js.map

package/build/lib/stubs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"stubs.js","sourceRoot":"","sources":["../../lib/stubs.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/lib/stubs.ts

@@ -1,7 +0,0 @@
-/**
- * This module contains delcaration stubs for dependencies that are untyped.
- * @module
- */
-
-// @ts-ignore It is expected this module is untyped
-declare module 'io.appium.settings';