appium-webdriveragent 5.7.0 → 5.8.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [5.8.0](https://github.com/appium/WebDriverAgent/compare/v5.7.0...v5.8.0) (2023-08-24)
+
+
+### Features
+
+* Add wdHittable property ([#756](https://github.com/appium/WebDriverAgent/issues/756)) ([075298b](https://github.com/appium/WebDriverAgent/commit/075298b286c83ab5d4a2855e9e0bb915790b3f43))
+
 ## [5.7.0](https://github.com/appium/WebDriverAgent/compare/v5.6.2...v5.7.0) (2023-08-24)
 
 

package/WebDriverAgentLib/Categories/XCUIElement+FBWebDriverAttributes.m

@@ -20,6 +20,7 @@
 #import "XCUIElement+FBUtilities.h"
 #import "FBElementUtils.h"
 #import "XCTestPrivateSymbols.h"
+#import "XCUIHitPointResult.h"
 
 #define BROKEN_RECT CGRectMake(-1, -1, 0, 0)
 
@@ -226,6 +227,12 @@
   return 0;
 }
 
+- (BOOL)isWDHittable
+{
+  XCUIHitPointResult *result = [self hitPoint:nil];
+  return nil == result ? NO : result.hittable;
+}
+
 - (NSDictionary *)wdRect
 {
   CGRect frame = self.wdFrame;

package/WebDriverAgentLib/Routing/FBElement.h

@@ -56,6 +56,9 @@ NS_ASSUME_NONNULL_BEGIN
 /*! Whether element is focused */
 @property (nonatomic, readonly, getter = isWDFocused) BOOL wdFocused;
 
+/*! Whether element is hittable */
+@property (nonatomic, readonly, getter = isWDHittable) BOOL wdHittable;
+
 /*! Element's index relatively to its parent. Starts from zero */
 @property (nonatomic, readonly) NSUInteger wdIndex;
 

package/WebDriverAgentLib/Utilities/FBMacros.h

@@ -52,3 +52,7 @@
 
 /*! Converts the given number of milliseconds into seconds */
 #define FBMillisToSeconds(ms) ((ms) / 1000.0)
+
+/*! Converts boolean value to its string representation */
+#define FBBoolToString(b) ((b) ? @"true" : @"false")
+

package/WebDriverAgentLib/Utilities/FBXPath.m

@@ -12,6 +12,7 @@
 #import "FBConfiguration.h"
 #import "FBExceptions.h"
 #import "FBLogger.h"
+#import "FBMacros.h"
 #import "FBXMLGenerationOptions.h"
 #import "FBXCElementSnapshotWrapper+Helpers.h"
 #import "NSString+FBXMLSafeString.h"
@@ -87,6 +88,10 @@
 
 @end
 
+@interface FBHittableAttribute : FBElementAttribute
+
+@end
+
 @interface FBInternalIndexAttribute : FBElementAttribute
 
 @property (nonatomic, nonnull, readonly) NSString* indexValue;
@@ -273,6 +278,9 @@ static NSString *const topNodeIndexPath = @"top";
   NSMutableSet<Class> *includedAttributes;
   if (nil == query) {
     includedAttributes = [NSMutableSet setWithArray:FBElementAttribute.supportedAttributes];
+    // The hittable attribute is expensive to calculate for each snapshot item
+    // thus we only include it when requested by an xPath query
+    [includedAttributes removeObject:FBHittableAttribute.class];
     if (nil != excludedAttributes) {
       for (NSString *excludedAttributeName in excludedAttributes) {
         for (Class supportedAttribute in FBElementAttribute.supportedAttributes) {
@@ -481,6 +489,7 @@ static NSString *const FBAbstractMethodInvocationException = @"AbstractMethodInv
            FBWidthAttribute.class,
            FBHeightAttribute.class,
            FBIndexAttribute.class,
+           FBHittableAttribute.class,
           ];
 }
 
@@ -557,7 +566,7 @@ static NSString *const FBAbstractMethodInvocationException = @"AbstractMethodInv
 
 + (NSString *)valueForElement:(id<FBElement>)element
 {
-  return element.wdEnabled ? @"true" : @"false";
+  return FBBoolToString(element.wdEnabled);
 }
 
 @end
@@ -571,7 +580,7 @@ static NSString *const FBAbstractMethodInvocationException = @"AbstractMethodInv
 
 + (NSString *)valueForElement:(id<FBElement>)element
 {
-  return element.wdVisible ? @"true" : @"false";
+  return FBBoolToString(element.wdVisible);
 }
 
 @end
@@ -585,7 +594,7 @@ static NSString *const FBAbstractMethodInvocationException = @"AbstractMethodInv
 
 + (NSString *)valueForElement:(id<FBElement>)element
 {
-  return element.wdAccessible ? @"true" : @"false";
+  return FBBoolToString(element.wdAccessible);
 }
 
 @end
@@ -601,7 +610,7 @@ static NSString *const FBAbstractMethodInvocationException = @"AbstractMethodInv
 
 + (NSString *)valueForElement:(id<FBElement>)element
 {
-  return element.wdFocused ? @"true" : @"false";
+  return FBBoolToString(element.wdFocused);
 }
 
 @end
@@ -667,6 +676,20 @@ static NSString *const FBAbstractMethodInvocationException = @"AbstractMethodInv
 
 @end
 
+@implementation FBHittableAttribute
+
++ (NSString *)name
+{
+  return @"hittable";
+}
+
++ (NSString *)valueForElement:(id<FBElement>)element
+{
+  return FBBoolToString(element.wdHittable);
+}
+
+@end
+
 @implementation FBInternalIndexAttribute
 
 + (NSString *)name

package/WebDriverAgentTests/IntegrationTests/FBElementAttributeTests.m

@@ -160,6 +160,7 @@
   XCTAssertNil(element.wdLabel);
   XCTAssertEqualObjects(element.wdValue, @"1");
   XCTAssertFalse(element.wdSelected);
+  XCTAssertTrue(element.wdHittable);
   [element tap];
   XCTAssertEqualObjects(element.wdValue, @"0");
   XCTAssertFalse(element.wdSelected);

package/WebDriverAgentTests/IntegrationTests/FBXPathIntegrationTests.m

@@ -10,6 +10,7 @@
 #import <XCTest/XCTest.h>
 
 #import "FBIntegrationTestCase.h"
+#import "FBMacros.h"
 #import "FBTestMacros.h"
 #import "FBXPath.h"
 #import "FBXCodeCompatibility.h"
@@ -58,7 +59,7 @@
   NSString *xmlStr = [FBXPath xmlStringWithRootElement:wrappedSnapshot
                                                options:nil];
   XCTAssertNotNil(xmlStr);
-  NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@ type=\"%@\" name=\"%@\" label=\"%@\" enabled=\"%@\" visible=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\" index=\"%lu\"/>\n", wrappedSnapshot.wdType, wrappedSnapshot.wdType, wrappedSnapshot.wdName, wrappedSnapshot.wdLabel, wrappedSnapshot.wdEnabled ? @"true" : @"false", wrappedSnapshot.wdVisible ? @"true" : @"false", wrappedSnapshot.wdAccessible ? @"true" : @"false", [wrappedSnapshot.wdRect[@"x"] stringValue], [wrappedSnapshot.wdRect[@"y"] stringValue], [wrappedSnapshot.wdRect[@"width"] stringValue], [wrappedSnapshot.wdRect[@"height"] stringValue], wrappedSnapshot.wdIndex];
+  NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@ type=\"%@\" name=\"%@\" label=\"%@\" enabled=\"%@\" visible=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\" index=\"%lu\"/>\n", wrappedSnapshot.wdType, wrappedSnapshot.wdType, wrappedSnapshot.wdName, wrappedSnapshot.wdLabel, FBBoolToString(wrappedSnapshot.wdEnabled), FBBoolToString(wrappedSnapshot.wdVisible), FBBoolToString(wrappedSnapshot.wdAccessible), [wrappedSnapshot.wdRect[@"x"] stringValue], [wrappedSnapshot.wdRect[@"y"] stringValue], [wrappedSnapshot.wdRect[@"width"] stringValue], [wrappedSnapshot.wdRect[@"height"] stringValue], wrappedSnapshot.wdIndex];
   XCTAssertEqualObjects(xmlStr, expectedXml);
 }
 
@@ -71,7 +72,7 @@
   NSString *xmlStr = [FBXPath xmlStringWithRootElement:wrappedSnapshot
                                                options:options];
   XCTAssertNotNil(xmlStr);
-  NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@>\n  <%@ type=\"%@\" name=\"%@\" label=\"%@\" enabled=\"%@\" visible=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\" index=\"%lu\"/>\n</%@>\n", scope, wrappedSnapshot.wdType, wrappedSnapshot.wdType, wrappedSnapshot.wdName, wrappedSnapshot.wdLabel, wrappedSnapshot.wdEnabled ? @"true" : @"false", wrappedSnapshot.wdVisible ? @"true" : @"false", wrappedSnapshot.wdAccessible ? @"true" : @"false", [wrappedSnapshot.wdRect[@"x"] stringValue], [wrappedSnapshot.wdRect[@"y"] stringValue], [wrappedSnapshot.wdRect[@"width"] stringValue], [wrappedSnapshot.wdRect[@"height"] stringValue], wrappedSnapshot.wdIndex, scope];
+  NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@>\n  <%@ type=\"%@\" name=\"%@\" label=\"%@\" enabled=\"%@\" visible=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\" index=\"%lu\"/>\n</%@>\n", scope, wrappedSnapshot.wdType, wrappedSnapshot.wdType, wrappedSnapshot.wdName, wrappedSnapshot.wdLabel, FBBoolToString(wrappedSnapshot.wdEnabled), FBBoolToString(wrappedSnapshot.wdVisible), FBBoolToString(wrappedSnapshot.wdAccessible), [wrappedSnapshot.wdRect[@"x"] stringValue], [wrappedSnapshot.wdRect[@"y"] stringValue], [wrappedSnapshot.wdRect[@"width"] stringValue], [wrappedSnapshot.wdRect[@"height"] stringValue], wrappedSnapshot.wdIndex, scope];
   XCTAssertEqualObjects(xmlStr, expectedXml);
 }
 
