appium 3.5.0 → 3.5.2

package/lib/bootstrap/grid-v3-register.ts

@@ -1,7 +1,6 @@
 import axios from 'axios';
 import {fs} from '@appium/support';
 import type {StringRecord} from '@appium/types';
-import _ from 'lodash';
 import {log as logger} from '../logger';
 
 /**
@@ -44,13 +43,13 @@ export default async function registerNode(
   data: string,
   addr: string,
   port: number,
-  basePath: string
+  basePath: string,
 ): Promise<void>;
 export default async function registerNode(
   data: Grid3NodeConfig,
   addr?: string,
   port?: number,
-  basePath?: string
+  basePath?: string,
 ): Promise<void>;
 /**
  * Registers this server as a node with a **Selenium Grid 3** hub.
@@ -71,24 +70,24 @@ export default async function registerNode(
   data: string | Grid3NodeConfig,
   addr?: string,
   port?: number,
-  basePath?: string
+  basePath?: string,
 ): Promise<void> {
   if (typeof data === 'string') {
     if (addr === undefined || port === undefined || basePath === undefined) {
       throw logger.errorWithException(
         'When the first argument is a Selenium Grid 3 node config file path, address, port, and basePath ' +
-          'are required (e.g. match your Appium `--address`, `--port`, and base path).'
+          'are required (e.g. match your Appium `--address`, `--port`, and base path).',
       );
     }
     if (typeof port !== 'number' || !Number.isFinite(port)) {
       throw logger.errorWithException(
-        'When registering from a node config file path, port must be a finite number.'
+        'When registering from a node config file path, port must be a finite number.',
       );
     }
   }
 
   let configHolder: Grid3NodeConfig;
-  if (_.isString(data)) {
+  if (typeof data === 'string') {
     const configFilePath = data;
     let fileContent: string;
     try {
@@ -96,7 +95,7 @@ export default async function registerNode(
     } catch (err) {
       logger.error(
         `Unable to load Selenium Grid 3 node configuration file ${configFilePath} to ` +
-        `register with the hub: ${(err as Error).message}`
+          `register with the hub: ${(err as Error).message}`,
       );
       return;
     }
@@ -105,7 +104,7 @@ export default async function registerNode(
     } catch (err) {
       throw logger.errorWithException(
         `Syntax error in Selenium Grid 3 node configuration file ${configFilePath}: ` +
-        (err as Error).message
+          (err as Error).message,
       );
     }
   } else {
@@ -124,7 +123,7 @@ function hubUri(config: Grid3HubConfiguration): string {
 /** POST registration payload to the Selenium Grid 3 hub. */
 async function registerToGrid(
   postOptions: {url: string; method: string; data: Grid3NodeConfig},
-  configHolder: Grid3NodeConfig
+  configHolder: Grid3NodeConfig,
 ): Promise<void> {
   const hubCfg = configHolder.configuration;
   if (!hubCfg) {
@@ -136,12 +135,12 @@ async function registerToGrid(
       throw new Error(`Request failed with code ${status}`);
     }
     logger.debug(
-      `Appium successfully registered with the Selenium Grid 3 hub at ` + hubUri(hubCfg)
+      `Appium successfully registered with the Selenium Grid 3 hub at ` + hubUri(hubCfg),
     );
   } catch (err) {
     logger.error(
       `An attempt to register with the Selenium Grid 3 hub was unsuccessful: ` +
-      (err as Error).message
+        (err as Error).message,
     );
   }
 }
