@appium/base-driver 10.6.0 → 10.7.0

package/lib/basedriver/core.ts

@@ -14,10 +14,7 @@ import type {
 import AsyncLock from 'async-lock';
 import {util} from '@appium/support';
 import os from 'node:os';
-import {
-  DEFAULT_BASE_PATH,
-  PROTOCOLS,
-} from '../constants';
+import {DEFAULT_BASE_PATH, PROTOCOLS} from '../constants';
 import {errors} from '../protocol';
 import {DeviceSettings} from './device-settings';
 import * as helpers from './helpers';
@@ -31,7 +28,8 @@ const ALL_DRIVERS_MATCH = '*';
 const FEATURE_NAME_SEPARATOR = ':';
 
 export class DriverCore<const C extends Constraints, Settings extends StringRecord = StringRecord>
-  extends ExtensionCore implements Core<C, Settings>
+  extends ExtensionCore
+  implements Core<C, Settings>
 {
   /**
    * Make the basedriver version available so for any driver which inherits from this package, we
@@ -41,7 +39,7 @@ export class DriverCore<const C extends Constraints, Settings extends StringReco
 
   sessionId: string | null;
 
-  sessionCreationTimestampMs: number;
+  sessionCreationTimestampMs!: number;
 
   opts: DriverOpts<C>;
 
@@ -104,7 +102,6 @@ export class DriverCore<const C extends Constraints, Settings extends StringReco
     super();
     this._log = this.log; // TODO: remove references to this._log and use this.log instead
 
-
     // setup state
     this.opts = opts as DriverOpts<C>;
 
@@ -273,19 +270,23 @@ export class DriverCore<const C extends Constraints, Settings extends StringReco
         // but better be safe than sorry
         throw new Error(
           `The full feature name must include both the automation name ` +
-          `'${this.opts.automationName}' or the '${ALL_DRIVERS_MATCH}' ` +
-          `wildcard to apply the feature to all installed drivers, and ` +
-          `the feature name split by a colon. Got '${fullName}' instead`
+            `'${this.opts.automationName}' or the '${ALL_DRIVERS_MATCH}' ` +
+            `wildcard to apply the feature to all installed drivers, and ` +
+            `the feature name split by a colon. Got '${fullName}' instead`,
         );
       }
       return [
         fullName.substring(0, separatorPos).toLowerCase(),
-        fullName.substring(separatorPos + 1)
+        fullName.substring(separatorPos + 1),
       ];
     };
     const parseFullNames = (fullNames: string[]) => fullNames.map(parseFullName);
-    const matches = ([automationName, featureName]: [string, string]) =>
-      [currentAutomationName, ALL_DRIVERS_MATCH].includes(automationName) && featureName === name;
+    const matches = (pair: string[]) => {
+      const [automationName, featureName] = pair;
+      return (
+        [currentAutomationName, ALL_DRIVERS_MATCH].includes(automationName) && featureName === name
+      );
+    };
 
     // if we have explicitly denied this feature, return false immediately
     if (!util.isEmpty(this.denyInsecure) && parseFullNames(this.denyInsecure).some(matches)) {
@@ -406,5 +407,4 @@ export class DriverCore<const C extends Constraints, Settings extends StringReco
       this.noCommandTimer = null;
     }
   }
-
 }

package/lib/basedriver/device-settings.ts

@@ -23,7 +23,7 @@ export class DeviceSettings<T extends StringRecord = StringRecord> implements ID
    */
   constructor(
     defaultSettings: T = {} as T,
-    onSettingsUpdate: SettingsUpdateListener<T> = async () => {}
+    onSettingsUpdate: SettingsUpdateListener<T> = async () => {},
   ) {
     this._settings = {...defaultSettings};
     this._onSettingsUpdate = onSettingsUpdate;
@@ -38,14 +38,14 @@ export class DeviceSettings<T extends StringRecord = StringRecord> implements ID
     if (!util.isPlainObject(newSettings)) {
       throw new errors.InvalidArgumentError(
         `Settings update should be called with valid JSON. Got ` +
-          `${JSON.stringify(newSettings)} instead`
+          `${JSON.stringify(newSettings)} instead`,
       );
     }
 
     if (node.getObjectSize({...this._settings, ...newSettings}) >= MAX_SETTINGS_SIZE) {
       throw new errors.InvalidArgumentError(
         `New settings cannot be applied, because the overall ` +
-          `object size exceeds the allowed limit of ${util.toReadableSizeString(MAX_SETTINGS_SIZE)}`
+          `object size exceeds the allowed limit of ${util.toReadableSizeString(MAX_SETTINGS_SIZE)}`,
       );
     }
 
@@ -56,11 +56,7 @@ export class DeviceSettings<T extends StringRecord = StringRecord> implements ID
           continue;
         }
       }
-      await this._onSettingsUpdate(
-        prop as keyof T,
-        newSettings[prop],
-        this._settings[prop]
-      );
+      await this._onSettingsUpdate(prop as keyof T, newSettings[prop], this._settings[prop]);
       this._settings[prop] = newSettings[prop];
     }
   }

