appium 2.0.0-beta.25 → 2.0.0-beta.26

package/lib/extension/plugin-config.js

@@ -0,0 +1,111 @@
+// @ts-check
+
+import _ from 'lodash';
+import {ExtensionConfig} from './extension-config';
+import log from '../logger';
+import {PLUGIN_TYPE} from '../constants';
+
+/**
+ * @extends {ExtensionConfig<PluginType>}
+ */
+export class PluginConfig extends ExtensionConfig {
+
+  /**
+   * A mapping of {@link Manifest} instances to {@link PluginConfig} instances.
+   *
+   * `Manifest` and {@link ExtensionConfig} have a one-to-many relationship; each `Manifest` should be associated with a `DriverConfig` and a `PluginConfig`; no more, no less.
+   *
+   * This variable tracks the `Manifest`-to-`PluginConfig` portion.
+   *
+   * @type {WeakMap<Manifest,PluginConfig>}
+   * @private
+   */
+   static _instances = new WeakMap();
+
+   /**
+   * Call {@link PluginConfig.create} instead.
+   *
+   * Just calls the superclass' constructor with the correct extension type
+   * @private
+   * @param {import('./manifest').Manifest} manifest - IO object
+   * @param {PluginConfigOptions} [opts]
+   */
+   constructor (manifest, {extData, logFn} = {}) {
+     super(PLUGIN_TYPE, manifest, logFn);
+
+     if (extData) {
+       this.validate(extData);
+     }
+   }
+
+   /**
+    * Creates a new {@link PluginConfig} instance for a {@link Manifest} instance.
+    *
+    * @param {Manifest} manifest
+    * @param {PluginConfigOptions} [opts]
+    * @throws If `manifest` already associated with a `PluginConfig`
+    * @returns {PluginConfig}
+    */
+   static create (manifest, {extData, logFn} = {}) {
+     const instance = new PluginConfig(manifest, {logFn, extData});
+     if (PluginConfig.getInstance(manifest)) {
+       throw new Error(`Manifest with APPIUM_HOME ${manifest.appiumHome} already has a PluginConfig; use PluginConfig.getInstance() to retrieve it.`);
+     }
+     PluginConfig._instances.set(manifest, instance);
+     return instance;
+   }
+
+   /**
+     * Returns a PluginConfig associated with a Manifest
+     * @param {Manifest} manifest
+     * @returns {PluginConfig|undefined}
+     */
+   static getInstance (manifest) {
+     return PluginConfig._instances.get(manifest);
+   }
+   /**
+   * @param {string} pluginName
+   * @param {PluginData} pluginData
+   * @returns {string}
+   */
+   extensionDesc (pluginName, {version}) {
+     return `${pluginName}@${version}`;
+   }
+
+   /**
+   *
+   * @param {(keyof import('./manifest').ExtRecord<PluginType>)[]} activeNames
+   * @returns {void}
+   */
+   print (activeNames) {
+     const pluginNames = Object.keys(this.installedExtensions);
+
+     if (_.isEmpty(pluginNames)) {
+       log.info(`No plugins have been installed. Use the "appium plugin" ` +
+               'command to install the one(s) you want to use.');
+       return;
+     }
+
+     log.info(`Available plugins:`);
+     for (const [pluginName, pluginData] of _.toPairs(this.installedExtensions)) {
+       const activeTxt = _.includes(activeNames, pluginName) ? ' (ACTIVE)' : '';
+       log.info(`  - ${this.extensionDesc(pluginName, pluginData)}${activeTxt}`);
+     }
+
+     if (_.isEmpty(activeNames)) {
+       log.info('No plugins activated. Use the --use-plugins flag with names of plugins to activate');
+     }
+   }
+}
+
+/**
+ * @typedef PluginConfigOptions
+ * @property {import('./extension-config').ExtensionLogFn} [logFn] - Optional logging function
+ * @property {import('./manifest').ExtRecord<PluginType>} [extData] - Extension data
+ */
+
+/**
+ * @typedef {import('./manifest').PluginType} PluginType
+ * @typedef {import('./manifest').ExtData<PluginType>} PluginData
+ * @typedef {import('./manifest').Manifest} Manifest
+ */

