@appium/base-driver 9.4.3 → 9.5.0

package/lib/basedriver/driver.ts

@@ -37,7 +37,7 @@ export class BaseDriver<
     Settings extends StringRecord = StringRecord,
     CreateResult = DefaultCreateSessionResult<C>,
     DeleteResult = DefaultDeleteSessionResult,
-    SessionData extends StringRecord = StringRecord
+    SessionData extends StringRecord = StringRecord,
   >
   extends DriverCore<C, Settings>
   implements Driver<C, CArgs, Settings, CreateResult, DeleteResult, SessionData>
@@ -55,7 +55,6 @@ export class BaseDriver<
     super(opts, shouldValidateCaps);
 
     this.caps = {} as DriverCaps<C>;
-
     this.cliArgs = {} as CArgs & ServerArgs;
   }
 
@@ -114,7 +113,7 @@ export class BaseDriver<
           // This is needed to prevent memory leaks
           this.eventEmitter.removeListener(
             ON_UNEXPECTED_SHUTDOWN_EVENT,
-            unexpectedShutdownListener
+            unexpectedShutdownListener,
           );
           unexpectedShutdownListener = null;
         }
@@ -147,7 +146,7 @@ export class BaseDriver<
   }
 
   async startUnexpectedShutdown(
-    err: Error = new errors.NoSuchDriverError('The driver was unexpectedly shut down!')
+    err: Error = new errors.NoSuchDriverError('The driver was unexpectedly shut down!'),
   ) {
     this.eventEmitter.emit(ON_UNEXPECTED_SHUTDOWN_EVENT, err); // allow others to listen for this
     this.shutdownUnexpectedly = true;
@@ -170,7 +169,7 @@ export class BaseDriver<
     this.noCommandTimer = setTimeout(async () => {
       this.log.warn(
         `Shutting down because we waited ` +
-          `${this.newCommandTimeoutMs / 1000.0} seconds for a command`
+          `${this.newCommandTimeoutMs / 1000.0} seconds for a command`,
       );
       const errorMessage =
         `New Command Timeout of ` +
@@ -234,23 +233,23 @@ export class BaseDriver<
     w3cCapabilities2?: W3CDriverCaps<C>,
     w3cCapabilities?: W3CDriverCaps<C>,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    driverData?: DriverData[]
+    driverData?: DriverData[],
   ): Promise<CreateResult> {
     if (this.sessionId !== null) {
       throw new errors.SessionNotCreatedError(
-        'Cannot create a new session while one is in progress'
+        'Cannot create a new session while one is in progress',
       );
     }
 
     this.log.debug();
 
     const originalCaps = _.cloneDeep(
-      [w3cCapabilities, w3cCapabilities1, w3cCapabilities2].find(isW3cCaps)
+      [w3cCapabilities, w3cCapabilities1, w3cCapabilities2].find(isW3cCaps),
     );
     if (!originalCaps) {
       throw new errors.SessionNotCreatedError(
         'Appium only supports W3C-style capability objects. ' +
-          'Your client is sending an older capabilities format. Please update your client library.'
+          'Your client is sending an older capabilities format. Please update your client library.',
       );
     }
 
@@ -258,7 +257,7 @@ export class BaseDriver<
 
     this.originalCaps = originalCaps;
     this.log.debug(
-      `Creating session with W3C capabilities: ${JSON.stringify(originalCaps, null, 2)}`
+      `Creating session with W3C capabilities: ${JSON.stringify(originalCaps, null, 2)}`,
     );
 
     let caps: DriverCaps<C>;
@@ -266,7 +265,7 @@ export class BaseDriver<
       caps = processCapabilities(
         originalCaps,
         this._desiredCapConstraints,
-        this.shouldValidateCaps
+        this.shouldValidateCaps,
       ) as DriverCaps<C>;
       caps = fixCaps(caps, this._desiredCapConstraints, this.log) as DriverCaps<C>;
     } catch (e) {
@@ -287,7 +286,7 @@ export class BaseDriver<
       throw new Error(
         "The 'noReset' and 'fullReset' capabilities are mutually " +
           'exclusive and should not both be set to true. You ' +
-          "probably meant to just use 'fullReset' on its own"
+          "probably meant to just use 'fullReset' on its own",
       );
     }
     if (this.opts.noReset === true) {
@@ -354,9 +353,7 @@ export class BaseDriver<
   logExtraCaps(caps: Capabilities<C>) {
     const extraCaps = _.difference(_.keys(caps), _.keys(this._desiredCapConstraints));
     if (extraCaps.length) {
-      this.log.warn(
-        `The following provided capabilities were not recognized by this driver:`
-      );
+      this.log.warn(`The following provided capabilities were not recognized by this driver:`);
       for (const cap of extraCaps) {
         this.log.warn(`  ${cap}`);
       }
@@ -371,11 +368,11 @@ export class BaseDriver<
     try {
       validateCaps(caps, this._desiredCapConstraints);
     } catch (e) {
-      this.log.errorAndThrow(
+      throw this.log.errorWithException(
         new errors.SessionNotCreatedError(
           `The desiredCapabilities object was not valid for the ` +
-            `following reason(s): ${e.message}`
-        )
+            `following reason(s): ${e.message}`,
+        ),
       );
     }
 
@@ -386,14 +383,14 @@ export class BaseDriver<
 
   async updateSettings(newSettings: Settings) {
     if (!this.settings) {
-      this.log.errorAndThrow('Cannot update settings; settings object not found');
+      throw this.log.errorWithException('Cannot update settings; settings object not found');
     }
     return await this.settings.update(newSettings);
   }
 
   async getSettings() {
     if (!this.settings) {
-      this.log.errorAndThrow('Cannot get settings; settings object not found');
+      throw this.log.errorWithException('Cannot get settings; settings object not found');
     }
     return this.settings.getSettings();
   }

package/lib/basedriver/helpers.js

@@ -491,7 +491,7 @@ async function unzipApp(zipPath, dstRoot, supportedAppExtensions) {
       })
     ).sort((a, b) => a.split(path.sep).length - b.split(path.sep).length);
     if (_.isEmpty(sortedBundleItems)) {
-      logger.errorAndThrow(
+      throw logger.errorWithException(
         `App unzipped OK, but we could not find any '${supportedAppExtensions}' ` +
           util.pluralize('bundle', supportedAppExtensions.length, false) +
           ` in it. Make sure your archive contains at least one package having ` +

package/lib/index.js

@@ -1,8 +1,13 @@
 import B from 'bluebird';
 
-B.config({
-  cancellation: true,
-});
+try {
+  B.config({
+    cancellation: true,
+  });
+} catch (ign) {
+  // sometimes during testing this somehow gets required twice and results in an error about
+  // cancellation not being able to be enabled after promise has been configured
+}
 
 // BaseDriver exports
 import {BaseDriver} from './basedriver/driver';
@@ -11,11 +16,11 @@ export {DeviceSettings} from './basedriver/device-settings';
 
 export {BaseDriver};
 export default BaseDriver;
+export {MAX_LOG_BODY_LENGTH, DEFAULT_BASE_PATH, PROTOCOLS, W3C_ELEMENT_KEY} from './constants';
 
 // MJSONWP exports
 export * from './protocol';
 export {errorFromMJSONWPStatusCode as errorFromCode} from './protocol';
-export {DEFAULT_BASE_PATH, PROTOCOLS, W3C_ELEMENT_KEY} from './constants';
 
 // Express exports
 export {STATIC_DIR} from './express/static';

package/lib/protocol/bidi-commands.js

@@ -0,0 +1,31 @@
+const SUBSCRIPTION_REQUEST_PARAMS = /** @type {const} */ ({
+  required: ['events'],
+  optional: ['contexts'],
+});
+
+const BIDI_COMMANDS = /** @type {const} */ ({
+  session: {
+    subscribe: {
+      command: 'bidiSubscribe',
+      params: SUBSCRIPTION_REQUEST_PARAMS,
+    },
+    unsubscribe: {
+      command: 'bidiUnsubscribe',
+      params: SUBSCRIPTION_REQUEST_PARAMS,
+    },
+  },
+  browsingContext: {
+    navigate: {
+      command: 'bidiNavigate',
+      params: {
+        required: ['context', 'url'],
+        optional: ['wait'],
+      },
+    },
+  },
+});
+
+// TODO add definitions for all bidi commands.
+// spec link: https://w3c.github.io/webdriver-bidi/
+
+export {BIDI_COMMANDS};

package/lib/protocol/errors.js

@@ -28,6 +28,27 @@ export class ProtocolError extends ES6Error {
   set stacktrace(value) {
     this._stacktrace = value;
   }
+
+  /**
+   * Get the Bidi protocol version of an error
+   * @param {string|number} id - the id used in the request for which this error forms the response
+   * @see https://w3c.github.io/webdriver-bidi/#protocol-definition
+   * @returns The object conforming to the shape of a BiDi error response
+   */
+  bidiErrObject(id) {
+    // if we don't have an id, the client didn't send one, so we have nothing to send back.
+    // send back an empty string rather than making something up
+    if (_.isNil(id)) {
+      id = '';
+    }
+    return {
+      id,
+      type: 'error',
+      error: this.error,
+      stacktrace: this.stacktrace,
+      message: this.message,
+    };
+  }
 }
 
 // https://github.com/SeleniumHQ/selenium/blob/176b4a9e3082ac1926f2a436eb346760c37a5998/java/client/src/org/openqa/selenium/remote/ErrorCodes.java#L215

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/base-driver",
-  "version": "9.4.3",
+  "version": "9.5.0",
   "description": "Base driver class for Appium drivers",
   "keywords": [
     "automation",
@@ -44,8 +44,8 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@appium/support": "^4.1.10",
-    "@appium/types": "^0.14.3",
+    "@appium/support": "^4.2.0",
+    "@appium/types": "^0.16.0",
     "@colors/colors": "1.6.0",
     "@types/async-lock": "1.4.2",
     "@types/bluebird": "3.5.42",
@@ -53,22 +53,22 @@
     "@types/lodash": "4.14.202",
     "@types/method-override": "0.0.35",
     "@types/serve-favicon": "2.5.7",
-    "async-lock": "1.4.0",
+    "async-lock": "1.4.1",
     "asyncbox": "3.0.0",
-    "axios": "1.6.2",
+    "axios": "1.6.3",
     "bluebird": "3.7.2",
     "body-parser": "1.20.2",
     "es6-error": "4.1.1",
     "express": "4.18.2",
     "http-status-codes": "2.3.0",
     "lodash": "4.17.21",
-    "lru-cache": "10.0.1",
+    "lru-cache": "10.1.0",
     "method-override": "3.0.0",
     "morgan": "1.10.0",
     "path-to-regexp": "6.2.1",
     "serve-favicon": "2.5.0",
     "source-map-support": "0.5.21",
-    "type-fest": "3.13.1",
+    "type-fest": "4.9.0",
     "validate.js": "0.13.1"
   },
   "optionalDependencies": {
@@ -81,10 +81,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "67504604b7d4602561db2cb3529860b241bec427",
-  "typedoc": {
-    "entryPoint": "./lib/index.js"
-  },
+  "gitHead": "76df4d600dcb7c867c37c3d7d302dc7fcc95ae09",
   "tsd": {
     "directory": "test/types"
   }