appium-uiautomator2-driver 3.5.6 → 3.6.0

package/lib/uiautomator2.js

@@ -97,6 +97,51 @@ class UiAutomator2Server {
     return resultInfo;
   }
 
+  /**
+   * @typedef {Object} PackageInfo
+   * @property {import('appium-adb/build/lib/tools/apk-utils').InstallState} installState
+   * @property {string} appPath
+   * @property {string} appId
+   */
+
+  /**
+   * Checks if server components must be installed from the device under test
+   * in scope of the current driver session.
+   *
+   * For example, if one of servers on the device under test was newer than servers current UIA2 driver wants to
+   * use for the session, the UIA2 driver should uninstall the installed ones in order to avoid
+   * version mismatch between the UIA2 drier and servers on the device under test.
+   * Also, if the device under test has missing servers, current UIA2 driver should uninstall all
+   * servers once in order to install proper servers freshly.
+   *
+   * @param {PackageInfo[]} packagesInfo
+   * @returns {boolean} true if any of components is already installed and the other is not installed
+   *                    or the installed one has a newer version.
+   */
+  shouldUninstallServerPackages(packagesInfo = []) {
+    const isAnyComponentInstalled = packagesInfo.some(
+      ({installState}) => installState !== this.adb.APP_INSTALL_STATE.NOT_INSTALLED);
+    const isAnyComponentNotInstalledOrNewer = packagesInfo.some(({installState}) => [
+      this.adb.APP_INSTALL_STATE.NOT_INSTALLED,
+      this.adb.APP_INSTALL_STATE.NEWER_VERSION_INSTALLED,
+    ].includes(installState));
+    return isAnyComponentInstalled && isAnyComponentNotInstalledOrNewer;
+  }
+
+  /**
+   * Checks if server components should be installed on the device under test in scope of the current driver session.
+   *
+   * @param {PackageInfo[]} packagesInfo
+   * @returns {boolean} true if any of components is not installed or older than currently installed in order to
+   *                    install or upgrade the servers on the device under test.
+   */
+  shouldInstallServerPackages(packagesInfo = []) {
+    return packagesInfo.some(({installState}) => [
+      this.adb.APP_INSTALL_STATE.NOT_INSTALLED,
+      this.adb.APP_INSTALL_STATE.OLDER_VERSION_INSTALLED,
+    ].includes(installState));
+  }
+
   /**
    * Installs the apks on to the device or emulator.
    *
@@ -116,15 +161,10 @@ class UiAutomator2Server {
     );
 
     this.log.debug(`Server packages status: ${JSON.stringify(packagesInfo)}`);
-    // Enforce server packages reinstall if any of the packages is not installed, while the other is
-    const shouldUninstallServerPackages = (packagesInfo.some(({installState}) => installState === this.adb.APP_INSTALL_STATE.NOT_INSTALLED)
-          && !packagesInfo.every(({installState}) => installState === this.adb.APP_INSTALL_STATE.NOT_INSTALLED));
+    const shouldUninstallServerPackages = this.shouldUninstallServerPackages(packagesInfo);
     // Install must always follow uninstall. Also, perform the install if
     // any of server packages is not installed or is outdated
-    const shouldInstallServerPackages = shouldUninstallServerPackages || packagesInfo.some(({installState}) => [
-      this.adb.APP_INSTALL_STATE.NOT_INSTALLED,
-      this.adb.APP_INSTALL_STATE.OLDER_VERSION_INSTALLED,
-    ].includes(installState));
+    const shouldInstallServerPackages = shouldUninstallServerPackages || this.shouldInstallServerPackages(packagesInfo);
     this.log.info(`Server packages are ${shouldInstallServerPackages ? '' : 'not '}going to be (re)installed`);
     if (shouldInstallServerPackages && shouldUninstallServerPackages) {
       this.log.info('Full packages reinstall is going to be performed');

package/npm-shrinkwrap.json

@@ -1,16 +1,16 @@
 {
   "name": "appium-uiautomator2-driver",
-  "version": "3.5.6",
+  "version": "3.6.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-uiautomator2-driver",
-      "version": "3.5.6",
+      "version": "3.6.0",
       "license": "Apache-2.0",
       "dependencies": {
         "appium-adb": "^12.2.0",
-        "appium-android-driver": "^9.6.5",
+        "appium-android-driver": "^9.7.0",
         "appium-chromedriver": "^5.6.28",
         "appium-uiautomator2-server": "^7.0.14",
         "asyncbox": "^3.0.0",
@@ -198,6 +198,18 @@
         "url": "https://github.com/sponsors/sindresorhus"
       }
     },
+    "node_modules/@appium/docutils/node_modules/typescript": {
+      "version": "5.4.5",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz",
+      "integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==",
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
+    },
     "node_modules/@appium/logger": {
       "version": "1.4.2",
       "resolved": "https://registry.npmjs.org/@appium/logger/-/logger-1.4.2.tgz",
@@ -711,9 +723,9 @@
       }
     },
     "node_modules/@types/express-serve-static-core": {
-      "version": "4.19.3",
-      "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.19.3.tgz",
-      "integrity": "sha512-KOzM7MhcBFlmnlr/fzISFF5vGWVSvN6fTd4T+ExOt08bA/dA5kpSzY52nMsI1KDFmUREpJelPYyuslLRSjjgCg==",
+      "version": "4.19.5",
+      "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.19.5.tgz",
+      "integrity": "sha512-y6W03tvrACO72aijJ5uF02FRq5cgDR9lUxddQ8vyF+GvmjJQqbzDcJngEjURc+ZsG31VI3hODNZJ2URj86pzmg==",
       "dependencies": {
         "@types/node": "*",
         "@types/qs": "*",
@@ -794,9 +806,9 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "20.14.5",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.5.tgz",
-      "integrity": "sha512-aoRR+fJkZT2l0aGOJhuA8frnCSoNX6W7U2mpNq63+BxBIj5BQFt8rHy627kijCmm63ijdSdwvGgpUsU6MBsZZA==",
+      "version": "20.14.8",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.8.tgz",
+      "integrity": "sha512-DO+2/jZinXfROG7j7WKFn/3C6nFwxy2lLpgLjEXJz+0XKphZlTLJ14mo8Vfg8X5BWN6XjyESXq+LcYdT7tR3bA==",
       "dependencies": {
         "undici-types": "~5.26.4"
       }
@@ -1043,9 +1055,9 @@
       }
     },
     "node_modules/appium-adb": {
-      "version": "12.4.3",
-      "resolved": "https://registry.npmjs.org/appium-adb/-/appium-adb-12.4.3.tgz",
-      "integrity": "sha512-pN8W6mB4PEUa2615XhmP77gHPx21lGrAzIrTlNweIS+ibNW+gMtfOvEFimtLZ1RXMpWW5GMO7AHSr50ceb92ug==",
+      "version": "12.4.4",
+      "resolved": "https://registry.npmjs.org/appium-adb/-/appium-adb-12.4.4.tgz",
+      "integrity": "sha512-q+vN6NgnUlcWT6FV12ryc1d8bFZSQOtcXpJJuUtgWYwVhebJB8hJE+6mcqUG5LOrcEWLOQXkx1oVQSx+VQosTQ==",
       "dependencies": {
         "@appium/support": "^5.0.3",
         "@devicefarmer/adbkit-apkreader": "^3.2.4",
@@ -1065,9 +1077,9 @@
       }
     },
     "node_modules/appium-android-driver": {
-      "version": "9.6.5",
-      "resolved": "https://registry.npmjs.org/appium-android-driver/-/appium-android-driver-9.6.5.tgz",
-      "integrity": "sha512-7MHHuZwGK+ku1DIHp4pIZdKt/P/MTDnlZqTDhMsxx5D0BQ9OwEd+OGGbUIyktAQOGNPRU2KyH3aeGiYg2XlfSw==",
+      "version": "9.7.0",
+      "resolved": "https://registry.npmjs.org/appium-android-driver/-/appium-android-driver-9.7.0.tgz",
+      "integrity": "sha512-0XWMOuuA8uzMcHturqYwfECnY6imfPzXuPxs75/XfUuyDCkVE7zHoAQaYJes3Q3A6tE9MEMTvmY3GKyjJR6koQ==",
       "dependencies": {
         "@appium/support": "^4.2.0",
         "@colors/colors": "^1.6.0",
@@ -1220,9 +1232,9 @@
       }
     },
     "node_modules/appium-chromedriver": {
-      "version": "5.6.58",
-      "resolved": "https://registry.npmjs.org/appium-chromedriver/-/appium-chromedriver-5.6.58.tgz",
-      "integrity": "sha512-RkBV1anx42CZbRpw+RuGL2sSgxnzS0Vi+GXrFQjHZzJd4uadjYmv0n5jcUQgCtPT2VGL3SZKYnuyIPTBF8D8HA==",
+      "version": "5.6.61",
+      "resolved": "https://registry.npmjs.org/appium-chromedriver/-/appium-chromedriver-5.6.61.tgz",
+      "integrity": "sha512-PO2HioadxOE+yijz+YgPbWxAbPJn0H0mW1tTvpWz45x9kTWMgXY5lXAv9jSZsSF2iTx8DOxInUltEBr9dPIjLw==",
       "hasInstallScript": true,
       "dependencies": {
         "@appium/base-driver": "^9.1.0",
@@ -2767,9 +2779,9 @@
       }
     },
     "node_modules/io.appium.settings": {
-      "version": "5.12.3",
-      "resolved": "https://registry.npmjs.org/io.appium.settings/-/io.appium.settings-5.12.3.tgz",
-      "integrity": "sha512-8wQxk88UM69AiP8bCZODWtVxm7O7Tt+mTWXObQkFwJrE/xek/idd84Gfe3mkhpSA5Fz451N9Qhm/DVzOIGDCDA==",
+      "version": "5.12.4",
+      "resolved": "https://registry.npmjs.org/io.appium.settings/-/io.appium.settings-5.12.4.tgz",
+      "integrity": "sha512-L/x6a2cM/lPZyTJgshAaMN9G8FsIJYqON7/MJwAUl268oDN/igwxuc8k5RrhK5lYgEbqNEqXktosQIeeOTKozA==",
       "dependencies": {
         "@appium/logger": "^1.3.0",
         "asyncbox": "^3.0.0",
@@ -2798,11 +2810,14 @@
       "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg=="
     },
     "node_modules/is-core-module": {
-      "version": "2.13.1",
-      "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.1.tgz",
-      "integrity": "sha512-hHrIjvZsftOsvKSn2TRYl63zvxsgE0K+0mYMoH6gD4omR5IWB2KynivBQczo3+wF1cCkjzvptnI9Q0sPU66ilw==",
+      "version": "2.14.0",
+      "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.14.0.tgz",
+      "integrity": "sha512-a5dFJih5ZLYlRtDc0dZWP7RiKr6xIKzmn/oAYCDvdLThadVgyJwlaoQPmRtMSpz+rk0OGAgIu+TcM9HUF0fk1A==",
       "dependencies": {
-        "hasown": "^2.0.0"
+        "hasown": "^2.0.2"
+      },
+      "engines": {
+        "node": ">= 0.4"
       },
       "funding": {
         "url": "https://github.com/sponsors/ljharb"
@@ -3377,9 +3392,12 @@
       }
     },
     "node_modules/object-inspect": {
-      "version": "1.13.1",
-      "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.1.tgz",
-      "integrity": "sha512-5qoj1RUiKOMsCCNLV1CBiPYE10sziTsnmNxkAI/rZhiD63CF7IqdFGC/XzjWjpSgLf0LxXX3bDFIh0E18f6UhQ==",
+      "version": "1.13.2",
+      "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.2.tgz",
+      "integrity": "sha512-IRZSRuzJiynemAXPYtPe5BoI/RESNYR7TYm50MC5Mqbd3Jmw5y790sErYw3V6SryFJD64b74qQQs9wn5Bg/k3g==",
+      "engines": {
+        "node": ">= 0.4"
+      },
       "funding": {
         "url": "https://github.com/sponsors/ljharb"
       }
@@ -4483,9 +4501,9 @@
       }
     },
     "node_modules/typescript": {
-      "version": "5.4.5",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz",
-      "integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==",
+      "version": "5.5.2",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.2.tgz",
+      "integrity": "sha512-NcRtPEOsPFFWjobJEtfihkLCZCXZt/os3zf8nTxjVH3RvTSxjrCamJpbExGvYOF+tFHc3pA65qpdwPbzjohhew==",
       "bin": {
         "tsc": "bin/tsc",
         "tsserver": "bin/tsserver"

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "3.5.6",
+  "version": "3.6.0",
   "bugs": {
     "url": "https://github.com/appium/appium-uiautomator2-driver/issues"
   },
@@ -57,7 +57,7 @@
   },
   "dependencies": {
     "appium-adb": "^12.2.0",
-    "appium-android-driver": "^9.6.5",
+    "appium-android-driver": "^9.7.0",
     "appium-chromedriver": "^5.6.28",
     "appium-uiautomator2-server": "^7.0.14",
     "asyncbox": "^3.0.0",