appium-android-driver 4.53.0 → 5.0.2

package/lib/commands/system-bars.js

@@ -0,0 +1,131 @@
+import _ from 'lodash';
+import log from '../logger';
+
+const WINDOW_TITLE_PATTERN = /^\s+Window\s#\d+\sWindow\{[0-9a-f]+\s\w+\s([\w-]+)\}:$/;
+const FRAME_PATTERN = /^\s+mFrame=\[([0-9.-]+),([0-9.-]+)\]\[([0-9.-]+),([0-9.-]+)\]/m;
+const SURFACE_PATTERN = /^\s+Surface:\sshown=(true|false)/m;
+const STATUS_BAR_WINDOW_NAME_PREFIX = 'StatusBar';
+const NAVIGATION_BAR_WINDOW_NAME_PREFIX = 'NavigationBar';
+const DEFAULT_WINDOW_PROPERTIES = {
+  visible: false,
+  x: 0, y: 0, width: 0, height: 0,
+};
+
+const commands = {};
+
+/**
+ * @typedef {Object} WindowProperties
+ * @property {boolean} visible Whether the window is visible
+ * @property {number} x Window x coordinate
+ * @property {number} y Window y coordinate
+ * @property {number} width Window width
+ * @property {number} height Window height
+ */
+
+/**
+ * Parses window properties from adb dumpsys output
+ *
+ * @param {string} name The name of the window whose properties are being parsed
+ * @param {Array<string>} props The list of particular window property lines.
+ * Check the corresponding unit tests for more details on the input format.
+ * @returns {WindowProperties} Parsed properties object
+ * @throws {Error} If there was an issue while parsing the properties string
+ */
+function parseWindowProperties (name, props) {
+  const result = _.cloneDeep(DEFAULT_WINDOW_PROPERTIES);
+  const propLines = props.join('\n');
+  const frameMatch = FRAME_PATTERN.exec(propLines);
+  if (!frameMatch) {
+    log.debug(propLines);
+    throw new Error(`Cannot parse the frame size from '${name}' window properties`);
+  }
+  result.x = parseFloat(frameMatch[1]);
+  result.y = parseFloat(frameMatch[2]);
+  const left = parseFloat(frameMatch[3]);
+  const top = parseFloat(frameMatch[4]);
+  result.width = left - result.x;
+  result.height = top - result.y;
+  const visibilityMatch = SURFACE_PATTERN.exec(propLines);
+  if (!visibilityMatch) {
+    log.debug(propLines);
+    throw new Error(`Cannot parse the visibility value from '${name}' window properties`);
+  }
+  result.visible = visibilityMatch[1] === 'true';
+  return result;
+}
+
+/**
+ * Extracts status and navigation bar information from the window manager output.
+ *
+ * @param {Array<string>} lines Output from dumpsys command.
+ * Check the corresponding unit tests for more details on the input format.
+ * @return {Object} An object containing two items where keys are statusBar and navigationBar,
+ * and values are corresponding WindowProperties objects
+ * @throws {Error} If no window properties could be parsed
+ */
+function parseWindows (lines) {
+  const windows = {};
+  let currentWindowName = null;
+  let windowNameRowIndent = null;
+  for (const line of lines.split('\n').map(_.trimEnd)) {
+    const currentIndent = line.length - _.trimStart(line).length;
+    if (_.isNil(windowNameRowIndent) || currentIndent <= windowNameRowIndent) {
+      const match = WINDOW_TITLE_PATTERN.exec(line);
+      if (!match) {
+        currentWindowName = null;
+        continue;
+      }
+      currentWindowName = match[1];
+      if (_.isNil(windowNameRowIndent)) {
+        windowNameRowIndent = currentIndent;
+      }
+      continue;
+    }
+    if (!currentWindowName || currentIndent <= windowNameRowIndent) {
+      continue;
+    }
+
+    if (!_.isArray(windows[currentWindowName])) {
+      windows[currentWindowName] = [];
+    }
+    windows[currentWindowName].push(line);
+  }
+  if (_.isEmpty(windows)) {
+    log.debug(lines.join('\n'));
+    throw new Error('Cannot parse any window information from the dumpsys output');
+  }
+
+  const result = {statusBar: null, navigationBar: null};
+  for (const [name, props] of _.toPairs(windows)) {
+    if (name.startsWith(STATUS_BAR_WINDOW_NAME_PREFIX)) {
+      result.statusBar = parseWindowProperties(name, props);
+    } else if (name.startsWith(NAVIGATION_BAR_WINDOW_NAME_PREFIX)) {
+      result.navigationBar = parseWindowProperties(name, props);
+    }
+  }
+  const unmatchedWindows = [
+    ['statusBar', STATUS_BAR_WINDOW_NAME_PREFIX],
+    ['navigationBar', NAVIGATION_BAR_WINDOW_NAME_PREFIX]
+  ].filter(([name]) => _.isNil(result[name]));
+  for (const [window, namePrefix] of unmatchedWindows) {
+    log.info(`No windows have been found whose title matches to ` +
+      `'${namePrefix}'. Assuming it is invisible. ` +
+      `Only the following windows are available: ${_.keys(windows)}`);
+    result[window] = _.cloneDeep(DEFAULT_WINDOW_PROPERTIES);
+  }
+  return result;
+}
+
+commands.getSystemBars = async function getSystemBars () {
+  let stdout;
+  try {
+    stdout = await this.adb.shell(['dumpsys', 'window', 'windows']);
+  } catch (e) {
+    throw new Error(`Cannot retrieve system bars details. Original error: ${e.message}`);
+  }
+  return parseWindows(stdout);
+};
+
+// for unit tests
+export { parseWindows, parseWindowProperties };
+export default commands;

