appium-webdriveragent 9.7.1 → 9.9.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [9.9.0](https://github.com/appium/WebDriverAgent/compare/v9.8.0...v9.9.0) (2025-05-26)
+
+### Features
+
+* Use another snapshotting mechanism for the hittable attribute calculation ([#1022](https://github.com/appium/WebDriverAgent/issues/1022)) ([13c9f45](https://github.com/appium/WebDriverAgent/commit/13c9f453d890ad9b78fa7c47728ebae33880966a))
+
+## [9.8.0](https://github.com/appium/WebDriverAgent/compare/v9.7.1...v9.8.0) (2025-05-21)
+
+### Features
+
+* Add a native frame property of the element ([#1017](https://github.com/appium/WebDriverAgent/issues/1017)) ([09214c4](https://github.com/appium/WebDriverAgent/commit/09214c4228ed5a49c02adead452cb0bb8dd83b6d))
+
 ## [9.7.1](https://github.com/appium/WebDriverAgent/compare/v9.7.0...v9.7.1) (2025-05-21)
 
 ### Miscellaneous Chores

package/WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.m

@@ -47,7 +47,7 @@ static NSString* const FBExclusionAttributeVisible = @"visible";
 static NSString* const FBExclusionAttributeAccessible = @"accessible";
 static NSString* const FBExclusionAttributeFocused = @"focused";
 static NSString* const FBExclusionAttributePlaceholderValue = @"placeholderValue";
-
+static NSString* const FBExclusionAttributeNativeFrame = @"nativeFrame";
 
 _Nullable id extractIssueProperty(id issue, NSString *propertyName) {
   SEL selector = NSSelectorFromString(propertyName);
@@ -205,8 +205,11 @@ NSDictionary<NSString *, NSString *> *customExclusionAttributesMap(void) {
   
   NSDictionary<NSString *, NSString *(^)(void)> *attributeBlocks = [self fb_attributeBlockMapForWrappedSnapshot:wrappedSnapshot];
 
-  NSSet *nonPrefixedKeys = [NSSet setWithObjects:FBExclusionAttributeFrame,
-                            FBExclusionAttributePlaceholderValue, nil];
+  NSSet *nonPrefixedKeys = [NSSet setWithObjects:
+                            FBExclusionAttributeFrame,
+                            FBExclusionAttributePlaceholderValue,
+                            FBExclusionAttributeNativeFrame,
+                            nil];
 
   for (NSString *key in attributeBlocks) {
       if (excludedAttributes == nil || ![excludedAttributes containsObject:key]) {
@@ -247,6 +250,9 @@ NSDictionary<NSString *, NSString *> *customExclusionAttributesMap(void) {
   [@{
     FBExclusionAttributeFrame: ^{
     return NSStringFromCGRect(wrappedSnapshot.wdFrame);
+  },
+    FBExclusionAttributeNativeFrame: ^{
+    return NSStringFromCGRect(wrappedSnapshot.wdNativeFrame);
   },
     FBExclusionAttributeEnabled: ^{
     return [@([wrappedSnapshot isWDEnabled]) stringValue];

package/WebDriverAgentLib/Categories/XCUIElement+FBUtilities.h

@@ -36,7 +36,7 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  Gets the most recent snapshot of the current element. The element will be
  automatically resolved if the snapshot is not available yet.
- Calls to this method mutate the `lastSnapshot` instance property..
+ Calls to this method mutate the `lastSnapshot` instance property.
  The maximum snapshot tree depth is set by `FBConfiguration.snapshotMaxDepth`
 
  Snapshot specifics:
@@ -49,6 +49,21 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (id<FBXCElementSnapshot>)fb_customSnapshot;
 
+/**
+ Gets the most recent snapshot of the current element. The element will be
+ automatically resolved if the snapshot is not available yet.
+ Calls to this method mutate the `lastSnapshot` instance property.
+ The maximum snapshot tree depth is set by `FBConfiguration.snapshotMaxDepth`
+
+ Snapshot specifics:
+ - Less performant in comparison to the standard one
+ - The `hittable` property calculation is aligned with the native calculation logic
+
+ @return The recent snapshot of the element
+ @throws FBStaleElementException if the element is not present in DOM and thus no snapshot could be made
+ */
+- (id<FBXCElementSnapshot>)fb_nativeSnapshot;
+
 /**
  Extracts the cached element snapshot from its query.
  No requests to the accessiblity framework is made.

package/WebDriverAgentLib/Categories/XCUIElement+FBUtilities.m

@@ -53,16 +53,7 @@
       ? [self.fb_query fb_uniqueSnapshotWithError:&error]
       : (id<FBXCElementSnapshot>)[self snapshotWithError:&error];
     if (nil == snapshot) {
-      NSString *hintText = @"Make sure the application UI has the expected state";
-      if (nil != error && [error.localizedDescription containsString:@"Identity Binding"]) {
-        hintText = [NSString stringWithFormat:@"%@. You could also try to switch the binding strategy using the 'boundElementsByIndex' setting for the element lookup", hintText];
-      }
-      NSString *reason = [NSString stringWithFormat:@"The previously found element \"%@\" is not present in the current view anymore. %@",
-                          self.description, hintText];
-      if (nil != error) {
-        reason = [NSString stringWithFormat:@"%@. Original error: %@", reason, error.localizedDescription];
-      }
-      @throw [NSException exceptionWithName:FBStaleElementException reason:reason userInfo:@{}];
+      [self fb_raiseStaleElementExceptionWithError:error];
     }
   }
   self.lastSnapshot = snapshot;
@@ -79,6 +70,16 @@
   return [self fb_takeSnapshot:YES];
 }
 
+- (id<FBXCElementSnapshot>)fb_nativeSnapshot
+{
+  NSError *error = nil;
+  BOOL isSuccessful = [self resolveOrRaiseTestFailure:NO error:&error];
+  if (nil == self.lastSnapshot || !isSuccessful) {
+    [self fb_raiseStaleElementExceptionWithError:error];
+  }
+  return self.lastSnapshot;
+}
+
 - (id<FBXCElementSnapshot>)fb_cachedSnapshot
 {
   return [self.query fb_cachedSnapshot];
@@ -153,4 +154,18 @@
   FBConfiguration.waitForIdleTimeout = previousTimeout;
 }
 
+- (void)fb_raiseStaleElementExceptionWithError:(NSError *)error __attribute__((noreturn))
+{
+  NSString *hintText = @"Make sure the application UI has the expected state";
+  if (nil != error && [error.localizedDescription containsString:@"Identity Binding"]) {
+    hintText = [NSString stringWithFormat:@"%@. You could also try to switch the binding strategy using the 'boundElementsByIndex' setting for the element lookup", hintText];
+  }
+  NSString *reason = [NSString stringWithFormat:@"The previously found element \"%@\" is not present in the current view anymore. %@",
+                      self.description, hintText];
+  if (nil != error) {
+    reason = [NSString stringWithFormat:@"%@. Original error: %@", reason, error.localizedDescription];
+  }
+  @throw [NSException exceptionWithName:FBStaleElementException reason:reason userInfo:@{}];
+}
+
 @end

package/WebDriverAgentLib/Categories/XCUIElement+FBWebDriverAttributes.m

@@ -29,6 +29,10 @@
 
 - (id<FBXCElementSnapshot>)fb_snapshotForAttributeName:(NSString *)name
 {
+  // https://github.com/appium/appium-xcuitest-driver/pull/2565
+  if ([name isEqualToString:FBStringify(XCUIElement, isWDHittable)]) {
+    return [self fb_nativeSnapshot];
+  }
   // https://github.com/appium/appium-xcuitest-driver/issues/2552
   BOOL isValueRequest = [name isEqualToString:FBStringify(XCUIElement, wdValue)];
   if ([self isKindOfClass:XCUIApplication.class] && !isValueRequest) {
@@ -147,6 +151,14 @@
     : CGRectIntegral(frame);
 }
 
+- (CGRect)wdNativeFrame
+{
+  // To avoid confusion regarding the frame returned by `wdFrame`,
+  // the current property is provided to represent the element's
+  // actual rendered frame.
+  return self.frame;
+}
+
 - (BOOL)isWDVisible
 {
   return self.fb_isVisible;

package/WebDriverAgentLib/Info.plist

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

package/WebDriverAgentLib/Routing/FBElement.h

@@ -20,6 +20,9 @@ NS_ASSUME_NONNULL_BEGIN
 /*! Element's frame in normalized (rounded dimensions without Infinity values) CGRect format */
 @property (nonatomic, readonly, assign) CGRect wdFrame;
 
+/*! Represents the element's frame as a CGRect, preserving the actual values. */
+@property (nonatomic, readonly, assign) CGRect wdNativeFrame;
+
 /*! Element's wsFrame in NSDictionary format */
 @property (nonatomic, readonly, copy) NSDictionary *wdRect;
 

package/WebDriverAgentTests/IntegrationTests/FBElementAttributeTests.m

@@ -16,7 +16,6 @@
 #import "XCUIElement+FBAccessibility.h"
 #import "XCUIElement+FBIsVisible.h"
 #import "XCUIElement+FBWebDriverAttributes.h"
-#import "FBXCodeCompatibility.h"
 
 @interface FBElementAttributeTests : FBIntegrationTestCase
 @end
@@ -157,7 +156,7 @@
   XCTAssertNil(element.wdPlaceholderValue);
   XCTAssertEqualObjects(element.wdValue, @"1");
   XCTAssertFalse(element.wdSelected);
-  XCTAssertTrue(element.wdHittable);
+  XCTAssertEqual(element.wdHittable, element.hittable);
   [element tap];
   XCTAssertEqualObjects(element.wdValue, @"0");
   XCTAssertFalse(element.wdSelected);

package/WebDriverAgentTests/IntegrationTests/FBScrollingTests.m

@@ -15,7 +15,6 @@
 #import "FBMacros.h"
 #import "XCUIElement+FBIsVisible.h"
 #import "XCUIElement+FBScrolling.h"
-
 #import "XCUIElement+FBClassChain.h"
 #import "FBXCodeCompatibility.h"
 
@@ -43,8 +42,12 @@
 {
   FBAssertVisibleCell(@"0");
   FBAssertVisibleCell(@"10");
+  XCUIElement *cell10 = FBCellElementWithLabel(@"10");
+  XCTAssertEqual([cell10 isWDHittable], [cell10 isHittable]);
   FBAssertInvisibleCell(@"30");
   FBAssertInvisibleCell(@"50");
+  XCUIElement *cell50 = FBCellElementWithLabel(@"50");
+  XCTAssertEqual([cell50 isWDHittable], [cell50 isHittable]);
 }
 
 - (void)testSimpleScroll

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "9.7.1",
+  "version": "9.9.0",
   "description": "Package bundling WebDriverAgent",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",