appium 2.0.0-beta.2 → 2.0.0-beta.23

package/lib/utils.js

@@ -1,7 +1,7 @@
 import _ from 'lodash';
 import logger from './logger';
-import { processCapabilities, PROTOCOLS } from 'appium-base-driver';
-import findRoot from 'find-root';
+import { processCapabilities, PROTOCOLS } from '@appium/base-driver';
+import { fs } from '@appium/support';
 
 const W3C_APPIUM_PREFIX = 'appium';
 
@@ -47,19 +47,19 @@ function parseCapsForInnerDriver (jsonwpCapabilities, w3cCapabilities, constrain
   const hasW3CCaps = _.isPlainObject(w3cCapabilities) &&
     (_.has(w3cCapabilities, 'alwaysMatch') || _.has(w3cCapabilities, 'firstMatch'));
   const hasJSONWPCaps = _.isPlainObject(jsonwpCapabilities);
-  let protocol = null;
   let desiredCaps = {};
   let processedW3CCapabilities = null;
   let processedJsonwpCapabilities = null;
 
-  if (!hasJSONWPCaps && !hasW3CCaps) {
+  if (!hasW3CCaps) {
     return {
       protocol: PROTOCOLS.W3C,
-      error: new Error('Either JSONWP or W3C capabilities should be provided'),
+      error: new Error('W3C capabilities should be provided'),
     };
   }
 
-  const {W3C, MJSONWP} = PROTOCOLS;
+  const {W3C} = PROTOCOLS;
+  const protocol = W3C;
 
   // Make sure we don't mutate the original arguments
   jsonwpCapabilities = _.cloneDeep(jsonwpCapabilities);
@@ -101,56 +101,24 @@ function parseCapsForInnerDriver (jsonwpCapabilities, w3cCapabilities, constrain
 
   // Get MJSONWP caps
   if (hasJSONWPCaps) {
-    protocol = MJSONWP;
-    desiredCaps = jsonwpCapabilities;
     processedJsonwpCapabilities = {...jsonwpCapabilities};
   }
 
   // Get W3C caps
   if (hasW3CCaps) {
-    protocol = W3C;
     // Call the process capabilities algorithm to find matching caps on the W3C
     // (see: https://github.com/jlipps/simple-wd-spec#processing-capabilities)
-    let isFixingNeededForW3cCaps = false;
     try {
       desiredCaps = processCapabilities(w3cCapabilities, constraints, true);
     } catch (error) {
-      if (!hasJSONWPCaps) {
-        return {
-          desiredCaps,
-          processedJsonwpCapabilities,
-          processedW3CCapabilities,
-          protocol,
-          error,
-        };
-      }
       logger.info(`Could not parse W3C capabilities: ${error.message}`);
-      isFixingNeededForW3cCaps = true;
-    }
-
-    if (hasJSONWPCaps && !isFixingNeededForW3cCaps) {
-      const differingKeys = _.difference(_.keys(removeAppiumPrefixes(processedJsonwpCapabilities)), _.keys(removeAppiumPrefixes(desiredCaps)));
-      if (!_.isEmpty(differingKeys)) {
-        logger.info(`The following capabilities were provided in the JSONWP desired capabilities that are missing ` +
-          `in W3C capabilities: ${JSON.stringify(differingKeys)}`);
-        isFixingNeededForW3cCaps = true;
-      }
-    }
-
-    if (isFixingNeededForW3cCaps && hasJSONWPCaps) {
-      logger.info('Trying to fix W3C capabilities by merging them with JSONWP caps');
-      w3cCapabilities = fixW3cCapabilities(w3cCapabilities, jsonwpCapabilities);
-      try {
-        desiredCaps = processCapabilities(w3cCapabilities, constraints, true);
-      } catch (error) {
-        logger.warn(`Could not parse fixed W3C capabilities: ${error.message}. Falling back to JSONWP protocol`);
-        return {
-          desiredCaps: processedJsonwpCapabilities,
-          processedJsonwpCapabilities,
-          processedW3CCapabilities: null,
-          protocol: MJSONWP,
-        };
-      }
+      return {
+        desiredCaps,
+        processedJsonwpCapabilities,
+        processedW3CCapabilities,
+        protocol,
+        error,
+      };
     }
 
     // Create a new w3c capabilities payload that contains only the matching caps in `alwaysMatch`
@@ -163,47 +131,6 @@ function parseCapsForInnerDriver (jsonwpCapabilities, w3cCapabilities, constrain
   return {desiredCaps, processedJsonwpCapabilities, processedW3CCapabilities, protocol};
 }
 
-/**
- * This helper method tries to fix corrupted W3C capabilities by
- * merging them to existing JSONWP capabilities.
- *
- * @param {Object} w3cCaps W3C capabilities
- * @param {Object} jsonwpCaps JSONWP capabilities
- * @return {Object} Fixed W3C capabilities
- */
-function fixW3cCapabilities (w3cCaps, jsonwpCaps) {
-  const result = {
-    firstMatch: w3cCaps.firstMatch || [],
-    alwaysMatch: w3cCaps.alwaysMatch || {},
-  };
-  const keysToInsert = _.keys(jsonwpCaps);
-  const removeMatchingKeys = (match) => {
-    _.pull(keysToInsert, match);
-    const colonIndex = match.indexOf(':');
-    if (colonIndex >= 0 && match.length > colonIndex) {
-      _.pull(keysToInsert, match.substring(colonIndex + 1));
-    }
-    if (keysToInsert.includes(`${W3C_APPIUM_PREFIX}:${match}`)) {
-      _.pull(keysToInsert, `${W3C_APPIUM_PREFIX}:${match}`);
-    }
-  };
-
-  for (const firstMatchEntry of result.firstMatch) {
-    for (const pair of _.toPairs(firstMatchEntry)) {
-      removeMatchingKeys(pair[0]);
-    }
-  }
-
-  for (const pair of _.toPairs(result.alwaysMatch)) {
-    removeMatchingKeys(pair[0]);
-  }
-
-  for (const key of keysToInsert) {
-    result.alwaysMatch[key] = jsonwpCaps[key];
-  }
-  return result;
-}
-
 /**
  * Takes a capabilities objects and prefixes capabilities with `appium:`
  * @param {Object} caps Desired capabilities object
@@ -289,9 +216,36 @@ function pullSettings (caps) {
   return result;
 }
 
-const rootDir = findRoot(__dirname);
+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,
+  getPackageVersion, pullSettings, removeAppiumPrefixes, ReadonlyMap
 };

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "appium",
+  "version": "2.0.0-beta.23",
   "description": "Automation for Apps.",
-  "tags": [
+  "keywords": [
     "automation",
     "javascript",
     "selenium",
@@ -11,102 +12,72 @@
     "firefoxos",
     "testing"
   ],
-  "version": "2.0.0-beta.2",
-  "author": "https://github.com/appium",
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/appium/appium.git"
-  },
   "bugs": {
     "url": "https://github.com/appium/appium/issues"
   },
-  "engines": {
-    "node": ">=8",
-    "npm": ">=6"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/appium/appium.git"
   },
-  "main": "./build/lib/main.js",
+  "license": "Apache-2.0",
+  "author": "https://github.com/appium",
   "bin": {
-    "appium": "./build/lib/main.js"
+    "appium": "index.js"
   },
   "directories": {
-    "lib": "./lib",
-    "doc": "./docs"
+    "lib": "./lib"
   },
   "files": [
     "bin",
     "lib",
-    "build/lib",
-    "npm-shrinkwrap.json"
+    "build",
+    "index.js",
+    "postinstall.js",
+    "types"
   ],
-  "dependencies": {
-    "@appium/base-plugin": "^1.0.0",
-    "@babel/runtime": "^7.6.0",
-    "appium-base-driver": "^7.0.0",
-    "appium-support": "2.x",
-    "argparse": "^1.0.10",
-    "async-lock": "^1.0.0",
-    "asyncbox": "2.x",
-    "axios": "^0.20.0",
-    "bluebird": "3.x",
-    "continuation-local-storage": "3.x",
-    "dateformat": "^3.0.3",
-    "find-root": "^1.1.0",
-    "lodash": "^4.17.11",
-    "longjohn": "^0.2.12",
-    "npmlog": "4.x",
-    "ora": "^4.0.4",
-    "semver": "^7.0.0",
-    "source-map-support": "0.x",
-    "teen_process": "1.x",
-    "winston": "3.x",
-    "word-wrap": "^1.2.3",
-    "yaml": "^1.7.2"
-  },
   "scripts": {
-    "clean": "rm -rf node_modules && rm -f package-lock.json && npm install",
-    "prepare": "gulp prepublish",
-    "prepublishOnly": "npm run prune-shrinkwrap && gulp fixShrinkwrap",
-    "postpublish": "npm run restore-shrinkwrap",
-    "prune-shrinkwrap": "!(test -e npm-shrinkwrap.json) || (npm ci --production --ignore-scripts && npm run backup-shrinkwrap && npm shrinkwrap && npm install --only=dev --no-shrinkwrap)",
-    "restore-shrinkwrap": "!(test -e npm-shrinkwrap.json) || (mv npm-shrinkwrap-backup.json npm-shrinkwrap.json)",
-    "backup-shrinkwrap": "mv npm-shrinkwrap.json npm-shrinkwrap-backup.json",
-    "check-pruned-shrinkwrap": "node check-pruned-shrinkwrap.js",
-    "test": "gulp once",
-    "e2e-test": "gulp e2e-test",
-    "watch": "gulp watch",
-    "build": "gulp transpile",
-    "mocha": "mocha",
-    "precommit-msg": "echo 'Pre-commit checks...' && exit 0",
-    "precommit-test": "REPORTER=dot gulp once",
-    "lint": "gulp lint",
-    "lint:fix": "gulp lint --fix",
-    "coverage": "gulp coveralls",
-    "generate-docs": "node ./build/commands-yml/parse.js",
-    "zip": "zip -qr appium.zip .",
+    "generate-docs": "gulp transpile && node ./build/commands-yml/parse.js",
+    "postinstall": "node ./postinstall.js",
     "upload": "gulp github-upload",
-    "zip-and-upload": "npm run zip && npm run upload",
-    "authorize-ios": "authorize-ios"
+    "zip": "zip -qr appium.zip .",
+    "zip-and-upload": "npm run zip && npm run upload"
   },
-  "pre-commit": [
-    "precommit-msg",
-    "precommit-test"
-  ],
-  "devDependencies": {
-    "@appium/fake-plugin": "^0.2.0",
-    "appium-fake-driver": "^1.0.1",
-    "appium-gulp-plugins": "^5.2.1",
-    "chai": "4.x",
-    "chai-as-promised": "7.x",
-    "eslint-config-appium": "^4.0.1",
-    "fancy-log": "^1.3.2",
-    "gulp": "^4.0.0",
-    "handlebars": "^4.2.0",
-    "mocha": "^8.0.1",
-    "pre-commit": "1.x",
-    "sinon": "^9.0.0",
-    "validate.js": "^0.13.0",
-    "wd": "^1.10.0",
-    "yaml-js": "^0.2.0"
-  }
+  "dependencies": {
+    "@appium/base-driver": "^8.2.2",
+    "@appium/base-plugin": "1.8.0",
+    "@appium/support": "^2.55.2",
+    "@babel/runtime": "7.16.3",
+    "@sidvind/better-ajv-errors": "0.9.2",
+    "ajv": "8.8.2",
+    "ajv-formats": "2.1.1",
+    "argparse": "2.0.1",
+    "async-lock": "1.3.0",
+    "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.21",
+    "teen_process": "1.16.0",
+    "winston": "3.3.3",
+    "word-wrap": "1.2.3",
+    "yaml": "1.10.2"
+  },
+  "engines": {
+    "node": ">=12",
+    "npm": ">=6"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "next"
+  },
+  "homepage": "https://appium.io",
+  "gitHead": "280d409df6c02d36b4ffc4d02a95ab3f4649b08c"
 }

package/postinstall.js

@@ -0,0 +1,71 @@
+#!/usr/bin/env node
+/* eslint-disable no-console, promise/prefer-await-to-then */
+
+async function main () {
+  const driverEnv = process.env.npm_config_drivers;
+  const pluginEnv = process.env.npm_config_plugins;
+
+  if (!driverEnv && !pluginEnv) {
+    console.log('Not auto-installing any drivers or plugins');
+    return;
+  }
+
+  let extension;
+  try {
+    extension = require('./build/lib/cli/extension');
+  } catch (e) {
+    throw new Error(`Could not load extension CLI file; has the project been transpiled? ` +
+                    `(${e.message})`);
+  }
+
+  const {DEFAULT_APPIUM_HOME, DRIVER_TYPE, PLUGIN_TYPE} = require('./build/lib/extension-config');
+  const {runExtensionCommand} = extension;
+  const appiumHome = process.env.npm_config_appium_home || DEFAULT_APPIUM_HOME;
+  const specs = [[DRIVER_TYPE, driverEnv], [PLUGIN_TYPE, pluginEnv]];
+
+  for (const [type, extEnv] of specs) {
+    if (extEnv) {
+      for (const ext of extEnv.split(',')) {
+        try {
+          await checkAndInstallExtension({runExtensionCommand, appiumHome, type, ext});
+        } catch (e) {
+          console.log(`There was an error checking and installing ${type} ${ext}: ${e.message}`);
+        }
+      }
+    }
+  }
+}
+
+async function checkAndInstallExtension ({
+  runExtensionCommand,
+  appiumHome,
+  type,
+  ext,
+}) {
+  const extList = await runExtensionCommand({
+    appiumHome,
+    [`${type}Command`]: 'list',
+    showInstalled: true,
+    suppressOutput: true,
+  }, type);
+  if (extList[ext]) {
+    console.log(`The ${type} ${ext} was already installed, skipping...`);
+    return;
+  }
+  console.log(`Installing the ${type} ${ext}...`);
+  await runExtensionCommand({
+    appiumHome,
+    [`${type}Command`]: 'install',
+    [type]: ext,
+    suppressOutput: true,
+  }, type);
+}
+
+if (require.main === module) {
+  main().then(() => {
+    process.exit(0);
+  }).catch((e) => {
+    console.error(e);
+    process.exit(1);
+  });
+}

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;
+}