package/lib/commands/touch.js

@@ -2,9 +2,9 @@ import log from '../logger';
 import _ from 'lodash';
 import androidHelpers from '../android-helpers';
 import B from 'bluebird';
-import { errors, isErrorType } from 'appium-base-driver';
+import { errors, isErrorType } from '@appium/base-driver';
 import { asyncmap } from 'asyncbox';
-import { util } from 'appium-support';
+import { util } from '@appium/support';
 
 let commands = {}, helpers = {}, extensions = {};
 

package/lib/driver.js

@@ -1,4 +1,4 @@
-import { BaseDriver, DeviceSettings } from 'appium-base-driver';
+import { BaseDriver, DeviceSettings } from '@appium/base-driver';
 import desiredConstraints from './desired-caps';
 import commands from './commands/index';
 import {
@@ -8,7 +8,7 @@ import {
 import log from './logger';
 import _ from 'lodash';
 import { DEFAULT_ADB_PORT } from 'appium-adb';
-import { fs, tempDir, util } from 'appium-support';
+import { fs, tempDir, util } from '@appium/support';
 import { retryInterval } from 'asyncbox';
 import { SharedPrefsBuilder } from 'shared-preferences-builder';
 import B from 'bluebird';

package/lib/logger.js

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

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 AndroidDriver from './driver';
 
 async function startServer (port, host) {

package/lib/uiautomator.js

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

package/lib/unlock-helpers.js

@@ -1,7 +1,7 @@
 import logger from './logger';
 import { sleep } from 'asyncbox';
 import _ from 'lodash';
-import { util } from 'appium-support';
+import { util } from '@appium/support';
 
 const PIN_UNLOCK = 'pin';
 const PIN_UNLOCK_KEY_EVENT = 'pinWithKeyEvent';

package/lib/webview-helpers.js

@@ -1,7 +1,7 @@
 import _ from 'lodash';
 import logger from './logger';
 import axios from 'axios';
-import { util } from 'appium-support';
+import { util } from '@appium/support';
 import { findAPortNotInUse } from 'portscanner';
 import LRU from 'lru-cache';
 import B from 'bluebird';

package/package.json

@@ -9,7 +9,7 @@
     "mobile",
     "mobile testing"
   ],
-  "version": "4.53.0",
+  "version": "5.0.2",
   "author": "appium",
   "license": "Apache-2.0",
   "repository": {
@@ -35,25 +35,25 @@
     "bootstrap/bin/AppiumBootstrap.jar"
   ],
   "dependencies": {
+    "@appium/base-driver": "^8.0.0",
+    "@appium/support": "^2.55.3",
     "@babel/runtime": "^7.0.0",
-    "appium-adb": "^8.17.0",
-    "appium-base-driver": "^7.0.0",
-    "appium-chromedriver": "^4.13.0",
-    "appium-support": "^2.47.1",
+    "appium-adb": "^9.0.0",
+    "appium-chromedriver": "^5.0.1",
     "asyncbox": "^2.8.0",
     "axios": "^0.x",
     "bluebird": "^3.4.7",
-    "io.appium.settings": "^3.5.0",
-    "jimp": "^0.16.1",
+    "io.appium.settings": "^4.0.0",
+    "jimp": "^0.x",
     "lodash": "^4.17.4",
-    "lru-cache": "^6.0.0",
+    "lru-cache": "^7.3.0",
     "moment": "^2.24.0",
     "moment-timezone": "^0.5.26",
     "portfinder": "^1.0.6",
     "portscanner": "2.2.0",
-    "shared-preferences-builder": "^0.0.4",
+    "shared-preferences-builder": "^0.x",
     "semver": "^7.0.0",
-    "source-map-support": "^0.5.5",
+    "source-map-support": "^0.x",
     "teen_process": "^1.9.0",
     "ws": "^8.0.0"
   },
@@ -77,18 +77,20 @@
     "precommit-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.2",
     "chai-as-promised": "^7.1.1",
-    "eslint-config-appium": "^4.0.1",
     "gulp": "^4.0.0",
     "mocha": "^9.0.0",
     "mock-fs": "^5.0.0",
     "pre-commit": "^1.1.3",
-    "sinon": "^12.0.0",
+    "sinon": "^13.0.0",
     "xpath": "^0.x"
   }
 }