appium 3.0.0-beta.0 → 3.0.0-rc.1

package/lib/insecure-features.ts

@@ -0,0 +1,129 @@
+import _ from 'lodash';
+import logger from './logger';
+
+import type {AppiumDriver} from './appium';
+import type {ExternalDriver} from '@appium/types';
+
+const ALL_DRIVERS_MATCH = '*';
+const FEATURE_NAME_SEPARATOR = ':';
+
+/**
+ * Configures insecure features according to the values in `args.relaxedSecurityEnabled`,
+ * `args.allowInsecure`, and `args.denyInsecure`, and informs the user about any
+ * globally-applied features.
+ * Uses `logger` instead of `this.log` to reduce user confusion.
+ */
+export function configureGlobalFeatures(this: AppiumDriver) {
+  if (this.args.relaxedSecurityEnabled) {
+    logger.info(
+      `Enabling relaxed security. All insecure features will be ` +
+        `enabled unless explicitly disabled by --deny-insecure`,
+    );
+    this.relaxedSecurityEnabled = true;
+  } else if (!_.isEmpty(this.args.allowInsecure)) {
+    this.allowInsecure = validateFeatures(this.args.allowInsecure);
+    const globalAllowedFeatures = filterInsecureFeatures(this.allowInsecure);
+    if (!_.isEmpty(globalAllowedFeatures)) {
+      logger.info('Explicitly enabling insecure features:');
+      globalAllowedFeatures.forEach((a) => logger.info(`    ${a}`));
+    }
+  }
+  if (_.isEmpty(this.args.denyInsecure)) {
+    return;
+  }
+  this.denyInsecure = validateFeatures(this.args.denyInsecure);
+  const globalDeniedFeatures = filterInsecureFeatures(this.denyInsecure);
+  if (_.isEmpty(globalDeniedFeatures)) {
+    return;
+  }
+  logger.info('Explicitly disabling insecure features:');
+  globalDeniedFeatures.forEach((a) => logger.info(`    ${a}`));
+}
+
+/**
+ * If anything in the umbrella driver's insecure feature configuration applies to this driver,
+ * assign it to the driver instance
+ *
+ * @param driver
+ * @param driverName
+ */
+export function configureDriverFeatures(
+  this: AppiumDriver,
+  driver: ExternalDriver,
+  driverName: string,
+) {
+  if (this.relaxedSecurityEnabled) {
+    this.log.info(
+      `Enabling relaxed security for this session as per the server configuration. ` +
+        `All insecure features will be enabled unless explicitly disabled by --deny-insecure`,
+    );
+    driver.relaxedSecurityEnabled = true;
+  }
+  const allowedDriverFeatures = filterInsecureFeatures(this.allowInsecure, driverName);
+  if (!_.isEmpty(allowedDriverFeatures)) {
+    this.log.info('Explicitly enabling insecure features for this session ' +
+      'as per the server configuration:',
+    );
+    allowedDriverFeatures.forEach((a) => this.log.info(`    ${a}`));
+    driver.allowInsecure = allowedDriverFeatures;
+  }
+  const deniedDriverFeatures = filterInsecureFeatures(this.denyInsecure, driverName);
+  if (_.isEmpty(deniedDriverFeatures)) {
+    return;
+  }
+  this.log.info('Explicitly disabling insecure features for this session ' +
+    'as per the server configuration:',
+  );
+  deniedDriverFeatures.forEach((a) => this.log.info(`    ${a}`));
+  driver.denyInsecure = deniedDriverFeatures;
+}
+
+/**
+ * Validates the list of allowed/denied server features
+ *
+ * @param features
+ */
+function validateFeatures(features: string[]): string[] {
+  const validator = (fullName: string) => {
+    const errMsg = `The full feature name must include both the destination automation name or the ` +
+      `'${ALL_DRIVERS_MATCH}' wildcard to apply the feature to all installed drivers, and ` +
+      `the feature name split by a colon. Got '${fullName}' instead`;
+
+    const separatorPos = fullName.indexOf(FEATURE_NAME_SEPARATOR);
+    if (separatorPos < 0) {
+      throw new Error(errMsg);
+    }
+    const [automationName, featureName] = [
+      fullName.substring(0, separatorPos),
+      fullName.substring(separatorPos + 1)
+    ];
+    if (!automationName || !featureName) {
+      throw new Error(errMsg);
+    }
+    return fullName;
+  };
+  return features.map(validator);
+}
+
+/**
+ * Filters the list of insecure features to only those that are
+ * applicable to the given driver name.
+ * Assumes that all feature names have already been validated
+ *
+ * @param features
+ * @param driverName
+ */
+function filterInsecureFeatures(
+  features: string[],
+  driverName: string = ALL_DRIVERS_MATCH
+): string[] {
+  const filterFn = (fullName: string) => {
+    const separatorPos = fullName.indexOf(FEATURE_NAME_SEPARATOR);
+    if (separatorPos <= 0) {
+      return false;
+    }
+    const automationName = fullName.substring(0, separatorPos);
+    return [driverName, ALL_DRIVERS_MATCH].includes(automationName);
+  };
+  return features.filter(filterFn);
+}

