appium-android-driver 4.51.0 → 4.54.0

package/lib/commands/performance.js

@@ -2,72 +2,149 @@ import _ from 'lodash';
 import { retryInterval } from 'asyncbox';
 import log from '../logger';
 
+const commands = {}, helpers = {}, extensions = {};
 
-let commands = {}, helpers = {}, extensions = {};
-
-const NETWORK_KEYS = [['bucketStart', 'activeTime', 'rxBytes', 'rxPackets', 'txBytes', 'txPackets', 'operations', 'bucketDuration'], ['st', 'activeTime', 'rb', 'rp', 'tb', 'tp', 'op', 'bucketDuration']];
+const NETWORK_KEYS = [
+  ['bucketStart', 'activeTime', 'rxBytes', 'rxPackets', 'txBytes', 'txPackets', 'operations', 'bucketDuration'],
+  ['st', 'activeTime', 'rb', 'rp', 'tb', 'tp', 'op', 'bucketDuration']
+];
 const CPU_KEYS = ['user', 'kernel'];
 const BATTERY_KEYS = ['power'];
-const MEMORY_KEYS = ['totalPrivateDirty', 'nativePrivateDirty', 'dalvikPrivateDirty', 'eglPrivateDirty', 'glPrivateDirty', 'totalPss', 'nativePss', 'dalvikPss', 'eglPss', 'glPss', 'nativeHeapAllocatedSize', 'nativeHeapSize'];
-
-const SUPPORTED_PERFORMANCE_DATA_TYPES = {
+const MEMORY_KEYS = [
+  'totalPrivateDirty', 'nativePrivateDirty', 'dalvikPrivateDirty',
+  'eglPrivateDirty', 'glPrivateDirty',
+  'totalPss', 'nativePss', 'dalvikPss', 'eglPss', 'glPss',
+  'nativeHeapAllocatedSize', 'nativeHeapSize',
+  'nativeRss', 'dalvikRss', 'totalRss'
+];
+const SUPPORTED_PERFORMANCE_DATA_TYPES = Object.freeze({
   cpuinfo: 'the amount of cpu by user and kernel process - cpu information for applications on real devices and simulators',
   memoryinfo: 'the amount of memory used by the process - memory information for applications on real devices and simulators',
   batteryinfo: 'the remaining battery power - battery power information for applications on real devices and simulators',
   networkinfo: 'the network statistics - network rx/tx information for applications on real devices and simulators'
-};
-
-const RETRY_PAUSE = 1000;
+});
+const MEMINFO_TITLES = Object.freeze({
+  NATIVE: 'Native',
+  DALVIK: 'Dalvik',
+  EGL: 'EGL',
+  GL: 'GL',
+  MTRACK: 'mtrack',
+  TOTAL: 'TOTAL',
+  HEAP: 'Heap'
+});
+const RETRY_PAUSE_MS = 1000;
+
+/**
+ * API level between 18 and 30
+ * ['<System Type>', '<Memory Type>', <pss total>, <private dirty>, <private clean>, <swapPss dirty>, <heap size>, <heap alloc>, <heap free>]
+ * except 'TOTAL', which skips the second type name
+ * !!! valDict gets mutated
+ */
+function parseMeminfoForApi19To29 (entries, valDict) {
+  const [type, subType] = entries;
+  if (type === MEMINFO_TITLES.NATIVE && subType === MEMINFO_TITLES.HEAP) {
+    [,, valDict.nativePss, valDict.nativePrivateDirty,,, valDict.nativeHeapSize, valDict.nativeHeapAllocatedSize] = entries;
+  } else if (type === MEMINFO_TITLES.DALVIK && subType === MEMINFO_TITLES.HEAP) {
+    [,, valDict.dalvikPss, valDict.dalvikPrivateDirty] = entries;
+  } else if (type === MEMINFO_TITLES.EGL && subType === MEMINFO_TITLES.MTRACK) {
+    [,, valDict.eglPss, valDict.eglPrivateDirty] = entries;
+  } else if (type === MEMINFO_TITLES.GL && subType === MEMINFO_TITLES.MTRACK) {
+    [,, valDict.glPss, valDict.glPrivateDirty] = entries;
+  } else if (type === MEMINFO_TITLES.TOTAL && entries.length === 8) {
+    // there are two totals, and we only want the full listing, which has 8 entries
+    [, valDict.totalPss, valDict.totalPrivateDirty] = entries;
+  }
+}
+
+/**
+ * ['<System Type', '<pps>', '<shared dirty>', '<private dirty>', '<heap size>', '<heap alloc>', '<heap free>']
+ * !!! valDict gets mutated
+ */
+function parseMeminfoForApiBelow19 (entries, valDict) {
+  const type = entries[0];
+  if (type === MEMINFO_TITLES.NATIVE) {
+    [, valDict.nativePss,, valDict.nativePrivateDirty, valDict.nativeHeapSize, valDict.nativeHeapAllocatedSize] = entries;
+  } else if (type === MEMINFO_TITLES.DALVIK) {
+    [, valDict.dalvikPss,, valDict.dalvikPrivateDirty] = entries;
+  } else if (type === MEMINFO_TITLES.EGL) {
+    [, valDict.eglPss,, valDict.eglPrivateDirty] = entries;
+  } else if (type === MEMINFO_TITLES.GL) {
+    [, valDict.glPss,, valDict.glPrivateDirty] = entries;
+  } else if (type === MEMINFO_TITLES.TOTAL) {
+    [, valDict.totalPss,, valDict.totalPrivateDirty] = entries;
+  }
+}
+
+/**
+ * API level 30 and above
+ * ['<System Type>', '<Memory Type>', <pss total>, <private dirty>, <private clean>, <swapPss dirty>, <rss total>, <heap size>, <heap alloc>, <heap free>]
+ * !!! valDict gets mutated
+ */
+function parseMeminfoForApiAbove29 (entries, valDict) {
+  const [type, subType] = entries;
+  if (type === MEMINFO_TITLES.NATIVE && subType === MEMINFO_TITLES.HEAP) {
+    [,, valDict.nativePss, valDict.nativePrivateDirty,,, valDict.nativeRss, valDict.nativeHeapSize, valDict.nativeHeapAllocatedSize] = entries;
+  } else if (type === MEMINFO_TITLES.DALVIK && subType === MEMINFO_TITLES.HEAP) {
+    [,, valDict.dalvikPss, valDict.dalvikPrivateDirty,,, valDict.dalvikRss] = entries;
+  } else if (type === MEMINFO_TITLES.EGL && subType === MEMINFO_TITLES.MTRACK) {
+    [,, valDict.eglPss, valDict.eglPrivateDirty] = entries;
+  } else if (type === MEMINFO_TITLES.GL && subType === MEMINFO_TITLES.MTRACK) {
+    [,, valDict.glPss, valDict.glPrivateDirty] = entries;
+  } else if (type === MEMINFO_TITLES.TOTAL && entries.length === 9) {
+    // has 9 entries
+    [, valDict.totalPss, valDict.totalPrivateDirty,,, valDict.totalRss] = entries;
+  }
+}
 
 //
 // returns the information type of the system state which is supported to read as like cpu, memory, network traffic, and battery.
 // output - array like below
