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

package/lib/drivers.js

@@ -1,84 +0,0 @@
-import _ from 'lodash';
-import log from './logger';
-
-
-// This is a map of driver names to npm packages representing those drivers.
-// The drivers in this list will be available to the CLI so users can just
-// type 'appium driver install 'name'', rather than having to specify the full
-// npm package. I.e., these are the officially recognized drivers.
-const KNOWN_DRIVERS = {
-  uiautomator2: 'appium-uiautomator2-driver',
-  xcuitest: 'appium-xcuitest-driver',
-  youiengine: 'appium-youiengine-driver',
-  windows: 'appium-windows-driver',
-  mac: 'appium-mac-driver',
-  mac2: 'appium-mac2-driver',
-  espresso: 'appium-espresso-driver',
-  tizen: 'appium-tizen-driver',
-  flutter: 'appium-flutter-driver',
-  safari: 'appium-safari-driver',
-  gecko: 'appium-geckodriver',
-};
-
-function getDriverBySupport (drivers, matchAutomationName, matchPlatformName) {
-  for (const [driverName, driverData] of _.toPairs(drivers)) {
-    const {automationName, platformNames} = driverData;
-    const aNameMatches = automationName.toLowerCase() === matchAutomationName.toLowerCase();
-    const pNameMatches = _.includes(platformNames.map(_.toLower),
-                                    matchPlatformName.toLowerCase());
-
-    if (aNameMatches && pNameMatches) {
-      return {driverName, ...driverData};
-    }
-
-    if (aNameMatches) {
-      throw new Error(`Driver '${driverName}' supports automationName ` +
-                      `'${automationName}', but Appium could not find ` +
-                      `support for platformName '${matchPlatformName}'. Supported ` +
-                      `platformNames are: ` +
-                      JSON.stringify(platformNames));
-    }
-  }
-
-  throw new Error(`Could not find installed driver to support given caps`);
-}
-
-function findMatchingDriver (config, {automationName, platformName}) {
-  if (!_.isString(platformName)) {
-    throw new Error('You must include a platformName capability');
-  }
-
-  if (!_.isString(automationName)) {
-    throw new Error('You must include an automationName capability');
-  }
-
-  log.info(`Attempting to find matching driver for automationName ` +
-           `'${automationName}' and platformName '${platformName}'`);
-
-  try {
-    const {
-      driverName,
-      mainClass,
-      version,
-    } = getDriverBySupport(config.installedExtensions, automationName, platformName);
-    log.info(`The '${driverName}' driver was installed and matched caps.`);
-    log.info(`Will require it at ${config.getExtensionRequirePath(driverName)}`);
-    const driver = config.require(driverName);
-    if (!driver) {
-      throw new Error(`MainClass ${mainClass} did not result in a driver object`);
-    }
-    return {driver, version, driverName};
-  } catch (err) {
-    const msg = `Could not find a driver for automationName ` +
-                `'${automationName}' and platformName ${platformName}'. ` +
-                `Have you installed a driver that supports those ` +
-                `capabilities? Run 'appium driver list --installed' to see. ` +
-                `(Lower-level error: ${err.message})`;
-    throw new Error(msg);
-  }
-}
-
-export {
-  findMatchingDriver,
-  KNOWN_DRIVERS,
-};

package/lib/ext-config-io.js

