appium-webdriveragent 8.10.1 → 8.11.1

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [8.11.1](https://github.com/appium/WebDriverAgent/compare/v8.11.0...v8.11.1) (2024-11-11)
+
+### Miscellaneous Chores
+
+* bump appium-ios-device ([#955](https://github.com/appium/WebDriverAgent/issues/955)) ([021f349](https://github.com/appium/WebDriverAgent/commit/021f34901866f4a7870914c00781b83bd0cbddc4))
+
+## [8.11.0](https://github.com/appium/WebDriverAgent/compare/v8.10.1...v8.11.0) (2024-11-11)
+
+### Features
+
+* Add support for excluded_attributes in JSON source hierarchy ([#953](https://github.com/appium/WebDriverAgent/issues/953)) ([6112223](https://github.com/appium/WebDriverAgent/commit/6112223b21026fae5545fe1b1433a09c67ff524b))
+
 ## [8.10.1](https://github.com/appium/WebDriverAgent/compare/v8.10.0...v8.10.1) (2024-11-10)
 
 ### Miscellaneous Chores

package/WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.h

@@ -31,6 +31,12 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (NSDictionary *)fb_tree;
 
+/**
+  @param excludedAttributes Set of possible attributes to be excluded i.e frame, enabled, visible, accessible, focused. If set to nil or an empty array then no attributes will be excluded from the resulting JSON
+  @return application elements tree in form of nested dictionaries
+ */
+- (NSDictionary *)fb_tree:(nullable NSSet<NSString *> *) excludedAttributes;
+
 /**
  Return application elements accessibility tree in form of nested dictionaries
  */

package/WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.m

@@ -152,11 +152,16 @@ NSDictionary<NSNumber *, NSString *> *auditTypeValuesToNames(void) {
 }
 
 - (NSDictionary *)fb_tree
+{
+  return [self fb_tree:nil];
+}
+
+- (NSDictionary *)fb_tree:(nullable NSSet<NSString *> *) excludedAttributes
 {
   id<FBXCElementSnapshot> snapshot = self.fb_isResolvedFromCache.boolValue
     ? self.lastSnapshot
     : [self fb_snapshotWithAllAttributesAndMaxDepth:nil];
-  return [self.class dictionaryForElement:snapshot recursive:YES];
+  return [self.class dictionaryForElement:snapshot recursive:YES excludedAttributes:excludedAttributes];
 }
 
 - (NSDictionary *)fb_accessibilityTree
@@ -167,7 +172,9 @@ NSDictionary<NSNumber *, NSString *> *auditTypeValuesToNames(void) {
   return [self.class accessibilityInfoForElement:snapshot];
 }
 
-+ (NSDictionary *)dictionaryForElement:(id<FBXCElementSnapshot>)snapshot recursive:(BOOL)recursive
++ (NSDictionary *)dictionaryForElement:(id<FBXCElementSnapshot>)snapshot 
+                             recursive:(BOOL)recursive
+                    excludedAttributes:(nullable NSSet<NSString *> *) excludedAttributes
 {
   NSMutableDictionary *info = [[NSMutableDictionary alloc] init];
   info[@"type"] = [FBElementTypeTransformer shortStringWithElementType:snapshot.elementType];
@@ -177,11 +184,35 @@ NSDictionary<NSNumber *, NSString *> *auditTypeValuesToNames(void) {
   info[@"value"] = FBValueOrNull(wrappedSnapshot.wdValue);
   info[@"label"] = FBValueOrNull(wrappedSnapshot.wdLabel);
   info[@"rect"] = wrappedSnapshot.wdRect;
-  info[@"frame"] = NSStringFromCGRect(wrappedSnapshot.wdFrame);
-  info[@"isEnabled"] = [@([wrappedSnapshot isWDEnabled]) stringValue];
-  info[@"isVisible"] = [@([wrappedSnapshot isWDVisible]) stringValue];
-  info[@"isAccessible"] = [@([wrappedSnapshot isWDAccessible]) stringValue];
-  info[@"isFocused"] = [@([wrappedSnapshot isWDFocused]) stringValue];
+  
+  NSDictionary<NSString *, NSString * (^)(void)> *attributeBlocks = @{
+      @"frame": ^{
+          return NSStringFromCGRect(wrappedSnapshot.wdFrame);
+      },
+      @"enabled": ^{
+          return [@([wrappedSnapshot isWDEnabled]) stringValue];
+      },
+      @"visible": ^{
+          return [@([wrappedSnapshot isWDVisible]) stringValue];
+      },
+      @"accessible": ^{
+          return [@([wrappedSnapshot isWDAccessible]) stringValue];
+      },
+      @"focused": ^{
+          return [@([wrappedSnapshot isWDFocused]) stringValue];
+      }
+  };
+
+  for (NSString *key in attributeBlocks) {
+      if (excludedAttributes == nil || ![excludedAttributes containsObject:key]) {
+          NSString *value = ((NSString * (^)(void))attributeBlocks[key])();
+          if ([key isEqualToString:@"frame"]) {
+              info[key] = value;
+          } else {
+              info[[NSString stringWithFormat:@"is%@", [key capitalizedString]]] = value;
+          }
+      }
+  }
 
   if (!recursive) {
     return info.copy;
@@ -191,7 +222,9 @@ NSDictionary<NSNumber *, NSString *> *auditTypeValuesToNames(void) {
   if ([childElements count]) {
     info[@"children"] = [[NSMutableArray alloc] init];
     for (id<FBXCElementSnapshot> childSnapshot in childElements) {
-      [info[@"children"] addObject:[self dictionaryForElement:childSnapshot recursive:YES]];
+      [info[@"children"] addObject:[self dictionaryForElement:childSnapshot 
+                                                    recursive:YES
+                                           excludedAttributes:excludedAttributes]];
     }
   }
   return info;
@@ -379,7 +412,9 @@ NSDictionary<NSNumber *, NSString *> *auditTypeValuesToNames(void) {
     id extractedElement = extractIssueProperty(issue, @"element");
     
     id<FBXCElementSnapshot> elementSnapshot = [extractedElement fb_takeSnapshot];
-    NSDictionary *elementAttributes = elementSnapshot ? [self.class dictionaryForElement:elementSnapshot recursive:NO] : @{};
+    NSDictionary *elementAttributes = elementSnapshot 
+      ? [self.class dictionaryForElement:elementSnapshot recursive:NO excludedAttributes:nil]
+      : @{};
     
     [resultArray addObject:@{
       @"detailedDescription": extractIssueProperty(issue, @"detailedDescription") ?: @"",

package/WebDriverAgentLib/Commands/FBDebugCommands.m

@@ -54,7 +54,12 @@ static NSString *const SOURCE_FORMAT_DESCRIPTION = @"description";
           withExcludedAttributes:excludedAttributes]
          withScope:sourceScope]];
   } else if ([sourceType caseInsensitiveCompare:SOURCE_FORMAT_JSON] == NSOrderedSame) {
-    result = application.fb_tree;
+    NSString *excludedAttributesString = request.parameters[@"excluded_attributes"];
+    NSSet<NSString *> *excludedAttributes = (excludedAttributesString == nil)
+          ? nil
+          : [NSSet setWithArray:[excludedAttributesString componentsSeparatedByString:@","]];
+
+    result = [application fb_tree:excludedAttributes];
   } else if ([sourceType caseInsensitiveCompare:SOURCE_FORMAT_DESCRIPTION] == NSOrderedSame) {
     result = application.fb_descriptionRepresentation;
   } else {

package/WebDriverAgentLib/Info.plist

@@ -15,11 +15,11 @@
     <key>CFBundlePackageType</key>
     <string>FMWK</string>
     <key>CFBundleShortVersionString</key>
-    <string>8.10.1</string>
+    <string>8.11.1</string>
     <key>CFBundleSignature</key>
     <string>????</string>
     <key>CFBundleVersion</key>
-    <string>8.10.1</string>
+    <string>8.11.1</string>
     <key>NSPrincipalClass</key>
     <string/>
   </dict>

package/WebDriverAgentTests/IntegrationTests/XCUIApplicationHelperTests.m

@@ -44,6 +44,13 @@
   XCTAssertNotNil(self.testedApplication.fb_accessibilityTree);
 }
 
+- (void)testApplicationTreeAttributesFiltering
+{
+  NSDictionary *applicationTree = [self.testedApplication fb_tree:[NSSet setWithArray:@[@"visible"]]];
+  XCTAssertNotNil(applicationTree);
+  XCTAssertNil([applicationTree objectForKey:@"isVisible"], @"'isVisible' key should not be present in the application tree");
+}
+
 - (void)testDeactivateApplication
 {
   NSError *error;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "8.10.1",
+  "version": "8.11.1",
   "description": "Package bundling WebDriverAgent",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -76,7 +76,7 @@
     "@appium/base-driver": "^9.0.0",
     "@appium/strongbox": "^0.x",
     "@appium/support": "^5.0.3",
-    "appium-ios-device": "^2.5.0",
+    "appium-ios-device": "^2.7.25",
     "appium-ios-simulator": "^6.0.0",
     "async-lock": "^1.0.0",
     "asyncbox": "^3.0.0",