appium 2.3.0 → 2.4.1

package/lib/doctor/doctor.js

@@ -0,0 +1,209 @@
+import '@colors/colors';
+import _ from 'lodash';
+import { util, doctor, logger } from '@appium/support';
+
+export class Doctor {
+  /**
+   * @param {DoctorCheck[]} [checks=[]]
+   */
+  constructor(checks = []) {
+    this.log = logger.getLogger('Doctor');
+    /** @type {DoctorCheck[]} */
+    this.checks = checks;
+    this.checks
+      .filter((c) => _.isNil(c.log))
+      .forEach((c) => { c.log = this.log; });
+    /** @type {DoctorIssue[]} */
+    this.foundIssues = [];
+  }
+
+  /**
+   * @returns {DoctorIssue[]}
+   */
+  get issuesRequiredToFix() {
+    return this.foundIssues.filter((f) => !f.check.isOptional());
+  }
+
+  /**
+   * @returns {DoctorIssue[]}
+   */
+  get issuesOptionalToFix() {
+    return this.foundIssues.filter((f) => f.check.isOptional());
+  }
+
+  /**
+   * The doctor shows the report
+   */
+  async diagnose() {
+    this.log.info(`### Starting doctor diagnostics  ###`);
+    this.foundIssues = [];
+    for (const check of this.checks) {
+      const res = await check.diagnose();
+      const issue = this.toIssue(res, check);
+      if (issue) {
+        this.foundIssues.push(issue);
+      }
+    }
+    this.log.info(
+      `### Diagnostic completed, ${this.buildFixMessage()}. ###`
+    );
+    this.log.info('');
+  }
+
+  /**
+   * @returns {Promise<boolean>}
+   */
+  async reportManualIssues() {
+    const manualIssues = _.filter(this.issuesRequiredToFix, (f) => !f.check.hasAutofix());
+    const manualIssuesOptional = _.filter(this.issuesOptionalToFix, (f) => !f.check.hasAutofix());
+
+    const handleIssues = async (headerLogs, issues) => {
+      if (_.isEmpty(issues)) {
+        return;
+      }
+
+      for (const logMsg of headerLogs) {
+        this.log.info(logMsg);
+      }
+      /** @type {string[]} */
+      const fixMessages = [];
+      for (const issue of issues) {
+        const message = await issue.check.fix();
+        if (message) {
+          fixMessages.push(message);
+        }
+      }
+      for (const m of _.uniq(fixMessages)) {
+        this.log.warn(` \u279C ${m}`);
+      }
+      this.log.info('');
+    };
+
+    await handleIssues([
+      '### Manual Fixes Needed ###',
+      'The configuration cannot be automatically fixed, please do the following first:',
+    ], manualIssues);
+    await handleIssues([
+      '### Optional Manual Fixes  ###',
+      'To fix these optional issues, please do the following manually:',
+    ], manualIssuesOptional);
+
+    if (manualIssues.length > 0) {
+      this.log.info('###');
+      this.log.info('');
+      this.log.info('Bye! Run doctor again when all manual fixes have been applied!');
+      this.log.info('');
+      return true;
+    }
+    return false;
+  }
+
+  /**
+   * @param {DoctorIssue} f
+   */
+  async runAutoFix(f) {
+    this.log.info(`### Fixing: ${f.error} ###`);
+    try {
+      await f.check.fix();
+    } catch (err) {
+      if (err.constructor.name === doctor.FixSkippedError.name) {
+        this.log.info(`### Skipped fix ###`);
+        return;
+      } else {
+        this.log.warn(`${err}`.replace(/\n$/g, ''));
+        this.log.info(`### Fix did not succeed ###`);
+        return;
+      }
+    }
+    this.log.info('Checking if this was fixed:');
+    const res = await f.check.diagnose();
+    if (res.ok) {
+      f.fixed = true;
+      this.log.info(` ${'\u2714'.green} ${res.message}`);
+      this.log.info(`### Fix was successfully applied ###`);
+    } else {
+      this.log.info(` ${'\u2716'.red} ${res.message}`);
+      this.log.info(`### Fix was applied but issue remains ###`);
+    }
+  }
+
+  async runAutoFixes() {
+    const autoFixes = _.filter(this.foundIssues, (f) => f.check.hasAutofix());
+    for (const f of autoFixes) {
+      await this.runAutoFix(f);
+      this.log.info('');
+    }
+    if (_.find(autoFixes, (f) => !f.fixed)) {
+      // a few issues remain.
+      this.log.info('Bye! A few issues remain, fix manually and/or rerun doctor!');
+    } else {
+      // nothing left to fix.
+      this.log.info('Bye! All issues have been fixed!');
+    }
+    this.log.info('');
+  }
+
+  async run() {
+    await this.diagnose();
+    if (this.reportSuccess()) {
+      return;
+    }
+    if (await this.reportManualIssues()) {
+      return;
+    }
+    await this.runAutoFixes();
+  }
+
+  /**
+   * @param {DoctorCheckResult} result
+   * @param {DoctorCheck} check
+   * @returns {DoctorIssue?}
+   */
+  toIssue(result, check) {
+    if (result.ok) {
+      this.log.info(` ${'\u2714'.green} ${result.message}`);
+      return null;
+    }
+
+    const errorMessage = result.optional
+      ? ` ${'\u2716'.yellow} ${result.message}`
+      : ` ${'\u2716'.red} ${result.message}`;
+    this.log.warn(errorMessage);
+    return {
+      error: errorMessage,
+      check,
+    };
+  }
+
+  /**
+   * @returns {string}
+   */
+  buildFixMessage() {
+    return `${util.pluralize('required fix', this.issuesRequiredToFix.length, true)} needed, ` +
+      `${util.pluralize('optional fix', this.issuesOptionalToFix.length, true)} possible`;
+  }
+
+  /**
+   * @returns {boolean}
+   */
+  reportSuccess() {
+    if (this.issuesRequiredToFix.length === 0 && this.issuesOptionalToFix.length === 0) {
+      this.log.info('Everything looks good, bye!');
+      this.log.info('');
+      return true;
+    }
+    return false;
+  }
+}
+
+/**
+ * @typedef DoctorIssue
+ * @property {DoctorCheck} check
+ * @property {string} error
+ * @property {boolean} [fixed]
+ */
+
+/**
+ * @typedef {import('@appium/types').IDoctorCheck} DoctorCheck
+ * @typedef {import('@appium/types').DoctorCheckResult} DoctorCheckResult
+ */

