appium 3.2.2 → 3.3.1

package/lib/cli/driver-command.js

@@ -1,174 +0,0 @@
-import _ from 'lodash';
-import ExtensionCliCommand from './extension-command';
-import {KNOWN_DRIVERS} from '../constants';
-import '@colors/colors';
-
-const REQ_DRIVER_FIELDS = ['driverName', 'automationName', 'platformNames', 'mainClass'];
-
-/**
- * @extends {ExtensionCliCommand<DriverType>}
- */
-
-export default class DriverCliCommand extends ExtensionCliCommand {
-  /**
-   * @param {import('./extension-command').ExtensionCommandOptions<DriverType>} opts
-   */
-  constructor({config, json}) {
-    super({config, json});
-    this.knownExtensions = KNOWN_DRIVERS;
-  }
-
-  /**
-   * Install a driver
-   *
-   * @param {DriverInstallOpts} opts
-   * @return {Promise<ExtRecord<DriverType>>}
-   */
-  async install({driver, installType, packageName}) {
-    return await super._install({
-      installSpec: driver,
-      installType,
-      packageName,
-    });
-  }
-
-  /**
-   * Uninstall a driver
-   *
-   * @param {DriverUninstallOpts} opts
-   * @return {Promise<ExtRecord<DriverType>>}
-   */
-  async uninstall({driver}) {
-    return await super._uninstall({installSpec: driver});
-  }
-
-  /**
-   * Update a driver
-   *
-   * @param {DriverUpdateOpts} opts
-   * @return {Promise<import('./extension-command').ExtensionUpdateResult>}
-   */
-  async update({driver, unsafe}) {
-    return await super._update({installSpec: driver, unsafe});
-  }
-
-  /**
-   * Run a script from a driver
-   *
-   * @param {DriverRunOptions} opts
-   * @return {Promise<import('./extension-command').RunOutput>}
-   * @throws {Error} if the script fails to run
-   */
-  async run({driver, scriptName, extraArgs}) {
-    return await super._run({
-      installSpec: driver,
-      scriptName,
-      extraArgs,
-      bufferOutput: this.isJsonOutput,
-    });
-  }
-
-  /**
-   * Runs doctor checks for the given driver.
-   *
-   * @param {DriverDoctorOptions} opts
-   * @returns {Promise<number>} The amount of executed doctor checks.
-   * @throws {Error} If any of the mandatory Doctor checks fails.
-   */
-  async doctor({driver}) {
-    return await super._doctor({
-      installSpec: driver,
-    });
-  }
-
-  /**
-   *
-   * @param {import('./extension-command').ExtensionArgs} opts
-   * @returns {string}
-   */
-  getPostInstallText({extName, extData}) {
-    return (
-      `Driver ${extName}@${extData.version} successfully installed\n`.green +
-      `- automationName: ${extData.automationName.green}\n` +
-      `- platformNames: ${JSON.stringify(extData.platformNames).green}`
-    );
-  }
-
-  /**
-   * Validates fields in `appium` field of `driverMetadata`
-   *
-   * For any `package.json` fields which a driver requires, validate the type of
-   * those fields on the `package.json` data, throwing an error if anything is
-   * amiss.
-   * @param {import('appium/types').ExtMetadata<DriverType>} driverMetadata
-   * @param {string} installSpec
-   */
-  validateExtensionFields(driverMetadata, installSpec) {
-    const missingFields = REQ_DRIVER_FIELDS.reduce(
-      (acc, field) => (driverMetadata[field] ? acc : [...acc, field]),
-      []
-    );
-
-    if (!_.isEmpty(missingFields)) {
-      throw new Error(
-        `Driver "${installSpec}" did not expose correct fields for compatibility ` +
-          `with Appium. Missing fields: ${JSON.stringify(missingFields)}`
-      );
-    }
-  }
-}
-
-/**
- * @typedef {import('@appium/types').ExtensionType} ExtensionType
- * @typedef {import('@appium/types').DriverType} DriverType
- */
-
-/**
- * @template {ExtensionType} ExtType
- * @typedef {import('appium/types').ExtRecord<ExtType>} ExtRecord
- */
-
-/**
- * @typedef DriverCommandOptions
- * @property {import('../extension/extension-config').ExtensionConfig<DriverType>} config
- * @property {boolean} json
- */
-
-/**
- * Options for {@linkcode DriverCliCommand.install}
- * @typedef DriverInstallOpts
- * @property {string} driver - the name or spec of a driver to install
- * @property {InstallType} installType - how to install this driver. One of the INSTALL_TYPES
- * @property {string} [packageName] - for git/github installs, the driver node package name
- */
-
-/**
- * @typedef {import('appium/types').InstallType} InstallType
- */
-
-/**
- * Options for {@linkcode DriverCliCommand.uninstall}
- * @typedef DriverUninstallOpts
- * @property {string} driver - the name or spec of a driver to uninstall
- */
-
-/**
- * Options for {@linkcode DriverCliCommand.update}
- * @typedef DriverUpdateOpts
- * @property {string} driver - the name of the driver to update
- * @property {boolean} unsafe - if true, will perform unsafe updates past major revision boundaries
- */
-
-/**
- * Options for {@linkcode DriverCliCommand.run}.
- * @typedef DriverRunOptions
- * @property {string} driver - name of the driver to run a script from
- * @property {string} scriptName - name of the script to run
- * @property {string[]} [extraArgs] - arguments to pass to the script
- */
-
-/**
- * Options for {@linkcode DriverCliCommand.doctor}.
- * @typedef DriverDoctorOptions
- * @property {string} driver - name of the driver to run doctor checks for
- */