package/lib/basedriver/driver.ts

@@ -1,3 +1,4 @@
+import type AsyncLock from 'async-lock';
 import {util} from '@appium/support';
 import {
   BASE_DESIRED_CAP_CONSTRAINTS,
@@ -24,8 +25,11 @@ import {DELETE_SESSION_COMMAND, determineProtocol, errors} from '../protocol';
 import {processCapabilities, validateCaps} from './capabilities';
 import {DriverCore} from './core';
 import * as helpers from './helpers';
-import {resolveExecuteExtensionName} from '../helpers/extension-command-name';
 import {mergePlainObjects} from '../utils';
+import {resolveExecuteExtensionName} from '../helpers/extension-command-name';
+
+type CommandInvoker<C extends Constraints> = BaseDriver<C> &
+  Record<string, ((...args: any[]) => any) | undefined>;
 
 const EVENT_SESSION_INIT = 'newSessionRequested';
 const EVENT_SESSION_START = 'newSessionStarted';
@@ -34,20 +38,20 @@ const EVENT_SESSION_QUIT_DONE = 'quitSessionFinished';
 const ON_UNEXPECTED_SHUTDOWN_EVENT = 'onUnexpectedShutdown';
 
 export class BaseDriver<
-    const C extends Constraints,
-    CArgs extends StringRecord = StringRecord,
-    Settings extends StringRecord = StringRecord,
-    CreateResult = DefaultCreateSessionResult<C>,
-    DeleteResult = DefaultDeleteSessionResult,
-    SessionData extends StringRecord = StringRecord,
-  >
+  const C extends Constraints,
+  CArgs extends StringRecord = StringRecord,
+  Settings extends StringRecord = StringRecord,
+  CreateResult = DefaultCreateSessionResult<C>,
+  DeleteResult = DefaultDeleteSessionResult,
+  SessionData extends StringRecord = StringRecord,
+>
   extends DriverCore<C, Settings>
   implements Driver<C, CArgs, Settings, CreateResult, DeleteResult, SessionData>
 {
   cliArgs: CArgs & ServerArgs;
   caps: DriverCaps<C>;
-  originalCaps: W3CDriverCaps<C>;
-  desiredCapConstraints: C;
+  originalCaps!: W3CDriverCaps<C>;
+  desiredCapConstraints!: C;
   server?: AppiumServer;
   serverHost?: string;
   serverPort?: number;
@@ -69,7 +73,11 @@ export class BaseDriver<
    */
   protected get _desiredCapConstraints(): Readonly<BaseDriverCapConstraints & C> {
     return Object.freeze(
-      mergePlainObjects({}, BASE_DESIRED_CAP_CONSTRAINTS, this.desiredCapConstraints) as BaseDriverCapConstraints & C
+      mergePlainObjects(
+        {},
+        BASE_DESIRED_CAP_CONSTRAINTS,
+        this.desiredCapConstraints,
+      ) as BaseDriverCapConstraints & C,
     );
   }
 
@@ -99,8 +107,10 @@ export class BaseDriver<
       throw new errors.NoSuchDriverError('The driver was unexpectedly shut down!');
     }
 
+    const invoker = this as unknown as CommandInvoker<C>;
+    const command = invoker[cmd];
     // If we don't have this command, it must not be implemented
-    if (!this[cmd]) {
+    if (!command) {
       await this.startNewCommandTimeout();
       throw new errors.NotYetImplementedError();
     }
@@ -115,14 +125,14 @@ export class BaseDriver<
       };
       try {
         return await Promise.race([
-          this[cmd](...args),
+          command.call(this, ...args),
           // This promise is needed to monitor if the session has been
           // shut down unexpectedly while the command was running
           new Promise((resolve, reject) => {
             unexpectedShutdownResolver = resolve;
             unexpectedShutdownRejecter = reject;
             this.eventEmitter.once(ON_UNEXPECTED_SHUTDOWN_EVENT, onUnexpectedShutdown);
-          })
+          }),
         ]);
       } finally {
         if (unexpectedShutdownRejecter && unexpectedShutdownResolver) {
@@ -139,7 +149,11 @@ export class BaseDriver<
         // automatic session deletion in this.onCommandTimeout. Of course we don't
         // want to trigger the timer when the user is shutting down the session
         // intentionally
-        if (!wasSessionShutdownUnexpectedly && this.isCommandsQueueEnabled && cmd !== DELETE_SESSION_COMMAND) {
+        if (
+          !wasSessionShutdownUnexpectedly &&
+          this.isCommandsQueueEnabled &&
+          cmd !== DELETE_SESSION_COMMAND
+        ) {
           // resetting existing timeout
           await this.startNewCommandTimeout();
         }
@@ -147,13 +161,15 @@ export class BaseDriver<
     };
 
     const synchronizationKey = BaseDriver.name;
-    // eslint-disable-next-line dot-notation
-    const commandsQueueLen: number = this.commandsQueueGuard['queues']?.[synchronizationKey]?.length ?? 0;
+    const commandsQueueGuard = this.commandsQueueGuard as AsyncLock & {
+      queues?: Record<string, unknown[]>;
+    };
+    const commandsQueueLen: number = commandsQueueGuard.queues?.[synchronizationKey]?.length ?? 0;
     if (this.isCommandsQueueEnabled && commandsQueueLen > 0) {
       this.log.debug(
         `Scheduling the '${cmd}' command to the ${this.constructor.name} commands queue. ` +
-        `${util.pluralize('queue item', commandsQueueLen, true)} ${commandsQueueLen === 1 ? 'is' : 'are'} ` +
-        `already waiting for execution.`
+          `${util.pluralize('queue item', commandsQueueLen, true)} ${commandsQueueLen === 1 ? 'is' : 'are'} ` +
+          `already waiting for execution.`,
       );
     }
 
@@ -182,7 +198,7 @@ export class BaseDriver<
     if (cmd === 'execute') {
       const firstArg = args?.[0];
       if (typeof firstArg === 'string' && firstArg.trim().length > 0) {
-        return resolveExecuteExtensionName.call(this, firstArg);
+        return resolveExecuteExtensionName.call(this as BaseDriver<Constraints>, firstArg);
       }
     }
 
@@ -240,15 +256,12 @@ export class BaseDriver<
     this.log.debug('Running generic full reset');
 
     // preserving state
-    const currentConfig = {};
-    for (const property of [
-      'implicitWaitMs',
-      'newCommandTimeoutMs',
-      'sessionId',
-      'resetOnUnexpectedShutdown',
-    ]) {
-      currentConfig[property] = this[property];
-    }
+    const currentConfig = {
+      implicitWaitMs: this.implicitWaitMs,
+      newCommandTimeoutMs: this.newCommandTimeoutMs,
+      sessionId: this.sessionId,
+      shutdownUnexpectedly: this.shutdownUnexpectedly,
+    };
 
     try {
       if (this.sessionId !== null) {
@@ -258,9 +271,7 @@ export class BaseDriver<
       await this.createSession(this.originalCaps);
     } finally {
       // always restore state.
-      for (const [key, value] of Object.entries(currentConfig)) {
-        this[key] = value;
-      }
+      Object.assign(this, currentConfig);
     }
     await this.clearNewCommandTimeout();
   }
@@ -313,7 +324,8 @@ export class BaseDriver<
       ) as DriverCaps<C>;
       caps = fixCaps(caps, this._desiredCapConstraints, this.log) as DriverCaps<C>;
     } catch (e) {
-      throw new errors.SessionNotCreatedError(e.message);
+      const message = e instanceof Error ? e.message : String(e);
+      throw new errors.SessionNotCreatedError(message);
     }
 
     this.validateDesiredCaps(caps);
