appium-webdriveragent 3.9.2 → 3.12.0

package/WebDriverAgentLib/Routing/FBElementCache.m

@@ -9,7 +9,7 @@
 
 #import "FBElementCache.h"
 
-#import "YYCache.h"
+#import "LRUCache.h"
 #import "FBAlert.h"
 #import "FBExceptions.h"
 #import "FBXCodeCompatibility.h"
@@ -19,11 +19,14 @@
 #import "XCUIElement+FBUtilities.h"
 #import "XCUIElement+FBWebDriverAttributes.h"
 #import "XCUIElement+FBUID.h"
+#import "XCUIElement+FBResolve.h"
+#import "XCUIElementQuery.h"
 
 const int ELEMENT_CACHE_SIZE = 1024;
 
 @interface FBElementCache ()
-@property (atomic, strong) YYMemoryCache *elementCache;
+@property (nonatomic, strong) LRUCache *elementCache;
+@property (nonatomic) BOOL elementsNeedReset;
 @end
 
 @implementation FBElementCache
@@ -34,8 +37,8 @@ const int ELEMENT_CACHE_SIZE = 1024;
   if (!self) {
     return nil;
   }
-  _elementCache = [[YYMemoryCache alloc] init];
-  _elementCache.countLimit = ELEMENT_CACHE_SIZE;
+  _elementCache = [[LRUCache alloc] initWithCapacity:ELEMENT_CACHE_SIZE];
+  _elementsNeedReset = YES;
   return self;
 }
 
@@ -45,7 +48,10 @@ const int ELEMENT_CACHE_SIZE = 1024;
   if (nil == uuid) {
     return nil;
   }
-  [self.elementCache setObject:element forKey:uuid];
+  @synchronized (self.elementCache) {
+    [self.elementCache setObject:element forKey:uuid];
+  }
+  self.elementsNeedReset = YES;
   return uuid;
 }
 
@@ -63,7 +69,15 @@ const int ELEMENT_CACHE_SIZE = 1024;
     @throw [NSException exceptionWithName:FBInvalidArgumentException reason:reason userInfo:@{}];
   }
 
-  XCUIElement *element = [self.elementCache objectForKey:uuid];
+  XCUIElement *element;
+  @synchronized (self.elementCache) {
+    [self resetElements];
+    element = [self.elementCache objectForKey:uuid];
+  }
+  if (nil == element) {
+    NSString *reason = [NSString stringWithFormat:@"The element identified by \"%@\" is either not present or it has expired from the internal cache. Try to find it again", uuid];
+    @throw [NSException exceptionWithName:FBStaleElementException reason:reason userInfo:@{}];
+  }
   // This will throw FBStaleElementException exception if the element is stale
   // or resolve the element and set lastSnapshot property
   if (nil == additionalAttributes) {
@@ -73,17 +87,34 @@ const int ELEMENT_CACHE_SIZE = 1024;
     [attributes addObjectsFromArray:additionalAttributes];
     [element fb_snapshotWithAttributes:attributes.copy maxDepth:maxDepth];
   }
-  if (nil == element) {
-    NSString *reason = [NSString stringWithFormat:@"The element identified by \"%@\" is either not present or it has expired from the internal cache. Try to find it again", uuid];
-    @throw [NSException exceptionWithName:FBStaleElementException reason:reason userInfo:@{}];
-  }
   element.fb_isResolvedFromCache = @(YES);
   return element;
 }
 
 - (BOOL)hasElementWithUUID:(NSString *)uuid
 {
-  return nil == uuid ? NO : [self.elementCache containsObjectForKey:(NSString *)uuid];
+  if (nil == uuid) {
+    return NO;
+  }
+  @synchronized (self.elementCache) {
+    return nil != [self.elementCache objectForKey:(NSString *)uuid];
+  }
+}
+
+- (void)resetElements
+{
+  if (!self.elementsNeedReset) {
+    return;
+  }
+
+  for (XCUIElement *element in self.elementCache.allObjects) {
+    element.lastSnapshot = nil;
+    if (nil != element.query) {
+      element.query.rootElementSnapshot = nil;
+    }
+    element.fb_isResolvedFromCache = @(NO);
+  }
+  self.elementsNeedReset = NO;
 }
 
 @end

package/WebDriverAgentLib/Routing/FBResponsePayload.m

