appium 2.0.0-beta.18 → 2.0.0-beta.21

package/lib/utils.js

@@ -1,6 +1,6 @@
 import _ from 'lodash';
 import logger from './logger';
-import { processCapabilities, PROTOCOLS, validateCaps as validateArgs } from '@appium/base-driver';
+import { processCapabilities, PROTOCOLS } from '@appium/base-driver';
 import { fs } from '@appium/support';
 
 const W3C_APPIUM_PREFIX = 'appium';
@@ -33,55 +33,6 @@ function inspectObject (args) {
   }
 }
 
-/**
- * Given a set of CLI args and the name of a driver or plugin, extract those args for that plugin
- * @param {Object} extensionArgs - arguments of the form {[extName]: {[argName]: [argValue]}}
- * @param {string} extensionName - the name of the extension
- * @return {Object} the arg object for that extension alone
- */
-function getExtensionArgs (extensionArgs, extensionName) {
-  if (!_.has(extensionArgs, extensionName)) {
-    return {};
-  }
-  if (!_.isPlainObject(extensionArgs[extensionName])) {
-    throw new TypeError(`Driver or plugin arguments must be plain objects`);
-  }
-  return extensionArgs[extensionName];
-}
-
-
-/**
- * Given a set of args and a set of constraints, throw an error if any args are not mentioned in
- * the set of constraints
- * @param {Object} extensionArgs the args
- * @param {Object} argsConstraints the constraints object
- * @throws {Error} if any args were not recognized
- */
-function ensureNoUnknownArgs (extensionArgs, argsConstraints) {
-  const knownArgNames = Object.keys(argsConstraints);
-  const unknownArgs = _.difference(Object.keys(extensionArgs), knownArgNames);
-  if (unknownArgs.length > 0) {
-    throw new Error(`Some arguments were not recognized: ${JSON.stringify(unknownArgs)}. ` +
-                    `Are you sure they are in the list of supported args? ${JSON.stringify(knownArgNames)}`);
-  }
-}
-
-/**
- * Takes in a set of driver/plugin args passed in by user, and arg constraints
- * and throws an error if any arg is unknown or of the incorrect type
- *
- * @param {object} extensionArgs - Driver or Plugin specific args
- * @param {object} argsConstraints - Constraints for arguments
- * @throws {Error} if any args are not recognized or are of an invalid type
-*/
-function validateExtensionArgs (extensionArgs, argsConstraints) {
-  if (!_.isEmpty(extensionArgs) && !_.isEmpty(argsConstraints)) {
-    ensureNoUnknownArgs(extensionArgs, argsConstraints);
-    validateArgs(extensionArgs, argsConstraints);
-  }
-}
-
-
 /**
  * Takes the caps that were provided in the request and translates them
  * into caps that can be used by the inner drivers.
@@ -267,8 +218,34 @@ function pullSettings (caps) {
 
 const rootDir = fs.findRoot(__dirname);
 
+
+/**
+ * A Map where you can set properties, but only once. And you can't remove anything. So there.
+ * @template K,V
+ * @extends {Map<K,V>}
+ */
+class ReadonlyMap extends Map {
+  /**
+   * @param {K} key
+   * @param {V} value
+   */
+  set (key, value) {
+    if (this.has(key)) {
+      throw new Error(`${key} is already set`);
+    }
+    return super.set(key, value);
+  }
+
+  delete (key) {
+    throw new Error(`${key} cannot be deleted`);
+  }
+
+  clear () {
+    throw new Error(`Cannot clear ReadonlyMap`);
+  }
+}
+
 export {
   inspectObject, parseCapsForInnerDriver, insertAppiumPrefixes, rootDir,
-  getPackageVersion, pullSettings, removeAppiumPrefixes, getExtensionArgs,
-  validateExtensionArgs
+  getPackageVersion, pullSettings, removeAppiumPrefixes, ReadonlyMap
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "2.0.0-beta.18",
+  "version": "2.0.0-beta.21",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -32,7 +32,8 @@
     "bin",
     "lib",
     "build/lib",
-    "postinstall.js"
+    "postinstall.js",
+    "types"
   ],
   "scripts": {
     "generate-docs": "gulp transpile && node ./build/commands-yml/parse.js",
@@ -43,21 +44,26 @@
     "zip-and-upload": "npm run zip && npm run upload"
   },
   "dependencies": {
-    "@appium/base-driver": "^8.1.1",
-    "@appium/base-plugin": "1.7.2",
-    "@appium/support": "^2.54.2",
-    "@babel/runtime": "7.15.4",
+    "@appium/base-driver": "^8.2.0",
+    "@appium/base-plugin": "1.8.0",
+    "@appium/support": "^2.55.1",
+    "@babel/runtime": "7.16.3",
+    "@sidvind/better-ajv-errors": "0.9.2",
+    "ajv": "8.8.0",
+    "ajv-formats": "2.1.1",
     "argparse": "2.0.1",
     "async-lock": "1.3.0",
-    "asyncbox": "2.9.1",
-    "axios": "0.21.4",
+    "asyncbox": "2.9.2",
+    "axios": "0.24.0",
     "bluebird": "3.7.2",
     "continuation-local-storage": "3.2.1",
     "find-up": "5.0.0",
+    "lilconfig": "2.0.4",
     "lodash": "4.17.21",
     "longjohn": "0.2.12",
     "npmlog": "5.0.1",
     "ora": "5.4.1",
+    "resolve-from": "5.0.0",
     "semver": "7.3.5",
     "source-map-support": "0.5.20",
     "teen_process": "1.16.0",
@@ -66,8 +72,8 @@
     "yaml": "1.10.2"
   },
   "devDependencies": {
-    "@appium/fake-driver": "^3.0.5",
-    "@appium/gulp-plugins": "^5.5.3"
+    "@appium/fake-driver": "^3.2.0",
+    "@appium/gulp-plugins": "^5.5.5"
   },
   "engines": {
     "node": ">=12",
@@ -78,5 +84,5 @@
     "tag": "next"
   },
   "homepage": "https://appium.io",