@@ -1,287 +0,0 @@
-// @ts-check
-
-/**
- * Module containing {@link ExtConfigIO} which handles reading & writing of extension config files.
- */
-
-import { fs, mkdirp } from '@appium/support';
-import _ from 'lodash';
-import path from 'path';
-import YAML from 'yaml';
-
-const CONFIG_FILE_NAME = 'extensions.yaml';
-
-/**
- * Current configuration schema revision!
- */
-const CONFIG_SCHEMA_REV = 2;
-
-export const DRIVER_TYPE = 'driver';
-export const PLUGIN_TYPE = 'plugin';
-
-/**
- * Set of valid extension types.
- * @type {Readonly<Set<ExtensionType>>}
- */
-const VALID_EXT_TYPES = new Set([DRIVER_TYPE, PLUGIN_TYPE]);
-
-const CONFIG_DATA_DRIVER_KEY = `${DRIVER_TYPE}s`;
-const CONFIG_DATA_PLUGIN_KEY = `${PLUGIN_TYPE}s`;
-
-/**
- * Handles reading & writing of extension config files.
- *
- * Only one instance of this class exists per value of `APPIUM_HOME`.
- */
-class ExtConfigIO {
-  /**
-   * "Dirty" flag. If true, the data has changed since the last write.
-   * @type {boolean}
-   * @private
-   */
-  _dirty;
-
-  /**
-   * The entire contents of a parsed YAML extension config file.
-   * @type {object?}
-   * @private
-   */
-  _data;
-
-  /**
-   * A mapping of extension type to configuration data. Configuration data is
-   * keyed on extension name.
-   *
-   * Consumers get the values of this `Map` (corresponding to the
-   * `extensionType` of the consumer, which will be a subclass of
-   * `ExtensionConfig`) and do not have access to the entire data object.
-   * @private
-   * @type {Map<ExtensionType,object>}
-   */
-  _extDataByType = new Map();
-
-  /**
-   * Path to config file.
-   * @private
-   * @type {Readonly<string>}
-   */
-  _filepath;
-
-  /**
-   * Path to `APPIUM_HOME`
-   * @private
-   * @type {Readonly<string>}
-   */
-  _appiumHome;
-
-  /**
-   * Helps avoid writing multiple times.
-   *
-   * If this is `null`, calling {@link ExtConfigIO.write} will cause it to be
-   * set to a `Promise`. When the call to `write()` is complete, the `Promise`
-   * will resolve and then this value will be set to `null`.  Concurrent calls
-   * made while this value is a `Promise` will return the `Promise` itself.
-   * @private
-   * @type {Promise<boolean>?}
-   */
-  _writing = null;
-
-  /**
-   * Helps avoid reading multiple times.
-   *
-   * If this is `null`, calling {@link ExtConfigIO.read} will cause it to be
-   * set to a `Promise`. When the call to `read()` is complete, the `Promise`
-   * will resolve and then this value will be set to `null`.  Concurrent calls
-   * made while this value is a `Promise` will return the `Promise` itself.
-   * @private
-   * @type {Promise<void>?}
-   */
-  _reading = null;
-
-  /**
-   * @param {string} appiumHome
-   */
-  constructor (appiumHome) {
-    this._filepath = path.resolve(appiumHome, CONFIG_FILE_NAME);
-    this._appiumHome = appiumHome;
-  }
-
-  /**
-   * Creaes a `Proxy` which watches for changes to the extension-type-specific
-   * config data.
-   *
-   * When changes are detected, it sets a `_dirty` flag.  The next call to
-   * {@link ExtConfigIO.write} will check if this flag is `true` before
-   * proceeding.
-   * @param {ExtensionType} extensionType
-   * @param {Record<string,object>} data - Extension config data, keyed by name
-   * @private
-   * @returns {Record<string,object>}
-   */
-  _createProxy (extensionType, data) {
-    return new Proxy(data[`${extensionType}s`], {
-      set: (target, prop, value) => {
-        if (value !== target[prop]) {
-          this._dirty = true;
-        }
-        target[prop] = value;
-        return Reflect.set(target, prop, value);
-      },
-      deleteProperty: (target, prop) => {
-        if (prop in target) {
-          this._dirty = true;
-        }
-        return Reflect.deleteProperty(target, prop);
-      },
-    });
-  }
-
-  /**
-   * Returns the path to the config file.
-   */
-  get filepath () {
-    return this._filepath;
-  }
-
-  /**
-   * Gets data for an extension type.  Reads the config file if necessary.
-   *
-   * Force-reading is _not_ supported, as it's likely to be a source of
-   * bugs--it's easy to mutate the data and then overwrite memory with the file
-   * contents
-   *
-   * Ideally this will only ever read the file _once_.
-   * @param {ExtensionType} extensionType - Which bit of the config data we
-   * want
-   * @returns {Promise<object>} The data
-   */
-  async read (extensionType) {
-    if (this._reading) {
-      await this._reading;
-      return this._extDataByType.get(extensionType);
-    }
-
-    this._reading = (async () => {
-      if (!VALID_EXT_TYPES.has(extensionType)) {
-        throw new TypeError(
-          `Invalid extension type: ${extensionType}. Valid values are: ${[
-            ...VALID_EXT_TYPES,
-          ].join(', ')}`,
-        );
-      }
-      if (this._extDataByType.has(extensionType)) {
-        return;
-      }
-
-      let data;
-      let isNewFile = false;
-      try {
-        await mkdirp(this._appiumHome);
-        const yaml = await fs.readFile(this.filepath, 'utf8');
-        data = YAML.parse(yaml);
-      } catch (err) {
-        if (err.code === 'ENOENT') {
-          data = {
-            [CONFIG_DATA_DRIVER_KEY]: {},
-            [CONFIG_DATA_PLUGIN_KEY]: {},
-            schemaRev: CONFIG_SCHEMA_REV,
-          };
-          isNewFile = true;
-        } else {
-          throw new Error(
-            `Appium had trouble loading the extension installation ` +
-              `cache file (${this.filepath}). Ensure it exists and is ` +
-              `readable. Specific error: ${err.message}`,
-          );
-        }
-      }
-
-      this._data = data;
-      this._extDataByType.set(
-        DRIVER_TYPE,
-        this._createProxy(DRIVER_TYPE, data),
-      );
-      this._extDataByType.set(
-        PLUGIN_TYPE,
-        this._createProxy(PLUGIN_TYPE, data),
-      );
-
-      if (isNewFile) {
-        await this.write(true);
-      }
-    })();
-    try {
-      await this._reading;
-      return this._extDataByType.get(extensionType);
-    } finally {
-      this._reading = null;
-    }
-  }
-
-  /**
-   * Writes the data if it needs writing.
-   *
-   * If the `schemaRev` prop needs updating, the file will be written.
-   * @param {boolean} [force=false] - Whether to force a write even if the data is clean
-   * @returns {Promise<boolean>} Whether the data was written
-   */
-  async write (force = false) {
-    if (this._writing) {
-      return this._writing;
-    }
-    this._writing = (async () => {
-      try {
-        if (!this._dirty && !force) {
-          return false;
-        }
-
-        if (!this._data) {
-          throw new ReferenceError('No data to write. Call `read()` first');
-        }
-
-        const dataToWrite = {
-          ...this._data,
-          [CONFIG_DATA_DRIVER_KEY]: this._extDataByType.get(DRIVER_TYPE),
-          [CONFIG_DATA_PLUGIN_KEY]: this._extDataByType.get(PLUGIN_TYPE),
-        };
-
-        try {
-          await fs.writeFile(
-            this.filepath,
-            YAML.stringify(dataToWrite),
-            'utf8',
-          );
-          this._dirty = false;
-          return true;
-        } catch {
-          throw new Error(
-            `Appium could not parse or write from the Appium Home directory ` +
-              `(${this._appiumHome}). Please ensure it is writable.`,
-          );
-        }
-      } finally {
-        this._writing = null;
-      }
-    })();
-    return await this._writing;
-  }
-}
-
-/**
- * Factory function for {@link ExtConfigIO}.
- *
- * Maintains one instance per value of `APPIUM_HOME`.
- * @param {string} appiumHome - `APPIUM_HOME`
- * @returns {ExtConfigIO}
- */
-export const getExtConfigIOInstance = _.memoize(
-  (appiumHome) => new ExtConfigIO(appiumHome),
-);
-
-/**
- * @typedef {ExtConfigIO} ExtensionConfigIO
- */
-
-/**
- * @typedef {typeof DRIVER_TYPE | typeof PLUGIN_TYPE} ExtensionType
- */