@appium/base-driver 10.7.1 → 10.7.2

package/lib/protocol/protocol.ts

@@ -1,32 +1,26 @@
-import {util, logger} from '@appium/support';
-import {validators} from './validators';
+import {logger, util} from '@appium/support';
+import type {AppiumLogger, Core, Driver, DriverMethodDef, MethodMap, PayloadParams} from '@appium/types';
+import type {Application, Request, Response} from 'express';
+import type {MultidimensionalReadonlyArray} from 'type-fest';
+
+import type {BaseDriver} from '../basedriver/driver';
+import {generateDriverLogPrefix} from '../basedriver/helpers';
+import {log} from '../basedriver/logger';
+import {DEFAULT_BASE_PATH, MAX_LOG_BODY_LENGTH, PROTOCOLS} from '../constants';
+import type {RouteConfiguringFunction} from '../express/server';
+import {isW3cCaps} from '../helpers/capabilities';
+import {omitKeys} from '../utils';
 import {
-  errors,
-  isErrorType,
-  getResponseForW3CError,
+  BadParametersError,
   errorFromMJSONWPStatusCode,
   errorFromW3CJsonCode,
-  BadParametersError,
+  errors,
+  getResponseForW3CError,
+  isErrorType,
 } from './errors';
+import {ensureW3cResponse, formatResponseValue} from './helpers';
 import {METHOD_MAP, NO_SESSION_ID_COMMANDS} from './routes';
-import {formatResponseValue, ensureW3cResponse} from './helpers';
-import {MAX_LOG_BODY_LENGTH, PROTOCOLS, DEFAULT_BASE_PATH} from '../constants';
-import {isW3cCaps} from '../helpers/capabilities';
-import {log} from '../basedriver/logger';
-import {omitKeys} from '../utils';
-import {generateDriverLogPrefix} from '../basedriver/helpers';
-import type {
-  Core,
-  AppiumLogger,
-  PayloadParams,
-  MethodMap,
-  Driver,
-  DriverMethodDef,
-} from '@appium/types';
-import type {BaseDriver} from '../basedriver/driver';
-import type {Request, Response, Application} from 'express';
-import type {MultidimensionalReadonlyArray} from 'type-fest';
-import type {RouteConfiguringFunction} from '../express/server';
+import {validators} from './validators';
 
 export const CREATE_SESSION_COMMAND = 'createSession';
 export const DELETE_SESSION_COMMAND = 'deleteSession';
@@ -100,9 +94,7 @@ export function checkParams(
     // we might have an array of parameters,
     // or an array of arrays of parameters, so standardize
     requiredParams = structuredClone(
-      (hasMultipleRequiredParamSets(paramSpec.required)
-        ? paramSpec.required
-        : [paramSpec.required]) as string[][],
+      (hasMultipleRequiredParamSets(paramSpec.required) ? paramSpec.required : [paramSpec.required]) as string[][],
     );
   }
   // optional parameters are just an array