@@ -404,11 +416,7 @@ export class BaseDriver<
       this.log.warn(`The following provided capabilities were not recognized by this driver:`);
       for (const cap of extraCaps) {
         const suggestion = getLevenshteinSuggestion(cap, knownCaps);
-        this.log.warn(
-          suggestion
-            ? `  ${cap} (did you mean '${suggestion}'?)`
-            : `  ${cap}`,
-        );
+        this.log.warn(suggestion ? `  ${cap} (did you mean '${suggestion}'?)` : `  ${cap}`);
       }
     }
   }
@@ -421,11 +429,13 @@ export class BaseDriver<
     try {
       validateCaps(caps, this._desiredCapConstraints);
     } catch (e) {
+      const capError = e instanceof Error ? e : new Error(String(e));
       throw this.log.errorWithException(
         new errors.SessionNotCreatedError(
           `Session capabilities were not valid for the ` +
-          `following reason(s): ${e.message}`, e
-        )
+            `following reason(s): ${capError.message}`,
+          capError,
+        ),
       );
     }
 

package/lib/basedriver/extension-core.ts

@@ -9,9 +9,7 @@ import type {
   IpcData,
   StringRecord,
 } from '@appium/types';
-import {
-  MAX_LOG_BODY_LENGTH,
-} from '../constants';
+import {MAX_LOG_BODY_LENGTH} from '../constants';
 import {errors} from '../protocol';
 import {BIDI_COMMANDS} from '../protocol/bidi-commands';
 import {generateDriverLogPrefix} from './helpers';
