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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "2.0.0-beta.25",
+  "version": "2.0.0-beta.26",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -12,12 +12,14 @@
     "firefoxos",
     "testing"
   ],
+  "homepage": "https://appium.io",
   "bugs": {
     "url": "https://github.com/appium/appium/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/appium/appium.git"
+    "url": "https://github.com/appium/appium.git",
+    "directory": "packages/appium"
   },
   "license": "Apache-2.0",
   "author": "https://github.com/appium",
@@ -28,45 +30,52 @@
     "lib": "./lib"
   },
   "files": [
-    "bin",
     "lib",
     "build",
     "index.js",
-    "postinstall.js",
+    "scripts/postinstall.js",
     "types"
   ],
   "scripts": {
-    "generate-docs": "gulp transpile && node ./build/commands-yml/parse.js",
-    "postinstall": "node ./postinstall.js",
-    "upload": "gulp github-upload",
-    "zip": "zip -qr appium.zip .",
-    "zip-and-upload": "npm run zip && npm run upload"
+    "build": "babel lib --root-mode=upward --delete-dir-on-start --out-dir=build/lib",
+    "postbuild": "npm run generate-schema-json",
+    "dev": "npm run build -- --watch",
+    "fix": "npm run lint -- --fix",
+    "generate-docs": "node ./scripts/parse-yml-commands.js",
+    "generate-schema-json": "node ./scripts/generate-schema-json.js",
+    "generate-schema-declarations": "node ./scripts/generate-schema-declarations.js",
+    "postinstall": "node ./scripts/postinstall.js",
+    "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore .",
+    "test": "npm run test:unit",
+    "test:e2e": "mocha --require ../../test/setup-babel.js --timeout 20s --slow 10s \"./test/e2e/**/*.spec.js\"",
+    "test:unit": "mocha --require ../../test/setup-babel.js \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^8.2.4",
-    "@appium/base-plugin": "1.8.0",
-    "@appium/support": "^2.55.4",
-    "@babel/runtime": "7.16.3",
-    "@sidvind/better-ajv-errors": "0.9.2",
-    "ajv": "8.8.2",
+    "@appium/base-driver": "^8.3.0",
+    "@appium/base-plugin": "1.8.1",
+    "@appium/support": "^2.56.0",
+    "@babel/runtime": "7.17.8",
+    "@sidvind/better-ajv-errors": "1.1.1",
+    "ajv": "8.10.0",
     "ajv-formats": "2.1.1",
     "argparse": "2.0.1",
-    "async-lock": "1.3.0",
+    "async-lock": "1.3.1",
     "asyncbox": "2.9.2",
-    "axios": "0.24.0",
+    "axios": "0.26.1",
     "bluebird": "3.7.2",
     "continuation-local-storage": "3.2.1",
     "find-up": "5.0.0",
     "lilconfig": "2.0.4",
     "lodash": "4.17.21",
     "longjohn": "0.2.12",
-    "npmlog": "5.0.1",
+    "npmlog": "6.0.1",
     "ora": "5.4.1",
+    "package-changed": "1.9.0",
     "resolve-from": "5.0.0",
     "semver": "7.3.5",
     "source-map-support": "0.5.21",
     "teen_process": "1.16.0",
-    "winston": "3.3.3",
+    "winston": "3.6.0",
     "word-wrap": "1.2.3",
     "yaml": "1.10.2"
   },
@@ -78,6 +87,5 @@
     "access": "public",
     "tag": "next"
   },
-  "homepage": "https://appium.io",
-  "gitHead": "42f4a2de2d763d57cf0bdb6fb6c9a3bc9c3d232f"
+  "gitHead": "f5cce0f29d31699decea63ed94c4506f7af469df"
 }

package/{postinstall.js → scripts/postinstall.js}

