appium-webdriveragent 4.7.0 → 4.8.2

package/WebDriverAgentLib/Utilities/FBActiveAppDetectionPoint.m

@@ -36,13 +36,13 @@
   return instance;
 }
 
-+ (XCAccessibilityElement *)axElementWithPoint:(CGPoint)point
++ (id<FBXCAccessibilityElement>)axElementWithPoint:(CGPoint)point
 {
-  __block XCAccessibilityElement *onScreenElement = nil;
+  __block id<FBXCAccessibilityElement> onScreenElement = nil;
   id<XCTestManager_ManagerInterface> proxy = [FBXCTestDaemonsProxy testRunnerProxy];
   dispatch_semaphore_t sem = dispatch_semaphore_create(0);
   [proxy _XCT_requestElementAtPoint:point
-                              reply:^(XCAccessibilityElement *element, NSError *error) {
+                              reply:^(id element, NSError *error) {
                                 if (nil == error) {
                                   onScreenElement = element;
                                 } else {
@@ -54,7 +54,7 @@
   return onScreenElement;
 }
 
-- (XCAccessibilityElement *)axElement
+- (id<FBXCAccessibilityElement>)axElement
 {
   return [self.class axElementWithPoint:self.coordinates];
 }

package/WebDriverAgentLib/Utilities/FBBaseActionsSynthesizer.h

@@ -8,8 +8,8 @@
  */
 
 #import "FBElementCache.h"
+#import "FBXCElementSnapshot.h"
 #import "XCUIApplication.h"
-#import "XCElementSnapshot.h"
 #import "XCSynthesizedEventRecord.h"
 
 NS_ASSUME_NONNULL_BEGIN
@@ -62,7 +62,7 @@ NS_ASSUME_NONNULL_BEGIN
  @param snapshot Element's snapshot instance
  @return The fixed hit point coordinates, if there is a need to fix them, or the unchanged hit point value
  */
-- (CGPoint)fixedHitPointWith:(CGPoint)hitPoint forSnapshot:(XCElementSnapshot *)snapshot;
+- (CGPoint)fixedHitPointWith:(CGPoint)hitPoint forSnapshot:(id<FBXCElementSnapshot>)snapshot;
 
 /**
  Calculate absolute gesture position on the screen based on provided element and positionOffset values.

package/WebDriverAgentLib/Utilities/FBBaseActionsSynthesizer.m

@@ -13,12 +13,11 @@
 #import "FBLogger.h"
 #import "FBMacros.h"
 #import "FBMathUtils.h"
+#import "FBXCElementSnapshotWrapper+Helpers.h"
 #import "XCUIApplication+FBHelpers.h"
+#import "XCUIElement.h"
 #import "XCUIElement+FBIsVisible.h"
-#import "XCElementSnapshot.h"
 #import "XCUIElement+FBCaching.h"
-#import "XCElementSnapshot+FBHitPoint.h"
-#import "XCElementSnapshot+FBHelpers.h"
 #import "XCPointerEventPath.h"
 #import "XCSynthesizedEventRecord.h"
 #import "XCUIElement+FBUtilities.h"
@@ -42,7 +41,7 @@
 
 @implementation FBBaseGestureItem
 
-- (CGPoint)fixedHitPointWith:(CGPoint)hitPoint forSnapshot:(XCElementSnapshot *)snapshot
+- (CGPoint)fixedHitPointWith:(CGPoint)hitPoint forSnapshot:(id<FBXCElementSnapshot>)snapshot
 {
   UIInterfaceOrientation interfaceOrientation = self.application.interfaceOrientation;
   if (interfaceOrientation == UIInterfaceOrientationPortrait) {
@@ -54,8 +53,8 @@
     // For Xcode11 it is always necessary to adjust the tap point coordinates
     return FBInvertPointForApplication(hitPoint, appFrame.size, interfaceOrientation);
   }
-  NSArray<XCElementSnapshot *> *ancestors = snapshot.fb_ancestors;
-  XCElementSnapshot *parentWindow = ancestors.count > 1 ? [ancestors objectAtIndex:ancestors.count - 2] : nil;
+  NSArray<id<FBXCElementSnapshot>> *ancestors = [FBXCElementSnapshotWrapper ensureWrapped:snapshot].fb_ancestors;
+  id<FBXCElementSnapshot> parentWindow = ancestors.count > 1 ? [ancestors objectAtIndex:ancestors.count - 2] : nil;
   CGRect parentWindowFrame = nil == parentWindow ? snapshot.frame : parentWindow.frame;
   if ((appFrame.size.height > appFrame.size.width && parentWindowFrame.size.height < parentWindowFrame.size.width) ||
       (appFrame.size.height < appFrame.size.width && parentWindowFrame.size.height > parentWindowFrame.size.width)) {
@@ -86,11 +85,11 @@
   } else {
     // The offset relative to the element is defined
 
-    XCElementSnapshot *snapshot = element.fb_isResolvedFromCache.boolValue
+    id<FBXCElementSnapshot> snapshot = element.fb_isResolvedFromCache.boolValue
       ? element.lastSnapshot
       : element.fb_takeSnapshot;
     if (nil == positionOffset) {
-      NSValue *hitPointValue = snapshot.fb_hitPoint;
+      NSValue *hitPointValue = [FBXCElementSnapshotWrapper ensureWrapped:snapshot].fb_hitPoint;
       if (nil != hitPointValue) {
         // short circuit element hitpoint
         return hitPointValue;

package/WebDriverAgentLib/Utilities/FBClassChainQueryParser.m

@@ -11,7 +11,6 @@
 #import "FBErrorBuilder.h"
 #import "FBElementTypeTransformer.h"
 #import "FBExceptions.h"
-#import "FBPredicate.h"
 #import "NSPredicate+FBFormat.h"
 
 NS_ASSUME_NONNULL_BEGIN
@@ -559,7 +558,7 @@ static NSNumberFormatter *numberFormatter = nil;
         *error = [self.class compilationErrorWithQuery:originalQuery description:description];
         return nil;
       }
-      NSPredicate *value = [NSPredicate fb_formatSearchPredicate:[FBPredicate predicateWithFormat:token.asString]];
+      NSPredicate *value = [NSPredicate fb_snapshotBlockPredicateWithPredicate:[NSPredicate predicateWithFormat:token.asString]];
       if ([token isKindOfClass:FBSelfPredicateToken.class]) {
         [predicates addObject:[[FBSelfPredicateItem alloc] initWithValue:value]];
       } else if ([token isKindOfClass:FBDescendantPredicateToken.class]) {

package/WebDriverAgentLib/Utilities/FBConfiguration.m

@@ -15,7 +15,6 @@
 #include "TargetConditionals.h"
 #import "FBXCodeCompatibility.h"
 #import "XCTestPrivateSymbols.h"
-#import "XCElementSnapshot.h"
 #import "XCTestConfiguration.h"
 #import "XCUIApplication+FBUIInterruptions.h"
 

package/WebDriverAgentLib/Utilities/FBImageIOScaler.m

@@ -57,6 +57,8 @@ const CGFloat FBMaxCompressionQuality = 1.0f;
   self.nextImage = image;
   [self.nextImageLock unlock];
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wcompletion-handler"
   dispatch_async(self.scalingQueue, ^{
     [self.nextImageLock lock];
     NSData *next = self.nextImage;
@@ -77,6 +79,7 @@ const CGFloat FBMaxCompressionQuality = 1.0f;
     }
     completionHandler(scaled);
   });
+#pragma clang diagnostic pop
 }
 
 // This method is more optimized for JPEG scaling

package/WebDriverAgentLib/Utilities/FBKeyboard.m

@@ -17,7 +17,6 @@
 #import "FBRunLoopSpinner.h"
 #import "FBMacros.h"
 #import "FBXCodeCompatibility.h"
-#import "XCElementSnapshot.h"
 #import "XCUIElement+FBUtilities.h"
 #import "XCUIElement+FBIsVisible.h"
 #import "XCTestDriver.h"
@@ -58,7 +57,7 @@
       return NO;
     }
 
-    NSPredicate *keySearchPredicate = [NSPredicate predicateWithBlock:^BOOL(XCElementSnapshot *snapshot,
+    NSPredicate *keySearchPredicate = [NSPredicate predicateWithBlock:^BOOL(id<FBXCElementSnapshot> snapshot,
                                                                             NSDictionary *bindings) {
       return snapshot.label.length > 0;
     }];

package/WebDriverAgentLib/Utilities/FBPasteboard.m

@@ -9,7 +9,16 @@
 
 #import "FBPasteboard.h"
 
+#import <mach/mach_time.h>
+#import "FBAlert.h"
+#import "FBApplication.h"
 #import "FBErrorBuilder.h"
+#import "FBMacros.h"
+#import "XCUIApplication+FBAlert.h"
+
+#define ALERT_TIMEOUT_SEC 30
+// Must not be less than FB_MONTORING_INTERVAL in FBAlertsMonitor
+#define ALERT_CHECK_INTERVAL_SEC 2
 
 #if !TARGET_OS_TV
 @implementation FBPasteboard
@@ -50,21 +59,100 @@
   return YES;
 }
 
++ (nullable id)pasteboardContentForItem:(NSString *)item
+                               instance:(UIPasteboard *)pbInstance
+                                timeout:(NSTimeInterval)timeout
+                                  error:(NSError **)error
+{
+  SEL selector = NSSelectorFromString(item);
+  NSMethodSignature *methodSignature = [pbInstance methodSignatureForSelector:selector];
+  if (nil == methodSignature) {
+    NSString *description = [NSString stringWithFormat:@"Cannot retrieve '%@' from a UIPasteboard instance", item];
+    if (error) {
+      *error = [[FBErrorBuilder.builder withDescription:description] build];
+    }
+    return nil;
+  }
+  NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSignature];
+  [invocation setSelector:selector];
+  [invocation setTarget:pbInstance];
+  if (SYSTEM_VERSION_LESS_THAN(@"16.0")) {
+    [invocation invoke];
+    id __unsafe_unretained result;
+    [invocation getReturnValue:&result];
+    return result;
+  }
+
+  // https://github.com/appium/appium/issues/17392
+  __block id pasteboardContent;
+  dispatch_queue_t backgroundQueue = dispatch_queue_create("GetPasteboard", NULL);
+  __block BOOL didFinishGetPasteboard = NO;
+  dispatch_async(backgroundQueue, ^{
+    [invocation invoke];
+    id __unsafe_unretained result;
+    [invocation getReturnValue:&result];
+    pasteboardContent = result;
+    didFinishGetPasteboard = YES;
+  });
+  uint64_t timeStarted = mach_absolute_time();
+  while (!didFinishGetPasteboard) {
+    [[NSRunLoop currentRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:ALERT_CHECK_INTERVAL_SEC]];
+    if (didFinishGetPasteboard) {
+      break;
+    }
+
+    XCUIElement *alertElement = FBApplication.fb_systemApplication.fb_alertElement;
+    if (nil != alertElement) {
+      FBAlert *alert = [FBAlert alertWithElement:alertElement];
+      [alert acceptWithError:nil];
+    }
+    uint64_t timeElapsed = mach_absolute_time() - timeStarted;
+    if (timeElapsed / NSEC_PER_SEC > timeout) {
+      NSString *description = [NSString stringWithFormat:@"Cannot handle pasteboard alert within %@s timeout", @(timeout)];
+      if (error) {
+        *error = [[FBErrorBuilder.builder withDescription:description] build];
+      }
+      return nil;
+    }
+  }
+  return pasteboardContent;
+}
+
 + (NSData *)dataForType:(NSString *)type error:(NSError **)error
 {
   UIPasteboard *pb = UIPasteboard.generalPasteboard;
   if ([type.lowercaseString isEqualToString:@"plaintext"]) {
     if (pb.hasStrings) {
-      return [[pb.strings componentsJoinedByString:@"\n"] dataUsingEncoding:NSUTF8StringEncoding];
+      id result = [self.class pasteboardContentForItem:@"strings"
+                                              instance:pb
+                                               timeout:ALERT_TIMEOUT_SEC
+                                                 error:error
+      ];
+      return nil == result
+        ? nil
+        : [[(NSArray *)result componentsJoinedByString:@"\n"] dataUsingEncoding:NSUTF8StringEncoding];
     }
   } else if ([type.lowercaseString isEqualToString:@"image"]) {
     if (pb.hasImages) {
-      return UIImagePNGRepresentation((UIImage *)pb.image);
+      id result = [self.class pasteboardContentForItem:@"image"
+                                              instance:pb
+                                               timeout:ALERT_TIMEOUT_SEC
+                                                 error:error
+      ];
+      return nil == result ? nil : UIImagePNGRepresentation((UIImage *)result);
     }
   } else if ([type.lowercaseString isEqualToString:@"url"]) {
     if (pb.hasURLs) {
+      id result = [self.class pasteboardContentForItem:@"URLs"
+                                              instance:pb
+                                               timeout:ALERT_TIMEOUT_SEC
+                                                 error:error
+      ];
+      if (nil == result) {
+        return nil;
+      }
       NSMutableArray<NSString *> *urls = [NSMutableArray array];
-      for (NSURL *url in pb.URLs) {
+      for (NSURL *url in (NSArray *)result) {
         if (nil != url.absoluteString) {
           [urls addObject:(id)url.absoluteString];
         }

package/WebDriverAgentLib/Utilities/FBTVNavigationTracker.m

@@ -59,7 +59,7 @@
   if (self) {
     _targetElement = targetElement;
     CGRect frame = targetElement.fb_isResolvedFromCache.boolValue
-      ? targetElement.lastSnapshot.wdFrame
+      ? [FBXCElementSnapshotWrapper ensureWrapped:targetElement.lastSnapshot].wdFrame
       : targetElement.wdFrame;
     _targetCenter = FBRectGetCenter(frame);
     _navigationItems = [NSMutableDictionary dictionary];

package/WebDriverAgentLib/Utilities/FBW3CActionsSynthesizer.m

@@ -19,7 +19,7 @@
 #import "FBW3CActionsHelpers.h"
 #import "FBXCodeCompatibility.h"
 #import "FBXCTestDaemonsProxy.h"
-#import "XCElementSnapshot+FBHelpers.h"
+#import "FBXCElementSnapshotWrapper+Helpers.h"
 #import "XCUIApplication+FBHelpers.h"
 #import "XCUIDevice.h"
 #import "XCUIElement+FBCaching.h"
@@ -163,13 +163,13 @@ static NSString *const FB_KEY_ACTIONS = @"actions";
   }
 
   // An offset relative to the element is defined
-  XCElementSnapshot *snapshot = element.fb_isResolvedFromCache.boolValue
+  id<FBXCElementSnapshot> snapshot = element.fb_isResolvedFromCache.boolValue
     ? element.lastSnapshot
     : element.fb_takeSnapshot;
   CGRect frame = snapshot.frame;
   if (CGRectIsEmpty(frame)) {
     [FBLogger log:self.application.fb_descriptionRepresentation];
-    NSString *description = [NSString stringWithFormat:@"The element '%@' is not visible on the screen and thus is not interactable", snapshot.fb_description];
+    NSString *description = [NSString stringWithFormat:@"The element '%@' is not visible on the screen and thus is not interactable", [FBXCElementSnapshotWrapper ensureWrapped:snapshot].fb_description];
     if (error) {
       *error = [[FBErrorBuilder.builder withDescription:description] build];
     }

package/WebDriverAgentLib/Utilities/FBXCAXClientProxy.h

@@ -8,8 +8,9 @@
  */
 
 #import <XCTest/XCTest.h>
-#import "XCElementSnapshot.h"
-#import "XCAccessibilityElement.h"
+#import "FBXCElementSnapshot.h"
+
+@protocol FBXCAccessibilityElement;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -24,21 +25,21 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (BOOL)setAXTimeout:(NSTimeInterval)timeout error:(NSError **)error;
 
-- (nullable XCElementSnapshot *)snapshotForElement:(XCAccessibilityElement *)element
-                                        attributes:(nullable NSArray<NSString *> *)attributes
-                                          maxDepth:(nullable NSNumber *)maxDepth
-                                             error:(NSError **)error;
+- (nullable id<FBXCElementSnapshot>)snapshotForElement:(id<FBXCAccessibilityElement>)element
+                                            attributes:(nullable NSArray<NSString *> *)attributes
+                                              maxDepth:(nullable NSNumber *)maxDepth
+                                                 error:(NSError **)error;
 
-- (NSArray<XCAccessibilityElement *> *)activeApplications;
+- (NSArray<id<FBXCAccessibilityElement>> *)activeApplications;
 
-- (XCAccessibilityElement *)systemApplication;
+- (id<FBXCAccessibilityElement>)systemApplication;
 
 - (NSDictionary *)defaultParameters;
 
 - (void)notifyWhenNoAnimationsAreActiveForApplication:(XCUIApplication *)application
                                                 reply:(void (^)(void))reply;
 
-- (NSDictionary *)attributesForElement:(XCAccessibilityElement *)element
+- (NSDictionary *)attributesForElement:(id<FBXCAccessibilityElement>)element
                             attributes:(NSArray *)attributes;
 
 - (XCUIApplication *)monitoredApplicationWithProcessIdentifier:(int)pid;

package/WebDriverAgentLib/Utilities/FBXCAXClientProxy.m

@@ -11,6 +11,7 @@
 
 #import <objc/runtime.h>
 
+#import "FBXCAccessibilityElement.h"
 #import "FBConfiguration.h"
 #import "FBLogger.h"
 #import "FBMacros.h"
@@ -32,6 +33,9 @@ static id FBAXClient = nil;
   return FBConfiguration.snapshotRequestParameters;
 }
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wobjc-load-method"
+
 + (void)load
 {
   static dispatch_once_t onceToken;
@@ -42,6 +46,8 @@ static id FBAXClient = nil;
   });
 }
 
+#pragma clang diagnostic pop
+
 @end
 
 @implementation FBXCAXClientProxy
@@ -62,10 +68,10 @@ static id FBAXClient = nil;
   return [FBAXClient _setAXTimeout:timeout error:error];
 }
 