@@ -16,8 +16,8 @@
 #import "FBConfiguration.h"
 #import "FBMacros.h"
 #import "FBProtocolHelpers.h"
-
 #import "XCUIElementQuery.h"
+#import "XCUIElement+FBResolve.h"
 #import "XCUIElement+FBUtilities.h"
 #import "XCUIElement+FBWebDriverAttributes.h"
 
@@ -35,15 +35,21 @@ id<FBResponsePayload> FBResponseWithObject(id object)
 
 id<FBResponsePayload> FBResponseWithCachedElement(XCUIElement *element, FBElementCache *elementCache, BOOL compact)
 {
-  [elementCache storeElement:element];
+  BOOL useNativeCachingStrategy = nil == FBSession.activeSession
+    ? YES
+    : FBSession.activeSession.useNativeCachingStrategy;
+  [elementCache storeElement:(useNativeCachingStrategy ? element : element.fb_stableInstance)];
   return FBResponseWithStatus([FBCommandStatus okWithValue: FBDictionaryResponseWithElement(element, compact)]);
 }
 
 id<FBResponsePayload> FBResponseWithCachedElements(NSArray<XCUIElement *> *elements, FBElementCache *elementCache, BOOL compact)
 {
   NSMutableArray *elementsResponse = [NSMutableArray array];
+  BOOL useNativeCachingStrategy = nil == FBSession.activeSession
+    ? YES
+    : FBSession.activeSession.useNativeCachingStrategy;
   for (XCUIElement *element in elements) {
-    [elementCache storeElement:element];
+    [elementCache storeElement:(useNativeCachingStrategy ? element : element.fb_stableInstance)];
     [elementsResponse addObject:FBDictionaryResponseWithElement(element, compact)];
   }
   return FBResponseWithStatus([FBCommandStatus okWithValue:elementsResponse]);

package/WebDriverAgentLib/Routing/FBSession.h

@@ -34,6 +34,12 @@ NS_ASSUME_NONNULL_BEGIN
 /*! The action to apply to unexpected alerts. Either "accept"/"dismiss" or nil/empty string (by default) to do nothing */
 @property (nonatomic, nullable) NSString *defaultAlertAction;
 
+/*! Whether to use the native caching strategy for elements or the custom one: https://discuss.appium.io/t/elements-state-coming-from-xpath-vs-ios-predicate-string/34016 */
+@property (nonatomic) BOOL useNativeCachingStrategy;
+
+/*! Keeps cached visibility values for the current snapshots tree */
+@property (nonatomic, readonly) NSMutableDictionary<NSNumber *, NSMutableDictionary<NSString *, NSNumber *> *> *elementsVisibilityCache;
+
 + (nullable instancetype)activeSession;
 
 /**

package/WebDriverAgentLib/Routing/FBSession.m

@@ -32,9 +32,10 @@ NSString *const FBDefaultApplicationAuto = @"auto";
 
 @interface FBSession ()
 @property (nonatomic) NSString *testedApplicationBundleId;
-@property (nonatomic) NSDictionary<NSString *, FBApplication *> *applications;
-@property (nonatomic, strong, readwrite) FBApplication *testedApplication;
+@property (nonatomic) BOOL isTestedApplicationExpectedToRun;
+@property (nonatomic) BOOL shouldAppsWaitForQuiescence;
 @property (nonatomic, nullable) FBAlertsMonitor *alertsMonitor;
+@property (nonatomic, readwrite) NSMutableDictionary<NSNumber *, NSMutableDictionary<NSString *, NSNumber *> *> *elementsVisibilityCache;
 @end
 
 @interface FBSession (FBAlertsMonitorDelegate)
@@ -70,6 +71,7 @@ NSString *const FBDefaultApplicationAuto = @"auto";
 @implementation FBSession
 
 static FBSession *_activeSession = nil;
+
 + (instancetype)activeSession
 {
   return _activeSession;
@@ -77,7 +79,7 @@ static FBSession *_activeSession = nil;
 
 + (void)markSessionActive:(FBSession *)session
 {
-  if (_activeSession && _activeSession.testedApplication.bundleID != session.testedApplication.bundleID) {
+  if (_activeSession) {
     [_activeSession kill];
   }
   _activeSession = session;
@@ -97,28 +99,29 @@ static FBSession *_activeSession = nil;
 + (instancetype)initWithApplication:(FBApplication *)application
 {
   FBSession *session = [FBSession new];
+  session.useNativeCachingStrategy = YES;
   session.alertsMonitor = nil;
   session.defaultAlertAction = nil;
+  session.elementsVisibilityCache = [NSMutableDictionary dictionary];
   session.identifier = [[NSUUID UUID] UUIDString];
   session.defaultActiveApplication = FBDefaultApplicationAuto;
   session.testedApplicationBundleId = nil;
-  NSMutableDictionary *apps = [NSMutableDictionary dictionary];
+  session.isTestedApplicationExpectedToRun = nil != application && application.running;
   if (application) {
-    [apps setObject:application forKey:application.bundleID];
     session.testedApplicationBundleId = application.bundleID;
+    session.shouldAppsWaitForQuiescence = application.fb_shouldWaitForQuiescence;
   }
-  session.applications = apps.copy;
   session.elementCache = [FBElementCache new];
   [FBSession markSessionActive:session];
   return session;
 }
 
-+ (instancetype)initWithApplication:(nullable FBApplication *)application defaultAlertAction:(NSString *)defaultAlertAction
++ (instancetype)initWithApplication:(nullable FBApplication *)application
+                 defaultAlertAction:(NSString *)defaultAlertAction
 {
   FBSession *session = [self.class initWithApplication:application];
   session.alertsMonitor = [[FBAlertsMonitor alloc] init];
   session.alertsMonitor.delegate = (id<FBAlertsMonitorDelegate>)session;
-  session.alertsMonitor.application = application;
   session.defaultAlertAction = [defaultAlertAction lowercaseString];
   [session.alertsMonitor enable];
   return session;
@@ -126,14 +129,27 @@ static FBSession *_activeSession = nil;
 
 - (void)kill
 {
+  if (nil == _activeSession) {
+    return;
+  }
+
   if (nil != self.alertsMonitor) {
     [self.alertsMonitor disable];
     self.alertsMonitor = nil;
   }
 
-  if (self.testedApplicationBundleId && [FBConfiguration shouldTerminateApp]) {
-    [[self.applications objectForKey:self.testedApplicationBundleId] terminate];
+  if (self.testedApplicationBundleId && [FBConfiguration shouldTerminateApp]
+      && ![self.testedApplicationBundleId isEqualToString:FBApplication.fb_systemApplication.bundleID]) {
+    FBApplication *app = [[FBApplication alloc] initWithBundleIdentifier:self.testedApplicationBundleId];
+    if ([app running]) {
+      @try {
+        [app terminate];
+      } @catch (NSException *e) {
+        [FBLogger logFmt:@"%@", e.description];
+      }
+    }
   }
+
   _activeSession = nil;
 }
 
@@ -144,56 +160,28 @@ static FBSession *_activeSession = nil;
     : self.defaultActiveApplication;
   FBApplication *application = [FBApplication fb_activeApplicationWithDefaultBundleId:defaultBundleId];
   FBApplication *testedApplication = nil;
-  if (self.testedApplicationBundleId) {
-    testedApplication = [self.applications objectForKey:self.testedApplicationBundleId];
+  if (self.testedApplicationBundleId && self.isTestedApplicationExpectedToRun) {
+    testedApplication = nil != application.bundleID && [application.bundleID isEqualToString:self.testedApplicationBundleId]
+      ? application
+      : [[FBApplication alloc] initWithBundleIdentifier:self.testedApplicationBundleId];
   }
   if (testedApplication && !testedApplication.running) {
     NSString *description = [NSString stringWithFormat:@"The application under test with bundle id '%@' is not running, possibly crashed", self.testedApplicationBundleId];
     [[NSException exceptionWithName:FBApplicationCrashedException reason:description userInfo:nil] raise];
   }
-  if (nil != self.alertsMonitor) {
-    self.alertsMonitor.application = application;
-  }
   return application;
 }
 
-- (FBApplication *)registerApplicationWithBundleId:(NSString *)bundleIdentifier
-{
-  FBApplication *app = [self.applications objectForKey:bundleIdentifier];
-  if (!app) {
-    app = [[FBApplication alloc] initPrivateWithPath:nil bundleID:bundleIdentifier];
-    NSMutableDictionary *apps = self.applications.mutableCopy;
-    [apps setObject:app forKey:bundleIdentifier];
-    self.applications = apps.copy;
-  }
-  return app;
-}
-
-- (BOOL)unregisterApplicationWithBundleId:(NSString *)bundleIdentifier
-{
-  FBApplication *app = [self.applications objectForKey:bundleIdentifier];
-  if (app) {
-    NSMutableDictionary *apps = self.applications.mutableCopy;
-    [apps removeObjectForKey:bundleIdentifier];
-    self.applications = apps.copy;
-    return YES;
-  }
-  return NO;
-}
-
 - (FBApplication *)launchApplicationWithBundleId:(NSString *)bundleIdentifier
                          shouldWaitForQuiescence:(nullable NSNumber *)shouldWaitForQuiescence
                                        arguments:(nullable NSArray<NSString *> *)arguments
                                      environment:(nullable NSDictionary <NSString *, NSString *> *)environment
 {
-  FBApplication *app = [self registerApplicationWithBundleId:bundleIdentifier];
+  FBApplication *app = [[FBApplication alloc] initWithBundleIdentifier:bundleIdentifier];
   if (app.fb_state < 2) {
     if (nil == shouldWaitForQuiescence) {
       // Iherit the quiescence check setting from the main app under test by default
-      FBApplication *testedApplication = nil == self.testedApplicationBundleId
-        ? nil
-        : [self.applications objectForKey:self.testedApplicationBundleId];
-      app.fb_shouldWaitForQuiescence = nil == testedApplication || testedApplication.fb_shouldWaitForQuiescence;
+      app.fb_shouldWaitForQuiescence = nil != self.testedApplicationBundleId && self.shouldAppsWaitForQuiescence;
     } else {
       app.fb_shouldWaitForQuiescence = [shouldWaitForQuiescence boolValue];
     }
@@ -203,35 +191,37 @@ static FBSession *_activeSession = nil;
   } else {
     [app fb_activate];
   }
+  if (nil != self.testedApplicationBundleId
+      && [bundleIdentifier isEqualToString:(NSString *)self.testedApplicationBundleId]) {
+    self.isTestedApplicationExpectedToRun = YES;
+  }
   return app;
 }
 
 - (FBApplication *)activateApplicationWithBundleId:(NSString *)bundleIdentifier
 {
-  FBApplication *app = [self registerApplicationWithBundleId:bundleIdentifier];
+  FBApplication *app = [[FBApplication alloc] initWithBundleIdentifier:bundleIdentifier];
   [app fb_activate];
   return app;
 }
 
 - (BOOL)terminateApplicationWithBundleId:(NSString *)bundleIdentifier
 {
-  FBApplication *app = [self registerApplicationWithBundleId:bundleIdentifier];
-  BOOL result = NO;
+  FBApplication *app = [[FBApplication alloc] initWithBundleIdentifier:bundleIdentifier];
+  if (nil != self.testedApplicationBundleId
+      && [bundleIdentifier isEqualToString:(NSString *)self.testedApplicationBundleId]) {
+    self.isTestedApplicationExpectedToRun = NO;
+  }
   if (app.fb_state >= 2) {
     [app terminate];
-    result = YES;
+    return YES;
   }
-  [self unregisterApplicationWithBundleId:bundleIdentifier];
-  return result;
+  return NO;
 }
 
 - (NSUInteger)applicationStateWithBundleId:(NSString *)bundleIdentifier
 {
-  FBApplication *app = [self.applications objectForKey:bundleIdentifier];
-  if (!app) {
-    app = [[FBApplication alloc] initPrivateWithPath:nil bundleID:bundleIdentifier];
-  }
-  return app.fb_state;
+  return [[FBApplication alloc] initWithBundleIdentifier:bundleIdentifier].fb_state;
 }
 
 @end

package/WebDriverAgentLib/Utilities/FBAlertsMonitor.h

@@ -26,10 +26,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface FBAlertsMonitor : NSObject
 
-/*! The delegate which decides on what to do whwn an alert is detected  */
+/*! The delegate which decides on what to do when an alert is detected  */
 @property (nonatomic, nullable, weak) id<FBAlertsMonitorDelegate> delegate;
-/*! The active appication instance. It is updated by the session instance when necessary */
-@property (nonatomic, nullable) XCUIApplication *application;
 
 /**
  Creates an instance of alerts monitor.

package/WebDriverAgentLib/Utilities/FBAlertsMonitor.m

@@ -10,7 +10,7 @@
 #import "FBAlertsMonitor.h"
 
 #import "FBAlert.h"
-#import "XCUIApplication.h"
+#import "FBApplication.h"
 #import "XCUIApplication+FBAlert.h"
 
 static const NSTimeInterval FB_MONTORING_INTERVAL = 2.0;
@@ -26,7 +26,6 @@ static const NSTimeInterval FB_MONTORING_INTERVAL = 2.0;
 - (instancetype)init
 {
   if ((self = [super init])) {
-    _application = nil;
     _isMonitoring = NO;
     _delegate = nil;
   }
@@ -49,18 +48,12 @@ static const NSTimeInterval FB_MONTORING_INTERVAL = 2.0;
   }
 
   dispatch_async(dispatch_get_main_queue(), ^{
-    if (nil == self.application || !self.application.running) {
-      dispatch_after(dispatch_time(DISPATCH_TIME_NOW, delta), dispatch_get_main_queue(), ^{
-        [self scheduleNextTick];
-      });
-      return;
-    }
-
-    id<FBAlertsMonitorDelegate> handler = self.delegate;
-    if (nil != handler) {
-      XCUIElement *alertElement = [self.application fb_alertElement];
+    NSArray<FBApplication *> *activeApps = FBApplication.fb_activeApplications;
+    for (FBApplication *activeApp in activeApps) {
+      XCUIElement *alertElement = activeApp.fb_alertElement;
       if (nil != alertElement) {
-        [handler didDetectAlert:[FBAlert alertWithElement:alertElement]];
+        [self.delegate didDetectAlert:[FBAlert alertWithElement:alertElement]];
+        break;
       }
     }
 

package/WebDriverAgentLib/Utilities/FBCapabilities.h

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <Foundation/Foundation.h>
+
+extern NSString* const FB_CAP_USE_TEST_MANAGER_FOR_VISIBLITY_DETECTION;
+extern NSString* const FB_CAP_MAX_TYPING_FREQUNCY;
+extern NSString* const FB_CAP_USE_SINGLETON_TEST_MANAGER;
+extern NSString* const FB_CAP_DISABLE_AUTOMATIC_SCREENSHOTS;
+extern NSString* const FB_CAP_SHOULD_TERMINATE_APP;
+extern NSString* const FB_CAP_EVENT_LOOP_IDLE_DELAY_SEC;
+extern NSString* const FB_CAP_BUNDLE_ID;
+extern NSString* const FB_CAP_FORCE_APP_LAUNCH;
+extern NSString* const FB_CAP_SHOULD_WAIT_FOR_QUIESCENCE;
+extern NSString* const FB_CAP_ARGUMENTS;
+extern NSString* const FB_CAP_ENVIRNOMENT;
+extern NSString* const FB_CAP_USE_NATIVE_CACHING_STRATEGY;

package/WebDriverAgentLib/Utilities/FBCapabilities.m

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import "FBCapabilities.h"
+
+NSString* const FB_CAP_USE_TEST_MANAGER_FOR_VISIBLITY_DETECTION = @"shouldUseTestManagerForVisibilityDetection";
+NSString* const FB_CAP_MAX_TYPING_FREQUNCY = @"maxTypingFrequency";
+NSString* const FB_CAP_USE_SINGLETON_TEST_MANAGER = @"shouldUseSingletonTestManager";
+NSString* const FB_CAP_DISABLE_AUTOMATIC_SCREENSHOTS = @"disableAutomaticScreenshots";
+NSString* const FB_CAP_SHOULD_TERMINATE_APP = @"shouldTerminateApp";
+NSString* const FB_CAP_EVENT_LOOP_IDLE_DELAY_SEC = @"eventloopIdleDelaySec";
+NSString* const FB_CAP_BUNDLE_ID = @"bundleId";
+NSString* const FB_CAP_FORCE_APP_LAUNCH = @"forceAppLaunch";
+NSString* const FB_CAP_SHOULD_WAIT_FOR_QUIESCENCE = @"shouldWaitForQuiescence";
+NSString* const FB_CAP_ARGUMENTS = @"arguments";
+NSString* const FB_CAP_ENVIRNOMENT = @"environment";
+NSString* const FB_CAP_USE_NATIVE_CACHING_STRATEGY = @"useNativeCachingStrategy";

package/WebDriverAgentLib/Utilities/FBConfiguration.m

@@ -257,7 +257,12 @@ static UIInterfaceOrientation FBScreenshotOrientation = UIInterfaceOrientationUn
   // This can avoid 'Keyboard is not present' error which can happen
   // when send_keys are called by client
   [[UIKeyboardImpl sharedInstance] setAutomaticMinimizationEnabled:NO];
-  [[UIKeyboardImpl sharedInstance] setSoftwareKeyboardShownByTouch:YES];
+
+  if ([(NSObject *)[UIKeyboardImpl sharedInstance]
+       respondsToSelector:@selector(setSoftwareKeyboardShownByTouch:)]) {
+    // Xcode 13 no longer has this method
+    [[UIKeyboardImpl sharedInstance] setSoftwareKeyboardShownByTouch:YES];
+  }
 #endif
 
   void *handle = dlopen(controllerPrefBundlePath, RTLD_LAZY);

package/WebDriverAgentLib/Utilities/FBScreenshot.m

@@ -15,6 +15,7 @@
 #import "FBErrorBuilder.h"
 #import "FBImageIOScaler.h"
 #import "FBLogger.h"
+#import "FBMacros.h"
 #import "FBXCodeCompatibility.h"
 #import "FBXCTestDaemonsProxy.h"
 #import "XCTestManager_ManagerInterface-Protocol.h"
@@ -155,33 +156,143 @@ NSString *formatTimeInterval(NSTimeInterval interval) {
   __block NSData *screenshotData = nil;
   __block NSError *innerError = nil;
   dispatch_semaphore_t sem = dispatch_semaphore_create(0);
-  [proxy _XCT_requestScreenshotOfScreenWithID:screenID
-                                     withRect:CGRectNull
-                                          uti:uti
-                           compressionQuality:compressionQuality
-                                    withReply:^(NSData *data, NSError *err) {
-    if (nil != err) {
-      innerError = err;
-    } else {
-      screenshotData = data;
+  if ([self.class shouldUseScreenshotRequestApiForProxy:(NSObject *)proxy]) {
+    id screnshotRequest = [self.class screenshotRequestWithScreenID:screenID
+                                                               rect:CGRectNull
+                                                                uti:uti
+                                                 compressionQuality:compressionQuality
+                                                              error:error];
+    if (nil == screnshotRequest) {
+      return nil;
     }
-    dispatch_semaphore_signal(sem);
-  }];
-  if (nil != error && innerError) {
-    *error = innerError;
+    [proxy _XCT_requestScreenshot:screnshotRequest
+                        withReply:^(id image, NSError *err) {
+      if (nil != err) {
+        innerError = err;
+      } else {
+        screenshotData = [image data];
+      }
+      dispatch_semaphore_signal(sem);
+    }];
+  } else {
+    [proxy _XCT_requestScreenshotOfScreenWithID:screenID
+                                       withRect:CGRectNull
+                                            uti:uti
+                             compressionQuality:compressionQuality
+                                      withReply:^(NSData *data, NSError *err) {
+      if (nil != err) {
+        innerError = err;
+      } else {
+        screenshotData = data;
+      }
+      dispatch_semaphore_signal(sem);
+    }];
   }
   int64_t timeoutNs = (int64_t)(timeout * NSEC_PER_SEC);
   if (0 != dispatch_semaphore_wait(sem, dispatch_time(DISPATCH_TIME_NOW, timeoutNs))) {
     NSString *timeoutMsg = [NSString stringWithFormat:@"Cannot take a screenshot within %@ timeout", formatTimeInterval(SCREENSHOT_TIMEOUT)];
     if (nil == error) {
       [FBLogger log:timeoutMsg];
-    } else {
+    } else if (nil == innerError) {
       [[[FBErrorBuilder builder]
         withDescription:timeoutMsg]
        buildError:error];
     }
   };
+  if (nil != error && nil != innerError) {
+    *error = innerError;
+  }
   return screenshotData;
 }
 
++ (BOOL)shouldUseScreenshotRequestApiForProxy:(NSObject *)proxy
+{
+  static dispatch_once_t shouldUseSRApi;
+  static BOOL result;
+  dispatch_once(&shouldUseSRApi, ^{
+    if ([proxy respondsToSelector:@selector(_XCT_requestScreenshot:withReply:)]) {
+#if TARGET_OS_SIMULATOR
+      result = YES;
+#else
+      result = SYSTEM_VERSION_GREATER_THAN_OR_EQUAL_TO(@"15.0");
+#endif
+    } else {
+      result = NO;
+    }
+  });
+  return result;
+}
+
++ (nullable id)imageEncodingWithUniformTypeIdentifier:(NSString *)uti
+                                   compressionQuality:(CGFloat)compressionQuality
+                                                error:(NSError **)error
+{
+  // TODO: Use native accessors after we drop the support of Xcode 12.4 and below
+  Class imageEncodingClass = NSClassFromString(@"XCTImageEncoding");
+  if (nil == imageEncodingClass) {
+    [[[FBErrorBuilder builder]
+      withDescription:@"Cannot find XCTImageEncoding class"]
+     buildError:error];
+    return nil;
+  }
+  id imageEncodingAllocated = [imageEncodingClass alloc];
+  SEL imageEncodingConstructorSelector = NSSelectorFromString(@"initWithUniformTypeIdentifier:compressionQuality:");
+  if (![imageEncodingAllocated respondsToSelector:imageEncodingConstructorSelector]) {
+    [[[FBErrorBuilder builder]
+      withDescription:@"'initWithUniformTypeIdentifier:compressionQuality:' contructor is not found on XCTImageEncoding class"]
+     buildError:error];
+    return nil;
+  }
+  NSMethodSignature *imageEncodingContructorSignature = [imageEncodingAllocated methodSignatureForSelector:imageEncodingConstructorSelector];
+  NSInvocation *imageEncodingInitInvocation = [NSInvocation invocationWithMethodSignature:imageEncodingContructorSignature];
+  [imageEncodingInitInvocation setSelector:imageEncodingConstructorSelector];
+  [imageEncodingInitInvocation setArgument:&uti atIndex:2];
+  [imageEncodingInitInvocation setArgument:&compressionQuality atIndex:3];
+  [imageEncodingInitInvocation invokeWithTarget:imageEncodingAllocated];
+  id __unsafe_unretained imageEncoding;
+  [imageEncodingInitInvocation getReturnValue:&imageEncoding];
+  return imageEncoding;
+}
+
++ (nullable id)screenshotRequestWithScreenID:(unsigned int)screenID
+                                        rect:(struct CGRect)rect
+                                         uti:(NSString *)uti
+                          compressionQuality:(CGFloat)compressionQuality
+                                       error:(NSError **)error
+{
+  // TODO: Use native accessors after we drop the support of Xcode 12.4 and below
+  id imageEncoding = [self.class imageEncodingWithUniformTypeIdentifier:uti
+                                                     compressionQuality:compressionQuality
+                                                                  error:error];
+  if (nil == imageEncoding) {
+    return nil;
+  }
+
+  Class screenshotRequestClass = NSClassFromString(@"XCTScreenshotRequest");
+  if (nil == screenshotRequestClass) {
+    [[[FBErrorBuilder builder]
+      withDescription:@"Cannot find XCTScreenshotRequest class"]
+     buildError:error];
+    return nil;
+  }
+  id screenshotRequestAllocated = [screenshotRequestClass alloc];
+  SEL screenshotRequestConstructorSelector = NSSelectorFromString(@"initWithScreenID:rect:encoding:");
+  if (![screenshotRequestAllocated respondsToSelector:screenshotRequestConstructorSelector]) {
+    [[[FBErrorBuilder builder]
+      withDescription:@"'initWithScreenID:rect:encoding:' contructor is not found on XCTScreenshotRequest class"]
+     buildError:error];
+    return nil;
+  }
+  NSMethodSignature *screenshotRequestContructorSignature = [screenshotRequestAllocated methodSignatureForSelector:screenshotRequestConstructorSelector];
+  NSInvocation *screenshotRequestInitInvocation = [NSInvocation invocationWithMethodSignature:screenshotRequestContructorSignature];
+  [screenshotRequestInitInvocation setSelector:screenshotRequestConstructorSelector];
+  [screenshotRequestInitInvocation setArgument:&screenID atIndex:2];
+  [screenshotRequestInitInvocation setArgument:&rect atIndex:3];
+  [screenshotRequestInitInvocation setArgument:&imageEncoding atIndex:4];
+  [screenshotRequestInitInvocation invokeWithTarget:screenshotRequestAllocated];
+  id __unsafe_unretained screenshotRequest;
+  [screenshotRequestInitInvocation getReturnValue:&screenshotRequest];
+  return screenshotRequest;
+}
+
 @end