@@ -150,14 +149,18 @@ function postRequest(
   configHolder: Grid3NodeConfig,
   addr?: string,
   port?: number,
-  basePath?: string
+  basePath?: string,
 ): void {
   // Move Selenium Grid 3 (flat) configuration properties into `configuration`
-  if (!_.has(configHolder, 'configuration')) {
+  if (
+    configHolder != null &&
+    typeof configHolder === 'object' &&
+    !Object.hasOwn(configHolder, 'configuration')
+  ) {
     const configuration: StringRecord = {};
     const holder = configHolder as StringRecord;
-    for (const property in holder) {
-      if (_.has(holder, property) && property !== 'capabilities') {
+    for (const property of Object.keys(holder)) {
+      if (property !== 'capabilities') {
         configuration[property] = holder[property];
         delete holder[property];
       }
@@ -198,10 +201,14 @@ function postRequest(
   }
 
   const registerCycleInterval = cfg.registerCycle;
-  if (registerCycleInterval === undefined || isNaN(registerCycleInterval) || registerCycleInterval <= 0) {
+  if (
+    registerCycleInterval === undefined ||
+    isNaN(registerCycleInterval) ||
+    registerCycleInterval <= 0
+  ) {
     logger.warn(
       `'registerCycle' is not a valid positive number. ` +
-        `No registration request will be sent to the Selenium Grid 3 hub.`
+        `No registration request will be sent to the Selenium Grid 3 hub.`,
     );
     return;
   }
@@ -209,7 +216,7 @@ function postRequest(
   let first = true;
   logger.debug(
     `Starting auto-register thread for Selenium Grid 3. ` +
-      `Will try to register every ${registerCycleInterval} ms.`
+      `Will try to register every ${registerCycleInterval} ms.`,
   );
   setInterval(async function registerRetry() {
     if (first) {

package/lib/bootstrap/main-helpers.ts

@@ -6,7 +6,7 @@ import {
   server as baseServer,
   type ServerOpts,
 } from '@appium/base-driver';
-import _ from 'lodash';
+import {console as supportConsole, util} from '@appium/support';
 import type {AppiumServer, Driver, MethodMap, UpdateServerCallback} from '@appium/types';
 import {WebSocketServer} from 'ws';
 import type {NetworkInterfaceInfo} from 'node:os';
@@ -25,16 +25,15 @@ const isStdoutTTY = process.stdout.isTTY;
 /**
  * Logs a value to the console using the info logger (with util.inspect formatting).
  */
-export const inspect = _.flow(
-  _.partialRight(dump as (object: unknown, options: InspectOptions) => string, {
-    colors: true,
-    depth: null,
-    compact: !isStdoutTTY,
-  }),
-  (...args: unknown[]) => {
-    logger.info(...args);
-  },
-);
+export function inspect(value: unknown): void {
+  logger.info(
+    dump(value, {
+      colors: true,
+      depth: null,
+      compact: !isStdoutTTY,
+    } satisfies InspectOptions),
+  );
+}
 
 /**
  * Prints the current build info JSON to stdout.
@@ -52,7 +51,7 @@ export async function showBuildInfo(): Promise<void> {
  * Human-readable label for where Appium resolved `APPIUM_HOME` from (CLI, env, or autodetect).
  */
 export function determineAppiumHomeSource(appiumHomeFromArgs?: string | null): string {
-  if (!_.isNil(appiumHomeFromArgs)) {
+  if (util.hasValue(appiumHomeFromArgs)) {
     return 'appiumHome config value';
   }
   if (process.env.APPIUM_HOME) {
@@ -110,7 +109,7 @@ export async function preflightChecks(
     }
   } catch (err: unknown) {
     const message = err instanceof Error ? err.message : String(err);
-    logger.error((message as string & {red: string}).red);
+    logger.error(supportConsole.styleText('red', message));
     if (throwInsteadOfExit) {
       throw err;
     }
@@ -131,10 +130,10 @@ export async function logStartupInfo(args: ParsedArgs<CliCommandServer>): Promis
   logger.info(welcome);
 
   const showArgs = getNonDefaultServerArgs(args);
-  if (_.size(showArgs)) {
+  if (Object.keys(showArgs).length) {
     logNonDefaultArgsWarning(showArgs);
   }
-  if (!_.isEmpty(args.defaultCapabilities)) {
+  if (!util.isEmpty(args.defaultCapabilities)) {
     logDefaultCapabilitiesWarning(args.defaultCapabilities);
   }
 }
@@ -146,13 +145,18 @@ export function getServerUpdaters(
   driverClasses: DriverNameMap,
   pluginClasses: PluginNameMap,
 ): UpdateServerCallback[] {
-  return _.compact(_.map([...driverClasses.keys(), ...pluginClasses.keys()], 'updateServer'));
+  return [...driverClasses.keys(), ...pluginClasses.keys()]
+    .map((klass) => klass.updateServer)
+    .filter(Boolean) as UpdateServerCallback[];
 }
 
 /**
  * Merges `newMethodMap` contributions from all active drivers and plugins into one method map.
  */
-export function getExtraMethodMap(driverClasses: DriverNameMap, pluginClasses: PluginNameMap): MethodMap<Driver> {
+export function getExtraMethodMap(
+  driverClasses: DriverNameMap,
+  pluginClasses: PluginNameMap,
+): MethodMap<Driver> {
   return [...driverClasses.keys(), ...pluginClasses.keys()].reduce<MethodMap<Driver>>(
     (map, klass) => ({
       ...map,
@@ -184,7 +188,7 @@ export function buildServerOpts(
   };
   const normalizedBasePath = normalizeBasePath(parsedArgs.basePath);
   for (const timeoutArgName of ['keepAliveTimeout', 'requestTimeout'] as const) {
-    if (_.isInteger(parsedArgs[timeoutArgName])) {
+    if (Number.isInteger(parsedArgs[timeoutArgName])) {
       serverOpts[timeoutArgName] = parsedArgs[timeoutArgName] * 1000;
     }
   }
@@ -214,7 +218,9 @@ function logNonDefaultArgsWarning(args: Args): void {
   inspect(args);
 }
 
-function logDefaultCapabilitiesWarning(caps: ParsedArgs<CliCommandServer>['defaultCapabilities']): void {
+function logDefaultCapabilitiesWarning(
+  caps: ParsedArgs<CliCommandServer>['defaultCapabilities'],
+): void {
   logger.info(
     'Default capabilities, which will be added to each request ' +
       'unless overridden by desired capabilities:',

package/lib/bootstrap/node-helpers.ts

@@ -1,12 +1,10 @@
 /* eslint-disable no-console */
-import _ from 'lodash';
 import path from 'node:path';
 import os from 'node:os';
 import * as semver from 'semver';
 import {system, fs, npm} from '@appium/support';
-import {log as logger} from '../logger';
-import {getAppiumModuleRoot, npmPackage} from '../utils';
-import {rootDir, updateBuildInfo, getBuildInfo} from '../helpers/build';
+import {appiumPackageRoot, npmPackage} from '../utils';
+import {updateBuildInfo, getBuildInfo} from '../helpers/build';
 
 const MIN_NODE_VERSION = (npmPackage.engines as Record<string, string>).node;
 
@@ -26,7 +24,9 @@ interface DebugInfoInput {
 export function checkNodeOk(): void {
   const version = getNodeVersion();
   if (!semver.satisfies(version, MIN_NODE_VERSION)) {
-    throw new Error(`Node version must be at least ${MIN_NODE_VERSION}; current is ${version.version}`);
+    throw new Error(
+      `Node version must be at least ${MIN_NODE_VERSION}; current is ${version.version}`,
+    );
   }
 }
 
@@ -34,13 +34,7 @@ export function checkNodeOk(): void {
  * Adjusts NODE_PATH so CJS drivers/plugins can load peer deps. Does not work with ESM.
  */
 export function adjustNodePath(): void {
-  let appiumModuleSearchRoot: string;
-  try {
-    appiumModuleSearchRoot = path.dirname(getAppiumModuleRoot());
-  } catch (error) {
-    logger.warn((error as Error).message);
-    return;
-  }
+  const appiumModuleSearchRoot = path.dirname(appiumPackageRoot);
 
   const refreshRequirePaths = (): boolean => {
     try {
@@ -73,7 +67,9 @@ export function adjustNodePath(): void {
   if (refreshRequirePaths()) {
     process.env.APPIUM_OMIT_PEER_DEPS = '1';
   } else {
-    process.env.NODE_PATH = _.without(nodePathParts, appiumModuleSearchRoot).join(path.delimiter);
+    process.env.NODE_PATH = nodePathParts
+      .filter((p) => p !== appiumModuleSearchRoot)
+      .join(path.delimiter);
   }
 }
 
@@ -81,10 +77,14 @@ export function adjustNodePath(): void {
  * Prints JSON debug info (OS, Node/npm, Appium build, installed drivers/plugins) to stdout.
  * Input combines extension config snapshots with the resolved Appium home path.
  */
-export async function showDebugInfo({driverConfig, pluginConfig, appiumHome}: DebugInfoInput): Promise<void> {
+export async function showDebugInfo({
+  driverConfig,
+  pluginConfig,
+  appiumHome,
+}: DebugInfoInput): Promise<void> {
   const getNpmVersion = async (): Promise<string> => {
     const {stdout} = await npm.exec('--version', [], {cwd: process.cwd()});
-    return _.trim(stdout);
+    return stdout.trim();
   };
   const findNpmLocation = async (): Promise<string> =>
     await fs.which(system.isWindows() ? 'npm.cmd' : 'npm');
@@ -114,7 +114,7 @@ export async function showDebugInfo({driverConfig, pluginConfig, appiumHome}: De
       },
     },
     appium: {
-      location: rootDir,
+      location: appiumPackageRoot,
       homedir: appiumHome,
       build: getBuildInfo(),
       drivers: driverConfig.installedExtensions,
@@ -134,7 +134,7 @@ export async function showDebugInfo({driverConfig, pluginConfig, appiumHome}: De
 export async function requireDir(
   root: string,
   requireWriteable = true,
-  displayName = 'folder path'
+  displayName = 'folder path',
 ): Promise<void> {
   let stat;
   try {
@@ -146,10 +146,7 @@ export async function requireDir(
         return;
       } catch {}
     }
-    throw new Error(
-      `The ${displayName} '${root}' must exist and be a valid directory`,
-      {cause: e}
-    );
+    throw new Error(`The ${displayName} '${root}' must exist and be a valid directory`, {cause: e});
   }
   if (stat && !stat.isDirectory()) {
     throw new Error(`The ${displayName} '${root}' must be a valid directory`);
@@ -160,7 +157,7 @@ export async function requireDir(
     } catch (e) {
       throw new Error(
         `The ${displayName} '${root}' must be writeable for the current user account '${os.userInfo().username}'`,
-        {cause: e}
+        {cause: e},
       );
     }
   }

package/lib/bootstrap/startup-config.ts

@@ -1,8 +1,9 @@
 /* eslint-disable no-console */
-import _ from 'lodash';
+import {util} from '@appium/support';
 import {getDefaultsForSchema, getAllArgSpecs} from '../schema/schema';
 import type {Args} from 'appium/types';
 import type {ReadConfigFileResult} from './config-file';
+import {difference, getPath, pickBy, setPath} from '../utils';
 
 interface FlattenedArg {
   value: unknown;
@@ -21,15 +22,15 @@ export function getNonDefaultServerArgs(parsedArgs: Args): Args {
    */
   const flatten = (args: Args): Record<string, FlattenedArg> => {
     const argSpecs = getAllArgSpecs();
-    const flattened = _.reduce(
-      [...argSpecs.values()],
-      (acc: Record<string, FlattenedArg>, argSpec: {dest: string}) => {
-        if (_.has(args, argSpec.dest)) {
-          acc[argSpec.dest] = {value: _.get(args, argSpec.dest), argSpec};
+    const flattened = [...argSpecs.values()].reduce<Record<string, FlattenedArg>>(
+      (acc, argSpec: {dest: string}) => {
+        const value = getPath(args, argSpec.dest);
+        if (value !== undefined) {
+          acc[argSpec.dest] = {value, argSpec};
         }
         return acc;
       },
-      {}
+      {},
     );
 
     return flattened;
@@ -41,24 +42,22 @@ export function getNonDefaultServerArgs(parsedArgs: Args): Args {
   const typesDiffer = (dest: string): boolean =>
     typeof args[dest].value !== typeof defaultsFromSchema[dest];
 
-  const defaultValueIsArray = (dest: string): boolean => _.isArray(defaultsFromSchema[dest]);
+  const defaultValueIsArray = (dest: string): boolean => Array.isArray(defaultsFromSchema[dest]);
 
-  const argsValueIsArray = (dest: string): boolean => _.isArray(args[dest].value);
+  const argsValueIsArray = (dest: string): boolean => Array.isArray(args[dest].value);
 
   const arraysDiffer = (dest: string): boolean =>
-    _.gt(_.size(_.difference(args[dest].value as any[], defaultsFromSchema[dest] as any[])), 0);
+    difference(args[dest].value as unknown[], defaultsFromSchema[dest] as unknown[]).length > 0;
 
   const valuesDiffer = (dest: string): boolean => args[dest].value !== defaultsFromSchema[dest];
 
-  const defaultIsDefined = (dest: string): boolean => !_.isUndefined(defaultsFromSchema[dest]);
+  const defaultIsDefined = (dest: string): boolean => defaultsFromSchema[dest] !== undefined;
 
-  // note that `_.overEvery` is like an "AND", and `_.overSome` is like an "OR"
-  const argValueNotArrayOrArraysDiffer = _.overSome([_.negate(argsValueIsArray), arraysDiffer]);
+  const argValueNotArrayOrArraysDiffer = (dest: string) =>
+    !argsValueIsArray(dest) || arraysDiffer(dest);
 
-  const defaultValueNotArrayAndValuesDiffer = _.overEvery([
-    _.negate(defaultValueIsArray),
-    valuesDiffer,
-  ]);
+  const defaultValueNotArrayAndValuesDiffer = (dest: string) =>
+    !defaultValueIsArray(dest) && valuesDiffer(dest);
 
   /**
    * This used to be a hideous conditional, but it's broken up into a hideous function instead.
@@ -71,23 +70,24 @@ export function getNonDefaultServerArgs(parsedArgs: Args): Args {
    *   - ensures the args value is an array
    *   - ensures the args values do not differ from the default values
    */
-  const isNotDefault = _.overEvery([
-    defaultIsDefined,
-    _.overSome([
-      typesDiffer,
-      _.overEvery([defaultValueIsArray, argValueNotArrayOrArraysDiffer]),
-      defaultValueNotArrayAndValuesDiffer,
-    ]),
-  ]);
+  const isNotDefault = (dest: string) =>
+    defaultIsDefined(dest) &&
+    (typesDiffer(dest) ||
+      (defaultValueIsArray(dest) && argValueNotArrayOrArraysDiffer(dest)) ||
+      defaultValueNotArrayAndValuesDiffer(dest));
 
   const defaultsFromSchema = getDefaultsForSchema(true) as Record<string, unknown>;
 
-  return _.reduce(
-    _.pickBy(args, (_v, key) => isNotDefault(key)),
-    // explodes the flattened object back into nested one
-    (acc: Args, {value, argSpec}: FlattenedArg) => _.set(acc, argSpec.dest, value),
-    {} as Args
-  );
+  const nonDefault = pickBy(args, (_v, key) => isNotDefault(String(key)));
+  const result = {} as Args;
+  for (const entry of Object.values(nonDefault)) {
+    if (!entry) {
+      continue;
+    }
+    const {value, argSpec} = entry;
+    setPath(result as Record<string, unknown>, argSpec.dest, value);
+  }
+  return result;
 }
 
 /**
@@ -106,7 +106,7 @@ export function showConfig(
   nonDefaultPreConfigParsedArgs: Partial<Args>,
   configResult: ReadConfigFileResult,
   defaults: Partial<Args>,
-  parsedArgs: Args
+  parsedArgs: Args,
 ): void {
   console.log('Appium Configuration\n');
   console.log('from defaults:\n');
@@ -118,7 +118,7 @@ export function showConfig(
     console.log(`\n(no configuration file loaded)`);
   }
   const compactedNonDefaultPreConfigArgs = compactConfig(nonDefaultPreConfigParsedArgs);
-  if (_.isEmpty(compactedNonDefaultPreConfigArgs)) {
+  if (util.isEmpty(compactedNonDefaultPreConfigArgs)) {
     console.log(`\n(no CLI parameters provided)`);
   } else {
     console.log('\nvia CLI or function call:\n');
@@ -135,9 +135,12 @@ export function showConfig(
  * 3. Removes empty objects (but not `false` values)
  * Does not operate recursively.
  */
-const compactConfig = _.partial(
-  _.omitBy,
-  _,
-  (value: unknown, key: string) =>
-    key === 'subcommand' || _.isUndefined(value) || (_.isObject(value) && _.isEmpty(value))
-);
+function compactConfig<T extends Record<string, unknown>>(obj: T): Partial<T> {
+  return pickBy(
+    obj,
+    (value, key) =>
+      key !== 'subcommand' &&
+      value !== undefined &&
+      !(value !== null && typeof value === 'object' && util.isEmpty(value)),
+  );
+}

package/lib/cli/args.ts

@@ -1,4 +1,4 @@
-import _ from 'lodash';
+import {util} from '@appium/support';
 import type {ArgumentOptions} from 'argparse';
 import type {ExtensionType} from '@appium/types';
 import type {CliExtensionSubcommand} from 'appium/types';
@@ -49,7 +49,7 @@ const globalExtensionArgs: ArgumentDefinitions = new Map([
  *
  * The result is memoized because parser setup is static across process lifetime.
  */
-export const getExtensionArgs = _.memoize(function getExtensionArgs(): Record<
+export const getExtensionArgs = util.memoize(function getExtensionArgs(): Record<
   ExtensionType,
   Record<CliExtensionSubcommand, ArgumentDefinitions>
 > {
@@ -220,8 +220,7 @@ function makeUpdateArgs(type: ExtensionType): ArgumentDefinitions {
         required: false,
         default: false,
         action: 'store_true',
-        help:
-          'Include any available major revision updates, which may have breaking changes',
+        help: 'Include any available major revision updates, which may have breaking changes',
       },
     ],
   ]);

package/lib/cli/driver-command.ts

@@ -1,4 +1,4 @@
-import _ from 'lodash';
+import {console, util} from '@appium/support';
 import type {ExtMetadata, ExtRecord, InstallType} from 'appium/types';
 import ExtensionCliCommand from './extension-command';
 import type {
@@ -9,8 +9,6 @@ import type {
   RunOutput,
 } from './extension-command';
 import {KNOWN_DRIVERS} from '../constants';
-import '@colors/colors';
-
 const REQ_DRIVER_FIELDS = ['driverName', 'automationName', 'platformNames', 'mainClass'];
 type DriverInstallOpts = {driver: string; installType: InstallType; packageName?: string};
 type DriverUninstallOpts = {driver: string};
@@ -29,7 +27,11 @@ export default class DriverCliCommand extends ExtensionCliCommand<'driver'> {
    *
    * @param opts - install options
    */
-  async install({driver, installType, packageName}: DriverInstallOpts): Promise<ExtRecord<'driver'>> {
+  async install({
+    driver,
+    installType,
+    packageName,
+  }: DriverInstallOpts): Promise<ExtRecord<'driver'>> {
     return await super._install({
       installSpec: driver,
       installType,
@@ -91,9 +93,9 @@ export default class DriverCliCommand extends ExtensionCliCommand<'driver'> {
    */
   override getPostInstallText({extName, extData}: ExtensionArgs<'driver'>): PostInstallText {
     return (
-      `Driver ${extName}@${extData.version} successfully installed\n`.green +
-      `- automationName: ${extData.automationName.green}\n` +
-      `- platformNames: ${JSON.stringify(extData.platformNames).green}`
+      `${console.styleText('green', `Driver ${extName}@${extData.version} successfully installed`)}\n` +
+      `- automationName: ${console.styleText('green', extData.automationName)}\n` +
+      `- platformNames: ${console.styleText('green', JSON.stringify(extData.platformNames))}`
     );
   }
 
@@ -106,16 +108,20 @@ export default class DriverCliCommand extends ExtensionCliCommand<'driver'> {
    * @param driverMetadata - `appium` metadata from extension package
    * @param installSpec - install spec from CLI
    */
-  override validateExtensionFields(driverMetadata: ExtMetadata<'driver'>, installSpec: string): void {
-    const missingFields = REQ_DRIVER_FIELDS.reduce(
-      (acc, field) => (driverMetadata[field] ? acc : [...acc, field]),
-      []
+  override validateExtensionFields(
+    driverMetadata: ExtMetadata<'driver'>,
+    installSpec: string,
+  ): void {
+    const missingFields = REQ_DRIVER_FIELDS.reduce<string[]>(
+      (acc, field) =>
+        driverMetadata[field as keyof typeof driverMetadata] ? acc : [...acc, field],
+      [],
     );
 
-    if (!_.isEmpty(missingFields)) {
+    if (!util.isEmpty(missingFields)) {
       throw new Error(
         `Driver "${installSpec}" did not expose correct fields for compatibility ` +
-          `with Appium. Missing fields: ${JSON.stringify(missingFields)}`
+          `with Appium. Missing fields: ${JSON.stringify(missingFields)}`,
       );
     }
   }