appium-uiautomator2-driver 2.29.11 → 2.30.0

package/lib/{driver.js → driver.ts}

@@ -1,24 +1,45 @@
-import _ from 'lodash';
-import { BaseDriver, DeviceSettings } from 'appium/driver';
-import {
-  UiAutomator2Server, SERVER_PACKAGE_ID, SERVER_TEST_PACKAGE_ID
-} from './uiautomator2';
-import { newMethodMap } from './method-map';
-import { fs, util, mjpeg } from 'appium/support';
-import { retryInterval } from 'asyncbox';
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+import type {
+  DefaultCreateSessionResult,
+  DriverData,
+  ExternalDriver,
+  InitialOpts,
+  Orientation,
+  RouteMatcher,
+  SingularSessionData,
+  StringRecord,
+} from '@appium/types';
+import {DEFAULT_ADB_PORT} from 'appium-adb';
+import AndroidDriver, {SETTINGS_HELPER_PKG_ID, androidHelpers} from 'appium-android-driver';
+import {BaseDriver, DeviceSettings} from 'appium/driver';
+import {fs, mjpeg, util} from 'appium/support';
+import {retryInterval} from 'asyncbox';
 import B from 'bluebird';
-import commands from './commands/index';
-import { DEFAULT_ADB_PORT } from 'appium-adb';
+import _ from 'lodash';
+import os from 'node:os';
+import path from 'node:path';
+import {checkPortStatus, findAPortNotInUse} from 'portscanner';
+import type {ExecError} from 'teen_process';
+import UIAUTOMATOR2_CONSTRAINTS, {type Uiautomator2Constraints} from './constraints';
+import {executeMethodMap} from './execute-method-map';
+import {APKS_EXTENSION, APK_EXTENSION} from './extensions';
 import uiautomator2Helpers from './helpers';
-import { androidHelpers, androidCommands, SETTINGS_HELPER_PKG_ID, } from 'appium-android-driver';
-import desiredCapConstraints from './desired-caps';
-import { findAPortNotInUse, checkPortStatus } from 'portscanner';
-import os from 'os';
-import path from 'path';
-import { APK_EXTENSION, APKS_EXTENSION } from './extensions';
-
-
-const helpers = Object.assign({}, uiautomator2Helpers, androidHelpers);
+import {newMethodMap} from './method-map';
+import type {
+  Uiautomator2Settings,
+  Uiautomator2CreateResult,
+  Uiautomator2DeviceDetails,
+  Uiautomator2DeviceInfo,
+  Uiautomator2DriverCaps,
+  Uiautomator2DriverOpts,
+  Uiautomator2SessionCaps,
+  Uiautomator2SessionInfo,
+  Uiautomator2StartSessionOpts,
+  W3CUiautomator2DriverCaps,
+} from './types';
+import {SERVER_PACKAGE_ID, SERVER_TEST_PACKAGE_ID, UiAutomator2Server} from './uiautomator2';
+
+const helpers = {...uiautomator2Helpers, ...androidHelpers};
 
 // The range of ports we can use on the system for communicating to the
 // UiAutomator2 HTTP server on the device
@@ -45,7 +66,7 @@ const LOCALHOST_IP4 = '127.0.0.1';
 // TODO:  Add the list of paths that we never want to proxy to UiAutomator2 server.
 // TODO: Need to segregate the paths better way using regular expressions wherever applicable.
 // (Not segregating right away because more paths to be added in the NO_PROXY list)
