@devicelab/maestro-runner-darwin-x64 1.1.25

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIElement+FBTyping.m

@@ -0,0 +1,199 @@
+/**
+ * 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.
+ */
+
+#import "XCUIElement+FBTyping.h"
+
+#import "FBConfiguration.h"
+#import "FBErrorBuilder.h"
+#import "FBXCElementSnapshotWrapper.h"
+#import "FBXCElementSnapshotWrapper+Helpers.h"
+#import "FBXCodeCompatibility.h"
+#import "FBXCTestDaemonsProxy.h"
+#import "NSString+FBVisualLength.h"
+#import "XCUIDevice+FBHelpers.h"
+#import "XCUIElement+FBCaching.h"
+#import "XCUIElement+FBUtilities.h"
+#import "XCSynthesizedEventRecord.h"
+#import "XCPointerEventPath.h"
+
+#define MAX_TEXT_ABBR_LEN 12
+#define MAX_CLEAR_RETRIES 3
+
+BOOL FBTypeText(NSString *text, NSUInteger typingSpeed, NSError **error)
+{
+  NSString *name = text.length <= MAX_TEXT_ABBR_LEN
+    ? [NSString stringWithFormat:@"Type '%@'", text]
+    : [NSString stringWithFormat:@"Type '%@…'", [text substringToIndex:MAX_TEXT_ABBR_LEN]];
+  XCSynthesizedEventRecord *eventRecord = [[XCSynthesizedEventRecord alloc] initWithName:name];
+  XCPointerEventPath *ep = [[XCPointerEventPath alloc] initForTextInput];
+  [ep typeText:text
+      atOffset:0.0
+   typingSpeed:typingSpeed
+  shouldRedact:NO];
+  [eventRecord addPointerEventPath:ep];
+  return [FBXCTestDaemonsProxy synthesizeEventWithRecord:eventRecord error:error];
+}
+
+@interface NSString (FBRepeat)
+
+- (NSString *)fb_repeatTimes:(NSUInteger)times;
+
+@end
+
+@implementation NSString (FBRepeat)
+
+- (NSString *)fb_repeatTimes:(NSUInteger)times {
+  return [@"" stringByPaddingToLength:times * self.length
+                           withString:self
+                      startingAtIndex:0];
+}
+
+@end
+
+
+@interface FBXCElementSnapshotWrapper (FBKeyboardFocus)
+
+- (BOOL)fb_hasKeyboardFocus;
+
+@end
+
+@implementation FBXCElementSnapshotWrapper (FBKeyboardFocus)
+
+- (BOOL)fb_hasKeyboardFocus
+{
+  // https://developer.apple.com/documentation/xctest/xcuielement/1500968-typetext?language=objc
+  // > The element or a descendant must have keyboard focus; otherwise an error is raised.
+  return self.hasKeyboardFocus || [self descendantsByFilteringWithBlock:^BOOL(id<FBXCElementSnapshot> snapshot) {
+    return snapshot.hasKeyboardFocus;
+  }].count > 0;
+}
+
+@end
+
+
+@implementation XCUIElement (FBTyping)
+
+- (void)fb_prepareForTextInputWithSnapshot:(FBXCElementSnapshotWrapper *)snapshot
+{
+  if (snapshot.fb_hasKeyboardFocus) {
+    return;
+  }
+
+  [FBLogger logFmt:@"Neither the \"%@\" element itself nor its accessible descendants have the keyboard input focus", snapshot.fb_description];
+// There is no possibility to open the keyboard by tapping a field in TvOS
+#if !TARGET_OS_TV
+  [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_standardSnapshot];
+#endif
+}
+
+- (BOOL)fb_typeText:(NSString *)text
+        shouldClear:(BOOL)shouldClear
+              error:(NSError **)error
+{
+  return [self fb_typeText:text
+               shouldClear:shouldClear
+                 frequency:FBConfiguration.maxTypingFrequency
+                     error:error];
+}
+
+- (BOOL)fb_typeText:(NSString *)text
+        shouldClear:(BOOL)shouldClear
+          frequency:(NSUInteger)frequency
+              error:(NSError **)error
+{
+  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]) {
+    return NO;
+  }
+  return FBTypeText(text, frequency, error);
+}
+
+- (BOOL)fb_clearTextWithError:(NSError **)error
+{
+  id<FBXCElementSnapshot> snapshot = [self fb_standardSnapshot];
+  return [self fb_clearTextWithSnapshot:[FBXCElementSnapshotWrapper ensureWrapped:snapshot]
+                  shouldPrepareForInput:YES
+                                  error:error];
+}
+
+- (BOOL)fb_clearTextWithSnapshot:(FBXCElementSnapshotWrapper *)snapshot
+           shouldPrepareForInput:(BOOL)shouldPrepareForInput
+                           error:(NSError **)error
+{
+  id currentValue = snapshot.value;
+  if (nil != currentValue && ![currentValue isKindOfClass:NSString.class]) {
+    return [[[FBErrorBuilder builder]
+             withDescriptionFormat:@"The value of '%@' is not a string and thus cannot be edited", snapshot.fb_description]
+            buildError:error];
+  }
+
+  if (nil == currentValue || 0 == [currentValue fb_visualLength]) {
+    // Short circuit if the content is not present
+    return YES;
+  }
+
+  static NSString *backspaceDeleteSequence;
+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    backspaceDeleteSequence = [[NSString alloc] initWithData:(NSData *)[@"\\u0008\\u007F" dataUsingEncoding:NSASCIIStringEncoding]
+                                                    encoding:NSNonLossyASCIIStringEncoding];
+  });
+
+  NSUInteger preClearTextLength = [currentValue fb_visualLength];
+  NSString *backspacesToType = [backspaceDeleteSequence fb_repeatTimes:preClearTextLength];
+
+#if TARGET_OS_IOS
+  NSUInteger retry = 0;
+  NSString *placeholderValue = snapshot.placeholderValue;
+  do {
+    // the ios needs to have keyboard focus to clear text
+    if (shouldPrepareForInput && 0 == retry) {
+      [self fb_prepareForTextInputWithSnapshot:snapshot];
+    }
+
+    if (retry == 0 && FBConfiguration.useClearTextShortcut) {
+      // 1st attempt is via the IOHIDEvent as the fastest operation
+      // https://github.com/appium/appium/issues/19389
+      [[XCUIDevice sharedDevice] fb_performIOHIDEventWithPage:0x07  // kHIDPage_KeyboardOrKeypad
+                                                        usage:0x9c  // kHIDUsage_KeyboardClear
+                                                     duration:0.01
+                                                        error:nil];
+    } else if (retry >= MAX_CLEAR_RETRIES - 1) {
+      // Last chance retry. Tripple-tap the field to select its content
+      [self tapWithNumberOfTaps:3 numberOfTouches:1];
+      return FBTypeText(backspaceDeleteSequence, FBConfiguration.defaultTypingFrequency, error);
+    } else if (!FBTypeText(backspacesToType, FBConfiguration.defaultTypingFrequency, error)) {
+      // 2nd operation
+      return NO;
+    }
+
+    currentValue = [self fb_standardSnapshot].value;
+    if (nil != placeholderValue && [currentValue isEqualToString:placeholderValue]) {
+      // Short circuit if only the placeholder value left
+      return YES;
+    }
+    preClearTextLength = [currentValue fb_visualLength];
+
+    retry++;
+  } while (preClearTextLength > 0);
+  return YES;
+#else
+  // tvOS does not need a focus.
+  // kHIDPage_KeyboardOrKeypad did not work for tvOS's search field. (tvOS 17 at least)
+  // Tested XCUIElementTypeSearchField and XCUIElementTypeTextView whch were
+  // common search field and email/passowrd input in tvOS apps.
+  return FBTypeText(backspacesToType, FBConfiguration.defaultTypingFrequency, error);
+#endif
+}
+
+@end

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIElement+FBUID.h