package/lib/extension/index.js

@@ -99,9 +99,12 @@ export async function getActivePlugins(pluginConfig, maxParallelImports, usePlug
           `The reserved plugin name '${pluginName}' cannot be combined with other names.`
         );
       } else {
+        const suffix = _.isEmpty(pluginConfig.installedExtensions)
+          ? `You don't have any plugins installed yet.`
+          : `Only the following ${_.size(pluginConfig.installedExtensions) === 1 ? `plugin is` : `plugins are`} ` +
+            `available: ${_.keys(pluginConfig.installedExtensions)}`;
         throw new Error(
-          `Could not load the plugin '${pluginName}' because it is not installed. ` +
-          `Only the following plugins are available: ${_.keys(pluginConfig.installedExtensions)}`
+          `Could not load the plugin '${pluginName}' because it is not installed. ${suffix}`
         );
       }
     }
@@ -131,9 +134,12 @@ export async function getActiveDrivers(driverConfig, maxParallelImports, useDriv
       if (driverName in driverConfig.installedExtensions) {
         filteredDriverNames.push(driverName);
       } else {
+        const suffix = _.isEmpty(driverConfig.installedExtensions)
+          ? `You don't have any drivers installed yet.`
+          : `Only the following ${_.size(driverConfig.installedExtensions) === 1 ? `driver is` : `drivers are`} ` +
+            `available: ${_.keys(driverConfig.installedExtensions)}`;
         throw new Error(
-          `Could not load the driver '${driverName}' because it is not installed. ` +
-          `Only the following drivers are available: ${_.keys(driverConfig.installedExtensions)}`
+          `Could not load the driver '${driverName}' because it is not installed. ${suffix}`
         );
       }
     }

package/lib/grid-register.js

