appium-uiautomator2-driver 3.6.1 → 3.7.1

package/lib/commands/clipboard.js

@@ -0,0 +1,55 @@
+/**
+ * @this {AndroidUiautomator2Driver}
+ * @returns {Promise<string>} Base64-encoded content of the clipboard
+ * or an empty string if the clipboard is empty.
+ */
+export async function getClipboard() {
+  return String(
+    (await this.adb.getApiLevel()) < 29
+      ? await this.uiautomator2.jwproxy.command(
+          '/appium/device/get_clipboard',
+          'POST',
+          {}
+        )
+      : await this.settingsApp.getClipboard()
+  );
+}
+
+/**
+ * @this {AndroidUiautomator2Driver}
+ * @returns {Promise<string>} Base64-encoded content of the clipboard
+ * or an empty string if the clipboard is empty.
+ */
+export async function mobileGetClipboard() {
+  return await this.getClipboard();
+}
+
+/**
+ * @this {AndroidUiautomator2Driver}
+ * @param {string} content Base64-encoded clipboard payload
+ * @param {'plaintext'} [contentType='plaintext'] Only a single
+ * content type is supported, which is 'plaintext'
+ * @param {string} [label] Optinal label to identify the current
+ * clipboard payload
+ * @returns {Promise<void>}
+ */
+export async function setClipboard(content, contentType, label) {
+  await this.uiautomator2.jwproxy.command(
+    '/appium/device/set_clipboard',
+    'POST',
+    {content, contentType, label}
+  );
+}
+
+/**
+ * @this {AndroidUiautomator2Driver}
+ * @param {import('./types').SetClipboardOpts} opts
+ * @returns {Promise<void>}
+ */
+export async function mobileSetClipboard(opts) {
+  await this.setClipboard(opts.content, opts.contentType, opts.label);
+}
+
+/**
+ * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
+ */

package/lib/commands/execute.js

@@ -49,6 +49,9 @@ export function mobileCommandsMapping() {
     scheduleAction: 'mobileScheduleAction',
     getActionHistory: 'mobileGetActionHistory',
     unscheduleAction: 'mobileUnscheduleAction',
+
+    setClipboard: 'mobileSetClipboard',
+    getClipboard: 'mobileGetClipboard',
   };
 }
 

package/lib/commands/misc.js

@@ -40,22 +40,6 @@ export async function setOrientation(orientation) {
   );
 }
 
-/**
- * @this {AndroidUiautomator2Driver}
- * @returns {Promise<string>}
- */
-export async function getClipboard() {
-  return String(
-    (await this.adb.getApiLevel()) < 29
-      ? await this.uiautomator2.jwproxy.command(
-          '/appium/device/get_clipboard',
-          'POST',
-          {}
-        )
-      : await this.settingsApp.getClipboard()
-  );
-}
-
 /**
  * @this {AndroidUiautomator2Driver}
  * @returns {Promise<void>}

package/lib/commands/types.ts

@@ -471,3 +471,18 @@ export interface ActionResult {
 export interface ActionArgs {
   name: string;
 }
+
+export interface SetClipboardOpts {
+  /**
+   * Base64-encoded clipboard payload
+   */
+  content: string;
+  /**
+   * Only a single content type is supported, which is 'plaintext'
+   */
+  contentType?: 'plaintext';
+  /**
+   * Optinal label to identify the current clipboard payload
+   */
+  label?: string;
+}

package/lib/driver.ts