@@ -0,0 +1,42 @@
+/**
+ * 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.
+ */
+
+#import "FBXCElementSnapshotWrapper.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface XCUIElement (FBUID)
+
+/*! Represents unique internal element identifier, which is the same for an element and its snapshot as UUIDv4 */
+@property (nonatomic, nullable, readonly, copy) NSString *fb_uid;
+
+/*! Represents unique internal element identifier, which is the same for an element and its snapshot */
+@property (nonatomic, readonly) unsigned long long fb_accessibiltyId;
+
+@end
+
+
+@interface FBXCElementSnapshotWrapper (FBUID)
+
+/*! Represents unique internal element identifier, which is the same for an element and its snapshot as UUIDv4 */
+@property (nonatomic, nullable, readonly, copy) NSString *fb_uid;
+
+/*! Represents unique internal element identifier, which is the same for an element and its snapshot */
+@property (nonatomic, readonly) unsigned long long fb_accessibiltyId;
+
+/**
+ Fetches wdUID attribute value for the given snapshot instance
+
+ @param snapshot snapshot instance
+ @return UID attribute value
+ */
++ (nullable NSString *)wdUIDWithSnapshot:(id<FBXCElementSnapshot>)snapshot;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIElement+FBUID.m

@@ -0,0 +1,85 @@
+/**
+ * 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.
+ */
+
+#import <objc/runtime.h>
+
+#import "XCUIElement+FBUID.h"
+
+#import "FBElementUtils.h"
+#import "FBLogger.h"
+#import "XCUIApplication.h"
+#import "XCUIElement+FBUtilities.h"
+
+@implementation XCUIElement (FBUID)
+
+- (unsigned long long)fb_accessibiltyId
+{
+  return [FBElementUtils idWithAccessibilityElement:([self isKindOfClass:XCUIApplication.class]
+                                                     ? [(XCUIApplication *)self accessibilityElement]
+                                                     : [self fb_standardSnapshot].accessibilityElement)];
+}
+
+- (NSString *)fb_uid
+{
+  return [self isKindOfClass:XCUIApplication.class]
+    ? [FBElementUtils uidWithAccessibilityElement:[(XCUIApplication *)self accessibilityElement]]
+    : [FBXCElementSnapshotWrapper ensureWrapped:[self fb_standardSnapshot]].fb_uid;
+}
+
+@end
+
+@implementation FBXCElementSnapshotWrapper (FBUID)
+
+static void swizzled_validatePredicateWithExpressionsAllowed(id self, SEL _cmd, id predicate, BOOL withExpressionsAllowed)
+{
+}
+
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wobjc-load-method"
+#pragma clang diagnostic ignored "-Wcast-function-type-strict"
++ (void)load
+{
+  Class XCElementSnapshotCls = objc_lookUpClass("XCElementSnapshot");
+  NSAssert(XCElementSnapshotCls != nil, @"Could not locate XCElementSnapshot class");
+  Method uidMethod = class_getInstanceMethod(self.class, @selector(fb_uid));
+  class_addMethod(XCElementSnapshotCls, @selector(fb_uid), method_getImplementation(uidMethod), method_getTypeEncoding(uidMethod));
+  
+  // Support for Xcode 14.3 requires disabling the new predicate validator, see https://github.com/appium/appium/issues/18444
+  Class XCTElementQueryTransformerPredicateValidatorCls = objc_lookUpClass("XCTElementQueryTransformerPredicateValidator");
+  if (XCTElementQueryTransformerPredicateValidatorCls == nil) {
+    return;
+  }
+  Method validatePredicateMethod = class_getClassMethod(XCTElementQueryTransformerPredicateValidatorCls, NSSelectorFromString(@"validatePredicate:withExpressionsAllowed:"));
+  if (validatePredicateMethod == nil) {
+    [FBLogger log:@"Could not find method +[XCTElementQueryTransformerPredicateValidator validatePredicate:withExpressionsAllowed:]"];
+    return;
+  }
+  IMP swizzledImp = (IMP)swizzled_validatePredicateWithExpressionsAllowed;
+  method_setImplementation(validatePredicateMethod, swizzledImp);  
+}
+#pragma diagnostic pop
+
+- (unsigned long long)fb_accessibiltyId
+{
+  return [FBElementUtils idWithAccessibilityElement:self.accessibilityElement];
+}
+
++ (nullable NSString *)wdUIDWithSnapshot:(id<FBXCElementSnapshot>)snapshot
+{
+  return [FBElementUtils uidWithAccessibilityElement:[snapshot accessibilityElement]];
+}
+
+- (NSString *)fb_uid
+{
+  if ([self isKindOfClass:FBXCElementSnapshotWrapper.class]) {
+    return [self.class wdUIDWithSnapshot:self.snapshot];
+  }
+  return [FBElementUtils uidWithAccessibilityElement:[self accessibilityElement]];
+}
+
+@end

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIElement+FBUtilities.h

