appium-uiautomator2-driver 2.26.3 → 2.27.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [2.27.0](https://github.com/appium/appium-uiautomator2-driver/compare/v2.26.3...v2.27.0) (2023-06-21)
+
+
+### Features
+
+* add the description of setting API snapshotMaxDepth ([#629](https://github.com/appium/appium-uiautomator2-driver/issues/629)) ([c74ad63](https://github.com/appium/appium-uiautomator2-driver/commit/c74ad638af2bddd107bb774c76f2683acb7a8a07))
+
 ## [2.26.3](https://github.com/appium/appium-uiautomator2-driver/compare/v2.26.2...v2.26.3) (2023-06-21)
 
 

package/README.md

@@ -289,6 +289,7 @@ enforceXPath1 | boolean | Since UiAutomator2 driver version `4.25.0` XPath2 is s
 limitXPathContextScope | boolean | Due to historical reasons UiAutomator2 driver limits scopes of element context-based searches to the parent element. This means a request like `findElement(By.xpath, "//root").findElement(By.xpath, "./..")` would always fail, because the driver only collects descendants of the `root` element for the destination XML source. The `limitXPathContextScope` setting being set to `false` changes that default behavior, so the collected page source includes the whole page source XML where `root` node is set as the search context. With that setting disabled the search query above should not fail anymore. Although, you must still be careful while building XPath requests for context-based searches with the `limitXPathContextScope` setting set to `false`. A request like `findElement(By.xpath, "//root").findElement(By.xpath, "//element")` would ignore the current context and search for `element` trough the whole page source. Use `.` notation to correct that behavior and only find `element` nodes which are descendants of the `root` node: `findElement(By.xpath, "//root").findElement(By.xpath, ".//element")`.
 disableIdLocatorAutocompletion | boolean | According to internal Android standards it is expected that each resource identifier is prefixed with `<packageName>:id/` string. This should guarantee uniqueness of each identifier. Although some application development frameworks ignore this rule and don't add such prefix automatically or, rather, let it up to the developer to decide how to represent their application identifiers. For example, [testTag modifier attribute in the Jetpack Compose](https://developer.android.com/reference/kotlin/androidx/compose/ui/platform/package-summary#(androidx.compose.ui.Modifier).testTag(kotlin.String)) with [testTagsAsResourceId](https://developer.android.com/reference/kotlin/androidx/compose/ui/semantics/package-summary#(androidx.compose.ui.semantics.SemanticsPropertyReceiver).testTagsAsResourceId()) allows developers to set an arbitrary string without the prefix rule. [Interoperability with UiAutomator](https://developer.android.com/jetpack/compose/testing) also explains how to set it. By default UIA2 driver adds the above prefixes automatically to all resource id locators if they are not prefixed, but in case of such "special" apps this feature might be disabled by assigning the setting to `true`.
 includeExtrasInPageSource | boolean | Whether to include `extras` element attribute in the XML page source result. Then, XPath locator can find the element by the extras. Its value consists of combined [getExtras](https://developer.android.com/reference/android/view/accessibility/AccessibilityNodeInfo#getExtras()) as `keys=value` pair separated by a semicolon (`;`), thus you may need to find the element with partial matching like `contains` e.g. `driver.find_element :xpath, '//*[contains(@extras, "AccessibilityNodeInfo.roleDescription=")]'`. The value could be huge if elements in the XML page source have large `extras`. It could affect the performance of XML page source generation.
+snapshotMaxDepth | int | The number of maximum depth for the source tree snapshot. The default value is `70`. This number should be in range [1, 500]. A part of the elements source tree might be lost if the value is too low. Also, StackOverflowError might be caused if the value is too high (Issues [12545](https://github.com/appium/appium/issues/12545), [12892](https://github.com/appium/appium/issues/12892)). The available driver version is `2.27.0` or higher.
 
 
 ## Platform-Specific Extensions

package/npm-shrinkwrap.json

@@ -1,19 +1,19 @@
 {
   "name": "appium-uiautomator2-driver",
-  "version": "2.26.3",
+  "version": "2.27.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-uiautomator2-driver",
-      "version": "2.26.3",
+      "version": "2.27.0",
       "license": "Apache-2.0",
       "dependencies": {
         "@babel/runtime": "^7.0.0",
         "appium-adb": "^9.11.5",
         "appium-android-driver": "^5.14.0",
         "appium-chromedriver": "^5.3.1",
-        "appium-uiautomator2-server": "^5.11.1",
+        "appium-uiautomator2-server": "^5.12.0",
         "asyncbox": "^2.3.1",
         "axios": "^1.x",
         "bluebird": "^3.5.1",

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "2.26.3",
+  "version": "2.27.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -60,7 +60,7 @@
     "appium-adb": "^9.11.5",
     "appium-android-driver": "^5.14.0",
     "appium-chromedriver": "^5.3.1",
-    "appium-uiautomator2-server": "^5.11.1",
+    "appium-uiautomator2-server": "^5.12.0",
     "asyncbox": "^2.3.1",
     "axios": "^1.x",
     "bluebird": "^3.5.1",