appium-android-driver 4.52.1 → 5.0.1

package/lib/commands/file-actions.js

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import { fs, util, zip, tempDir} from 'appium-support';
+import { fs, util, zip, tempDir} from '@appium/support';
 import log from '../logger';
 import path from 'path';
 
@@ -30,6 +30,32 @@ function parseContainerPath (remotePath) {
   return [match[1], path.posix.resolve(`/data/data/${match[1]}`, match[2])];
 }
 
+/**
+ * Scans the given file/folder on the remote device
+ * and adds matching items to the device's media library.
+ * Exceptions are ignored and written into the log.
+ *
+ * @param {ADB} adb ADB instance
+ * @param {string} remotePath The file/folder path on the remote device
+ */
+async function scanMedia (adb, remotePath) {
+  log.debug(`Performing media scan of '${remotePath}'`);
+  try {
+    // https://github.com/appium/appium/issues/16184
+    if (await adb.getApiLevel() >= 29) {
+      await adb.scanMedia(remotePath);
+    } else {
+      await adb.shell([
+        'am', 'broadcast',
+        '-a', ANDROID_MEDIA_RESCAN_INTENT,
+        '-d', `file://${remotePath}`
+      ]);
+    }
+  } catch (e) {
+    log.warn(`Ignoring an unexpected error upon media scanning of '${remotePath}': ${e.stderr || e.message}`);
+  }
+}
+
 /**
  * A small helper, which escapes single quotes in paths,
  * so they are safe to be passed as arguments of shell commands
@@ -139,13 +165,7 @@ commands.pushFile = async function pushFile (remotePath, base64Data) {
 
       // if we have pushed a file, it might be a media file, so ensure that
       // apps know about it
-      log.info('After pushing media file, broadcasting media scan intent');
-      try {
-        await this.adb.shell(['am', 'broadcast', '-a',
-          ANDROID_MEDIA_RESCAN_INTENT, '-d', `file://${remotePath}`]);
-      } catch (e) {
-        log.warn(`Got error broadcasting media scan intent: ${e.message}; ignoring`);
-      }
+      await scanMedia(this.adb, remotePath);
     }
   } finally {
     if (await fs.exists(localFile)) {

package/lib/commands/find.js

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import { errors, isErrorType } from 'appium-base-driver';
+import { errors, isErrorType } from '@appium/base-driver';
 
 
 let helpers = {}, extensions = {};
@@ -44,7 +44,7 @@ helpers.findElOrEls = async function findElOrEls (strategy, selector, mult, cont
 
       // now we have to inspect the error to determine if it is a no such
       // element error, based on the shape of the error object from
-      // appium-base-driver
+      // @appium/base-driver
       if (isErrorType(err, errors.NoSuchElementError)) {
         // we are fine with this, just indicate a retry
         return false;

package/lib/commands/general.js

@@ -1,6 +1,6 @@
 import _ from 'lodash';
 import androidHelpers from '../android-helpers';
-import { util } from 'appium-support';
+import { util } from '@appium/support';
 import log from '../logger';
 import moment from 'moment';
 import { longSleep } from 'asyncbox';

package/lib/commands/ime.js

@@ -1,5 +1,5 @@
 import log from '../logger';
-import { errors } from 'appium-base-driver';
+import { errors } from '@appium/base-driver';
 
 let commands = {}, helpers = {}, extensions = {};
 

package/lib/commands/intent.js

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import { errors } from 'appium-base-driver';
+import { errors } from '@appium/base-driver';
 
 const NO_VALUE_ARG_TYPE = 'sn';
 const SUPPORTED_EXTRA_TYPES = [

package/lib/commands/log.js

@@ -2,7 +2,7 @@ import log from '../logger';
 import os from 'os';
 import _ from 'lodash';
 import WebSocket from 'ws';
-import { DEFAULT_WS_PATHNAME_PREFIX, BaseDriver } from 'appium-base-driver';
+import { DEFAULT_WS_PATHNAME_PREFIX, BaseDriver } from '@appium/base-driver';
 
 const GET_SERVER_LOGS_FEATURE = 'get_server_logs';
 

package/lib/commands/network.js

@@ -1,6 +1,6 @@
 import log from '../logger';
 import _ from 'lodash';
-import { errors } from 'appium-base-driver';
+import { errors } from '@appium/base-driver';
 import B from 'bluebird';
 
 let commands = {}, helpers = {}, extensions = {};
@@ -144,6 +144,27 @@ commands.setGeoLocation = async function setGeoLocation (location) {
   }
 };
 
+/**
+ * @typedef {Object} GpsCacheRefreshOptions
+ * @property {number} timeoutMs [20000] The maximum number of milliseconds
+ * to block until GPS cache is refreshed. Providing zero or a negative
+ * value to it skips waiting completely.
+ */
+
+/**
+ * Sends an async request to refresh the GPS cache.
+ * This feature only works if the device under test has
+ * Google Play Services installed. In case the vanilla
+ * LocationManager is used the device API level must be at
+ * version 30 (Android R) or higher.
+ *
+ * @param {GpsCacheRefreshOptions} opts
+ */
+commands.mobileRefreshGpsCache = async function mobileRefreshGpsCache (opts = {}) {
+  const { timeoutMs } = opts;
+  await this.adb.refreshGeoLocationCache(timeoutMs);
+};
+
 commands.getGeoLocation = async function getGeoLocation () {
   const {latitude, longitude, altitude} = await this.adb.getGeoLocation();
   return {

package/lib/commands/recordscreen.js

@@ -1,6 +1,6 @@
 import _ from 'lodash';
 import { waitForCondition } from 'asyncbox';
-import { util, fs, net, tempDir, system, timing } from 'appium-support';
+import { util, fs, net, tempDir, system, timing } from '@appium/support';
 import log from '../logger';
 import { exec } from 'teen_process';
 import path from 'path';

package/lib/commands/shell.js

@@ -1,7 +1,7 @@
 import log from '../logger';
 import _ from 'lodash';
 import { exec } from 'teen_process';
-import { util } from 'appium-support';
+import { util } from '@appium/support';
 
 const ADB_SHELL_FEATURE = 'adb_shell';
 

package/lib/commands/streamscreen.js

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import { fs, system, logger, util } from 'appium-support';
+import { fs, system, logger, util } from '@appium/support';
 import log from '../logger';
 import { exec, SubProcess } from 'teen_process';
 import { checkPortStatus } from 'portscanner';

package/lib/commands/touch.js

@@ -2,9 +2,9 @@ import log from '../logger';
 import _ from 'lodash';
 import androidHelpers from '../android-helpers';
 import B from 'bluebird';
-import { errors, isErrorType } from 'appium-base-driver';
+import { errors, isErrorType } from '@appium/base-driver';
 import { asyncmap } from 'asyncbox';
-import { util } from 'appium-support';
+import { util } from '@appium/support';
 
 let commands = {}, helpers = {}, extensions = {};
 

package/lib/driver.js

@@ -1,4 +1,4 @@
-import { BaseDriver, DeviceSettings } from 'appium-base-driver';
+import { BaseDriver, DeviceSettings } from '@appium/base-driver';
 import desiredConstraints from './desired-caps';
 import commands from './commands/index';
 import {
@@ -8,7 +8,7 @@ import {
 import log from './logger';
 import _ from 'lodash';
 import { DEFAULT_ADB_PORT } from 'appium-adb';
-import { fs, tempDir, util } from 'appium-support';
+import { fs, tempDir, util } from '@appium/support';
 import { retryInterval } from 'asyncbox';
 import { SharedPrefsBuilder } from 'shared-preferences-builder';
 import B from 'bluebird';

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/server.js

@@ -1,5 +1,5 @@
 import log from './logger';
-import { server as baseServer, routeConfiguringFunction as makeRouter } from 'appium-base-driver';
+import { server as baseServer, routeConfiguringFunction as makeRouter } from '@appium/base-driver';
 import AndroidDriver from './driver';
 
 async function startServer (port, host) {

package/lib/uiautomator.js

@@ -1,5 +1,5 @@
 import events from 'events';
-import { logger } from 'appium-support';
+import { logger } from '@appium/support';
 
 
 const log = logger.getLogger('UiAutomator');

package/lib/unlock-helpers.js

@@ -1,7 +1,7 @@
 import logger from './logger';
 import { sleep } from 'asyncbox';
 import _ from 'lodash';
-import { util } from 'appium-support';
+import { util } from '@appium/support';
 
 const PIN_UNLOCK = 'pin';
 const PIN_UNLOCK_KEY_EVENT = 'pinWithKeyEvent';

package/lib/webview-helpers.js

@@ -1,7 +1,7 @@
 import _ from 'lodash';
 import logger from './logger';
 import axios from 'axios';
-import { util } from 'appium-support';
+import { util } from '@appium/support';
 import { findAPortNotInUse } from 'portscanner';
 import LRU from 'lru-cache';
 import B from 'bluebird';

package/package.json

@@ -9,7 +9,7 @@
     "mobile",
     "mobile testing"
   ],
-  "version": "4.52.1",
+  "version": "5.0.1",
   "author": "appium",
   "license": "Apache-2.0",
   "repository": {
@@ -35,25 +35,25 @@
     "bootstrap/bin/AppiumBootstrap.jar"
   ],
   "dependencies": {
+    "@appium/base-driver": "^8.0.0",
+    "@appium/support": "^2.55.3",
     "@babel/runtime": "^7.0.0",
-    "appium-adb": "^8.16.0",
-    "appium-base-driver": "^7.0.0",
-    "appium-chromedriver": "^4.13.0",
-    "appium-support": "^2.47.1",
+    "appium-adb": "^9.0.0",
+    "appium-chromedriver": "^5.0.1",
     "asyncbox": "^2.8.0",
     "axios": "^0.x",
     "bluebird": "^3.4.7",
-    "io.appium.settings": "^3.3.0",
-    "jimp": "^0.16.1",
+    "io.appium.settings": "^4.0.0",
+    "jimp": "^0.x",
     "lodash": "^4.17.4",
-    "lru-cache": "^6.0.0",
+    "lru-cache": "^7.3.0",
     "moment": "^2.24.0",
     "moment-timezone": "^0.5.26",
     "portfinder": "^1.0.6",
     "portscanner": "2.2.0",
-    "shared-preferences-builder": "^0.0.4",
+    "shared-preferences-builder": "^0.x",
     "semver": "^7.0.0",
-    "source-map-support": "^0.5.5",
+    "source-map-support": "^0.x",
     "teen_process": "^1.9.0",
     "ws": "^8.0.0"
   },
@@ -77,18 +77,24 @@
     "precommit-test"
   ],
   "devDependencies": {
+    "@appium/gulp-plugins": "^6.0.0",
+    "@appium/eslint-config-appium": "^5.0.0",
+    "@appium/test-support": "^1.0.0",
+    "@babel/core": "^7.16.0",
+    "@babel/eslint-parser": "^7.16.3",
     "@xmldom/xmldom": "^0.x",
-    "android-apidemos": "^3.0.0",
-    "appium-gulp-plugins": "^5.4.0",
-    "appium-test-support": "^1.0.0",
+    "android-apidemos": "^4.0.0",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
-    "eslint-config-appium": "^4.0.1",
+    "eslint": "^7.32.0",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-mocha": "^9.0.0",
+    "eslint-plugin-promise": "^6.0.0",
     "gulp": "^4.0.0",
     "mocha": "^9.0.0",
     "mock-fs": "^5.0.0",
     "pre-commit": "^1.1.3",
-    "sinon": "^12.0.0",
+    "sinon": "^13.0.0",
     "xpath": "^0.x"
   }
 }