@@ -0,0 +1,106 @@
+/**
+ * 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.
+ */
+
+#import <XCTest/XCTest.h>
+#import <WebDriverAgentLib/FBElement.h>
+#import <WebDriverAgentLib/FBXCElementSnapshot.h>
+
+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
+ - Sometimes `frame` properties may be off.
+
+ @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
+
+ @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_customSnapshot;
+
+/**
+ Gets the most recent snapshot of the current element. The element will be
+ automatically resolved if the snapshot is not available yet.
+ Calls to this method mutate the `lastSnapshot` instance property.
+ The maximum snapshot tree depth is set by `FBConfiguration.snapshotMaxDepth`
+
+ Snapshot specifics:
+ - Less performant in comparison to the custom one. Internally, it calls same APIs
+ that fb_customSnapshot does, although this one has some additional logic to ensure
+ the snapshot is valid. It also may make retries, which slows the call down significantly.
+ - The `hittable` property calculation is aligned with the native calculation logic
+
+ @return The recent snapshot of the element
+ @throws FBStaleElementException if the element is not present in DOM and thus no snapshot could be made
+ */
+- (id<FBXCElementSnapshot>)fb_nativeSnapshot;
+
+/**
+ Extracts the cached element snapshot from its query.
+ No requests to the accessiblity framework is made.
+ It is only safe to use this call right after element lookup query
+ has been executed.
+
+ @return Either the cached snapshot or nil
+ */
+- (nullable id<FBXCElementSnapshot>)fb_cachedSnapshot;
+
+/**
+ Filters elements by matching them to snapshots from the corresponding array
+
+ @param snapshots Array of snapshots to be matched with
+ @param onlyChildren Whether to only look for direct element children
+
+ @return Array of filtered elements, which have matches in snapshots array
+ */
+- (NSArray<XCUIElement *> *)fb_filterDescendantsWithSnapshots:(NSArray<id<FBXCElementSnapshot>> *)snapshots
+                                                 onlyChildren:(BOOL)onlyChildren;
+
+/**
+ Waits until element snapshot is stable to avoid "Error copying attributes -25202 error".
+ This error usually happens for testmanagerd if there is an active UI animation in progress and
+ causes 15-seconds delay while getting hitpoint value of element's snapshot.
+*/
+- (void)fb_waitUntilStable;
+
+/**
+ Waits for receiver's snapshot to become stable with the given timeout
+
+ @param timeout The max time to wait util the snapshot is stable
+*/
+- (void)fb_waitUntilStableWithTimeout:(NSTimeInterval)timeout;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIElement+FBUtilities.m