-const NO_PROXY = [
+const NO_PROXY: RouteMatcher[] = [
   ['DELETE', new RegExp('^/session/[^/]+/actions')],
   ['GET', new RegExp('^/session/(?!.*/)')],
   ['GET', new RegExp('^/session/[^/]+/alert_[^/]+')],
@@ -114,7 +135,7 @@ const NO_PROXY = [
 ];
 
 // This is a set of methods and paths that we never want to proxy to Chromedriver.
-const CHROME_NO_PROXY = [
+const CHROME_NO_PROXY: RouteMatcher[] = [
   ['GET', new RegExp('^/session/[^/]+/appium')],
   ['GET', new RegExp('^/session/[^/]+/context')],
   ['GET', new RegExp('^/session/[^/]+/element/[^/]+/rect')],
@@ -139,56 +160,100 @@ const CHROME_NO_PROXY = [
   ['POST', new RegExp('^/session/[^/]+/se/log$')],
 ];
 
-const MEMOIZED_FUNCTIONS = [
-  'getStatusBarHeight',
-  'getDevicePixelRatio',
-];
+const MEMOIZED_FUNCTIONS = ['getStatusBarHeight', 'getDevicePixelRatio'] as const;
+
+class AndroidUiautomator2Driver
+  extends AndroidDriver<Uiautomator2Settings, Uiautomator2CreateResult>
+  implements
+    ExternalDriver<
+      Uiautomator2Constraints,
+      string,
+      StringRecord,
+      Uiautomator2Settings,
+      Uiautomator2CreateResult
+    >
+{
+  static newMethodMap = newMethodMap;
 
-class AndroidUiautomator2Driver extends BaseDriver {
+  static executeMethodMap = executeMethodMap;
 
-  static newMethodMap = newMethodMap;
+  uiautomator2?: UiAutomator2Server;
+
+  /**
+   * @privateRemarks moved from `this.opts`
+   */
+  systemPort: number | undefined;
 
-  constructor (opts = {}, shouldValidateCaps = true) {
+  _hasSystemPortInCaps: boolean | undefined;
+
+  mjpegStream?: mjpeg.MJpegStream;
+
+  override caps: Uiautomator2DriverCaps;
+
+  override opts: Uiautomator2DriverOpts;
+
+  override desiredCapConstraints: Uiautomator2Constraints;
+
+  constructor(opts: InitialOpts = {} as InitialOpts, shouldValidateCaps = true) {
     // `shell` overwrites adb.shell, so remove
+    // @ts-expect-error FIXME: what is this?
     delete opts.shell;
 
     super(opts, shouldValidateCaps);
+
     this.locatorStrategies = [
       'xpath',
       'id',
       'class name',
       'accessibility id',
       'css selector',
-      '-android uiautomator'
+      '-android uiautomator',
     ];
-    this.desiredCapConstraints = desiredCapConstraints;
-    this.uiautomator2 = null;
+    this.desiredCapConstraints = _.cloneDeep(UIAUTOMATOR2_CONSTRAINTS);
     this.jwpProxyActive = false;
     this.jwpProxyAvoid = NO_PROXY;
     this.apkStrings = {}; // map of language -> strings obj
 
-    this.settings = new DeviceSettings({ignoreUnimportantViews: false, allowInvisibleElements: false},
-        this.onSettingsUpdate.bind(this));
+    this.settings = new DeviceSettings(
+      {ignoreUnimportantViews: false, allowInvisibleElements: false},
+      this.onSettingsUpdate.bind(this)
+    );
     // handle webview mechanics from AndroidDriver
-    this.chromedriver = null;
     this.sessionChromedrivers = {};
 
+    this.caps = {} as Uiautomator2DriverCaps;
+    this.opts = opts as Uiautomator2DriverOpts;
     // memoize functions here, so that they are done on a per-instance basis
     for (const fn of MEMOIZED_FUNCTIONS) {
-      this[fn] = _.memoize(this[fn]);
+      this[fn] = _.memoize(this[fn]) as any;
     }
   }
 
-  validateDesiredCaps (caps) {
-    return super.validateDesiredCaps(caps) && androidHelpers.validateDesiredCaps(caps);
+  override validateDesiredCaps(caps: any): caps is Uiautomator2DriverCaps {
+    return (
+      BaseDriver.prototype.validateDesiredCaps.call(this, caps) &&
+      androidHelpers.validateDesiredCaps(caps)
+    );
   }
 
-  async createSession (...args) {
+  override async createSession(
+    w3cCaps1: W3CUiautomator2DriverCaps,
+    w3cCaps2?: W3CUiautomator2DriverCaps,
+    w3cCaps3?: W3CUiautomator2DriverCaps,
+    driverData?: DriverData[]
+  ): Promise<Uiautomator2CreateResult> {
     try {
       // TODO handle otherSessionData for multiple sessions
-      let [sessionId, caps] = await super.createSession(...args);
-
-      let serverDetails = {
+      const [sessionId, caps] = (await BaseDriver.prototype.createSession.call(
+        this,
+        w3cCaps1,
+        w3cCaps2,
+        w3cCaps3,
+        driverData
+      )) as DefaultCreateSessionResult<Uiautomator2Constraints>;
+
+      const startSessionOpts: Uiautomator2StartSessionOpts = {
+        ...caps,
         platform: 'LINUX',
         webStorageEnabled: false,
         takesScreenshot: true,
@@ -197,160 +262,184 @@ class AndroidUiautomator2Driver extends BaseDriver {
         networkConnectionEnabled: true,
         locationContextEnabled: false,
         warnings: {},
-        desired: this.caps,
+        desired: caps,
       };
 
-      this.caps = Object.assign(serverDetails, this.caps);
-
-      this.curContext = this.defaultContextName();
-
-      let defaultOpts = {
+      const defaultOpts = {
         fullReset: false,
         autoLaunch: true,
         adbPort: DEFAULT_ADB_PORT,
-        androidInstallTimeout: 90000
+        androidInstallTimeout: 90000,
       };
       _.defaults(this.opts, defaultOpts);
 
       if (this.isChromeSession) {
         this.log.info("We're going to run a Chrome-based session");
-        let {pkg, activity} = helpers.getChromePkg(this.opts.browserName);
+        const {pkg, activity} = helpers.getChromePkg(this.opts.browserName!);
         this.opts.appPackage = this.caps.appPackage = pkg;
         this.opts.appActivity = this.caps.appActivity = activity;
         this.log.info(`Chrome-type package and activity are ${pkg} and ${activity}`);
       }
 
+      // @ts-expect-error FIXME: missing CLI option?
       if (this.opts.reboot) {
-        this.setAvdFromCapabilities(caps);
+        this.setAvdFromCapabilities(startSessionOpts);
       }
 
       if (this.opts.app) {
         // find and copy, or download and unzip an app url or path
-        this.opts.app = await this.helpers.configureApp(this.opts.app, [APK_EXTENSION, APKS_EXTENSION]);
+        this.opts.app = await this.helpers.configureApp(this.opts.app, [
+          APK_EXTENSION,
+          APKS_EXTENSION,
+        ]);
         await this.checkAppPresent();
       } else if (this.opts.appPackage) {
         // the app isn't an actual app file but rather something we want to
         // assume is on the device and just launch via the appPackage
         this.log.info(`Starting '${this.opts.appPackage}' directly on the device`);
       } else {
-        this.log.info(`Neither 'app' nor 'appPackage' was set. Starting UiAutomator2 ` +
-          'without the target application');
+        this.log.info(
+          `Neither 'app' nor 'appPackage' was set. Starting UiAutomator2 ` +
+            'without the target application'
+        );
       }
       this.opts.adbPort = this.opts.adbPort || DEFAULT_ADB_PORT;
 
-      await this.startUiAutomator2Session();
-      await this.fillDeviceDetails();
+      const result = await this.startUiAutomator2Session(startSessionOpts);
+
       if (this.opts.mjpegScreenshotUrl) {
         this.log.info(`Starting MJPEG stream reading URL: '${this.opts.mjpegScreenshotUrl}'`);
         this.mjpegStream = new mjpeg.MJpegStream(this.opts.mjpegScreenshotUrl);
         await this.mjpegStream.start();
       }
-      return [sessionId, this.caps];
+      return [sessionId, result];
     } catch (e) {
       await this.deleteSession();
       throw e;
     }
   }
 
-  async fillDeviceDetails () {
-    this.caps.pixelRatio = await this.getDevicePixelRatio();
-    this.caps.statBarHeight = await this.getStatusBarHeight();
-    this.caps.viewportRect = await this.getViewPortRect();
+  async getDeviceDetails(): Promise<Uiautomator2DeviceDetails> {
+    const [pixelRatio, statBarHeight, viewportRect] = await B.all([
+      this.getDevicePixelRatio(),
+      this.getStatusBarHeight(),
+      this.getViewPortRect(),
+    ]);
+    return {pixelRatio, statBarHeight, viewportRect};
   }
 
-  get driverData () {
+  override get driverData() {
     // TODO fill out resource info here
     return {};
   }
 
-  async getSession () {
-    let sessionData = await super.getSession();
+  override async getSession(): Promise<SingularSessionData<Uiautomator2Constraints>> {
+    const sessionData = await BaseDriver.prototype.getSession.call(this);
     this.log.debug('Getting session details from server to mix in');
-    let uia2Data = await this.uiautomator2.jwproxy.command('/', 'GET', {});
-    return Object.assign({}, sessionData, uia2Data);
+    const uia2Data = (await this.uiautomator2!.jwproxy.command('/', 'GET', {})) as any;
+    return {...sessionData, ...uia2Data};
   }
 
-  isEmulator () {
+  override isEmulator() {
     return helpers.isEmulator(this.adb, this.opts);
   }
 
-  setAvdFromCapabilities (caps) {
+  override setAvdFromCapabilities(caps: Uiautomator2StartSessionOpts) {
     if (this.opts.avd) {
       this.log.info('avd name defined, ignoring device name and platform version');
     } else {
       if (!caps.deviceName) {
-        this.log.errorAndThrow('avd or deviceName should be specified when reboot option is enables');
+        this.log.errorAndThrow(
+          'avd or deviceName should be specified when reboot option is enables'
+        );
+        throw new Error(); // unreachable
       }
       if (!caps.platformVersion) {
-        this.log.errorAndThrow('avd or platformVersion should be specified when reboot option is enabled');
+        this.log.errorAndThrow(
+          'avd or platformVersion should be specified when reboot option is enabled'
+        );
+        throw new Error(); // unreachable
       }
-      let avdDevice = caps.deviceName.replace(/[^a-zA-Z0-9_.]/g, '-');
+      const avdDevice = caps.deviceName.replace(/[^a-zA-Z0-9_.]/g, '-');
       this.opts.avd = `${avdDevice}__${caps.platformVersion}`;
     }
   }
 
-  async allocateSystemPort () {
-    const forwardPort = async (localPort) => {
-      this.log.debug(`Forwarding UiAutomator2 Server port ${DEVICE_PORT} to local port ${localPort}`);
+  async allocateSystemPort() {
+    const forwardPort = async (localPort: number) => {
+      this.log.debug(
+        `Forwarding UiAutomator2 Server port ${DEVICE_PORT} to local port ${localPort}`
+      );
       if ((await checkPortStatus(localPort, LOCALHOST_IP4)) === 'open') {
-        this.log.errorAndThrow(`UiAutomator2 Server cannot start because the local port #${localPort} is busy. ` +
-          `Make sure the port you provide via 'systemPort' capability is not occupied. ` +
-          `This situation might often be a result of an inaccurate sessions management, e.g. ` +
-          `old automation sessions on the same device must always be closed before starting new ones.`);
+        this.log.errorAndThrow(
+          `UiAutomator2 Server cannot start because the local port #${localPort} is busy. ` +
+            `Make sure the port you provide via 'systemPort' capability is not occupied. ` +
+            `This situation might often be a result of an inaccurate sessions management, e.g. ` +
+            `old automation sessions on the same device must always be closed before starting new ones.`
+        );
       }
-      await this.adb.forwardPort(localPort, DEVICE_PORT);
+      await this.adb!.forwardPort(localPort, DEVICE_PORT);
     };
 
-    if (this.opts.systemPort) {
+    if (this.systemPort) {
       this._hasSystemPortInCaps = true;
-      return await forwardPort(this.opts.systemPort);
+      return await forwardPort(this.systemPort);
     }
 
     await DEVICE_PORT_ALLOCATION_GUARD(async () => {
       const [startPort, endPort] = DEVICE_PORT_RANGE;
       try {
-        this.opts.systemPort = await findAPortNotInUse(startPort, endPort);
+        this.systemPort = await findAPortNotInUse(startPort, endPort);
       } catch (e) {
         this.log.errorAndThrow(
           `Cannot find any free port in range ${startPort}..${endPort}}. ` +
-          `Please set the available port number by providing the systemPort capability or ` +
-          `double check the processes that are locking ports within this range and terminate ` +
-          `these which are not needed anymore`);
+            `Please set the available port number by providing the systemPort capability or ` +
+            `double check the processes that are locking ports within this range and terminate ` +
+            `these which are not needed anymore`
+        );
+        throw new Error(); // unreachable
       }
-      await forwardPort(this.opts.systemPort);
+      await forwardPort(this.systemPort);
     });
   }
 
-  async releaseSystemPort () {
-    if (!this.opts.systemPort || !this.adb) {
+  async releaseSystemPort() {
+    if (!this.systemPort || !this.adb) {
       return;
     }
 
     if (this._hasSystemPortInCaps) {
-      await this.adb.removePortForward(this.opts.systemPort);
+      await this.adb.removePortForward(this.systemPort);
     } else {
-      await DEVICE_PORT_ALLOCATION_GUARD(async () => await this.adb.removePortForward(this.opts.systemPort));
+      await DEVICE_PORT_ALLOCATION_GUARD(
+        async () => await this.adb!.removePortForward(this.systemPort!)
+      );
     }
   }
 
-  async allocateMjpegServerPort () {
+  async allocateMjpegServerPort() {
     if (this.opts.mjpegServerPort) {
-      this.log.debug(`MJPEG broadcasting requested, forwarding MJPEG server port ${MJPEG_SERVER_DEVICE_PORT} ` +
-        `to local port ${this.opts.mjpegServerPort}`);
-      await this.adb.forwardPort(this.opts.mjpegServerPort, MJPEG_SERVER_DEVICE_PORT);
+      this.log.debug(
+        `MJPEG broadcasting requested, forwarding MJPEG server port ${MJPEG_SERVER_DEVICE_PORT} ` +
+          `to local port ${this.opts.mjpegServerPort}`
+      );
+      await this.adb!.forwardPort(this.opts.mjpegServerPort, MJPEG_SERVER_DEVICE_PORT);
     }
   }
 
-  async releaseMjpegServerPort () {
+  async releaseMjpegServerPort() {
     if (this.opts.mjpegServerPort) {
-      await this.adb.removePortForward(this.opts.mjpegServerPort);
+      await this.adb!.removePortForward(this.opts.mjpegServerPort);
     }
   }
 
-  async startUiAutomator2Session () {
+  async startUiAutomator2Session(
+    caps: Uiautomator2StartSessionOpts
+  ): Promise<Uiautomator2SessionCaps> {
     // get device udid for this session
-    let {udid, emPort} = await helpers.getDeviceInfoFromCaps(this.opts);
+    const {udid, emPort} = await helpers.getDeviceInfoFromCaps(this.opts);
     this.opts.udid = udid;
+    // @ts-expect-error do not put random stuff on opts
     this.opts.emPort = emPort;
 
     // now that we know our java version and device info, we can create our
@@ -360,11 +449,14 @@ class AndroidUiautomator2Driver extends BaseDriver {
     const apiLevel = await this.adb.getApiLevel();
 
     if (apiLevel < 21) {
-      this.log.errorAndThrow('UIAutomator2 is only supported since Android 5.0 (Lollipop). ' +
-        'You could still use other supported backends in order to automate older Android versions.');
+      this.log.errorAndThrow(
+        'UIAutomator2 is only supported since Android 5.0 (Lollipop). ' +
+          'You could still use other supported backends in order to automate older Android versions.'
+      );
     }
 
-    if (apiLevel >= 28) { // Android P
+    if (apiLevel >= 28) {
+      // Android P
       this.log.info('Relaxing hidden api policy');
       await this.adb.setHiddenApiPolicy('1', !!this.opts.ignoreHiddenApiPolicyError);
     }
@@ -372,7 +464,9 @@ class AndroidUiautomator2Driver extends BaseDriver {
     // check if we have to enable/disable gps before running the application
     if (util.hasValue(this.opts.gpsEnabled)) {
       if (this.isEmulator()) {
-        this.log.info(`Trying to ${this.opts.gpsEnabled ? 'enable' : 'disable'} gps location provider`);
+        this.log.info(
+          `Trying to ${this.opts.gpsEnabled ? 'enable' : 'disable'} gps location provider`
+        );
         await this.adb.toggleGPSLocationProvider(this.opts.gpsEnabled);
       } else {
         this.log.warn(`Sorry! 'gpsEnabled' capability is only available for emulators`);
@@ -382,18 +476,25 @@ class AndroidUiautomator2Driver extends BaseDriver {
     // get appPackage et al from manifest if necessary
     const appInfo = await helpers.getLaunchInfo(this.adb, this.opts);
     // and get it onto our 'opts' object so we use it from now on
-    Object.assign(this.opts, appInfo || {});
+    this.opts = {...this.opts, ...(appInfo ?? {})};
 
     // set actual device name, udid, platform version, screen size, screen density, model and manufacturer details
-    this.caps.deviceName = this.adb.curDeviceId;
-    this.caps.deviceUDID = this.opts.udid;
+    const sessionInfo: Uiautomator2SessionInfo = {
+      deviceName: this.adb.curDeviceId!,
+      deviceUDID: this.opts.udid!,
+    };
+
+    const capsWithSessionInfo = {
+      ...caps,
+      ...sessionInfo,
+    };
 
     // start an avd, set the language/locale, pick an emulator, etc...
     // TODO with multiple devices we'll need to parameterize this
     await helpers.initDevice(this.adb, this.opts);
 
     // Prepare the device by forwarding the UiAutomator2 port
-    // This call mutates this.opts.systemPort if it is not set explicitly
+    // This call mutates this.systemPort if it is not set explicitly
     await this.allocateSystemPort();
 
     // Prepare the device by forwarding the UiAutomator2 MJPEG server port (if
@@ -401,10 +502,11 @@ class AndroidUiautomator2Driver extends BaseDriver {
     await this.allocateMjpegServerPort();
 
     // set up the modified UiAutomator2 server etc
-    await this.initUiAutomator2Server();
+    const uiautomator2 = await this.initUiAutomator2Server();
 
     // Should be after installing io.appium.settings in helpers.initDevice
-    if (this.opts.disableWindowAnimation && (await this.adb.getApiLevel() < 26)) { // API level 26 is Android 8.0.
+    if (this.opts.disableWindowAnimation && (await this.adb.getApiLevel()) < 26) {
+      // API level 26 is Android 8.0.
       // Granting android.permission.SET_ANIMATION_SCALE is necessary to handle animations under API level 26
       // Read https://github.com/appium/appium/pull/11640#issuecomment-438260477
       // `--no-window-animation` works over Android 8 to disable all of animations
@@ -422,25 +524,29 @@ class AndroidUiautomator2Driver extends BaseDriver {
     await this.initAUT();
 
     // Adding AUT package name in the capabilities if package name not exist in caps
-    if (!this.caps.appPackage && appInfo) {
-      this.caps.appPackage = appInfo.appPackage;
+    if (!capsWithSessionInfo.appPackage && appInfo) {
+      capsWithSessionInfo.appPackage = appInfo.appPackage;
     }
 
     // launch UiAutomator2 and wait till its online and we have a session
-    await this.uiautomator2.startSession(this.caps);
+    await uiautomator2.startSession(capsWithSessionInfo);
 
-    await this.addDeviceInfoToCaps();
+    const capsWithSessionAndDeviceInfo = {
+      ...capsWithSessionInfo,
+      ...(await this.getDeviceInfoFromUia2()),
+    };
 
     // Unlock the device after the session is started.
     if (!this.opts.skipUnlock) {
       // unlock the device to prepare it for testing
-      await helpers.unlock(this, this.adb, this.caps);
+      await helpers.unlock(this as any, this.adb, this.caps);
     } else {
       this.log.debug(`'skipUnlock' capability set, so skipping device unlock`);
     }
 
-    if (this.isChromeSession) { // start a chromedriver session
-      await this.startChromeSession(this);
+    if (this.isChromeSession) {
+      // start a chromedriver session
+      await this.startChromeSession();
     } else if (this.opts.autoLaunch && this.opts.appPackage) {
       await this.ensureAppStarts();
     }
@@ -448,7 +554,7 @@ class AndroidUiautomator2Driver extends BaseDriver {
     // if the initial orientation is requested, set it
     if (util.hasValue(this.opts.orientation)) {
       this.log.debug(`Setting initial orientation to '${this.opts.orientation}'`);
-      await this.setOrientation(this.opts.orientation);
+      await this.setOrientation(this.opts.orientation as Orientation);
     }
 
     // if we want to immediately get into a webview, set our context
@@ -463,30 +569,29 @@ class AndroidUiautomator2Driver extends BaseDriver {
     // now that everything has started successfully, turn on proxying so all
     // subsequent session requests go straight to/from uiautomator2
     this.jwpProxyActive = true;
+
+    return {...capsWithSessionAndDeviceInfo, ...(await this.getDeviceDetails())};
   }
 
-  async addDeviceInfoToCaps () {
-    const {
-      apiVersion,
+  async getDeviceInfoFromUia2(): Promise<Uiautomator2DeviceInfo> {
+    const {apiVersion, platformVersion, manufacturer, model, realDisplaySize, displayDensity} =
+      await this.mobileGetDeviceInfo();
+    return {
+      deviceApiLevel: _.parseInt(apiVersion),
       platformVersion,
-      manufacturer,
-      model,
-      realDisplaySize,
-      displayDensity,
-    } = await this.mobileGetDeviceInfo();
-    this.caps.deviceApiLevel = parseInt(apiVersion, 10);
-    this.caps.platformVersion = platformVersion;
-    this.caps.deviceScreenSize = realDisplaySize;
-    this.caps.deviceScreenDensity = displayDensity;
-    this.caps.deviceModel = model;
-    this.caps.deviceManufacturer = manufacturer;
+      deviceManufacturer: manufacturer,
+      deviceModel: model,
+      deviceScreenSize: realDisplaySize,
+      deviceScreenDensity: displayDensity,
+    };
   }
 
-  async initUiAutomator2Server () {
+  async initUiAutomator2Server() {
     // broken out for readability
     const uiautomator2Opts = {
+      // @ts-expect-error FIXME: maybe `address` instead of `host`?
       host: this.opts.remoteAdbHost || this.opts.host || LOCALHOST_IP4,
-      systemPort: this.opts.systemPort,
+      systemPort: this.systemPort,
       devicePort: DEVICE_PORT,
       adb: this.adb,
       apk: this.opts.app,
@@ -501,28 +606,37 @@ class AndroidUiautomator2Driver extends BaseDriver {
     // uiautomator2 with the appropriate options
     this.uiautomator2 = new UiAutomator2Server(this.log, uiautomator2Opts);
     this.proxyReqRes = this.uiautomator2.proxyReqRes.bind(this.uiautomator2);
-    this.proxyCommand = this.uiautomator2.proxyCommand.bind(this.uiautomator2);
+    this.proxyCommand = this.uiautomator2.proxyCommand.bind(
+      this.uiautomator2
+    ) as typeof this.proxyCommand;
 
     if (this.opts.skipServerInstallation) {
       this.log.info(`'skipServerInstallation' is set. Skipping UIAutomator2 server installation.`);
     } else {
       await this.uiautomator2.installServerApk(this.opts.uiautomator2ServerInstallTimeout);
       try {
-        await this.adb.addToDeviceIdleWhitelist(
-          SETTINGS_HELPER_PKG_ID, SERVER_PACKAGE_ID, SERVER_TEST_PACKAGE_ID,
+        await this.adb!.addToDeviceIdleWhitelist(
+          SETTINGS_HELPER_PKG_ID,
+          SERVER_PACKAGE_ID,
+          SERVER_TEST_PACKAGE_ID
         );
       } catch (e) {
-        this.log.warn(`Cannot add server packages to the Doze whitelist. Original error: ` +
-          (e.stderr || e.message));
+        const err = e as ExecError;
+        this.log.warn(
+          `Cannot add server packages to the Doze whitelist. Original error: ` +
+            (err.stderr || err.message)
+        );
       }
     }
+
+    return this.uiautomator2;
   }
 
-  async initAUT () {
+  async initAUT() {
     // Uninstall any uninstallOtherPackages which were specified in caps
     if (this.opts.uninstallOtherPackages) {
       await helpers.uninstallOtherPackages(
-        this.adb,
+        this.adb!,
         helpers.parseArray(this.opts.uninstallOtherPackages),
         [SETTINGS_HELPER_PKG_ID, SERVER_PACKAGE_ID, SERVER_TEST_PACKAGE_ID]
       );
@@ -534,61 +648,80 @@ class AndroidUiautomator2Driver extends BaseDriver {
       try {
         otherApps = helpers.parseArray(this.opts.otherApps);
       } catch (e) {
-        this.log.errorAndThrow(`Could not parse "otherApps" capability: ${e.message}`);
+        this.log.errorAndThrow(`Could not parse "otherApps" capability: ${(e as Error).message}`);
+        throw new Error(); // unrechable
       }
-      otherApps = await B.all(otherApps
-        .map((app) => this.helpers.configureApp(app, [APK_EXTENSION, APKS_EXTENSION])));
-      await helpers.installOtherApks(otherApps, this.adb, this.opts);
+      otherApps = await B.all(
+        otherApps.map((app) => this.helpers.configureApp(app, [APK_EXTENSION, APKS_EXTENSION]))
+      );
+      await helpers.installOtherApks(otherApps, this.adb!, this.opts);
     }
 
     if (this.opts.app) {
-      if (this.opts.noReset && !(await this.adb.isAppInstalled(this.opts.appPackage))
-          || !this.opts.noReset) {
-        if (!this.opts.noSign && !await this.adb.checkApkCert(this.opts.app, this.opts.appPackage, {
-          requireDefaultCert: false,
-        })) {
-          await helpers.signApp(this.adb, this.opts.app);
+      if (
+        (this.opts.noReset && !(await this.adb!.isAppInstalled(this.opts.appPackage!))) ||
+        !this.opts.noReset
+      ) {
+        if (
+          !this.opts.noSign &&
+          !(await this.adb!.checkApkCert(this.opts.app, this.opts.appPackage, {
+            requireDefaultCert: false,
+          }))
+        ) {
+          await helpers.signApp(this.adb!, this.opts.app);
         }
         if (!this.opts.skipUninstall) {
-          await this.adb.uninstallApk(this.opts.appPackage);
+          await this.adb!.uninstallApk(this.opts.appPackage!);
         }
-        await helpers.installApk(this.adb, this.opts);
+        await helpers.installApk(this.adb!, this.opts);
       } else {
-        this.log.debug('noReset has been requested and the app is already installed. Doing nothing');
+        this.log.debug(
+          'noReset has been requested and the app is already installed. Doing nothing'
+        );
       }
     } else {
       if (this.opts.fullReset) {
-        this.log.errorAndThrow('Full reset requires an app capability, use fastReset if app is not provided');
+        this.log.errorAndThrow(
+          'Full reset requires an app capability, use fastReset if app is not provided'
+        );
       }
       this.log.debug('No app capability. Assuming it is already on the device');
       if (this.opts.fastReset && this.opts.appPackage) {
-        await helpers.resetApp(this.adb, this.opts);
+        await helpers.resetApp(this.adb!, this.opts);
       }
     }
   }
 
-  async ensureAppStarts () {
+  async ensureAppStarts() {
     // make sure we have an activity and package to wait for
     const appWaitPackage = this.opts.appWaitPackage || this.opts.appPackage;
     const appWaitActivity = this.opts.appWaitActivity || this.opts.appActivity;
-
-    this.log.info(`Starting '${this.opts.appPackage}/${this.opts.appActivity} ` +
-      `and waiting for '${appWaitPackage}/${appWaitActivity}'`);
+    this.log.info(
+      `Starting '${this.opts.appPackage}/${this.opts.appActivity} ` +
+        `and waiting for '${appWaitPackage}/${appWaitActivity}'`
+    );
 
     if (this.caps.androidCoverage) {
-      this.log.info(`androidCoverage is configured. ` +
-        ` Starting instrumentation of '${this.caps.androidCoverage}'...`);
-      await this.adb.androidCoverage(this.caps.androidCoverage, appWaitPackage, appWaitActivity);
+      this.log.info(
+        `androidCoverage is configured. ` +
+          ` Starting instrumentation of '${this.caps.androidCoverage}'...`
+      );
+      await this.adb!.androidCoverage(this.caps.androidCoverage, appWaitPackage!, appWaitActivity!);
       return;
     }
-    if (this.opts.noReset && !this.opts.forceAppLaunch
-        && await this.adb.processExists(this.opts.appPackage)) {
-      this.log.info(`'${this.opts.appPackage}' is already running and noReset is enabled. ` +
-        `Set forceAppLaunch capability to true if the app must be forcefully restarted on session startup.`);
+    if (
+      this.opts.noReset &&
+      !this.opts.forceAppLaunch &&
+      (await this.adb!.processExists(this.opts.appPackage!))
+    ) {
+      this.log.info(
+        `'${this.opts.appPackage}' is already running and noReset is enabled. ` +
+          `Set forceAppLaunch capability to true if the app must be forcefully restarted on session startup.`
+      );
       return;
     }
-    await this.adb.startApp({
-      pkg: this.opts.appPackage,
+    await this.adb!.startApp({
+      pkg: this.opts.appPackage!,
       activity: this.opts.appActivity,
       action: this.opts.intentAction || 'android.intent.action.MAIN',
       category: this.opts.intentCategory || 'android.intent.category.LAUNCHER',
@@ -604,22 +737,26 @@ class AndroidUiautomator2Driver extends BaseDriver {
     });
   }
 
-  async deleteSession () {
+  override async deleteSession() {
     this.log.debug('Deleting UiAutomator2 session');
 
-    const screenRecordingStopTasks = [async () => {
-      if (!_.isEmpty(this._screenRecordingProperties)) {
-        await this.stopRecordingScreen();
-      }
-    }, async () => {
-      if (await this.mobileIsMediaProjectionRecordingRunning()) {
-        await this.mobileStopMediaProjectionRecording();
-      }
-    }, async () => {
-      if (!_.isEmpty(this._screenStreamingProps)) {
-        await this.mobileStopScreenStreaming();
-      }
-    }];
+    const screenRecordingStopTasks = [
+      async () => {
+        if (!_.isEmpty(this._screenRecordingProperties)) {
+          await this.stopRecordingScreen();
+        }
+      },
+      async () => {
+        if (await this.mobileIsMediaProjectionRecordingRunning()) {
+          await this.mobileStopMediaProjectionRecording();
+        }
+      },
+      async () => {
+        if (!_.isEmpty(this._screenStreamingProps)) {
+          await this.mobileStopScreenStreaming();
+        }
+      },
+    ];
 
     await androidHelpers.removeAllSessionWebSocketHandlers(this.server, this.sessionId);
 
@@ -627,54 +764,65 @@ class AndroidUiautomator2Driver extends BaseDriver {
       try {
         await this.stopChromedriverProxies();
       } catch (err) {
-        this.log.warn(`Unable to stop ChromeDriver proxies: ${err.message}`);
+        this.log.warn(`Unable to stop ChromeDriver proxies: ${(err as Error).message}`);
       }
       if (this.jwpProxyActive) {
         try {
           await this.uiautomator2.deleteSession();
         } catch (err) {
-          this.log.warn(`Unable to proxy deleteSession to UiAutomator2: ${err.message}`);
+          this.log.warn(`Unable to proxy deleteSession to UiAutomator2: ${(err as Error).message}`);
         }
       }
-      this.uiautomator2 = null;
+      this.uiautomator2 = undefined;
     }
     this.jwpProxyActive = false;
 
     if (this.adb) {
-      await B.all(screenRecordingStopTasks.map((task) => {
-        (async () => {
-          try {
-            await task();
-          } catch (ign) {}
-        })();
-      }));
+      await B.all(
+        screenRecordingStopTasks.map((task) => {
+          (async () => {
+            try {
+              await task();
+            } catch (ign) {}
+          })();
+        })
+      );
 
       if (this.caps.androidCoverage) {
         this.log.info('Shutting down the adb process of instrumentation...');
         await this.adb.endAndroidCoverage();
         // Use this broadcast intent to notify it's time to dump coverage to file
         if (this.caps.androidCoverageEndIntent) {
-          this.log.info(`Sending intent broadcast '${this.caps.androidCoverageEndIntent}' at the end of instrumenting.`);
+          this.log.info(
+            `Sending intent broadcast '${this.caps.androidCoverageEndIntent}' at the end of instrumenting.`
+          );
           await this.adb.broadcast(this.caps.androidCoverageEndIntent);
         } else {
-          this.log.warn('No androidCoverageEndIntent is configured in caps. Possibly you cannot get coverage file.');
+          this.log.warn(
+            'No androidCoverageEndIntent is configured in caps. Possibly you cannot get coverage file.'
+          );
         }
       }
       if (this.opts.appPackage) {
-        if (!this.isChromeSession && ((!this.opts.dontStopAppOnReset && !this.opts.noReset)
-            || (this.opts.noReset && this.opts.shouldTerminateApp))) {
+        if (
+          !this.isChromeSession &&
+          ((!this.opts.dontStopAppOnReset && !this.opts.noReset) ||
+            (this.opts.noReset && this.opts.shouldTerminateApp))
+        ) {
           try {
             await this.adb.forceStop(this.opts.appPackage);
           } catch (err) {
-            this.log.warn(`Unable to force stop app: ${err.message}`);
+            this.log.warn(`Unable to force stop app: ${(err as Error).message}`);
           }
         }
         if (this.opts.fullReset && !this.opts.skipUninstall) {
-          this.log.debug(`Capability 'fullReset' set to 'true', Uninstalling '${this.opts.appPackage}'`);
+          this.log.debug(
+            `Capability 'fullReset' set to 'true', Uninstalling '${this.opts.appPackage}'`
+          );
           try {
             await this.adb.uninstallApk(this.opts.appPackage);
           } catch (err) {
-            this.log.warn(`Unable to uninstall app: ${err.message}`);
+            this.log.warn(`Unable to uninstall app: ${(err as Error).message}`);
           }
         }
       }
@@ -687,30 +835,32 @@ class AndroidUiautomator2Driver extends BaseDriver {
       try {
         await this.releaseSystemPort();
       } catch (error) {
-        this.log.warn(`Unable to remove system port forward: ${error.message}`);
+        this.log.warn(`Unable to remove system port forward: ${(error as Error).message}`);
         // Ignore, this block will also be called when we fall in catch block
         // and before even port forward.
       }
       try {
         await this.releaseMjpegServerPort();
       } catch (error) {
-        this.log.warn(`Unable to remove MJPEG server port forward: ${error.message}`);
+        this.log.warn(`Unable to remove MJPEG server port forward: ${(error as Error).message}`);
         // Ignore, this block will also be called when we fall in catch block
         // and before even port forward.
       }
 
-      if (await this.adb.getApiLevel() >= 28) { // Android P
+      if ((await this.adb.getApiLevel()) >= 28) {
+        // Android P
         this.log.info('Restoring hidden api policy to the device default configuration');
         await this.adb.setDefaultHiddenApiPolicy(!!this.opts.ignoreHiddenApiPolicyError);
       }
 
+      // @ts-expect-error unknown option
       if (this.opts.reboot) {
-        let avdName = this.opts.avd.replace('@', '');
+        const avdName = this.opts.avd!.replace('@', '');
         this.log.debug(`Closing emulator '${avdName}'`);
         try {
           await this.adb.killEmulator(avdName);
         } catch (err) {
-          this.log.warn(`Unable to close emulator: ${err.message}`);
+          this.log.warn(`Unable to close emulator: ${(err as Error).message}`);
         }
       }
     }
@@ -718,17 +868,18 @@ class AndroidUiautomator2Driver extends BaseDriver {
       this.log.info('Closing MJPEG stream');
       this.mjpegStream.stop();
     }
-    await super.deleteSession();
+    await BaseDriver.prototype.deleteSession.call(this);
   }
 
-  async checkAppPresent () {
+  override 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}'`);
+      throw new Error(); // unreachable
     }
   }
 
-  async onSettingsUpdate () {
+  override async onSettingsUpdate() {
     // intentionally do nothing here, since commands.updateSettings proxies
     // settings to the uiauto2 server already
   }
@@ -736,29 +887,28 @@ class AndroidUiautomator2Driver extends BaseDriver {
   // 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
-  async wrapBootstrapDisconnect (wrapped) {
+  override async wrapBootstrapDisconnect(wrapped: () => Promise<void>) {
     await wrapped();
-    await this.adb.restart();
+    this.adb!.restart();
     await this.allocateSystemPort();
     await this.allocateMjpegServerPort();
   }
 
-  proxyActive (sessionId) {
-    super.proxyActive(sessionId);
+  override proxyActive(sessionId: string) {
+    BaseDriver.prototype.proxyActive.call(this, sessionId);
 
     // we always have an active proxy to the UiAutomator2 server
     return true;
   }
 
-  canProxy (sessionId) {
-    super.canProxy(sessionId);
+  override canProxy(sessionId: string) {
+    BaseDriver.prototype.canProxy.call(this, sessionId);
 
     // we can always proxy to the uiautomator2 server
     return true;
   }
 
-  getProxyAvoidList (sessionId) {
-    super.getProxyAvoidList(sessionId);
+  override 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)) {
@@ -768,26 +918,34 @@ class AndroidUiautomator2Driver extends BaseDriver {
       this.jwpProxyAvoid = NO_PROXY;
     }
     if (this.opts.nativeWebScreenshot) {
-      this.jwpProxyAvoid = [...this.jwpProxyAvoid, ['GET', new RegExp('^/session/[^/]+/screenshot')]];
+      this.jwpProxyAvoid = [
+        ...this.jwpProxyAvoid,
+        ['GET', new RegExp('^/session/[^/]+/screenshot')],
+      ];
     }
 
     return this.jwpProxyAvoid;
   }
 
-  get isChromeSession () {
+  get isChromeSession() {
     return helpers.isChromeBrowser(this.opts.browserName);
   }
-}
 
-// first add the android-driver commands which we will fall back to
-for (let [cmd, fn] of _.toPairs(androidCommands)) {
-  AndroidUiautomator2Driver.prototype[cmd] = fn;
-}
+  async updateSettings(settings: Uiautomator2Settings) {
+    await this.settings.update(settings);
+    await this.uiautomator2!.jwproxy.command('/appium/settings', 'POST', {settings});
+  }
 
-// then overwrite with any uiautomator2-specific commands
-for (let [cmd, fn] of _.toPairs(commands)) {
-  AndroidUiautomator2Driver.prototype[cmd] = fn;
+  async getSettings() {
+    const driverSettings = this.settings.getSettings();
+    const serverSettings = (await this.uiautomator2!.jwproxy.command(
+      '/appium/settings',
+      'GET'
+    )) as Partial<Uiautomator2Settings>;
+    return {...driverSettings, ...serverSettings};
+  }
 }
 
-export { AndroidUiautomator2Driver };
-export default AndroidUiautomator2Driver;
+import './commands';
+
+export {AndroidUiautomator2Driver};