-//[cpuinfo, batteryinfo, networkinfo, memoryinfo]
+// [cpuinfo, batteryinfo, networkinfo, memoryinfo]
 //
 commands.getPerformanceDataTypes = function getPerformanceDataTypes () {
   return _.keys(SUPPORTED_PERFORMANCE_DATA_TYPES);
 };
 
-// returns the information type of the system state which is supported to read as like cpu, memory, network traffic, and battery.
-//input - (packageName) the package name of the application
-//        (dataType) the type of system state which wants to read. It should be one of the keys of the SUPPORTED_PERFORMANCE_DATA_TYPES
-//        (dataReadTimeout) the number of attempts to read
-// output - table of the performance data, The first line of the table represents the type of data. The remaining lines represent the values of the data.
-//
-// in case of battery info : [[power], [23]]
-// in case of memory info :  [[totalPrivateDirty, nativePrivateDirty, dalvikPrivateDirty, eglPrivateDirty, glPrivateDirty, totalPss, nativePss, dalvikPss, eglPss, glPss, nativeHeapAllocatedSize, nativeHeapSize], [18360, 8296, 6132, null, null, 42588, 8406, 7024, null, null, 26519, 10344]]
-// in case of network info : [[bucketStart, activeTime, rxBytes, rxPackets, txBytes, txPackets, operations, bucketDuration,], [1478091600000, null, 1099075, 610947, 928, 114362, 769, 0, 3600000], [1478095200000, null, 1306300, 405997, 509, 46359, 370, 0, 3600000]]
-// in case of network info : [[st, activeTime, rb, rp, tb, tp, op, bucketDuration], [1478088000, null, null, 32115296, 34291, 2956805, 25705, 0, 3600], [1478091600, null, null, 2714683, 11821, 1420564, 12650, 0, 3600], [1478095200, null, null, 10079213, 19962, 2487705, 20015, 0, 3600], [1478098800, null, null, 4444433, 10227, 1430356, 10493, 0, 3600]]
-// in case of cpu info : [[user, kernel], [0.9, 1.3]]
-//
-commands.getPerformanceData = async function getPerformanceData (packageName, dataType, dataReadTimeout = 2) {
-  let data;
-  switch (dataType) {
+/**
+ * @returns The information type of the system state which is supported to read as like cpu, memory, network traffic, and battery.
+ * input - (packageName) the package name of the application
+ *        (dataType) the type of system state which wants to read. It should be one of the keys of the SUPPORTED_PERFORMANCE_DATA_TYPES
+ *        (dataReadTimeout) the number of attempts to read
+ * output - table of the performance data, The first line of the table represents the type of data. The remaining lines represent the values of the data.
+ *
+ * in case of battery info : [[power], [23]]
+ * in case of memory info :  [[totalPrivateDirty, nativePrivateDirty, dalvikPrivateDirty, eglPrivateDirty, glPrivateDirty, totalPss,
+ *   nativePss, dalvikPss, eglPss, glPss, nativeHeapAllocatedSize, nativeHeapSize], [18360, 8296, 6132, null, null, 42588, 8406, 7024, null, null, 26519, 10344]]
+ * in case of network info : [[bucketStart, activeTime, rxBytes, rxPackets, txBytes, txPackets, operations, bucketDuration,],
+ *   [1478091600000, null, 1099075, 610947, 928, 114362, 769, 0, 3600000], [1478095200000, null, 1306300, 405997, 509, 46359, 370, 0, 3600000]]
+ * in case of network info : [[st, activeTime, rb, rp, tb, tp, op, bucketDuration], [1478088000, null, null, 32115296, 34291, 2956805, 25705, 0, 3600],
+ *   [1478091600, null, null, 2714683, 11821, 1420564, 12650, 0, 3600], [1478095200, null, null, 10079213, 19962, 2487705, 20015, 0, 3600],
+ *   [1478098800, null, null, 4444433, 10227, 1430356, 10493, 0, 3600]]
+ * in case of cpu info : [[user, kernel], [0.9, 1.3]]
+ */
+commands.getPerformanceData = async function getPerformanceData (packageName, dataType, retries = 2) {
+  switch (_.toLower(dataType)) {
     case 'batteryinfo':
-      data = await this.getBatteryInfo(dataReadTimeout);
-      break;
+      return await this.getBatteryInfo(retries);
     case 'cpuinfo':
-      data = await this.getCPUInfo(packageName, dataReadTimeout);
-      break;
+      return await this.getCPUInfo(packageName, retries);
     case 'memoryinfo':
-      data = await this.getMemoryInfo(packageName, dataReadTimeout);
-      break;
+      return await this.getMemoryInfo(packageName, retries);
     case 'networkinfo':
-      data = await this.getNetworkTrafficInfo(dataReadTimeout);
-      break;
+      return await this.getNetworkTrafficInfo(retries);
     default:
-      throw new Error(`No performance data of type '${dataType}' found.`);
+      throw new Error(`No performance data of type '${dataType}' found. ` +
+        `Only the following values are supported: ${JSON.stringify(SUPPORTED_PERFORMANCE_DATA_TYPES, ' ', 2)}`);
   }
-  return data;
 };
 
-helpers.getCPUInfo = async function getCPUInfo (packageName, dataReadTimeout = 2) {
+helpers.getCPUInfo = async function getCPUInfo (packageName, retries = 2) {
   // TODO: figure out why this is
   // sometimes, the function of 'adb.shell' fails. when I tested this function on the target of 'Galaxy Note5',
   // adb.shell(dumpsys cpuinfo) returns cpu datas for other application packages, but I can't find the data for packageName.
   // It usually fails 30 times and success for the next time,
   // Since then, he has continued to succeed.
-  return await retryInterval(dataReadTimeout, RETRY_PAUSE, async () => {
+  return await retryInterval(retries, RETRY_PAUSE_MS, async () => {
     let output;
     try {
       output = await this.adb.shell(['dumpsys', 'cpuinfo']);
@@ -90,8 +167,8 @@ helpers.getCPUInfo = async function getCPUInfo (packageName, dataReadTimeout = 2
   });
 };
 
-helpers.getBatteryInfo = async function getBatteryInfo (dataReadTimeout = 2) {
-  return await retryInterval(dataReadTimeout, RETRY_PAUSE, async () => {
+helpers.getBatteryInfo = async function getBatteryInfo (retries = 2) {
+  return await retryInterval(retries, RETRY_PAUSE_MS, async () => {
     let cmd = ['dumpsys', 'battery', '|', 'grep', 'level'];
     let data = await this.adb.shell(cmd);
     if (!data) throw new Error('No data from dumpsys'); //eslint-disable-line curly
@@ -104,91 +181,44 @@ helpers.getBatteryInfo = async function getBatteryInfo (dataReadTimeout = 2) {
       throw new Error(`Unable to parse battery data: '${data}'`);
     }
   });
-
 };
 
-helpers.getMemoryInfo = async function getMemoryInfo (packageName, dataReadTimeout = 2) {
-  return await retryInterval(dataReadTimeout, RETRY_PAUSE, async () => {
-    let cmd = ['dumpsys', 'meminfo', `'${packageName}'`, '|', 'grep', '-E', "'Native|Dalvik|EGL|GL|TOTAL'"];
-    let data = await this.adb.shell(cmd);
-    if (!data) throw new Error('No data from dumpsys'); //eslint-disable-line curly
-
-    let totalPrivateDirty, totalPss,
-        nativePrivateDirty, nativePss, nativeHeapSize, nativeHeapAllocatedSize,
-        dalvikPrivateDirty, dalvikPss,
-        eglPrivateDirty, eglPss,
-        glPrivateDirty, glPss;
-    let apilevel = await this.adb.getApiLevel();
-    for (let line of data.split('\n')) {
-      let entries = line.trim().split(' ').filter(Boolean);
-      // entries will have the values
-      //   ['<System Type>', '<Memory Type>', <pss total>, <private dirty>, <private clean>, <swapPss dirty>, <heap size>, <heap alloc>, <heap free>]
-      // except 'TOTAL', which skips the second type name
-      //
-      // and on API level 18 and below
-      //   ['<System Type', '<pps>', '<shared dirty>', '<private dirty>', '<heap size>', '<heap alloc>', '<heap free>']
-
-      if (apilevel > 18) {
-        let type = entries[0];
-        let subType = entries[1];
-        if (type === 'Native' && subType === 'Heap') {
-          // native heap
-          nativePss = entries[2];
-          nativePrivateDirty = entries[3];
-          nativeHeapSize = entries[6];
-          nativeHeapAllocatedSize = entries[7];
-        } else if (type === 'Dalvik' && subType === 'Heap') {
-          // dalvik heap
-          dalvikPss = entries[2];
-          dalvikPrivateDirty = entries[3];
-        } else if (type === 'EGL' && subType === 'mtrack') {
-          // egl
-          eglPss = entries[2];
-          eglPrivateDirty = entries[3];
-        } else if (type === 'GL' && subType === 'mtrack') {
-          // gl
-          glPss = entries[2];
-          glPrivateDirty = entries[3];
-        } else if (type === 'TOTAL' && entries.length === 8) {
-          // there are two totals, and we only want the full listing, which has 8 entries
-          totalPss = entries[1];
-          totalPrivateDirty = entries[2];
-        }
+helpers.getMemoryInfo = async function getMemoryInfo (packageName, retries = 2) {
+  return await retryInterval(retries, RETRY_PAUSE_MS, async () => {
+    const cmd = [
+      'dumpsys', 'meminfo', `'${packageName}'`,
+      '|', 'grep', '-E',
+      `'${MEMINFO_TITLES.NATIVE}|${MEMINFO_TITLES.DALVIK}|${MEMINFO_TITLES.EGL}` +
+      `|${MEMINFO_TITLES.GL}|${MEMINFO_TITLES.TOTAL}'`
+    ];
+    const data = await this.adb.shell(cmd);
+    if (!data) {
+      throw new Error('No data from dumpsys');
+    }
+    const valDict = {totalPrivateDirty: ''};
+    const apiLevel = await this.adb.getApiLevel();
+    for (const line of data.split('\n')) {
+      const entries = line.trim().split(/\s+/).filter(Boolean);
+      if (apiLevel >= 30) {
+        parseMeminfoForApiAbove29(entries, valDict);
+      } else if (apiLevel > 18 && apiLevel < 30) {
+        parseMeminfoForApi19To29(entries, valDict);
       } else {
-        let type = entries[0];
-        if (type === 'Native') {
-          nativePss = entries[1];
-          nativePrivateDirty = entries[3];
-          nativeHeapSize = entries[4];
-          nativeHeapAllocatedSize = entries[5];
-        } else if (type === 'Dalvik') {
-          dalvikPss = entries[1];
-          dalvikPrivateDirty = entries[3];
-        } else if (type === 'EGL') {
-          eglPss = entries[1];
-          eglPrivateDirty = entries[3];
-        } else if (type === 'GL') {
-          glPss = entries[1];
-          glPrivateDirty = entries[3];
-        } else if (type === 'TOTAL') {
-          totalPss = entries[1];
-          totalPrivateDirty = entries[3];
-        }
+        parseMeminfoForApiBelow19(entries, valDict);
       }
     }
-
-    if (totalPrivateDirty && totalPrivateDirty !== 'nodex') {
-      let headers = _.clone(MEMORY_KEYS);
-      let data = [totalPrivateDirty, nativePrivateDirty, dalvikPrivateDirty, eglPrivateDirty, glPrivateDirty, totalPss, nativePss, dalvikPss, eglPss, glPss, nativeHeapAllocatedSize, nativeHeapSize];
-      return [headers, data];
-    } else {
-      throw new Error(`Unable to parse memory data: '${data}'`);
+    if (valDict.totalPrivateDirty && valDict.totalPrivateDirty !== 'nodex') {
+      const headers = _.clone(MEMORY_KEYS);
+      const values = headers.map((header) => valDict[header]);
+      return [headers, values];
     }
+
+    throw new Error(`Unable to parse memory data: '${data}'`);
   });
 };
 
-helpers.getNetworkTrafficInfo = async function getNetworkTrafficInfo (dataReadTimeout = 2) {
-  return await retryInterval(dataReadTimeout, RETRY_PAUSE, async () => {
+helpers.getNetworkTrafficInfo = async function getNetworkTrafficInfo (retries = 2) {
+  return await retryInterval(retries, RETRY_PAUSE_MS, async () => {
     let returnValue = [];
     let bucketDuration, bucketStart, activeTime, rxBytes, rxPackets, txBytes, txPackets, operations;
 
@@ -346,3 +376,4 @@ export {
   BATTERY_KEYS, NETWORK_KEYS,
 };
 export default extensions;
+

package/package.json

@@ -9,7 +9,7 @@
     "mobile",
     "mobile testing"
   ],
-  "version": "4.51.0",
+  "version": "4.54.0",
   "author": "appium",
   "license": "Apache-2.0",
   "repository": {
@@ -36,24 +36,24 @@
   ],
   "dependencies": {
     "@babel/runtime": "^7.0.0",
-    "appium-adb": "^8.16.0",
+    "appium-adb": "^8.18.0",
     "appium-base-driver": "^7.0.0",
     "appium-chromedriver": "^4.13.0",
     "appium-support": "^2.47.1",
     "asyncbox": "^2.8.0",
     "axios": "^0.x",
     "bluebird": "^3.4.7",
-    "io.appium.settings": "^3.3.0",
-    "jimp": "^0.16.1",
+    "io.appium.settings": "^3.6.0",
+    "jimp": "^0.x",
     "lodash": "^4.17.4",
     "lru-cache": "^6.0.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,6 +77,7 @@
     "precommit-test"
   ],
   "devDependencies": {
+    "@xmldom/xmldom": "^0.x",
     "android-apidemos": "^3.0.0",
     "appium-gulp-plugins": "^5.4.0",
     "appium-test-support": "^1.0.0",
@@ -87,8 +88,7 @@
     "mocha": "^9.0.0",
     "mock-fs": "^5.0.0",
     "pre-commit": "^1.1.3",
-    "sinon": "^11.0.0",
-    "xmldom": "^0.x",
+    "sinon": "^12.0.0",
     "xpath": "^0.x"
   }
 }