@@ -61,6 +61,12 @@ import {
 import {
   mobileGetBatteryInfo,
 } from './commands/battery';
+import {
+  getClipboard,
+  mobileGetClipboard,
+  setClipboard,
+  mobileSetClipboard,
+} from './commands/clipboard';
 import {
   active,
   getAttribute,
@@ -111,7 +117,6 @@ import {
   getPageSource,
   getOrientation,
   setOrientation,
-  getClipboard,
   openNotifications,
   suspendChromedriverProxy,
   mobileGetDeviceInfo,
@@ -1054,11 +1059,15 @@ class AndroidUiautomator2Driver
   getPageSource = getPageSource;
   getOrientation = getOrientation;
   setOrientation = setOrientation;
-  getClipboard = getClipboard;
   openNotifications = openNotifications;
   suspendChromedriverProxy = suspendChromedriverProxy as any;
   mobileGetDeviceInfo = mobileGetDeviceInfo;
 
+  getClipboard = getClipboard;
+  mobileGetClipboard = mobileGetClipboard;
+  setClipboard = setClipboard;
+  mobileSetClipboard = mobileSetClipboard;
+
   setUrl = setUrl;
   mobileDeepLink = mobileDeepLink;
   back = back;

package/lib/uiautomator2.js

@@ -6,7 +6,7 @@ import {
   TEST_APK_PATH as testApkPath,
   version as serverVersion
 } from 'appium-uiautomator2-server';
-import { util, logger, timing } from 'appium/support';
+import { util, timing } from 'appium/support';
 import B from 'bluebird';
 import axios from 'axios';
 
@@ -17,7 +17,6 @@ const SERVICES_LAUNCH_TIMEOUT = 30000;
 const SERVER_PACKAGE_ID = 'io.appium.uiautomator2.server';
 const SERVER_TEST_PACKAGE_ID = `${SERVER_PACKAGE_ID}.test`;
 const INSTRUMENTATION_TARGET = `${SERVER_TEST_PACKAGE_ID}/androidx.test.runner.AndroidJUnitRunner`;
-const instrumentationLogger = logger.getLogger('Instrumentation');
 
 class UIA2Proxy extends JWProxy {
   /** @type {boolean} */
@@ -50,6 +49,9 @@ class UiAutomator2Server {
   /** @type {boolean|undefined} */
   disableSuppressAccessibilityService;
 
+  /** @type {import('teen_process').SubProcess|null} */
+  instrumentationProcess;
+
   constructor (log, opts = {}) {
     for (let req of REQD_PARAMS) {
       if (!opts || !util.hasValue(opts[req])) {
@@ -72,6 +74,7 @@ class UiAutomator2Server {
     this.proxyReqRes = this.jwproxy.proxyReqRes.bind(this.jwproxy);
     this.proxyCommand = this.jwproxy.command.bind(this.jwproxy);
     this.jwproxy.didInstrumentationExit = false;
+    this.instrumentationProcess = null;
   }
 
   /**
@@ -255,6 +258,9 @@ class UiAutomator2Server {
     while (retries < maxRetries) {
       this.log.info(`Waiting up to ${timeout}ms for UiAutomator2 to be online...`);
       this.jwproxy.didInstrumentationExit = false;
+      try {
+        await this.stopInstrumentationProcess();
+      } catch (ign) {}
       await this.startInstrumentationProcess();
       if (!this.jwproxy.didInstrumentationExit) {
         try {
@@ -312,18 +318,30 @@ class UiAutomator2Server {
     // Disable Google analytics to prevent possible fatal exception
     cmd.push('-e', 'disableAnalytics', 'true');
     cmd.push(INSTRUMENTATION_TARGET);
-    const instrumentationProcess = this.adb.createSubProcess(['shell', ...cmd]);
-    instrumentationProcess.on('output', (stdout, stderr) => {
-      const output = _.trim(stdout || stderr);
-      if (output) {
-        instrumentationLogger.debug(output);
-      }
-    });
-    instrumentationProcess.on('exit', (code) => {
-      instrumentationLogger.debug(`The process has exited with code ${code}`);
+    this.instrumentationProcess = this.adb.createSubProcess(['shell', ...cmd]);
+    for (const streamName of ['stderr', 'stdout']) {
+      this.instrumentationProcess.on(`line-${streamName}`, (line) => this.log.debug(`[Instrumentation] ${line}`));
+    }
+    this.instrumentationProcess.once('exit', (code, signal) => {
+      this.log.debug(`[Instrumentation] The process has exited with code ${code}, signal ${signal}`);
       this.jwproxy.didInstrumentationExit = true;
     });
-    await instrumentationProcess.start(0);
+    await this.instrumentationProcess.start(0);
+  }
+
+  async stopInstrumentationProcess () {
+    if (!this.instrumentationProcess) {
+      return;
+    }
+
+    try {
+      if (this.instrumentationProcess.isRunning) {
+        await this.instrumentationProcess.stop();
+      }
+    } finally {
+      this.instrumentationProcess.removeAllListeners();
+      this.instrumentationProcess = null;
+    }
   }
 
   async deleteSession () {
@@ -336,6 +354,11 @@ class UiAutomator2Server {
       this.log.warn(`Did not get confirmation UiAutomator2 deleteSession worked; ` +
           `Error was: ${err}`);
     }
+    try {
+      await this.stopInstrumentationProcess();
+    } catch (err) {
+      this.log.warn(`Could not stop the instrumentation process. Original error: ${err.message}`);
+    }
   }
 
   async cleanupAutomationLeftovers (strictCleanup = false) {