appium-uiautomator2-driver 2.30.0 → 2.31.1

package/lib/driver.ts

@@ -27,7 +27,6 @@ import uiautomator2Helpers from './helpers';
 import {newMethodMap} from './method-map';
 import type {
   Uiautomator2Settings,
-  Uiautomator2CreateResult,
   Uiautomator2DeviceDetails,
   Uiautomator2DeviceInfo,
   Uiautomator2DriverCaps,
@@ -163,14 +162,12 @@ const CHROME_NO_PROXY: RouteMatcher[] = [
 const MEMOIZED_FUNCTIONS = ['getStatusBarHeight', 'getDevicePixelRatio'] as const;
 
 class AndroidUiautomator2Driver
-  extends AndroidDriver<Uiautomator2Settings, Uiautomator2CreateResult>
+  extends AndroidDriver
   implements
     ExternalDriver<
       Uiautomator2Constraints,
       string,
-      StringRecord,
-      Uiautomator2Settings,
-      Uiautomator2CreateResult
+      StringRecord
     >
 {
   static newMethodMap = newMethodMap;
@@ -236,12 +233,12 @@ class AndroidUiautomator2Driver
     );
   }
 
-  override async createSession(
+  async createSession(
     w3cCaps1: W3CUiautomator2DriverCaps,
     w3cCaps2?: W3CUiautomator2DriverCaps,
     w3cCaps3?: W3CUiautomator2DriverCaps,
     driverData?: DriverData[]
-  ): Promise<Uiautomator2CreateResult> {
+  ): Promise<any> {
     try {
       // TODO handle otherSessionData for multiple sessions
       const [sessionId, caps] = (await BaseDriver.prototype.createSession.call(
@@ -340,11 +337,7 @@ class AndroidUiautomator2Driver
     return {...sessionData, ...uia2Data};
   }
 
-  override isEmulator() {
-    return helpers.isEmulator(this.adb, this.opts);
-  }
-
-  override setAvdFromCapabilities(caps: Uiautomator2StartSessionOpts) {
+  setAvdFromCapabilities(caps: Uiautomator2StartSessionOpts) {
     if (this.opts.avd) {
       this.log.info('avd name defined, ignoring device name and platform version');
     } else {
@@ -458,7 +451,18 @@ class AndroidUiautomator2Driver
     if (apiLevel >= 28) {
       // Android P
       this.log.info('Relaxing hidden api policy');
-      await this.adb.setHiddenApiPolicy('1', !!this.opts.ignoreHiddenApiPolicyError);
+      try {
+        await this.adb.setHiddenApiPolicy('1', !!this.opts.ignoreHiddenApiPolicyError);
+      } catch (err) {
+        this.log.errorAndThrow(
+          'Hidden API policy (https://developer.android.com/guide/app-compatibility/restrictions-non-sdk-interfaces) cannot be enabled. ' +
+            'This might be happening because the device under test is not configured properly. ' +
+            'Please check https://github.com/appium/appium/issues/13802 for more details. ' +
+            'You could also set the "appium:ignoreHiddenApiPolicyError" capability to true in order to ' +
+            'ignore this error, which might later lead to unexpected crashes or behavior of ' +
+            `the automation server. Original error: ${err.message}`
+        );
+      }
     }
 
     // check if we have to enable/disable gps before running the application
@@ -737,7 +741,7 @@ class AndroidUiautomator2Driver
     });
   }
 
-  override async deleteSession() {
+  async deleteSession() {
     this.log.debug('Deleting UiAutomator2 session');
 
     const screenRecordingStopTasks = [
@@ -871,7 +875,7 @@ class AndroidUiautomator2Driver
     await BaseDriver.prototype.deleteSession.call(this);
   }
 
-  override async checkAppPresent() {
+  async checkAppPresent() {
     this.log.debug('Checking whether app is actually present');
     if (!(await fs.exists(this.opts.app))) {
       this.log.errorAndThrow(`Could not find app apk at '${this.opts.app}'`);
@@ -879,36 +883,24 @@ class AndroidUiautomator2Driver
     }
   }
 
-  override async onSettingsUpdate() {
+  async onSettingsUpdate() {
     // intentionally do nothing here, since commands.updateSettings proxies
     // settings to the uiauto2 server already
   }
 
-  // Need to override android-driver's version of this since we don't actually
-  // have a bootstrap; instead we just restart adb and re-forward the UiAutomator2
-  // port
-  override async wrapBootstrapDisconnect(wrapped: () => Promise<void>) {
-    await wrapped();
-    this.adb!.restart();
-    await this.allocateSystemPort();
-    await this.allocateMjpegServerPort();
-  }
-
-  override proxyActive(sessionId: string) {
-    BaseDriver.prototype.proxyActive.call(this, sessionId);
-
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  proxyActive(sessionId: string) {
     // we always have an active proxy to the UiAutomator2 server
     return true;
   }
 
-  override canProxy(sessionId: string) {
-    BaseDriver.prototype.canProxy.call(this, sessionId);
-
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  canProxy(sessionId: string) {
     // we can always proxy to the uiautomator2 server
     return true;
   }
 
-  override getProxyAvoidList() {
+  getProxyAvoidList() {
     // we are maintaining two sets of NO_PROXY lists, one for chromedriver(CHROME_NO_PROXY)
     // and one for uiautomator2(NO_PROXY), based on current context will return related NO_PROXY list
     if (util.hasValue(this.chromedriver)) {
@@ -927,10 +919,6 @@ class AndroidUiautomator2Driver
     return this.jwpProxyAvoid;
   }
 
-  get isChromeSession() {
-    return helpers.isChromeBrowser(this.opts.browserName);
-  }
-
   async updateSettings(settings: Uiautomator2Settings) {
     await this.settings.update(settings);
     await this.uiautomator2!.jwproxy.command('/appium/settings', 'POST', {settings});
@@ -942,7 +930,7 @@ class AndroidUiautomator2Driver
       '/appium/settings',
       'GET'
     )) as Partial<Uiautomator2Settings>;
-    return {...driverSettings, ...serverSettings};
+    return {...driverSettings, ...serverSettings} as any;
   }
 }
 

package/lib/types.ts

@@ -1,5 +1,4 @@
 import type {DriverCaps, DriverOpts, W3CDriverCaps} from '@appium/types';
-import type {AndroidSettings} from 'appium-android-driver';
 import type {EmptyObject} from 'type-fest';
 import type {RelativeRect} from './commands/types';
 import type {Uiautomator2Constraints} from './constraints';
@@ -52,8 +51,7 @@ export interface Uiautomator2SessionCaps
     Uiautomator2DeviceInfo,
     Uiautomator2DeviceDetails {}
 
-export type Uiautomator2CreateResult = [string, Uiautomator2SessionCaps];
-
-export interface Uiautomator2Settings extends AndroidSettings {
+export interface Uiautomator2Settings {
+  ignoreUnimportantViews: boolean;
   allowInvisibleElements: boolean;
 }

package/npm-shrinkwrap.json

@@ -1,16 +1,16 @@
 {
   "name": "appium-uiautomator2-driver",
-  "version": "2.30.0",
+  "version": "2.31.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-uiautomator2-driver",
-      "version": "2.30.0",
+      "version": "2.31.1",
       "license": "Apache-2.0",
       "dependencies": {
         "appium-adb": "^9.14.12",
-        "appium-android-driver": "^6.0.0",
+        "appium-android-driver": "^7.0.1",
         "appium-chromedriver": "^5.6.5",
         "appium-uiautomator2-server": "^5.12.2",
         "asyncbox": "^2.3.1",
@@ -70,7 +70,7 @@
         "rimraf": "^5.0.0",
         "semantic-release": "^21.1.0",
         "sharp": "^0.x",
-        "sinon": "^15.0.0",
+        "sinon": "^16.1.0",
         "sinon-chai": "^3.7.0",
         "ts-node": "^10.9.1",
         "typescript": "~5.0",
@@ -829,7 +829,7 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "20.8.5",
+      "version": "20.8.6",
       "license": "MIT",
       "dependencies": {
         "undici-types": "~5.25.1"
@@ -1044,7 +1044,7 @@
       }
     },
     "node_modules/appium-android-driver": {
-      "version": "6.0.1",
+      "version": "7.0.2",
       "license": "Apache-2.0",
       "dependencies": {
         "appium-adb": "^9.12.0",
@@ -1054,16 +1054,15 @@
         "bluebird": "^3.4.7",
         "io.appium.settings": "^5.0.0",
         "lodash": "^4.17.4",
-        "lru-cache": "^7.3.0",
+        "lru-cache": "^10.0.1",
         "moment": "^2.24.0",
         "moment-timezone": "^0.5.26",
         "portfinder": "^1.0.6",
         "portscanner": "2.2.0",
         "semver": "^7.0.0",
-        "shared-preferences-builder": "^0.x",
         "source-map-support": "^0.x",
         "teen_process": "^2.0.0",
-        "type-fest": "^3.11.1",
+        "type-fest": "^4.4.0",
         "ws": "^8.0.0"
       },
       "engines": {
@@ -1074,6 +1073,23 @@
         "appium": "^2.0.0-beta.40"
       }
     },
+    "node_modules/appium-android-driver/node_modules/lru-cache": {
+      "version": "10.0.1",
+      "license": "ISC",
+      "engines": {
+        "node": "14 || >=16.14"
+      }
+    },
+    "node_modules/appium-android-driver/node_modules/type-fest": {
+      "version": "4.4.0",
+      "license": "(MIT OR CC0-1.0)",
+      "engines": {
+        "node": ">=16"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
     "node_modules/appium-chromedriver": {
       "version": "5.6.13",
       "hasInstallScript": true,
@@ -2757,24 +2773,19 @@
       }
     },
     "node_modules/logform": {
-      "version": "2.5.1",
+      "version": "2.6.0",
       "extraneous": true,
       "license": "MIT",
       "dependencies": {
-        "@colors/colors": "1.5.0",
+        "@colors/colors": "1.6.0",
         "@types/triple-beam": "^1.3.2",
         "fecha": "^4.2.0",
         "ms": "^2.1.1",
         "safe-stable-stringify": "^2.3.1",
         "triple-beam": "^1.3.0"
-      }
-    },
-    "node_modules/logform/node_modules/@colors/colors": {
-      "version": "1.5.0",
-      "extraneous": true,
-      "license": "MIT",
+      },
       "engines": {
-        "node": ">=0.1.90"
+        "node": ">= 12.0.0"
       }
     },
     "node_modules/lru-cache": {
@@ -3780,21 +3791,6 @@
       "version": "1.2.0",
       "license": "ISC"
     },
-    "node_modules/shared-preferences-builder": {
-      "version": "0.0.4",
-      "license": "MIT",
-      "dependencies": {
-        "lodash": "^4.17.4",
-        "xmlbuilder": "^9.0.1"
-      }
-    },
-    "node_modules/shared-preferences-builder/node_modules/xmlbuilder": {
-      "version": "9.0.7",
-      "license": "MIT",
-      "engines": {
-        "node": ">=4.0"
-      }
-    },
     "node_modules/shebang-command": {
       "version": "2.0.0",
       "license": "MIT",
@@ -4461,7 +4457,7 @@
       }
     },
     "node_modules/winston-transport": {
-      "version": "4.5.0",
+      "version": "4.6.0",
       "extraneous": true,
       "license": "MIT",
       "dependencies": {
@@ -4470,7 +4466,7 @@
         "triple-beam": "^1.3.0"
       },
       "engines": {
-        "node": ">= 6.4.0"
+        "node": ">= 12.0.0"
       }
     },
     "node_modules/winston/node_modules/@colors/colors": {

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "2.30.0",
+  "version": "2.31.1",
   "bugs": {
     "url": "https://github.com/appium/appium-uiautomator2-driver/issues"
   },
@@ -63,7 +63,7 @@
   },
   "dependencies": {
     "appium-adb": "^9.14.12",
-    "appium-android-driver": "^6.0.0",
+    "appium-android-driver": "^7.0.1",
     "appium-chromedriver": "^5.6.5",
     "appium-uiautomator2-server": "^5.12.2",
     "asyncbox": "^2.3.1",
@@ -123,7 +123,7 @@
     "rimraf": "^5.0.0",
     "semantic-release": "^21.1.0",
     "sharp": "^0.x",
-    "sinon": "^15.0.0",
+    "sinon": "^16.1.0",
     "sinon-chai": "^3.7.0",
     "ts-node": "^10.9.1",
     "typescript": "~5.0",