-- (XCElementSnapshot *)snapshotForElement:(XCAccessibilityElement *)element
-                               attributes:(NSArray<NSString *> *)attributes
-                                 maxDepth:(nullable NSNumber *)maxDepth
-                                    error:(NSError **)error
+- (id<FBXCElementSnapshot>)snapshotForElement:(id<FBXCAccessibilityElement>)element
+                                   attributes:(NSArray<NSString *> *)attributes
+                                     maxDepth:(nullable NSNumber *)maxDepth
+                                        error:(NSError **)error
 {
   NSMutableDictionary *parameters = [[NSMutableDictionary alloc] init];
   // Mimicking XCTest framework behavior (this attribute is added by default unless it is an excludingNonModalElements query)
@@ -82,16 +88,16 @@ static id FBAXClient = nil;
                                          attributes:attributes
                                          parameters:[parameters copy]
                                               error:error];
-  XCElementSnapshot *snapshot = [result valueForKey:@"_rootElementSnapshot"];
+  id<FBXCElementSnapshot> snapshot = [result valueForKey:@"_rootElementSnapshot"];
   return nil == snapshot ? result : snapshot;
 }
 
-- (NSArray<XCAccessibilityElement *> *)activeApplications
+- (NSArray<id<FBXCAccessibilityElement>> *)activeApplications
 {
   return [FBAXClient activeApplications];
 }
 
