appium-uiautomator2-driver 6.6.1 → 6.6.2

package/lib/commands/screenshot.ts

@@ -0,0 +1,146 @@
+import _ from 'lodash';
+import B from 'bluebird';
+import {imageUtil} from 'appium/support';
+import type {AndroidUiautomator2Driver} from '../driver';
+import type {Screenshot} from './types';
+import type {StringRecord} from '@appium/types';
+
+// Matches SurfaceFlinger output format:
+// Physical: Display 4619827259835644672 (HWC display 0): port=0 pnpId=GGL displayName="EMU_display_0"
+// Virtual: Display 11529215049243506835 (Virtual display): displayName="Emulator 2D Display" uniqueId="..."
+const DISPLAY_PATTERN = /^Display\s+(\d+)\s+\((?:HWC\s+display\s+(\d+)|Virtual\s+display)\):.*?displayName="([^"]*)"/gm;
+
+/**
+ * Parses SurfaceFlinger display output to extract display information.
+ * @param displaysInfo - The raw output from `adb shell dumpsys SurfaceFlinger --display-id`
+ * @returns A record mapping display IDs to their information (without payload)
+ */
+export function parseSurfaceFlingerDisplays(
+  displaysInfo: string
+): Record<string, Partial<Screenshot>> {
+  const infos: Record<string, Partial<Screenshot>> = {};
+  const lines = displaysInfo.split('\n');
+
+  for (const line of lines) {
+    let match: RegExpExecArray | null;
+
+    // Try to match display header line
+    if ((match = DISPLAY_PATTERN.exec(line))) {
+      const [, matchedDisplayId, hwcId, displayName] = match; // Skip match[0] (full match), then Display ID, HWC ID (optional), Display name
+
+      // Determine if default: HWC display 0 is default, or first physical display if no HWC info
+      const isDefault = hwcId !== undefined
+        ? hwcId === '0'
+        : !line.includes('Virtual') && Object.keys(infos).length === 0;
+
+      infos[matchedDisplayId] = {
+        id: matchedDisplayId,
+        isDefault,
+        name: displayName || undefined,
+      };
+
+      // Reset regex lastIndex for next iteration
+      DISPLAY_PATTERN.lastIndex = 0;
+    }
+  }
+
+  return infos;
+}
+
+/**
+ * Takes a screenshot of the current viewport
+ */
+export async function mobileViewportScreenshot(
+  this: AndroidUiautomator2Driver
+): Promise<string> {
+  return await this.getViewportScreenshot();
+}
+
+/**
+ * Gets a screenshot of the current viewport
+ */
+export async function getViewportScreenshot(
+  this: AndroidUiautomator2Driver
+): Promise<string> {
+  const screenshot = await this.getScreenshot();
+  const rect = await this.getViewPortRect();
+  return await imageUtil.cropBase64Image(screenshot, rect);
+}
+
+/**
+ * Gets a screenshot of the current screen
+ */
+export async function getScreenshot(
+  this: AndroidUiautomator2Driver
+): Promise<string> {
+  if (this.mjpegStream) {
+    const data = await this.mjpegStream.lastChunkPNGBase64();
+    if (data) {
+      return data;
+    }
+    this.log.warn(
+      'Tried to get screenshot from active MJPEG stream, but there ' +
+        'was no data yet. Falling back to regular screenshot methods.'
+    );
+  }
+  return String(
+    await this.uiautomator2.jwproxy.command('/screenshot', 'GET')
+  );
+}
+
+/**
+ * Retrieves screenshots of each display available to Android.
+ * This functionality is only supported since Android 10.
+ * @param displayId - Android display identifier to take a screenshot for.
+ * If not provided then screenshots of all displays are going to be returned.
+ * If no matches were found then an error is thrown.
+ */
+export async function mobileScreenshots(
+  this: AndroidUiautomator2Driver,
+  displayId?: number | string
+): Promise<StringRecord<Screenshot>> {
+  const displaysInfo = await this.adb.shell([
+    'dumpsys',
+    'SurfaceFlinger',
+    '--display-id',
+  ]);
+  const infos = parseSurfaceFlingerDisplays(displaysInfo);
+  if (_.isEmpty(infos)) {
+    this.log.debug(displaysInfo);
+    throw new Error('Cannot determine the information about connected Android displays');
+  }
+  this.log.info(`Parsed Android display infos: ${JSON.stringify(infos)}`);
+
+  const toB64Screenshot = async (dispId: string): Promise<string> =>
+    (await this.adb.takeScreenshot(dispId)).toString('base64');
+
+  const displayIdStr: string | null =
+    _.isNil(displayId) || displayId === ''
+      ? null
+      : String(displayId);
+
+  if (displayIdStr) {
+    if (!infos[displayIdStr]) {
+      throw new Error(
+        `The provided display identifier '${displayId}' is not known. ` +
+          `Only the following displays have been detected: ${JSON.stringify(infos)}`
+      );
+    }
+    return {
+      [displayIdStr]: {
+        ...infos[displayIdStr],
+        payload: await toB64Screenshot(displayIdStr),
+      } as Screenshot,
+    };
+  }
+
+  const allInfos = _.values(infos).filter((info): info is Partial<Screenshot> & {id: string} => !!info?.id);
+  const screenshots = await B.all(allInfos.map((info) => toB64Screenshot(info.id)));
+  for (const [info, payload] of _.zip(allInfos, screenshots) as Array<[Partial<Screenshot>, string]>) {
+    if (info && payload) {
+      info.payload = payload;
+    }
+  }
+  return infos as StringRecord<Screenshot>;
+}
+

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-uiautomator2-driver",
-  "version": "6.6.1",
+  "version": "6.6.2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-uiautomator2-driver",
-      "version": "6.6.1",
+      "version": "6.6.2",
       "license": "Apache-2.0",
       "dependencies": {
         "appium-adb": "^14.0.0",
@@ -631,9 +631,9 @@
       }
     },
     "node_modules/appium-chromedriver": {
-      "version": "8.0.23",
-      "resolved": "https://registry.npmjs.org/appium-chromedriver/-/appium-chromedriver-8.0.23.tgz",
-      "integrity": "sha512-T1A+9A4X396/MSmVaLkQb1Gkbj0OYxTG/hIr+Qq/Iv0HMsIq7boFiDauPhfi5cVoJ6gMdv9KQc+9BdhvpPAboA==",
+      "version": "8.0.24",
+      "resolved": "https://registry.npmjs.org/appium-chromedriver/-/appium-chromedriver-8.0.24.tgz",
+      "integrity": "sha512-OL2OoICSwBzv7k08MnVEemRGTCL+cHxyOkPWxg4gWQ4nv76+U/rKGtU9b7MP0j1rC7rdpZGjGuyDcsD3U7BZqg==",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/base-driver": "^10.0.0-rc.2",
@@ -656,9 +656,9 @@
       }
     },
     "node_modules/appium-uiautomator2-server": {
-      "version": "9.8.0",
-      "resolved": "https://registry.npmjs.org/appium-uiautomator2-server/-/appium-uiautomator2-server-9.8.0.tgz",
-      "integrity": "sha512-iG/PufSB2hRj7yMtnpiyocOkEQdlmXHGfKEVTJXtuVmNO2ZZ/frZ8jdknO83T2zqzQBVUj5saNBx+zpfiWvI2g==",
+      "version": "9.9.0",
+      "resolved": "https://registry.npmjs.org/appium-uiautomator2-server/-/appium-uiautomator2-server-9.9.0.tgz",
+      "integrity": "sha512-j9XN7AjP7dWk9HA+/segTQUyhV4n0LyMJdtKMLRXp60r+6oYX4UYh57Rp9NaHY5UPykw+2eFhOdc5n101IDItg==",
       "license": "Apache-2.0",
       "engines": {
         "node": "^20.19.0 || ^22.12.0 || >=24.0.0",

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "6.6.1",
+  "version": "6.6.2",
   "bugs": {
     "url": "https://github.com/appium/appium-uiautomator2-driver/issues"
   },
@@ -48,7 +48,7 @@
     "rebuild": "npm run clean; npm run build",
     "format": "prettier -w ./lib",
     "reset": "node ./scripts/reset.js",
-    "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.js\""
+    "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.ts\""
   },
   "prettier": {
     "bracketSpacing": false,

package/lib/commands/screenshot.js

@@ -1,116 +0,0 @@
-import _ from 'lodash';
-import B from 'bluebird';
-import {imageUtil} from 'appium/support';
-
-// Display 4619827259835644672 (HWC display 0): port=0 pnpId=GGL displayName="EMU_display_0"
-const DISPLAY_PATTERN = /^Display\s+(\d+)\s+\(.+display\s+(\d+)\).+displayName="([^"]*)/gm;
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @returns {Promise<string>}
- */
-export async function mobileViewportScreenshot() {
-  return await this.getViewportScreenshot();
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @returns {Promise<string>}
- */
-export async function getViewportScreenshot() {
-  const screenshot = await this.getScreenshot();
-  const rect = await this.getViewPortRect();
-  return await imageUtil.cropBase64Image(screenshot, rect);
-}
-
-/**
- * @this {AndroidUiautomator2Driver}
- * @returns {Promise<string>}
- */
-export async function getScreenshot() {
-  if (this.mjpegStream) {
-    const data = await this.mjpegStream.lastChunkPNGBase64();
-    if (data) {
-      return data;
-    }
-    this.log.warn(
-      'Tried to get screenshot from active MJPEG stream, but there ' +
-        'was no data yet. Falling back to regular screenshot methods.'
-    );
-  }
-  return String(
-    await /** @type {import('../uiautomator2').UiAutomator2Server} */ (
-      this.uiautomator2
-    ).jwproxy.command('/screenshot', 'GET')
-  );
-}
-
-/**
- * Retrieves screenshots of each display available to Android.
- * This functionality is only supported since Android 10.
- * @this {AndroidUiautomator2Driver}
- * @param {number | string} [displayId] Android display identifier to take a screenshot for.
- * If not provided then screenshots of all displays are going to be returned.
- * If no matches were found then an error is thrown.
- * @returns {Promise<import('@appium/types').StringRecord<import('./types').Screenshot>>}
- */
-export async function mobileScreenshots(displayId) {
-  const displaysInfo = await /** @type {import('appium-adb').ADB} */ (this.adb).shell([
-    'dumpsys',
-    'SurfaceFlinger',
-    '--display-id',
-  ]);
-  /** @type {import('@appium/types').StringRecord<import('./types').Screenshot>} */
-  const infos = {};
-  let match;
-  while ((match = DISPLAY_PATTERN.exec(displaysInfo))) {
-    infos[match[1]] = /** @type {any} */ ({
-      id: match[1],
-      isDefault: match[2] === '0',
-      name: match[3],
-    });
-  }
-  if (_.isEmpty(infos)) {
-    this.log.debug(displaysInfo);
-    throw new Error('Cannot determine the information about connected Android displays');
-  }
-  this.log.info(`Parsed Android display infos: ${JSON.stringify(infos)}`);
-
-  /**
-   * @param {string} dispId
-   */
-  const toB64Screenshot = async (dispId) =>
-    (await /** @type {import('appium-adb').ADB} */ (this.adb).takeScreenshot(dispId)).toString(
-      'base64'
-    );
-
-  // @ts-ignore isNaN works properly here
-  const displayIdStr = isNaN(displayId) ? null : `${displayId}`;
-  if (displayIdStr) {
-    if (!infos[displayIdStr]) {
-      throw new Error(
-        `The provided display identifier '${displayId}' is not known. ` +
-          `Only the following displays have been detected: ${JSON.stringify(infos)}`
-      );
-    }
-    return {
-      [displayIdStr]: {
-        ...infos[displayIdStr],
-        payload: await toB64Screenshot(displayIdStr),
-      },
-    };
-  }
-
-  const allInfos = _.values(infos);
-  const screenshots = await B.all(allInfos.map(({id}) => toB64Screenshot(id)));
-  for (const [info, payload] of /** @type {[import('./types').Screenshot, string][]} */ (
-    _.zip(allInfos, screenshots)
-  )) {
-    info.payload = payload;
-  }
-  return infos;
-}
-
-/**
- * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
- */