@@ -22,10 +20,9 @@ export class ExtensionCore {
   _logPrefix?: string;
   // used to handle driver events
   readonly eventEmitter: NodeJS.EventEmitter;
-  protected _log: AppiumLogger;
+  protected _log!: AppiumLogger;
   private ipc?: IAppiumIpc;
 
-
   constructor(logPrefix?: string) {
     this._logPrefix = logPrefix;
     this.bidiEventSubs = {};
@@ -46,7 +43,9 @@ export class ExtensionCore {
   updateBidiCommands(cmds: BidiModuleMap): void {
     const overlappingKeys = Object.keys(cmds).filter((key) => key in this.bidiCommands);
     if (overlappingKeys.length) {
-      this.log.warn(`Overwriting existing bidi modules: ${JSON.stringify(overlappingKeys)}. This may not be intended!`);
+      this.log.warn(
+        `Overwriting existing bidi modules: ${JSON.stringify(overlappingKeys)}. This may not be intended!`,
+      );
     }
     this.bidiCommands = {
       ...this.bidiCommands,
@@ -74,7 +73,7 @@ export class ExtensionCore {
     }
 
     // if the command module or method isn't part of our spec, reject
-    if (!(this.bidiCommands[moduleName]?.[methodName])) {
+    if (!this.bidiCommands[moduleName]?.[methodName]) {
       throw new errors.UnknownCommandError();
     }
 
@@ -85,13 +84,19 @@ export class ExtensionCore {
     }
 
     // If the driver doesn't have this command, it must not be implemented
-    if (!this[command]) {
+    const handler = (this as ExtensionCore & Record<string, unknown>)[command];
+    if (typeof handler !== 'function') {
       throw new errors.NotYetImplementedError();
     }
   }
 
-  async executeBidiCommand(bidiCmd: string, bidiParams: StringRecord, next?: () => Promise<any>, driver?: ExtensionCore): Promise<BiDiResultData> {
-    const handlerType = (next && driver) ? 'plugin' : 'driver';
+  async executeBidiCommand(
+    bidiCmd: string,
+    bidiParams: StringRecord,
+    next?: () => Promise<any>,
+    driver?: ExtensionCore,
+  ): Promise<BiDiResultData> {
+    const handlerType = next && driver ? 'plugin' : 'driver';
     const [moduleName, methodName] = bidiCmd.split('.');
     this.ensureBidiCommandExists(moduleName, methodName);
     const {command, params} = this.bidiCommands[moduleName][methodName];
@@ -114,17 +119,26 @@ export class ExtensionCore {
         args.push(bidiParams[optionalParam]);
       }
     }
-    const logParams = util.truncateString(JSON.stringify(bidiParams), {length: MAX_LOG_BODY_LENGTH});
+    const logParams = util.truncateString(JSON.stringify(bidiParams), {
+      length: MAX_LOG_BODY_LENGTH,
+    });
     this.log.debug(
       `Executing bidi command '${bidiCmd}' with params ${logParams} by passing to ${handlerType} ` +
         `method '${command}'`,
     );
     // call the handler with the signature appropriate to extension type (plugin or driver)
-    const response = (next && driver) ? await this[command](next, driver, ...args) : await this[command](...args);
-    const finalResponse = response === undefined ? {} : response;
+    const commandHandler = (
+      this as unknown as Record<string, (...handlerArgs: any[]) => Promise<unknown>>
+    )[command];
+    const response =
+      next && driver
+        ? await commandHandler.call(this, next, driver, ...args)
+        : await commandHandler.call(this, ...args);
+    const finalResponse: BiDiResultData =
+      response === undefined ? {} : (response as BiDiResultData);
     this.log.debug(
       `Responding to bidi command '${bidiCmd}' with ` +
-      `${util.truncateString(JSON.stringify(finalResponse), {length: MAX_LOG_BODY_LENGTH})}`
+        `${util.truncateString(JSON.stringify(finalResponse), {length: MAX_LOG_BODY_LENGTH})}`,
     );
     return finalResponse;
   }
@@ -145,9 +159,11 @@ export class ExtensionCore {
 
   ipcSubscribe<T extends IpcData>(topic: string): IIpcSubscription<T> {
     if (!this.ipc) {
-      throw new Error(`Cannot subscribe to an IPC topic without an IPC object assigned. ` +
-                      `This is likely a programming error. ipcSubscribe should be called in the ` +
-                      `onIpcInit handler or after you are certain that createSession has completed successfully.`);
+      throw new Error(
+        `Cannot subscribe to an IPC topic without an IPC object assigned. ` +
+          `This is likely a programming error. ipcSubscribe should be called in the ` +
+          `onIpcInit handler or after you are certain that createSession has completed successfully.`,
+      );
     }
     return this.ipc.subscribe<T>(topic, generateDriverLogPrefix(this));
   }

package/lib/basedriver/helpers.ts

@@ -1,3 +1,4 @@
+import nodeFs from 'node:fs';
 import path from 'node:path';
 import {log as logger} from './logger';
 import {tempDir, fs, util, timing, node} from '@appium/support';
@@ -13,14 +14,15 @@ import type {
 } from '@appium/types';
 import type {AxiosResponseHeaders, RawAxiosRequestHeaders} from 'axios';
 import type {Readable} from 'node:stream';
+import type {PackageJson} from 'type-fest';
 
 // for compat with running tests transpiled and in-place
-export const {version: BASEDRIVER_VER} = fs.readPackageJsonFrom(__dirname);
+export const BASEDRIVER_VER = readBaseDriverVersion();
 
 const CACHED_APPS_MAX_AGE_MS = 1000 * 60 * toNaturalNumber(60 * 24, 'APPIUM_APPS_CACHE_MAX_AGE');
 const MAX_CACHED_APPS = toNaturalNumber(1024, 'APPIUM_APPS_CACHE_MAX_ITEMS');
 const HTTP_STATUS_NOT_MODIFIED = 304;
-const DEFAULT_REQ_HEADERS = Object.freeze({
+const DEFAULT_REQ_HEADERS: RawAxiosRequestHeaders = Object.freeze({
   'user-agent': `Appium (BaseDriver v${BASEDRIVER_VER})`,
 });
 const AVG_DOWNLOAD_SPEED_MEASUREMENT_THRESHOLD_SEC = 2;
@@ -31,7 +33,7 @@ const APPLICATIONS_CACHE = new LRUCache<string, CachedAppInfoEntry>({
   dispose: ({fullPath}, app) => {
     logger.info(
       `The application '${app}' cached at '${fullPath}' has ` +
-        `expired after ${CACHED_APPS_MAX_AGE_MS}ms`
+        `expired after ${CACHED_APPS_MAX_AGE_MS}ms`,
     );
     if (fullPath) {
       void fs.rimraf(fullPath);
@@ -51,7 +53,7 @@ process.on('exit', () => {
 
   const appPaths = [...APPLICATIONS_CACHE.values()].map(({fullPath}) => fullPath);
   logger.debug(
-    `Performing cleanup of ${util.pluralize('cached application', appPaths.length, true)}`
+    `Performing cleanup of ${util.pluralize('cached application', appPaths.length, true)}`,
   );
   for (const appPath of appPaths) {
     if (!appPath) {
@@ -98,7 +100,7 @@ interface CachedAppInfoEntry extends Omit<CachedAppInfo, 'packageHash'> {
  */
 export async function configureApp(
   app: string,
-  options: string | string[] | ConfigureAppOptions = {} as ConfigureAppOptions
+  options: string | string[] | ConfigureAppOptions = {} as ConfigureAppOptions,
 ): Promise<string> {
   if (typeof app !== 'string') {
     // immediately shortcircuit if not given an app
@@ -140,7 +142,7 @@ export async function configureApp(
     newApp = path.resolve(process.cwd(), newApp);
     logger.warn(
       `The current application path '${app}' is not absolute ` +
-      `and has been rewritten to '${newApp}'. Consider using absolute paths rather than relative`
+        `and has been rewritten to '${newApp}'. Consider using absolute paths rather than relative`,
     );
     app = newApp;
   }
@@ -194,7 +196,7 @@ export async function configureApp(
           }
           logger.info(
             `The application at '${cachedAppInfo.fullPath}' does not exist anymore ` +
-              `or its integrity has been damaged. Deleting it from the internal cache`
+              `or its integrity has been damaged. Deleting it from the internal cache`,
           );
           APPLICATIONS_CACHE.delete(appCacheKey);
 
@@ -215,10 +217,13 @@ export async function configureApp(
           });
         } else {
           const fileName = determineFilename(headers, pathname ?? '', supportedAppExtensions);
-          newApp = await fetchApp(stream, await tempDir.path({
-            prefix: fileName,
-            suffix: '',
-          }));
+          newApp = await fetchApp(
+            stream,
+            await tempDir.path({
+              prefix: fileName,
+              suffix: '',
+            }),
+          );
         }
       } finally {
         if (!stream.closed) {
@@ -280,7 +285,8 @@ export async function configureApp(
     }
 
     verifyAppExtension(newApp, supportedAppExtensions);
-    return appCacheKey !== toCacheKey(newApp) && (packageHash || Object.values(remoteAppProps).some(Boolean))
+    return appCacheKey !== toCacheKey(newApp) &&
+      (packageHash || Object.values(remoteAppProps).some(Boolean))
       ? await storeAppInCache(newApp)
       : newApp;
   });
@@ -380,7 +386,9 @@ export function generateDriverLogPrefix(obj: object | null, _sessionId?: string
 
 // #region Private helpers
 
-function parseAppLink(appLink: string): URL | {protocol?: string; pathname?: string; href?: string; search?: string} {
+function parseAppLink(
+  appLink: string,
+): URL | {protocol?: string; pathname?: string; href?: string; search?: string} {
   try {
     return new URL(appLink);
   } catch {
@@ -430,7 +438,10 @@ function toCacheKey(app: string): string {
   return app;
 }
 
-async function queryAppLink(appLink: string, reqHeaders: RawAxiosRequestHeaders): Promise<RemoteAppData> {
+async function queryAppLink(
+  appLink: string,
+  reqHeaders: RawAxiosRequestHeaders,
+): Promise<RemoteAppData> {
   const url = new URL(appLink);
   // Extract credentials, then remove them from the URL for axios
   const {username, password} = url;
@@ -451,10 +462,9 @@ async function queryAppLink(appLink: string, reqHeaders: RawAxiosRequestHeaders)
     const {data: stream, headers, status} = await axios(requestOpts);
     return {stream, headers, status};
   } catch (err) {
-    throw new Error(
-      `Cannot download the app from ${axiosUrl}: ${(err as Error).message}`,
-      {cause: err}
-    );
+    throw new Error(`Cannot download the app from ${axiosUrl}: ${(err as Error).message}`, {
+      cause: err,
+    });
   }
 }
 
@@ -480,7 +490,7 @@ async function fetchApp(srcStream: Readable, dstPath: string): Promise<string> {
   const {size} = await fs.stat(dstPath);
   logger.debug(
     `The application (${util.toReadableSizeString(size)}) ` +
-      `has been downloaded to '${dstPath}' in ${secondsElapsed.toFixed(3)}s`
+      `has been downloaded to '${dstPath}' in ${secondsElapsed.toFixed(3)}s`,
   );
   // it does not make much sense to approximate the speed for short downloads
   if (secondsElapsed >= AVG_DOWNLOAD_SPEED_MEASUREMENT_THRESHOLD_SEC) {
@@ -494,13 +504,16 @@ async function fetchApp(srcStream: Readable, dstPath: string): Promise<string> {
 function determineFilename(
   headers: AxiosResponseHeaders | RawAxiosRequestHeaders,
   pathname: string,
-  supportedAppExtensions: string[]
+  supportedAppExtensions: string[],
 ): string {
   const basename = fs.sanitizeName(path.basename(decodeURIComponent(pathname ?? '')), {
     replacement: SANITIZE_REPLACEMENT,
   });
   const extname = path.extname(basename);
-  if (headers['content-disposition'] && /^attachment/i.test(String(headers['content-disposition']))) {
+  if (
+    headers['content-disposition'] &&
+    /^attachment/i.test(String(headers['content-disposition']))
+  ) {
     logger.debug(`Content-Disposition: ${headers['content-disposition']}`);
     const match = /filename="([^"]+)/i.exec(String(headers['content-disposition']));
     if (match) {
@@ -513,10 +526,12 @@ function determineFilename(
     ? basename.substring(0, basename.length - extname.length)
     : DEFAULT_BASENAME;
   let resultingExt = extname;
-  if (!supportedAppExtensions.map((ext) => ext.toLowerCase()).includes(resultingExt.toLowerCase())) {
+  if (
+    !supportedAppExtensions.map((ext) => ext.toLowerCase()).includes(resultingExt.toLowerCase())
+  ) {
     logger.info(
       `The current file extension '${resultingExt}' is not supported. ` +
-        `Defaulting to '${supportedAppExtensions[0]}'`
+        `Defaulting to '${supportedAppExtensions[0]}'`,
     );
     resultingExt = supportedAppExtensions[0] as string;
   }
@@ -524,13 +539,15 @@ function determineFilename(
 }
 
 function verifyAppExtension(app: string, supportedAppExtensions: string[]): string {
-  if (supportedAppExtensions.map((ext) => ext.toLowerCase()).includes(path.extname(app).toLowerCase())) {
+  if (
+    supportedAppExtensions.map((ext) => ext.toLowerCase()).includes(path.extname(app).toLowerCase())
+  ) {
     return app;
   }
   throw new Error(
     `New app path '${app}' did not have ` +
       `${util.pluralize('extension', supportedAppExtensions.length, false)}: ` +
-      supportedAppExtensions
+      supportedAppExtensions,
   );
 }
 
@@ -544,7 +561,7 @@ async function calculateFileIntegrity(filePath: string): Promise<string> {
 
 async function isAppIntegrityOk(
   currentPath: string,
-  expectedIntegrity: {file?: string; folder?: number} = {}
+  expectedIntegrity: {file?: string; folder?: number} = {},
 ): Promise<boolean> {
   if (!(await fs.exists(currentPath))) {
     return false;
@@ -570,6 +587,20 @@ function toNaturalNumber(defaultValue: number, envVarName?: string): number {
   return num > 0 ? num : defaultValue;
 }
 
+function readBaseDriverVersion(): string {
+  const pkgRoot = node.getModuleRootSync('@appium/base-driver', __filename);
+  if (!pkgRoot) {
+    throw new Error('Cannot find the @appium/base-driver package root');
+  }
+  const pkg = JSON.parse(
+    nodeFs.readFileSync(path.join(pkgRoot, 'package.json'), 'utf8'),
+  ) as PackageJson;
+  if (typeof pkg.version !== 'string') {
+    throw new Error('Invalid `package.json` for @appium/base-driver');
+  }
+  return pkg.version;
+}
+
 export default {
   configureApp,
   isPackageOrBundle,