@appium/base-driver 8.5.2 → 8.5.5

package/lib/index.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import B from 'bluebird';
 
 B.config({
@@ -7,62 +5,81 @@ B.config({
 });
 
 // BaseDriver exports
-import { BaseDriver } from './basedriver/driver';
-export { DriverCore } from './basedriver/core';
-import { DeviceSettings } from './basedriver/device-settings';
+import {BaseDriver} from './basedriver/driver';
+export {DriverCore} from './basedriver/core';
+import {DeviceSettings} from './basedriver/device-settings';
 
-export { BaseDriver, DeviceSettings };
+export {BaseDriver, DeviceSettings};
 export default BaseDriver;
 
-
 // MJSONWP exports
 import * as protocol from './protocol';
-import {
-  DEFAULT_BASE_PATH, PROTOCOLS
-} from './constants';
+import {DEFAULT_BASE_PATH, PROTOCOLS} from './constants';
 
 const {
-  routeConfiguringFunction, errors, isErrorType,
-  errorFromMJSONWPStatusCode, errorFromW3CJsonCode, ALL_COMMANDS, METHOD_MAP,
-  routeToCommandName, NO_SESSION_ID_COMMANDS, isSessionCommand,
-  determineProtocol, CREATE_SESSION_COMMAND,
-  DELETE_SESSION_COMMAND, GET_STATUS_COMMAND,
+  routeConfiguringFunction,
+  errors,
+  isErrorType,
+  errorFromMJSONWPStatusCode,
+  errorFromW3CJsonCode,
+  ALL_COMMANDS,
+  METHOD_MAP,
+  routeToCommandName,
+  NO_SESSION_ID_COMMANDS,
+  isSessionCommand,
+  determineProtocol,
+  CREATE_SESSION_COMMAND,
+  DELETE_SESSION_COMMAND,
+  GET_STATUS_COMMAND,
 } = protocol;
 
 export {
-  routeConfiguringFunction, errors, isErrorType, PROTOCOLS,
-  errorFromMJSONWPStatusCode, errorFromW3CJsonCode, determineProtocol,
-  errorFromMJSONWPStatusCode as errorFromCode, ALL_COMMANDS, METHOD_MAP,
-  routeToCommandName, NO_SESSION_ID_COMMANDS, isSessionCommand,
-  DEFAULT_BASE_PATH, CREATE_SESSION_COMMAND,
-  DELETE_SESSION_COMMAND, GET_STATUS_COMMAND,
+  routeConfiguringFunction,
+  errors,
+  isErrorType,
+  PROTOCOLS,
+  errorFromMJSONWPStatusCode,
+  errorFromW3CJsonCode,
+  determineProtocol,
+  errorFromMJSONWPStatusCode as errorFromCode,
+  ALL_COMMANDS,
+  METHOD_MAP,
+  routeToCommandName,
+  NO_SESSION_ID_COMMANDS,
+  isSessionCommand,
+  DEFAULT_BASE_PATH,
+  CREATE_SESSION_COMMAND,
+  DELETE_SESSION_COMMAND,
+  GET_STATUS_COMMAND,
 };
 
 // Express exports
 import * as staticIndex from './express/static';
-const { STATIC_DIR } = staticIndex;
-export { STATIC_DIR };
+const {STATIC_DIR} = staticIndex;
+export {STATIC_DIR};
 
 import * as serverIndex from './express/server';
-const { server, normalizeBasePath } = serverIndex;
-export { server, normalizeBasePath };
+const {server, normalizeBasePath} = serverIndex;
+export {server, normalizeBasePath};
 
 // jsonwp-proxy exports
 import * as proxyIndex from './jsonwp-proxy/proxy';
-const { JWProxy } = proxyIndex;
-export { JWProxy };
+const {JWProxy} = proxyIndex;
+export {JWProxy};
 
 // jsonwp-status exports
 import * as statusIndex from './jsonwp-status/status';
-const { codes: statusCodes, getSummaryByCode } = statusIndex;
-export { statusCodes, getSummaryByCode };
+const {codes: statusCodes, getSummaryByCode} = statusIndex;
+export {statusCodes, getSummaryByCode};
 
 // W3C capabilities parser
 import * as caps from './basedriver/capabilities';
-const { processCapabilities, isStandardCap, validateCaps } = caps;
-export { processCapabilities, isStandardCap, validateCaps };
+const {processCapabilities, isStandardCap, validateCaps} = caps;
+export {processCapabilities, isStandardCap, validateCaps};
 
 // Web socket helpers
 import * as ws from './express/websocket';
-const { DEFAULT_WS_PATHNAME_PREFIX } = ws;
-export { DEFAULT_WS_PATHNAME_PREFIX };
+const {DEFAULT_WS_PATHNAME_PREFIX} = ws;
+export {DEFAULT_WS_PATHNAME_PREFIX};
+
+export {PREFIXED_APPIUM_OPTS_CAP} from './basedriver/capabilities';

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

@@ -1,33 +1,29 @@
 import _ from 'lodash';
-import { logger, util } from '@appium/support';
-import { duplicateKeys } from '../basedriver/helpers';
-import {
-  MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY, PROTOCOLS
-} from '../constants';
+import {logger, util} from '@appium/support';
+import {duplicateKeys} from '../basedriver/helpers';
+import {MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY, PROTOCOLS} from '../constants';
 
 export const COMMAND_URLS_CONFLICTS = [
   {
     commandNames: ['execute', 'executeAsync'],
-    jsonwpConverter: (url) => url.replace(/\/execute.*/,
-      url.includes('async') ? '/execute_async' : '/execute'),
-    w3cConverter: (url) => url.replace(/\/execute.*/,
-      url.includes('async') ? '/execute/async' : '/execute/sync'),
+    jsonwpConverter: (url) =>
+      url.replace(/\/execute.*/, url.includes('async') ? '/execute_async' : '/execute'),
+    w3cConverter: (url) =>
+      url.replace(/\/execute.*/, url.includes('async') ? '/execute/async' : '/execute/sync'),
   },
   {
     commandNames: ['getElementScreenshot'],
-    jsonwpConverter: (url) => url.replace(/\/element\/([^/]+)\/screenshot$/,
-      '/screenshot/$1'),
-    w3cConverter: (url) => url.replace(/\/screenshot\/([^/]+)/,
-      '/element/$1/screenshot'),
+    jsonwpConverter: (url) => url.replace(/\/element\/([^/]+)\/screenshot$/, '/screenshot/$1'),
+    w3cConverter: (url) => url.replace(/\/screenshot\/([^/]+)/, '/element/$1/screenshot'),
   },
   {
     commandNames: ['getWindowHandles', 'getWindowHandle'],
-    jsonwpConverter (url) {
+    jsonwpConverter(url) {
       return /\/window$/.test(url)
         ? url.replace(/\/window$/, '/window_handle')
         : url.replace(/\/window\/handle(s?)$/, '/window_handle$1');
     },
-    w3cConverter (url) {
+    w3cConverter(url) {
       return /\/window_handle$/.test(url)
         ? url.replace(/\/window_handle$/, '/window')
         : url.replace(/\/window_handles$/, '/window/handles');
@@ -40,29 +36,28 @@ export const COMMAND_URLS_CONFLICTS = [
       const jsonwpUrl = w3cUrl.replace(w3cPropertyRegex, '/element/$1/attribute/$2');
       return jsonwpUrl;
     },
-    w3cConverter: (jsonwpUrl) => jsonwpUrl // Don't convert JSONWP URL to W3C. W3C accepts /attribute and /property
-  }
+    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, log = null) {
+  constructor(proxyFunc, log = null) {
     this.proxyFunc = proxyFunc;
     this._downstreamProtocol = null;
     this._log = log;
   }
 
-  get log () {
+  get log() {
     return this._log ?? DEFAULT_LOG;
   }
 
-  set downstreamProtocol (value) {
+  set downstreamProtocol(value) {
     this._downstreamProtocol = value;
   }
 
-  get downstreamProtocol () {
+  get downstreamProtocol() {
     return this._downstreamProtocol;
   }
 
@@ -74,25 +69,29 @@ class ProtocolConverter {
    * @param {Object} body Request body
    * @return {Array} Array of W3C + MJSONWP compatible timeout objects
    */
-  getTimeoutRequestObjects (body) {
+  getTimeoutRequestObjects(body) {
     if (this.downstreamProtocol === W3C && _.has(body, 'ms') && _.has(body, 'type')) {
-      const typeToW3C = (x) => x === 'page load' ? 'pageLoad' : x;
-      return [{
-        [typeToW3C(body.type)]: body.ms,
-      }];
+      const typeToW3C = (x) => (x === 'page load' ? 'pageLoad' : x);
+      return [
+        {
+          [typeToW3C(body.type)]: body.ms,
+        },
+      ];
     }
 
     if (this.downstreamProtocol === MJSONWP && (!_.has(body, 'ms') || !_.has(body, 'type'))) {
-      const typeToJSONWP = (x) => x === 'pageLoad' ? 'page load' : x;
-      return _.toPairs(body)
-        // Only transform the entry if ms value is a valid positive float number
-        .filter((pair) => /^\d+(?:[.,]\d*?)?$/.test(`${pair[1]}`))
-        .map(function (pair) {
-          return {
-            type: typeToJSONWP(pair[0]),
-            ms: pair[1],
-          };
-        });
+      const typeToJSONWP = (x) => (x === 'pageLoad' ? 'page load' : x);
+      return (
+        _.toPairs(body)
+          // Only transform the entry if ms value is a valid positive float number
+          .filter((pair) => /^\d+(?:[.,]\d*?)?$/.test(`${pair[1]}`))
+          .map(function (pair) {
+            return {
+              type: typeToJSONWP(pair[0]),
+              ms: pair[1],
+            };
+          })
+      );
     }
 
     return [body];
@@ -104,11 +103,15 @@ class ProtocolConverter {
    * @param {String} method Endpoint method
    * @param {Object} body Request body
    */
-  async proxySetTimeouts (url, method, body) {
+  async proxySetTimeouts(url, method, body) {
     let response, resBody;
 
     const timeoutRequestObjects = this.getTimeoutRequestObjects(body);
-    this.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);
 
@@ -127,7 +130,7 @@ class ProtocolConverter {
     return [response, resBody];
   }
 
-  async proxySetWindow (url, method, body) {
+  async proxySetWindow(url, method, body) {
     const bodyObj = util.safeJsonParse(body);
     if (_.isPlainObject(bodyObj)) {
       if (this.downstreamProtocol === W3C && _.has(bodyObj, 'name') && !_.has(bodyObj, 'handle')) {
@@ -137,7 +140,11 @@ class ProtocolConverter {
           handle: bodyObj.name,
         });
       }
-      if (this.downstreamProtocol === MJSONWP && _.has(bodyObj, 'handle') && !_.has(bodyObj, 'name')) {
+      if (
+        this.downstreamProtocol === MJSONWP &&
+        _.has(bodyObj, 'handle') &&
+        !_.has(bodyObj, 'name')
+      ) {
         this.log.debug(`Copied 'handle' value '${bodyObj.handle}' to 'name' as per JSONWP spec`);
         return await this.proxyFunc(url, method, {
           ...bodyObj,
@@ -149,48 +156,54 @@ class ProtocolConverter {
     return await this.proxyFunc(url, method, body);
   }
 
-  async proxySetValue (url, method, body) {
+  async proxySetValue(url, method, body) {
     const bodyObj = util.safeJsonParse(body);
     if (_.isPlainObject(bodyObj) && (util.hasValue(bodyObj.text) || util.hasValue(bodyObj.value))) {
       let {text, value} = bodyObj;
       if (util.hasValue(text) && !util.hasValue(value)) {
-        value = _.isString(text)
-          ? [...text]
-          : (_.isArray(text) ? text : []);
-        this.log.debug(`Added 'value' property ${JSON.stringify(value)} to 'setValue' request body`);
+        value = _.isString(text) ? [...text] : _.isArray(text) ? text : [];
+        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 : '');
+        text = _.isArray(value) ? value.join('') : _.isString(value) ? value : '';
         this.log.debug(`Added 'text' property ${JSON.stringify(text)} to 'setValue' request body`);
       }
-      return await this.proxyFunc(url, method, Object.assign({}, bodyObj, {
-        text,
-        value,
-      }));
+      return await this.proxyFunc(
+        url,
+        method,
+        Object.assign({}, bodyObj, {
+          text,
+          value,
+        })
+      );
     }
 
     return await this.proxyFunc(url, method, body);
   }
 
-  async proxySetFrame (url, method, body) {
+  async proxySetFrame(url, method, body) {
     const bodyObj = util.safeJsonParse(body);
     return _.has(bodyObj, 'id') && _.isPlainObject(bodyObj.id)
       ? await this.proxyFunc(url, method, {
-        ...bodyObj,
-        id: duplicateKeys(bodyObj.id, MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY),
-      })
+          ...bodyObj,
+          id: duplicateKeys(bodyObj.id, MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY),
+        })
       : await this.proxyFunc(url, method, body);
   }
 
-  async proxyPerformActions (url, method, body) {
+  async proxyPerformActions(url, method, body) {
     const bodyObj = util.safeJsonParse(body);
     return _.isPlainObject(bodyObj)
-      ? await this.proxyFunc(url, method, duplicateKeys(bodyObj, MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY))
+      ? await this.proxyFunc(
+          url,
+          method,
+          duplicateKeys(bodyObj, MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY)
+        )
       : await this.proxyFunc(url, method, body);
   }
 
-  async proxyReleaseActions (url, method) {
+  async proxyReleaseActions(url, method) {
     return await this.proxyFunc(url, method);
   }
 
@@ -204,7 +217,7 @@ class ProtocolConverter {
    * @param {?string|object} body
    * @returns The proxyfying result as [response, responseBody] tuple
    */
-  async convertAndProxy (commandName, url, method, body) {
+  async convertAndProxy(commandName, url, method, body) {
     if (!this.downstreamProtocol) {
       return await this.proxyFunc(url, method, body);
     }
@@ -220,7 +233,7 @@ class ProtocolConverter {
       case 'performActions':
         return await this.proxyPerformActions(url, method, body);
       case 'releaseActions':
-        return await this.proxyReleaseActions(url, method, body);
+        return await this.proxyReleaseActions(url, method);
       case 'setFrame':
         return await this.proxySetFrame(url, method, body);
       default:
@@ -233,16 +246,19 @@ class ProtocolConverter {
         continue;
       }
 
-      const rewrittenUrl = this.downstreamProtocol === MJSONWP
-        ? jsonwpConverter(url)
-        : w3cConverter(url);
+      const rewrittenUrl =
+        this.downstreamProtocol === MJSONWP ? jsonwpConverter(url) : w3cConverter(url);
       if (rewrittenUrl === url) {
-        this.log.debug(`Did not know how to rewrite the original URL '${url}' ` +
-          `for ${this.downstreamProtocol} protocol`);
+        this.log.debug(
+          `Did not know how to rewrite the original URL '${url}' ` +
+            `for ${this.downstreamProtocol} protocol`
+        );
         break;
       }
-      this.log.info(`Rewrote the original URL '${url}' to '${rewrittenUrl}' ` +
-        `for ${this.downstreamProtocol} protocol`);
+      this.log.info(
+        `Rewrote the original URL '${url}' to '${rewrittenUrl}' ` +
+          `for ${this.downstreamProtocol} protocol`
+      );
       return await this.proxyFunc(rewrittenUrl, method, body);
     }