appium-android-driver 5.14.7 → 6.0.0

package/lib/commands/permissions.js

@@ -1,9 +1,10 @@
-import _ from 'lodash';
-import { errors } from 'appium/driver';
-import B from 'bluebird';
-import { ADB_SHELL_FEATURE } from '../utils';
+// @ts-check
 
-const commands = {};
+import {errors} from 'appium/driver';
+import B from 'bluebird';
+import _ from 'lodash';
+import {ADB_SHELL_FEATURE} from '../utils';
+import {mixin} from './mixins';
 
 const ALL_PERMISSIONS_MAGIC = 'all';
 const PM_ACTION = Object.freeze({
@@ -26,18 +27,28 @@ const PERMISSIONS_TYPE = Object.freeze({
   REQUESTED: 'requested',
 });
 
-async function changePermissionsViaPm (permissions, appPackage, action) {
+/**
+ * @this {AndroidDriver}
+ * @param {*} permissions
+ * @param {*} appPackage
+ * @param {*} action
+ * @todo FIXME: type this
+ */
+async function changePermissionsViaPm(permissions, appPackage, action) {
   if (!_.values(PM_ACTION).includes(action)) {
-    throw new errors.InvalidArgumentError(`Unknown action '${action}'. ` +
-      `Only ${JSON.stringify(_.values(PM_ACTION))} actions are supported`);
+    throw new errors.InvalidArgumentError(
+      `Unknown action '${action}'. ` +
+        `Only ${JSON.stringify(_.values(PM_ACTION))} actions are supported`
+    );
   }
+  const adb = /** @type {ADB} */ (this.adb);
 
   let affectedPermissions = _.isArray(permissions) ? permissions : [permissions];
   if (_.toLower(permissions) === ALL_PERMISSIONS_MAGIC) {
-    const dumpsys = await this.adb.shell(['dumpsys', 'package', appPackage]);
-    const grantedPermissions = await this.adb.getGrantedPermissions(appPackage, dumpsys);
+    const dumpsys = await adb.shell(['dumpsys', 'package', appPackage]);
+    const grantedPermissions = await adb.getGrantedPermissions(appPackage, dumpsys);
     if (action === PM_ACTION.GRANT) {
-      const reqPermissons = await this.adb.getReqPermissions(appPackage, dumpsys);
+      const reqPermissons = await adb.getReqPermissions(appPackage, dumpsys);
       affectedPermissions = _.difference(reqPermissons, grantedPermissions);
     } else {
       affectedPermissions = grantedPermissions;
@@ -49,121 +60,109 @@ async function changePermissionsViaPm (permissions, appPackage, action) {
   }
 
   if (action === PM_ACTION.GRANT) {
-    await this.adb.grantPermissions(appPackage, affectedPermissions);
+    await adb.grantPermissions(appPackage, affectedPermissions);
   } else {
-    await B.all(affectedPermissions.map((name) => this.adb.revokePermission(appPackage, name)));
+    await B.all(affectedPermissions.map((name) => adb.revokePermission(appPackage, name)));
   }
 }
-
-async function changePermissionsViaAppops (permissions, appPackage, action) {
+/**
+ * @this {AndroidDriver}
+ * @param {*} permissions
+ * @param {*} appPackage
+ * @param {*} action
+ * @todo FIXME: type this
+ */
+async function changePermissionsViaAppops(permissions, appPackage, action) {
   if (!_.values(APPOPS_ACTION).includes(action)) {
-    throw new errors.InvalidArgumentError(`Unknown action '${action}'. ` +
-      `Only ${JSON.stringify(_.values(APPOPS_ACTION))} actions are supported`);
+    throw new errors.InvalidArgumentError(
+      `Unknown action '${action}'. ` +
+        `Only ${JSON.stringify(_.values(APPOPS_ACTION))} actions are supported`
+    );
   }
   if (_.toLower(permissions) === ALL_PERMISSIONS_MAGIC) {
-    throw new errors.InvalidArgumentError(`'${ALL_PERMISSIONS_MAGIC}' permission is only supported for ` +
-      `'${PERMISSION_TARGET.PM}' target. ` +
-      `Check AppOpsManager.java from Android platform sources to get the full list of supported AppOps permissions`);
+    throw new errors.InvalidArgumentError(
+      `'${ALL_PERMISSIONS_MAGIC}' permission is only supported for ` +
+        `'${PERMISSION_TARGET.PM}' target. ` +
+        `Check AppOpsManager.java from Android platform sources to get the full list of supported AppOps permissions`
+    );
   }
 
-  const promises = (_.isArray(permissions) ? permissions : [permissions])
-    .map((permission) => this.adb.shell(['appops', 'set', appPackage, permission, action]));
+  const promises = (_.isArray(permissions) ? permissions : [permissions]).map((permission) =>
+    /** @type {ADB} */ (this.adb).shell(['appops', 'set', appPackage, permission, action])
+  );
   await B.all(promises);
 }
 
 /**
- * @typedef {Object} ChangePermissionsOptions
- * @property {!string|Array<string>} permissions
- * If `target` is set to 'pm':
- *   The full name of the permission to be changed
- * or a list of permissions. Check https://developer.android.com/reference/android/Manifest.permission
- * to get the full list of standard Android permssion names. Mandatory argument.
- * If 'all' magic string is passed then the chosen action is going to be applied to all
- * permisisons requested/granted by 'appPackage'.
- * If `target` is set to 'appops':
- *   The full name of the appops permission to be changed
- * or a list of permissions. Check AppOpsManager.java sources to get the full list of
- * supported appops permission names for the given Android pklatform.
- * Examples: 'ACTIVITY_RECOGNITION', 'SMS_FINANCIAL_TRANSACTIONS', 'READ_SMS', 'ACCESS_NOTIFICATIONS'.
- * The 'all' magic string is unsupported.
- * @property {string} appPackage [this.opts.appPackage] The application package to set change
- * permissions on. Defaults to the package name under test.
- * @property {string} action [grant|allow] One of `PM_ACTION` values if `target` is set to 'pm',
- * otherwise one of `APPOPS_ACTION` values
- * @property {string} target [pm] Either 'pm' or 'appops'. The 'appops' one requires
- * 'adb_shell' server security option to be enabled.
+ * @type {import('./mixins').PermissionsMixin & ThisType<import('../driver').AndroidDriver>}
+ * @satisfies {import('@appium/types').ExternalDriver}
  */
+const PermissionsMixin = {
+  async mobileChangePermissions(opts) {
+    const {
+      permissions,
+      appPackage = this.opts.appPackage,
+      action = _.toLower(opts.target) === PERMISSION_TARGET.APPOPS
+        ? APPOPS_ACTION.ALLOW
+        : PM_ACTION.GRANT,
+      target = PERMISSION_TARGET.PM,
+    } = opts;
+    if (_.isNil(permissions)) {
+      throw new errors.InvalidArgumentError(`'permissions' argument is required`);
+    }
+    if (_.isEmpty(permissions)) {
+      throw new errors.InvalidArgumentError(`'permissions' argument must not be empty`);
+    }
 
-/**
- * Changes package permissions in runtime.
- *
- * @param {?ChangePermissionsOptions} opts - Available options mapping.
- * @throws {Error} if there was a failure while changing permissions
- */
-commands.mobileChangePermissions = async function mobileChangePermissions (opts = {}) {
-  const {
-    permissions,
-    appPackage = this.opts.appPackage,
-    action = _.toLower(opts.target) === PERMISSION_TARGET.APPOPS ? APPOPS_ACTION.ALLOW : PM_ACTION.GRANT,
-    target = PERMISSION_TARGET.PM,
-  } = opts;
-  if (_.isNil(permissions)) {
-    throw new errors.InvalidArgumentError(`'permissions' argument is required`);
-  }
-  if (_.isEmpty(permissions)) {
-    throw new errors.InvalidArgumentError(`'permissions' argument must not be empty`);
-  }
+    switch (_.toLower(target)) {
+      case PERMISSION_TARGET.PM:
+        return await changePermissionsViaPm.bind(this)(permissions, appPackage, _.toLower(action));
+      case PERMISSION_TARGET.APPOPS:
+        this.ensureFeatureEnabled(ADB_SHELL_FEATURE);
+        return await changePermissionsViaAppops.bind(this)(
+          permissions,
+          appPackage,
+          _.toLower(action)
+        );
+      default:
+        throw new errors.InvalidArgumentError(
+          `'target' argument must be one of: ${_.values(PERMISSION_TARGET)}`
+        );
+    }
+  },
 
-  switch (_.toLower(target)) {
-    case PERMISSION_TARGET.PM:
-      return await changePermissionsViaPm.bind(this)(permissions, appPackage, _.toLower(action));
-    case PERMISSION_TARGET.APPOPS:
-      this.ensureFeatureEnabled(ADB_SHELL_FEATURE);
-      return await changePermissionsViaAppops.bind(this)(permissions, appPackage, _.toLower(action));
-    default:
-      throw new errors.InvalidArgumentError(`'target' argument must be one of: ${_.values(PERMISSION_TARGET)}`);
-  }
+  async mobileGetPermissions(opts = {}) {
+    const {type = PERMISSIONS_TYPE.REQUESTED, appPackage = this.opts.appPackage} = opts;
+    const adb = /** @type {ADB} */ (this.adb);
+    /**
+     * @type {(pkg: string) => Promise<string[]>}
+     */
+    let actionFunc;
+    switch (_.toLower(type)) {
+      case PERMISSIONS_TYPE.REQUESTED:
+        actionFunc = (pkg) => adb.getReqPermissions(pkg);
+        break;
+      case PERMISSIONS_TYPE.GRANTED:
+        actionFunc = (pkg) => adb.getGrantedPermissions(pkg);
+        break;
+      case PERMISSIONS_TYPE.DENIED:
+        actionFunc = (pkg) => adb.getDeniedPermissions(pkg);
+        break;
+      default:
+        throw new errors.InvalidArgumentError(
+          `Unknown permissions type '${type}'. ` +
+            `Only ${JSON.stringify(_.values(PERMISSIONS_TYPE))} types are supported`
+        );
+    }
+    return await actionFunc(/** @type {string} */ (appPackage));
+  },
 };
 
-/**
- * @typedef {Object} GetPermissionsOptions
- * @property {string} type [requested] - One of possible permission types to get.
- * Can be any of `PERMISSIONS_TYPE` values.
- * @property {string} appPackage [this.opts.appPackage] - The application package to set change
- * permissions on. Defaults to the package name under test.
- */
+mixin(PermissionsMixin);
+
+export default PermissionsMixin;
 
 /**
- * Gets runtime permissions list for the given application package.
- *
- * @param {GetPermissionsOptions} opts - Available options mapping.
- * @returns {Array<string>} The list of retrieved permissions for the given type
- * (can also be empty).
- * @throws {Error} if there was an error while getting permissions.
+ * @typedef {import('appium-adb').ADB} ADB
+ * @typedef {import('../driver').AndroidDriver} AndroidDriver
  */
-commands.mobileGetPermissions = async function mobileGetPermissions (opts = {}) {
-  const {
-    type = PERMISSIONS_TYPE.REQUESTED,
-    appPackage = this.opts.appPackage,
-  } = opts;
-
-  let actionFunc;
-  switch (_.toLower(type)) {
-    case PERMISSIONS_TYPE.REQUESTED:
-      actionFunc = (pkg) => this.adb.getReqPermissions(pkg);
-      break;
-    case PERMISSIONS_TYPE.GRANTED:
-      actionFunc = (pkg) => this.adb.getGrantedPermissions(pkg);
-      break;
-    case PERMISSIONS_TYPE.DENIED:
-      actionFunc = (pkg) => this.adb.getDeniedPermissions(pkg);
-      break;
-    default:
-      throw new errors.InvalidArgumentError(`Unknown permissions type '${type}'. ` +
-        `Only ${JSON.stringify(_.values(PERMISSIONS_TYPE))} types are supported`);
-  }
-  return await actionFunc(appPackage);
-};
-
-export { commands };
-export default commands;