appium 3.1.2 → 3.2.1

package/lib/logsink.js

@@ -5,10 +5,6 @@ import _ from 'lodash';
 import { adler32 } from './utils';
 import { LRUCache } from 'lru-cache';
 
-// set up distributed logging before everything else
-global._global_npmlog = globalLog;
-// npmlog is used only for emitting, we use winston for output
-globalLog.level = 'info';
 const LEVELS_MAP = {
   debug: 4,
   info: 3,
@@ -42,6 +38,7 @@ const COLORS_CACHE = new LRUCache({
   updateAgeOnGet: true,
 });
 
+// npmlog is used only for emitting, we use winston for output (global is set by support)
 /** @type {import('winston').Logger?} */
 let log = null;
 
@@ -102,6 +99,8 @@ export async function init(args) {
       }
     }
   });
+  // Only Winston produces output; avoid duplicate lines from the logger's default stream
+  globalLog.stream = null;
 }
 
 /**
@@ -211,12 +210,17 @@ async function createTransports(args) {
   let consoleLogLevel;
   /** @type {string} */
   let fileLogLevel;
-  if (args.loglevel && args.loglevel.match(':')) {
+
+  // Server args are normalized in main so we only see dest form (`loglevel`).
+  // Fall back to schema default so Winston never sees undefined.
+  const rawLogLevel = args.loglevel ?? 'debug';
+
+  if (rawLogLevel && rawLogLevel.includes(':')) {
     // --log-level arg can optionally provide diff logging levels for console and file, separated by a colon
-    const lvlPair = args.loglevel.split(':');
+    const lvlPair = rawLogLevel.split(':');
     [consoleLogLevel, fileLogLevel] = lvlPair;
   } else {
-    consoleLogLevel = fileLogLevel = args.loglevel;
+    consoleLogLevel = fileLogLevel = rawLogLevel;
   }
 
   transports.push(createConsoleTransport(args, consoleLogLevel));

package/lib/main.js

@@ -9,12 +9,11 @@ import {
   normalizeBasePath,
 } from '@appium/base-driver';
 import {util, env} from '@appium/support';
-import {asyncify} from 'asyncbox';
 import _ from 'lodash';
 import {AppiumDriver} from './appium';
 import {runExtensionCommand} from './cli/extension';
 import { runSetupCommand } from './cli/setup-command';
-import {getParser} from './cli/parser';
+import {getParser, ArgParser} from './cli/parser';
 import {
   APPIUM_VER,
   checkNodeOk,
@@ -43,6 +42,7 @@ import {
   isBroadcastIp,
 } from './utils';
 import net from 'node:net';
+import { injectAppiumSymlinks } from './cli/extension-command';
 
 const {resolveAppiumHome} = env;
 /*
@@ -211,6 +211,8 @@ async function init(args) {
       delete args.throwInsteadOfExit;
     }
     preConfigArgs = {...args, subcommand: args.subcommand ?? SERVER_SUBCOMMAND};
+    // Normalize hyphenated keys to dest form so programmatic args match CLI shape
+    ArgParser.normalizeServerArgs(preConfigArgs);
   } else {
     // otherwise parse from CLI
     preConfigArgs = /** @type {Args<Cmd, SubCmd>} */ (parser.parseArgs());
@@ -314,6 +316,14 @@ async function init(args) {
       if (isPluginCommandArgs(preConfigArgs)) {
         await runExtensionCommand(preConfigArgs, pluginConfig);
       }
+
+      if (isDriverCommandArgs(preConfigArgs) || isPluginCommandArgs(preConfigArgs)) {
+        // @ts-ignore The linter suggest using dot
+        const cmd = preConfigArgs.driverCommand || preConfigArgs.pluginCommand;
+        if (cmd === 'install') {
+          await injectAppiumSymlinks(driverConfig, pluginConfig, logger);
+        }
+      }
     }
     return /** @type {InitResult<Cmd>} */ ({});
   }
@@ -481,7 +491,7 @@ async function main(args) {
 // (more specifically, `build/lib/main.js`)
 // the executable is now `../index.js`, so that module will typically be `require.main`.
 if (require.main === module) {
-  asyncify(main);
+  main();
 }
 
 // everything below here is intended to be a public API.

package/lib/schema/cli-args.js

@@ -112,6 +112,12 @@ function subSchemaToArgDef(subSchema, argSpec) {
     help: makeDescription(subSchema),
   };
 
+  // argparse infers dest from the option string (e.g. --log-level → log_level).
+  // We need schema dest (e.g. loglevel) so merged server args and logsink use the right key.
+  if (!argSpec.extType) {
+    argOpts.dest = argSpec.rawDest;
+  }
+
   /**
    * Generally we will provide a `type` to `argparse` as a function which
    * validates using ajv (which is much more full-featured than what `argparse`

package/lib/schema/cli-transformers.js

@@ -1,5 +1,5 @@
 import {ArgumentTypeError} from 'argparse';
-import {readFileSync, existsSync} from 'fs';
+import {readFileSync, existsSync} from 'node:fs';
 
 /**
  * This module provides custom keywords for Appium schemas, as well as

package/lib/schema/schema.js

@@ -1,7 +1,7 @@
 import {Ajv} from 'ajv';
 import addFormats from 'ajv-formats';
 import _ from 'lodash';
-import path from 'path';
+import path from 'node:path';
 import {DRIVER_TYPE, PLUGIN_TYPE} from '../constants';
 import {AppiumConfigJsonSchema} from '@appium/schema';
 import {APPIUM_CONFIG_SCHEMA_ID, ArgSpec, SERVER_PROP_NAME} from './arg-spec';

package/lib/utils.js

@@ -6,9 +6,9 @@ import {
   errors,
   isW3cCaps,
 } from '@appium/base-driver';
-import {inspect as dump} from 'util';
+import {inspect as dump} from 'node:util';
 import {node, fs} from '@appium/support';
-import path from 'path';
+import path from 'node:path';
 import {SERVER_SUBCOMMAND, DRIVER_TYPE, PLUGIN_TYPE, SETUP_SUBCOMMAND} from './constants';
 import os from 'node:os';
 
@@ -229,7 +229,7 @@ export function adjustNodePath() {
       // See https://gist.github.com/branneman/8048520#7-the-hack
       // @ts-ignore see above comment
 
-      require('module').Module._initPaths();
+      require('node:module').Module._initPaths();
       return true;
     } catch {
       return false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium",
-  "version": "3.1.2",
+  "version": "3.2.1",
   "description": "Automation for Apps.",
   "keywords": [
     "automation",
@@ -40,7 +40,8 @@
     "scripts/autoinstall-extensions.js",
     "types",
     "tsconfig.json",
-    "!build/tsconfig.tsbuildinfo"
+    "!build/tsconfig.tsbuildinfo",
+    "!build/test"
   ],
   "scripts": {
     "build:docs": "node docs/scripts/build-docs.js",
@@ -55,39 +56,36 @@
     "postinstall": "node ./scripts/autoinstall-extensions.js",
     "publish:docs": "cross-env APPIUM_DOCS_PUBLISH=1 npm run build:docs",
     "test": "npm run test:unit",
-    "test:e2e": "mocha --exit --timeout 1m --slow 30s \"./test/e2e/**/*.spec.js\"",
+    "test:e2e": "mocha --exit --timeout 1m --slow 30s \"./test/e2e/**/*.spec.ts\"",
     "test:smoke": "cross-env APPIUM_HOME=./local_appium_home node ./index.js driver install uiautomator2 && cross-env APPIUM_HOME=./local_appium_home node ./index.js driver list",
-    "test:unit": "mocha \"./test/unit/**/*.spec.js\""
+    "test:unit": "mocha \"./test/unit/**/*.spec.ts\""
   },
   "dependencies": {
-    "@appium/base-driver": "^10.1.2",
-    "@appium/base-plugin": "^3.0.5",
-    "@appium/docutils": "^2.2.0",
-    "@appium/logger": "^2.0.3",
-    "@appium/schema": "^1.0.0",
-    "@appium/support": "^7.0.4",
-    "@appium/types": "^1.1.2",
+    "@appium/base-driver": "^10.2.1",
+    "@appium/base-plugin": "^3.1.0",
+    "@appium/docutils": "^2.2.2",
+    "@appium/logger": "^2.0.5",
+    "@appium/schema": "^1.1.0",
+    "@appium/support": "^7.0.6",
+    "@appium/types": "^1.2.1",
     "@sidvind/better-ajv-errors": "4.0.1",
-    "ajv": "8.17.1",
+    "ajv": "8.18.0",
     "ajv-formats": "3.0.1",
     "argparse": "2.0.1",
     "async-lock": "1.4.1",
-    "asyncbox": "3.0.0",
-    "axios": "1.13.2",
+    "axios": "1.13.6",
     "bluebird": "3.7.2",
     "lilconfig": "3.1.3",
-    "lodash": "4.17.21",
-    "lru-cache": "11.2.4",
+    "lodash": "4.17.23",
+    "lru-cache": "11.2.6",
     "ora": "5.4.1",
     "package-changed": "3.0.0",
     "resolve-from": "5.0.0",
-    "semver": "7.7.3",
-    "source-map-support": "0.5.21",
-    "teen_process": "3.0.4",
-    "type-fest": "5.3.0",
-    "winston": "3.18.3",
-    "wrap-ansi": "7.0.0",
-    "ws": "8.18.3",
+    "semver": "7.7.4",
+    "teen_process": "4.0.10",
+    "type-fest": "5.4.4",
+    "winston": "3.19.0",
+    "ws": "8.19.0",
     "yaml": "2.8.2"
   },
   "engines": {
@@ -97,5 +95,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9004554879687ddad51d3afdf8c711b027efbd99"
+  "gitHead": "980a121804ae006db879fb6860f627ac36174c15"
 }

package/scripts/autoinstall-extensions.js

@@ -38,12 +38,6 @@ let PLUGIN_TYPE;
 /** @type {typeof import('../lib/extension').loadExtensions} */
 let loadExtensions;
 
-const _ = require('lodash');
-const wrap = _.partial(
-  require('wrap-ansi'),
-  _,
-  process.stderr.columns ?? process.stdout.columns ?? 80
-);
 const ora = require('ora');
 
 /** @type {typeof import('@appium/support').env} */
@@ -54,7 +48,7 @@ let util;
 let logger;
 
 function log(message) {
-  console.error(wrap(`[Appium] ${message}`));
+  console.error(`[Appium] ${message}`);
 }
 
 /**
@@ -118,9 +112,12 @@ async function main() {
   }).start();
 
   if (!driverEnv && !pluginEnv) {
-    spinner.succeed(
-      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".`)
+    spinner.succeed('No drivers or plugins to automatically install.');
+    log(
+      'If desired, provide the argument "--drivers=<driver_name>[,<driver_name>...]" and/or ' +
+      '"--plugins=<plugin_name>[,<plugin_name>...]" to the "npm install appium" command. ' +
+      'The specified extensions will be installed automatically alongside Appium. ' +
+      'For a list of known extensions, run "appium <driver|plugin> list".'
     );
     return;
   }

package/tsconfig.json

@@ -7,19 +7,22 @@
       "@appium/support": ["../support"],
       "@appium/base-driver": ["../base-driver"],
       "@appium/base-plugin": ["../base-plugin"],
+      "@appium/fake-driver": ["../fake-driver"],
       "@appium/types": ["../types"],
       "@appium/schema": ["../schema"],
       "appium": ["."]
     },
-    "checkJs": true
+    "checkJs": true,
+    "types": ["mocha", "chai", "chai-as-promised", "node"]
   },
-  "include": ["lib", "types"],
+  "include": ["lib", "types", "test", "package.json"],
   "references": [
     {"path": "../schema"},
     {"path": "../types"},
     {"path": "../support"},
     {"path": "../base-driver"},
     {"path": "../base-plugin"},
+    {"path": "../fake-driver"},
     {"path": "../test-support"}
   ]
 }

package/types/cli.ts

@@ -1,6 +1,6 @@
-import {DriverType, PluginType, ServerArgs} from '@appium/types';
-import {SetOptional} from 'type-fest';
-import {InstallType} from './manifest';
+import type {DriverType, PluginType, ServerArgs} from '@appium/types';
+import type {SetOptional} from 'type-fest';
+import type {InstallType} from './manifest';
 export type CliCommandServer = 'server';
 export type CliCommandSetup = 'setup';
 export type CliCommandDriver = DriverType;
@@ -26,7 +26,7 @@ export type CliCommandSetupSubcommand = 'mobile' | 'browser' | 'desktop' | 'rese
  * Possible subcommands of {@linkcode CliCommandDriver} or
  * {@linkcode CliCommandPlugin}.
  */
-export type CliExtensionSubcommand = 'install' | 'list' | 'run' | 'uninstall' | 'update'| 'doctor';
+export type CliExtensionSubcommand = 'install' | 'list' | 'run' | 'uninstall' | 'update' | 'doctor';
 
 export interface CliExtensionSubcommandListArgs {
   showInstalled?: boolean;

package/types/index.ts

@@ -1,4 +1,4 @@
-import {ExtensionType, DriverType, DriverClass, PluginType, PluginClass} from '@appium/types';
+import type {ExtensionType, DriverType, DriverClass, PluginType, PluginClass} from '@appium/types';
 
 export * from './manifest';
 export * from './cli';

package/types/manifest/base.ts

@@ -1,6 +1,6 @@
-import {DriverType, ExtensionType, PluginType} from '@appium/types';
-import {SchemaObject} from 'ajv';
-import {PackageJson, SetRequired} from 'type-fest';
+import type {DriverType, ExtensionType, PluginType} from '@appium/types';
+import type {SchemaObject} from 'ajv';
+import type {PackageJson, SetRequired} from 'type-fest';
 
 /**
  * One of the possible extension installation stratgies

package/types/manifest/v3.ts

@@ -1,6 +1,6 @@
-import {DriverType, ExtensionType, PluginType} from '@appium/types';
-import {SchemaObject} from 'ajv';
-import {PackageJson, SetRequired} from 'type-fest';
+import type {DriverType, ExtensionType, PluginType} from '@appium/types';
+import type {SchemaObject} from 'ajv';
+import type {PackageJson, SetRequired} from 'type-fest';
 
 /**
  * One of the possible extension installation stratgies

package/types/manifest/v4.ts

@@ -1,6 +1,6 @@
-import {DriverType, ExtensionType, PluginType} from '@appium/types';
-import {SchemaObject} from 'ajv';
-import {PackageJson, SetRequired} from 'type-fest';
+import type {DriverType, ExtensionType, PluginType} from '@appium/types';
+import type {SchemaObject} from 'ajv';
+import type {PackageJson, SetRequired} from 'type-fest';
 
 /**
  * One of the possible extension installation stratgies