appium 2.0.0-beta.46 → 2.0.0-beta.48

package/lib/main.js

@@ -23,10 +23,17 @@ import {
 } from './config';
 import {readConfigFile} from './config-file';
 import {loadExtensions, getActivePlugins, getActiveDrivers} from './extension';
-import {DRIVER_TYPE, PLUGIN_TYPE, SERVER_SUBCOMMAND} from './constants';
+import {SERVER_SUBCOMMAND} from './constants';
 import registerNode from './grid-register';
 import {getDefaultsForSchema, validate} from './schema/schema';
-import {inspect, adjustNodePath} from './utils';
+import {
+  inspect,
+  adjustNodePath,
+  isDriverCommandArgs,
+  isExtensionCommandArgs,
+  isPluginCommandArgs,
+  isServerCommandArgs,
+} from './utils';
 
 const {resolveAppiumHome} = env;
 
@@ -143,16 +150,6 @@ function getExtraMethodMap(driverClasses, pluginClasses) {
     {}
   );
 }
-
-/**
- * @template [T=WithServerSubcommand]
- * @param {Args<T>} args
- * @returns {args is Args<WithServerSubcommand>}
- */
-function areServerCommandArgs(args) {
-  return args.subcommand === SERVER_SUBCOMMAND;
-}
-
 /**
  * Initializes Appium, but does not start the server.
  *
@@ -160,9 +157,10 @@ function areServerCommandArgs(args) {
  *
  * If `args` contains a non-empty `subcommand` which is not `server`, this function will return an empty object.
  *
- * @template [T=WithServerSubcommand]
- * @param {Args<T>} [args] - Partial args (progammatic usage only)
- * @returns {Promise<ServerInitResult | ExtCommandInitResult>}
+ * @template {CliCommand} [Cmd=ServerCommand]
+ * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @param {Args<Cmd, SubCmd>} [args] - Partial args (progammatic usage only)
+ * @returns {Promise<InitResult<Cmd>>}
  * @example
  * import {init, getSchema} from 'appium';
  * const options = {}; // config object
@@ -178,7 +176,7 @@ async function init(args) {
 
   const parser = getParser();
   let throwInsteadOfExit = false;
-  /** @type {Args<T>} */
+  /** @type {Args<Cmd, SubCmd>} */
   let preConfigArgs;
 
   if (args) {
@@ -193,7 +191,7 @@ async function init(args) {
     preConfigArgs = {...args, subcommand: args.subcommand ?? SERVER_SUBCOMMAND};
   } else {
     // otherwise parse from CLI
-    preConfigArgs = /** @type {Args<T>} */ (parser.parseArgs());
+    preConfigArgs = /** @type {Args<Cmd, SubCmd>} */ (parser.parseArgs());
   }
 
   const configResult = await readConfigFile(preConfigArgs.configFile);
@@ -211,15 +209,15 @@ async function init(args) {
   // 1. command line args
   // 2. config file
   // 3. defaults from config file.
-  if (areServerCommandArgs(preConfigArgs)) {
+  if (isServerCommandArgs(preConfigArgs)) {
     const defaults = getDefaultsForSchema(false);
 
     /** @type {ParsedArgs} */
-    const serverArgs = _.defaultsDeep(preConfigArgs, configResult.config?.server, defaults);
+    const serverArgs = _.defaultsDeep({}, preConfigArgs, configResult.config?.server, defaults);
 
     if (preConfigArgs.showConfig) {
       showConfig(getNonDefaultServerArgs(preConfigArgs), configResult, defaults, serverArgs);
-      return {};
+      return /** @type {InitResult<Cmd>} */ ({});
     }
 
     await logsinkInit(serverArgs);
@@ -252,49 +250,49 @@ async function init(args) {
     appiumDriver.driverConfig = driverConfig;
     await preflightChecks(serverArgs, throwInsteadOfExit);
 
-    return /** @type {ServerInitResult} */ ({
+    return /** @type {InitResult<Cmd>} */ ({
       appiumDriver,
       parsedArgs: serverArgs,
       driverConfig,
       pluginConfig,
     });
   } else {
-    const extensionCommandArgs = /** @type {Args<import('appium/types').WithExtSubcommand>} */ (
-      preConfigArgs
-    );
-    // if the user has requested the 'driver' CLI, don't run the normal server,
-    // but instead pass control to the driver CLI
-    if (preConfigArgs.subcommand === DRIVER_TYPE) {
-      await runExtensionCommand(extensionCommandArgs, driverConfig);
-      return {};
-    }
-    if (preConfigArgs.subcommand === PLUGIN_TYPE) {
-      await runExtensionCommand(extensionCommandArgs, pluginConfig);
-      return {};
+    if (isExtensionCommandArgs(preConfigArgs)) {
+      // if the user has requested the 'driver' CLI, don't run the normal server,
+      // but instead pass control to the driver CLI
+      if (isDriverCommandArgs(preConfigArgs)) {
+        await runExtensionCommand(preConfigArgs, driverConfig);
+      }
+      if (isPluginCommandArgs(preConfigArgs)) {
+        await runExtensionCommand(preConfigArgs, pluginConfig);
+      }
     }
-    /* istanbul ignore next */
-    return {}; // should never happen
+    return /** @type {InitResult<Cmd>} */ ({});
   }
 }
 
 /**
  * Initializes Appium's config.  Starts server if appropriate and resolves the
  * server instance if so; otherwise resolves w/ `undefined`.
- * @template [T=WithServerSubcommand]
- * @param {Args<T>} [args] - Arguments from CLI or otherwise
- * @returns {Promise<import('@appium/types').AppiumServer|undefined>}
+ * @template {CliCommand} [Cmd=ServerCommand]
+ * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @param {Args<Cmd, SubCmd>} [args] - Arguments from CLI or otherwise
+ * @returns {Promise<Cmd extends ServerCommand ? import('@appium/types').AppiumServer : void>}
  */
 async function main(args) {
-  const {appiumDriver, parsedArgs, pluginConfig, driverConfig} = /** @type {ServerInitResult} */ (
-    await init(args)
-  );
+  const initResult = await init(args);
 
-  if (!appiumDriver || !parsedArgs || !pluginConfig || !driverConfig) {
+  if (_.isEmpty(initResult)) {
     // if this branch is taken, we've run a different subcommand, so there's nothing
     // left to do here.
-    return;
+    return /** @type {Cmd extends ServerCommand ? import('@appium/types').AppiumServer : void} */ (
+      undefined
+    );
   }
 
+  const {appiumDriver, pluginConfig, driverConfig, parsedArgs} =
+    /** @type {InitResult<ServerCommand>} */ (initResult);
+
   const pluginClasses = getActivePlugins(pluginConfig, parsedArgs.usePlugins);
   // set the active plugins on the umbrella driver so it can use them for commands
   appiumDriver.pluginClasses = pluginClasses;
@@ -377,7 +375,9 @@ async function main(args) {
   driverConfig.print();
   pluginConfig.print([...pluginClasses.values()]);
 
-  return server;
+  return /** @type {Cmd extends ServerCommand ? import('@appium/types').AppiumServer : void} */ (
+    server
+  );
 }
 
 // NOTE: this is here for backwards compat for any scripts referencing `main.js` directly
@@ -397,7 +397,12 @@ export {main, init, resolveAppiumHome};
  * @typedef {import('@appium/types').PluginType} PluginType
  * @typedef {import('@appium/types').DriverClass} DriverClass
  * @typedef {import('@appium/types').PluginClass} PluginClass
- * @typedef {import('appium/types').WithServerSubcommand} WithServerSubcommand
+ * @typedef {import('appium/types').CliCommand} CliCommand
+ * @typedef {import('appium/types').CliExtensionSubcommand} CliExtensionSubcommand
+ * @typedef {import('appium/types').CliExtensionCommand} CliExtensionCommand
+ * @typedef {import('appium/types').ServerCommand} ServerCommand
+ * @typedef {import('appium/types').DriverCommand} DriverCommand
+ * @typedef {import('appium/types').PluginCommand} PluginCommand
  * @typedef {import('./extension').DriverNameMap} DriverNameMap
  * @typedef {import('./extension').PluginNameMap} PluginNameMap
  */
@@ -414,15 +419,18 @@ export {main, init, resolveAppiumHome};
  */
 
 /**
- * @typedef {ServerInitData & import('./extension').ExtensionConfigs} ServerInitResult
+ * @template {CliCommand} Cmd
+ * @typedef {Cmd extends ServerCommand ? ServerInitData & import('./extension').ExtensionConfigs : ExtCommandInitResult} InitResult
  */
 
 /**
- * @template [T=WithServerSubcommand]
- * @typedef {import('appium/types').Args<T>} Args
+ * @template {CliCommand} [Cmd=ServerCommand]
+ * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @typedef {import('appium/types').Args<Cmd, SubCmd>} Args
  */
 
 /**
- * @template [T=WithServerSubcommand]
- * @typedef {import('appium/types').ParsedArgs<T>} ParsedArgs
+ * @template {CliCommand} [Cmd=ServerCommand]
+ * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @typedef {import('appium/types').ParsedArgs<Cmd, SubCmd>} ParsedArgs
  */

package/lib/schema/schema.js

@@ -43,6 +43,8 @@ export class RoachHotelMap extends Map {
  */
 export const ALLOWED_SCHEMA_EXTENSIONS = new Set(['.json', '.js', '.cjs']);
 
+const SCHEMA_KEY = '$schema';
+
 /**
  * A wrapper around Ajv and schema-related functions.
  *
@@ -316,7 +318,7 @@ class AppiumSchema {
     }
     const normalizedExtName = _.kebabCase(extName);
     if (this.hasRegisteredSchema(extType, normalizedExtName)) {
-      if (this._registeredSchemas[extType].get(normalizedExtName) === schema) {
+      if (_.isEqual(this._registeredSchemas[extType].get(normalizedExtName), schema)) {
         return;
       }
       throw new SchemaNameConflictError(extType, extName);
@@ -441,6 +443,9 @@ class AppiumSchema {
     for (const {properties, prefix} of stack) {
       const pairs = _.toPairs(properties);
       for (const [key, value] of pairs) {
+        if (key === SCHEMA_KEY) {
+          continue;
+        }
         const {properties, $ref} = value;
         if (properties) {
           stack.push({

package/lib/utils.js

@@ -4,6 +4,7 @@ import {processCapabilities, PROTOCOLS, STANDARD_CAPS} from '@appium/base-driver
 import {inspect as dump} from 'util';
 import {node} from '@appium/support';
 import path from 'path';
+import {SERVER_SUBCOMMAND, DRIVER_TYPE, PLUGIN_TYPE} from './constants';
 
 const W3C_APPIUM_PREFIX = 'appium';
 const STANDARD_CAPS_LOWERCASE = new Set([...STANDARD_CAPS].map((cap) => cap.toLowerCase()));
@@ -289,6 +290,46 @@ function pullSettings(caps) {
   return result;
 }
 
+/**
+ * @template {CliCommand} [Cmd=ServerCommand]
+ * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @param {Args<Cmd, SubCmd>} args
+ * @returns {args is Args<ServerCommand>}
+ */
+export function isServerCommandArgs(args) {
+  return args.subcommand === SERVER_SUBCOMMAND;
+}
+
+/**
+ * @template {CliCommand} [Cmd=ServerCommand]
+ * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @param {Args<Cmd, SubCmd>} args
+ * @returns {args is Args<CliExtensionCommand, SubCmd>}
+ */
+export function isExtensionCommandArgs(args) {
+  return args.subcommand === DRIVER_TYPE || args.subcommand === PLUGIN_TYPE;
+}
+
+/**
+ * @template {CliCommand} Cmd
+ * @template {CliExtensionSubcommand} SubCmd
+ * @param {Args<Cmd, SubCmd>} args
+ * @returns {args is Args<DriverCommand, SubCmd>}
+ */
+export function isDriverCommandArgs(args) {
+  return args.subcommand === DRIVER_TYPE;
+}
+
+/**
+ * @template {CliCommand} Cmd
+ * @template {CliExtensionSubcommand} SubCmd
+ * @param {Args<Cmd, SubCmd>} args
+ * @returns {args is Args<PluginCommand, SubCmd>}
+ */
+export function isPluginCommandArgs(args) {
+  return args.subcommand === PLUGIN_TYPE;
+}
+
 export {
   inspect,
   parseCapsForInnerDriver,
@@ -357,3 +398,24 @@ export {
 /**
  * @typedef {import('@appium/types').Constraints} Constraints
  */
+
+/**
+ * @typedef {import('appium/types').CliCommand} CliCommand
+ * @typedef {import('appium/types').CliExtensionSubcommand} CliExtensionSubcommand
+ * @typedef {import('appium/types').CliExtensionCommand} CliExtensionCommand
+ * @typedef {import('appium/types').ServerCommand} ServerCommand
+ * @typedef {import('appium/types').DriverCommand} DriverCommand
+ * @typedef {import('appium/types').PluginCommand} PluginCommand
+ */
+
+/**
+ * @template {CliCommand} [Cmd=ServerCommand]
+ * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @typedef {import('appium/types').Args<Cmd, SubCmd>} Args
+ */
+
+/**
+ * @template {CliCommand} [Cmd=ServerCommand]
+ * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @typedef {import('appium/types').ParsedArgs<Cmd, SubCmd>} ParsedArgs
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "2.0.0-beta.46",
+  "version": "2.0.0-beta.48",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -41,45 +41,41 @@
     "types"
   ],
   "scripts": {
-    "build": "babel lib --root-mode=upward --out-dir=build/lib",
     "build:docs": "node docs/scripts/build-docs.js",
-    "build:docs:cli": "node docs/scripts/gen-cli-args-docs.js",
     "build:docs:assets": "node docs/scripts/copy-assets.js",
-    "dev": "npm run build -- --watch",
+    "build:docs:cli": "node docs/scripts/gen-cli-args-docs.js",
+    "build:docs:reference": "node docs/scripts/build-reference.js",
     "dev:docs": "npm run build:docs:assets && npm run dev:docs:en",
     "dev:docs:en": "mkdocs serve -f ./docs/mkdocs-en.yml",
     "dev:docs:ja": "mkdocs serve -f ./docs/mkdocs-ja.yml",
     "dev:docs:zh": "mkdocs serve -f ./docs/mkdocs-zh.yml",
-    "fix": "npm run lint -- --fix",
     "postinstall": "node ./scripts/autoinstall-extensions.js",
-    "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore .",
-    "prepare": "npm run build",
     "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 -p --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": "^8.7.3",
-    "@appium/base-plugin": "^1.10.5",
-    "@appium/docutils": "^0.0.13",
-    "@appium/schema": "^0.0.9",
-    "@appium/support": "^2.61.1",
-    "@appium/types": "^0.5.0",
+    "@appium/base-driver": "^9.1.0",
+    "@appium/base-plugin": "^2.0.1",
+    "@appium/docutils": "^0.1.1",
+    "@appium/schema": "^0.1.0",
+    "@appium/support": "^3.0.1",
+    "@appium/types": "^0.7.0",
     "@sidvind/better-ajv-errors": "2.1.0",
     "@types/argparse": "2.0.10",
-    "@types/bluebird": "3.5.37",
+    "@types/bluebird": "3.5.38",
     "@types/fancy-log": "2.0.0",
-    "@types/semver": "7.3.12",
-    "@types/teen_process": "1.16.1",
+    "@types/semver": "7.3.13",
+    "@types/teen_process": "2.0.0",
     "@types/wrap-ansi": "3.0.0",
-    "ajv": "8.11.0",
+    "ajv": "8.11.2",
     "ajv-formats": "2.1.1",
     "argparse": "2.0.1",
-    "async-lock": "1.3.2",
-    "asyncbox": "2.9.2",
-    "axios": "0.27.2",
+    "async-lock": "1.4.0",
+    "asyncbox": "2.9.4",
+    "axios": "1.2.1",
     "bluebird": "3.7.2",
     "cross-env": "7.0.3",
     "find-up": "5.0.0",
@@ -87,25 +83,28 @@
     "lilconfig": "2.0.6",
     "lodash": "4.17.21",
     "longjohn": "0.2.12",
-    "npmlog": "6.0.2",
+    "npmlog": "7.0.1",
     "ora": "5.4.1",
     "package-changed": "1.9.0",
     "resolve-from": "5.0.0",
     "semver": "7.3.8",
     "source-map-support": "0.5.21",
     "teen_process": "2.0.2",
-    "type-fest": "3.1.0",
+    "type-fest": "3.4.0",
     "winston": "3.8.2",
     "wrap-ansi": "7.0.0",
     "yaml": "2.1.3"
   },
   "engines": {
-    "node": ">=14",
+    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
     "npm": ">=8"
   },
   "publishConfig": {
     "access": "public",
     "tag": "next"
   },
-  "gitHead": "6b3cc1a8743f78c1f50320364f25f3011d2b2136"
+  "gitHead": "2e76ba9607729f59ca967e47c2cba738e90a57b8",
+  "typedoc": {
+    "entryPoint": "./build/lib/main.js"
+  }
 }

package/scripts/autoinstall-extensions.js

@@ -14,10 +14,24 @@
  * code upon failure (which will typically break a build).  Otherwise, it
  * will always exit with code 0, even if errors occur.
  *
+ * @module
  * @example
  * `npm install -g appium --drivers=uiautomator2,xcuitest --plugins=images`
  */
 
+const path = require('path');
+const {exec} = require('teen_process');
+const B = require('bluebird');
+
+B.config({
+  cancellation: true,
+});
+
+/**
+ * This is only used if we're actually in the monorepo
+ */
+const MONOREPO_ROOT = path.join(__dirname, '..', '..', '..');
+
 /** @type {import('../lib/cli/extension').runExtensionCommand} */
 let runExtensionCommand;
 /** @type {import('../lib/constants').DRIVER_TYPE} */
@@ -27,44 +41,82 @@ let PLUGIN_TYPE;
 /** @type {import('../lib/extension').loadExtensions} */
 let loadExtensions;
 
-const {env, util, logger} = require('@appium/support');
 const _ = require('lodash');
 const wrap = _.partial(
   require('wrap-ansi'),
   _,
-  process.stderr.columns ?? process.stdout.columns ?? 25
+  process.stderr.columns ?? process.stdout.columns ?? 80
 );
-
 const ora = require('ora');
 
-const log = (message) => {
+let env, util, logger;
+
+function log(message) {
   console.error(wrap(`[Appium] ${message}`));
-};
-
-const spinner = ora({
-  text: 'Checking Appium installation...',
-  prefixText: '[Appium]',
-}).start();
-
-try {
-  ({runExtensionCommand} = require('../build/lib/cli/extension'));
-  ({DRIVER_TYPE, PLUGIN_TYPE} = require('../build/lib/constants'));
-  ({loadExtensions} = require('../build/lib/extension'));
-  spinner.succeed('Appium installation OK');
-  // suppress logs from Appium, which mess up the script output
-  logger.getLogger('Appium').level = 'error';
-} catch (e) {
-  spinner.fail(`Could not load required module(s); has Appium been built? (${e.message})`);
-  if (process.env.CI) {
-    console.error('Detected CI environment, exiting with code 1');
-    process.exitCode = 1;
-  } else {
-    process.exitCode = 0;
+}
+
+async function init() {
+  /** @type {import('ora').Ora} */
+  let spinner;
+
+  try {
+    ({env, util, logger} = require('@appium/support'));
+    require('..');
+  } catch {
+    spinner = ora({
+      text: 'Building Appium dev environment...',
+      prefixText: '[Appium]',
+    }).start();
+
+    try {
+      const {stderr, code} = await exec('npm', ['run', 'build'], {
+        cwd: MONOREPO_ROOT,
+        encoding: 'utf8',
+      });
+      if (!code) {
+        spinner.succeed('Appium build successfully.');
+      } else {
+        spinner.fail(`Building Appium failed!`);
+        log(stderr);
+      }
+    } catch (err) {
+      spinner.fail(`Building Appium failed!`);
+      log(err);
+    }
+  }
+
+  spinner = ora({
+    text: 'Checking Appium installation...',
+    prefixText: '[Appium]',
+  }).start();
+
+  try {
+    ({env, util, logger} = require('@appium/support'));
+    ({runExtensionCommand} = require('../build/lib/cli/extension'));
+    ({DRIVER_TYPE, PLUGIN_TYPE} = require('../build/lib/constants'));
+    ({loadExtensions} = require('../build/lib/extension'));
+    spinner.succeed('Appium installation OK');
+    // suppress logs from Appium, which mess up the script output
+    logger.getLogger('Appium').level = 'error';
+  } catch (e) {
+    spinner.fail(`Could not load required module(s); has Appium been built? (${e.message})`);
+    if (process.env.CI) {
+      log('Detected CI environment, exiting with code 1');
+      process.exitCode = 1;
+    } else {
+      process.exitCode = 0;
+    }
+    return false;
   }
-  process.exit();
+
+  return true;
 }
 
 async function main() {
+  if (!(await init())) {
+    return;
+  }
+
   // if we're doing `npm install -g appium` then we will assume we don't have a local appium.
   if (!process.env.npm_config_global && (await env.hasAppiumDependency())) {
     log(`Found local Appium installation; skipping automatic installation of extensions.`);