package/lib/cli/extension.js

@@ -1,74 +0,0 @@
-/* eslint-disable no-console */
-import {DRIVER_TYPE, PLUGIN_TYPE} from '../constants';
-import {isExtensionCommandArgs} from '../utils';
-import DriverCliCommand from './driver-command';
-import PluginCliCommand from './plugin-command';
-import {errAndQuit, JSON_SPACES} from './utils';
-
-export const commandClasses = Object.freeze(
-  /** @type {const} */ ({
-    [DRIVER_TYPE]: DriverCliCommand,
-    [PLUGIN_TYPE]: PluginCliCommand,
-  })
-);
-
-/**
- * Run a subcommand of the 'appium driver' type. Each subcommand has its own set of arguments which
- * can be represented as a JS object.
- *
- * @template {import('appium/types').CliExtensionCommand} Cmd
- * @template {import('appium/types').CliExtensionSubcommand} SubCmd
- * @param {import('appium/types').Args<Cmd, SubCmd>} args - JS object where the key is the parameter name (as defined in
- * driver-parser.js)
- * @param {import('../extension/extension-config').ExtensionConfig<Cmd>} config - Extension config object
- */
-async function runExtensionCommand(args, config) {
-  // TODO driver config file should be locked while any of these commands are
-  // running to prevent weird situations
-  let jsonResult = null;
-  const {extensionType: type} = config; // NOTE this is the same as `args.subcommand`
-  if (!isExtensionCommandArgs(args)) {
-    throw new TypeError(`Cannot call ${type} command without a subcommand like 'install'`);
-  }
-  let {json, suppressOutput} = args;
-  json = Boolean(json);
-  if (suppressOutput) {
-    json = true;
-  }
-  const CommandClass = /** @type {ExtCommand<Cmd>} */ (commandClasses[type]);
-  const cmd = new CommandClass({config, json});
-  try {
-    jsonResult = await cmd.execute(args);
-  } catch (err) {
-    // in the suppress output case, we are calling this function internally and should
-    // just throw instead of printing an error and ending the process
-    if (suppressOutput) {
-      throw err;
-    }
-    errAndQuit(json, err);
-  }
-
-  if (json && !suppressOutput) {
-    console.log(JSON.stringify(jsonResult, null, JSON_SPACES));
-  }
-
-  return jsonResult;
-}
-
-export {runExtensionCommand};
-
-/**
- * @template {ExtensionType} ExtType
- * @typedef {ExtType extends DriverType ? Class<DriverCliCommand> : ExtType extends PluginType ? Class<PluginCliCommand> : never} ExtCommand
- */
-
-/**
- * @typedef {import('@appium/types').ExtensionType} ExtensionType
- * @typedef {import('@appium/types').DriverType} DriverType
- * @typedef {import('@appium/types').PluginType} PluginType
- */
-
-/**
- * @template T
- * @typedef {import('@appium/types').Class<T>} Class
- */