@@ -84,7 +85,7 @@
   NSString *xmlStr = [FBXPath xmlStringWithRootElement:wrappedSnapshot
                                                options:options];
   XCTAssertNotNil(xmlStr);
-  NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@ type=\"%@\" name=\"%@\" label=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\"/>\n", wrappedSnapshot.wdType, wrappedSnapshot.wdType, wrappedSnapshot.wdName, wrappedSnapshot.wdLabel, wrappedSnapshot.wdAccessible ? @"true" : @"false", [wrappedSnapshot.wdRect[@"x"] stringValue], [wrappedSnapshot.wdRect[@"y"] stringValue], [wrappedSnapshot.wdRect[@"width"] stringValue], [wrappedSnapshot.wdRect[@"height"] stringValue]];
+  NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@ type=\"%@\" name=\"%@\" label=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\"/>\n", wrappedSnapshot.wdType, wrappedSnapshot.wdType, wrappedSnapshot.wdName, wrappedSnapshot.wdLabel, FBBoolToString(wrappedSnapshot.wdAccessible), [wrappedSnapshot.wdRect[@"x"] stringValue], [wrappedSnapshot.wdRect[@"y"] stringValue], [wrappedSnapshot.wdRect[@"width"] stringValue], [wrappedSnapshot.wdRect[@"height"] stringValue]];
   XCTAssertEqualObjects(xmlStr, expectedXml);
 }
 