@@ -151,9 +143,7 @@ export function checkParams(
     if (requiredParamsSet.every((name) => actualParamNames.includes(name))) {
       return pickKnownParams(
         args,
-        actualParamNames.filter(
-          (name) => !requiredParamsSet.includes(name) && !optionalParams.includes(name),
-        ),
+        actualParamNames.filter((name) => !requiredParamsSet.includes(name) && !optionalParams.includes(name)),
       );
     }
     if (!util.isEmpty(requiredParamsSet) && util.isEmpty(matchedReqParamSet)) {
@@ -320,14 +310,9 @@ export function driverShouldDoJwpProxy(driver: Core<any>, req: Request, command:
   return true;
 }
 
-function extractProtocol(
-  driver: Core<any>,
-  sessionId: string | null = null,
-): keyof typeof PROTOCOLS {
+function extractProtocol(driver: Core<any>, sessionId: string | null = null): keyof typeof PROTOCOLS {
   const dstDriver =
-    typeof driver.driverForSession === 'function' && sessionId
-      ? driver.driverForSession(sessionId)
-      : driver;
+    typeof driver.driverForSession === 'function' && sessionId ? driver.driverForSession(sessionId) : driver;
   if (dstDriver === driver) {
     // Shortcircuit if the driver instance is not an umbrella driver
     // or it is Fake driver instance, where `driver.driverForSession`
@@ -359,8 +344,7 @@ function wrapParams<T>(paramSets: PayloadParams, jsonObj: T): T | Record<string,
    * The wrap option in the spec enforce wrapping before validation, so that all params are wrapped at
    * the time they are validated and later passed to the commands.
    */
-  return (Array.isArray(jsonObj) || typeof jsonObj !== 'object' || jsonObj === null) &&
-    paramSets.wrap
+  return (Array.isArray(jsonObj) || typeof jsonObj !== 'object' || jsonObj === null) && paramSets.wrap
     ? {[paramSets.wrap]: jsonObj}
     : jsonObj;
 }
@@ -432,12 +416,7 @@ function buildHandler(
       // commands and generally would not want that command to be proxied instead of handled by the
       // plugin)
       let didPluginOverrideProxy = false;
-      if (
-        isSessCmd &&
-        !spec.neverProxy &&
-        spec.command &&
-        driverShouldDoJwpProxy(driver, req, spec.command)
-      ) {
+      if (isSessCmd && !spec.neverProxy && spec.command && driverShouldDoJwpProxy(driver, req, spec.command)) {
         if (
           !('pluginsToHandleCmd' in driver) ||
           typeof driver.pluginsToHandleCmd !== 'function' ||
@@ -473,9 +452,7 @@ function buildHandler(
       if (spec.command === CREATE_SESSION_COMMAND) {
         // try to determine protocol by session creation args, so we can throw a
         // properly formatted error if arguments validation fails
-        currentProtocol = determineProtocol(
-          makeArgs(req.params, jsonObj, spec.payloadParams || {}),
-        );
+        currentProtocol = determineProtocol(makeArgs(req.params, jsonObj, spec.payloadParams || {}));
       }
 
       // ensure that the json payload conforms to the spec
@@ -488,9 +465,7 @@ function buildHandler(
       const args = makeArgs(req.params, jsonObj, spec.payloadParams || {});
       let driverRes: any;
       // validate command args according to MJSONWP
-      const validator = (
-        validators as Record<string, ((...validatorArgs: any[]) => void) | undefined>
-      )[spec.command];
+      const validator = (validators as Record<string, ((...validatorArgs: any[]) => void) | undefined>)[spec.command];
       if (validator) {
         validator(...args);
       }
@@ -500,9 +475,7 @@ function buildHandler(
         `Calling %s.%s() with args: %s`,
         driver.constructor.name,
         spec.command,
-        logger.markSensitive(
-          util.truncateString(JSON.stringify(args), {length: MAX_LOG_BODY_LENGTH}),
-        ),
+        logger.markSensitive(util.truncateString(JSON.stringify(args), {length: MAX_LOG_BODY_LENGTH})),
       );
 
       if (didPluginOverrideProxy) {
@@ -520,8 +493,7 @@ function buildHandler(
       // If `executeCommand` was overridden and the method returns an object
       // with a protocol and value/error property, re-assign the protocol
       if (util.isPlainObject(driverRes) && Object.hasOwn(driverRes, 'protocol')) {
-        currentProtocol =
-          (driverRes as {protocol?: keyof typeof PROTOCOLS}).protocol || currentProtocol;
+        currentProtocol = (driverRes as {protocol?: keyof typeof PROTOCOLS}).protocol || currentProtocol;
         if (driverRes.error) {
           throw driverRes.error;
         }
@@ -558,30 +530,19 @@ function buildHandler(
 
       // if the status is not 0,  throw the appropriate error for status code.
       if (util.hasValue(driverRes)) {
-        if (
-          util.hasValue(driverRes.status) &&
-          !isNaN(driverRes.status) &&
-          parseInt(driverRes.status, 10) !== 0
-        ) {
+        if (util.hasValue(driverRes.status) && !isNaN(driverRes.status) && parseInt(driverRes.status, 10) !== 0) {
           throw errorFromMJSONWPStatusCode(driverRes.status, driverRes.value);
         } else if (util.isPlainObject(driverRes.value) && driverRes.value.error) {
-          throw errorFromW3CJsonCode(
-            driverRes.value.error,
-            driverRes.value.message,
-            driverRes.value.stacktrace,
-          );
+          throw errorFromW3CJsonCode(driverRes.value.error, driverRes.value.message, driverRes.value.stacktrace);
         }
       }
 
       httpResBody.value = driverRes;
       getLogger(driver, sessionId || newSessionId).debug(
         `Responding ` +
-          `to client with driver.${spec.command}() result: ${util.truncateString(
-            JSON.stringify(driverRes),
-            {
-              length: MAX_LOG_BODY_LENGTH,
-            },
-          )}`,
+          `to client with driver.${spec.command}() result: ${util.truncateString(JSON.stringify(driverRes), {
+            length: MAX_LOG_BODY_LENGTH,
+          })}`,
       );
     } catch (err) {
       // if anything goes wrong, figure out what our response should be
@@ -616,9 +577,7 @@ function buildHandler(
       if (isErrorType(err, errors.ProxyRequestError)) {
         actualErr = err.getActualError();
       } else {
-        getLogger(driver, sessionId || newSessionId).debug(
-          `Encountered internal error running command: ${errMsg}`,
-        );
+        getLogger(driver, sessionId || newSessionId).debug(`Encountered internal error running command: ${errMsg}`);
       }
 
       [httpStatus, httpResBody] = getResponseForW3CError(actualErr);
@@ -626,10 +585,7 @@ function buildHandler(
 
     // decode the response, which is either a string or json
     if (typeof httpResBody === 'string') {
-      res
-        .status(httpStatus)
-        .setHeader('content-type', 'application/json; charset=utf-8')
-        .send(httpResBody);
+      res.status(httpStatus).setHeader('content-type', 'application/json; charset=utf-8').send(httpResBody);
     } else {
       if (newSessionId && currentProtocol === PROTOCOLS.W3C) {
         httpResBody.value.sessionId = newSessionId;
@@ -638,9 +594,9 @@ function buildHandler(
     }
   };
   // add the method to the app
-  const registerRoute = (
-    app as Application & Record<string, (routePath: string, ...handlers: any[]) => void>
-  )[method.toLowerCase()].bind(app);
+  const registerRoute = (app as Application & Record<string, (routePath: string, ...handlers: any[]) => void>)[
+    method.toLowerCase()
+  ].bind(app);
   registerRoute(path, (req: Request, res: Response) => {
     void asyncHandler(req, res);
   });

package/lib/protocol/routes.ts

@@ -1,8 +1,9 @@
-import type {Driver, DriverMethodDef, HTTPMethod, MethodMap} from '@appium/types';
 import {util} from '@appium/support';
-import {DEFAULT_BASE_PATH} from '../constants';
-import {match} from 'path-to-regexp';
+import type {Driver, DriverMethodDef, HTTPMethod, MethodMap} from '@appium/types';
 import {LRUCache} from 'lru-cache';
+import {match} from 'path-to-regexp';
+
+import {DEFAULT_BASE_PATH} from '../constants';
 
 const COMMAND_NAMES_CACHE = new LRUCache<string, string>({
   max: 1024,
@@ -234,15 +235,7 @@ export const METHOD_MAP = {
     POST: {
       command: 'printPage',
       payloadParams: {
-        optional: [
-          'orientation',
-          'scale',
-          'background',
-          'page',
-          'margin',
-          'shrinkToFit',
-          'pageRanges',
-        ],
+        optional: ['orientation', 'scale', 'background', 'page', 'margin', 'shrinkToFit', 'pageRanges'],
       },
     },
   },
@@ -470,7 +463,7 @@ export const METHOD_MAP = {
       },
     },
   },
-  '/session/:sessionId/sensors/:sensorType': {
+  '/session/:sessionId/sensor/:sensorType': {
     GET: {command: 'getVirtualSensorInfo'},
     POST: {command: 'updateVirtualSensorReading', payloadParams: {required: ['reading']}},
     DELETE: {command: 'deleteVirtualSensor'},
@@ -588,11 +581,7 @@ export const ALL_COMMANDS = Object.values(METHOD_MAP)
  * @param method - HTTP method (used when one path maps to multiple commands)
  * @param basePath - Optional base path prefix to strip before matching
  */
-export function routeToCommandName(
-  endpoint: string,
-  method?: HTTPMethod,
-  basePath?: string,
-): string | undefined {
+export function routeToCommandName(endpoint: string, method?: HTTPMethod, basePath?: string): string | undefined {
   const resolvedBasePath = basePath ?? DEFAULT_BASE_PATH;
   let normalizedEndpoint = resolvedBasePath
     ? endpoint.replace(new RegExp(`^${util.escapeRegExp(resolvedBasePath)}`), '')
@@ -624,9 +613,7 @@ export function routeToCommandName(
     if (possiblePathnames.some((pp) => routeMatcher(pp))) {
       const spec = routeSpec as Record<string, DriverMethodDef<Driver>>;
       const commandForAnyMethod = () => Object.keys(spec).map((key) => spec[key]?.command)[0];
-      const commandName = normalizedMethod
-        ? spec[normalizedMethod]?.command
-        : commandForAnyMethod();
+      const commandName = normalizedMethod ? spec[normalizedMethod]?.command : commandForAnyMethod();
       if (commandName) {
         COMMAND_NAMES_CACHE.set(cacheKey, commandName);
         return commandName;

package/lib/test-pages/handlers.ts

@@ -1,10 +1,12 @@
 import path from 'node:path';
-import {log} from '../express/logger';
+
 import {fs} from '@appium/support';
 import {sleep} from 'asyncbox';
 import type {Request, Response} from 'express';
-import {compileLodashTemplate} from './template';
+
+import {log} from '../express/logger';
 import {TEST_FIXTURES_DIR} from './static-dir';
+import {compileLodashTemplate} from './template';
 
 type TemplateParams = Record<string, unknown>;
 

package/lib/test-pages/index.ts

@@ -1,9 +1,11 @@
 import path from 'node:path';
+
 import express from 'express';
 import type {Express} from 'express';
 import favicon from 'serve-favicon';
-import {guineaPig, guineaPigScrollable, guineaPigAppBanner, welcome} from './handlers';
-import {produceError, produceCrash} from './crash';
+
+import {produceCrash, produceError} from './crash';
+import {guineaPig, guineaPigAppBanner, guineaPigScrollable, welcome} from './handlers';
 import {TEST_FIXTURES_DIR} from './static-dir';
 
 export interface RegisterTestPagesOpts {
@@ -30,5 +32,5 @@ export function registerTestPages(app: Express, {basePath}: RegisterTestPagesOpt
   app.all('/test/guinea-pig-app-banner', guineaPigAppBanner);
 }
 
-export {TEST_FIXTURES_DIR} from './static-dir';
 export {isLegacyTestPagesEnabled} from './env';
+export {TEST_FIXTURES_DIR} from './static-dir';

package/lib/test-pages/static-dir.ts

@@ -1,5 +1,7 @@
 import path from 'node:path';
 
+import {node} from '@appium/support';
+
 /**
  * Absolute path to bundled legacy test fixture static files.
  *
@@ -9,11 +11,9 @@ import path from 'node:path';
 export const TEST_FIXTURES_DIR = resolveTestFixturesDir();
 
 function resolveTestFixturesDir(): string {
-  const fromDir = __dirname;
-  const parts = path.resolve(fromDir).split(path.sep);
-  const baseDriverIndex = parts.indexOf('base-driver');
-  if (baseDriverIndex < 0) {
-    throw new Error(`Could not find the module root folder in the path: ${fromDir}`);
+  const packageRoot = node.getModuleRootSync('@appium/base-driver', __filename);
+  if (!packageRoot) {
+    throw new Error(`Could not find the module root folder for @appium/base-driver from ${__filename}`);
   }
-  return path.join(parts.slice(0, baseDriverIndex + 1).join(path.sep), 'test-fixtures', 'static');
+  return path.join(packageRoot, 'test-fixtures', 'static');
 }

package/lib/test-pages/template.ts

@@ -1,7 +1,5 @@
 /** Compile a lodash-style template string (`<%= expression %>`) into a render function. */
-export function compileLodashTemplate(
-  template: string,
-): (params: Record<string, unknown>) => string {
+export function compileLodashTemplate(template: string): (params: Record<string, unknown>) => string {
   const parts: string[] = [];
   let lastIndex = 0;
   const re = /<%=\s*([\s\S]+?)\s*%>/g;

package/lib/utils.ts

@@ -46,10 +46,7 @@ export function omitKeys<T extends Record<string, unknown>>(obj: T, keys: readon
 }
 
 /** Return a shallow copy of `obj` containing only listed keys. */
-export function pick<T extends Record<string, unknown>>(
-  obj: T,
-  keys: readonly string[],
-): Partial<T> {
+export function pick<T extends Record<string, unknown>>(obj: T, keys: readonly string[]): Partial<T> {
   const keysToPick = new Set(keys);
   return Object.fromEntries(Object.entries(obj).filter(([k]) => keysToPick.has(k))) as Partial<T>;
 }

package/package.json

@@ -1,78 +1,75 @@
 {
   "name": "@appium/base-driver",
-  "version": "10.7.1",
+  "version": "10.7.2",
+  "gitHead": "f7b20335eab4022e5cbbb627ec86866a994444f8",
   "description": "Base driver class for Appium drivers",
   "keywords": [
+    "android",
     "automation",
+    "firefoxos",
+    "ios",
     "javascript",
     "selenium",
-    "webdriver",
-    "ios",
-    "android",
-    "firefoxos",
-    "testing"
+    "testing",
+    "webdriver"
   ],
   "homepage": "https://appium.io",
   "bugs": {
     "url": "https://github.com/appium/appium/issues"
   },
+  "license": "Apache-2.0",
+  "author": "https://github.com/appium",
   "repository": {
     "type": "git",
     "url": "https://github.com/appium/appium.git",
     "directory": "packages/base-driver"
   },
-  "license": "Apache-2.0",
-  "author": "https://github.com/appium",
-  "types": "./build/lib/index.d.ts",
   "directories": {
     "lib": "lib"
   },
   "files": [
-    "index.js",
-    "index.d.ts",
     "lib",
+    "build/lib",
     "test-fixtures",
-    "build",
-    "tsconfig.json",
-    "!build/tsconfig.tsbuildinfo",
-    "!build/test"
+    "tsconfig.json"
   ],
+  "main": "./build/lib/index.js",
+  "types": "./build/lib/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "test": "run-p test:unit test:types",
-    "test:e2e": "mocha --exit --timeout 20s --slow 10s \"./test/e2e/**/*.spec.ts\"",
-    "test:smoke": "node ./index.js",
-    "test:unit": "mocha \"./test/unit/**/*.spec.ts\"",
+    "test:e2e": "node --test --enable-source-maps --test-force-exit --test-concurrency=1 --test-timeout=20000 \"./build/test/e2e/**/*.spec.js\"",
+    "test:smoke": "node ./build/lib/index.js",
+    "test:unit": "node --test --enable-source-maps --test-timeout=10000 \"./build/test/unit/**/*.spec.js\"",
     "test:types": "tsd"
   },
   "dependencies": {
-    "@appium/support": "7.2.5",
-    "@appium/types": "1.5.1",
+    "@appium/support": "7.2.6",
+    "@appium/types": "1.6.0",
     "async-lock": "1.4.1",
-    "asyncbox": "6.3.0",
-    "axios": "1.18.0",
-    "body-parser": "2.2.2",
+    "asyncbox": "6.3.5",
+    "axios": "1.18.1",
+    "body-parser": "2.3.0",
     "express": "5.2.1",
     "fastest-levenshtein": "1.0.16",
     "http-status-codes": "2.3.0",
-    "lru-cache": "11.5.1",
+    "lru-cache": "11.5.2",
     "method-override": "3.0.0",
     "morgan": "1.11.0",
     "path-to-regexp": "8.4.2",
     "serve-favicon": "2.5.1",
-    "type-fest": "5.7.0"
+    "type-fest": "5.8.0"
   },
   "optionalDependencies": {
     "spdy": "4.0.2"
   },
+  "tsd": {
+    "directory": "test/types"
+  },
   "engines": {
     "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
     "npm": ">=10"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "gitHead": "e6b583a2094f7919ef27b0dc28ebf42b3184852b",
-  "tsd": {
-    "directory": "test/types"
   }
 }

package/tsconfig.json

@@ -1,13 +1,8 @@
 {
   "extends": "@appium/tsconfig/tsconfig.json",
-  "ts-node": {
-    "transpileOnly": true,
-    "compilerOptions": {
-      "rootDir": "."
-    }
-  },
   "compilerOptions": {
     "strict": true,
+    "rootDir": ".",
     "outDir": "build",
     "paths": {
       "@appium/support": ["../support"],
@@ -15,9 +10,19 @@
       "@appium/driver-test-support": ["../driver-test-support"]
     },
     "checkJs": true,
-    "types": ["node", "mocha"]
+    "types": ["node"]
   },
-  "include": ["lib"],
+  "include": ["lib", "test"],
   "exclude": ["build"],
-  "references": [{"path": "../support"}, {"path": "../types"}]
+  "references": [
+    {
+      "path": "../support"
+    },
+    {
+      "path": "../types"
+    },
+    {
+      "path": "../driver-test-support"
+    }
+  ]
 }