@@ -12,7 +12,7 @@ async function main () {
 
   let extension;
   try {
-    extension = require('./build/lib/cli/extension');
+    extension = require('../build/lib/cli/extension');
   } catch (e) {
     throw new Error(`Could not load extension CLI file; has the project been transpiled? ` +
                     `(${e.message})`);

package/types/types.d.ts

@@ -1,10 +1,15 @@
-import {transformers} from '../lib/schema/cli-transformers';
-import {SERVER_SUBCOMMAND} from '../lib/cli/parser';
 import {
   DRIVER_TYPE as DRIVER_SUBCOMMAND,
+  EXT_SUBCOMMAND_INSTALL,
+  EXT_SUBCOMMAND_UPDATE,
+  EXT_SUBCOMMAND_RUN,
+  EXT_SUBCOMMAND_LIST,
+  EXT_SUBCOMMAND_UNINSTALL,
   PLUGIN_TYPE as PLUGIN_SUBCOMMAND,
-} from '../lib/ext-config-io';
+  SERVER_SUBCOMMAND,
+} from '../lib/constants';
 import appiumConfigSchema from '../lib/schema/appium-config-schema';
+import {transformers} from '../lib/schema/cli-transformers';
 import {AppiumConfiguration, ServerConfig} from './appium-config';
 
 /**
@@ -124,14 +129,14 @@ type DefaultForProp<Prop extends keyof ServerConfigMapping> =
 /**
  * The final shape of the parsed CLI arguments.
  */
-type ParsedArgsFromConfig = {
+type ArgsFromConfig = {
   [Prop in keyof ServerConfigMapping as SetKeyForProp<Prop>]: DefaultForProp<Prop>;
 };
 
 /**
  * Possible subcommands for the `appium` CLI.
  */
-type CliSubCommands =
+type CliSubcommand =
   | typeof SERVER_SUBCOMMAND
   | typeof DRIVER_SUBCOMMAND
   | typeof PLUGIN_SUBCOMMAND;
@@ -140,12 +145,12 @@ type CliSubCommands =
  * Possible subcommands of {@link DRIVER_SUBCOMMAND} or
  * {@link PLUGIN_SUBCOMMAND}.
  */
-type CliExtensionSubcommands =
-  | 'list'
-  | 'install'
-  | 'uninstall'
-  | 'update'
-  | 'run';
+export type CliExtensionSubcommand =
+  | typeof EXT_SUBCOMMAND_INSTALL
+  | typeof EXT_SUBCOMMAND_LIST
+  | typeof EXT_SUBCOMMAND_RUN
+  | typeof EXT_SUBCOMMAND_UPDATE
+  | typeof EXT_SUBCOMMAND_UNINSTALL;
 
 /**
  * Random stuff that may appear in the parsed args which has no equivalent in a
@@ -153,31 +158,64 @@ type CliExtensionSubcommands =
  */
 interface MoreArgs {
   /**
-   * Path to config file, if any
+   * Path to config file, if any. Does not make sense for this to be allowed in a config file!
    */
-  configFile: string;
+  configFile?: string;
 
   /**
-   * If true, show the build info and exit
+   * If true, show the config and exit
    */
-  showBuildInfo: boolean;
+  showConfig?: boolean;
 
   /**
-   * If true, show config and exit
+   * If true, open a REPL
    */
-  showConfig: boolean;
+  shell?: boolean;
+}
 
+/**
+ * These arguments are _not_ supported by the CLI, but only via programmatic usage / tests.
+ */
+interface ProgrammaticArgs {
   /**
-   * If true, open a REPL
+   * Subcommands of `driver` subcommand
+   */
+  driverCommand?: CliExtensionSubcommand;
+
+  /**
+   * Subcommands of `plugin` subcommand
    */
-  shell: boolean;
+  pluginCommand?: CliExtensionSubcommand;
 
   /**
-   * If true, throw on error instead of exit. Not supported via CLI, but rather
-   * only programmatic usage.
+   * If true, throw on error instead of exit.
    */
-  throwInsteadOfExit: boolean;
+  throwInsteadOfExit?: boolean;
 
+  /**
+   * Seems to only be used in tests or standalone driver calls
+   */
+  logHandler?: (...args: any[]) => void;
+
+  /**
+   * Alternate way to set `APPIUM_HOME` for tests. Since we don't want to muck about
+   * with the environment, we just set it here.
+   */
+  appiumHome?: string;
+
+  /**
+   * If true, show the build info and exit
+   */
+  showBuildInfo: boolean;
+
+  /**
+   * If true, show config and exit
+   */
+  showConfig: boolean;
+
+}
+
+interface SubcommandArgs {
   /**
    * Possible subcommands
    */
@@ -185,17 +223,15 @@ interface MoreArgs {
     | typeof DRIVER_SUBCOMMAND
     | typeof PLUGIN_SUBCOMMAND
     | typeof SERVER_SUBCOMMAND;
+}
 
   /**
-   * Subcommands of `driver` subcommand
-   */
-  driverCommand: CliExtensionSubcommands;
-
-  /**
-   * Subcommands of `plugin` subcommand
+ * The same as {@link ParsedArgs} but with a nullable `subcommand`.
    */
-  pluginCommand: CliExtensionSubcommands;
-}
+export type PartialArgs = ArgsFromConfig &
+  MoreArgs &
+  ProgrammaticArgs &
+  Partial<SubcommandArgs>;
 
 /**
  * The Appium configuration as a flattened object, parsed via CLI args _and_ any
@@ -203,4 +239,7 @@ interface MoreArgs {
  * @todo Does not make any assumptions about property names derived from
  * extensions.
  */
-export type ParsedArgs = ParsedArgsFromConfig & Partial<MoreArgs>;
+export type ParsedArgs = ArgsFromConfig &
+  MoreArgs &
+  ProgrammaticArgs &
+  SubcommandArgs;

package/bin/ios-webkit-debug-proxy-launcher.js

@@ -1,71 +0,0 @@
-#!/usr/bin/env node
-
-/* eslint no-console:0 */
-
-/*
- * Small tool, launching and monitoring ios-web-kit-proxy, and relaunching
- * on predefined errors.
- *
- * Usage:
- *  ./bin/ios-webkit-debug-proxy-launcher.js [args]
- *  args: ios-webkit-debug-proxy args (they will be passed over)
- *
- * Example:
- *  ./bin/ios-webkit-debug-proxy-launcher.js -c <UDID>:27753 -d
- *
- *  Note:
- *   For iOS8.1 try this first:
- *     brew install --HEAD ideviceinstaller
- */
-
-'use strict';
-
-const spawn = require('child_process').spawn;
-const _ = require('lodash');
-
-const args = process.argv.slice(2);
-
-const RESTART_ON_MESSAGES = [
-  'Invalid message _rpc_applicationUpdated',
-  'Invalid message _rpc_applicationSentListing'];
-
-const PROXY_CMD = 'ios_webkit_debug_proxy';
-let proxy;
-
-const handleKillProcess = function (exitCode) {
-  console.log('\nKilling proxy process!');
-  proxy.kill('SIGTERM');
-  process.exit((exitCode || 0));
-};
-
-const startProxy = function () {
-  console.log(`RUNNING: ${PROXY_CMD} ${args.join(' ')}`);
-
-  proxy = spawn(PROXY_CMD, args);
-
-  proxy.stdout.on('data', function onStdout (data) {
-    console.log(`stdout: ${data}`);
-  });
-
-  proxy.stderr.on('data', function onStderr (data) {
-    console.log(`stderr: ${data}`);
-    const restartMessage = _(RESTART_ON_MESSAGES).find(function findMessage (message) {
-      return ('' + data).indexOf(message) >= 0;
-    });
-    if (restartMessage) {
-      console.log(`Detected error message: ${restartMessage}`);
-      console.log('Killing proxy!');
-      proxy.kill('SIGTERM');
-      process.nextTick(startProxy);
-    }
-  });
-
-  proxy.on('close', function onClose (code) {
-    console.log(`Child process exited with code ${code}`);
-  });
-};
-
-process.on('SIGINT', handleKillProcess);
-process.on('SIGTERM', handleKillProcess);
-
-startProxy();

package/build/check-npm-pack-files.js

@@ -1,23 +0,0 @@
-"use strict";
-
-require("source-map-support/register");
-
-const childProcess = require('child_process');
-
-const _ = require('lodash');
-
-const res = JSON.parse(childProcess.execSync('npm pack --dry-run --json --ignore-scripts', {
-  encoding: 'utf8'
-}))[0];
-const testFiles = ['LICENSE', 'build/lib/appium.js'];
-
-const missingFiles = _.without(testFiles, ..._.map(res.files, 'path'));
-
-if (!_.isEmpty(missingFiles)) {
-  throw new Error(`Files [${missingFiles.join(', ')}] are not included in package.json "files". ` + `Please make sure these files are included before publishing.`);
-}
-
-process.exit(0);require('source-map-support').install();
-
-
-//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImNoZWNrLW5wbS1wYWNrLWZpbGVzLmpzIl0sIm5hbWVzIjpbImNoaWxkUHJvY2VzcyIsInJlcXVpcmUiLCJfIiwicmVzIiwiSlNPTiIsInBhcnNlIiwiZXhlY1N5bmMiLCJlbmNvZGluZyIsInRlc3RGaWxlcyIsIm1pc3NpbmdGaWxlcyIsIndpdGhvdXQiLCJtYXAiLCJmaWxlcyIsImlzRW1wdHkiLCJFcnJvciIsImpvaW4iLCJwcm9jZXNzIiwiZXhpdCJdLCJtYXBwaW5ncyI6Ijs7OztBQUFBLE1BQU1BLFlBQVksR0FBR0MsT0FBTyxDQUFDLGVBQUQsQ0FBNUI7O0FBQ0EsTUFBTUMsQ0FBQyxHQUFHRCxPQUFPLENBQUMsUUFBRCxDQUFqQjs7QUFFQSxNQUFNRSxHQUFHLEdBQUdDLElBQUksQ0FBQ0MsS0FBTCxDQUFXTCxZQUFZLENBQUNNLFFBQWIsQ0FBc0IsNENBQXRCLEVBQW9FO0FBQUNDLEVBQUFBLFFBQVEsRUFBRTtBQUFYLENBQXBFLENBQVgsRUFBb0csQ0FBcEcsQ0FBWjtBQUdBLE1BQU1DLFNBQVMsR0FBRyxDQUNoQixTQURnQixFQUVoQixxQkFGZ0IsQ0FBbEI7O0FBTUEsTUFBTUMsWUFBWSxHQUFHUCxDQUFDLENBQUNRLE9BQUYsQ0FBVUYsU0FBVixFQUFxQixHQUFHTixDQUFDLENBQUNTLEdBQUYsQ0FBTVIsR0FBRyxDQUFDUyxLQUFWLEVBQWlCLE1BQWpCLENBQXhCLENBQXJCOztBQUVBLElBQUksQ0FBQ1YsQ0FBQyxDQUFDVyxPQUFGLENBQVVKLFlBQVYsQ0FBTCxFQUE4QjtBQUM1QixRQUFNLElBQUlLLEtBQUosQ0FBVyxVQUFTTCxZQUFZLENBQUNNLElBQWIsQ0FBa0IsSUFBbEIsQ0FBd0IsOENBQWxDLEdBQ2IsOERBREcsQ0FBTjtBQUVEOztBQUVEQyxPQUFPLENBQUNDLElBQVIsQ0FBYSxDQUFiIiwic291cmNlc0NvbnRlbnQiOlsiY29uc3QgY2hpbGRQcm9jZXNzID0gcmVxdWlyZSgnY2hpbGRfcHJvY2VzcycpO1xuY29uc3QgXyA9IHJlcXVpcmUoJ2xvZGFzaCcpO1xuXG5jb25zdCByZXMgPSBKU09OLnBhcnNlKGNoaWxkUHJvY2Vzcy5leGVjU3luYygnbnBtIHBhY2sgLS1kcnktcnVuIC0tanNvbiAtLWlnbm9yZS1zY3JpcHRzJywge2VuY29kaW5nOiAndXRmOCd9KSlbMF07XG5cbi8vIExpc3Qgb2YgZmlsZXMgd2UgYXJlIHRlc3RpbmcgdG8gbWFrZSBzdXJlIHRoZXkgYXJlIGluY2x1ZGVkIGluIHBhY2thZ2VcbmNvbnN0IHRlc3RGaWxlcyA9IFtcbiAgJ0xJQ0VOU0UnLCAvLyBDaGVjayB0aGF0IGxpY2Vuc2UgaXMgaW5jbHVkZWRcbiAgJ2J1aWxkL2xpYi9hcHBpdW0uanMnLCAvLyBTYW5pdHkgY2hlY2sgdGhhdCBidWlsZCBmaWxlcyBhcmUgYmVpbmcgaW5jbHVkZWQgYnkgdGVzdGluZyBqdXN0IG9uZSBmaWxlXG5dO1xuXG4vLyBHZXQgbGlzdCBvZiBmaWxlcyBpbiBgdGVzdEZpbGVzYCB0aGF0IGFyZW4ndCBpbiB0aGUgbGlzdCBvZiBwYWNrYWdlZCBmaWxlTmFtZXNcbmNvbnN0IG1pc3NpbmdGaWxlcyA9IF8ud2l0aG91dCh0ZXN0RmlsZXMsIC4uLl8ubWFwKHJlcy5maWxlcywgJ3BhdGgnKSk7XG5cbmlmICghXy5pc0VtcHR5KG1pc3NpbmdGaWxlcykpIHtcbiAgdGhyb3cgbmV3IEVycm9yKGBGaWxlcyBbJHttaXNzaW5nRmlsZXMuam9pbignLCAnKX1dIGFyZSBub3QgaW5jbHVkZWQgaW4gcGFja2FnZS5qc29uIFwiZmlsZXNcIi4gYCArXG4gICAgYFBsZWFzZSBtYWtlIHN1cmUgdGhlc2UgZmlsZXMgYXJlIGluY2x1ZGVkIGJlZm9yZSBwdWJsaXNoaW5nLmApO1xufVxuXG5wcm9jZXNzLmV4aXQoMCk7XG4iXSwiZmlsZSI6ImNoZWNrLW5wbS1wYWNrLWZpbGVzLmpzIiwic291cmNlUm9vdCI6Ii4uIn0=