package/lib/grid-register.js

@@ -11,10 +11,10 @@ const hubUri = (config) => {
 
 /**
  * Registers a new node with a selenium grid
- * @param {string|object} data - Path or object representing selenium grid node config file
- * @param {string} addr - Bind to this address
- * @param {number} port - Bind to this port
- * @param {string} basePath - Base path for the grid
+ * @param {string|object} data - Path or object representing selenium grid node config file. If a `string`, all subsequent arguments are required!
+ * @param {string} [addr] - Bind to this address
+ * @param {number} [port] - Bind to this port
+ * @param {string} [basePath] - Base path for the grid
  */
 async function registerNode (data, addr, port, basePath) {
   let configFilePath;

package/lib/main.js

@@ -3,24 +3,26 @@
 // transpile:main
 // @ts-check
 
-import logger from './logger'; // logger needs to remain first of imports
+import { init as logsinkInit } from './logsink'; // this import needs to come first since it sets up global npmlog
+import logger from './logger'; // logger needs to remain second
 // @ts-ignore
 import { routeConfiguringFunction as makeRouter, server as baseServer } from '@appium/base-driver';
-import { logger as logFactory, util } from '@appium/support';
+import { logger as logFactory, util, env } from '@appium/support';
 import { asyncify } from 'asyncbox';
 import _ from 'lodash';
 import { AppiumDriver } from './appium';
-import { driverConfig, pluginConfig, USE_ALL_PLUGINS } from './cli/args';
 import { runExtensionCommand } from './cli/extension';
-import { default as getParser, SERVER_SUBCOMMAND } from './cli/parser';
-import { APPIUM_VER, checkNodeOk, getGitRev, getNonDefaultServerArgs, showBuildInfo, validateTmpDir, warnNodeDeprecations, showConfig } from './config';
+import { getParser } from './cli/parser';
+import { APPIUM_VER, checkNodeOk, getGitRev, getNonDefaultServerArgs, showConfig, showBuildInfo, validateTmpDir, warnNodeDeprecations } from './config';
 import { readConfigFile } from './config-file';
-import { DRIVER_TYPE, PLUGIN_TYPE } from './extension-config';
+import { loadExtensions, getActivePlugins, getActiveDrivers } from './extension';
+import { DRIVER_TYPE, PLUGIN_TYPE, SERVER_SUBCOMMAND } from './constants';
 import registerNode from './grid-register';
-import { init as logsinkInit } from './logsink';
-import { getDefaultsForSchema } from './schema/schema';
+import { getDefaultsForSchema, validate } from './schema/schema';
 import { inspect } from './utils';
 
+const {resolveAppiumHome} = env;
+
 /**
  *
  * @param {ParsedArgs} args
@@ -38,6 +40,8 @@ async function preflightChecks (args, throwInsteadOfExit = false) {
     }
     warnNodeDeprecations();
 
+    validate(args);
+
     if (args.tmpDir) {
       await validateTmpDir(args.tmpDir);
     }
@@ -102,63 +106,11 @@ function logServerPort (address, port) {
   logger.info(logMessage);
 }
 
-/**
- * Find any plugin name which has been installed, and which has been requested for activation by
- * using the --use-plugins flag, and turn each one into its class, so we can send them as objects
- * to the server init. We also want to send/assign them to the umbrella driver so it can use them
- * to wrap command execution
- *
- * @param {Object} args - argparser parsed dict
- * @param {import('./plugin-config').default} pluginConfig - a plugin extension config
- * @returns {PluginExtensionClass[]}
- */
-function getActivePlugins (args, pluginConfig) {
-  return _.compact(Object.keys(pluginConfig.installedExtensions).filter((pluginName) =>
-    _.includes(args.usePlugins, pluginName) ||
-    (args.usePlugins.length === 1 && args.usePlugins[0] === USE_ALL_PLUGINS)
-  ).map((pluginName) => {
-    try {
-      logger.info(`Attempting to load plugin ${pluginName}...`);
-      const PluginClass = /** @type {PluginExtensionClass} */(pluginConfig.require(pluginName));
-
-      PluginClass.pluginName = pluginName; // store the plugin name on the class so it can be used later
-      return PluginClass;
-    } catch (err) {
-      logger.error(`Could not load plugin '${pluginName}', so it will not be available. Error ` +
-                   `in loading the plugin was: ${err.message}`);
-      logger.debug(err.stack);
-    }
-  }));
-}
-
-/**
- * Find any driver name which has been installed, and turn each one into its class, so we can send
- * them as objects to the server init in case they need to add methods/routes or update the server.
- * If the --drivers flag was given, this method only loads the given drivers.
- *
- * @param {Object} args - argparser parsed dict
- * @param {import('./driver-config').default} driverConfig - a driver extension config
- */
-function getActiveDrivers (args, driverConfig) {
-  return _.compact(Object.keys(driverConfig.installedExtensions).filter((driverName) =>
-    _.includes(args.useDrivers, driverName) || args.useDrivers.length === 0
-  ).map((driverName) => {
-    try {
-      logger.info(`Attempting to load driver ${driverName}...`);
-      return driverConfig.require(driverName);
-    } catch (err) {
-      logger.error(`Could not load driver '${driverName}', so it will not be available. Error ` +
-                   `in loading the driver was: ${err.message}`);
-      logger.debug(err.stack);
-    }
-  }));
-}
-
 /**
  * Gets a list of `updateServer` functions from all extensions
- * @param {DriverExtensionClass[]} driverClasses
- * @param {PluginExtensionClass[]} pluginClasses
- * @returns {StaticExtMembers['updateServer'][]}
+ * @param {DriverClass[]} driverClasses
+ * @param {PluginClass[]} pluginClasses
+ * @returns {import('./extension/manifest').UpdateServerFn[]}
  */
 function getServerUpdaters (driverClasses, pluginClasses) {
   return _.compact(_.map([...driverClasses, ...pluginClasses], 'updateServer'));
@@ -166,8 +118,8 @@ function getServerUpdaters (driverClasses, pluginClasses) {
 
 /**
  * Makes a big `MethodMap` from all the little `MethodMap`s in the extensions
- * @param {DriverExtensionClass[]} driverClasses
- * @param {PluginExtensionClass[]} pluginClasses
+ * @param {DriverClass[]} driverClasses
+ * @param {PluginClass[]} pluginClasses
  * @returns {import('@appium/base-driver').MethodMap}
  */
 function getExtraMethodMap (driverClasses, pluginClasses) {
@@ -182,11 +134,10 @@ function getExtraMethodMap (driverClasses, pluginClasses) {
  *
  * Use this to get at the configuration schema.
  *
- * If `args` contains a non-empty `subcommand` which is not `server`, this function
- * will resolve with an empty object.
+ * If `args` contains a non-empty `subcommand` which is not `server`, this function will return an empty object.
  *
- * @param {ParsedArgs} [args] - Parsed args
- * @returns {Promise<Partial<{appiumDriver: AppiumDriver, parsedArgs: ParsedArgs}>>}
+ * @param {PartialArgs} [args] - Partial args (progammatic usage only)
+ * @returns {Promise<ServerInitResult | ExtCommandInitResult>}
  * @example
  * import {init, getSchema} from 'appium';
  * const options = {}; // config object
@@ -194,11 +145,15 @@ function getExtraMethodMap (driverClasses, pluginClasses) {
  * const schema = getSchema(); // entire config schema including plugins and drivers
  */
 async function init (args) {
-  const parser = await getParser();
+  const appiumHome = args?.appiumHome ?? await resolveAppiumHome();
+
+  const {driverConfig, pluginConfig} = await loadExtensions(appiumHome);
+
+  const parser = getParser();
   let throwInsteadOfExit = false;
   /** @type {ParsedArgs} */
   let preConfigParsedArgs;
-  /** @type {typeof preConfigParsedArgs & import('type-fest').AsyncReturnType<readConfigFile>['config']} */
+  /** @type {ParsedArgs} */
   let parsedArgs;
   /**
    * This is a definition (instead of declaration) because TS can't figure out
@@ -215,7 +170,7 @@ async function init (args) {
       // but remove it since it's not a real server arg per se
       delete args.throwInsteadOfExit;
     }
-    preConfigParsedArgs = {...args, subcommand: args.subcommand ?? SERVER_SUBCOMMAND};
+    preConfigParsedArgs = /** @type {ParsedArgs} */({...args, subcommand: args.subcommand ?? SERVER_SUBCOMMAND});
   } else {
     // otherwise parse from CLI
     preConfigParsedArgs = parser.parseArgs();
@@ -227,7 +182,6 @@ async function init (args) {
     throw new Error(`Errors in config file ${configResult.filepath}:\n ${configResult.reason ?? configResult.errors}`);
   }
 
-
   // merge config and apply defaults.
   // the order of precendece is:
   // 1. command line args
@@ -256,11 +210,11 @@ async function init (args) {
   // if the user has requested the 'driver' CLI, don't run the normal server,
   // but instead pass control to the driver CLI
   if (parsedArgs.subcommand === DRIVER_TYPE) {
-    await runExtensionCommand(parsedArgs, parsedArgs.subcommand, driverConfig);
+    await runExtensionCommand(parsedArgs, driverConfig);
     return {};
   }
   if (parsedArgs.subcommand === PLUGIN_TYPE) {
-    await runExtensionCommand(parsedArgs, parsedArgs.subcommand, pluginConfig);
+    await runExtensionCommand(parsedArgs, pluginConfig);
     return {};
   }
 
@@ -282,32 +236,32 @@ async function init (args) {
   appiumDriver.driverConfig = driverConfig;
   await preflightChecks(parsedArgs, throwInsteadOfExit);
 
-  return {appiumDriver, parsedArgs};
+  return /** @type {ServerInitResult} */({appiumDriver, parsedArgs, driverConfig, pluginConfig});
 }
 
 /**
  * Initializes Appium's config.  Starts server if appropriate and resolves the
  * server instance if so; otherwise resolves w/ `undefined`.
- * @param {ParsedArgs} [args] - Arguments from CLI or otherwise
- * @returns {Promise<import('express').Express|undefined>}
+ * @param {PartialArgs} [args] - Arguments from CLI or otherwise
+ * @returns {Promise<import('http').Server|undefined>}
  */
 async function main (args) {
-  const {appiumDriver, parsedArgs} = await init(args);
+  const {appiumDriver, parsedArgs, pluginConfig, driverConfig} = /** @type {ServerInitResult} */(await init(args));
 
-  if (!appiumDriver || !parsedArgs) {
+  if (!appiumDriver || !parsedArgs || !pluginConfig || !driverConfig) {
     // if this branch is taken, we've run a different subcommand, so there's nothing
     // left to do here.
     return;
   }
 
-  const pluginClasses = getActivePlugins(parsedArgs, pluginConfig);
+  const pluginClasses = getActivePlugins(pluginConfig, parsedArgs.usePlugins);
   // set the active plugins on the umbrella driver so it can use them for commands
   appiumDriver.pluginClasses = pluginClasses;
 
   await logStartupInfo(parsedArgs);
   let routeConfiguringFunction = makeRouter(appiumDriver);
 
-  const driverClasses = getActiveDrivers(parsedArgs, driverConfig);
+  const driverClasses = getActiveDrivers(driverConfig, parsedArgs.useDrivers);
   const serverUpdaters = getServerUpdaters(driverClasses, pluginClasses);
   const extraMethodMap = getExtraMethodMap(driverClasses, pluginClasses);
 
@@ -382,23 +336,32 @@ if (require.main === module) {
 }
 
 // everything below here is intended to be a public API.
-export { main, init };
-export { APPIUM_HOME } from './extension-config';
-export { getSchema, validate, finalizeSchema } from './schema/schema';
 export { readConfigFile } from './config-file';
+export { finalizeSchema, getSchema, validate } from './schema/schema';
+export { main, init, resolveAppiumHome };
 
 /**
  * @typedef {import('../types/types').ParsedArgs} ParsedArgs
  */
 
 /**
- * @typedef {import('./appium').PluginExtensionClass} PluginExtensionClass
+ * @typedef {import('../types/types').PartialArgs} PartialArgs
+ * @typedef {import('./extension/manifest').DriverType} DriverType
+ * @typedef {import('./extension/manifest').PluginType} PluginType
+ * @typedef {import('./extension/manifest').DriverClass} DriverClass
+ * @typedef {import('./extension/manifest').PluginClass} PluginClass
+ */
+
+/**
+ * @typedef { {} } ExtCommandInitResult
  */
 
 /**
- * @typedef {import('./appium').DriverExtensionClass} DriverExtensionClass
+ * @typedef ServerInitData
+ * @property {AppiumDriver} appiumDriver - The Appium driver
+ * @property {ParsedArgs} parsedArgs - The parsed arguments
  */
 
 /**
- * @typedef {import('./appium').StaticExtMembers} StaticExtMembers
+ * @typedef {ServerInitData & import('./extension').ExtensionConfigs} ServerInitResult
  */

package/lib/schema/arg-spec.js

@@ -216,7 +216,7 @@ export class ArgSpec {
 /**
  * Options for {@link ArgSpec.create}
  * @template D
- * @typedef {Object} ArgSpecOptions
+ * @typedef ArgSpecOptions
  * @property {string} [extName]
  * @property {ExtensionType} [extType]
  * @property {string} [dest]
@@ -224,5 +224,5 @@ export class ArgSpec {
  */
 
 /**
- * @typedef {import('../ext-config-io').ExtensionType} ExtensionType
+ * @typedef {import('../manifest').ExtensionType} ExtensionType
  */

package/lib/schema/cli-args.js

@@ -139,6 +139,7 @@ function subSchemaToArgDef (subSchema, argSpec) {
   // handle special cases for various types
   switch (type) {
     // booleans do not have a type per `ArgumentOptions`, just an "action"
+    // NOTE: due to limitations of `argparse`, we cannot provide fancy help text, and must rely on its internal error messaging.
     case TYPENAMES.BOOLEAN: {
       argOpts.action = 'store_const';
       argOpts.const = true;

package/lib/schema/keywords.js

@@ -120,7 +120,7 @@ export const keywords = {
 /**
  * These are the custom keywords that Appium recognizes.
  *
- * @typedef {Object} AppiumJSONSchemaKeywords
+ * @typedef AppiumJSONSchemaKeywords
  * @property {string} [appiumCliDest]
  * @property {string} [appiumCliDescription]
  * @property {string[]} [appiumCliAliases]

package/lib/schema/schema.js

@@ -4,12 +4,42 @@ import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
 import _ from 'lodash';
 import path from 'path';
-import { DRIVER_TYPE, PLUGIN_TYPE } from '../extension-config';
-import { ReadonlyMap } from '../utils';
+import { DRIVER_TYPE, PLUGIN_TYPE } from '../constants';
 import appiumConfigSchema from './appium-config-schema';
 import { APPIUM_CONFIG_SCHEMA_ID, ArgSpec, SERVER_PROP_NAME } from './arg-spec';
 import { keywords } from './keywords';
 
+/**
+ * Key/value pairs go in... but they don't come out.
+ *
+ * @template K,V
+ * @extends {Map<K,V>}
+ */
+export class RoachHotelMap 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);
+  }
+
+  /**
+   * @param {K} key
+   */
+  // eslint-disable-next-line no-unused-vars
+  delete (key) {
+    return false;
+  }
+
+  clear () {
+    throw new Error(`Cannot clear RoachHotelMap`);
+  }
+}
+
 /**
  * Extensions that an extension schema file can have.
  */
@@ -28,9 +58,9 @@ class AppiumSchema {
    *
    * Used to provide easy lookups of argument metadata when converting between different representations of those arguments.
    * @private
-   * @type {ReadonlyMap<string,ArgSpec>}
+   * @type {RoachHotelMap<string,ArgSpec>}
    */
-  _argSpecs = new ReadonlyMap();
+  _argSpecs = new RoachHotelMap();
 
   /**
    * A map of extension types to extension names to schema objects.
@@ -83,25 +113,27 @@ class AppiumSchema {
    * @returns {AppiumSchema}
    */
   static create () {
-    const instance = AppiumSchema._instance ?? new AppiumSchema();
-    AppiumSchema._instance = instance;
-
-    _.bindAll(instance, [
-      'finalize',
-      'flatten',
-      'getAllArgSpecs',
-      'getArgSpec',
-      'getDefaults',
-      'getDefaultsForExtension',
-      'getSchema',
-      'hasArgSpec',
-      'isFinalized',
-      'registerSchema',
-      'reset',
-      'validate',
-    ]);
-
-    return instance;
+    if (!AppiumSchema._instance) {
+      const instance = new AppiumSchema();
+      AppiumSchema._instance = instance;
+      _.bindAll(instance, [
+        'finalize',
+        'flatten',
+        'getAllArgSpecs',
+        'getArgSpec',
+        'getDefaults',
+        'getDefaultsForExtension',
+        'getSchema',
+        'hasArgSpec',
+        'isFinalized',
+        'registerSchema',
+        'hasRegisteredSchema',
+        'reset',
+        'validate',
+      ]);
+    }
+
+    return AppiumSchema._instance;
   }
 
   /**
@@ -150,7 +182,7 @@ class AppiumSchema {
    */
   finalize () {
     if (this.isFinalized()) {
-      return /** @type {Record<string,StrictSchemaObject>} */ (
+      return /** @type {NonNullable<typeof this._finalizedSchemas>} */ (
         this._finalizedSchemas
       );
     }
@@ -259,7 +291,7 @@ class AppiumSchema {
     for (const schemaId of Object.keys(this._finalizedSchemas ?? {})) {
       this._ajv.removeSchema(schemaId);
     }
-    this._argSpecs = new ReadonlyMap();
+    this._argSpecs = new RoachHotelMap();
     this._registeredSchemas = {
       [DRIVER_TYPE]: new Map(),
       [PLUGIN_TYPE]: new Map(),
@@ -276,7 +308,7 @@ class AppiumSchema {
    * This is "fail-fast" in that the schema will immediately be validated against JSON schema draft-07 _or_ whatever the value of the schema's `$schema` prop is.
    *
    * Does _not_ add the schema to the `ajv` instance (this is done by {@link AppiumSchema.finalize}).
-   * @param {import('../ext-config-io').ExtensionType} extType - Extension type
+   * @param {ExtensionType} extType - Extension type
    * @param {string} extName - Unique extension name for `type`
    * @param {SchemaObject} schema - Schema object
    * @throws {SchemaNameConflictError} If the schema is an invalid
@@ -666,12 +698,12 @@ export const {isAllowedSchemaFileExtension} = AppiumSchema;
  */
 
 /**
- * @typedef {import('../ext-config-io').ExtensionType} ExtensionType
+ * @typedef {import('../extension/manifest').ExtensionType} ExtensionType
  */
 
 /**
  * An object having property `additionalProperties: false`
- * @typedef {Object} StrictProp
+ * @typedef StrictProp
  * @property {false} additionalProperties
  */
 

package/lib/utils.js

@@ -4,7 +4,6 @@ import _ from 'lodash';
 import logger from './logger';
 // @ts-ignore
 import { processCapabilities, PROTOCOLS } from '@appium/base-driver';
-import { fs } from '@appium/support';
 import { inspect as dump } from 'util';
 
 const W3C_APPIUM_PREFIX = 'appium';
@@ -215,36 +214,7 @@ function pullSettings (caps) {
   return result;
 }
 
-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 () {
-    return false;
-  }
-
-  clear () {
-    throw new Error(`Cannot clear ReadonlyMap`);
-  }
-}
-
 export {
-  inspect, parseCapsForInnerDriver, insertAppiumPrefixes, rootDir,
-  getPackageVersion, pullSettings, removeAppiumPrefixes, ReadonlyMap
+  inspect, parseCapsForInnerDriver, insertAppiumPrefixes,
+  getPackageVersion, pullSettings, removeAppiumPrefixes
 };