appium-android-driver 5.13.1 → 5.13.2

package/build/lib/commands/performance.d.ts

@@ -0,0 +1,101 @@
+export default commands;
+export type PerformanceDataOptions = {
+    /**
+     * The name of the package identifier to fetch the data for
+     */
+    packageName: string;
+    /**
+     * One of supported subsystem
+     * to fetch the data for.
+     */
+    dataType: 'batteryinfo' | 'cpuinfo' | 'memoryinfo' | 'networkinfo';
+};
+export namespace commands {
+    function getPerformanceDataTypes(): string[];
+    /**
+     * @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]]
+     */
+    function getPerformanceData(packageName: any, dataType: any, retries?: number): Promise<any>;
+    /**
+     * @typedef {Object} PerformanceDataOptions
+     * @property {string} packageName The name of the package identifier to fetch the data for
+     * @property {'batteryinfo' | 'cpuinfo' | 'memoryinfo' | 'networkinfo'} dataType One of supported subsystem
+     * to fetch the data for.
+     */
+    /**
+     * Retrieves performance data about the given Android subsystem.
+     * The data is parsed from the output of the dumpsys utility.
+     *
+     * @param {PerformanceDataOptions} opts
+     * @returns {Promise<any[][]>} The output depends on the selected subsystem.
+     * It is orginized into a table, where the first row represent column names
+     * and the following rows represent the sampled data for each column.
+     * Example output for different data types:
+     * - batteryinfo: [[power], [23]]
+     * - 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]]
+     * - networkinfo: [[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]]
+     *
+     *   [[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]]
+     * - cpuinfo: [[user, kernel], [0.9, 1.3]]
+     */
+    function mobileGetPerformanceData(opts?: PerformanceDataOptions): Promise<any[][]>;
+}
+export const SUPPORTED_PERFORMANCE_DATA_TYPES: Readonly<{
+    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";
+}>;
+export const CPU_KEYS: string[];
+export const MEMORY_KEYS: string[];
+export const BATTERY_KEYS: string[];
+export const NETWORK_KEYS: string[][];
+export function getMemoryInfo(packageName: any, retries?: number): Promise<any[][] | null>;
+/**
+ * @this {AndroidDriver}
+ * @param {number} retries
+ */
+export function getNetworkTrafficInfo(this: AndroidDriver, retries?: number): Promise<any[][] | null>;
+/**
+ * Return the CPU information related to the given packageName.
+ * It raises an exception if the dumped CPU information did not include the given packageName
+ * or the format was wrong.
+ * The CPU information's sampling interval depends on the device under test.
+ * For example, some devices have 5 minutes interval. When you get the information
+ * from 2023-02-07 11:59:40.468 to 2023-02-07 12:04:40.556, then the next will be
+ * from 2023-02-07 12:04:40.556 to 2023-02-07 12:09:40.668. No process information
+ * exists in the result if the process was not running during the period.
+ *
+ * @this {AndroidDriver}
+ * @param {string} packageName The package name to get the CPU information.
+ * @param {number} retries The number of retry count.
+ * @returns {Array} The array of the parsed CPU upsage percentages.
+ *                  e.g. ['cpuinfo', ['14.3', '28.2']]
+ *                  '14.3' is usage by the user (%), '28.2' is usage by the kernel (%)
+ * @throw {Error} If it failed to parse the result of dumpsys, or no package name exists.
+ */
+export function getCPUInfo(this: AndroidDriver, packageName: string, retries?: number): any[];
+/**
+ * @this {AndroidDriver}
+ * @param {number} retries
+ */
+export function getBatteryInfo(this: AndroidDriver, retries?: number): Promise<string[][] | null>;
+//# sourceMappingURL=performance.d.ts.map

package/build/lib/commands/performance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"performance.d.ts","sourceRoot":"","sources":["../../../lib/commands/performance.js"],"names":[],"mappings":";;;;;iBAgZc,MAAM;;;;;cACN,aAAa,GAAG,SAAS,GAAG,YAAY,GAAG,aAAa;;;IAxCtE,6CAEC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,6FAcC;IAED;;;;;OAKG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mFAGC;;AAzZD;;;;;GAKG;AAdH,gCAAoC;AAEpC,mCAME;AAPF,oCAA+B;AAL/B,sCAGE;AAyFF,2FAgCC;AAED;;;GAGG;AACH,qEAFW,MAAM,2BAyJhB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,6DAPW,MAAM,YACN,MAAM,SAiChB;AAED;;;GAGG;AACH,8DAFW,MAAM,8BAgBhB"}