appium-uiautomator2-driver 1.72.0 → 2.0.0

package/lib/css-converter.js

@@ -1,8 +1,6 @@
 import { CssSelectorParser } from 'css-selector-parser';
 import { escapeRegExp } from 'lodash';
-import { errors } from 'appium-base-driver';
-
-const CssConverter = {};
+import { errors } from '@appium/base-driver';
 
 const parser = new CssSelectorParser();
 parser.registerSelectorPseudos('has');
@@ -113,16 +111,6 @@ function getWordMatcherRegex (word) {
   return `\\b(\\w*${escapeRegExp(word)}\\w*)\\b`;
 }
 
-/**
- * Add android:id/ to beginning of string if it's not there already
- *
- * @param {string} locator The initial locator
- * @returns {string} String with `android:id/` prepended (if it wasn't already)
- */
-function formatIdLocator (locator) {
-  return ID_LOCATOR_PATTERN.test(locator) ? locator : `android:id/${locator}`;
-}
-
 /**
  * @typedef {Object} CssAttr
  * @property {?string} valueType Type of attribute (must be string or empty)
@@ -131,62 +119,20 @@ function formatIdLocator (locator) {
  */
 
 /**
- * Convert a CSS attribute into a UiSelector method call
- *
- * @param {CssAttr} cssAttr CSS attribute object
- * @returns {string} CSS attribute parsed as UiSelector
+ * @typedef {Object} CssRule
+ * @property {?string} nestingOperator The nesting operator (aka: combinator https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors)
+ * @property {?string} tagName The tag name (aka: type selector https://developer.mozilla.org/en-US/docs/Web/CSS/Type_selectors)
+ * @property {?string[]} classNames An array of CSS class names
+ * @property {?CssAttr[]} attrs An array of CSS attributes
+ * @property {?CssPseudo[]} attrs An array of CSS pseudos
+ * @property {?string} id CSS identifier
+ * @property {?CssRule} rule A descendant of this CSS rule
  */
-function parseAttr (cssAttr) {
-  if (cssAttr.valueType && cssAttr.valueType !== 'string') {
-    throw new Error(`'${cssAttr.name}=${cssAttr.value}' is an invalid attribute. ` +
-      `Only 'string' and empty attribute types are supported. Found '${cssAttr.valueType}'`);
-  }
-  const attrName = assertGetAttrName(cssAttr);
-  const methodName = toSnakeCase(attrName);
-
-  // Validate that it's a supported attribute
-  if (!STR_ATTRS.includes(attrName) && !BOOLEAN_ATTRS.includes(attrName)) {
-    throw new Error(`'${attrName}' is not supported. Supported attributes are ` +
-      `'${[...STR_ATTRS, ...BOOLEAN_ATTRS].join(', ')}'`);
-  }
-
-  // Parse boolean, if it's a boolean attribute
-  if (BOOLEAN_ATTRS.includes(attrName)) {
-    return `.${methodName}(${assertGetBool(cssAttr)})`;
-  }
-
-  // Otherwise parse as string
-  let value = cssAttr.value || '';
-  if (attrName === RESOURCE_ID) {
-    value = formatIdLocator(value);
-  }
-  if (value === '') {
-    return `.${methodName}Matches("")`;
-  }
 
-  switch (cssAttr.operator) {
-    case '=':
-      return `.${methodName}("${value}")`;
-    case '*=':
-      if (['description', 'text'].includes(attrName)) {
-        return `.${methodName}Contains("${value}")`;
-      }
-      return `.${methodName}Matches("${escapeRegExp(value)}")`;
-    case '^=':
-      if (['description', 'text'].includes(attrName)) {
-        return `.${methodName}StartsWith("${value}")`;
-      }
-      return `.${methodName}Matches("^${escapeRegExp(value)}")`;
-    case '$=':
-      return `.${methodName}Matches("${escapeRegExp(value)}$")`;
-    case '~=':
-      return `.${methodName}Matches("${getWordMatcherRegex(value)}")`;
-    default:
-      // Unreachable, but adding error in case a new CSS attribute is added.
-      throw new Error(`Unsupported CSS attribute operator '${cssAttr.operator}'. ` +
-        ` '=', '*=', '^=', '$=' and '~=' are supported.`);
-  }
-}
+/**
+ * @typedef {Object} CssObject
+ * @property {?string} type Type of CSS object. 'rule', 'ruleset' or 'selectors'
+ */
 
 /**
  * @typedef {Object} CssPseudo
@@ -195,126 +141,188 @@ function parseAttr (cssAttr) {
  * @property {?string} value The value of the pseudo selector
  */
 