-  "gitHead": "01dd42ee1778509664d422a0c26e7061bae8402e"
+  "gitHead": "ec6a90a797d2dadb407922426be16efaec9def07"
 }

package/types/appium-config.d.ts

@@ -0,0 +1,197 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * IP address to listen on
+ */
+export type AddressConfig = string;
+/**
+ * Whether the Appium server should allow web browser connections from any host
+ */
+export type AllowCorsConfig = boolean;
+/**
+ * Set which insecure features are allowed to run in this server's sessions. Features are defined on a driver level; see documentation for more details. Note that features defined via "deny-insecure" will be disabled, even if also listed here. If string, a path to a text file containing policy or a comma-delimited list.
+ */
+export type AllowInsecureConfig = string[];
+/**
+ * Base path to use as the prefix for all webdriver routes running on the server
+ */
+export type BasePathConfig = string;
+/**
+ * Callback IP address (default: same as "address")
+ */
+export type CallbackAddressConfig = string;
+/**
+ * Callback port (default: same as "port")
+ */
+export type CallbackPortConfig = number;
+/**
+ * Add exaggerated spacing in logs to help with visual inspection
+ */
+export type DebugLogSpacingConfig = boolean;
+/**
+ * Set which insecure features are not allowed to run in this server's sessions. Features are defined on a driver level; see documentation for more details. Features listed here will not be enabled even if also listed in "allow-insecure", and even if "relaxed-security" is enabled. If string, a path to a text file containing policy or a comma-delimited list.
+ */
+export type DenyInsecureConfig = string[];
+/**
+ * Number of seconds the Appium server should apply as both the keep-alive timeout and the connection timeout for all requests. A value of 0 disables the timeout.
+ */
+export type KeepAliveTimeoutConfig = number;
+/**
+ * Use local timezone for timestamps
+ */
+export type LocalTimezoneConfig = boolean;
+/**
+ * Also send log output to this file
+ */
+export type LogConfig = string;
+/**
+ * One or more log filtering rules
+ */
+export type LogFiltersConfig = string[];
+/**
+ * Log level (console[:file])
+ */
+export type LogLevelConfig =
+  | "info"
+  | "info:debug"
+  | "info:info"
+  | "info:warn"
+  | "info:error"
+  | "warn"
+  | "warn:debug"
+  | "warn:info"
+  | "warn:warn"
+  | "warn:error"
+  | "error"
+  | "error:debug"
+  | "error:info"
+  | "error:warn"
+  | "error:error"
+  | "debug"
+  | "debug:debug"
+  | "debug:info"
+  | "debug:warn"
+  | "debug:error";
+/**
+ * Do not use color in console output
+ */
+export type LogNoColorsConfig = boolean;
+/**
+ * Show timestamps in console output
+ */
+export type LogTimestampConfig = boolean;
+/**
+ * Add long stack traces to log entries. Recommended for debugging only.
+ */
+export type LongStacktraceConfig = boolean;
+/**
+ * Do not check that needed files are readable and/or writable
+ */
+export type NoPermsCheckConfig = boolean;
+/**
+ * Port to listen on
+ */
+export type PortConfig = number;
+/**
+ * Disable additional security checks, so it is possible to use some advanced features, provided by drivers supporting this option. Only enable it if all the clients are in the trusted network and it's not the case if a client could potentially break out of the session sandbox. Specific features can be overridden by using "deny-insecure"
+ */
+export type RelaxedSecurityConfig = boolean;
+/**
+ * Enables session override (clobbering)
+ */
+export type SessionOverrideConfig = boolean;
+/**
+ * Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device
+ */
+export type StrictCapsConfig = boolean;
+/**
+ * Absolute path to directory Appium can use to manage temp files. Defaults to C:\Windows\Temp on Windows and /tmp otherwise.
+ */
+export type TmpConfig = string;
+/**
+ * Absolute path to directory Appium can use to save iOS instrument traces; defaults to <tmp>/appium-instruments
+ */
+export type TraceDirConfig = string;
+/**
+ * A list of drivers to activate. By default, all installed drivers will be activated.
+ */
+export type UseDriversConfig = string[];
+/**
+ * A list of plugins to activate. To activate all plugins, the value should be an array with a single item "all".
+ */
+export type UsePluginsConfig = string[];
+/**
+ * Also send log output to this http listener
+ */
+export type WebhookConfig = string;
+
+/**
+ * A schema for Appium configuration files
+ */
+export interface AppiumConfiguration {
+  server?: ServerConfig;
+}
+/**
+ * Configuration when running Appium as a server
+ */
+export interface ServerConfig {
+  address?: AddressConfig;
+  "allow-cors"?: AllowCorsConfig;
+  "allow-insecure"?: AllowInsecureConfig;
+  "base-path"?: BasePathConfig;
+  "callback-address"?: CallbackAddressConfig;
+  "callback-port"?: CallbackPortConfig;
+  "debug-log-spacing"?: DebugLogSpacingConfig;
+  "default-capabilities"?: DefaultCapabilitiesConfig;
+  "deny-insecure"?: DenyInsecureConfig;
+  driver?: DriverConfig;
+  "keep-alive-timeout"?: KeepAliveTimeoutConfig;
+  "local-timezone"?: LocalTimezoneConfig;
+  log?: LogConfig;
+  "log-filters"?: LogFiltersConfig;
+  "log-level"?: LogLevelConfig;
+  "log-no-colors"?: LogNoColorsConfig;
+  "log-timestamp"?: LogTimestampConfig;
+  "long-stacktrace"?: LongStacktraceConfig;
+  "no-perms-check"?: NoPermsCheckConfig;
+  nodeconfig?: NodeconfigConfig;
+  plugin?: PluginConfig;
+  port?: PortConfig;
+  "relaxed-security"?: RelaxedSecurityConfig;
+  "session-override"?: SessionOverrideConfig;
+  "strict-caps"?: StrictCapsConfig;
+  tmp?: TmpConfig;
+  "trace-dir"?: TraceDirConfig;
+  "use-drivers"?: UseDriversConfig;
+  "use-plugins"?: UsePluginsConfig;
+  webhook?: WebhookConfig;
+}
+/**
+ * Set the default desired capabilities, which will be set on each session unless overridden by received capabilities. If a string, a path to a JSON file containing the capabilities, or raw JSON.
+ */
+export interface DefaultCapabilitiesConfig {
+  [k: string]: unknown;
+}
+/**
+ * Driver-specific configuration. Keys should correspond to driver package names
+ */
+export interface DriverConfig {
+  [k: string]: unknown;
+}
+/**
+ * Path to configuration JSON file to register Appium as a node with Selenium Grid 3; otherwise the configuration itself
+ */
+export interface NodeconfigConfig {
+  [k: string]: unknown;
+}
+/**
+ * Plugin-specific configuration. Keys should correspond to plugin package names
+ */
+export interface PluginConfig {
+  [k: string]: unknown;
+}