@@ -0,0 +1,170 @@
+/**
+ * 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.
+ */
+
+#import "XCUIElement+FBUtilities.h"
+
+#import <objc/runtime.h>
+
+#import "FBConfiguration.h"
+#import "FBExceptions.h"
+#import "FBImageUtils.h"
+#import "FBElementUtils.h"
+#import "FBLogger.h"
+#import "FBMacros.h"
+#import "FBMathUtils.h"
+#import "FBRunLoopSpinner.h"
+#import "FBSettings.h"
+#import "FBScreenshot.h"
+#import "FBXCAXClientProxy.h"
+#import "FBXCodeCompatibility.h"
+#import "FBXCElementSnapshot.h"
+#import "FBXCElementSnapshotWrapper+Helpers.h"
+#import "XCUIApplication.h"
+#import "XCUIApplication+FBQuiescence.h"
+#import "XCUIApplicationImpl.h"
+#import "XCUIApplicationProcess.h"
+#import "XCTElementSetTransformer-Protocol.h"
+#import "XCTestPrivateSymbols.h"
+#import "XCTRunnerDaemonSession.h"
+#import "XCUIApplicationProcess+FBQuiescence.h"
+#import "XCUIApplication.h"
+#import "XCUIElement+FBCaching.h"
+#import "XCUIElement+FBWebDriverAttributes.h"
+#import "XCUIElementQuery.h"
+#import "XCUIElementQuery+FBHelpers.h"
+#import "XCUIElement+FBUID.h"
+#import "XCUIScreen.h"
+#import "XCUIElement+FBResolve.h"
+
+@implementation XCUIElement (FBUtilities)
+
+- (id<FBXCElementSnapshot>)fb_takeSnapshot:(BOOL)isCustom
+{
+  __block id<FBXCElementSnapshot> snapshot = nil;
+  @autoreleasepool {
+    NSError *error = nil;
+    snapshot = isCustom
+      ? [self.fb_query fb_uniqueSnapshotWithError:&error]
+      : (id<FBXCElementSnapshot>)[self snapshotWithError:&error];
+    if (nil == snapshot) {
+      [self fb_raiseStaleElementExceptionWithError:error];
+    }
+  }
+  self.lastSnapshot = snapshot;
+  return self.lastSnapshot;
+}
+
+- (id<FBXCElementSnapshot>)fb_standardSnapshot
+{
+  return [self fb_takeSnapshot:NO];
+}
+
+- (id<FBXCElementSnapshot>)fb_customSnapshot
+{
+  return [self fb_takeSnapshot:YES];
+}
+
+- (id<FBXCElementSnapshot>)fb_nativeSnapshot
+{
+  NSError *error = nil;
+  BOOL isSuccessful = [self resolveOrRaiseTestFailure:NO error:&error];
+  if (nil == self.lastSnapshot || !isSuccessful) {
+    [self fb_raiseStaleElementExceptionWithError:error];
+  }
+  return self.lastSnapshot;
+}
+
+- (id<FBXCElementSnapshot>)fb_cachedSnapshot
+{
+  return [self.query fb_cachedSnapshot];
+}
+
+- (NSArray<XCUIElement *> *)fb_filterDescendantsWithSnapshots:(NSArray<id<FBXCElementSnapshot>> *)snapshots
+                                                 onlyChildren:(BOOL)onlyChildren
+{
+  if (0 == snapshots.count) {
+    return @[];
+  }
+  NSMutableArray<NSString *> *matchedIds = [NSMutableArray new];
+  for (id<FBXCElementSnapshot> snapshot in snapshots) {
+    @autoreleasepool {
+      NSString *uid = [FBXCElementSnapshotWrapper wdUIDWithSnapshot:snapshot];
+      if (nil != uid) {
+        [matchedIds addObject:uid];
+      }
+    }
+  }
+  NSMutableArray<XCUIElement *> *matchedElements = [NSMutableArray array];
+  NSString *uid = nil == self.lastSnapshot
+    ? self.fb_uid
+    : [FBXCElementSnapshotWrapper wdUIDWithSnapshot:self.lastSnapshot];
+  if (nil != uid && [matchedIds containsObject:uid]) {
+    XCUIElement *stableSelf = [self fb_stableInstanceWithUid:uid];
+    if (1 == snapshots.count) {
+      return @[stableSelf];
+    }
+    [matchedElements addObject:stableSelf];
+  }
+  XCUIElementType type = XCUIElementTypeAny;
+  NSArray<NSNumber *> *uniqueTypes = [snapshots valueForKeyPath:[NSString stringWithFormat:@"@distinctUnionOfObjects.%@", FBStringify(XCUIElement, elementType)]];
+  if (uniqueTypes && [uniqueTypes count] == 1) {
+    type = [uniqueTypes.firstObject intValue];
+  }
+  XCUIElementQuery *query = onlyChildren
+    ? [self.fb_query childrenMatchingType:type]
+    : [self.fb_query descendantsMatchingType:type];
+  
+  NSPredicate *predicate = [NSPredicate predicateWithFormat:@"%K IN %@",FBStringify(FBXCElementSnapshotWrapper, fb_uid), matchedIds];
+  [matchedElements addObjectsFromArray:[query matchingPredicate:predicate].allElementsBoundByIndex];
+
+  for (XCUIElement *el in matchedElements) {
+    el.fb_isResolvedNatively = @NO;
+  }
+  return matchedElements.copy;
+}
+
+- (void)fb_waitUntilStable
+{
+  [self fb_waitUntilStableWithTimeout:FBConfiguration.waitForIdleTimeout];
+}
+
+- (void)fb_waitUntilStableWithTimeout:(NSTimeInterval)timeout
+{
+  if (timeout < DBL_EPSILON) {
+    return;
+  }
+
+  NSTimeInterval previousTimeout = FBConfiguration.waitForIdleTimeout;
+  BOOL previousQuiescence = self.application.fb_shouldWaitForQuiescence;
+  FBConfiguration.waitForIdleTimeout = timeout;
+  if (!previousQuiescence) {
+    self.application.fb_shouldWaitForQuiescence = YES;
+  }
+  [[[self.application applicationImpl] currentProcess]
+   fb_waitForQuiescenceIncludingAnimationsIdle:YES];
+  if (previousQuiescence != self.application.fb_shouldWaitForQuiescence) {
+    self.application.fb_shouldWaitForQuiescence = previousQuiescence;
+  }
+  FBConfiguration.waitForIdleTimeout = previousTimeout;
+}
+
+- (void)fb_raiseStaleElementExceptionWithError:(NSError *)error __attribute__((noreturn))
+{
+  NSString *hintText = @"Make sure the application UI has the expected state";
+  if (nil != error && [error.localizedDescription containsString:@"Identity Binding"]) {
+    hintText = [NSString stringWithFormat:@"%@. You could also try to switch the binding strategy using the 'boundElementsByIndex' setting for the element lookup", hintText];
+  }
+  NSString *reason = [NSString stringWithFormat:@"The previously found element \"%@\" is not present in the current view anymore. %@",
+                      self.description, hintText];
+  if (nil != error) {
+    reason = [NSString stringWithFormat:@"%@. Original error: %@", reason, error.localizedDescription];
+  }
+  @throw [NSException exceptionWithName:FBStaleElementException reason:reason userInfo:@{}];
+}
+
+@end

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIElement+FBVisibleFrame.h