-/**
- * Convert a CSS pseudo class to a UiSelector
- *
- * @param {CssPseudo} cssPseudo CSS Pseudo class
- * @returns {string} Pseudo selector parsed as UiSelector
- */
-function parsePseudo (cssPseudo) {
-  if (cssPseudo.valueType && cssPseudo.valueType !== 'string') {
-    throw new Error(`'${cssPseudo.name}=${cssPseudo.value}'. ` +
-      `Unsupported css pseudo class value type: '${cssPseudo.valueType}'. Only 'string' type or empty is supported.`);
-  }
-
-  const pseudoName = assertGetAttrName(cssPseudo);
+class CssConverter {
 
-  if (BOOLEAN_ATTRS.includes(pseudoName)) {
-    return `.${toSnakeCase(pseudoName)}(${assertGetBool(cssPseudo)})`;
+  constructor (selector, pkg) {
+    this.selector = selector;
+    this.pkg = pkg;
   }
 
-  if (NUMERIC_ATTRS.includes(pseudoName)) {
-    return `.${pseudoName}(${cssPseudo.value})`;
+  /**
+   * Add `<pkgName>:id/` prefix to beginning of string if it's not there already
+   *
+   * @param {string} locator The initial locator
+   * @returns {string} String with `<pkgName>:id/` prepended (if it wasn't already)
+   */
+  formatIdLocator (locator) {
+    return ID_LOCATOR_PATTERN.test(locator)
+      ? locator
+      : `${this.pkg || 'android'}:id/${locator}`;
   }
-}
 
-/**
- * @typedef {Object} CssRule
- * @property {?string} nestingOperator The nesting operator (aka: combinator https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors)
- * @property {?string} tagName The tag name (aka: type selector https://developer.mozilla.org/en-US/docs/Web/CSS/Type_selectors)
- * @property {?string[]} classNames An array of CSS class names
- * @property {?CssAttr[]} attrs An array of CSS attributes
- * @property {?CssPseudo[]} attrs An array of CSS pseudos
- * @property {?string} id CSS identifier
- * @property {?CssRule} rule A descendant of this CSS rule
- */
+  /**
+   * Convert a CSS attribute into a UiSelector method call
+   *
+   * @param {CssAttr} cssAttr CSS attribute object
+   * @returns {string} CSS attribute parsed as UiSelector
+   */
+  parseAttr (cssAttr) {
+    if (cssAttr.valueType && cssAttr.valueType !== 'string') {
+      throw new Error(`'${cssAttr.name}=${cssAttr.value}' is an invalid attribute. ` +
+        `Only 'string' and empty attribute types are supported. Found '${cssAttr.valueType}'`);
+    }
+    const attrName = assertGetAttrName(cssAttr);
+    const methodName = toSnakeCase(attrName);
 
-/**
- * Convert a CSS rule to a UiSelector
- * @param {CssRule} cssRule CSS rule definition
- */
-function parseCssRule (cssRule) {
-  const { nestingOperator } = cssRule;
-  if (nestingOperator && nestingOperator !== ' ') {
-    throw new Error(`'${nestingOperator}' is not a supported combinator. ` +
-      `Only child combinator (>) and descendant combinator are supported.`);
-  }
+    // Validate that it's a supported attribute
+    if (!STR_ATTRS.includes(attrName) && !BOOLEAN_ATTRS.includes(attrName)) {
+      throw new Error(`'${attrName}' is not supported. Supported attributes are ` +
+        `'${[...STR_ATTRS, ...BOOLEAN_ATTRS].join(', ')}'`);
+    }
 
-  let uiAutomatorSelector = 'new UiSelector()';
-  if (cssRule.tagName && cssRule.tagName !== '*') {
-    let androidClass = [cssRule.tagName];
-    if (cssRule.classNames) {
-      for (const cssClassNames of cssRule.classNames) {
-        androidClass.push(cssClassNames);
-      }
-      uiAutomatorSelector += `.className("${androidClass.join('.')}")`;
-    } else {
-      uiAutomatorSelector += `.classNameMatches("${cssRule.tagName}")`;
+    // Parse boolean, if it's a boolean attribute
+    if (BOOLEAN_ATTRS.includes(attrName)) {
+      return `.${methodName}(${assertGetBool(cssAttr)})`;
     }
-  } else if (cssRule.classNames) {
-    uiAutomatorSelector += `.classNameMatches("${cssRule.classNames.join('\\.')}")`;
-  }
-  if (cssRule.id) {
-    uiAutomatorSelector += `.resourceId("${formatIdLocator(cssRule.id)}")`;
-  }
-  if (cssRule.attrs) {
-    for (const attr of cssRule.attrs) {
-      uiAutomatorSelector += parseAttr(attr);
+
+    // Otherwise parse as string
+    let value = cssAttr.value || '';
+    if (attrName === RESOURCE_ID) {
+      value = this.formatIdLocator(value);
     }
-  }
-  if (cssRule.pseudos) {
-    for (const pseudo of cssRule.pseudos) {
-      uiAutomatorSelector += parsePseudo(pseudo);
+    if (value === '') {
+      return `.${methodName}Matches("")`;
+    }
+
+    switch (cssAttr.operator) {
+      case '=':
+        return `.${methodName}("${value}")`;
+      case '*=':
+        if (['description', 'text'].includes(attrName)) {
+          return `.${methodName}Contains("${value}")`;
+        }
+        return `.${methodName}Matches("${escapeRegExp(value)}")`;
+      case '^=':
+        if (['description', 'text'].includes(attrName)) {
+          return `.${methodName}StartsWith("${value}")`;
+        }
+        return `.${methodName}Matches("^${escapeRegExp(value)}")`;
+      case '$=':
+        return `.${methodName}Matches("${escapeRegExp(value)}$")`;
+      case '~=':
+        return `.${methodName}Matches("${getWordMatcherRegex(value)}")`;
+      default:
+        // Unreachable, but adding error in case a new CSS attribute is added.
+        throw new Error(`Unsupported CSS attribute operator '${cssAttr.operator}'. ` +
+          ` '=', '*=', '^=', '$=' and '~=' are supported.`);
     }
   }
-  if (cssRule.rule) {
-    uiAutomatorSelector += `.childSelector(${parseCssRule(cssRule.rule)})`;
+
+  /**
+   * Convert a CSS pseudo class to a UiSelector
+   *
+   * @param {CssPseudo} cssPseudo CSS Pseudo class
+   * @returns {string} Pseudo selector parsed as UiSelector
+   */
+  parsePseudo (cssPseudo) {
+    if (cssPseudo.valueType && cssPseudo.valueType !== 'string') {
+      throw new Error(`'${cssPseudo.name}=${cssPseudo.value}'. ` +
+        `Unsupported css pseudo class value type: '${cssPseudo.valueType}'. Only 'string' type or empty is supported.`);
+    }
+
+    const pseudoName = assertGetAttrName(cssPseudo);
+
+    if (BOOLEAN_ATTRS.includes(pseudoName)) {
+      return `.${toSnakeCase(pseudoName)}(${assertGetBool(cssPseudo)})`;
+    }
+
+    if (NUMERIC_ATTRS.includes(pseudoName)) {
+      return `.${pseudoName}(${cssPseudo.value})`;
+    }
   }
-  return uiAutomatorSelector;
-}
 
-/**
- * @typedef {Object} CssObject
- * @property {?string} type Type of CSS object. 'rule', 'ruleset' or 'selectors'
- */
+  /**
+   * Convert a CSS rule to a UiSelector
+   * @param {CssRule} cssRule CSS rule definition
+   */
+  parseCssRule (cssRule) {
+    const { nestingOperator } = cssRule;
+    if (nestingOperator && nestingOperator !== ' ') {
+      throw new Error(`'${nestingOperator}' is not a supported combinator. ` +
+        `Only child combinator (>) and descendant combinator are supported.`);
+    }
 
-/**
- * Convert CSS object to UiAutomator2 selector
- * @param {CssObject} css CSS object
- * @returns {string} The CSS object parsed as a UiSelector
- */
-function parseCssObject (css) {
-  switch (css.type) {
-    case 'rule':
-      return parseCssRule(css);
-    case 'ruleSet':
-      return parseCssObject(css.rule);
-    case 'selectors':
-      return css.selectors.map((selector) => parseCssObject(selector)).join('; ');
-
-    default:
-      // This is never reachable, but if it ever is do this.
-      throw new Error(`UiAutomator does not support '${css.type}' css. Only supports 'rule', 'ruleSet', 'selectors' `);
+    let uiAutomatorSelector = 'new UiSelector()';
+    if (cssRule.tagName && cssRule.tagName !== '*') {
+      let androidClass = [cssRule.tagName];
+      if (cssRule.classNames) {
+        for (const cssClassNames of cssRule.classNames) {
+          androidClass.push(cssClassNames);
+        }
+        uiAutomatorSelector += `.className("${androidClass.join('.')}")`;
+      } else {
+        uiAutomatorSelector += `.classNameMatches("${cssRule.tagName}")`;
+      }
+    } else if (cssRule.classNames) {
+      uiAutomatorSelector += `.classNameMatches("${cssRule.classNames.join('\\.')}")`;
+    }
+    if (cssRule.id) {
+      uiAutomatorSelector += `.resourceId("${this.formatIdLocator(cssRule.id)}")`;
+    }
+    if (cssRule.attrs) {
+      for (const attr of cssRule.attrs) {
+        uiAutomatorSelector += this.parseAttr(attr);
+      }
+    }
+    if (cssRule.pseudos) {
+      for (const pseudo of cssRule.pseudos) {
+        uiAutomatorSelector += this.parsePseudo(pseudo);
+      }
+    }
+    if (cssRule.rule) {
+      uiAutomatorSelector += `.childSelector(${this.parseCssRule(cssRule.rule)})`;
+    }
+    return uiAutomatorSelector;
   }
-}
 
-/**
- * Convert a CSS selector to a UiAutomator2 selector
- * @param {string} cssSelector CSS Selector
- * @returns {string} The CSS selector converted to a UiSelector
- */
-CssConverter.toUiAutomatorSelector = function toUiAutomatorSelector (cssSelector) {
-  let cssObj;
-  try {
-    cssObj = parser.parse(cssSelector);
-  } catch (e) {
-    throw new errors.InvalidSelectorError(`Invalid CSS selector '${cssSelector}'. Reason: '${e}'`);
+  /**
+   * Convert CSS object to UiAutomator2 selector
+   * @param {CssObject} css CSS object
+   * @returns {string} The CSS object parsed as a UiSelector
+   */
+  parseCssObject (css) {
+    switch (css.type) {
+      case 'rule':
+        return this.parseCssRule(css);
+      case 'ruleSet':
+        return this.parseCssObject(css.rule);
+      case 'selectors':
+        return css.selectors.map((selector) => this.parseCssObject(selector)).join('; ');
+
+      default:
+        // This is never reachable, but if it ever is do this.
+        throw new Error(`UiAutomator does not support '${css.type}' css. Only supports 'rule', 'ruleSet', 'selectors' `);
+    }
   }
-  try {
-    return parseCssObject(cssObj);
-  } catch (e) {
-    throw new errors.InvalidSelectorError(`Unsupported CSS selector '${cssSelector}'. Reason: '${e}'`);
+
+  /**
+   * Convert a CSS selector to a UiAutomator2 selector
+   *
+   * @returns {string} The CSS selector converted to a UiSelector
+   */
+  toUiAutomatorSelector () {
+    let cssObj;
+    try {
+      cssObj = parser.parse(this.selector);
+    } catch (e) {
+      throw new errors.InvalidSelectorError(`Invalid CSS selector '${this.selector}'. Reason: '${e}'`);
+    }
+    try {
+      return this.parseCssObject(cssObj);
+    } catch (e) {
+      throw new errors.InvalidSelectorError(`Unsupported CSS selector '${this.selector}'. Reason: '${e}'`);
+    }
   }
-};
+}
 
 export default CssConverter;

package/lib/driver.js

@@ -1,9 +1,9 @@
 import _ from 'lodash';
-import { BaseDriver, DeviceSettings } from 'appium-base-driver';
+import { BaseDriver, DeviceSettings } from '@appium/base-driver';
 import {
   UiAutomator2Server, SERVER_PACKAGE_ID, SERVER_TEST_PACKAGE_ID
 } from './uiautomator2';
-import { fs, util, mjpeg } from 'appium-support';
+import { fs, util, mjpeg } from '@appium/support';
 import { retryInterval } from 'asyncbox';
 import B from 'bluebird';
 import logger from './logger';
@@ -67,7 +67,6 @@ const NO_PROXY = [
   ['GET', new RegExp('^/session/[^/]+/element/[^/]+/selected')],
   ['GET', new RegExp('^/session/[^/]+/ime/[^/]+')],
   ['GET', new RegExp('^/session/[^/]+/location')],
-  ['GET', new RegExp('^/session/[^/]+/log/types')],
   ['GET', new RegExp('^/session/[^/]+/network_connection')],
   ['GET', new RegExp('^/session/[^/]+/screenshot')],
   ['GET', new RegExp('^/session/[^/]+/timeouts')],
@@ -94,7 +93,6 @@ const NO_PROXY = [
   ['POST', new RegExp('^/session/[^/]+/ime/[^/]+')],
   ['POST', new RegExp('^/session/[^/]+/keys')],
   ['POST', new RegExp('^/session/[^/]+/location')],
-  ['POST', new RegExp('^/session/[^/]+/log')],
   ['POST', new RegExp('^/session/[^/]+/network_connection')],
   ['POST', new RegExp('^/session/[^/]+/timeouts')],
   ['POST', new RegExp('^/session/[^/]+/touch/multi/perform')],
@@ -102,12 +100,18 @@ const NO_PROXY = [
   ['POST', new RegExp('^/session/[^/]+/url')],
 
   // MJSONWP commands
+  ['GET', new RegExp('^/session/[^/]+/log/types')],
   ['POST', new RegExp('^/session/[^/]+/execute')],
   ['POST', new RegExp('^/session/[^/]+/execute_async')],
+  ['POST', new RegExp('^/session/[^/]+/log')],
   // W3C commands
+  // For Selenium v4 (W3C does not have this route)
+  ['GET', new RegExp('^/session/[^/]+/se/log/types')],
   ['GET', new RegExp('^/session/[^/]+/window/rect')],
   ['POST', new RegExp('^/session/[^/]+/execute/async')],
   ['POST', new RegExp('^/session/[^/]+/execute/sync')],
+  // For Selenium v4 (W3C does not have this route)
+  ['POST', new RegExp('^/session/[^/]+/se/log')],
 ];
 
 // This is a set of methods and paths that we never want to proxy to Chromedriver.
@@ -115,11 +119,9 @@ const CHROME_NO_PROXY = [
   ['GET', new RegExp('^/session/[^/]+/appium')],
   ['GET', new RegExp('^/session/[^/]+/context')],
   ['GET', new RegExp('^/session/[^/]+/element/[^/]+/rect')],
-  ['GET', new RegExp('^/session/[^/]+/log/types$')],
   ['GET', new RegExp('^/session/[^/]+/orientation')],
   ['POST', new RegExp('^/session/[^/]+/appium')],
   ['POST', new RegExp('^/session/[^/]+/context')],
-  ['POST', new RegExp('^/session/[^/]+/log$')],
   ['POST', new RegExp('^/session/[^/]+/orientation')],
   ['POST', new RegExp('^/session/[^/]+/touch/multi/perform')],
   ['POST', new RegExp('^/session/[^/]+/touch/perform')],
@@ -127,6 +129,15 @@ const CHROME_NO_PROXY = [
   // this is needed to make the mobile: commands working in web context
   ['POST', new RegExp('^/session/[^/]+/execute$')],
   ['POST', new RegExp('^/session/[^/]+/execute/sync')],
+
+  // MJSONWP commands
+  ['GET', new RegExp('^/session/[^/]+/log/types$')],
+  ['POST', new RegExp('^/session/[^/]+/log$')],
+  // W3C commands
+  // For Selenium v4 (W3C does not have this route)
+  ['GET', new RegExp('^/session/[^/]+/se/log/types$')],
+  // For Selenium v4 (W3C does not have this route)
+  ['POST', new RegExp('^/session/[^/]+/se/log$')],
 ];
 
 const MEMOIZED_FUNCTIONS = [

package/lib/helpers.js

@@ -1,5 +1,5 @@
 import path from 'path';
-import { fs, system } from 'appium-support';
+import { fs, system } from '@appium/support';
 
 
 let helpers = {};

package/lib/logger.js

@@ -1,4 +1,4 @@
-import { logger } from 'appium-support';
+import { logger } from '@appium/support';
 
 
 const log = logger.getLogger('UiAutomator2');

package/lib/server.js

@@ -1,5 +1,5 @@
 import log from './logger';
-import { server as baseServer, routeConfiguringFunction as makeRouter } from 'appium-base-driver';
+import { server as baseServer, routeConfiguringFunction as makeRouter } from '@appium/base-driver';
 import AndroidUiautomator2Driver from './driver';
 
 

package/lib/uiautomator2.js

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import { JWProxy, errors } from 'appium-base-driver';
+import { JWProxy, errors } from '@appium/base-driver';
 import { waitForCondition } from 'asyncbox';
 import log from './logger';
 import {
@@ -9,7 +9,7 @@ import {
 } from 'appium-uiautomator2-server';
 import {
   util, logger, tempDir, fs, timing
-} from 'appium-support';
+} from '@appium/support';
 import B from 'bluebird';
 import helpers from './helpers';
 import axios from 'axios';

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "1.72.0",
+  "version": "2.0.0",
   "author": "appium",
   "license": "Apache-2.0",
   "repository": {
@@ -40,20 +40,20 @@
     "build/lib"
   ],
   "dependencies": {
+    "@appium/base-driver": "^8.0.0",
+    "@appium/support": "^2.55.3",
     "@babel/runtime": "^7.0.0",
-    "appium-adb": "^8.10.0",
-    "appium-android-driver": "^4.51.0",
-    "appium-base-driver": "^7.0.0",
-    "appium-chromedriver": "^4.23.1",
-    "appium-support": "^2.49.0",
-    "appium-uiautomator2-server": "^4.28.0",
+    "appium-adb": "^9.0.0",
+    "appium-android-driver": "^5.0.0",
+    "appium-chromedriver": "^5.0.1",
+    "appium-uiautomator2-server": "^5.0.0",
     "asyncbox": "^2.3.1",
     "axios": "^0.x",
     "bluebird": "^3.5.1",
     "css-selector-parser": "^1.4.1",
     "lodash": "^4.17.4",
-    "portscanner": "2.2.0",
-    "source-map-support": "^0.5.5",
+    "portscanner": "^2.2.0",
+    "source-map-support": "^0.x",
     "teen_process": "^1.3.1"
   },
   "scripts": {
@@ -81,13 +81,19 @@
     "test"
   ],
   "devDependencies": {
+    "@appium/gulp-plugins": "^6.0.0",
+    "@appium/eslint-config-appium": "^5.0.0",
+    "@appium/test-support": "^1.0.0",
+    "@babel/core": "^7.16.0",
+    "@babel/eslint-parser": "^7.16.3",
     "@xmldom/xmldom": "^0.x",
-    "android-apidemos": "^3.0.0",
-    "appium-gulp-plugins": "^5.4.0",
-    "appium-test-support": "^1.0.0",
+    "android-apidemos": "^4.0.0",
     "chai": "^4.1.0",
     "chai-as-promised": "^7.1.1",
-    "eslint-config-appium": "^4.0.1",
+    "eslint": "^7.32.0",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-mocha": "^9.0.0",
+    "eslint-plugin-promise": "^6.0.0",
     "gps-demo-app": "^2.1.1",
     "gulp": "^4.0.0",
     "mocha": "^9.0.0",
@@ -97,8 +103,8 @@
     "pre-commit": "^1.2.2",
     "rimraf": "^3.0.0",
     "sinon": "^12.0.0",
-    "unzipper": "^0.10.0",
-    "wd": "^1.10.3",
+    "unzipper": "^0.x",
+    "webdriverio": "^7.0.0",
     "xpath": "^0.x"
   }
 }