package/lib/main.js

@@ -177,7 +177,7 @@ function determineAppiumHomeSource(appiumHomeFromArgs) {
  *
  * @template {CliCommand} [Cmd=ServerCommand]
  * @template {CliExtensionSubcommand|void} [SubCmd=void]
- * @param {Args<Cmd, SubCmd>} [args] - Partial args (progammatic usage only)
+ * @param {Args<Cmd, SubCmd>} [args] - Partial args (programmatic usage only)
  * @returns {Promise<InitResult<Cmd>>}
  * @example
  * import {init, getSchema} from 'appium';
@@ -375,6 +375,9 @@ async function main(args) {
 
   await logStartupInfo(parsedArgs);
 
+  // handle the insecure feature configuration since some features may apply globally
+  appiumDriver.configureGlobalFeatures();
+
   const appiumHomeSourceName = determineAppiumHomeSource(args?.appiumHome);
   logger.debug(`The ${appiumHomeSourceName}: ${appiumHome}`);
 

package/lib/schema/cli-args.js

@@ -1,6 +1,6 @@
 import {ArgumentTypeError} from 'argparse';
 import _ from 'lodash';
-import {formatErrors as formatErrors} from '../config-file';
+import {formatErrors} from '../config-file';
 import {flattenSchema, validate} from './schema';
 import {transformers, parseCsvLine} from './cli-transformers';
 
@@ -225,7 +225,7 @@ function subSchemaToArgDef(subSchema, argSpec) {
  * ArgumentDefinitions for handoff to `argparse`.
  *
  * @throws If schema has not been added to ajv (via `finalizeSchema()`)
- * @returns {import('../cli/args').ArgumentDefinitions} A map of arryas of
+ * @returns {import('../cli/args').ArgumentDefinitions} A map of arrays of
  * aliases to `argparse` arguments; empty if no schema found
  */
 export function toParserArgs() {

package/lib/schema/schema.js

@@ -421,7 +421,7 @@ class AppiumSchema {
    * name. Used when translating to `argparse` options or getting the list of
    * default values (see {@link AppiumSchema.getDefaults}) for CLI or otherwise.
    *
-   * The return value is an intermediate reprsentation used by `cli-args`
+   * The return value is an intermediate representation used by `cli-args`
    * module's `toParserArgs`, which converts the finalized schema to parameters
    * used by `argparse`.
    * @throws If {@link AppiumSchema.finalize} has not been called yet.

package/lib/utils.js

@@ -2,9 +2,9 @@ import _ from 'lodash';
 import logger from './logger';
 import {
   processCapabilities,
-  PROTOCOLS,
   STANDARD_CAPS,
   errors,
+  isW3cCaps,
 } from '@appium/base-driver';
 import {inspect as dump} from 'util';
 import {node, fs} from '@appium/support';
@@ -17,8 +17,6 @@ const STANDARD_CAPS_LOWERCASE = new Set([...STANDARD_CAPS].map((cap) => cap.toLo
 export const V4_BROADCAST_IP = '0.0.0.0';
 export const V6_BROADCAST_IP = '::';
 export const npmPackage = fs.readPackageJsonFrom(__dirname);
-const ALL_DRIVERS_MATCH = '*';
-const FEATURE_NAME_SEPARATOR = ':';
 
 /**
  *
@@ -61,124 +59,89 @@ export const inspect = _.flow(
  * into caps that can be used by the inner drivers.
  *
  * @template {Constraints} C
- * @template [J=any]
- * @param {J} jsonwpCapabilities
  * @param {W3CCapabilities<C>} w3cCapabilities
  * @param {C} constraints
  * @param {NSCapabilities<C>} [defaultCapabilities]
- * @returns {ParsedDriverCaps<C,J>|InvalidCaps<C,J>}
+ * @returns {ParsedDriverCaps<C>|InvalidCaps<C>}
  */
 export function parseCapsForInnerDriver(
-  jsonwpCapabilities,
   w3cCapabilities,
   constraints = /** @type {C} */ ({}),
   defaultCapabilities = {}
 ) {
-  // Check if the caller sent JSONWP caps, W3C caps, or both
-  const hasW3CCaps =
-    _.isPlainObject(w3cCapabilities) &&
-    (_.has(w3cCapabilities, 'alwaysMatch') || _.has(w3cCapabilities, 'firstMatch'));
-  const hasJSONWPCaps = _.isPlainObject(jsonwpCapabilities);
-  let desiredCaps = /** @type {ParsedDriverCaps<C>['desiredCaps']} */ ({});
-  /** @type {ParsedDriverCaps<C>['processedW3CCapabilities']} */
-  let processedW3CCapabilities;
-  /** @type {ParsedDriverCaps<C>['processedJsonwpCapabilities']} */
-  let processedJsonwpCapabilities;
-
-  if (!hasW3CCaps) {
+  if (!isW3cCaps(w3cCapabilities)) {
     return /** @type {InvalidCaps<C>} */ ({
-      protocol: PROTOCOLS.W3C,
       error: makeNonW3cCapsError(),
     });
   }
 
-  const {W3C} = PROTOCOLS;
-  const protocol = W3C;
+  let desiredCaps = /** @type {ParsedDriverCaps<C>['desiredCaps']} */ ({});
+  /** @type {ParsedDriverCaps<C>['processedW3CCapabilities'] | undefined} */
+  let processedW3CCapabilities;
 
   // Make sure we don't mutate the original arguments
-  jsonwpCapabilities = _.cloneDeep(jsonwpCapabilities);
   w3cCapabilities = _.cloneDeep(w3cCapabilities);
   defaultCapabilities = _.cloneDeep(defaultCapabilities);
 
   if (!_.isEmpty(defaultCapabilities)) {
-    if (hasW3CCaps) {
-      for (const [defaultCapKey, defaultCapValue] of _.toPairs(defaultCapabilities)) {
-        let isCapAlreadySet = false;
-        // Check if the key is already present in firstMatch entries
-        for (const firstMatchEntry of w3cCapabilities.firstMatch ?? []) {
-          if (
-            _.isPlainObject(firstMatchEntry) &&
-            _.has(removeAppiumPrefixes(firstMatchEntry), removeAppiumPrefix(defaultCapKey))
-          ) {
-            isCapAlreadySet = true;
-            break;
-          }
-        }
-        // Check if the key is already present in alwaysMatch entries
-        isCapAlreadySet =
-          isCapAlreadySet ||
-          (_.isPlainObject(w3cCapabilities.alwaysMatch) &&
-            _.has(
-              removeAppiumPrefixes(w3cCapabilities.alwaysMatch),
-              removeAppiumPrefix(defaultCapKey)
-            ));
-        if (isCapAlreadySet) {
-          // Skip if the key is already present in the provided caps
-          continue;
+    for (const [defaultCapKey, defaultCapValue] of _.toPairs(defaultCapabilities)) {
+      let isCapAlreadySet = false;
+      // Check if the key is already present in firstMatch entries
+      for (const firstMatchEntry of w3cCapabilities.firstMatch ?? []) {
+        if (
+          _.isPlainObject(firstMatchEntry) &&
+          _.has(removeAppiumPrefixes(firstMatchEntry), removeAppiumPrefix(defaultCapKey))
+        ) {
+          isCapAlreadySet = true;
+          break;
         }
+      }
+      // Check if the key is already present in alwaysMatch entries
+      isCapAlreadySet =
+        isCapAlreadySet ||
+        (_.isPlainObject(w3cCapabilities.alwaysMatch) &&
+          _.has(
+            removeAppiumPrefixes(w3cCapabilities.alwaysMatch),
+            removeAppiumPrefix(defaultCapKey)
+          ));
+      if (isCapAlreadySet) {
+        // Skip if the key is already present in the provided caps
+        continue;
+      }
 
-        // Only add the default capability if it is not overridden
-        if (_.isEmpty(w3cCapabilities.firstMatch)) {
-          w3cCapabilities.firstMatch = /** @type {W3CCapabilities<C>['firstMatch']} */ ([
-            {[defaultCapKey]: defaultCapValue},
-          ]);
-        } else {
-          w3cCapabilities.firstMatch[0][defaultCapKey] = defaultCapValue;
-        }
+      // Only add the default capability if it is not overridden
+      if (_.isEmpty(w3cCapabilities.firstMatch)) {
+        w3cCapabilities.firstMatch = /** @type {W3CCapabilities<C>['firstMatch']} */ ([
+          {[defaultCapKey]: defaultCapValue},
+        ]);
+      } else {
+        w3cCapabilities.firstMatch[0][defaultCapKey] = defaultCapValue;
       }
     }
-    if (hasJSONWPCaps) {
-      jsonwpCapabilities = {
-        ...removeAppiumPrefixes(defaultCapabilities),
-        ...jsonwpCapabilities,
-      };
-    }
   }
 
-  // Get MJSONWP caps
-  if (hasJSONWPCaps) {
-    processedJsonwpCapabilities = {...jsonwpCapabilities};
+  // Call the process capabilities algorithm to find matching caps on the W3C
+  // (see: https://github.com/jlipps/simple-wd-spec#processing-capabilities)
+  try {
+    desiredCaps = processCapabilities(w3cCapabilities, constraints, true);
+  } catch (error) {
+    logger.info(`Could not parse W3C capabilities: ${error.message}`);
+    return /** @type {InvalidCaps<C>} */ ({
+      desiredCaps,
+      processedW3CCapabilities,
+      error,
+    });
   }
 
-  // Get W3C caps
-  if (hasW3CCaps) {
-    // Call the process capabilities algorithm to find matching caps on the W3C
-    // (see: https://github.com/jlipps/simple-wd-spec#processing-capabilities)
-    try {
-      desiredCaps = processCapabilities(w3cCapabilities, constraints, true);
-    } catch (error) {
-      logger.info(`Could not parse W3C capabilities: ${error.message}`);
-      return /** @type {InvalidCaps<C,J>} */ ({
-        desiredCaps,
-        processedJsonwpCapabilities,
-        processedW3CCapabilities,
-        protocol,
-        error,
-      });
-    }
-
-    // Create a new w3c capabilities payload that contains only the matching caps in `alwaysMatch`
-    processedW3CCapabilities = {
-      alwaysMatch: {...insertAppiumPrefixes(desiredCaps)},
-      firstMatch: [{}],
-    };
-  }
+  // Create a new w3c capabilities payload that contains only the matching caps in `alwaysMatch`
+  processedW3CCapabilities = {
+    alwaysMatch: {...insertAppiumPrefixes(desiredCaps)},
+    firstMatch: [{}],
+  };
 
-  return /** @type {ParsedDriverCaps<C,J>} */ ({
+  return /** @type {ParsedDriverCaps<C>} */ ({
     desiredCaps,
-    processedJsonwpCapabilities,
     processedW3CCapabilities,
-    protocol,
   });
 }
 
@@ -381,7 +344,7 @@ export function isPluginCommandArgs(args) {
  *
  * @param {4|6|null} family Either 4 to include ipv4 addresses only,
  * 6 to include ipv6 addresses only, or null to include all of them
- * @returns {os.NetworkInterfaceInfo[]} The list of matched interfcaes
+ * @returns {os.NetworkInterfaceInfo[]} The list of matched interfaces
  */
 export function fetchInterfaces (family = null) {
   let familyValue = null;
@@ -416,8 +379,7 @@ export function adler32(str, seed = null) {
 			c = str.charCodeAt(i++);
 			if (c < 0x80) {
         a += c;
-      }
-			else if (c < 0x800) {
+      } else if (c < 0x800) {
 				a += 192 | ((c >> 6) & 31);
         b += a;
         --M;
@@ -463,37 +425,6 @@ export function isBroadcastIp(address) {
   return [V4_BROADCAST_IP, V6_BROADCAST_IP, `[${V6_BROADCAST_IP}]`].includes(address);
 }
 
-/**
- * Validates the list of allowed/denied server features
- *
- * @param {string[]} features
- * @returns {string[]}
- */
-export function validateFeatures(features) {
-  const validator = (/** @type {string} */ fullName) => {
-    const separatorPos = fullName.indexOf(FEATURE_NAME_SEPARATOR);
-    // TODO: This is for the backward compatibility with Appium2
-    // TODO: In Appium3 the separator will be mandatory
-    if (separatorPos < 0) {
-      return `${ALL_DRIVERS_MATCH}${FEATURE_NAME_SEPARATOR}${fullName}`;
-    }
-
-    const [automationName, featureName] = [
-      fullName.substring(0, separatorPos),
-      fullName.substring(separatorPos + 1)
-    ];
-    if (!automationName || !featureName) {
-      throw new Error(
-        `The full feature name must include both the destination automation name or the ` +
-        `'${ALL_DRIVERS_MATCH}' wildcard to apply the feature to all installed drivers, and ` +
-        `the feature name split by a colon, got '${fullName}' instead`
-      );
-    }
-    return fullName;
-  };
-  return features.map(validator);
-}
-
 /**
  * @typedef {import('@appium/types').StringRecord} StringRecord
  * @typedef {import('@appium/types').BaseDriverCapConstraints} BaseDriverCapConstraints
@@ -501,23 +432,17 @@ export function validateFeatures(features) {
 
 /**
  * @template {Constraints} [C=BaseDriverCapConstraints]
- * @template [J=any]
  * @typedef ParsedDriverCaps
  * @property {Capabilities<C>} desiredCaps
- * @property {string} protocol
- * @property {J} [processedJsonwpCapabilities]
- * @property {W3CCapabilities<C>} [processedW3CCapabilities]
+ * @property {W3CCapabilities<C>} processedW3CCapabilities
  */
 
 /**
  * @todo protocol is more specific
  * @template {Constraints} [C=BaseDriverCapConstraints]
- * @template [J=any]
  * @typedef InvalidCaps
  * @property {Error} error
- * @property {string} protocol
  * @property {Capabilities<C>} [desiredCaps]
- * @property {J} [processedJsonwpCapabilities]
  * @property {W3CCapabilities<C>} [processedW3CCapabilities]
  */
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "3.0.0-beta.0",
+  "version": "3.0.0-rc.1",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -55,25 +55,25 @@
     "postinstall": "node ./scripts/autoinstall-extensions.js",
     "publish:docs": "cross-env APPIUM_DOCS_PUBLISH=1 npm run build:docs",
     "test": "npm run test:unit",
-    "test:e2e": "mocha --timeout 1m --slow 30s \"./test/e2e/**/*.spec.js\"",
+    "test:e2e": "mocha --exit --timeout 1m --slow 30s \"./test/e2e/**/*.spec.js\"",
     "test:smoke": "cross-env APPIUM_HOME=./local_appium_home node ./index.js driver install uiautomator2 && cross-env APPIUM_HOME=./local_appium_home node ./index.js driver list",
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^10.0.0-beta.0",
-    "@appium/base-plugin": "^3.0.0-beta.0",
-    "@appium/docutils": "^1.0.32",
-    "@appium/logger": "^1.6.1",
+    "@appium/base-driver": "^10.0.0-beta.2",
+    "@appium/base-plugin": "^3.0.0-beta.2",
+    "@appium/docutils": "^1.1.0",
+    "@appium/logger": "^1.7.0",
     "@appium/schema": "^0.8.1",
-    "@appium/support": "^6.0.6",
-    "@appium/types": "^0.25.1",
+    "@appium/support": "^6.1.0",
+    "@appium/types": "^0.26.0",
     "@sidvind/better-ajv-errors": "3.0.1",
     "ajv": "8.17.1",
     "ajv-formats": "3.0.1",
     "argparse": "2.0.1",
     "async-lock": "1.4.1",
     "asyncbox": "3.0.0",
-    "axios": "1.8.1",
+    "axios": "1.9.0",
     "bluebird": "3.7.2",
     "lilconfig": "3.1.3",
     "lodash": "4.17.21",
@@ -81,22 +81,22 @@
     "ora": "5.4.1",
     "package-changed": "3.0.0",
     "resolve-from": "5.0.0",
-    "semver": "7.7.1",
+    "semver": "7.7.2",
     "source-map-support": "0.5.21",
-    "teen_process": "2.3.1",
-    "type-fest": "4.36.0",
+    "teen_process": "2.3.2",
+    "type-fest": "4.41.0",
     "winston": "3.17.0",
     "wrap-ansi": "7.0.0",
-    "ws": "8.18.1",
-    "yaml": "2.7.0"
+    "ws": "8.18.2",
+    "yaml": "2.8.0"
   },
   "engines": {
-    "node": "^20.9.0 || >=22.11.0",
+    "node": "^20.19.0 || >=22.12.0",
     "npm": ">=10"
   },
   "publishConfig": {
     "access": "public",
     "tag": "beta"
   },
-  "gitHead": "16d16dd0f3bf9829cff2ada7525156c462970932"
+  "gitHead": "92680d9b4a95da18a812187773240a51b52f5f29"
 }