appium 2.18.0 → 2.19.0

package/lib/insecure-features.ts

@@ -0,0 +1,132 @@
+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 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);
+}
+
+/**
+ * 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

@@ -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 = ':';
 
 /**
  *
@@ -381,7 +379,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;
@@ -463,37 +461,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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "2.18.0",
+  "version": "2.19.0",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -60,20 +60,20 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^9.17.0",
-    "@appium/base-plugin": "^2.3.6",
-    "@appium/docutils": "^1.1.0",
-    "@appium/logger": "^1.7.0",
+    "@appium/base-driver": "^9.18.0",
+    "@appium/base-plugin": "^2.3.7",
+    "@appium/docutils": "^1.1.1",
+    "@appium/logger": "^1.7.1",
     "@appium/schema": "^0.8.1",
-    "@appium/support": "^6.1.0",
-    "@appium/types": "^0.25.3",
+    "@appium/support": "^6.1.1",
+    "@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.4",
+    "axios": "1.9.0",
     "bluebird": "3.7.2",
     "lilconfig": "3.1.3",
     "lodash": "4.17.21",
@@ -81,14 +81,14 @@
     "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.40.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.1"
+    "ws": "8.18.2",
+    "yaml": "2.8.0"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -97,5 +97,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8476bd3f65fc549f9a589d20d19236d0ce4ea335"
+  "gitHead": "c8fe4412525f7e1fa237813cf83fe7d98f0125eb"
 }