package/WebDriverAgentTests/IntegrationTests/XCUIElementFBFindTests.m

@@ -127,7 +127,7 @@
 
 - (void)testSingleDescendantWithXPathQuery
 {
-  NSArray<XCUIElement *> *matchingSnapshots = [self.testedApplication fb_descendantsMatchingXPathQuery:@"//XCUIElementTypeButton"
+  NSArray<XCUIElement *> *matchingSnapshots = [self.testedApplication fb_descendantsMatchingXPathQuery:@"//XCUIElementTypeButton[@hittable='true']"
                                                                            shouldReturnAfterFirstMatch:YES];
   XCTAssertEqual(matchingSnapshots.count, 1);
   XCUIElement *matchingSnapshot = [matchingSnapshots firstObject];

package/WebDriverAgentTests/UnitTests/Doubles/XCElementSnapshotDouble.m

@@ -11,6 +11,7 @@
 
 #import "FBXCAccessibilityElement.h"
 #import "FBXCElementSnapshot.h"
+#import "XCUIHitPointResult.h"
 
 @implementation XCElementSnapshotDouble
 
@@ -87,6 +88,11 @@
   return nil;
 }
 
+- (XCUIHitPointResult *)hitPoint:(NSError **)error
+{
+  return [[XCUIHitPointResult alloc] initWithHitPoint:CGPointZero hittable:YES];
+}
+
 - (NSArray *)children
 {
   return @[];

package/WebDriverAgentTests/UnitTests/Doubles/XCUIElementDouble.h

@@ -32,6 +32,8 @@
 @property (nonatomic, readwrite) NSUInteger wdIndex;
 @property (nonatomic, readwrite, getter=isWDVisible) BOOL wdVisible;
 @property (nonatomic, readwrite, getter=isWDAccessible) BOOL wdAccessible;
+@property (nonatomic, readwrite, getter = isWDFocused) BOOL wdFocused;
+@property (nonatomic, readwrite, getter = isWDHittable) BOOL wdHittable;
 @property (copy, nonnull) NSArray *children;
 @property (nonatomic, readwrite, assign) XCUIElementType elementType;
 @property (nonatomic, readwrite, getter=isWDAccessibilityContainer) BOOL wdAccessibilityContainer;

package/WebDriverAgentTests/UnitTests/Doubles/XCUIElementDouble.m

@@ -27,6 +27,8 @@
     self.wdAccessible = YES;
     self.wdEnabled = YES;
     self.wdSelected = YES;
+    self.wdFocused = YES;
+    self.wdHittable = YES;
     self.wdIndex = 0;
 #if TARGET_OS_TV
     self.wdFocused = YES;

package/WebDriverAgentTests/UnitTests/FBXPathTests.m

@@ -9,6 +9,7 @@
 
 #import <XCTest/XCTest.h>
 
+#import "FBMacros.h"
 #import "FBXPath.h"
 #import "FBXPath-Private.h"
 #import "XCUIElementDouble.h"
@@ -63,7 +64,7 @@
                                         xpathQuery:nil
                                excludingAttributes:nil];
   NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@ type=\"%@\" value=\"%@\" name=\"%@\" label=\"%@\" enabled=\"%@\" visible=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\" index=\"%lu\" private_indexPath=\"top\"/>\n",
-                           element.wdType, element.wdType, element.wdValue, element.wdName, element.wdLabel, element.wdEnabled ? @"true" : @"false", element.wdVisible ? @"true" : @"false", element.wdAccessible ? @"true" : @"false", element.wdRect[@"x"], element.wdRect[@"y"], element.wdRect[@"width"], element.wdRect[@"height"], element.wdIndex];
+                           element.wdType, element.wdType, element.wdValue, element.wdName, element.wdLabel, FBBoolToString(element.wdEnabled), FBBoolToString(element.wdVisible), FBBoolToString(element.wdAccessible), element.wdRect[@"x"], element.wdRect[@"y"], element.wdRect[@"width"], element.wdRect[@"height"], element.wdIndex];
   XCTAssertTrue([resultXml isEqualToString: expectedXml]);
 }
 
