appium-adb 16.0.9 → 16.1.2

package/lib/tools/system-calls.ts

@@ -8,7 +8,15 @@ import type {ExecError, TeenProcessExecResult} from 'teen_process';
 
 import type {ADB} from '../adb.js';
 import {log} from '../logger.js';
-import {DEFAULT_ADB_EXEC_TIMEOUT, cloneDeep, getSdkRootFromEnv, memoize, zip} from '../utils/index.js';
+import {
+  DEFAULT_ADB_EXEC_TIMEOUT,
+  cloneDeep,
+  getSdkRootFromEnv,
+  memoize,
+  redactExecError,
+  redactSecrets,
+  zip,
+} from '../utils/index.js';
 import type {
   ConnectedDevicesOptions,
   Device,
@@ -493,11 +501,12 @@ export async function adbExec(this: ADB, cmd: string | string[], opts?: AdbExecO
   cmd = Array.isArray(cmd) ? cmd : [cmd];
   let adbRetried = false;
   const execFunc = async (): Promise<string | ExecResult> => {
+    const args = [...this.executable.defaultArgs, ...cmd];
     try {
-      const args = [...this.executable.defaultArgs, ...cmd];
+      const logArgs = redactSecrets(args);
       log.debug(
         `Running '${this.executable.path} ` +
-          (args.find((arg) => /\s+/.test(arg)) ? util.quote(args) : args.join(' ')) +
+          (logArgs.find((arg) => /\s+/.test(arg)) ? util.quote(logArgs) : logArgs.join(' ')) +
           `'`,
       );
       const {stdout: rawStdout, stderr} = (await exec(
@@ -510,10 +519,10 @@ export async function adbExec(this: ADB, cmd: string | string[], opts?: AdbExecO
       const stdout = rawStdout.replace(LINKER_WARNING_REGEXP, '').trim();
       return outputFormat === this.EXEC_OUTPUT_FORMAT.FULL ? {stdout, stderr} : stdout;
     } catch (e: unknown) {
-      const error = e as ExecError;
+      const error = redactExecError(e, this.executable.path, args) as ExecError;
       const errText = `${error.message}, ${error.stdout}, ${error.stderr}`;
       if (ADB_RETRY_ERROR_PATTERNS.some((p) => p.test(errText))) {
-        log.info(`Error sending command, reconnecting device and retrying: ${cmd}`);
+        log.info(`Error sending command, reconnecting device and retrying: ${redactSecrets(cmd)}`);
         await this.getDevicesWithRetry();
 
         // try again one time
@@ -589,7 +598,7 @@ export async function shell(this: ADB, cmd: string | string[], opts?: ShellExecO
   const cmdArr = Array.isArray(cmd) ? cmd : [cmd];
   const fullCmd: string[] = ['shell'];
   if (privileged) {
-    log.info(`'adb shell ${util.quote(cmdArr)}' requires root access`);
+    log.info(`'adb shell ${util.quote(redactSecrets(cmdArr))}' requires root access`);
     if (await this.isRoot()) {
       log.info('The device already had root access');
       fullCmd.push(...cmdArr);

package/lib/utils/helpers/index.ts

@@ -1,5 +1,6 @@
 export {APKS_EXTENSION, APK_EXTENSION, APK_INSTALL_TIMEOUT, DEFAULT_ADB_EXEC_TIMEOUT} from './constants.js';
 export {buildInstallArgs, type BuildInstallArgsOptions} from './install.js';
+export {redactExecError, redactSecrets} from './redact.js';
 export {readPackageManifest} from './manifest.js';
 export {getResourcePath, unzipFile} from './resource.js';
 export {getSdkRootFromEnv, requireSdkRoot, getJavaHome, getJavaForOs} from './sdk.js';

package/lib/utils/helpers/redact.ts

@@ -0,0 +1,59 @@
+import {util} from '@appium/support';
+
+const SENSITIVE_ARGS = new Set(['--ks-pass', '--key-pass', '-storepass', '-keypass']);
+const LOCK_CREDENTIAL_VERBS = new Set(['verify', 'clear', 'set-pin', 'set-password', 'set-pattern']);
+// Matches a `locksettings` credential command embedded in a single (e.g. `su root "..."`) argument
+const LOCK_COMMAND_RE = /\blocksettings\s+(verify|clear|set-pin|set-password|set-pattern)\b[\s\S]*$/;
+const REDACTED = 'REDACTED';
+
+/**
+ * Masks secrets in command line arguments (keystore passwords and lock screen credentials)
+ * so the result is safe to log.
+ *
+ * @param args - The command line arguments
+ * @returns A copy of the arguments with the secret values replaced
+ */
+export function redactSecrets(args: readonly string[]): string[] {
+  let isLockCredentialPart = false;
+  return args.map((arg, i) => {
+    if (isLockCredentialPart) {
+      return arg === '--old' ? arg : REDACTED;
+    }
+    if (args[i - 1] === 'locksettings' && LOCK_CREDENTIAL_VERBS.has(arg)) {
+      isLockCredentialPart = true;
+      return arg;
+    }
+    if (i > 0 && SENSITIVE_ARGS.has(args[i - 1])) {
+      return REDACTED;
+    }
+    const [name] = arg.split('=', 1);
+    if (SENSITIVE_ARGS.has(name) && arg.includes('=')) {
+      return `${name}=${REDACTED}`;
+    }
+    return arg.replace(LOCK_COMMAND_RE, `locksettings $1 ${REDACTED}`);
+  });
+}
+
+/**
+ * Masks secrets in the message and stack of an error thrown by `teen_process.exec`,
+ * which embed the full command line. The error is modified in place.
+ *
+ * @param err - The caught error
+ * @param cmd - The executable passed to `exec`
+ * @param args - The arguments passed to `exec`
+ * @returns The same error, so it can be rethrown as `throw redactExecError(...)`
+ */
+export function redactExecError<T>(err: T, cmd: string, args: readonly string[]): T {
+  if (!(err instanceof Error)) {
+    return err;
+  }
+  const rawCmd = util.quote([cmd, ...args]);
+  const safeCmd = util.quote(redactSecrets([cmd, ...args]));
+  if (rawCmd !== safeCmd) {
+    err.message = err.message.split(rawCmd).join(safeCmd);
+    if (err.stack) {
+      err.stack = err.stack.split(rawCmd).join(safeCmd);
+    }
+  }
+  return err;
+}

package/lib/utils/index.ts

@@ -14,6 +14,8 @@ export const getSdkRootFromEnv = helpers.getSdkRootFromEnv;
 export const requireSdkRoot = helpers.requireSdkRoot;
 export const getJavaHome = helpers.getJavaHome;
 export const getJavaForOs = helpers.getJavaForOs;
+export const redactExecError = helpers.redactExecError;
+export const redactSecrets = helpers.redactSecrets;
 
 export const memoize = util.memoize;
 export const cloneDeep = lodash.cloneDeep;

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "appium-adb",
-  "version": "16.0.9",
+  "version": "16.1.2",
   "description": "Android Debug Bridge interface",
-  "homepage": "https://github.com/appium/appium-adb",
+  "homepage": "https://appium.io",
   "bugs": {
-    "url": "https://github.com/appium/appium-adb/issues"
+    "url": "https://github.com/appium/appium-android/issues"
   },
   "license": "Apache-2.0",
   "author": "Appium Contributors",
   "repository": {
     "type": "git",
-    "url": "https://github.com/appium/appium-adb.git"
+    "url": "https://github.com/appium/appium-android.git",
+    "directory": "packages/adb"
   },
   "bin": {},
   "directories": {
@@ -20,6 +21,7 @@
     "keys",
     "lib",
     "build/lib",
+    "!.DS_Store",
     "CHANGELOG.md"
   ],
   "type": "module",
@@ -36,32 +38,24 @@
     "build": "tsc -b",
     "clean": "npm run build -- --clean",
     "dev": "npm run build -- --watch",
-    "lint": "oxlint -c oxlint.config.mjs .",
-    "lint:fix": "oxlint -c oxlint.config.mjs --fix .",
-    "prepare": "npm run rebuild",
+    "prepare": "npm run build",
     "rebuild": "npm run clean && npm run build",
-    "format": "oxfmt -c oxfmt.config.mjs .",
-    "format:check": "oxfmt -c oxfmt.config.mjs --check .",
     "test": "node --enable-source-maps --experimental-test-module-mocks --test --test-force-exit --test-timeout=60000 \"./build/test/unit/**/*.spec.js\"",
-    "e2e-test": "node --enable-source-maps --test --test-force-exit --test-concurrency=1 --test-timeout=300000 \"./build/test/functional/**/*.spec.js\""
+    "test:e2e": "node --enable-source-maps --test --test-force-exit --test-concurrency=1 --test-timeout=300000 \"./build/test/functional/**/*.spec.js\""
   },
   "dependencies": {
     "@appium/support": "^7.2.6",
-    "async-lock": "^1.0.0",
-    "asyncbox": "^6.4.3",
+    "asyncbox": "^6.5.0",
     "ini": "^6.0.0",
     "lru-cache": "^11.1.0",
     "semver": "^7.0.0",
     "teen_process": "^4.2.0"
   },
   "devDependencies": {
-    "@appium/oxc-config": "^1.1.0",
-    "@appium/semantic-release-config": "^1.1.0",
     "@appium/tsconfig": "^1.2.0",
     "@appium/types": "^1.0.0-rc.1",
-    "@types/async-lock": "^1.4.0",
     "@types/ini": "^4.1.0",
-    "@types/node": "^26.0.0",
+    "@types/node": "^26.6.5",
     "@types/semver": "^7.5.0",
     "@types/sinon": "^22.0.0",
     "sinon": "^22.0.0"
@@ -69,5 +63,6 @@
   "engines": {
     "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
     "npm": ">=10"
-  }
+  },
+  "gitHead": "dd7fac6576be570d54de8ff2874b88426b4446dd"
 }