appium-webdriveragent 9.5.2 → 9.6.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [9.6.0](https://github.com/appium/WebDriverAgent/compare/v9.5.2...v9.6.0) (2025-04-20)
+
+### Features
+
+* Split custom and standard snapshotting methods ([#1008](https://github.com/appium/WebDriverAgent/issues/1008)) ([8358856](https://github.com/appium/WebDriverAgent/commit/8358856f5968977b13d5cbdafac97f3053dae56e))
+
 ## [9.5.2](https://github.com/appium/WebDriverAgent/compare/v9.5.1...v9.5.2) (2025-04-19)
 
 ### Bug Fixes

package/WebDriverAgentLib/Categories/XCUIApplication+FBAlert.m

@@ -52,7 +52,7 @@ NSString *const FB_SAFARI_APP_NAME = @"Safari";
   // and conatins at least one text view
   __block NSUInteger buttonsCount = 0;
   __block NSUInteger textViewsCount = 0;
-  id<FBXCElementSnapshot> snapshot = candidate.fb_cachedSnapshot ?: [candidate fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> snapshot = candidate.fb_cachedSnapshot ?: [candidate fb_customSnapshot];
   [snapshot enumerateDescendantsUsingBlock:^(id<FBXCElementSnapshot> descendant) {
     XCUIElementType curType = descendant.elementType;
     if (curType == XCUIElementTypeButton) {
@@ -73,7 +73,7 @@ NSString *const FB_SAFARI_APP_NAME = @"Safari";
   if (nil == alert) {
     return nil;
   }
-  id<FBXCElementSnapshot> alertSnapshot = alert.fb_cachedSnapshot ?: [alert fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> alertSnapshot = alert.fb_cachedSnapshot ?: [alert fb_customSnapshot];
 
   if (alertSnapshot.elementType == XCUIElementTypeAlert) {
     return alert;

package/WebDriverAgentLib/Categories/XCUIApplication+FBHelpers.m

@@ -176,7 +176,7 @@ NSDictionary<NSString *, NSString *> *customExclusionAttributesMap(void) {
 
 - (NSDictionary *)fb_tree:(nullable NSSet<NSString *> *)excludedAttributes
 {
-  id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> snapshot = [self fb_standardSnapshot];
   return [self.class dictionaryForElement:snapshot
                                 recursive:YES
                        excludedAttributes:excludedAttributes];
@@ -184,7 +184,7 @@ NSDictionary<NSString *, NSString *> *customExclusionAttributesMap(void) {
 
 - (NSDictionary *)fb_accessibilityTree
 {
-  id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> snapshot = [self fb_standardSnapshot];
   return [self.class accessibilityInfoForElement:snapshot];
 }
 
@@ -434,7 +434,7 @@ NSDictionary<NSString *, NSString *> *customExclusionAttributesMap(void) {
       
       id extractedElement = extractIssueProperty(issue, @"element");
       
-      id<FBXCElementSnapshot> elementSnapshot = [extractedElement fb_cachedSnapshot] ?: [extractedElement fb_takeSnapshot:NO];
+      id<FBXCElementSnapshot> elementSnapshot = [extractedElement fb_cachedSnapshot] ?: [extractedElement fb_standardSnapshot];
       NSDictionary *elementAttributes = elementSnapshot
       ? [self.class dictionaryForElement:elementSnapshot
                                recursive:NO

package/WebDriverAgentLib/Categories/XCUIElement+FBAccessibility.m

@@ -18,7 +18,7 @@
 
 - (BOOL)fb_isAccessibilityElement
 {
-  id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:NO];
+  id<FBXCElementSnapshot> snapshot = [self fb_standardSnapshot];
   return [FBXCElementSnapshotWrapper ensureWrapped:snapshot].fb_isAccessibilityElement;
 }
 

package/WebDriverAgentLib/Categories/XCUIElement+FBIsVisible.m

@@ -26,7 +26,7 @@ NSNumber* _Nullable fetchSnapshotVisibility(id<FBXCElementSnapshot> snapshot)
 - (BOOL)fb_isVisible
 {
   @autoreleasepool {
-    id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:NO];
+    id<FBXCElementSnapshot> snapshot = [self fb_standardSnapshot];
     return [FBXCElementSnapshotWrapper ensureWrapped:snapshot].fb_isVisible;
   }
 }

package/WebDriverAgentLib/Categories/XCUIElement+FBPickerWheel.m

@@ -24,7 +24,7 @@ static const NSTimeInterval VALUE_CHANGE_TIMEOUT = 2;
 
 - (BOOL)fb_scrollWithOffset:(CGFloat)relativeHeightOffset error:(NSError **)error
 {
-  id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:NO];
+  id<FBXCElementSnapshot> snapshot = [self fb_standardSnapshot];
   NSString *previousValue = snapshot.value;
   XCUICoordinate *startCoord = [self coordinateWithNormalizedOffset:CGVectorMake(0.5, 0.5)];
   XCUICoordinate *endCoord = [startCoord coordinateWithOffset:CGVectorMake(0.0, relativeHeightOffset * snapshot.frame.size.height)];

package/WebDriverAgentLib/Categories/XCUIElement+FBScrolling.m

@@ -49,35 +49,35 @@ const CGFloat FBScrollTouchProportion = 0.75f;
 
 - (BOOL)fb_nativeScrollToVisibleWithError:(NSError **)error
 {
-  id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> snapshot = [self fb_customSnapshot];
   return nil != [self _hitPointByAttemptingToScrollToVisibleSnapshot:snapshot
                                                                error:error];
 }
 
 - (void)fb_scrollUpByNormalizedDistance:(CGFloat)distance
 {
-  id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> snapshot = [self fb_customSnapshot];
   [[FBXCElementSnapshotWrapper ensureWrapped:snapshot] fb_scrollUpByNormalizedDistance:distance
                                                                          inApplication:self.application];
 }
 
 - (void)fb_scrollDownByNormalizedDistance:(CGFloat)distance
 {
-  id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> snapshot = [self fb_customSnapshot];
   [[FBXCElementSnapshotWrapper ensureWrapped:snapshot] fb_scrollDownByNormalizedDistance:distance
                                                                            inApplication:self.application];
 }
 
 - (void)fb_scrollLeftByNormalizedDistance:(CGFloat)distance
 {
-  id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> snapshot = [self fb_customSnapshot];
   [[FBXCElementSnapshotWrapper ensureWrapped:snapshot] fb_scrollLeftByNormalizedDistance:distance
                                                                            inApplication:self.application];
 }
 
 - (void)fb_scrollRightByNormalizedDistance:(CGFloat)distance
 {
-  id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> snapshot = [self fb_customSnapshot];
   [[FBXCElementSnapshotWrapper ensureWrapped:snapshot] fb_scrollRightByNormalizedDistance:distance
                                                                             inApplication:self.application];
 }
@@ -99,7 +99,7 @@ const CGFloat FBScrollTouchProportion = 0.75f;
                                        scrollDirection:(FBXCUIElementScrollDirection)scrollDirection
                                                  error:(NSError **)error
 {
-  FBXCElementSnapshotWrapper *prescrollSnapshot = [FBXCElementSnapshotWrapper ensureWrapped:[self fb_takeSnapshot:YES]];
+  FBXCElementSnapshotWrapper *prescrollSnapshot = [FBXCElementSnapshotWrapper ensureWrapped:[self fb_customSnapshot]];
 
   if (prescrollSnapshot.isWDVisible) {
     return YES;
@@ -209,7 +209,7 @@ const CGFloat FBScrollTouchProportion = 0.75f;
   // Cell is now visible, but it might be only partialy visible, scrolling till whole frame is visible.
   // Sometimes, attempting to grab the parent snapshot of the target cell after scrolling is complete causes a stale element reference exception.
   // Trying fb_cachedSnapshot first
-  FBXCElementSnapshotWrapper *targetCellSnapshotWrapped = [FBXCElementSnapshotWrapper ensureWrapped:[self fb_takeSnapshot:YES]];
+  FBXCElementSnapshotWrapper *targetCellSnapshotWrapped = [FBXCElementSnapshotWrapper ensureWrapped:[self fb_customSnapshot]];
   targetCellSnapshot = [targetCellSnapshotWrapped fb_parentCellSnapshot];
   CGRect visibleFrame = [FBXCElementSnapshotWrapper ensureWrapped:targetCellSnapshot].fb_visibleFrame;
   
@@ -229,7 +229,7 @@ const CGFloat FBScrollTouchProportion = 0.75f;
     return YES;
   }
 
-  id<FBXCElementSnapshot> appSnapshot = [self.application fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> appSnapshot = [self.application fb_standardSnapshot];
   for (id<FBXCElementSnapshot> elementSnapshot in appSnapshot._allDescendants.copy) {
     FBXCElementSnapshotWrapper *wrappedElementSnapshot = [FBXCElementSnapshotWrapper ensureWrapped:elementSnapshot];
     // We are comparing pre-scroll snapshot so frames are irrelevant.

package/WebDriverAgentLib/Categories/XCUIElement+FBTyping.m

@@ -91,7 +91,7 @@ BOOL FBTypeText(NSString *text, NSUInteger typingSpeed, NSError **error)
   [FBLogger logFmt:@"Trying to tap the \"%@\" element to have it focused", snapshot.fb_description];
   [self tap];
   // It might take some time to update the UI
-  [self fb_takeSnapshot:NO];
+  [self fb_standardSnapshot];
 #endif
 }
 
@@ -110,7 +110,7 @@ BOOL FBTypeText(NSString *text, NSUInteger typingSpeed, NSError **error)
           frequency:(NSUInteger)frequency
               error:(NSError **)error
 {
-  id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:NO];
+  id<FBXCElementSnapshot> snapshot = [self fb_standardSnapshot];
   FBXCElementSnapshotWrapper *wrapped = [FBXCElementSnapshotWrapper ensureWrapped:snapshot];
   [self fb_prepareForTextInputWithSnapshot:wrapped];
   if (shouldClear && ![self fb_clearTextWithSnapshot:wrapped shouldPrepareForInput:NO error:error]) {
@@ -121,7 +121,7 @@ BOOL FBTypeText(NSString *text, NSUInteger typingSpeed, NSError **error)
 
 - (BOOL)fb_clearTextWithError:(NSError **)error
 {
-  id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:NO];
+  id<FBXCElementSnapshot> snapshot = [self fb_standardSnapshot];
   return [self fb_clearTextWithSnapshot:[FBXCElementSnapshotWrapper ensureWrapped:snapshot]
                   shouldPrepareForInput:YES
                                   error:error];
@@ -178,7 +178,7 @@ BOOL FBTypeText(NSString *text, NSUInteger typingSpeed, NSError **error)
       return NO;
     }
 
-    currentValue = [self fb_takeSnapshot:NO].value;
+    currentValue = [self fb_standardSnapshot].value;
     if (nil != placeholderValue && [currentValue isEqualToString:placeholderValue]) {
       // Short circuit if only the placeholder value left
       return YES;

package/WebDriverAgentLib/Categories/XCUIElement+FBUID.m

@@ -22,14 +22,14 @@
 {
   return [FBElementUtils idWithAccessibilityElement:([self isKindOfClass:XCUIApplication.class]
                                                      ? [(XCUIApplication *)self accessibilityElement]
-                                                     : [self fb_takeSnapshot:NO].accessibilityElement)];
+                                                     : [self fb_standardSnapshot].accessibilityElement)];
 }
 
 - (NSString *)fb_uid
 {
   return [self isKindOfClass:XCUIApplication.class]
     ? [FBElementUtils uidWithAccessibilityElement:[(XCUIApplication *)self accessibilityElement]]
-    : [FBXCElementSnapshotWrapper ensureWrapped:[self fb_takeSnapshot:NO]].fb_uid;
+    : [FBXCElementSnapshotWrapper ensureWrapped:[self fb_standardSnapshot]].fb_uid;
 }
 
 @end

package/WebDriverAgentLib/Categories/XCUIElement+FBUtilities.h

@@ -15,17 +15,39 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface XCUIElement (FBUtilities)
 
+/**
+ 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 snapshot is taken by the native API provided by XCTest.
+ The maximum snapshot tree depth is set by `FBConfiguration.snapshotMaxDepth`
+
+ Snapshot specifics:
+ - Most performant
+ - Memory-friedly
+ - `children` property is set to `nil` if not taken from XCUIApplication
+ - `value` property is cut off to max 512 bytes
+
+ @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_standardSnapshot;
+
 /**
  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
+ - `children` property is always defined
+ - `value` property is not cut off
 
- @param inDepth Whether to resolve snapshot parents and children. Setting it to NO
- would improve the snapshotting performance
  @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_takeSnapshot:(BOOL)inDepth;
+- (id<FBXCElementSnapshot>)fb_customSnapshot;
 
 /**
  Extracts the cached element snapshot from its query.

package/WebDriverAgentLib/Categories/XCUIElement+FBUtilities.m

@@ -44,12 +44,12 @@
 
 @implementation XCUIElement (FBUtilities)
 
-- (id<FBXCElementSnapshot>)fb_takeSnapshot:(BOOL)inDepth
+- (id<FBXCElementSnapshot>)fb_takeSnapshot:(BOOL)isCustom
 {
   __block id<FBXCElementSnapshot> snapshot = nil;
   @autoreleasepool {
     NSError *error = nil;
-    snapshot = inDepth && ![self isKindOfClass:XCUIApplication.class]
+    snapshot = isCustom
       ? [self.fb_query fb_uniqueSnapshotWithError:&error]
       : (id<FBXCElementSnapshot>)[self snapshotWithError:&error];
     if (nil == snapshot) {
@@ -69,6 +69,16 @@
   return self.lastSnapshot;
 }
 
+- (id<FBXCElementSnapshot>)fb_standardSnapshot
+{
+  return [self fb_takeSnapshot:NO];
+}
+
+- (id<FBXCElementSnapshot>)fb_customSnapshot
+{
+  return [self fb_takeSnapshot:YES];
+}
+
 - (id<FBXCElementSnapshot>)fb_cachedSnapshot
 {
   return [self.query fb_cachedSnapshot];

package/WebDriverAgentLib/Categories/XCUIElement+FBVisibleFrame.m

@@ -18,7 +18,7 @@
 
 - (CGRect)fb_visibleFrame
 {
-  id<FBXCElementSnapshot> snapshot = [self fb_takeSnapshot:NO];
+  id<FBXCElementSnapshot> snapshot = [self fb_standardSnapshot];
   return [FBXCElementSnapshotWrapper ensureWrapped:snapshot].fb_visibleFrame;
 }
 

package/WebDriverAgentLib/Categories/XCUIElement+FBWebDriverAttributes.m

@@ -28,12 +28,16 @@
 
 - (id<FBXCElementSnapshot>)fb_snapshotForAttributeName:(NSString *)name
 {
-  BOOL inDepth = [name isEqualToString:FBStringify(XCUIElement, isWDAccessible)]
+  // https://github.com/appium/appium-xcuitest-driver/issues/2552
+  BOOL isValueRequest = [name isEqualToString:FBStringify(XCUIElement, wdValue)];
+  if ([self isKindOfClass:XCUIApplication.class] && !isValueRequest) {
+    return [self fb_standardSnapshot];
+  }
+  BOOL isCustomSnapshot = [name isEqualToString:FBStringify(XCUIElement, isWDAccessible)]
     || [name isEqualToString:FBStringify(XCUIElement, isWDAccessibilityContainer)]
-    // To retrice entire text https://github.com/appium/appium-xcuitest-driver/issues/2552
-    || [name isEqualToString:FBStringify(XCUIElement, wdValue)]
-    || [name isEqualToString:FBStringify(XCUIElement, wdIndex)];
-  return [self fb_takeSnapshot:inDepth];
+    || [name isEqualToString:FBStringify(XCUIElement, wdIndex)]
+    || isValueRequest;
+  return isCustomSnapshot ? [self fb_customSnapshot] : [self fb_standardSnapshot];
 }
 
 - (id)fb_valueForWDAttributeName:(NSString *)name
@@ -66,6 +70,15 @@
   return [self valueForKey:[FBElementUtils wdAttributeNameForAttributeName:name]];
 }
 
+- (BOOL)fb_supportsInnerText
+{
+  XCUIElementType elementType = self.elementType;
+  return elementType == XCUIElementTypeTextView
+    || elementType == XCUIElementTypeTextField
+    || elementType == XCUIElementTypeSearchField
+    || elementType == XCUIElementTypeSecureTextField;
+}
+
 - (NSString *)wdValue
 {
   id value = self.value;
@@ -78,10 +91,7 @@
     value = FBFirstNonEmptyValue(value, isSelected);
   } else if (elementType == XCUIElementTypeSwitch) {
     value = @([value boolValue]);
-  } else if (elementType == XCUIElementTypeTextView ||
-             elementType == XCUIElementTypeTextField ||
-             elementType == XCUIElementTypeSearchField ||
-             elementType == XCUIElementTypeSecureTextField) {
+  } else if (self.fb_supportsInnerText) {
     NSString *placeholderValue = self.placeholderValue;
     value = FBFirstNonEmptyValue(value, placeholderValue);
   }
@@ -109,21 +119,18 @@
 
 - (NSString *)wdLabel
 {
-  NSString *label = self.label;
   XCUIElementType elementType = self.elementType;
-  if (elementType == XCUIElementTypeTextField || elementType == XCUIElementTypeSecureTextField ) {
-    return label;
-  }
-  return FBTransferEmptyStringToNil(label);
+  return (elementType == XCUIElementTypeTextField
+          || elementType == XCUIElementTypeSecureTextField)
+    ? self.label
+    : FBTransferEmptyStringToNil(self.label);
 }
 
 - (NSString *)wdPlaceholderValue
 {
-  NSString *placehlderValue = self.placeholderValue;
-  if (nil != placehlderValue) {
-    return placehlderValue;
-  }
-  return FBTransferEmptyStringToNil(placehlderValue);
+  return self.fb_supportsInnerText
+    ? self.placeholderValue
+    : FBTransferEmptyStringToNil(self.placeholderValue);
 }
 
 - (NSString *)wdType

package/WebDriverAgentLib/Commands/FBElementCommands.m

@@ -151,8 +151,9 @@
 {
   FBElementCache *elementCache = request.session.elementCache;
   XCUIElement *element = [elementCache elementForUUID:(NSString *)request.parameters[@"uuid"]];
-  // 'fb_takeSnapshot:YES' is to retrice entire text https://github.com/appium/appium-xcuitest-driver/issues/2552
-  FBXCElementSnapshotWrapper *wrappedSnapshot = [FBXCElementSnapshotWrapper ensureWrapped:[element fb_takeSnapshot:YES]];
+  // https://github.com/appium/appium-xcuitest-driver/issues/2552
+  id<FBXCElementSnapshot> snapshot = [element fb_customSnapshot];
+  FBXCElementSnapshotWrapper *wrappedSnapshot = [FBXCElementSnapshotWrapper ensureWrapped:snapshot];
   id text = FBFirstNonEmptyValue(wrappedSnapshot.wdValue, wrappedSnapshot.wdLabel);
   return FBResponseWithObject(text ?: @"");
 }

package/WebDriverAgentLib/Commands/FBFindElementCommands.m

@@ -81,7 +81,7 @@ static id<FBResponsePayload> FBNoSuchElementErrorResponseForRequest(FBRouteReque
 {
   FBElementCache *elementCache = request.session.elementCache;
   XCUIElement *element = [elementCache elementForUUID:(NSString *)request.parameters[@"uuid"]];
-  id<FBXCElementSnapshot> snapshot = [element fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> snapshot = [element fb_customSnapshot];
   NSArray<id<FBXCElementSnapshot>> *visibleCellSnapshots = [snapshot descendantsByFilteringWithBlock:^BOOL(id<FBXCElementSnapshot> shot) {
     return shot.elementType == XCUIElementTypeCell
       && [FBXCElementSnapshotWrapper ensureWrapped:shot].wdVisible;

package/WebDriverAgentLib/FBAlert.m

@@ -50,7 +50,7 @@
     if (nil == self.alertElement) {
       return NO;
     }
-    [self.alertElement fb_takeSnapshot:YES];
+    [self.alertElement fb_customSnapshot];
     return YES;
   } @catch (NSException *) {
     return NO;
@@ -82,7 +82,7 @@
   }
 
   NSMutableArray<NSString *> *resultText = [NSMutableArray array];
-  id<FBXCElementSnapshot> snapshot = self.alertElement.lastSnapshot ?: [self.alertElement fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> snapshot = self.alertElement.lastSnapshot ?: [self.alertElement fb_customSnapshot];
   BOOL isSafariAlert = [self.class isSafariWebAlertWithSnapshot:snapshot];
   [snapshot enumerateDescendantsUsingBlock:^(id<FBXCElementSnapshot> descendant) {
     XCUIElementType elementType = descendant.elementType;
@@ -145,7 +145,7 @@
   }
 
   NSMutableArray<NSString *> *labels = [NSMutableArray array];
-  id<FBXCElementSnapshot> alertSnapshot = self.alertElement.lastSnapshot ?: [self.alertElement fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> alertSnapshot = self.alertElement.lastSnapshot ?: [self.alertElement fb_customSnapshot];
   [alertSnapshot enumerateDescendantsUsingBlock:^(id<FBXCElementSnapshot> descendant) {
     if (descendant.elementType != XCUIElementTypeButton) {
       return;
@@ -164,7 +164,7 @@
     return [self notPresentWithError:error];
   }
 
-  id<FBXCElementSnapshot> alertSnapshot = self.alertElement.lastSnapshot ?: [self.alertElement fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> alertSnapshot = self.alertElement.lastSnapshot ?: [self.alertElement fb_customSnapshot];
   XCUIElement *acceptButton = nil;
   if (FBConfiguration.acceptAlertButtonSelector.length) {
     NSString *errorReason = nil;
@@ -205,7 +205,7 @@
     return [self notPresentWithError:error];
   }
 
-  id<FBXCElementSnapshot> alertSnapshot = self.alertElement.lastSnapshot ?: [self.alertElement fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> alertSnapshot = self.alertElement.lastSnapshot ?: [self.alertElement fb_customSnapshot];
   XCUIElement *dismissButton = nil;
   if (FBConfiguration.dismissAlertButtonSelector.length) {
     NSString *errorReason = nil;

package/WebDriverAgentLib/Info.plist

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

package/WebDriverAgentLib/Routing/FBElementCache.m

@@ -74,7 +74,7 @@ const int ELEMENT_CACHE_SIZE = 1024;
   }
   if (checkStaleness) {
     @try {
-      [element fb_takeSnapshot:NO];
+      [element fb_standardSnapshot];
     } @catch (NSException *exception) {
       //  if the snapshot method threw FBStaleElementException (implying the element is stale) we need to explicitly remove it from the cache, PR: https://github.com/appium/WebDriverAgent/pull/985
       if ([exception.name isEqualToString:FBStaleElementException]) {

package/WebDriverAgentLib/Routing/FBResponsePayload.m

@@ -44,7 +44,9 @@ XCUIElement *maybeStable(XCUIElement *element)
   }
 
   XCUIElement *result = element;
-  id<FBXCElementSnapshot> snapshot = element.lastSnapshot ?: [element fb_cachedSnapshot] ?: [element fb_takeSnapshot:NO];
+  id<FBXCElementSnapshot> snapshot = element.lastSnapshot
+    ?: element.fb_cachedSnapshot
+    ?: [element fb_standardSnapshot];
   NSString *uid = [FBXCElementSnapshotWrapper wdUIDWithSnapshot:snapshot];
   if (nil != uid) {
     result = [element fb_stableInstanceWithUid:uid];
@@ -108,7 +110,9 @@ inline NSDictionary *FBDictionaryResponseWithElement(XCUIElement *element, BOOL
 {
   __block NSDictionary *elementResponse = nil;
   @autoreleasepool {
-    id<FBXCElementSnapshot> snapshot = element.lastSnapshot ?: element.fb_cachedSnapshot ?: [element fb_takeSnapshot:YES];
+    id<FBXCElementSnapshot> snapshot = element.lastSnapshot
+      ?: element.fb_cachedSnapshot
+      ?: [element fb_customSnapshot];
     NSDictionary *compactResult = FBToElementDict((NSString *)[FBXCElementSnapshotWrapper wdUIDWithSnapshot:snapshot]);
     if (compact) {
       elementResponse = compactResult;

package/WebDriverAgentLib/Utilities/FBXPath.m

@@ -206,7 +206,7 @@ static NSString *const topNodeIndexPath = @"top";
         lookupScopeSnapshot = [self snapshotWithRoot:[(XCUIElement *)root application]];
         contextRootSnapshot = [root isKindOfClass:XCUIApplication.class]
           ? nil
-          : [(XCUIElement *)root fb_takeSnapshot:YES];
+          : ([(XCUIElement *)root lastSnapshot] ?: [(XCUIElement *)root fb_customSnapshot]);
       } else {
         lookupScopeSnapshot = (id<FBXCElementSnapshot>)root;
         contextRootSnapshot = nil == lookupScopeSnapshot.parent ? nil : (id<FBXCElementSnapshot>)root;
@@ -491,9 +491,9 @@ static NSString *const topNodeIndexPath = @"top";
   // If the app is not idle state while we retrieve the visiblity state
   // then the snapshot retrieval operation might freeze and time out
   [[(XCUIElement *)root application] fb_waitUntilStableWithTimeout:FBConfiguration.animationCoolOffTimeout];
-  @autoreleasepool {
-    return [(XCUIElement *)root fb_takeSnapshot:YES];
-  }
+  return [root isKindOfClass:XCUIApplication.class]
+    ? [(XCUIElement *)root fb_standardSnapshot]
+    : [(XCUIElement *)root fb_customSnapshot];
 }
 
 @end

package/WebDriverAgentTests/IntegrationTests/FBW3CTouchActionsIntegrationTests.m

@@ -424,7 +424,7 @@
                    timeout:2.0]
                   timeoutErrorMessage:@"Picker wheel value has not been changed after 2 seconds timeout"]
                  spinUntilTrue:^BOOL{
-    return ![[self.pickerWheel fb_takeSnapshot:NO].value isEqualToString:previousValue];
+    return ![[self.pickerWheel fb_standardSnapshot].value isEqualToString:previousValue];
                  }
                  error:&error]);
   XCTAssertNil(error);

package/WebDriverAgentTests/IntegrationTests/FBXPathIntegrationTests.m

@@ -43,7 +43,7 @@
 - (id<FBXCElementSnapshot>)destinationSnapshot
 {
   XCUIElement *matchingElement = self.testedView.buttons.allElementsBoundByIndex.firstObject;
-  id<FBXCElementSnapshot> snapshot = [matchingElement fb_takeSnapshot:YES];
+  id<FBXCElementSnapshot> snapshot = [matchingElement fb_customSnapshot];
   // Over iOS13, snapshot returns a child.
   // The purpose of here is return a single element to replace children with an empty array for testing.
   snapshot.children = @[];
@@ -57,7 +57,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\" placeholderValue=\"%@\"/>\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, wrappedSnapshot.wdPlaceholderValue];
+  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);
 }
 
@@ -70,7 +70,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\" placeholderValue=\"%@\"/>\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, wrappedSnapshot.wdPlaceholderValue, 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);
 }
 
@@ -83,7 +83,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=\"%@\" placeholderValue=\"%@\"/>\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], wrappedSnapshot.wdPlaceholderValue];
+  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/XCElementSnapshotHelperTests.m

@@ -45,7 +45,7 @@
     @"Touch",
   ]];
   NSArray<id<FBXCElementSnapshot>> *matchingSnapshots = [[FBXCElementSnapshotWrapper ensureWrapped:
-                                                          [self.testedView fb_takeSnapshot:YES]]
+                                                          [self.testedView fb_customSnapshot]]
                                                          fb_descendantsMatchingType:XCUIElementTypeButton];
   XCTAssertEqual(matchingSnapshots.count, expectedLabels.count);
   NSArray<NSString *> *labels = [matchingSnapshots valueForKeyPath:@"@distinctUnionOfObjects.label"];
@@ -61,7 +61,7 @@
   XCUIElement *button = self.testedApplication.buttons[@"Alerts"];
   FBAssertWaitTillBecomesTrue(button.exists);
   id<FBXCElementSnapshot> windowSnapshot = [[FBXCElementSnapshotWrapper ensureWrapped:
-                                             [self.testedView fb_takeSnapshot:YES]]
+                                             [self.testedView fb_customSnapshot]]
                                             fb_parentMatchingType:XCUIElementTypeWindow];
   XCTAssertNotNil(windowSnapshot);
   XCTAssertEqual(windowSnapshot.elementType, XCUIElementTypeWindow);
@@ -89,7 +89,7 @@
   XCUIElement *todayPickerWheel = self.testedApplication.pickerWheels[@"Today"];
   FBAssertWaitTillBecomesTrue(todayPickerWheel.exists);
   id<FBXCElementSnapshot> datePicker = [[FBXCElementSnapshotWrapper ensureWrapped:
-                                         [todayPickerWheel fb_takeSnapshot:YES]]
+                                         [todayPickerWheel fb_customSnapshot]]
                                         fb_parentMatchingOneOfTypes:@[@(XCUIElementTypeDatePicker), @(XCUIElementTypeWindow)]];
   XCTAssertNotNil(datePicker);
   XCTAssertEqual(datePicker.elementType, XCUIElementTypeDatePicker);
@@ -100,7 +100,7 @@
   XCUIElement *todayPickerWheel = self.testedApplication.pickerWheels[@"Today"];
   FBAssertWaitTillBecomesTrue(todayPickerWheel.exists);
   id<FBXCElementSnapshot> otherSnapshot =[[FBXCElementSnapshotWrapper ensureWrapped:
-                                           [todayPickerWheel fb_takeSnapshot:YES]]
+                                           [todayPickerWheel fb_customSnapshot]]
                                           fb_parentMatchingOneOfTypes:@[@(XCUIElementTypeAny)]];
   XCTAssertNotNil(otherSnapshot);
 }
@@ -110,7 +110,7 @@
   XCUIElement *todayPickerWheel = self.testedApplication.pickerWheels[@"Today"];
   FBAssertWaitTillBecomesTrue(todayPickerWheel.exists);
   id<FBXCElementSnapshot> otherSnapshot = [[FBXCElementSnapshotWrapper ensureWrapped:
-                                            [todayPickerWheel fb_takeSnapshot:YES]]
+                                            [todayPickerWheel fb_customSnapshot]]
                                       fb_parentMatchingOneOfTypes:@[@(XCUIElementTypeTab), @(XCUIElementTypeLink)]];
   XCTAssertNil(otherSnapshot);
 }
@@ -142,7 +142,7 @@
                                @(XCUIElementTypeTable),
                                ];
   id<FBXCElementSnapshot> scrollView = [[FBXCElementSnapshotWrapper ensureWrapped:
-                                         [threeStaticText fb_takeSnapshot:YES]]
+                                         [threeStaticText fb_customSnapshot]]
                                    fb_parentMatchingOneOfTypes:acceptedParents
                                                         filter:^BOOL(id<FBXCElementSnapshot> snapshot) {
     return [[FBXCElementSnapshotWrapper ensureWrapped:snapshot] isWDVisible];
@@ -160,7 +160,7 @@
                                @(XCUIElementTypeTable),
                                ];
   id<FBXCElementSnapshot> scrollView = [[FBXCElementSnapshotWrapper ensureWrapped:
-                                         [threeStaticText fb_takeSnapshot:YES]]
+                                         [threeStaticText fb_customSnapshot]]
                                         fb_parentMatchingOneOfTypes:acceptedParents
                                                              filter:^BOOL(id<FBXCElementSnapshot> snapshot) {
     return NO;
@@ -173,7 +173,7 @@
   XCUIElement *scrollView = self.testedApplication.scrollViews[@"scrollView"];
   FBAssertWaitTillBecomesTrue(self.testedApplication.staticTexts[@"3"].fb_isVisible);
   NSArray *cells = [[FBXCElementSnapshotWrapper ensureWrapped:
-                     [scrollView fb_takeSnapshot:YES]]
+                     [scrollView fb_customSnapshot]]
                     fb_descendantsCellSnapshots];
   XCTAssertGreaterThanOrEqual(cells.count, 10);
   id<FBXCElementSnapshot> element = cells.firstObject;
@@ -202,7 +202,7 @@
   FBAssertWaitTillBecomesTrue(self.testedApplication.staticTexts[@"3"].fb_isVisible);
   XCUIElement *threeStaticText = self.testedApplication.staticTexts[@"3"];
   id<FBXCElementSnapshot> xcuiElementCell = [[FBXCElementSnapshotWrapper ensureWrapped:
-                                              [threeStaticText fb_takeSnapshot:YES]]
+                                              [threeStaticText fb_customSnapshot]]
                                              fb_parentCellSnapshot];
   XCTAssertEqual(xcuiElementCell.elementType, 75);
 }

package/WebDriverAgentTests/IntegrationTests/XCElementSnapshotHitPointTests.m

@@ -23,7 +23,8 @@
   [self launchApplication];
   [self goToAttributesPage];
   XCUIElement *dstBtn = self.testedApplication.buttons[@"not_accessible"];
-  CGPoint hitPoint = [FBXCElementSnapshotWrapper ensureWrapped:[dstBtn fb_takeSnapshot:NO]].fb_hitPoint.CGPointValue;
+  CGPoint hitPoint = [FBXCElementSnapshotWrapper
+                      ensureWrapped:[dstBtn fb_standardSnapshot]].fb_hitPoint.CGPointValue;
   XCTAssertTrue(hitPoint.x > 0 && hitPoint.y > 0);
 }
 

package/WebDriverAgentTests/IntegrationTests/XCUIElementHelperIntegrationTests.m

@@ -41,7 +41,7 @@
   [allElements addObjectsFromArray:windows];
   
   NSMutableArray<id<FBXCElementSnapshot>> *buttonSnapshots = [NSMutableArray array];
-  [buttonSnapshots addObject:[buttons.firstObject fb_takeSnapshot:YES]];
+  [buttonSnapshots addObject:[buttons.firstObject fb_customSnapshot]];
 
   NSArray<XCUIElement *> *result = [self.testedApplication fb_filterDescendantsWithSnapshots:buttonSnapshots
                                                                                 onlyChildren:NO];

package/WebDriverAgentTests/UnitTests/Doubles/XCUIElementDouble.h

@@ -39,7 +39,8 @@
 @property (nonatomic, readwrite, getter=isWDAccessibilityContainer) BOOL wdAccessibilityContainer;
 
 - (void)resolve;
-- (id _Nonnull)fb_takeSnapshot:(BOOL)inDepth;
+- (id _Nonnull)fb_standardSnapshot;
+- (id _Nonnull)fb_customSnapshot;
 - (nullable id)query;
 
 // Checks

package/WebDriverAgentTests/UnitTests/Doubles/XCUIElementDouble.m

@@ -69,7 +69,12 @@
   self.didResolve = YES;
 }
 
-- (id _Nonnull)fb_takeSnapshot:(BOOL)inDepth;
+- (id _Nonnull)fb_standardSnapshot;
+{
+  return [self lastSnapshot];
+}
+
+- (id _Nonnull)fb_customSnapshot;
 {
   return [self lastSnapshot];
 }

package/WebDriverAgentTests/UnitTests_tvOS/Doubles/XCUIElementDouble.h

@@ -37,7 +37,8 @@
 @property (nonatomic, readwrite, getter=isWDAccessibilityContainer) BOOL wdAccessibilityContainer;
 
 - (void)resolve;
-- (id _Nonnull)fb_takeSnapshot;
+- (id _Nonnull)fb_standardSnapshot;
+- (id _Nonnull)fb_customSnapshot;
 
 // Checks
 @property (nonatomic, assign, readonly) BOOL didResolve;

package/WebDriverAgentTests/UnitTests_tvOS/Doubles/XCUIElementDouble.m

@@ -52,7 +52,12 @@
   return @"test";
 }
 
-- (id)fb_takeSnapshot
+- (id)fb_standardSnapshot
+{
+  return [self lastSnapshot];
+}
+
+- (id)fb_customSnapshot
 {
   return [self lastSnapshot];
 }

package/package.json

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