@@ -75,7 +76,7 @@
                                         xpathQuery:nil
                                excludingAttributes:@[@"type", @"visible", @"value", @"index"]];
   NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@ name=\"%@\" label=\"%@\" enabled=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\" private_indexPath=\"top\"/>\n",
-                           element.wdType, element.wdName, element.wdLabel,  element.wdEnabled ? @"true" : @"false", element.wdAccessible ? @"true" : @"false", element.wdRect[@"x"], element.wdRect[@"y"], element.wdRect[@"width"], element.wdRect[@"height"]];
+                           element.wdType, element.wdName, element.wdLabel, FBBoolToString(element.wdEnabled), FBBoolToString(element.wdAccessible), element.wdRect[@"x"], element.wdRect[@"y"], element.wdRect[@"width"], element.wdRect[@"height"]];
   XCTAssertEqualObjects(resultXml, expectedXml);
 }
 
@@ -88,9 +89,9 @@
   NSString *resultXml = [self xmlStringWithElement:element
                                         xpathQuery:[NSString stringWithFormat:@"//%@[@*]", element.wdType]
                                excludingAttributes:@[@"visible"]];
-  NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@ type=\"%@\" value=\"%@\" name=\"%@\" label=\"%@\" enabled=\"%@\" visible=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\" index=\"%lu\" private_indexPath=\"top\"/>\n",
-                           element.wdType, element.wdType, @"йоло&lt;&gt;&amp;&quot;", element.wdName, @"a&#10;b", element.wdEnabled ? @"true" : @"false", element.wdVisible ? @"true" : @"false", element.wdAccessible ? @"true" : @"false", element.wdRect[@"x"], element.wdRect[@"y"], element.wdRect[@"width"], element.wdRect[@"height"], element.wdIndex];
-  XCTAssertTrue([resultXml isEqualToString:expectedXml]);
+  NSString *expectedXml = [NSString stringWithFormat:@"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<%@ type=\"%@\" value=\"%@\" name=\"%@\" label=\"%@\" enabled=\"%@\" visible=\"%@\" accessible=\"%@\" x=\"%@\" y=\"%@\" width=\"%@\" height=\"%@\" index=\"%lu\" hittable=\"%@\" private_indexPath=\"top\"/>\n",
+                           element.wdType, element.wdType, @"йоло&lt;&gt;&amp;&quot;", element.wdName, @"a&#10;b", FBBoolToString(element.wdEnabled), FBBoolToString(element.wdVisible), FBBoolToString(element.wdAccessible), element.wdRect[@"x"], element.wdRect[@"y"], element.wdRect[@"width"], element.wdRect[@"height"], element.wdIndex, FBBoolToString(element.wdHittable)];
+  XCTAssertEqualObjects(expectedXml, resultXml);
 }
 
 - (void)testXPathPresentationBasedOnQueryMatchingSomeAttributes

