appium 2.0.0-beta.40 → 2.0.0-beta.41

package/lib/config.js

@@ -28,15 +28,18 @@ function getNodeVersion() {
   return /** @type {import('semver').SemVer} */ (semver.coerce(process.version));
 }
 
+/**
+ * @param {boolean} [useGithubApiFallback]
+ */
 async function updateBuildInfo(useGithubApiFallback = false) {
   const sha = await getGitRev(useGithubApiFallback);
   if (!sha) {
     return;
   }
   BUILD_INFO['git-sha'] = sha;
-  const built = await getGitTimestamp(sha, useGithubApiFallback);
-  if (built) {
-    BUILD_INFO.built = built;
+  const buildTimestamp = await getGitTimestamp(sha, useGithubApiFallback);
+  if (buildTimestamp) {
+    BUILD_INFO.built = buildTimestamp;
   }
 }
 
@@ -51,6 +54,10 @@ async function findGitRoot() {
   return await findUp(GIT_META_ROOT, {cwd: rootDir, type: 'directory'});
 }
 
+/**
+ * @param {boolean} [useGithubApiFallback]
+ * @returns {Promise<string?>}
+ */
 async function getGitRev(useGithubApiFallback = false) {
   const gitRoot = await findGitRoot();
   if (gitRoot) {
@@ -66,21 +73,16 @@ async function getGitRev(useGithubApiFallback = false) {
     return null;
   }
 
+  // If the package folder is not a valid git repository
+  // then fetch the corresponding tag info from GitHub
   try {
-    const resBodyObj = (
-      await axios.get(`${GITHUB_API}/tags`, {
+    return (
+      await axios.get(`${GITHUB_API}/git/refs/tags/appium@${APPIUM_VER}`, {
         headers: {
           'User-Agent': `Appium ${APPIUM_VER}`,
         },
       })
-    ).data;
-    if (_.isArray(resBodyObj)) {
-      for (const {name, commit} of resBodyObj) {
-        if (name === `v${APPIUM_VER}` && commit && commit.sha) {
-          return commit.sha;
-        }
-      }
-    }
+    ).data?.object?.sha;
   } catch (ign) {}
   return null;
 }
@@ -106,21 +108,13 @@ async function getGitTimestamp(commitSha, useGithubApiFallback = false) {
   }
 
   try {
-    const resBodyObj = (
-      await axios.get(`${GITHUB_API}/commits/${commitSha}`, {
+    return (
+      await axios.get(`${GITHUB_API}/git/tags/${commitSha}`, {
         headers: {
           'User-Agent': `Appium ${APPIUM_VER}`,
         },
       })
-    ).data;
-    if (resBodyObj && resBodyObj.commit) {
-      if (resBodyObj.commit.committer && resBodyObj.commit.committer.date) {
-        return resBodyObj.commit.committer.date;
-      }
-      if (resBodyObj.commit.author && resBodyObj.commit.author.date) {
-        return resBodyObj.commit.author.date;
-      }
-    }
+    ).data?.tagger?.date;
   } catch (ign) {}
   return null;
 }

package/lib/extension/extension-config.js

@@ -203,11 +203,9 @@ export class ExtensionConfig {
 
     if (!_.isEmpty(errorSummaries)) {
       log.error(
-        `Appium encountered ${util.pluralize(
-          'error',
-          errorSummaries.length,
-          true
-        )} while validating ${this.configKey} found in manifest ${this.manifestPath}`
+        `Appium encountered ${util.pluralize('error', errorMap.size, true)} while validating ${
+          this.configKey
+        } found in manifest ${this.manifestPath}`
       );
       for (const summary of errorSummaries) {
         log.error(summary);
@@ -219,7 +217,7 @@ export class ExtensionConfig {
         log.warn(
           `Appium encountered ${util.pluralize(
             'warning',
-            warningSummaries.length,
+            warningMap.size,
             true
           )} while validating ${this.configKey} found in manifest ${this.manifestPath}`
         );

package/lib/main.js

@@ -4,7 +4,7 @@ import {init as logsinkInit} from './logsink'; // this import needs to come firs
 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, env} from '@appium/support';
+import {logger as logFactory, util, env, fs} from '@appium/support';
 import {asyncify} from 'asyncbox';
 import _ from 'lodash';
 import {AppiumDriver} from './appium';
@@ -15,6 +15,7 @@ import {
   checkNodeOk,
   getGitRev,
   getNonDefaultServerArgs,
+  rootDir,
   showConfig,
   showBuildInfo,
   validateTmpDir,
@@ -26,8 +27,9 @@ import {DRIVER_TYPE, PLUGIN_TYPE, SERVER_SUBCOMMAND} from './constants';
 import registerNode from './grid-register';
 import {getDefaultsForSchema, validate} from './schema/schema';
 import {inspect} from './utils';
+import path from 'path';
 
-const {resolveAppiumHome} = env;
+const {resolveAppiumHome, hasAppiumDependency} = env;
 
 /**
  *
@@ -170,6 +172,19 @@ function areServerCommandArgs(args) {
 async function init(args) {
   const appiumHome = args?.appiumHome ?? (await resolveAppiumHome());
 
+  // this is here so extensions installed in e.g., `~/.appium` can find the peer dependency
+  // of `appium`, which lives wherever it lives (see `rootDir`).
+  if (!(await hasAppiumDependency(appiumHome))) {
+    try {
+      await fs.mkdirp(path.join(appiumHome, 'node_modules'));
+      await fs.symlink(rootDir, path.join(appiumHome, 'node_modules', 'appium'), 'junction');
+    } catch (err) {
+      if (err.code !== 'EEXIST') {
+        throw new Error(`Unable to create symlink to appium: ${err.message}`);
+      }
+    }
+  }
+
   const {driverConfig, pluginConfig} = await loadExtensions(appiumHome);
 
   const parser = getParser();

package/lib/schema/arg-spec.js

@@ -225,5 +225,5 @@ export class ArgSpec {
  */
 
 /**
- * @typedef {import('../extension/manifest').ExtensionType} ExtensionType
+ * @typedef {import('@appium/types').ExtensionType} ExtensionType
  */

package/lib/schema/schema.js

@@ -680,7 +680,7 @@ export const {isAllowedSchemaFileExtension} = AppiumSchema;
  */
 
 /**
- * @typedef {import('../extension/manifest').ExtensionType} ExtensionType
+ * @typedef {import('@appium/types').ExtensionType} ExtensionType
  */
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "2.0.0-beta.40",
+  "version": "2.0.0-beta.41",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -49,33 +49,42 @@
     "dev:docs": "npm run build:docs:assets && npm run dev:docs:en",
     "dev:docs:en": "mkdocs serve -f ./docs/mkdocs-en.yml",
     "dev:docs:ja": "mkdocs serve -f ./docs/mkdocs-ja.yml",
+    "dev:docs:zh": "mkdocs serve -f ./docs/mkdocs-zh.yml",
     "fix": "npm run lint -- --fix",
     "postinstall": "node ./scripts/autoinstall-extensions.js",
     "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore .",
     "prepare": "npm run build",
     "publish:docs": "APPIUM_DOCS_PUBLISH=1 npm run build:docs",
     "test": "npm run test:unit",
-    "test:e2e": "mocha --timeout 75s --slow 30s \"./test/e2e/**/*.spec.js\"",
+    "test:e2e": "mocha --timeout 1m --slow 30s \"./test/e2e/**/*.spec.js\"",
+    "test:smoke": "node ./index.js --show-build-info",
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^8.5.7",
-    "@appium/base-plugin": "^1.9.2",
-    "@appium/docutils": "^0.0.7",
-    "@appium/schema": "^0.0.7",
-    "@appium/support": "^2.59.2",
-    "@appium/test-support": "^1.3.22",
-    "@babel/runtime": "7.18.3",
+    "@appium/base-driver": "^8.6.0",
+    "@appium/base-plugin": "^1.10.0",
+    "@appium/docutils": "^0.0.8",
+    "@appium/schema": "^0.0.8",
+    "@appium/support": "^2.59.3",
+    "@appium/test-support": "^1.4.0",
+    "@appium/types": "^0.3.0",
+    "@babel/runtime": "7.18.9",
     "@sidvind/better-ajv-errors": "2.0.0",
+    "@types/argparse": "2.0.10",
+    "@types/bluebird": "3.5.36",
+    "@types/fancy-log": "2.0.0",
+    "@types/semver": "7.3.10",
+    "@types/teen_process": "1.16.1",
+    "@types/wrap-ansi": "3.0.0",
     "ajv": "8.11.0",
     "ajv-formats": "2.1.1",
     "argparse": "2.0.1",
-    "async-lock": "1.3.1",
+    "async-lock": "1.3.2",
     "asyncbox": "2.9.2",
     "axios": "0.27.2",
     "bluebird": "3.7.2",
     "find-up": "5.0.0",
-    "lilconfig": "2.0.5",
+    "lilconfig": "2.0.6",
     "lodash": "4.17.21",
     "longjohn": "0.2.12",
     "npmlog": "6.0.2",
@@ -84,10 +93,10 @@
     "resolve-from": "5.0.0",
     "semver": "7.3.7",
     "source-map-support": "0.5.21",
-    "supports-color": "8.1.1",
     "teen_process": "1.16.0",
-    "winston": "3.7.2",
-    "word-wrap": "1.2.3",
+    "type-fest": "2.17.0",
+    "winston": "3.8.1",
+    "wrap-ansi": "7.0.0",
     "yaml": "2.1.1"
   },
   "engines": {
@@ -98,5 +107,5 @@
     "access": "public",
     "tag": "next"
   },
-  "gitHead": "4cf2cc92d066ed32adda27e0439547290a4b71ce"
+  "gitHead": "f6e6d7234e7fe92f989f4e37a71007044985dedf"
 }

package/scripts/autoinstall-extensions.js

@@ -28,11 +28,17 @@ let PLUGIN_TYPE;
 let loadExtensions;
 
 const {env, util, logger} = require('@appium/support');
+const _ = require('lodash');
+const wrap = _.partial(
+  require('wrap-ansi'),
+  _,
+  process.stderr.columns ?? process.stdout.columns ?? 25
+);
 
 const ora = require('ora');
 
 const log = (message) => {
-  console.error(`[Appium] ${message}`);
+  console.error(wrap(`[Appium] ${message}`));
 };
 
 const spinner = ora({
@@ -59,7 +65,8 @@ try {
 }
 
 async function main() {
-  if (await env.hasAppiumDependency()) {
+  // if we're doing `npm install -g appium` then we will assume we don't have a local appium.
+  if (!process.env.npm_config_global && (await env.hasAppiumDependency())) {
     log(`Found local Appium installation; skipping automatic installation of extensions.`);
     return;
   }
@@ -74,7 +81,8 @@ async function main() {
 
   if (!driverEnv && !pluginEnv) {
     spinner.succeed(
-      'No drivers or plugins to automatically install. If desired, provide arguments with comma-separated values "--drivers=<known_driver>[,known_driver...]" and/or "--plugins=<known_plugin>[,known_plugin...]" to the "npm install appium" command. The specified extensions will be installed automatically with Appium.  Note: to see the list of known extensions, run "appium <driver|plugin> list".'
+      wrap(`No drivers or plugins to automatically install. 
+      If desired, provide arguments with comma-separated values "--drivers=<known_driver>[,known_driver...]" and/or "--plugins=<known_plugin>[,known_plugin...]" to the "npm install appium" command. The specified extensions will be installed automatically with Appium.  Note: to see the list of known extensions, run "appium <driver|plugin> list".`)
     );
     return;
   }

package/test.d.ts

@@ -0,0 +1,7 @@
+export * from '@appium/test-support';
+/**
+ * @typedef {import('@appium/test-support').SessionHelpers} SessionHelpers
+ */
+/**
+ * @typedef {import('@appium/test-support').E2ESetupOpts} E2ESetupOpts
+ */

package/test.js

@@ -0,0 +1,13 @@
+'use strict';
+
+// @ts-check
+
+/**
+ * This module is here to re-export `@appium/test-support` for Appium extensions.
+ *
+ * @see https://npm.im/@appium/test-support
+ * @example
+ * const { getPort } = require('appium/test');
+ */
+
+module.exports = require('@appium/test-support');

package/types/cli.ts

@@ -1,18 +1,7 @@
 import {ServerArgs} from '@appium/types';
-import type {
-  DRIVER_TYPE as DRIVER_SUBCOMMAND,
-  EXT_SUBCOMMAND_INSTALL,
-  EXT_SUBCOMMAND_LIST,
-  EXT_SUBCOMMAND_RUN,
-  EXT_SUBCOMMAND_UNINSTALL,
-  EXT_SUBCOMMAND_UPDATE,
-  PLUGIN_TYPE as PLUGIN_SUBCOMMAND,
-  SERVER_SUBCOMMAND,
-} from '../lib/constants';
-
-export type ServerSubcommand = typeof SERVER_SUBCOMMAND;
-export type DriverSubcommand = typeof DRIVER_SUBCOMMAND;
-export type PluginSubcommand = typeof PLUGIN_SUBCOMMAND;
+export type ServerSubcommand = 'server';
+export type DriverSubcommand = 'driver';
+export type PluginSubcommand = 'plugin';
 
 /**
  * Possible subcommands for the `appium` CLI.
@@ -24,11 +13,11 @@ export type CliSubcommand = ServerSubcommand | DriverSubcommand | PluginSubcomma
  * {@linkcode PluginSubcommand}.
  */
 export type CliExtensionSubcommand =
-  | typeof EXT_SUBCOMMAND_INSTALL
-  | typeof EXT_SUBCOMMAND_LIST
-  | typeof EXT_SUBCOMMAND_RUN
-  | typeof EXT_SUBCOMMAND_UPDATE
-  | typeof EXT_SUBCOMMAND_UNINSTALL;
+  | 'install'
+  | 'list'
+  | 'run'
+  | 'uninstall'
+  | 'update';
 
 /**
  * Random stuff that may appear in the parsed args which has no equivalent in a