appium-android-driver
Version:
Android UiAutomator and Chrome support for Appium
180 lines • 7.74 kB
JavaScript
;
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getSystemBars = getSystemBars;
exports.mobilePerformStatusBarCommand = mobilePerformStatusBarCommand;
exports.parseWindowProperties = parseWindowProperties;
exports.parseWindows = parseWindows;
const driver_1 = require("appium/driver");
const lodash_1 = __importDefault(require("lodash"));
const WINDOW_TITLE_PATTERN = /^\s+Window\s#\d+\sWindow\{[0-9a-f]+\s\w+\s([\w-]+)\}:$/;
const FRAME_PATTERN = /\bm?[Ff]rame=\[([0-9.-]+),([0-9.-]+)\]\[([0-9.-]+),([0-9.-]+)\]/;
// https://github.com/appium/appium-uiautomator2-driver/issues/904
const STATUS_BAR_TYPE_PATTERN = /\bty=STATUS_BAR\b/;
const NAVIGATION_BAR_TYPE_PATTERN = /\bty=NAVIGATION_BAR\b/;
const VIEW_VISIBILITY_PATTERN = /\bmViewVisibility=(0x[0-9a-fA-F]+)/;
// https://developer.android.com/reference/android/view/View#VISIBLE
const VIEW_VISIBLE = 0x0;
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,
};
/**
* @this {import('../driver').AndroidDriver}
* @returns {Promise<StringRecord>}
*/
async function getSystemBars() {
/** @type {string} */
let stdout;
try {
stdout = await this.adb.shell(['dumpsys', 'window', 'windows']);
}
catch (e) {
throw new Error(`Cannot retrieve system bars details. Original error: ${ /** @type {Error} */(e).message}`);
}
return parseWindows.bind(this)(stdout);
}
/**
* @this {import('../driver').AndroidDriver}
* @param {import('./types').StatusBarCommand} command Each list
* item must separated with a new line (`\n`) character.
* @param {string} [component] The name of the tile component.
* It is only required for `(add|remove|click)Tile` commands.
* Example value: `com.package.name/.service.QuickSettingsTileComponent`
* @returns {Promise<string>}
*/
async function mobilePerformStatusBarCommand(command, component) {
/**
*
* @param {string} cmd
* @param {(() => string[]|string)} [argsCallable]
* @returns
*/
const toStatusBarCommandCallable = (cmd, argsCallable) => async () => await this.adb.shell([
'cmd',
'statusbar',
cmd,
...(argsCallable ? lodash_1.default.castArray(argsCallable()) : []),
]);
const tileCommandArgsCallable = () => /** @type {string} */ (component);
const statusBarCommands = lodash_1.default.fromPairs(
/** @type {const} */ ([
['expandNotifications', ['expand-notifications']],
['expandSettings', ['expand-settings']],
['collapse', ['collapse']],
['addTile', ['add-tile', tileCommandArgsCallable]],
['removeTile', ['remove-tile', tileCommandArgsCallable]],
['clickTile', ['click-tile', tileCommandArgsCallable]],
['getStatusIcons', ['get-status-icons']],
]).map(([name, args]) => [name, toStatusBarCommandCallable(args[0], args[1])]));
const action = statusBarCommands[command];
if (!action) {
throw new driver_1.errors.InvalidArgumentError(`The '${command}' status bar command is unknown. Only the following commands ` +
`are supported: ${lodash_1.default.keys(statusBarCommands)}`);
}
return await action();
}
// #region Internal helpers
/**
* Parses window properties from adb dumpsys output
*
* @this {import('../driver').AndroidDriver}
* @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 = lodash_1.default.cloneDeep(DEFAULT_WINDOW_PROPERTIES);
const propLines = props.join('\n');
const frameMatch = FRAME_PATTERN.exec(propLines);
if (!frameMatch) {
this.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]);
result.width = parseFloat(frameMatch[3]) - result.x;
result.height = parseFloat(frameMatch[4]) - result.y;
const visibilityMatch = VIEW_VISIBILITY_PATTERN.exec(propLines);
if (!visibilityMatch) {
this.log.debug(propLines);
throw new Error(`Cannot parse the visibility value from '${name}' window properties`);
}
result.visible = parseInt(visibilityMatch[1], 16) === VIEW_VISIBLE;
return result;
}
/**
* Extracts status and navigation bar information from the window manager output.
*
* @this {import('../driver').AndroidDriver}
* @param {string} lines Output from dumpsys command.
* Check the corresponding unit tests for more details on the input format.
* @return {StringRecord} 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) {
/**
* @type {StringRecord}
*/
const windows = {};
let currentWindowName = null;
for (const line of lines.split('\n').map(lodash_1.default.trimEnd)) {
const match = WINDOW_TITLE_PATTERN.exec(line);
if (match) {
currentWindowName = match[1];
windows[currentWindowName] = [];
continue;
}
if (lodash_1.default.trim(line).length === 0) {
currentWindowName = null;
continue;
}
if (currentWindowName && lodash_1.default.isArray(windows[currentWindowName])) {
windows[currentWindowName].push(line);
}
}
if (lodash_1.default.isEmpty(windows)) {
this.log.debug(lines);
throw new Error('Cannot parse any window information from the dumpsys output');
}
/** @type {{statusBar?: WindowProperties, navigationBar?: WindowProperties}} */
const result = {};
for (const [name, props] of lodash_1.default.toPairs(windows)) {
if (name.startsWith(STATUS_BAR_WINDOW_NAME_PREFIX)
|| props.some((/** @type {string} */ line) => STATUS_BAR_TYPE_PATTERN.test(line))) {
result.statusBar = parseWindowProperties.bind(this)(name, props);
}
else if (name.startsWith(NAVIGATION_BAR_WINDOW_NAME_PREFIX)
|| props.some((/** @type {string} */ line) => NAVIGATION_BAR_TYPE_PATTERN.test(line))) {
result.navigationBar = parseWindowProperties.bind(this)(name, props);
}
}
const unmatchedWindows = /** @type {const} */ ([
['statusBar', STATUS_BAR_WINDOW_NAME_PREFIX],
['navigationBar', NAVIGATION_BAR_WINDOW_NAME_PREFIX],
]).filter(([name]) => lodash_1.default.isNil(result[name]));
for (const [window, namePrefix] of unmatchedWindows) {
this.log.info(`No windows have been found whose title matches to ` +
`'${namePrefix}'. Assuming it is invisible. ` +
`Only the following windows are available: ${lodash_1.default.keys(windows)}`);
result[window] = lodash_1.default.cloneDeep(DEFAULT_WINDOW_PROPERTIES);
}
return result;
}
// #endregion
/**
* @typedef {import('appium-adb').ADB} ADB
* @typedef {import('@appium/types').StringRecord} StringRecord
* @typedef {import('./types').WindowProperties} WindowProperties
*/
//# sourceMappingURL=system-bars.js.map