-- (XCAccessibilityElement *)systemApplication
+- (id<FBXCAccessibilityElement>)systemApplication
 {
   return [FBAXClient systemApplication];
 }
@@ -107,7 +113,7 @@ static id FBAXClient = nil;
   [FBAXClient notifyWhenNoAnimationsAreActiveForApplication:application reply:reply];
 }
 
-- (NSDictionary *)attributesForElement:(XCAccessibilityElement *)element
+- (NSDictionary *)attributesForElement:(id<FBXCAccessibilityElement>)element
                             attributes:(NSArray *)attributes
 {
   NSError *error = nil;

package/WebDriverAgentLib/Utilities/FBXCTestDaemonsProxy.h

@@ -9,7 +9,6 @@
 
 #import <XCTest/XCTest.h>
 #import "XCSynthesizedEventRecord.h"
-#import "XCElementSnapshot.h"
 
 NS_ASSUME_NONNULL_BEGIN
 

package/WebDriverAgentLib/Utilities/FBXCTestDaemonsProxy.m

@@ -23,6 +23,10 @@
 
 static Class FBXCTRunnerDaemonSessionClass = nil;
 static dispatch_once_t onceTestRunnerDaemonClass;
+
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wobjc-load-method"
+
 + (void)load
 {
   // XCTRunnerDaemonSession class is only available since Xcode 8.3
@@ -31,6 +35,8 @@ static dispatch_once_t onceTestRunnerDaemonClass;
   });
 }
 
