@appium/base-driver 9.16.4 → 9.18.0

package/build/lib/protocol/validators.js.map

@@ -1 +1 @@
-{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../../lib/protocol/validators.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAEvB,SAAS,QAAQ,CAAC,CAAC;IACjB,OAAO,gBAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED,SAAS,WAAW,CAAC,EAAE;IACrB,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;AACH,CAAC;AAED,MAAM,UAAU,GAAG;IACjB,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE;QACd,6DAA6D;QAC7D,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2CAA2C,CAAC,EAAE,CAAC;YACpE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IACD,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE;QACnB,WAAW,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC;IACD,kBAAkB,EAAE,CAAC,EAAE,EAAE,EAAE;QACzB,WAAW,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC;IACD,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;QACvB,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,gBAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,MAAM,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7E,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IACD,oBAAoB,EAAE,CAAC,IAAI,EAAE,EAAE;QAC7B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;CACF,CAAC;AAEM,gCAAU"}
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../../lib/protocol/validators.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAEvB,SAAS,QAAQ,CAAC,CAAC;IACjB,OAAO,gBAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED,SAAS,WAAW,CAAC,EAAE;IACrB,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,GAAG;IACjB,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE;QACd,6DAA6D;QAC7D,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2CAA2C,CAAC,EAAE,CAAC;YACpE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IACD,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE;QACnB,WAAW,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC;IACD,kBAAkB,EAAE,CAAC,EAAE,EAAE,EAAE;QACzB,WAAW,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC;IACD,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;QACvB,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,gBAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,MAAM,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7E,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IACD,oBAAoB,EAAE,CAAC,IAAI,EAAE,EAAE;QAC7B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;CACF,CAAC;AAEM,gCAAU"}

package/lib/basedriver/capabilities.ts

@@ -27,7 +27,7 @@ export type ParsedCaps<C extends Constraints> = {
 };
 export type ValidateCapsOpts = {
   /** if true, skip the presence constraint */
-  skipPresenceConstraint?: boolean | undefined;
+  skipPresenceConstraint?: boolean;
 }
 
 /**
@@ -377,7 +377,7 @@ export function promoteAppiumOptionsForObject<C extends Constraints>(obj: NSCapa
     }
     if (isStandardCap(capName)) {
       throw new errors.SessionNotCreatedError(
-        `${PREFIXED_APPIUM_OPTS_CAP} must only contain vendor-specific capabilties. '${capName}' is unexpected`
+        `${PREFIXED_APPIUM_OPTS_CAP} must only contain vendor-specific capabilities. '${capName}' is unexpected`
       );
     }
     return capName;

package/lib/basedriver/commands/timeout.ts

@@ -106,7 +106,7 @@ const TimeoutCommands: ITimeoutCommands = {
 
     this.implicitWaitMs = ms;
     this.log.debug(`Set implicit wait to ${ms}ms`);
-    if (this.managedDrivers && this.managedDrivers.length) {
+    if (this.managedDrivers?.length) {
       this.log.debug('Setting implicit wait on managed drivers');
       for (const driver of this.managedDrivers) {
         if (_.isFunction(driver.setImplicitWait)) {
@@ -119,7 +119,7 @@ const TimeoutCommands: ITimeoutCommands = {
   setNewCommandTimeout<C extends Constraints>(this: BaseDriver<C>, ms: number) {
     this.newCommandTimeoutMs = ms;
     this.log.debug(`Set new command timeout to ${ms}ms`);
-    if (this.managedDrivers && this.managedDrivers.length) {
+    if (this.managedDrivers?.length) {
       this.log.debug('Setting new command timeout on managed drivers');
       for (const driver of this.managedDrivers) {
         if (_.isFunction(driver.setNewCommandTimeout)) {

package/lib/basedriver/core.ts

@@ -41,6 +41,8 @@ export class DriverCore<const C extends Constraints, Settings extends StringReco
 
   sessionId: string | null;
 
+  sessionCreationTimestampMs: number;
+
   opts: DriverOpts<C>;
 
   initialOpts: InitialOpts;
@@ -137,7 +139,7 @@ export class DriverCore<const C extends Constraints, Settings extends StringReco
   /**
    * Set a callback handler if needed to execute a custom piece of code
    * when the driver is shut down unexpectedly. Multiple calls to this method
-   * will cause the handler to be executed mutiple times
+   * will cause the handler to be executed multiple times
    *
    * @param handler The code to be executed on unexpected shutdown.
    * The function may accept one argument, which is the actual error instance, which
@@ -314,7 +316,7 @@ export class DriverCore<const C extends Constraints, Settings extends StringReco
         `Potentially insecure feature '${name}' has not been ` +
           `enabled. If you want to enable this feature and accept ` +
           `the security ramifications, please do so by following ` +
-          `the documented instructions at http://appium.io/docs/en/2.0/guides/security/`,
+          `the documented instructions at http://appium.io/docs/en/latest/guides/security/`,
       );
     }
   }

package/lib/basedriver/driver.ts

@@ -302,6 +302,7 @@ export class BaseDriver<
     this.validateDesiredCaps(caps);
 
     this.sessionId = util.uuidV4();
+    this.sessionCreationTimestampMs = Date.now();
     this.caps = caps;
     // merge caps onto opts so we don't need to worry about what's where
     this.opts = {..._.cloneDeep(this.initialOpts), ...this.caps};
@@ -345,6 +346,11 @@ export class BaseDriver<
 
     return [this.sessionId, caps] as CreateResult;
   }
+
+  /**
+   * Returns the session id and capabilities for the session
+   * @deprecated Use AppiumDriver.getAppiumSessions instead for getting the session data.
+   */
   async getSessions() {
     const ret: MultiSessionData<C>[] = [];
 
@@ -360,7 +366,7 @@ export class BaseDriver<
 
   /**
    * Returns capabilities for the session and event history (if applicable)
-   * @deprecated Use {@linkcode ISessionCommands.getAppiumSessionCapabilities} instead for getting the capabilities.
+   * @deprecated Use {@linkcode getAppiumSessionCapabilities} instead for getting the capabilities.
    * Use {@linkcode EventCommands.getLogEvents} instead to get the event history.
    */
   async getSession() {

package/lib/basedriver/extension-core.ts

@@ -71,7 +71,7 @@ export class ExtensionCore {
     }
 
     // if the command module or method isn't part of our spec, reject
-    if (!this.bidiCommands[moduleName] || !this.bidiCommands[moduleName][methodName]) {
+    if (!(this.bidiCommands[moduleName]?.[methodName])) {
       throw new errors.UnknownCommandError();
     }
 

package/lib/basedriver/helpers.js

@@ -95,7 +95,7 @@ export async function configureApp(
   let shouldUnzipApp = false;
   let packageHash = null;
   /** @type {import('axios').AxiosResponse['headers']|undefined} */
-  let headers = undefined;
+  let headers;
   /** @type {RemoteAppProps} */
   const remoteAppProps = {
     lastModified: null,
@@ -581,7 +581,7 @@ async function unzipApp(zipPath, dstRoot, supportedAppExtensions) {
  *
  * @param {string} app App link.
  * @returns {string} Transformed app link or the original arg if
- * no transfromation is needed.
+ * no transformation is needed.
  */
 function toCacheKey(app) {
   if (!isEnvOptionEnabled('APPIUM_APPS_CACHE_IGNORE_URL_QUERY') || !isSupportedUrl(app)) {
@@ -635,7 +635,7 @@ function isSupportedUrl(app) {
  *
  * @param {string} optionName Option name
  * @param {boolean|null} [defaultValue=null] The value to return if the given env value
- * is not set explcitly
+ * is not set explicitly
  * @returns {boolean} True if the option is enabled
  */
 function isEnvOptionEnabled(optionName, defaultValue = null) {

package/lib/express/middleware.js

@@ -60,7 +60,7 @@ export function fixPythonContentType(basePath) {
     // hack because python client library gives us wrong content-type
     if (
       new RegExp(`^${_.escapeRegExp(basePath)}`).test(req.path) &&
-      /^Python/.test(req.headers['user-agent'] ?? '')
+      (req.headers['user-agent'] ?? '').startsWith('Python')
     ) {
       if (req.headers['content-type'] === 'application/x-www-form-urlencoded') {
         req.headers['content-type'] = 'application/json; charset=utf-8';
@@ -78,12 +78,17 @@ export function fixPythonContentType(basePath) {
  * @returns {any}
  */
 export function handleLogContext(req, res, next) {
-  const requestId = util.uuidV4();
+  const requestId = fetchHeaderValue(req, 'x-request-id') || util.uuidV4();
 
   const sessionId = SESSION_ID_PATTERN.exec(req.url)?.[1];
   const sessionInfo = sessionId ? {sessionId, sessionSignature: calcSignature(sessionId)} : {};
+  const isSensitiveHeaderValue = fetchHeaderValue(req, 'x-appium-is-sensitive');
 
-  log.updateAsyncContext({requestId, ...sessionInfo}, true);
+  log.updateAsyncContext({
+    requestId,
+    ...sessionInfo,
+    isSensitive: ['true', '1', 'yes'].includes(_.toLower(isSensitiveHeaderValue)),
+  }, true);
 
   return next();
 }
@@ -181,6 +186,11 @@ export function catch404Handler(req, res) {
 
 const SESSION_ID_PATTERN = /\/session\/([^/]+)/;
 
+/**
+ * @param {import('express').Request} req
+ * @param {any} body
+ * @returns {any}
+ */
 function patchWithSessionId(req, body) {
   const match = SESSION_ID_PATTERN.exec(req.url);
   if (match) {
@@ -188,3 +198,14 @@ function patchWithSessionId(req, body) {
   }
   return body;
 }
+
+/**
+ * @param {import('express').Request} req
+ * @param {string} name
+ * @returns {string | undefined}
+ */
+function fetchHeaderValue(req, name) {
+  return _.isArray(req.headers[name])
+    ? req.headers[name][0]
+    : req.headers[name];
+}

package/lib/express/server.js

@@ -233,7 +233,7 @@ function configureHttp({httpServer, reject, keepAliveTimeout, gracefulShutdownTi
       }, gracefulShutdownTimeout);
       httpServer.once('close', () => {
         log.info(
-          `Appium HTTP server has been succesfully closed after ` +
+          `Appium HTTP server has been successfully closed after ` +
           `${timer.getDuration().asMilliSeconds.toFixed(0)}ms`
         );
         clearTimeout(onTimeout);
@@ -311,7 +311,7 @@ export function normalizeBasePath(basePath) {
 
   // likewise, ensure the path prefix does always START with /, unless the path
   // is empty meaning no base path at all
-  if (basePath !== '' && basePath[0] !== '/') {
+  if (basePath !== '' && !basePath.startsWith('/')) {
     basePath = `/${basePath}`;
   }
 

package/lib/jsonwp-proxy/protocol-converter.js

@@ -19,12 +19,12 @@ export const COMMAND_URLS_CONFLICTS = [
   {
     commandNames: ['getWindowHandles', 'getWindowHandle'],
     jsonwpConverter(url) {
-      return /\/window$/.test(url)
+      return url.endsWith('/window')
         ? url.replace(/\/window$/, '/window_handle')
         : url.replace(/\/window\/handle(s?)$/, '/window_handle$1');
     },
     w3cConverter(url) {
-      return /\/window_handle$/.test(url)
+      return url.endsWith('/window_handle')
         ? url.replace(/\/window_handle$/, '/window')
         : url.replace(/\/window_handles$/, '/window/handles');
     },

package/lib/jsonwp-proxy/proxy.js

@@ -236,7 +236,7 @@ export class JWProxy {
       }
       this.log.debug(`Got response with status ${status}: ${truncateBody(data)}`);
       isResponseLogged = true;
-      const isSessionCreationRequest = /\/session$/.test(url) && method === 'POST';
+      const isSessionCreationRequest = url.endsWith('/session') && method === 'POST';
       if (isSessionCreationRequest) {
         if (status === 200) {
           this.sessionId = data.sessionId || (data.value || {}).sessionId;

package/lib/protocol/index.js

@@ -12,7 +12,13 @@ import {
   validateExecuteMethodParams,
 } from './protocol';
 import {NO_SESSION_ID_COMMANDS, ALL_COMMANDS, METHOD_MAP, routeToCommandName} from './routes';
-import {errors, isErrorType, errorFromMJSONWPStatusCode, errorFromW3CJsonCode} from './errors';
+import {
+  errors,
+  isErrorType,
+  errorFromMJSONWPStatusCode,
+  errorFromW3CJsonCode,
+  getResponseForW3CError,
+} from './errors';
 
 export {
   routeConfiguringFunction,
@@ -34,4 +40,5 @@ export {
   GET_STATUS_COMMAND,
   LIST_DRIVER_COMMANDS_COMMAND,
   LIST_DRIVER_EXTENSIONS_COMMAND,
+  getResponseForW3CError,
 };

package/lib/protocol/protocol.js

@@ -299,9 +299,9 @@ function buildHandler(app, method, path, spec, driver, isSessCmd) {
       if (spec.deprecated && !deprecatedCommandsLogged.has(spec.command)) {
         deprecatedCommandsLogged.add(spec.command);
         getLogger(driver, req.params.sessionId).warn(
-          `Command '${spec.command}' has been deprecated and will be removed in a future ` +
-            `version of Appium or your driver/plugin. Please use a different method or contact the ` +
-            `driver/plugin author to add explicit support for the command before it is removed`
+          `The ${method} ${path} endpoint has been deprecated and will be removed in a future ` +
+            `version of Appium or your driver/plugin. Please use a different API or contact the ` +
+            `driver/plugin author to add an explicit support for it.`
         );
       }
 

package/lib/protocol/routes.js

@@ -304,27 +304,38 @@ export const METHOD_MAP = /** @type {const} */ ({
   // Appium specific
   //
   '/session/:sessionId/ime/available_engines': {
-    GET: {command: 'availableIMEEngines'},
+    GET: {command: 'availableIMEEngines', deprecated: true},
   },
   '/session/:sessionId/ime/active_engine': {
-    GET: {command: 'getActiveIMEEngine'},
+    GET: {command: 'getActiveIMEEngine', deprecated: true},
   },
   '/session/:sessionId/ime/activated': {
-    GET: {command: 'isIMEActivated'},
+    GET: {command: 'isIMEActivated', deprecated: true},
   },
   '/session/:sessionId/ime/deactivate': {
-    POST: {command: 'deactivateIMEEngine'},
+    POST: {command: 'deactivateIMEEngine', deprecated: true},
   },
   '/session/:sessionId/ime/activate': {
-    POST: {command: 'activateIMEEngine', payloadParams: {required: ['engine']}},
+    POST: {
+      command: 'activateIMEEngine',
+      payloadParams: {required: ['engine']},
+      deprecated: true,
+    },
   },
   '/session/:sessionId/rotation': {
     GET: {command: 'getRotation'},
     POST: {command: 'setRotation', payloadParams: {required: ['x', 'y', 'z']}},
   },
   '/session/:sessionId/location': {
-    GET: {command: 'getGeoLocation'},
-    POST: {command: 'setGeoLocation', payloadParams: {required: ['location']}},
+    GET: {
+      command: 'getGeoLocation',
+      deprecated: true,
+    },
+    POST: {
+      command: 'setGeoLocation',
+      payloadParams: {required: ['location']},
+      deprecated: true,
+    },
   },
   '/session/:sessionId/orientation': {
     GET: {command: 'getOrientation'},
@@ -341,16 +352,18 @@ export const METHOD_MAP = /** @type {const} */ ({
     GET: {command: 'getContexts'},
   },
   '/session/:sessionId/network_connection': {
-    GET: {command: 'getNetworkConnection'},
+    GET: {command: 'getNetworkConnection', deprecated: true},
     POST: {
       command: 'setNetworkConnection',
       payloadParams: {unwrap: 'parameters', required: ['type']},
+      deprecated: true,
     },
   },
   '/session/:sessionId/receive_async_response': {
     POST: {
       command: 'receiveAsyncResponse',
       payloadParams: {required: ['status', 'value']},
+      deprecated: true,
     },
   },
   '/appium/sessions': {
@@ -465,7 +478,7 @@ export const METHOD_MAP = /** @type {const} */ ({
   // #endregion
 
   //
-  // 3rd party vendor/protcol support
+  // 3rd party vendor/protocol support
   //
   // #region Selenium/Chromium browsers
   '/session/:sessionId/se/log': {

package/lib/protocol/validators.js

@@ -10,6 +10,9 @@ function msValidator(ms) {
   }
 }
 
+/**
+ * @deprecated
+ */
 const validators = {
   setUrl: (url) => {
     // either an `xyz://`, `about:`, or `data:` scheme is allowed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/base-driver",
-  "version": "9.16.4",
+  "version": "9.18.0",
   "description": "Base driver class for Appium drivers",
   "keywords": [
     "automation",
@@ -44,12 +44,12 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@appium/support": "^6.0.8",
-    "@appium/types": "^0.25.2",
+    "@appium/support": "^6.1.1",
+    "@appium/types": "^0.26.0",
     "@colors/colors": "1.6.0",
     "async-lock": "1.4.1",
     "asyncbox": "3.0.0",
-    "axios": "1.8.3",
+    "axios": "1.9.0",
     "bluebird": "3.7.2",
     "body-parser": "1.20.3",
     "express": "4.21.2",
@@ -62,7 +62,7 @@
     "path-to-regexp": "8.2.0",
     "serve-favicon": "2.5.0",
     "source-map-support": "0.5.21",
-    "type-fest": "4.37.0",
+    "type-fest": "4.41.0",
     "validate.js": "0.13.1"
   },
   "optionalDependencies": {
@@ -75,7 +75,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "603d1e7fb268342df1d7c12502210ab3c2f380f1",
+  "gitHead": "c8fe4412525f7e1fa237813cf83fe7d98f0125eb",
   "tsd": {
     "directory": "test/types"
   }