appium-adb 9.2.3 → 9.4.0

package/lib/tools/system-calls.js

@@ -197,6 +197,12 @@ systemCallMethods.getBinaryFromPath = async function getBinaryFromPath (binaryNa
   }
 };
 
+/**
+ * @typedef {Object} ConnectedDevicesOptions
+ * @property {?boolean} verbose - Whether to get long output, which includes extra properties in each device.
+ * Akin to running `adb devices -l`.
+ */
+
 /**
  * @typedef {Object} Device
  * @property {string} udid - The device udid.
@@ -204,18 +210,33 @@ systemCallMethods.getBinaryFromPath = async function getBinaryFromPath (binaryNa
  *                            _adb devices -l_ output.
  */
 
+/**
+ * @typedef {Device} VerboseDevice Additional properties returned when `verbose` is true.
+ * @property {string} product - The product codename of the device, such as "razor".
+ * @property {string} model - The model name of the device, such as "Nexus_7".
+ * @property {string} device - The device codename, such as "flow".
+ * @property {?string} usb - Represents the USB port the device is connected to, such as "1-1".
+ * @property {?string} transport_id - The Transport ID for the device, such as "1".
+ */
+
 /**
  * Retrieve the list of devices visible to adb.
  *
+ * @param {?ConnectedDevicesOptions} opts [{}] - Additional options mapping.
  * @return {Array.<Device>} The list of devices or an empty list if
  *                          no devices are connected.
  * @throws {Error} If there was an error while listing devices.
  */
-systemCallMethods.getConnectedDevices = async function getConnectedDevices () {
+systemCallMethods.getConnectedDevices = async function getConnectedDevices (opts = {}) {
   log.debug('Getting connected devices');
+  const args = [...this.executable.defaultArgs, 'devices'];
+  if (opts.verbose) {
+    args.push('-l');
+  }
+
   let stdout;
   try {
-    ({stdout} = await exec(this.executable.path, [...this.executable.defaultArgs, 'devices']));
+    ({stdout} = await exec(this.executable.path, args));
   } catch (e) {
     throw new Error(`Error while getting connected devices. Original error: ${e.message}`);
   }
@@ -236,12 +257,21 @@ systemCallMethods.getConnectedDevices = async function getConnectedDevices () {
   const devices = stdout.split('\n')
     .map(_.trim)
     .filter((line) => line && !excludedLines.some((x) => line.includes(x)))
-    .reduce((acc, line) => {
+    .map((line) => {
       // state is "device", afaic
-      const [udid, state] = line.split(/\s+/);
-      acc.push({udid, state});
-      return acc;
-    }, []);
+      const [udid, state, ...description] = line.split(/\s+/);
+      const device = {udid, state};
+      if (opts.verbose) {
+        for (const entry of description) {
+          if (entry.includes(':')) {
+            // each entry looks like key:value
+            const [key, value] = entry.split(':');
+            device[key] = value;
+          }
+        }
+      }
+      return device;
+    });
   if (_.isEmpty(devices)) {
     log.debug('No connected devices have been detected');
   } else {
@@ -577,12 +607,13 @@ systemCallMethods.getPortFromEmulatorString = function getPortFromEmulatorString
 /**
  * Retrieve the list of currently connected emulators.
  *
+ * @param {?ConnectedDevicesOptions} opts [{}] - Additional options mapping.
  * @return {Array.<Device>} The list of connected devices.
  */
-systemCallMethods.getConnectedEmulators = async function getConnectedEmulators () {
+systemCallMethods.getConnectedEmulators = async function getConnectedEmulators (opts = {}) {
   log.debug('Getting connected emulators');
   try {
-    let devices = await this.getConnectedDevices();
+    let devices = await this.getConnectedDevices(opts);
     let emulators = [];
     for (let device of devices) {
       let port = this.getPortFromEmulatorString(device.udid);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-adb",
-  "version": "9.2.3",
+  "version": "9.4.0",
   "description": "Android Debug Bridge interface",
   "main": "./build/index.js",
   "scripts": {
@@ -77,7 +77,7 @@
     "mocha-multi-reporters": "^1.1.7",
     "pre-commit": "^1.1.3",
     "semantic-release": "^19.0.2",
-    "sinon": "^13.0.0",
+    "sinon": "^14.0.0",
     "temp": "^0.x"
   }
 }