package/lib/cli/plugin-command.js

@@ -1,164 +0,0 @@
-import _ from 'lodash';
-import ExtensionCliCommand from './extension-command';
-import {KNOWN_PLUGINS} from '../constants';
-
-const REQ_PLUGIN_FIELDS = ['pluginName', 'mainClass'];
-
-/**
- * @extends {ExtensionCliCommand<PluginType>}
- */
-export default class PluginCliCommand extends ExtensionCliCommand {
-  /**
-   *
-   * @param {import('./extension-command').ExtensionCommandOptions<PluginType>} opts
-   */
-  constructor({config, json}) {
-    super({config, json});
-    this.knownExtensions = KNOWN_PLUGINS;
-  }
-
-  /**
-   * Install a plugin
-   *
-   * @param {PluginInstallOpts} opts
-   * @returns {Promise<ExtRecord<PluginType>>}
-   */
-  async install({plugin, installType, packageName}) {
-    return await super._install({
-      installSpec: plugin,
-      installType,
-      packageName,
-    });
-  }
-
-  /**
-   * Uninstall a plugin
-   *
-   * @param {PluginUninstallOpts} opts
-   * @returns {Promise<ExtRecord<PluginType>>}
-   */
-  async uninstall({plugin}) {
-    return await super._uninstall({installSpec: plugin});
-  }
-
-  /**
-   * Update a plugin
-   *
-   * @param {PluginUpdateOpts} opts
-   * @returns {Promise<import('./extension-command').ExtensionUpdateResult>}
-   */
-  async update({plugin, unsafe}) {
-    return await super._update({installSpec: plugin, unsafe});
-  }
-
-  /**
-   * Run a script from a plugin
-   *
-   * @param {PluginRunOptions} opts
-   * @returns {Promise<import('./extension-command').RunOutput>}
-   * @throws {Error} if the script fails to run
-   */
-  async run({plugin, scriptName, extraArgs}) {
-    return await super._run({
-      installSpec: plugin,
-      scriptName,
-      extraArgs,
-      bufferOutput: this.isJsonOutput,
-    });
-  }
-
-  /**
-   * Runs doctor checks for the given plugin
-   *
-   * @param {PluginDoctorOptions} opts
-   * @returns {Promise<number>} The amount of executed doctor checks.
-   * @throws {Error} If any of the mandatory Doctor checks fails.
-   */
-  async doctor({plugin}) {
-    return await super._doctor({
-      installSpec: plugin,
-    });
-  }
-
-  /**
-   *
-   * @param {import('./extension-command').ExtensionArgs} opts
-   * @returns {string}
-   */
-  getPostInstallText({extName, extData}) {
-    return `Plugin ${extName}@${extData.version} successfully installed`.green;
-  }
-
-  /**
-   * Validates fields in `appium` field of `pluginMetadata`
-   *
-   * For any `package.json` fields which a plugin requires, validate the type of
-   * those fields on the `package.json` data, throwing an error if anything is
-   * amiss.
-   * @param {import('appium/types').ExtMetadata<PluginType>} pluginMetadata
-   * @param {string} installSpec
-   * @returns {void}
-   */
-  validateExtensionFields(pluginMetadata, installSpec) {
-    const missingFields = REQ_PLUGIN_FIELDS.reduce(
-      (acc, field) => (pluginMetadata[field] ? acc : [...acc, field]),
-      []
-    );
-
-    if (!_.isEmpty(missingFields)) {
-      throw new Error(
-        `Installed plugin "${installSpec}" did not expose correct fields for compatibility ` +
-          `with Appium. Missing fields: ${JSON.stringify(missingFields)}`
-      );
-    }
-  }
-}
-
-/**
- * @typedef {import('@appium/types').ExtensionType} ExtensionType
- * @typedef {import('@appium/types').PluginType} PluginType
- */
-
-/**
- * @template {ExtensionType} ExtType
- * @typedef {import('appium/types').ExtRecord<ExtType>} ExtRecord
- */
-
-/**
- * Options for {@linkcode PluginCliCommand.install}
- * @typedef PluginInstallOpts
- * @property {string} plugin - the name or spec of a plugin to install
- * @property {InstallType} installType - how to install this plugin. One of the INSTALL_TYPES
- * @property {string} [packageName] - for git/github installs, the plugin node package name
- */
-
-/**
- * @typedef {import('appium/types').InstallType} InstallType
- */
-
-/**
- * Options for {@linkcode PluginCliCommand.uninstall}
- * @typedef PluginUninstallOpts
- * @property {string} plugin - the name or spec of a plugin to uninstall
- */
-
-/**
- * Options for {@linkcode PluginCliCommand.update}
- * @typedef PluginUpdateOpts
- * @property {string} plugin - the name of the plugin to update
- * @property {boolean} unsafe - if true, will perform unsafe updates past major revision boundaries
- */
-
-/**
- * Options for {@linkcode PluginCliCommand.run}.
- * @typedef PluginRunOptions
- * @property {string} plugin - name of the plugin to run a script from
- * @property {string} scriptName - name of the script to run
- * @property {string[]} [extraArgs] - arguments to pass to the script
- */
-
-/**
- * Options for {@linkcode PluginCliCommand.doctor}.
- * @typedef PluginDoctorOptions
- * @property {string} plugin - name of the plugin to run doctor checks for
- */

