appium-adb 9.10.13 → 9.10.14

package/lib/tools/settings-client-commands.js

@@ -45,6 +45,8 @@ const commands = {};
  * @typedef {Object} SettingsAppStartupOptions
  * @property {number} timeout [5000] The maximum number of milliseconds
  * to wait until the app has started
+ * @property {boolean} shouldRestoreCurrentApp [false] Whether to restore
+ * the activity which was the current one before Settings startup
  */
 
 /**
@@ -63,7 +65,16 @@ commands.requireRunningSettingsApp = async function requireRunningSettingsApp (o
   log.debug('Starting Appium Settings app');
   const {
     timeout = 5000,
+    shouldRestoreCurrentApp = false,
   } = opts;
+  let appPackage;
+  if (shouldRestoreCurrentApp) {
+    try {
+      ({appPackage} = await this.getFocusedPackageAndActivity());
+    } catch (e) {
+      log.warn(`The current application can not be restored: ${e.message}`);
+    }
+  }
   await this.startApp({
     pkg: SETTINGS_HELPER_ID,
     activity: SETTINGS_HELPER_MAIN_ACTIVITY,
@@ -77,6 +88,13 @@ commands.requireRunningSettingsApp = async function requireRunningSettingsApp (o
       waitMs: timeout,
       intervalMs: 300,
     });
+    if (shouldRestoreCurrentApp && appPackage) {
+      try {
+        await this.activateApp(appPackage);
+      } catch (e) {
+        log.warn(`The current application can not be restored: ${e.message}`);
+      }
+    }
     return this;
   } catch (err) {
     throw new Error(`Appium Settings app is not running after ${timeout}ms`);
@@ -97,6 +115,8 @@ commands.setWifiState = async function setWifiState (on, isEmulator = false) {
       privileged: await this.getApiLevel() < 26,
     });
   } else {
+    await this.requireRunningSettingsApp({shouldRestoreCurrentApp: true});
+
     await this.shell([
       'am', 'broadcast',
       '-a', WIFI_CONNECTION_SETTING_ACTION,
@@ -120,6 +140,8 @@ commands.setDataState = async function setDataState (on, isEmulator = false) {
       privileged: await this.getApiLevel() < 26,
     });
   } else {
+    await this.requireRunningSettingsApp({shouldRestoreCurrentApp: true});
+
     await this.shell([
       'am', 'broadcast',
       '-a', DATA_CONNECTION_SETTING_ACTION,
@@ -269,6 +291,8 @@ commands.setGeoLocation = async function setGeoLocation (location, isEmulator =
  * @throws {Error} If the current location cannot be retrieved
  */
 commands.getGeoLocation = async function getGeoLocation () {
+  await this.requireRunningSettingsApp({shouldRestoreCurrentApp: true});
+
   let output;
   try {
     output = await this.shell([
@@ -309,6 +333,8 @@ commands.getGeoLocation = async function getGeoLocation () {
  * @throws {Error} If the GPS cache cannot be refreshed.
  */
 commands.refreshGeoLocationCache = async function refreshGeoLocationCache (timeoutMs = 20000) {
+  await this.requireRunningSettingsApp({shouldRestoreCurrentApp: true});
+
   let logcatMonitor;
   let monitoringPromise;
 
@@ -396,6 +422,7 @@ commands.performEditorAction = async function performEditorAction (action) {
  */
 commands.getClipboard = async function getClipboard () {
   log.debug('Getting the clipboard content');
+  await this.requireRunningSettingsApp({shouldRestoreCurrentApp: true});
   const retrieveClipboard = async () => await this.shell([
     'am', 'broadcast',
     '-n', CLIPBOARD_RECEIVER,
@@ -472,7 +499,7 @@ commands.getNotifications = async function getNotifications () {
   // renders the broadcast to fail instead of starting the
   // Appium Settings app. This only happens to the notifications
   // receiver
-  await this.requireRunningSettingsApp();
+  await this.requireRunningSettingsApp({shouldRestoreCurrentApp: true});
   let output;
   try {
     output = await this.shell([
@@ -535,6 +562,7 @@ commands.getNotifications = async function getNotifications () {
  */
 commands.getSmsList = async function getSmsList (opts = {}) {
   log.debug('Retrieving the recent SMS messages');
+  await this.requireRunningSettingsApp({shouldRestoreCurrentApp: true});
   const args = [
     'am', 'broadcast',
     '-n', SMS_LIST_RECEIVER,
@@ -588,6 +616,7 @@ commands.typeUnicode = async function typeUnicode (text) {
  */
 commands.scanMedia = async function scanMedia (destination) {
   log.debug(`Scanning '${destination}' for media files`);
+  await this.requireRunningSettingsApp({shouldRestoreCurrentApp: true});
   const output = await this.shell([
     'am', 'broadcast',
     '-n', MEDIA_SCAN_RECEIVER,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-adb",
-  "version": "9.10.13",
+  "version": "9.10.14",
   "description": "Android Debug Bridge interface",
   "main": "./build/index.js",
   "scripts": {