@@ -0,0 +1,35 @@
+/**
+ * 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.
+ */
+
+#import "FBXCElementSnapshotWrapper.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface XCUIElement (FBVisibleFrame)
+
+/**
+ Returns the snapshot visibleFrame with a fallback to direct attribute retrieval from FBXCAXClient in case of a snapshot fault (nil visibleFrame)
+
+ @return the snapshot visibleFrame
+ */
+- (CGRect)fb_visibleFrame;
+
+@end
+
+@interface FBXCElementSnapshotWrapper (FBVisibleFrame)
+
+/**
+ Returns the snapshot visibleFrame with a fallback to direct attribute retrieval from FBXCAXClient in case of a snapshot fault (nil visibleFrame)
+
+ @return the snapshot visibleFrame
+ */
+- (CGRect)fb_visibleFrame;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIElement+FBVisibleFrame.m

@@ -0,0 +1,52 @@
+/**
+ * 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.
+ */
+
+#import "XCUIElement+FBVisibleFrame.h"
+#import "FBElementUtils.h"
+#import "FBXCodeCompatibility.h"
+#import "FBXCElementSnapshotWrapper+Helpers.h"
+#import "XCUIElement+FBUtilities.h"
+#import "XCTestPrivateSymbols.h"
+
+@implementation XCUIElement (FBVisibleFrame)
+
+- (CGRect)fb_visibleFrame
+{
+  id<FBXCElementSnapshot> snapshot = [self fb_standardSnapshot];
+  return [FBXCElementSnapshotWrapper ensureWrapped:snapshot].fb_visibleFrame;
+}
+
+@end
+
+@implementation FBXCElementSnapshotWrapper (FBVisibleFrame)
+
+- (CGRect)fb_visibleFrame
+{
+  CGRect thisVisibleFrame = [self visibleFrame];
+  if (!CGRectIsEmpty(thisVisibleFrame)) {
+    return thisVisibleFrame;
+  }
+
+  NSDictionary *visibleFrameDict = [self fb_attributeValue:FB_XCAXAVisibleFrameAttributeName
+                                                     error:nil];
+  if (nil == visibleFrameDict) {
+    return thisVisibleFrame;
+  }
+
+  id x = [visibleFrameDict objectForKey:@"X"];
+  id y = [visibleFrameDict objectForKey:@"Y"];
+  id height = [visibleFrameDict objectForKey:@"Height"];
+  id width = [visibleFrameDict objectForKey:@"Width"];
+  if (x != nil && y != nil && height != nil && width != nil) {
+    return CGRectMake([x doubleValue], [y doubleValue], [width doubleValue], [height doubleValue]);
+  }
+
+  return thisVisibleFrame;
+}
+
+@end