package/WebDriverAgentTests/UnitTests_tvOS/Doubles/XCUIElementDouble.h

@@ -32,6 +32,7 @@
 @property (nonatomic, readwrite, getter=isWDVisible) BOOL wdVisible;
 @property (nonatomic, readwrite, getter=isWDAccessible) BOOL wdAccessible;
 @property (nonatomic, readwrite, getter=isWDFocused) BOOL wdFocused;
+@property (nonatomic, readwrite, getter = isWDHittable) BOOL wdHittable;
 @property (copy, nonnull) NSArray *children;
 @property (nonatomic, readwrite, assign) XCUIElementType elementType;
 @property (nonatomic, readwrite, getter=isWDAccessibilityContainer) BOOL wdAccessibilityContainer;

package/WebDriverAgentTests/UnitTests_tvOS/Doubles/XCUIElementDouble.m

@@ -27,6 +27,7 @@
     self.wdAccessible = YES;
     self.wdEnabled = YES;
     self.wdSelected = YES;
+    self.wdHittable = YES;
     self.wdIndex = 0;
 #if TARGET_OS_TV
     self.wdFocused = YES;

package/build/lib/constants.d.ts

@@ -8,5 +8,5 @@ export const SDK_SIMULATOR: "iphonesimulator";
 export const SDK_DEVICE: "iphoneos";
 export const WDA_BASE_URL: "http://127.0.0.1";
 export const WDA_UPGRADE_TIMESTAMP_PATH: string;
-export const WDA_RUNNER_BUNDLE_ID_FOR_XCTEST: string;
+export const WDA_RUNNER_BUNDLE_ID_FOR_XCTEST: "com.facebook.WebDriverAgentRunner.xctrunner";
 //# sourceMappingURL=constants.d.ts.map

package/build/lib/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.js"],"names":[],"mappings":"AAEA,uEAAiE;AAEjE,+DAAyD;AAEzD,6CAAuC;AADvC,gDAA0C;AAI1C,wCAAkC;AAClC,sCAAgC;AAEhC,8CAAwC;AACxC,oCAA8B;AAN9B,8CAAwC;AAQxC,gDAA0F;AAZ1F,qDAA4E"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.js"],"names":[],"mappings":"AAEA,uEAAiE;AAEjE,+DAAyD;AAEzD,6CAAuC;AADvC,gDAA0C;AAI1C,wCAAkC;AAClC,sCAAgC;AAEhC,8CAAwC;AACxC,oCAA8B;AAN9B,8CAAwC;AAQxC,gDAA0F;AAZ1F,4FAA4E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "5.7.0",
+  "version": "5.8.0",
   "description": "Package bundling WebDriverAgent",
   "main": "./build/index.js",
   "scripts": {