+#pragma clang diagnostic pop
+
 + (id<XCTestManager_ManagerInterface>)testRunnerProxy
 {
   static id<XCTestManager_ManagerInterface> proxy = nil;

package/WebDriverAgentLib/Utilities/FBXCodeCompatibility.h

@@ -28,16 +28,6 @@ NSInteger FBTestmanagerdVersion(void);
 
 NS_ASSUME_NONNULL_BEGIN
 
-/**
- Set of categories that patches method name differences between Xcode versions,
- so that WDA can be build with different Xcode versions.
- */
-@interface XCElementSnapshot (FBCompatibility)
-
-+ (nullable SEL)fb_attributesForElementSnapshotKeyPathsSelector;
-
-@end
-
 /**
  The exception happends if one tries to call application method,
  which is not supported in the current iOS version

package/WebDriverAgentLib/Utilities/FBXCodeCompatibility.m

@@ -19,30 +19,6 @@
 
 static const NSTimeInterval APP_STATE_CHANGE_TIMEOUT = 5.0;
 
-@implementation XCElementSnapshot (FBCompatibility)
-
-+ (id)fb_axAttributesForElementSnapshotKeyPathsIOS:(id)arg1
-{
-  return [self.class axAttributesForElementSnapshotKeyPaths:arg1 isMacOS:NO];
-}
-
-+ (nullable SEL)fb_attributesForElementSnapshotKeyPathsSelector
-{
-  static SEL attributesForElementSnapshotKeyPathsSelector = nil;
-  static dispatch_once_t attributesForElementSnapshotKeyPathsSelectorToken;
-  dispatch_once(&attributesForElementSnapshotKeyPathsSelectorToken, ^{
-    if ([self.class respondsToSelector:@selector(axAttributesForElementSnapshotKeyPaths:)]) {
-      attributesForElementSnapshotKeyPathsSelector = @selector(axAttributesForElementSnapshotKeyPaths:);
-    } else if ([self.class respondsToSelector:@selector(axAttributesForElementSnapshotKeyPaths:isMacOS:)]) {
-      attributesForElementSnapshotKeyPathsSelector = @selector(fb_axAttributesForElementSnapshotKeyPathsIOS:);
-    }
-  });
-  return attributesForElementSnapshotKeyPathsSelector;
-}
-
-@end
-
-
 NSString *const FBApplicationMethodNotSupportedException = @"FBApplicationMethodNotSupportedException";
 
 @implementation XCUIApplication (FBCompatibility)

package/WebDriverAgentLib/Utilities/FBXPath-Private.h

@@ -25,7 +25,7 @@ NS_ASSUME_NONNULL_BEGIN
  If `query` argument is assigned then `excludedAttributes` argument is effectively ignored.
  @return zero if the method has completed successfully
  */
-+ (int)xmlRepresentationWithRootElement:(XCElementSnapshot *)root
++ (int)xmlRepresentationWithRootElement:(id<FBElement>)root
                                  writer:(xmlTextWriterPtr)writer
                            elementStore:(nullable NSMutableDictionary *)elementStore
                                   query:(nullable NSString*)query

package/WebDriverAgentLib/Utilities/FBXPath.h

@@ -9,7 +9,7 @@
 
 #import <XCTest/XCTest.h>
 #import <WebDriverAgentLib/FBElement.h>
-#import <WebDriverAgentLib/XCElementSnapshot.h>
+#import "FBXCElementSnapshot.h"
 
 #ifdef __clang__
 #pragma clang diagnostic push
@@ -41,8 +41,8 @@ NS_ASSUME_NONNULL_BEGIN
  @return an array of descendants matching the given xpath query or an empty array if no matches were found
  @throws NSException if there is an unexpected internal error during xml parsing
  */
-+ (NSArray<XCElementSnapshot *> *)matchesWithRootElement:(id<FBElement>)root
-                                                forQuery:(NSString *)xpathQuery;
++ (NSArray<id<FBXCElementSnapshot>> *)matchesWithRootElement:(id<FBElement>)root
+                                                    forQuery:(NSString *)xpathQuery;
 
 /**
  Gets XML representation of XCElementSnapshot with all its descendants. This method generates the same

package/WebDriverAgentLib/Utilities/FBXPath.m

@@ -13,8 +13,8 @@
 #import "FBExceptions.h"
 #import "FBLogger.h"
 #import "FBXMLGenerationOptions.h"
+#import "FBXCElementSnapshotWrapper+Helpers.h"
 #import "NSString+FBXMLSafeString.h"
-#import "XCElementSnapshot+FBHelpers.h"
 #import "XCUIElement.h"
 #import "XCUIElement+FBCaching.h"
 #import "XCUIElement+FBUtilities.h"
@@ -172,8 +172,8 @@ static NSString *const topNodeIndexPath = @"top";
   return result;
 }
 
-+ (NSArray<XCElementSnapshot *> *)matchesWithRootElement:(id<FBElement>)root
-                                                forQuery:(NSString *)xpathQuery
++ (NSArray<id<FBXCElementSnapshot>> *)matchesWithRootElement:(id<FBElement>)root
+                                                    forQuery:(NSString *)xpathQuery
 {
   xmlDocPtr doc;
 
@@ -238,7 +238,7 @@ static NSString *const topNodeIndexPath = @"top";
       [FBLogger log:@"Failed to invoke libxml2>xmlGetProp"];
       return nil;
     }
-    XCElementSnapshot *element = [elementStore objectForKey:(id)[NSString stringWithCString:(const char *)attrValue encoding:NSUTF8StringEncoding]];
+    id<FBXCElementSnapshot> element = [elementStore objectForKey:(id)[NSString stringWithCString:(const char *)attrValue encoding:NSUTF8StringEncoding]];
     if (element) {
       [matchingSnapshots addObject:element];
     }
@@ -325,7 +325,7 @@ static NSString *const topNodeIndexPath = @"top";
 }
 
 + (int)recordElementAttributes:(xmlTextWriterPtr)writer
-                    forElement:(XCElementSnapshot *)element
+                    forElement:(id<FBXCElementSnapshot>)element
                      indexPath:(nullable NSString *)indexPath
             includedAttributes:(nullable NSSet<Class> *)includedAttributes
 {
@@ -334,7 +334,8 @@ static NSString *const topNodeIndexPath = @"top";
     if (includedAttributes && ![includedAttributes containsObject:attributeCls]) {
       continue;
     }
-    int rc = [attributeCls recordWithWriter:writer forElement:element];
+    int rc = [attributeCls recordWithWriter:writer
+                                 forElement:[FBXCElementSnapshotWrapper ensureWrapped:element]];
     if (rc < 0) {
       return rc;
     }
@@ -355,8 +356,8 @@ static NSString *const topNodeIndexPath = @"top";
 {
   NSAssert((indexPath == nil && elementStore == nil) || (indexPath != nil && elementStore != nil), @"Either both or none of indexPath and elementStore arguments should be equal to nil", nil);
 
-  XCElementSnapshot *currentSnapshot;
-  NSArray<XCElementSnapshot *> *children;
+  id<FBXCElementSnapshot> currentSnapshot;
+  NSArray<id<FBXCElementSnapshot>> *children;
   if ([root isKindOfClass:XCUIElement.class]) {
     XCUIElement *element = (XCUIElement *)root;
     NSMutableArray<NSString *> *snapshotAttributes = [NSMutableArray arrayWithArray:FBStandardAttributeNames()];
@@ -370,7 +371,7 @@ static NSString *const topNodeIndexPath = @"top";
                                                 maxDepth:nil];
     children = currentSnapshot.children;
   } else {
-    currentSnapshot = (XCElementSnapshot *)root;
+    currentSnapshot = (id<FBXCElementSnapshot>)root;
     children = currentSnapshot.children;
   }
 
@@ -378,9 +379,10 @@ static NSString *const topNodeIndexPath = @"top";
     [elementStore setObject:currentSnapshot forKey:topNodeIndexPath];
   }
 
-  int rc = xmlTextWriterStartElement(writer, (xmlChar *)[currentSnapshot.wdType UTF8String]);
+  FBXCElementSnapshotWrapper *wrappedSnapshot = [FBXCElementSnapshotWrapper ensureWrapped:currentSnapshot];
+  int rc = xmlTextWriterStartElement(writer, (xmlChar *)[wrappedSnapshot.wdType UTF8String]);
   if (rc < 0) {
-    [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterStartElement for the tag value '%@'. Error code: %d", currentSnapshot.wdType, rc];
+    [FBLogger logFmt:@"Failed to invoke libxml2>xmlTextWriterStartElement for the tag value '%@'. Error code: %d", wrappedSnapshot.wdType, rc];
     return rc;
   }
 
@@ -393,12 +395,12 @@ static NSString *const topNodeIndexPath = @"top";
   }
 
   for (NSUInteger i = 0; i < [children count]; i++) {
-    XCElementSnapshot *childSnapshot = [children objectAtIndex:i];
+    id<FBXCElementSnapshot> childSnapshot = [children objectAtIndex:i];
     NSString *newIndexPath = (indexPath != nil) ? [indexPath stringByAppendingFormat:@",%lu", (unsigned long)i] : nil;
     if (elementStore != nil && newIndexPath != nil) {
       [elementStore setObject:childSnapshot forKey:(id)newIndexPath];
     }
-    rc = [self writeXmlWithRootElement:childSnapshot
+    rc = [self writeXmlWithRootElement:[FBXCElementSnapshotWrapper ensureWrapped:childSnapshot]
                              indexPath:newIndexPath
                           elementStore:elementStore
                     includedAttributes:includedAttributes

package/WebDriverAgentLib/Utilities/NSPredicate+FBFormat.h

@@ -23,7 +23,20 @@ NS_ASSUME_NONNULL_BEGIN
  @return formatted predicate
  @throw FBUnknownPredicateKeyException in case the given property name is not declared in FBElement protocol
  */
-+ (NSPredicate *)fb_formatSearchPredicate:(NSPredicate *)input;
++ (instancetype)fb_formatSearchPredicate:(NSPredicate *)input;
+
+/**
+ Creates a block predicate expression, which properly evalluates the given raw predicate agains
+ xctest hierarchy. Vanilla string predicates don't work on this hierachy because "raw" snapshots
+ don't have any of the custom properties declared in FBElement protocol.
+ `fb_formatSearchPredicate` is called automtically on the original predicate before
+ making it to a block.
+ 
+ @param input predicate object received from user input
+ @return formatted predicate
+ @throw FBUnknownPredicateKeyException in case the given property name is not declared in FBElement protocol
+ */
++ (instancetype)fb_snapshotBlockPredicateWithPredicate:(NSPredicate *)input;
 
 @end