appium 2.2.3 → 2.4.0

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 {
@@ -7,7 +8,7 @@ import {
   server as baseServer,
   normalizeBasePath,
 } from '@appium/base-driver';
-import {logger as logFactory, util, env, fs} from '@appium/support';
+import {logger as logFactory, util, env} from '@appium/support';
 import {asyncify} from 'asyncbox';
 import _ from 'lodash';
 import {AppiumDriver} from './appium';
@@ -20,15 +21,13 @@ import {
   getNonDefaultServerArgs,
   showConfig,
   showBuildInfo,
-  validateTmpDir,
-  warnNodeDeprecations,
-  checkNpmOk,
+  requireDir,
 } from './config';
 import {readConfigFile} from './config-file';
 import {loadExtensions, getActivePlugins, getActiveDrivers} from './extension';
 import {SERVER_SUBCOMMAND, LONG_STACKTRACE_LIMIT} from './constants';
 import registerNode from './grid-register';
-import {getDefaultsForSchema, validate} from './schema/schema';
+import {getDefaultsForSchema, validate as validateSchema} from './schema/schema';
 import {
   inspect,
   adjustNodePath,
@@ -40,7 +39,6 @@ import {
   V4_BROADCAST_IP,
   V6_BROADCAST_IP,
 } from './utils';
-import os from 'node:os';
 import net from 'node:net';
 
 const {resolveAppiumHome} = env;
@@ -53,7 +51,6 @@ const {resolveAppiumHome} = env;
 async function preflightChecks(args, throwInsteadOfExit = false) {
   try {
     checkNodeOk();
-    await checkNpmOk();
     if (args.longStacktrace) {
       Error.stackTraceLimit = LONG_STACKTRACE_LIMIT;
     }
@@ -61,12 +58,11 @@ async function preflightChecks(args, throwInsteadOfExit = false) {
       await showBuildInfo();
       process.exit(0);
     }
-    warnNodeDeprecations();
 
-    validate(args);
+    validateSchema(args);
 
     if (args.tmpDir) {
-      await validateTmpDir(args.tmpDir);
+      await requireDir(args.tmpDir, !args.noPermsCheck, 'tmpDir argument value');
     }
   } catch (err) {
     logger.error(err.message.red);
@@ -149,48 +145,16 @@ function getExtraMethodMap(driverClasses, pluginClasses) {
 }
 
 /**
- * Prepares and validates appium home path folder
- *
- * @param {string} name The name of the appium home source (needed for error messages)
- * @param {string} appiumHome The actual value to be verified
- * @returns {Promise<string>} Same appiumHome value
- * @throws {Error} If the validation has failed
+ * @param {string?} [appiumHomeFromArgs] - Appium home value retrieved from progrmmatic server args
+ * @returns {string}
  */
-async function prepareAppiumHome(name, appiumHome) {
-  let stat;
-  try {
-    stat = await fs.stat(appiumHome);
-  } catch (e) {
-    let err = e;
-    if (e.code === 'ENOENT') {
-      try {
-        await fs.mkdir(appiumHome, {recursive: true});
-        return appiumHome;
-      } catch (e1) {
-        err = e1;
-      }
-    }
-    throw new Error(
-      `The path '${appiumHome}' provided in the ${name} must point ` +
-        `to a valid folder writeable for the current user account '${os.userInfo().username}'. ` +
-        `Original error: ${err.message}`,
-    );
-  }
-  if (!stat.isDirectory()) {
-    throw new Error(
-      `The path '${appiumHome}' provided in the ${name} must point to a valid folder`,
-    );
-  }
-  try {
-    await fs.access(appiumHome, fs.constants.W_OK);
-  } catch (e) {
-    throw new Error(
-      `The folder path '${appiumHome}' provided in the ${name} must be ` +
-        `writeable for the current user account '${os.userInfo().username}. ` +
-        `Original error: ${e.message}`,
-    );
+function determineAppiumHomeSource(appiumHomeFromArgs) {
+  if (!_.isNil(appiumHomeFromArgs)) {
+    return 'appiumHome config value';
+  } else if (process.env.APPIUM_HOME) {
+    return 'APPIUM_HOME environment variable';
   }
-  return appiumHome;
+  return 'autodetected Appium home path';
 }
 
 /**
@@ -212,13 +176,10 @@ async function prepareAppiumHome(name, appiumHome) {
  */
 async function init(args) {
   const appiumHome = args?.appiumHome ?? (await resolveAppiumHome());
-  let appiumHomeSourceName = 'autodetected appium home path';
-  if (!_.isNil(args?.appiumHome)) {
-    appiumHomeSourceName = 'appiumHome config value';
-  } else if (process.env.APPIUM_HOME) {
-    appiumHomeSourceName = 'APPIUM_HOME environment variable';
-  }
-  await prepareAppiumHome(appiumHomeSourceName, appiumHome);
+  const appiumHomeSourceName = determineAppiumHomeSource(args?.appiumHome);
+  // We verify the writeability later based on requested server arguments
+  // Here we just need to make sure the path exists and is a folder
+  await requireDir(appiumHome, false, appiumHomeSourceName);
 
   adjustNodePath();
 
@@ -295,6 +256,10 @@ async function init(args) {
       }
     }
 
+    if (!serverArgs.noPermsCheck) {
+      await requireDir(appiumHome, true, appiumHomeSourceName);
+    }
+
     const appiumDriver = new AppiumDriver(
       /** @type {import('@appium/types').DriverOpts<import('./appium').AppiumDriverConstraints>} */ (
         serverArgs
@@ -309,8 +274,10 @@ async function init(args) {
       parsedArgs: serverArgs,
       driverConfig,
       pluginConfig,
+      appiumHome,
     });
   } else {
+    await requireDir(appiumHome, true, appiumHomeSourceName);
     if (isExtensionCommandArgs(preConfigArgs)) {
       // if the user has requested the 'driver' CLI, don't run the normal server,
       // but instead pass control to the driver CLI
@@ -340,7 +307,7 @@ function logServerAddress(url) {
   }
 
   const interfaces = fetchInterfaces(urlObj.hostname === V4_BROADCAST_IP ? 4 : 6);
-  const toLabel = (/** @type {os.NetworkInterfaceInfo} */ iface) => {
+  const toLabel = (/** @type {import('node:os').NetworkInterfaceInfo} */ iface) => {
     const href = urlObj.href.replace(urlObj.hostname, iface.address);
     return iface.internal ? `${href} (only accessible from the same host)` : href;
   };
@@ -370,17 +337,25 @@ async function main(args) {
     );
   }
 
-  const {appiumDriver, pluginConfig, driverConfig, parsedArgs} =
+  const {appiumDriver, pluginConfig, driverConfig, parsedArgs, appiumHome} =
     /** @type {InitResult<ServerCommand>} */ (initResult);
 
-  const pluginClasses = getActivePlugins(pluginConfig, parsedArgs.usePlugins);
+  const pluginClasses = await getActivePlugins(
+    pluginConfig, parsedArgs.pluginsImportChunkSize, parsedArgs.usePlugins
+  );
   // set the active plugins on the umbrella driver so it can use them for commands
   appiumDriver.pluginClasses = pluginClasses;
 
   await logStartupInfo(parsedArgs);
+
+  const appiumHomeSourceName = determineAppiumHomeSource(args?.appiumHome);
+  logger.debug(`The ${appiumHomeSourceName}: ${appiumHome}`);
+
   let routeConfiguringFunction = makeRouter(appiumDriver);
 
-  const driverClasses = getActiveDrivers(driverConfig, parsedArgs.useDrivers);
+  const driverClasses = await getActiveDrivers(
+    driverConfig, parsedArgs.driversImportChunkSize, parsedArgs.useDrivers
+  );
   const serverUpdaters = getServerUpdaters(driverClasses, pluginClasses);
   const extraMethodMap = getExtraMethodMap(driverClasses, pluginClasses);
 
@@ -399,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 ` +
@@ -498,6 +478,7 @@ export {main, init, resolveAppiumHome};
  * @typedef ServerInitData
  * @property {import('./appium').AppiumDriver} appiumDriver - The Appium driver
  * @property {import('appium/types').ParsedArgs} parsedArgs - The parsed arguments
+ * @property {string} appiumHome - The full path to the Appium home folder
  */
 
 /**

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.2.3",
+  "version": "2.4.0",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -60,13 +60,13 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^9.4.3",
-    "@appium/base-plugin": "^2.2.24",
-    "@appium/docutils": "^0.4.13",
-    "@appium/schema": "^0.4.2",
-    "@appium/support": "^4.1.10",
-    "@appium/types": "^0.14.3",
-    "@sidvind/better-ajv-errors": "2.1.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",
     "@types/fancy-log": "2.0.2",
@@ -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",
@@ -90,10 +89,11 @@
     "resolve-from": "5.0.0",
     "semver": "7.5.4",
     "source-map-support": "0.5.21",
-    "teen_process": "2.0.101",
-    "type-fest": "3.13.1",
+    "teen_process": "2.1.1",
+    "type-fest": "4.9.0",
     "winston": "3.11.0",
     "wrap-ansi": "7.0.0",
+    "ws": "8.16.0",
     "yaml": "2.3.4"
   },
   "engines": {
@@ -103,8 +103,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "67504604b7d4602561db2cb3529860b241bec427",
-  "typedoc": {
-    "entryPoint": "./lib/main.js"
-  }
+  "gitHead": "76df4d600dcb7c867c37c3d7d302dc7fcc95ae09"
 }

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;