package/types/types.d.ts

@@ -0,0 +1,201 @@
+import {transformers} from '../lib/schema/cli-transformers';
+import {SERVER_SUBCOMMAND} from '../lib/cli/parser';
+import {
+  DRIVER_TYPE as DRIVER_SUBCOMMAND,
+  PLUGIN_TYPE as PLUGIN_SUBCOMMAND,
+} from '../lib/ext-config-io';
+import appiumConfigSchema from '../lib/schema/appium-config-schema';
+import {AppiumConfiguration, ServerConfig} from './appium-config';
+
+/**
+ * Converts a kebab-cased string into a camel-cased string.
+ */
+export type KebabToCamel<S extends string> =
+  S extends `${infer P1}-${infer P2}${infer P3}`
+    ? `${Lowercase<P1>}${Uppercase<P2>}${KebabToCamel<P3>}`
+    : Lowercase<S>;
+
+/**
+ * Converts an object with kebab-cased keys into camel-cased keys.
+ */
+type ObjectToCamel<T> = {
+  [K in keyof T as KebabToCamel<string & K>]: T[K] extends Record<string, any>
+    ? KeysToCamelCase<T[K]>
+    : T[K];
+};
+
+/**
+ * Converts an object or array to have camel-cased keys.
+ */
+export type KeysToCamelCase<T> = {
+  [K in keyof T as KebabToCamel<string & K>]: T[K] extends Array<any>
+    ? KeysToCamelCase<T[K][number]>[]
+    : ObjectToCamel<T[K]>;
+};
+
+/**
+ * The Appium configuration as it would be in a configuration file.
+ */
+export type AppiumConfig = Partial<AppiumConfiguration>;
+
+/**
+ * Certain properties have an `appiumCliDest` prop, which affects the shape of
+ * {@link ParsedArgs}. This type helps recognize these properties.
+ *
+ * See `../lib/schema/keywords` for definition of `appiumCliDest`.
+ */
+interface WithDest {
+  appiumCliDest: string;
+}
+
+/**
+ * Some properties have a `default` prop, which means practically they will not
+ * be `undefined` upon parsing.
+ *
+ * We use this to ensure that the {@link ParsedArgs} makes guarantees
+ * about the presence of properties.
+ */
+interface WithDefault {
+  default: any;
+}
+
+interface WithCliTransformer {
+  appiumCliTransformer: keyof typeof transformers;
+}
+
+interface WithTypeArray {
+  type: 'array';
+}
+interface WithTypeObject {
+  type: 'object';
+}
+type WithTransformer = WithCliTransformer | WithTypeArray | WithTypeObject;
+
+/**
+ * Derive the "constant" type of the server properties from the schema.
+ */
+type AppiumServerSchema =
+  typeof appiumConfigSchema['properties']['server']['properties'];
+
+/**
+ * Properties of `T` with keys `appiumCliDest` prop _or_ just camel-cased.
+ */
+type NormalizedServerConfig = {
+  [Prop in keyof ServerConfigMapping as AppiumServerSchema[Prop] extends WithDest
+    ? AppiumServerSchema[Prop]['appiumCliDest']
+    : KebabToCamel<Prop>]: ServerConfig[Prop];
+};
+
+/**
+ * "Normalized" config, which is like the flattened config (camel-cased keys),
+ * but not flattened.
+ */
+export type NormalizedAppiumConfig = {
+  server: NormalizedServerConfig;
+};
+
+/**
+ * Utility type to associate {@link AppiumServerSchema} with
+ * {@link ServerConfig}.
+ */
+type ServerConfigMapping = {
+  [Prop in keyof Required<ServerConfig>]: AppiumServerSchema[Prop];
+};
+
+/**
+ * This type checks if `appiumCliDest` is present in the object via
+ * {@link WithDest}, and uses the _value_ of that property for the key name;
+ * otherwise uses the camel-cased value of the key name.
+ */
+type SetKeyForProp<Prop extends keyof ServerConfigMapping> =
+  AppiumServerSchema[Prop] extends WithDest
+    ? AppiumServerSchema[Prop]['appiumCliDest']
+    : KebabToCamel<Prop>;
+
+/**
+ * Checks for the existence of default values, and ensures those properties will
+ * be defined (eliminate `| undefined` from the type).
+ */
+type DefaultForProp<Prop extends keyof ServerConfigMapping> =
+  AppiumServerSchema[Prop] extends WithDefault
+    ? NonNullable<ServerConfig[Prop]>
+    : ServerConfig[Prop];
+
+/**
+ * The final shape of the parsed CLI arguments.
+ */
+type ParsedArgsFromConfig = {
+  [Prop in keyof ServerConfigMapping as SetKeyForProp<Prop>]: DefaultForProp<Prop>;
+};
+
+/**
+ * Possible subcommands for the `appium` CLI.
+ */
+type CliSubCommands =
+  | typeof SERVER_SUBCOMMAND
+  | typeof DRIVER_SUBCOMMAND
+  | typeof PLUGIN_SUBCOMMAND;
+
+/**
+ * Possible subcommands of {@link DRIVER_SUBCOMMAND} or
+ * {@link PLUGIN_SUBCOMMAND}.
+ */
+type CliExtensionSubcommands =
+  | 'list'
+  | 'install'
+  | 'uninstall'
+  | 'update'
+  | 'run';
+
+/**
+ * Random stuff that may appear in the parsed args which has no equivalent in a
+ * config file.
+ */
+interface MoreArgs {
+  /**
+   * Path to config file, if any
+   */
+  configFile: string;
+
+  /**
+   * If true, show the build info and exit
+   */
+  showConfig: boolean;
+
+  /**
+   * If true, open a REPL
+   */
+  shell: boolean;
+
+  /**
+   * If true, throw on error instead of exit. Not supported via CLI, but rather
+   * only programmatic usage.
+   */
+  throwInsteadOfExit: boolean;
+
+  /**
+   * Possible subcommands
+   */
+  subcommand:
+    | typeof DRIVER_SUBCOMMAND
+    | typeof PLUGIN_SUBCOMMAND
+    | typeof SERVER_SUBCOMMAND;
+
+  /**
+   * Subcommands of `driver` subcommand
+   */
+  driverCommand: CliExtensionSubcommands;
+
+  /**
+   * Subcommands of `plugin` subcommand
+   */
+  pluginCommand: CliExtensionSubcommands;
+}
+
+/**
+ * The Appium configuration as a flattened object, parsed via CLI args _and_ any
+ * CLI args unsupported by the config file.
+ * @todo Does not make any assumptions about property names derived from
+ * extensions.
+ */
+export type ParsedArgs = ParsedArgsFromConfig & Partial<MoreArgs>;