appium 2.0.0-beta.3 → 2.0.0-beta.34

package/lib/extension/plugin-config.js

@@ -0,0 +1,113 @@
+
+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 {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 {import('../../types/appium-manifest').ExtManifest<PluginType>} pluginData
+   * @returns {string}
+   */
+   extensionDesc (pluginName, {version}) {
+     return `${pluginName}@${version}`;
+   }
+
+   /**
+   *
+   * @param {(keyof PluginRecord)[]} 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('../../types/appium-manifest').PluginRecord} [extData] - Extension data
+ */
+
+
+/**
+ * @typedef {import('../../types/appium-manifest').PluginRecord} PluginRecord
+ * @typedef {import('../../types').PluginType} PluginType
+ * @typedef {import('../../types/external-manifest').ExtMetadata<PluginType>} PluginMetadata
+ * @typedef {import('./manifest').Manifest} Manifest
+ */

package/lib/grid-register.js

@@ -1,5 +1,5 @@
 import axios from 'axios';
-import { fs } from 'appium-support';
+import { fs } from '@appium/support';
 import logger from './logger';
 import _ from 'lodash';
 
@@ -9,20 +9,31 @@ const hubUri = (config) => {
   return `${protocol}://${config.hubHost}:${config.hubPort}`;
 };
 
-async function registerNode (configFile, addr, port, basePath) {
-  let data;
-  try {
-    data = await fs.readFile(configFile, 'utf-8');
-  } catch (err) {
-    logger.error(`Unable to load node configuration file to register with grid: ${err.message}`);
-    return;
+/**
+ * Registers a new node with a selenium 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;
+  if (_.isString(data)) {
+    configFilePath = data;
+    try {
+      data = await fs.readFile(data, 'utf-8');
+    } catch (err) {
+      logger.error(`Unable to load node configuration file ${configFilePath} to register with grid: ${err.message}`);
+      return;
+    }
+    try {
+      data = JSON.parse(data);
+    } catch (err) {
+      logger.errorAndThrow(`Syntax error in node configuration file ${configFilePath}: ${err.message}`);
+      return;
+    }
   }
 
-  // Check presence of data before posting  it to the selenium grid
-  if (!data) {
-    logger.error('No data found in the node configuration file to send to the grid');
-    return;
-  }
   postRequest(data, addr, port, basePath);
 }
 
@@ -39,15 +50,7 @@ async function registerToGrid (postOptions, configHolder) {
   }
 }
 
-function postRequest (data, addr, port, basePath) {
-  // parse json to get hub host and port
-  let configHolder;
-  try {
-    configHolder = JSON.parse(data);
-  } catch (err) {
-    logger.errorAndThrow(`Syntax error in node configuration file: ${err.message}`);
-  }
-
+function postRequest (configHolder, addr, port, basePath) {
   // Move Selenium 3 configuration properties to configuration object
   if (!_.has(configHolder, 'configuration')) {
     let configuration = {};

package/lib/logger.js

@@ -1,4 +1,4 @@
-import { logger } from 'appium-support';
+import { logger } from '@appium/support';
 
 
 let log = logger.getLogger('Appium');

package/lib/logsink.js

@@ -1,7 +1,6 @@
 import npmlog from 'npmlog';
 import { createLogger, format, transports } from 'winston';
-import { fs, logger } from 'appium-support';
-import dateformat from 'dateformat';
+import { fs, logger } from '@appium/support';
 import _ from 'lodash';
 
 
@@ -36,16 +35,20 @@ const npmToWinstonLevels = {
 };
 
 let log = null;
-let timeZone = null;
+let useLocalTimeZone = false;
 
 // add the timestamp in the correct format to the log info object
 const timestampFormat = format.timestamp({
   format () {
     let date = new Date();
-    if (!timeZone) {
-      date = new Date(date.valueOf() + date.getTimezoneOffset() * 60000);
+    if (useLocalTimeZone) {
+      date = new Date(date.valueOf() - date.getTimezoneOffset() * 60000);
     }
-    return dateformat(date, 'yyyy-mm-dd HH:MM:ss:l');
+    // '2012-11-04T14:51:06.157Z' -> '2012-11-04 14:51:06:157'
+    return date.toISOString()
+      .replace(/[TZ]/g, ' ')
+      .replace(/\./g, ':')
+      .trim();
   },
 });
 
@@ -63,6 +66,8 @@ const stripColorFormat = format(function stripColor (info) {
 
 function createConsoleTransport (args, logLvl) {
   return new (transports.Console)({
+    // `name` is unsupported per winston's type declarations
+    // @ts-expect-error
     name: 'console',
     handleExceptions: true,
     exitOnError: false,
@@ -89,6 +94,7 @@ function createConsoleTransport (args, logLvl) {
 
 function createFileTransport (args, logLvl) {
   return new (transports.File)({
+    // @ts-expect-error
     name: 'file',
     filename: args.logFile,
     maxFiles: 1,
@@ -117,6 +123,7 @@ function createHttpTransport (args, logLvl) {
   }
 
   return new (transports.Http)({
+    // @ts-expect-error
     name: 'http',
     host,
     port,
@@ -182,7 +189,7 @@ async function createTransports (args) {
 
 async function init (args) {
   // set de facto param passed to timestamp function
-  timeZone = args.localTimezone;
+  useLocalTimeZone = args.localTimezone;
 
   // clean up in case we have initiated before since npmlog is a global object
   clear();