@@ -30,10 +30,9 @@ async function registerNode(data, addr, port, basePath) {
     try {
       data = JSON.parse(data);
     } catch (err) {
-      logger.errorAndThrow(
+      throw logger.errorWithException(
         `Syntax error in node configuration file ${configFilePath}: ${err.message}`
       );
-      return;
     }
   }
 

package/lib/main.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+import {WebSocketServer} from 'ws';
 import {init as logsinkInit} from './logsink'; // this import needs to come first since it sets up global npmlog
 import logger from './logger'; // logger needs to remain second
 import {
@@ -373,8 +374,13 @@ async function main(args) {
     serverOpts.keepAliveTimeout = parsedArgs.keepAliveTimeout * 1000;
   }
   let server;
+  const bidiServer = new WebSocketServer({noServer: true});
+  bidiServer.on('connection', appiumDriver.onBidiConnection.bind(appiumDriver));
+  bidiServer.on('error', appiumDriver.onBidiServerError.bind(appiumDriver));
   try {
     server = await baseServer(serverOpts);
+    server.addWebSocketHandler('/bidi', bidiServer);
+    server.addWebSocketHandler('/bidi/:sessionId', bidiServer);
   } catch (err) {
     logger.error(
       `Could not configure Appium server. It's possible that a driver or plugin tried ` +

package/lib/utils.js

@@ -2,7 +2,7 @@ import _ from 'lodash';
 import logger from './logger';
 import {processCapabilities, PROTOCOLS, STANDARD_CAPS, errors} from '@appium/base-driver';
 import {inspect as dump} from 'util';
-import {node} from '@appium/support';
+import {node, fs} from '@appium/support';
 import path from 'path';
 import {SERVER_SUBCOMMAND, DRIVER_TYPE, PLUGIN_TYPE} from './constants';
 import os from 'node:os';
@@ -11,6 +11,7 @@ const W3C_APPIUM_PREFIX = 'appium';
 const STANDARD_CAPS_LOWERCASE = new Set([...STANDARD_CAPS].map((cap) => cap.toLowerCase()));
 export const V4_BROADCAST_IP = '0.0.0.0';
 export const V6_BROADCAST_IP = '::';
+export const npmPackage = fs.readPackageJsonFrom(__dirname);
 
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -60,12 +60,12 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^9.4.4",
-    "@appium/base-plugin": "^2.2.25",
-    "@appium/docutils": "^1.0.1",
-    "@appium/schema": "^0.5.0",
-    "@appium/support": "^4.1.11",
-    "@appium/types": "^0.15.0",
+    "@appium/base-driver": "^9.5.0",
+    "@appium/base-plugin": "^2.2.26",
+    "@appium/docutils": "^1.0.2",
+    "@appium/schema": "~0.5.0",
+    "@appium/support": "^4.2.0",
+    "@appium/types": "^0.16.0",
     "@sidvind/better-ajv-errors": "2.1.3",
     "@types/argparse": "2.0.14",
     "@types/bluebird": "3.5.42",
@@ -76,13 +76,12 @@
     "ajv": "8.12.0",
     "ajv-formats": "2.1.1",
     "argparse": "2.0.1",
-    "async-lock": "1.4.0",
+    "async-lock": "1.4.1",
     "asyncbox": "3.0.0",
-    "axios": "1.6.2",
+    "axios": "1.6.3",
     "bluebird": "3.7.2",
     "cross-env": "7.0.3",
-    "find-up": "5.0.0",
-    "lilconfig": "2.1.0",
+    "lilconfig": "3.0.0",
     "lodash": "4.17.21",
     "npmlog": "7.0.1",
     "ora": "5.4.1",
@@ -91,9 +90,10 @@
     "semver": "7.5.4",
     "source-map-support": "0.5.21",
     "teen_process": "2.1.1",
-    "type-fest": "4.8.3",
+    "type-fest": "4.9.0",
     "winston": "3.11.0",
     "wrap-ansi": "7.0.0",
+    "ws": "8.16.0",
     "yaml": "2.3.4"
   },
   "engines": {
@@ -103,5 +103,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5c1d20517cfc8773cd5ffb0f8bb996668d71116b"
+  "gitHead": "b08210a6f80dcae55bd9e6c415327eba73a8aadd"
 }

package/types/cli.ts

@@ -19,7 +19,7 @@ export type CliCommand = CliCommandServer | CliExtensionCommand;
  * Possible subcommands of {@linkcode CliCommandDriver} or
  * {@linkcode CliCommandPlugin}.
  */
-export type CliExtensionSubcommand = 'install' | 'list' | 'run' | 'uninstall' | 'update';
+export type CliExtensionSubcommand = 'install' | 'list' | 'run' | 'uninstall' | 'update'| 'doctor';
 
 export interface CliExtensionSubcommandListArgs {
   showInstalled?: boolean;