package/lib/cli/utils.js

@@ -1,91 +0,0 @@
-/* eslint-disable no-console */
-
-import ora from 'ora';
-
-export const JSON_SPACES = 4;
-
-/***
- * Log an error to the console and exit the process.
- * @param {boolean} json - whether we should log json or text
- * @param {any} msg - error message, object, Error instance, etc.
- */
-export function errAndQuit(json, msg) {
-  if (json) {
-    console.log(JSON.stringify({error: `${msg}`}, null, JSON_SPACES));
-  } else {
-    console.error(`${msg}`.red);
-    if (msg.stderr) {
-      console.error(`${msg.stderr}`.red);
-    }
-  }
-  process.exit(1);
-}
-
-/**
- * Conditionally log something to the console
- * @param {boolean} json - whether we are in json mode (and should therefore not log)
- * @param {string} msg - string to log
- */
-export function log(json, msg) {
-  if (!json) {
-    console.log(msg);
-  }
-}
-
-/**
- * Start a spinner, execute an async function, and then stop the spinner
- * @param {boolean} json - whether we are in json mode (and should therefore not log)
- * @param {string} msg - string to log
- * @param {function} fn - function to wrap with spinning
- */
-export async function spinWith(json, msg, fn) {
-  if (json) {
-    return await fn();
-  }
-  const spinner = ora(msg).start();
-  let res;
-  try {
-    res = await fn();
-    spinner.succeed();
-    return res;
-  } catch (err) {
-    spinner.fail();
-    throw err;
-  }
-}
-
-export class RingBuffer {
-  constructor(size = 50) {
-    this.size = size;
-    this.buffer = [];
-  }
-
-  /**
-   * Get the current buffer contents
-   *
-   * @returns {any[]}
-   */
-  getBuff() {
-    return this.buffer;
-  }
-
-  /**
-   * Remove the oldest item from the buffer
-   *
-   * @returns {void}
-   */
-  dequeue() {
-    this.buffer.shift();
-  }
-  /**
-   * Add an item to the buffer
-   *
-   * @param {any} item
-   */
-  enqueue(item) {
-    if (this.buffer.length >= this.size) {
-      this.dequeue();
-    }
-    this.buffer.push(item);
-  }
-}