@appium/base-driver 8.2.3 → 8.3.1

package/lib/index.js

@@ -5,9 +5,9 @@ import * as driver from './basedriver/driver';
 import * as deviceSettings from './basedriver/device-settings';
 
 const { BaseDriver } = driver;
-const { DeviceSettings, BASEDRIVER_HANDLED_SETTINGS } = deviceSettings;
+const { DeviceSettings } = deviceSettings;
 
-export { BaseDriver, DeviceSettings, BASEDRIVER_HANDLED_SETTINGS };
+export { BaseDriver, DeviceSettings };
 export default BaseDriver;
 
 

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

@@ -5,9 +5,6 @@ import {
   MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY, PROTOCOLS
 } from '../constants';
 
-const log = logger.getLogger('Protocol Converter');
-
-
 export const COMMAND_URLS_CONFLICTS = [
   {
     commandNames: ['execute', 'executeAsync'],
@@ -41,20 +38,24 @@ export const COMMAND_URLS_CONFLICTS = [
     jsonwpConverter: (w3cUrl) => {
       const w3cPropertyRegex = /\/element\/([^/]+)\/property\/([^/]+)/;
       const jsonwpUrl = w3cUrl.replace(w3cPropertyRegex, '/element/$1/attribute/$2');
-      log.info(`Converting W3C '${w3cUrl}' to '${jsonwpUrl}'`);
       return jsonwpUrl;
     },
     w3cConverter: (jsonwpUrl) => jsonwpUrl // Don't convert JSONWP URL to W3C. W3C accepts /attribute and /property
   }
 ];
-
 const {MJSONWP, W3C} = PROTOCOLS;
+const DEFAULT_LOG = logger.getLogger('Protocol Converter');
 
 
 class ProtocolConverter {
-  constructor (proxyFunc) {
+  constructor (proxyFunc, log = null) {
     this.proxyFunc = proxyFunc;
     this._downstreamProtocol = null;
+    this._log = log;
+  }
+
+  get log () {
+    return this._log ?? DEFAULT_LOG;
   }
 
   set downstreamProtocol (value) {
@@ -107,7 +108,7 @@ class ProtocolConverter {
     let response, resBody;
 
     const timeoutRequestObjects = this.getTimeoutRequestObjects(body);
-    log.debug(`Will send the following request bodies to /timeouts: ${JSON.stringify(timeoutRequestObjects)}`);
+    this.log.debug(`Will send the following request bodies to /timeouts: ${JSON.stringify(timeoutRequestObjects)}`);
     for (const timeoutObj of timeoutRequestObjects) {
       [response, resBody] = await this.proxyFunc(url, method, timeoutObj);
 
@@ -130,14 +131,14 @@ class ProtocolConverter {
     const bodyObj = util.safeJsonParse(body);
     if (_.isPlainObject(bodyObj)) {
       if (this.downstreamProtocol === W3C && _.has(bodyObj, 'name') && !_.has(bodyObj, 'handle')) {
-        log.debug(`Copied 'name' value '${bodyObj.name}' to 'handle' as per W3C spec`);
+        this.log.debug(`Copied 'name' value '${bodyObj.name}' to 'handle' as per W3C spec`);
         return await this.proxyFunc(url, method, {
           ...bodyObj,
           handle: bodyObj.name,
         });
       }
       if (this.downstreamProtocol === MJSONWP && _.has(bodyObj, 'handle') && !_.has(bodyObj, 'name')) {
-        log.debug(`Copied 'handle' value '${bodyObj.handle}' to 'name' as per JSONWP spec`);
+        this.log.debug(`Copied 'handle' value '${bodyObj.handle}' to 'name' as per JSONWP spec`);
         return await this.proxyFunc(url, method, {
           ...bodyObj,
           name: bodyObj.handle,
@@ -156,12 +157,12 @@ class ProtocolConverter {
         value = _.isString(text)
           ? [...text]
           : (_.isArray(text) ? text : []);
-        log.debug(`Added 'value' property ${JSON.stringify(value)} to 'setValue' request body`);
+        this.log.debug(`Added 'value' property ${JSON.stringify(value)} to 'setValue' request body`);
       } else if (!util.hasValue(text) && util.hasValue(value)) {
         text = _.isArray(value)
           ? value.join('')
           : (_.isString(value) ? value : '');
-        log.debug(`Added 'text' property ${JSON.stringify(text)} to 'setValue' request body`);
+        this.log.debug(`Added 'text' property ${JSON.stringify(text)} to 'setValue' request body`);
       }
       return await this.proxyFunc(url, method, Object.assign({}, bodyObj, {
         text,
@@ -236,11 +237,11 @@ class ProtocolConverter {
         ? jsonwpConverter(url)
         : w3cConverter(url);
       if (rewrittenUrl === url) {
-        log.debug(`Did not know how to rewrite the original URL '${url}' ` +
+        this.log.debug(`Did not know how to rewrite the original URL '${url}' ` +
           `for ${this.downstreamProtocol} protocol`);
         break;
       }
-      log.info(`Rewrote the original URL '${url}' to '${rewrittenUrl}' ` +
+      this.log.info(`Rewrote the original URL '${url}' to '${rewrittenUrl}' ` +
         `for ${this.downstreamProtocol} protocol`);
       return await this.proxyFunc(rewrittenUrl, method, body);
     }

package/lib/jsonwp-proxy/proxy.js

@@ -12,8 +12,7 @@ import { formatResponseValue, formatStatus } from '../protocol/helpers';
 import http from 'http';
 import https from 'https';
 
-
-const log = logger.getLogger('WD Proxy');
+const DEFAULT_LOG = logger.getLogger('WD Proxy');
 const DEFAULT_REQUEST_TIMEOUT = 240000;
 const COMPACT_ERROR_PATTERNS = [
   /\bECONNREFUSED\b/,
@@ -43,7 +42,12 @@ class JWProxy {
     };
     this.httpAgent = new http.Agent(agentOpts);
     this.httpsAgent = new https.Agent(agentOpts);
-    this.protocolConverter = new ProtocolConverter(this.proxy.bind(this));
+    this.protocolConverter = new ProtocolConverter(this.proxy.bind(this), opts.log);
+    this._log = opts.log;
+  }
+
+  get log () {
+    return this._log ?? DEFAULT_LOG;
   }
 
   /**
@@ -166,7 +170,7 @@ class JWProxy {
       }
     }
 
-    log.debug(`Proxying [${method} ${url || '/'}] to [${method} ${newUrl}] ` +
+    this.log.debug(`Proxying [${method} ${url || '/'}] to [${method} ${newUrl}] ` +
       (reqOpts.data ? `with body: ${truncateBody(reqOpts.data)}` : 'with no body'));
 
     const throwProxyError = (error) => {
@@ -187,7 +191,7 @@ class JWProxy {
         // If it cannot be coerced to an object then the response is wrong
         throwProxyError(data);
       }
-      log.debug(`Got response with status ${status}: ${truncateBody(data)}`);
+      this.log.debug(`Got response with status ${status}: ${truncateBody(data)}`);
       isResponseLogged = true;
       const isSessionCreationRequest = /\/session$/.test(url) && method === 'POST';
       if (isSessionCreationRequest) {
@@ -195,7 +199,7 @@ class JWProxy {
           this.sessionId = data.sessionId || (data.value || {}).sessionId;
         }
         this.downstreamProtocol = this.getProtocolFromResBody(data);
-        log.info(`Determined the downstream protocol as '${this.downstreamProtocol}'`);
+        this.log.info(`Determined the downstream protocol as '${this.downstreamProtocol}'`);
       }
       if (_.has(data, 'status') && parseInt(data.status, 10) !== 0) {
         // Some servers, like chromedriver may return response code 200 for non-zero JSONWP statuses
@@ -211,16 +215,16 @@ class JWProxy {
       if (util.hasValue(e.response)) {
         if (!isResponseLogged) {
           const error = truncateBody(e.response.data);
-          log.info(util.hasValue(e.response.status)
+          this.log.info(util.hasValue(e.response.status)
             ? `Got response with status ${e.response.status}: ${error}`
             : `Got response with unknown status: ${error}`);
         }
       } else {
         proxyErrorMsg = `Could not proxy command to the remote server. Original error: ${e.message}`;
         if (COMPACT_ERROR_PATTERNS.some((p) => p.test(e.message))) {
-          log.info(e.message);
+          this.log.info(e.message);
         } else {
-          log.info(e.stack);
+          this.log.info(e.stack);
         }
       }
       throw new errors.ProxyRequestError(proxyErrorMsg, e.response?.data, e.response?.status);
@@ -256,7 +260,7 @@ class JWProxy {
     if (!commandName) {
       return await this.proxy(url, method, body);
     }
-    log.debug(`Matched '${url}' to command name '${commandName}'`);
+    this.log.debug(`Matched '${url}' to command name '${commandName}'`);
 
     return await this.protocolConverter.convertAndProxy(commandName, url, method, body);
   }
@@ -318,10 +322,10 @@ class JWProxy {
     const reqSessionId = this.getSessionIdFromUrl(req.originalUrl);
     if (_.has(resBodyObj, 'sessionId')) {
       if (reqSessionId) {
-        log.info(`Replacing sessionId ${resBodyObj.sessionId} with ${reqSessionId}`);
+        this.log.info(`Replacing sessionId ${resBodyObj.sessionId} with ${reqSessionId}`);
         resBodyObj.sessionId = reqSessionId;
       } else if (this.sessionId) {
-        log.info(`Replacing sessionId ${resBodyObj.sessionId} with ${this.sessionId}`);
+        this.log.info(`Replacing sessionId ${resBodyObj.sessionId} with ${this.sessionId}`);
         resBodyObj.sessionId = this.sessionId;
       }
     }

package/lib/protocol/protocol.js

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import { util } from '@appium/support';
+import { util, logger, node } from '@appium/support';
 import { validators } from './validators';
 import {
   errors, isErrorType, getResponseForW3CError,
@@ -7,11 +7,9 @@ import {
 } from './errors';
 import { METHOD_MAP, NO_SESSION_ID_COMMANDS } from './routes';
 import B from 'bluebird';
-import {
-  formatResponseValue, formatStatus,
-} from './helpers';
+import { formatResponseValue, formatStatus } from './helpers';
 import { MAX_LOG_BODY_LENGTH, PROTOCOLS, DEFAULT_BASE_PATH } from '../constants';
-import SESSIONS_CACHE from './sessions-cache';
+import { isW3cCaps } from '../helpers/capabilities';
 
 
 const CREATE_SESSION_COMMAND = 'createSession';
@@ -20,10 +18,8 @@ const GET_STATUS_COMMAND = 'getStatus';
 
 class Protocol {}
 
-function determineProtocol (desiredCapabilities, requiredCapabilities, capabilities) {
-  return _.isPlainObject(capabilities) ?
-    PROTOCOLS.W3C :
-    PROTOCOLS.MJSONWP;
+function determineProtocol (createSessionArgs) {
+  return _.some(createSessionArgs, isW3cCaps) ? PROTOCOLS.W3C : PROTOCOLS.MJSONWP;
 }
 
 function extractProtocol (driver, sessionId = null) {
@@ -38,13 +34,30 @@ function extractProtocol (driver, sessionId = null) {
   }
 
   // Extract the protocol for the current session if the given driver is the umbrella one
-  return dstDriver ? dstDriver.protocol : SESSIONS_CACHE.getProtocol(sessionId);
+  return dstDriver?.protocol ?? PROTOCOLS.W3C;
 }
 
 function isSessionCommand (command) {
   return !_.includes(NO_SESSION_ID_COMMANDS, command);
 }
 
+function getLogger (driver, sessionId = null) {
+  const dstDriver = sessionId && _.isFunction(driver.driverForSession)
+    ? (driver.driverForSession(sessionId) ?? driver)
+    : driver;
+  if (_.isFunction(dstDriver.log?.info)) {
+    return dstDriver.log;
+  }
+
+  let logPrefix = dstDriver.constructor
+    ? `${dstDriver.constructor.name}@${node.getObjectId(dstDriver).substring(0, 8)}`
+    : 'AppiumDriver';
+  if (sessionId) {
+    logPrefix += ` (${sessionId.substring(0, 8)})`;
+  }
+  return logger.getLogger(logPrefix);
+}
+
 function wrapParams (paramSets, jsonObj) {
   /* There are commands like performTouch which take a single parameter (primitive type or array).
    * Some drivers choose to pass this parameter as a value (eg. [action1, action2...]) while others to
@@ -192,11 +205,11 @@ function makeArgs (requestParams, jsonObj, payloadParams, protocol) {
 
 function routeConfiguringFunction (driver) {
   if (!driver.sessionExists) {
-    throw new Error('Drivers used with MJSONWP must implement `sessionExists`');
+    throw new Error('Drivers must implement `sessionExists` property');
   }
 
   if (!(driver.executeCommand || driver.execute)) {
-    throw new Error('Drivers used with MJSONWP must implement `executeCommand` or `execute`');
+    throw new Error('Drivers must implement `executeCommand` or `execute` method');
   }
 
   // return a function which will add all the routes to the driver. Here extraMethods might be
@@ -247,7 +260,7 @@ function buildHandler (app, method, path, spec, driver, isSessCmd) {
           await doJwpProxy(driver, req, res);
           return;
         }
-        SESSIONS_CACHE.getLogger(req.params.sessionId, currentProtocol).debug(`Would have proxied ` +
+        getLogger(driver, req.params.sessionId).debug(`Would have proxied ` +
           `command directly, but a plugin exists which might require its value, so will let ` +
           `its value be collected internally and made part of plugin chain`);
         didPluginOverrideProxy = true;
@@ -272,7 +285,7 @@ function buildHandler (app, method, path, spec, driver, isSessCmd) {
       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
@@ -288,7 +301,7 @@ function buildHandler (app, method, path, spec, driver, isSessCmd) {
       }
 
       // run the driver command wrapped inside the argument validators
-      SESSIONS_CACHE.getLogger(req.params.sessionId, currentProtocol).debug(`Calling ` +
+      getLogger(driver, req.params.sessionId).debug(`Calling ` +
         `${driver.constructor.name}.${spec.command}() with args: ` +
         _.truncate(JSON.stringify(args), {length: MAX_LOG_BODY_LENGTH}));
 
@@ -317,8 +330,7 @@ function buildHandler (app, method, path, spec, driver, isSessCmd) {
       // unpack createSession response
       if (spec.command === CREATE_SESSION_COMMAND) {
         newSessionId = driverRes[0];
-        SESSIONS_CACHE.putSession(newSessionId, currentProtocol);
-        SESSIONS_CACHE.getLogger(newSessionId, currentProtocol)
+        getLogger(driver, newSessionId)
           .debug(`Cached the protocol value '${currentProtocol}' for the new session ${newSessionId}`);
         if (currentProtocol === PROTOCOLS.MJSONWP) {
           driverRes = driverRes[1];
@@ -333,9 +345,9 @@ function buildHandler (app, method, path, spec, driver, isSessCmd) {
 
       // delete should not return anything even if successful
       if (spec.command === DELETE_SESSION_COMMAND) {
-        SESSIONS_CACHE.getLogger(req.params.sessionId, currentProtocol)
+        getLogger(driver, req.params.sessionId)
           .debug(`Received response: ${_.truncate(JSON.stringify(driverRes), {length: MAX_LOG_BODY_LENGTH})}`);
-        SESSIONS_CACHE.getLogger(req.params.sessionId, currentProtocol).debug('But deleting session, so not returning');
+        getLogger(driver, req.params.sessionId).debug('But deleting session, so not returning');
         driverRes = null;
       }
 
@@ -349,15 +361,8 @@ function buildHandler (app, method, path, spec, driver, isSessCmd) {
       }
 
       httpResBody.value = driverRes;
-      SESSIONS_CACHE.getLogger(req.params.sessionId || newSessionId, currentProtocol).debug(`Responding ` +
+      getLogger(driver, req.params.sessionId || newSessionId).debug(`Responding ` +
         `to client with driver.${spec.command}() result: ${_.truncate(JSON.stringify(driverRes), {length: MAX_LOG_BODY_LENGTH})}`);
-
-      if (spec.command === DELETE_SESSION_COMMAND) {
-        // We don't want to keep the logger instance in the cache
-        // after the session is deleted, because it contains the logging history
-        // and consumes the memory
-        SESSIONS_CACHE.resetLogger(req.params.sessionId);
-      }
     } catch (err) {
       // if anything goes wrong, figure out what our response should be
       // based on the type of error that we encountered
@@ -374,7 +379,7 @@ function buildHandler (app, method, path, spec, driver, isSessCmd) {
       if (isErrorType(err, errors.ProxyRequestError)) {
         actualErr = err.getActualError();
       } else {
-        SESSIONS_CACHE.getLogger(req.params.sessionId || newSessionId, currentProtocol)
+        getLogger(driver, req.params.sessionId || newSessionId)
           .debug(`Encountered internal error running command: ${errMsg}`);
       }
 
@@ -431,7 +436,7 @@ function driverShouldDoJwpProxy (driver, req, command) {
 }
 
 async function doJwpProxy (driver, req, res) {
-  SESSIONS_CACHE.getLogger(req.params.sessionId, extractProtocol(driver, req.params.sessionId))
+  getLogger(driver, req.params.sessionId)
     .info('Driver proxy active, passing request on via HTTP proxy');
 
   // check that the inner driver has a proxy function

package/lib/protocol/routes.js

@@ -1,6 +1,6 @@
 import _ from 'lodash';
 import { util } from '@appium/support';
-import { DEFAULT_BASE_PATH } from '../constants';
+import { PROTOCOLS, DEFAULT_BASE_PATH } from '../constants';
 
 
 const SET_ALERT_TEXT_PAYLOAD_PARAMS = {
@@ -33,6 +33,18 @@ const METHOD_MAP = {
   '/session/:sessionId/timeouts': {
     GET: {command: 'getTimeouts'}, // W3C route
     POST: {command: 'timeouts', payloadParams: {
+      validate: (jsonObj, protocolName) => {
+        if (protocolName === PROTOCOLS.W3C) {
+          if (!util.hasValue(jsonObj.script) && !util.hasValue(jsonObj.pageLoad) && !util.hasValue(jsonObj.implicit)) {
+            return 'W3C protocol expects any of script, pageLoad or implicit to be set';
+          }
+        } else {
+          // MJSONWP
+          if (!util.hasValue(jsonObj.type) || !util.hasValue(jsonObj.ms)) {
+            return 'MJSONWP protocol requires type and ms';
+          }
+        }
+      },
       optional: ['type', 'ms', 'script', 'pageLoad', 'implicit'],
     }}
   },
@@ -42,9 +54,19 @@ const METHOD_MAP = {
   '/session/:sessionId/timeouts/implicit_wait': {
     POST: {command: 'implicitWait', payloadParams: {required: ['ms']}}
   },
+  // JSONWP
+  '/session/:sessionId/window_handle': {
+    GET: {command: 'getWindowHandle'}
+  },
+  // W3C
   '/session/:sessionId/window/handle': {
     GET: {command: 'getWindowHandle'}
   },
+  // JSONWP
+  '/session/:sessionId/window_handles': {
+    GET: {command: 'getWindowHandles'}
+  },
+  // W3C
   '/session/:sessionId/window/handles': {
     GET: {command: 'getWindowHandles'}
   },
@@ -61,6 +83,14 @@ const METHOD_MAP = {
   '/session/:sessionId/refresh': {
     POST: {command: 'refresh'}
   },
+  // MJSONWP
+  '/session/:sessionId/execute': {
+    POST: {command: 'execute', payloadParams: {required: ['script', 'args']}}
+  },
+  // MJSONWP
+  '/session/:sessionId/execute_async': {
+    POST: {command: 'executeAsync', payloadParams: {required: ['script', 'args']}}
+  },
   '/session/:sessionId/screenshot': {
     GET: {command: 'getScreenshot'}
   },
@@ -207,6 +237,9 @@ const METHOD_MAP = {
   '/session/:sessionId/element/:elementId/size': {
     GET: {command: 'getSize'}
   },
+  '/session/:sessionId/element/:elementId/shadow': {
+    GET: {command: 'elementShadowRoot'}
+  },
   '/session/:sessionId/element/:elementId/css/:propertyName': {
     GET: {command: 'getCssProperty'}
   },
@@ -582,6 +615,28 @@ const METHOD_MAP = {
     POST: {command: 'logCustomEvent', payloadParams: {required: ['vendor', 'event']}}
   },
 
+  /*
+   * The W3C spec has some changes to the wire protocol.
+   * https://w3c.github.io/webdriver/webdriver-spec.html
+   * Begin to add those changes here, keeping the old version
+   * since clients still implement them.
+   */
+  // MJSONWP
+  '/session/:sessionId/alert_text': {
+    GET: {command: 'getAlertText'},
+    POST: {
+      command: 'setAlertText',
+      payloadParams: SET_ALERT_TEXT_PAYLOAD_PARAMS,
+    }
+  },
+  // MJSONWP
+  '/session/:sessionId/accept_alert': {
+    POST: {command: 'postAcceptAlert'}
+  },
+  // MJSONWP
+  '/session/:sessionId/dismiss_alert': {
+    POST: {command: 'postDismissAlert'}
+  },
   // https://w3c.github.io/webdriver/webdriver-spec.html#user-prompts
   '/session/:sessionId/alert/text': {
     GET: {command: 'getAlertText'},
@@ -606,6 +661,10 @@ const METHOD_MAP = {
   '/session/:sessionId/execute/async': {
     POST: {command: 'executeAsync', payloadParams: {required: ['script', 'args']}}
   },
+  // Pre-W3C endpoint for element screenshot
+  '/session/:sessionId/screenshot/:elementId': {
+    GET: {command: 'getElementScreenshot'}
+  },
   '/session/:sessionId/element/:elementId/screenshot': {
     GET: {command: 'getElementScreenshot'}
   },

package/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@appium/base-driver",
+  "version": "8.3.1",
   "description": "Base driver class for Appium drivers",
   "keywords": [
     "automation",
@@ -11,20 +12,17 @@
     "firefoxos",
     "testing"
   ],
-  "version": "8.2.3",
-  "author": "https://github.com/appium",
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/appium/appium.git"
-  },
+  "homepage": "https://appium.io",
   "bugs": {
     "url": "https://github.com/appium/appium/issues"
   },
-  "engines": {
-    "node": ">=12",
-    "npm": ">=6"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/appium/appium.git",
+    "directory": "packages/base-driver"
   },
+  "license": "Apache-2.0",
+  "author": "https://github.com/appium",
   "directories": {
     "lib": "lib"
   },
@@ -34,34 +32,48 @@
     "lib",
     "static",
     "test/basedriver",
-    "!test/basedriver/fixtures",
+    "!test/e2e/fixtures",
     "build",
-    "!build/test/basedriver/fixtures"
+    "!build/test/e2e/fixtures"
   ],
+  "scripts": {
+    "build": "npm run build:sources && npm run build:test",
+    "build:sources": "babel lib --root-mode=upward --out-dir=build/lib",
+    "build:test": "babel test --root-mode=upward --out-dir=build/test --copy-files",
+    "dev": "npm run build -- --watch",
+    "fix": "npm run lint -- --fix",
+    "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore .",
+    "test": "npm run test:unit",
+    "test:e2e": "mocha --require ../../test/setup-babel.js --timeout 20s --slow 10s \"./test/e2e/**/*.spec.js\"",
+    "test:unit": "mocha --require ../../test/setup-babel.js \"./test/unit/**/*.spec.js\""
+  },
   "dependencies": {
-    "@appium/support": "^2.55.3",
-    "@babel/runtime": "7.16.3",
-    "@dabh/colors": "1.4.0",
-    "async-lock": "1.3.0",
+    "@appium/support": "^2.56.1",
+    "@babel/runtime": "7.17.8",
+    "@colors/colors": "1.5.0",
+    "async-lock": "1.3.1",
     "asyncbox": "2.9.2",
-    "axios": "0.24.0",
+    "axios": "0.26.1",
     "bluebird": "3.7.2",
-    "body-parser": "1.19.0",
+    "body-parser": "1.19.2",
     "es6-error": "4.1.1",
-    "express": "4.17.1",
-    "http-status-codes": "2.1.4",
+    "express": "4.17.3",
+    "http-status-codes": "2.2.0",
     "lodash": "4.17.21",
-    "lru-cache": "6.0.0",
+    "lru-cache": "7.7.1",
     "method-override": "3.0.0",
     "morgan": "1.10.0",
     "serve-favicon": "2.5.0",
     "source-map-support": "0.5.21",
     "validate.js": "0.13.1",
-    "ws": "7.5.6"
+    "ws": "7.5.7"
+  },
+  "engines": {
+    "node": ">=12",
+    "npm": ">=6"
   },
   "publishConfig": {
     "access": "public"
   },
-  "homepage": "https://appium.io",
-  "gitHead": "ca90a11813546ab4851e5b1f0406f420a53227e6"
+  "gitHead": "6d35def9ed754121fee691cdaf7b30e3a7ac3e8b"
 }

package/test/basedriver/README.md

@@ -0,0 +1,5 @@
+# Driver Test Helpers
+
+This directory contains modules which expose test suites that an external driver can use to test against the base implementation.  They are published in the `@appium/base-driver` package.
+
+Drivers wanting to leverage these suites will want to add `@appium/base-driver` to their `devDependencies`.

package/test/basedriver/driver-e2e-tests.js

@@ -2,7 +2,7 @@ import _ from 'lodash';
 import { BaseDriver, server, routeConfiguringFunction, DeviceSettings } from '../../lib';
 import axios from 'axios';
 import B from 'bluebird';
-import {TEST_HOST, getTestPort, createAppiumURL, METHODS} from '../helpers';
+import { TEST_HOST, getTestPort, createAppiumURL, METHODS } from '../helpers';
 import { PREFIXED_APPIUM_OPTS_CAP } from '../../lib/basedriver/capabilities';
 const {POST, DELETE} = METHODS;
 

package/test/basedriver/driver-tests.js

@@ -1,7 +1,7 @@
 import _ from 'lodash';
 import B from 'bluebird';
 import { DeviceSettings } from '../../lib';
-import sinon from 'sinon';
+import { createSandbox } from 'sinon';
 
 
 // wrap these tests in a function so we can export the tests and re-use them
@@ -10,10 +10,14 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
   // to display the driver under test in report
   const className = DriverClass.name || '(unknown driver)';
 
+
   describe(`BaseDriver (as ${className})`, function () {
     let d, w3cCaps;
 
+    let sandbox;
+
     beforeEach(function () {
+      sandbox = createSandbox();
       d = new DriverClass();
       w3cCaps = {
         alwaysMatch: Object.assign({}, defaultCaps, {
@@ -25,6 +29,7 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
     });
     afterEach(async function () {
       await d.deleteSession();
+      sandbox.restore();
     });
 
     it('should report the version of BaseDriver used', function () {
@@ -345,7 +350,7 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
 
       describe('#proxyRouteIsAvoided', function () {
         it('should validate form of avoidance list', function () {
-          const avoidStub = sinon.stub(d, 'getProxyAvoidList');
+          const avoidStub = sandbox.stub(d, 'getProxyAvoidList');
           avoidStub.returns([['POST', /\/foo/], ['GET']]);
           (() => { d.proxyRouteIsAvoided(); }).should.throw;
           avoidStub.returns([['POST', /\/foo/], ['GET', /^foo/, 'bar']]);
@@ -353,31 +358,31 @@ function baseDriverUnitTests (DriverClass, defaultCaps = {}) {
           avoidStub.restore();
         });
         it('should reject bad http methods', function () {
-          const avoidStub = sinon.stub(d, 'getProxyAvoidList');
+          const avoidStub = sandbox.stub(d, 'getProxyAvoidList');
           avoidStub.returns([['POST', /^foo/], ['BAZETE', /^bar/]]);
           (() => { d.proxyRouteIsAvoided(); }).should.throw;
           avoidStub.restore();
         });
         it('should reject non-regex routes', function () {
-          const avoidStub = sinon.stub(d, 'getProxyAvoidList');
+          const avoidStub = sandbox.stub(d, 'getProxyAvoidList');
           avoidStub.returns([['POST', /^foo/], ['GET', '/bar']]);
           (() => { d.proxyRouteIsAvoided(); }).should.throw;
           avoidStub.restore();
         });
         it('should return true for routes in the avoid list', function () {
-          const avoidStub = sinon.stub(d, 'getProxyAvoidList');
+          const avoidStub = sandbox.stub(d, 'getProxyAvoidList');
           avoidStub.returns([['POST', /^\/foo/]]);
           d.proxyRouteIsAvoided(null, 'POST', '/foo/bar').should.be.true;
           avoidStub.restore();
         });
         it('should strip away any wd/hub prefix', function () {
-          const avoidStub = sinon.stub(d, 'getProxyAvoidList');
+          const avoidStub = sandbox.stub(d, 'getProxyAvoidList');
           avoidStub.returns([['POST', /^\/foo/]]);
           d.proxyRouteIsAvoided(null, 'POST', '/foo/bar').should.be.true;
           avoidStub.restore();
         });
         it('should return false for routes not in the avoid list', function () {
-          const avoidStub = sinon.stub(d, 'getProxyAvoidList');
+          const avoidStub = sandbox.stub(d, 'getProxyAvoidList');
           avoidStub.returns([['POST', /^\/foo/]]);
           d.proxyRouteIsAvoided(null, 'GET', '/foo/bar').should.be.false;
           d.proxyRouteIsAvoided(null, 'POST', '/boo').should.be.false;