appium-webdriveragent 3.11.1 → 3.12.0

package/WebDriverAgent.xcodeproj/project.pbxproj

@@ -466,6 +466,10 @@
 		71D04DC925356C43008A052C /* XCUIElement+FBCaching.h in Headers */ = {isa = PBXBuildFile; fileRef = 71D04DC625356C43008A052C /* XCUIElement+FBCaching.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		71D04DCA25356C43008A052C /* XCUIElement+FBCaching.m in Sources */ = {isa = PBXBuildFile; fileRef = 71D04DC725356C43008A052C /* XCUIElement+FBCaching.m */; };
 		71D04DCB25356C43008A052C /* XCUIElement+FBCaching.m in Sources */ = {isa = PBXBuildFile; fileRef = 71D04DC725356C43008A052C /* XCUIElement+FBCaching.m */; };
+		71D3B3D5267FC7260076473D /* XCUIElement+FBResolve.h in Headers */ = {isa = PBXBuildFile; fileRef = 71D3B3D3267FC7260076473D /* XCUIElement+FBResolve.h */; };
+		71D3B3D6267FC7260076473D /* XCUIElement+FBResolve.h in Headers */ = {isa = PBXBuildFile; fileRef = 71D3B3D3267FC7260076473D /* XCUIElement+FBResolve.h */; };
+		71D3B3D7267FC7260076473D /* XCUIElement+FBResolve.m in Sources */ = {isa = PBXBuildFile; fileRef = 71D3B3D4267FC7260076473D /* XCUIElement+FBResolve.m */; };
+		71D3B3D8267FC7260076473D /* XCUIElement+FBResolve.m in Sources */ = {isa = PBXBuildFile; fileRef = 71D3B3D4267FC7260076473D /* XCUIElement+FBResolve.m */; };
 		71D475C22538F5A8008D9401 /* XCUIApplicationProcess+FBQuiescence.h in Headers */ = {isa = PBXBuildFile; fileRef = 71D475C02538F5A8008D9401 /* XCUIApplicationProcess+FBQuiescence.h */; };
 		71D475C32538F5A8008D9401 /* XCUIApplicationProcess+FBQuiescence.h in Headers */ = {isa = PBXBuildFile; fileRef = 71D475C02538F5A8008D9401 /* XCUIApplicationProcess+FBQuiescence.h */; };
 		71D475C42538F5A8008D9401 /* XCUIApplicationProcess+FBQuiescence.m in Sources */ = {isa = PBXBuildFile; fileRef = 71D475C12538F5A8008D9401 /* XCUIApplicationProcess+FBQuiescence.m */; };
@@ -1033,6 +1037,8 @@
 		71C9EAAB25E8415A00470CD8 /* FBScreenshot.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = FBScreenshot.m; sourceTree = "<group>"; };
 		71D04DC625356C43008A052C /* XCUIElement+FBCaching.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "XCUIElement+FBCaching.h"; sourceTree = "<group>"; };
 		71D04DC725356C43008A052C /* XCUIElement+FBCaching.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "XCUIElement+FBCaching.m"; sourceTree = "<group>"; };
+		71D3B3D3267FC7260076473D /* XCUIElement+FBResolve.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "XCUIElement+FBResolve.h"; sourceTree = "<group>"; };
+		71D3B3D4267FC7260076473D /* XCUIElement+FBResolve.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "XCUIElement+FBResolve.m"; sourceTree = "<group>"; };
 		71D475C02538F5A8008D9401 /* XCUIApplicationProcess+FBQuiescence.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "XCUIApplicationProcess+FBQuiescence.h"; sourceTree = "<group>"; };
 		71D475C12538F5A8008D9401 /* XCUIApplicationProcess+FBQuiescence.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "XCUIApplicationProcess+FBQuiescence.m"; sourceTree = "<group>"; };
 		71E504941DF59BAD0020C32A /* XCUIElementAttributesTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = XCUIElementAttributesTests.m; sourceTree = "<group>"; };
@@ -1745,6 +1751,8 @@
 				EE9AB7481CAEDF0C008C271F /* XCUIElement+FBIsVisible.m */,
 				7136A4771E8918E60024FC3D /* XCUIElement+FBPickerWheel.h */,
 				7136A4781E8918E60024FC3D /* XCUIElement+FBPickerWheel.m */,
+				71D3B3D3267FC7260076473D /* XCUIElement+FBResolve.h */,
+				71D3B3D4267FC7260076473D /* XCUIElement+FBResolve.m */,
 				EE9AB7491CAEDF0C008C271F /* XCUIElement+FBScrolling.h */,
 				EE9AB74A1CAEDF0C008C271F /* XCUIElement+FBScrolling.m */,
 				71F5BE21252E576C00EE9EBA /* XCUIElement+FBSwiping.h */,
@@ -2399,6 +2407,7 @@
 				641EE6C12240C5CA00173FCB /* _XCTestObservationCenterImplementation.h in Headers */,
 				714EAA0E2673FDFE005C5B47 /* FBCapabilities.h in Headers */,
 				641EE6C22240C5CA00173FCB /* XCUIDevice+FBHelpers.h in Headers */,
+				71D3B3D6267FC7260076473D /* XCUIElement+FBResolve.h in Headers */,
 				641EE6C32240C5CA00173FCB /* FBClassChainQueryParser.h in Headers */,
 				641EE6C42240C5CA00173FCB /* FBMacros.h in Headers */,
 				641EE6C52240C5CA00173FCB /* XCTestExpectationDelegate-Protocol.h in Headers */,
@@ -2531,6 +2540,7 @@
 				EE35AD6B1E3B77D600A02D78 /* XCUIApplicationImpl.h in Headers */,
 				EE35AD201E3B77D600A02D78 /* UIPanGestureRecognizer-RecordingAdditions.h in Headers */,
 				71555A3D1DEC460A007D4A8B /* NSExpression+FBFormat.h in Headers */,
+				71D3B3D5267FC7260076473D /* XCUIElement+FBResolve.h in Headers */,
 				EE35AD0C1E3B77D600A02D78 /* _XCTestCaseImplementation.h in Headers */,
 				EE35AD211E3B77D600A02D78 /* UIPinchGestureRecognizer-RecordingAdditions.h in Headers */,
 				EE35AD4F1E3B77D600A02D78 /* XCTestManager_TestsInterface-Protocol.h in Headers */,
@@ -3045,6 +3055,7 @@
 			files = (
 				718226CF2587443700661B83 /* GCDAsyncSocket.m in Sources */,
 				E444DCBC24917A5E0060D7EB /* HTTPResponseProxy.m in Sources */,
+				71D3B3D8267FC7260076473D /* XCUIElement+FBResolve.m in Sources */,
 				E444DCBE24917A5E0060D7EB /* Route.m in Sources */,
 				E444DCC024917A5E0060D7EB /* RouteRequest.m in Sources */,
 				E444DCC224917A5E0060D7EB /* RouteResponse.m in Sources */,
@@ -3273,6 +3284,7 @@
 				EE158AE91CBD456F00A3E3F0 /* FBElementTypeTransformer.m in Sources */,
 				E444DC9D249131D40060D7EB /* HTTPMessage.m in Sources */,
 				E444DCB024913C220060D7EB /* RouteResponse.m in Sources */,
+				71D3B3D7267FC7260076473D /* XCUIElement+FBResolve.m in Sources */,
 				EE158AF61CBD456F00A3E3F0 /* FBApplication.m in Sources */,
 				715AFAC21FFA29180053896D /* FBScreen.m in Sources */,
 				71B155DC230711E900646AFB /* FBCommandStatus.m in Sources */,

package/WebDriverAgent.xcodeproj/xcuserdata/elf.xcuserdatad/xcdebugger/Breakpoints_v2.xcbkptlist

@@ -31,5 +31,21 @@
             endingLineNumber = "264">
          </BreakpointContent>
       </BreakpointProxy>
+      <BreakpointProxy
+         BreakpointExtensionID = "Xcode.Breakpoint.FileBreakpoint">
+         <BreakpointContent
+            uuid = "54216FE6-E240-47F1-88D3-D450CF0AF44E"
+            shouldBeEnabled = "Yes"
+            ignoreCount = "0"
+            continueAfterRunningActions = "No"
+            filePath = "WebDriverAgentLib/Categories/XCUIElement+FBResolve.m"
+            startingColumnNumber = "9223372036854775807"
+            endingColumnNumber = "9223372036854775807"
+            startingLineNumber = "37"
+            endingLineNumber = "37"
+            landmarkName = "-fb_stableInstance"
+            landmarkType = "7">
+         </BreakpointContent>
+      </BreakpointProxy>
    </Breakpoints>
 </Bucket>

package/WebDriverAgentLib/Categories/XCUIElement+FBResolve.h

@@ -0,0 +1,37 @@
+/**
+ * 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 <XCTest/XCTest.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface XCUIElement (FBResolve)
+
+/*! This property is always true unless the element gets resolved by its internal UUID (e.g. results of an xpath query) */
+@property (nullable, nonatomic) NSNumber *fb_isResolvedNatively;
+
+/**
+ Returns element instance based on query by element's UUID rather than any other attributes, which
+ might be a subject of change during the application life cycle. The UUID is calculated based on the PID
+ of the application to which this particular element belongs and the identifier of the underlying AXElement
+ instance. That usually guarantees the same element is always going to be matched in scope of the parent
+ application independently of its current attribute values.
+ Example: We have an element X with value Y. Our locator looks like 'value == Y'. Normally, if the element's
+ value is changed to Z and we try to reuse this cached instance of it then a StaleElement error is thrown.
+ Although, if the cached element instance is the one returned by this API call then the same element
+ is going to be matched and no staleness exception will be thrown.
+
+ @return Either the same element instance if `fb_isResolvedNatively` was set to NO (usually the cache for elements
+ matched by xpath locators) or the stable instance of the self element based on the query by element's UUID.
+ */
+- (XCUIElement *)fb_stableInstance;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Categories/XCUIElement+FBResolve.m

@@ -0,0 +1,51 @@
+/**
+ * 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 "XCUIElement+FBResolve.h"
+
+#import <objc/runtime.h>
+
+#import "XCUIElement.h"
+#import "FBXCodeCompatibility.h"
+#import "XCUIElement+FBUID.h"
+
+@implementation XCUIElement (FBResolve)
+
+static char XCUIELEMENT_IS_RESOLVED_NATIVELY_KEY;
+
+@dynamic fb_isResolvedNatively;
+
+- (void)setFb_isResolvedNatively:(NSNumber *)isResolvedNatively
+{
+  objc_setAssociatedObject(self, &XCUIELEMENT_IS_RESOLVED_NATIVELY_KEY, isResolvedNatively, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
+}
+
+- (NSNumber *)fb_isResolvedNatively
+{
+  NSNumber *result = objc_getAssociatedObject(self, &XCUIELEMENT_IS_RESOLVED_NATIVELY_KEY);
+  return nil == result ? @YES : result;
+}
+
+- (XCUIElement *)fb_stableInstance
+{
+  if (![self.fb_isResolvedNatively boolValue]) {
+    return self;
+  }
+
+  XCUIElementQuery *query = [self isKindOfClass:XCUIApplication.class]
+    ? self.application.fb_query
+    : [self.application.fb_query descendantsMatchingType:XCUIElementTypeAny];
+  XCElementSnapshot *cachedSnapshot = self.fb_cachedSnapshot;
+  NSString *uid = nil == cachedSnapshot ? self.fb_uid : cachedSnapshot.fb_uid;
+  return nil == uid
+    ? self
+    : [query matchingPredicate:[NSPredicate predicateWithFormat:@"%K = %@", FBStringify(XCUIElement, wdUID), uid]].fb_firstMatch;
+}
+
+@end

package/WebDriverAgentLib/Categories/XCUIElement+FBUtilities.m

@@ -35,6 +35,7 @@
 #import "XCUIElementQuery+FBHelpers.h"
 #import "XCUIElement+FBUID.h"
 #import "XCUIScreen.h"
+#import "XCUIElement+FBResolve.h"
 
 #define DEFAULT_AX_TIMEOUT 60.
 
@@ -113,7 +114,7 @@
   if (nil == snapshotWithAttributes) {
     [FBLogger logFmt:@"Cannot take a snapshot with attribute(s) %@ of '%@' after %.2f seconds",
      attributeNames, snapshot.fb_description, axTimeout];
-    [FBLogger logFmt:@"This timeout could be customized via '%@' setting", CUSTOM_SNAPSHOT_TIMEOUT];
+    [FBLogger logFmt:@"This timeout could be customized via '%@' setting", FB_SETTING_CUSTOM_SNAPSHOT_TIMEOUT];
     [FBLogger logFmt:@"Internal error: %@", error.localizedDescription];
     [FBLogger logFmt:@"Falling back to the default snapshotting mechanism for the element '%@' (some attribute values, like visibility or accessibility might not be precise though)", snapshot.fb_description];
     snapshotWithAttributes = self.lastSnapshot;
@@ -159,6 +160,7 @@
   query = [query matchingPredicate:[NSPredicate predicateWithFormat:@"%K IN %@", FBStringify(XCUIElement, wdUID), sortedIds]];
   if (1 == snapshots.count) {
     XCUIElement *result = query.fb_firstMatch;
+    result.fb_isResolvedNatively = @NO;
     return result ? @[result] : @[];
   }
   // Rely here on the fact, that XPath always returns query results in the same
@@ -176,7 +178,11 @@
   //    }
   //    return NSOrderedSame;
   //  }];
-  return query.fb_allMatches;
+  NSArray<XCUIElement *> *result = query.fb_allMatches;
+  for (XCUIElement *el in result) {
+    el.fb_isResolvedNatively = @NO;
+  }
+  return result;
 }
 
 - (void)fb_waitUntilStable

package/WebDriverAgentLib/Commands/FBElementCommands.m

@@ -38,6 +38,7 @@
 #import "XCUIElement+FBUtilities.h"
 #import "XCUIElement+FBWebDriverAttributes.h"
 #import "XCUIElement+FBTVFocuse.h"
+#import "XCUIElement+FBResolve.h"
 #import "FBElementTypeTransformer.h"
 #import "XCUIElement.h"
 #import "XCUIElementQuery.h"
@@ -258,7 +259,8 @@
   XCUIElement *focusedElement = request.session.activeApplication.fb_focusedElement;
   if (focusedElement != nil) {
     FBElementCache *elementCache = request.session.elementCache;
-    NSString *focusedUUID = [elementCache storeElement:focusedElement];
+    BOOL useNativeCachingStrategy = request.session.useNativeCachingStrategy;
+    NSString *focusedUUID = [elementCache storeElement:(useNativeCachingStrategy ? focusedElement : focusedElement.fb_stableInstance)];
     if (focusedUUID && [focusedUUID isEqualToString:(id)request.parameters[@"uuid"]]) {
       isFocused = YES;
     }

package/WebDriverAgentLib/Commands/FBOrientationCommands.m

@@ -40,9 +40,13 @@ const struct FBWDOrientationValues FBWDOrientationValues = {
   return
   @[
     [[FBRoute GET:@"/orientation"] respondWithTarget:self action:@selector(handleGetOrientation:)],
+    [[FBRoute GET:@"/orientation"].withoutSession respondWithTarget:self action:@selector(handleGetOrientation:)],
     [[FBRoute POST:@"/orientation"] respondWithTarget:self action:@selector(handleSetOrientation:)],
+    [[FBRoute POST:@"/orientation"].withoutSession respondWithTarget:self action:@selector(handleSetOrientation:)],
     [[FBRoute GET:@"/rotation"] respondWithTarget:self action:@selector(handleGetRotation:)],
+    [[FBRoute GET:@"/rotation"].withoutSession respondWithTarget:self action:@selector(handleGetRotation:)],
     [[FBRoute POST:@"/rotation"] respondWithTarget:self action:@selector(handleSetRotation:)],
+    [[FBRoute POST:@"/rotation"].withoutSession respondWithTarget:self action:@selector(handleSetRotation:)],
   ];
 }
 
@@ -51,15 +55,15 @@ const struct FBWDOrientationValues FBWDOrientationValues = {
 
 + (id<FBResponsePayload>)handleGetOrientation:(FBRouteRequest *)request
 {
-  FBSession *session = request.session;
-  NSString *orientation = [self.class interfaceOrientationForApplication:session.activeApplication];
+  FBApplication *application = request.session.activeApplication ?: FBApplication.fb_activeApplication;
+  NSString *orientation = [self.class interfaceOrientationForApplication:application];
   return FBResponseWithObject([[self _wdOrientationsMapping] objectForKey:orientation]);
 }
 
 + (id<FBResponsePayload>)handleSetOrientation:(FBRouteRequest *)request
 {
-  FBSession *session = request.session;
-  if ([self.class setDeviceOrientation:request.arguments[@"orientation"] forApplication:session.activeApplication]) {
+  FBApplication *application = request.session.activeApplication ?: FBApplication.fb_activeApplication;
+  if ([self.class setDeviceOrientation:request.arguments[@"orientation"] forApplication:application]) {
     return FBResponseWithOK();
   }
 
@@ -69,7 +73,8 @@ const struct FBWDOrientationValues FBWDOrientationValues = {
 + (id<FBResponsePayload>)handleGetRotation:(FBRouteRequest *)request
 {
   XCUIDevice *device = [XCUIDevice sharedDevice];
-  UIInterfaceOrientation orientation = request.session.activeApplication.interfaceOrientation;
+  FBApplication *application = request.session.activeApplication ?: FBApplication.fb_activeApplication;
+  UIInterfaceOrientation orientation = application.interfaceOrientation;
   return FBResponseWithObject(device.fb_rotationMapping[@(orientation)]);
 }
 
@@ -88,14 +93,20 @@ const struct FBWDOrientationValues FBWDOrientationValues = {
   };
   NSArray<NSDictionary *> *supportedRotations = XCUIDevice.sharedDevice.fb_rotationMapping.allValues;
   if (![supportedRotations containsObject:rotation]) {
-    NSString *errMessage = [NSString stringWithFormat:@"%@ rotation is not supported. Only the following values are supported: %@", rotation, supportedRotations];
+    NSString *errMessage = [
+      NSString stringWithFormat:@"%@ rotation is not supported. Only the following values are supported: %@",
+      rotation, supportedRotations
+    ];
     return FBResponseWithStatus([FBCommandStatus invalidArgumentErrorWithMessage:errMessage
                                                                        traceback:nil]);
   }
 
-  FBApplication *app = request.session.activeApplication;
-  if (![self.class setDeviceRotation:request.arguments forApplication:app]) {
-    NSString *errMessage = [NSString stringWithFormat:@"The current rotation cannot be set to %@. Make sure the %@ application supports it", rotation, app.bundleID];
+  FBApplication *application = request.session.activeApplication ?: FBApplication.fb_activeApplication;
+  if (![self.class setDeviceRotation:request.arguments forApplication:application]) {
+    NSString *errMessage = [
+      NSString stringWithFormat:@"The current rotation cannot be set to %@. Make sure the %@ application supports it",
+      rotation, application.bundleID
+    ];
     return FBResponseWithStatus([FBCommandStatus invalidElementStateErrorWithMessage:errMessage
                                                                            traceback:nil]);
   }

package/WebDriverAgentLib/Commands/FBSessionCommands.m

@@ -89,10 +89,10 @@
     return FBResponseWithStatus([FBCommandStatus sessionNotCreatedError:error.description traceback:nil]);
   }
   [FBConfiguration setShouldUseTestManagerForVisibilityDetection:[capabilities[FB_CAP_USE_TEST_MANAGER_FOR_VISIBLITY_DETECTION] boolValue]];
-  if (capabilities[USE_COMPACT_RESPONSES]) {
-    [FBConfiguration setShouldUseCompactResponses:[capabilities[USE_COMPACT_RESPONSES] boolValue]];
+  if (capabilities[FB_SETTING_USE_COMPACT_RESPONSES]) {
+    [FBConfiguration setShouldUseCompactResponses:[capabilities[FB_SETTING_USE_COMPACT_RESPONSES] boolValue]];
   }
-  NSString *elementResponseAttributes = capabilities[ELEMENT_RESPONSE_ATTRIBUTES];
+  NSString *elementResponseAttributes = capabilities[FB_SETTING_ELEMENT_RESPONSE_ATTRIBUTES];
   if (elementResponseAttributes) {
     [FBConfiguration setElementResponseAttributes:elementResponseAttributes];
   }
@@ -119,8 +119,8 @@
     [XCUIApplicationProcessDelay disableEventLoopDelay];
   }
 
-  if (nil != capabilities[WAIT_FOR_IDLE_TIMEOUT]) {
-    FBConfiguration.waitForIdleTimeout = [capabilities[WAIT_FOR_IDLE_TIMEOUT] doubleValue];
+  if (nil != capabilities[FB_SETTING_WAIT_FOR_IDLE_TIMEOUT]) {
+    FBConfiguration.waitForIdleTimeout = [capabilities[FB_SETTING_WAIT_FOR_IDLE_TIMEOUT] doubleValue];
   }
 
   NSString *bundleID = capabilities[FB_CAP_BUNDLE_ID];
@@ -149,13 +149,17 @@
     }
   }
 
-  if (capabilities[DEFAULT_ALERT_ACTION]) {
+  if (capabilities[FB_SETTING_DEFAULT_ALERT_ACTION]) {
     [FBSession initWithApplication:app
-                defaultAlertAction:(id)capabilities[DEFAULT_ALERT_ACTION]];
+                defaultAlertAction:(id)capabilities[FB_SETTING_DEFAULT_ALERT_ACTION]];
   } else {
     [FBSession initWithApplication:app];
   }
 
+  if (nil != capabilities[FB_CAP_USE_NATIVE_CACHING_STRATEGY]) {
+    FBSession.activeSession.useNativeCachingStrategy = [capabilities[FB_CAP_USE_NATIVE_CACHING_STRATEGY] boolValue];
+  }
+
   return FBResponseWithObject(FBSessionCommands.sessionInformation);
 }
 
@@ -256,29 +260,29 @@
 {
   return FBResponseWithObject(
     @{
-      USE_COMPACT_RESPONSES: @([FBConfiguration shouldUseCompactResponses]),
-      ELEMENT_RESPONSE_ATTRIBUTES: [FBConfiguration elementResponseAttributes],
-      MJPEG_SERVER_SCREENSHOT_QUALITY: @([FBConfiguration mjpegServerScreenshotQuality]),
-      MJPEG_SERVER_FRAMERATE: @([FBConfiguration mjpegServerFramerate]),
-      MJPEG_SCALING_FACTOR: @([FBConfiguration mjpegScalingFactor]),
-      SCREENSHOT_QUALITY: @([FBConfiguration screenshotQuality]),
-      KEYBOARD_AUTOCORRECTION: @([FBConfiguration keyboardAutocorrection]),
-      KEYBOARD_PREDICTION: @([FBConfiguration keyboardPrediction]),
-      CUSTOM_SNAPSHOT_TIMEOUT: @([FBConfiguration customSnapshotTimeout]),
-      SNAPSHOT_MAX_DEPTH: @([FBConfiguration snapshotMaxDepth]),
-      USE_FIRST_MATCH: @([FBConfiguration useFirstMatch]),
-      WAIT_FOR_IDLE_TIMEOUT: @([FBConfiguration waitForIdleTimeout]),
-      ANIMATION_COOL_OFF_TIMEOUT: @([FBConfiguration animationCoolOffTimeout]),
-      BOUND_ELEMENTS_BY_INDEX: @([FBConfiguration boundElementsByIndex]),
-      REDUCE_MOTION: @([FBConfiguration reduceMotionEnabled]),
-      DEFAULT_ACTIVE_APPLICATION: request.session.defaultActiveApplication,
-      ACTIVE_APP_DETECTION_POINT: FBActiveAppDetectionPoint.sharedInstance.stringCoordinates,
-      INCLUDE_NON_MODAL_ELEMENTS: @([FBConfiguration includeNonModalElements]),
-      ACCEPT_ALERT_BUTTON_SELECTOR: FBConfiguration.acceptAlertButtonSelector,
-      DISMISS_ALERT_BUTTON_SELECTOR: FBConfiguration.dismissAlertButtonSelector,
-      DEFAULT_ALERT_ACTION: request.session.defaultAlertAction ?: @"",
+      FB_SETTING_USE_COMPACT_RESPONSES: @([FBConfiguration shouldUseCompactResponses]),
+      FB_SETTING_ELEMENT_RESPONSE_ATTRIBUTES: [FBConfiguration elementResponseAttributes],
+      FB_SETTING_MJPEG_SERVER_SCREENSHOT_QUALITY: @([FBConfiguration mjpegServerScreenshotQuality]),
+      FB_SETTING_MJPEG_SERVER_FRAMERATE: @([FBConfiguration mjpegServerFramerate]),
+      FB_SETTING_MJPEG_SCALING_FACTOR: @([FBConfiguration mjpegScalingFactor]),
+      FB_SETTING_SCREENSHOT_QUALITY: @([FBConfiguration screenshotQuality]),
+      FB_SETTING_KEYBOARD_AUTOCORRECTION: @([FBConfiguration keyboardAutocorrection]),
+      FB_SETTING_KEYBOARD_PREDICTION: @([FBConfiguration keyboardPrediction]),
+      FB_SETTING_CUSTOM_SNAPSHOT_TIMEOUT: @([FBConfiguration customSnapshotTimeout]),
+      FB_SETTING_SNAPSHOT_MAX_DEPTH: @([FBConfiguration snapshotMaxDepth]),
+      FB_SETTING_USE_FIRST_MATCH: @([FBConfiguration useFirstMatch]),
+      FB_SETTING_WAIT_FOR_IDLE_TIMEOUT: @([FBConfiguration waitForIdleTimeout]),
+      FB_SETTING_ANIMATION_COOL_OFF_TIMEOUT: @([FBConfiguration animationCoolOffTimeout]),
+      FB_SETTING_BOUND_ELEMENTS_BY_INDEX: @([FBConfiguration boundElementsByIndex]),
+      FB_SETTING_REDUCE_MOTION: @([FBConfiguration reduceMotionEnabled]),
+      FB_SETTING_DEFAULT_ACTIVE_APPLICATION: request.session.defaultActiveApplication,
+      FB_SETTING_ACTIVE_APP_DETECTION_POINT: FBActiveAppDetectionPoint.sharedInstance.stringCoordinates,
+      FB_SETTING_INCLUDE_NON_MODAL_ELEMENTS: @([FBConfiguration includeNonModalElements]),
+      FB_SETTING_ACCEPT_ALERT_BUTTON_SELECTOR: FBConfiguration.acceptAlertButtonSelector,
+      FB_SETTING_DISMISS_ALERT_BUTTON_SELECTOR: FBConfiguration.dismissAlertButtonSelector,
+      FB_SETTING_DEFAULT_ALERT_ACTION: request.session.defaultAlertAction ?: @"",
 #if !TARGET_OS_TV
-      SCREENSHOT_ORIENTATION: [FBConfiguration humanReadableScreenshotOrientation],
+      FB_SETTING_SCREENSHOT_ORIENTATION: [FBConfiguration humanReadableScreenshotOrientation],
 #endif
     }
   );
@@ -290,86 +294,86 @@
 {
   NSDictionary* settings = request.arguments[@"settings"];
 
-  if (nil != [settings objectForKey:USE_COMPACT_RESPONSES]) {
-    [FBConfiguration setShouldUseCompactResponses:[[settings objectForKey:USE_COMPACT_RESPONSES] boolValue]];
+  if (nil != [settings objectForKey:FB_SETTING_USE_COMPACT_RESPONSES]) {
+    [FBConfiguration setShouldUseCompactResponses:[[settings objectForKey:FB_SETTING_USE_COMPACT_RESPONSES] boolValue]];
   }
-  if (nil != [settings objectForKey:ELEMENT_RESPONSE_ATTRIBUTES]) {
-    [FBConfiguration setElementResponseAttributes:(NSString *)[settings objectForKey:ELEMENT_RESPONSE_ATTRIBUTES]];
+  if (nil != [settings objectForKey:FB_SETTING_ELEMENT_RESPONSE_ATTRIBUTES]) {
+    [FBConfiguration setElementResponseAttributes:(NSString *)[settings objectForKey:FB_SETTING_ELEMENT_RESPONSE_ATTRIBUTES]];
   }
-  if (nil != [settings objectForKey:MJPEG_SERVER_SCREENSHOT_QUALITY]) {
-    [FBConfiguration setMjpegServerScreenshotQuality:[[settings objectForKey:MJPEG_SERVER_SCREENSHOT_QUALITY] unsignedIntegerValue]];
+  if (nil != [settings objectForKey:FB_SETTING_MJPEG_SERVER_SCREENSHOT_QUALITY]) {
+    [FBConfiguration setMjpegServerScreenshotQuality:[[settings objectForKey:FB_SETTING_MJPEG_SERVER_SCREENSHOT_QUALITY] unsignedIntegerValue]];
   }
-  if (nil != [settings objectForKey:MJPEG_SERVER_FRAMERATE]) {
-    [FBConfiguration setMjpegServerFramerate:[[settings objectForKey:MJPEG_SERVER_FRAMERATE] unsignedIntegerValue]];
+  if (nil != [settings objectForKey:FB_SETTING_MJPEG_SERVER_FRAMERATE]) {
+    [FBConfiguration setMjpegServerFramerate:[[settings objectForKey:FB_SETTING_MJPEG_SERVER_FRAMERATE] unsignedIntegerValue]];
   }
-  if (nil != [settings objectForKey:SCREENSHOT_QUALITY]) {
-    [FBConfiguration setScreenshotQuality:[[settings objectForKey:SCREENSHOT_QUALITY] unsignedIntegerValue]];
+  if (nil != [settings objectForKey:FB_SETTING_SCREENSHOT_QUALITY]) {
+    [FBConfiguration setScreenshotQuality:[[settings objectForKey:FB_SETTING_SCREENSHOT_QUALITY] unsignedIntegerValue]];
   }
-  if (nil != [settings objectForKey:MJPEG_SCALING_FACTOR]) {
-    [FBConfiguration setMjpegScalingFactor:[[settings objectForKey:MJPEG_SCALING_FACTOR] unsignedIntegerValue]];
+  if (nil != [settings objectForKey:FB_SETTING_MJPEG_SCALING_FACTOR]) {
+    [FBConfiguration setMjpegScalingFactor:[[settings objectForKey:FB_SETTING_MJPEG_SCALING_FACTOR] unsignedIntegerValue]];
   }
-  if (nil != [settings objectForKey:KEYBOARD_AUTOCORRECTION]) {
-    [FBConfiguration setKeyboardAutocorrection:[[settings objectForKey:KEYBOARD_AUTOCORRECTION] boolValue]];
+  if (nil != [settings objectForKey:FB_SETTING_KEYBOARD_AUTOCORRECTION]) {
+    [FBConfiguration setKeyboardAutocorrection:[[settings objectForKey:FB_SETTING_KEYBOARD_AUTOCORRECTION] boolValue]];
   }
-  if (nil != [settings objectForKey:KEYBOARD_PREDICTION]) {
-    [FBConfiguration setKeyboardPrediction:[[settings objectForKey:KEYBOARD_PREDICTION] boolValue]];
+  if (nil != [settings objectForKey:FB_SETTING_KEYBOARD_PREDICTION]) {
+    [FBConfiguration setKeyboardPrediction:[[settings objectForKey:FB_SETTING_KEYBOARD_PREDICTION] boolValue]];
   }
   // SNAPSHOT_TIMEOUT setting is deprecated. Please use CUSTOM_SNAPSHOT_TIMEOUT instead
-  if (nil != [settings objectForKey:SNAPSHOT_TIMEOUT]) {
-    [FBConfiguration setCustomSnapshotTimeout:[[settings objectForKey:SNAPSHOT_TIMEOUT] doubleValue]];
+  if (nil != [settings objectForKey:FB_SETTING_SNAPSHOT_TIMEOUT]) {
+    [FBConfiguration setCustomSnapshotTimeout:[[settings objectForKey:FB_SETTING_SNAPSHOT_TIMEOUT] doubleValue]];
   }
-  if (nil != [settings objectForKey:CUSTOM_SNAPSHOT_TIMEOUT]) {
-    [FBConfiguration setCustomSnapshotTimeout:[[settings objectForKey:CUSTOM_SNAPSHOT_TIMEOUT] doubleValue]];
+  if (nil != [settings objectForKey:FB_SETTING_CUSTOM_SNAPSHOT_TIMEOUT]) {
+    [FBConfiguration setCustomSnapshotTimeout:[[settings objectForKey:FB_SETTING_CUSTOM_SNAPSHOT_TIMEOUT] doubleValue]];
   }
-  if (nil != [settings objectForKey:SNAPSHOT_MAX_DEPTH]) {
-    [FBConfiguration setSnapshotMaxDepth:[[settings objectForKey:SNAPSHOT_MAX_DEPTH] intValue]];
+  if (nil != [settings objectForKey:FB_SETTING_SNAPSHOT_MAX_DEPTH]) {
+    [FBConfiguration setSnapshotMaxDepth:[[settings objectForKey:FB_SETTING_SNAPSHOT_MAX_DEPTH] intValue]];
   }
-  if (nil != [settings objectForKey:USE_FIRST_MATCH]) {
-    [FBConfiguration setUseFirstMatch:[[settings objectForKey:USE_FIRST_MATCH] boolValue]];
+  if (nil != [settings objectForKey:FB_SETTING_USE_FIRST_MATCH]) {
+    [FBConfiguration setUseFirstMatch:[[settings objectForKey:FB_SETTING_USE_FIRST_MATCH] boolValue]];
   }
-  if (nil != [settings objectForKey:BOUND_ELEMENTS_BY_INDEX]) {
-    [FBConfiguration setBoundElementsByIndex:[[settings objectForKey:BOUND_ELEMENTS_BY_INDEX] boolValue]];
+  if (nil != [settings objectForKey:FB_SETTING_BOUND_ELEMENTS_BY_INDEX]) {
+    [FBConfiguration setBoundElementsByIndex:[[settings objectForKey:FB_SETTING_BOUND_ELEMENTS_BY_INDEX] boolValue]];
   }
-  if (nil != [settings objectForKey:REDUCE_MOTION]) {
-    [FBConfiguration setReduceMotionEnabled:[[settings objectForKey:REDUCE_MOTION] boolValue]];
+  if (nil != [settings objectForKey:FB_SETTING_REDUCE_MOTION]) {
+    [FBConfiguration setReduceMotionEnabled:[[settings objectForKey:FB_SETTING_REDUCE_MOTION] boolValue]];
   }
-  if (nil != [settings objectForKey:DEFAULT_ACTIVE_APPLICATION]) {
-    request.session.defaultActiveApplication = (NSString *)[settings objectForKey:DEFAULT_ACTIVE_APPLICATION];
+  if (nil != [settings objectForKey:FB_SETTING_DEFAULT_ACTIVE_APPLICATION]) {
+    request.session.defaultActiveApplication = (NSString *)[settings objectForKey:FB_SETTING_DEFAULT_ACTIVE_APPLICATION];
   }
-  if (nil != [settings objectForKey:ACTIVE_APP_DETECTION_POINT]) {
+  if (nil != [settings objectForKey:FB_SETTING_ACTIVE_APP_DETECTION_POINT]) {
     NSError *error;
-    if (![FBActiveAppDetectionPoint.sharedInstance setCoordinatesWithString:(NSString *)[settings objectForKey:ACTIVE_APP_DETECTION_POINT]
+    if (![FBActiveAppDetectionPoint.sharedInstance setCoordinatesWithString:(NSString *)[settings objectForKey:FB_SETTING_ACTIVE_APP_DETECTION_POINT]
                                                                       error:&error]) {
       return FBResponseWithStatus([FBCommandStatus invalidArgumentErrorWithMessage:error.description traceback:nil]);
     }
   }
-  if (nil != [settings objectForKey:INCLUDE_NON_MODAL_ELEMENTS]) {
+  if (nil != [settings objectForKey:FB_SETTING_INCLUDE_NON_MODAL_ELEMENTS]) {
     if ([XCUIElement fb_supportsNonModalElementsInclusion]) {
-      [FBConfiguration setIncludeNonModalElements:[[settings objectForKey:INCLUDE_NON_MODAL_ELEMENTS] boolValue]];
+      [FBConfiguration setIncludeNonModalElements:[[settings objectForKey:FB_SETTING_INCLUDE_NON_MODAL_ELEMENTS] boolValue]];
     } else {
-      [FBLogger logFmt:@"'%@' settings value cannot be assigned, because non modal elements inclusion is not supported by the current iOS SDK", INCLUDE_NON_MODAL_ELEMENTS];
+      [FBLogger logFmt:@"'%@' settings value cannot be assigned, because non modal elements inclusion is not supported by the current iOS SDK", FB_SETTING_INCLUDE_NON_MODAL_ELEMENTS];
     }
   }
-  if (nil != [settings objectForKey:ACCEPT_ALERT_BUTTON_SELECTOR]) {
-    [FBConfiguration setAcceptAlertButtonSelector:(NSString *)[settings objectForKey:ACCEPT_ALERT_BUTTON_SELECTOR]];
+  if (nil != [settings objectForKey:FB_SETTING_ACCEPT_ALERT_BUTTON_SELECTOR]) {
+    [FBConfiguration setAcceptAlertButtonSelector:(NSString *)[settings objectForKey:FB_SETTING_ACCEPT_ALERT_BUTTON_SELECTOR]];
   }
-  if (nil != [settings objectForKey:DISMISS_ALERT_BUTTON_SELECTOR]) {
-    [FBConfiguration setDismissAlertButtonSelector:(NSString *)[settings objectForKey:DISMISS_ALERT_BUTTON_SELECTOR]];
+  if (nil != [settings objectForKey:FB_SETTING_DISMISS_ALERT_BUTTON_SELECTOR]) {
+    [FBConfiguration setDismissAlertButtonSelector:(NSString *)[settings objectForKey:FB_SETTING_DISMISS_ALERT_BUTTON_SELECTOR]];
   }
-  if (nil != [settings objectForKey:WAIT_FOR_IDLE_TIMEOUT]) {
-    [FBConfiguration setWaitForIdleTimeout:[[settings objectForKey:WAIT_FOR_IDLE_TIMEOUT] doubleValue]];
+  if (nil != [settings objectForKey:FB_SETTING_WAIT_FOR_IDLE_TIMEOUT]) {
+    [FBConfiguration setWaitForIdleTimeout:[[settings objectForKey:FB_SETTING_WAIT_FOR_IDLE_TIMEOUT] doubleValue]];
   }
-  if (nil != [settings objectForKey:ANIMATION_COOL_OFF_TIMEOUT]) {
-    [FBConfiguration setAnimationCoolOffTimeout:[[settings objectForKey:ANIMATION_COOL_OFF_TIMEOUT] doubleValue]];
+  if (nil != [settings objectForKey:FB_SETTING_ANIMATION_COOL_OFF_TIMEOUT]) {
+    [FBConfiguration setAnimationCoolOffTimeout:[[settings objectForKey:FB_SETTING_ANIMATION_COOL_OFF_TIMEOUT] doubleValue]];
   }
-  if ([[settings objectForKey:DEFAULT_ALERT_ACTION] isKindOfClass:NSString.class]) {
-    request.session.defaultAlertAction = [settings[DEFAULT_ALERT_ACTION] lowercaseString];
+  if ([[settings objectForKey:FB_SETTING_DEFAULT_ALERT_ACTION] isKindOfClass:NSString.class]) {
+    request.session.defaultAlertAction = [settings[FB_SETTING_DEFAULT_ALERT_ACTION] lowercaseString];
   }
 
 #if !TARGET_OS_TV
-  if (nil != [settings objectForKey:SCREENSHOT_ORIENTATION]) {
+  if (nil != [settings objectForKey:FB_SETTING_SCREENSHOT_ORIENTATION]) {
     NSError *error;
-    if (![FBConfiguration setScreenshotOrientation:(NSString *)[settings objectForKey:SCREENSHOT_ORIENTATION]
+    if (![FBConfiguration setScreenshotOrientation:(NSString *)[settings objectForKey:FB_SETTING_SCREENSHOT_ORIENTATION]
                                              error:&error]) {
       return FBResponseWithStatus([FBCommandStatus invalidArgumentErrorWithMessage:error.description traceback:nil]);
     }

package/WebDriverAgentLib/Routing/FBElementCache.m

@@ -19,6 +19,7 @@
 #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;

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,9 @@ 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;
 

package/WebDriverAgentLib/Routing/FBSession.m

@@ -99,6 +99,7 @@ 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];

package/WebDriverAgentLib/Utilities/FBCapabilities.h

@@ -20,3 +20,4 @@ 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

@@ -20,3 +20,4 @@ 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/FBSettings.h

@@ -13,30 +13,30 @@ NS_ASSUME_NONNULL_BEGIN
 
 // See FBConfiguration.h for more details on the meaning of each setting
 
-extern NSString* const USE_COMPACT_RESPONSES;
-extern NSString* const ELEMENT_RESPONSE_ATTRIBUTES;
-extern NSString* const MJPEG_SERVER_SCREENSHOT_QUALITY;
-extern NSString* const MJPEG_SERVER_FRAMERATE;
-extern NSString* const MJPEG_SCALING_FACTOR;
-extern NSString* const SCREENSHOT_QUALITY;
-extern NSString* const KEYBOARD_AUTOCORRECTION;
-extern NSString* const KEYBOARD_PREDICTION;
+extern NSString* const FB_SETTING_USE_COMPACT_RESPONSES;
+extern NSString* const FB_SETTING_ELEMENT_RESPONSE_ATTRIBUTES;
+extern NSString* const FB_SETTING_MJPEG_SERVER_SCREENSHOT_QUALITY;
+extern NSString* const FB_SETTING_MJPEG_SERVER_FRAMERATE;
+extern NSString* const FB_SETTING_MJPEG_SCALING_FACTOR;
+extern NSString* const FB_SETTING_SCREENSHOT_QUALITY;
+extern NSString* const FB_SETTING_KEYBOARD_AUTOCORRECTION;
+extern NSString* const FB_SETTING_KEYBOARD_PREDICTION;
 // This setting is deprecated. Please use CUSTOM_SNAPSHOT_TIMEOUT instead
-extern NSString* const SNAPSHOT_TIMEOUT;
-extern NSString* const CUSTOM_SNAPSHOT_TIMEOUT;
-extern NSString* const SNAPSHOT_MAX_DEPTH;
-extern NSString* const USE_FIRST_MATCH;
-extern NSString* const BOUND_ELEMENTS_BY_INDEX;
-extern NSString* const REDUCE_MOTION;
-extern NSString* const DEFAULT_ACTIVE_APPLICATION;
-extern NSString* const ACTIVE_APP_DETECTION_POINT;
-extern NSString* const INCLUDE_NON_MODAL_ELEMENTS;
-extern NSString* const DEFAULT_ALERT_ACTION;
-extern NSString* const ACCEPT_ALERT_BUTTON_SELECTOR;
-extern NSString* const DISMISS_ALERT_BUTTON_SELECTOR;
-extern NSString* const SCREENSHOT_ORIENTATION;
-extern NSString* const WAIT_FOR_IDLE_TIMEOUT;
-extern NSString* const ANIMATION_COOL_OFF_TIMEOUT;
+extern NSString* const FB_SETTING_SNAPSHOT_TIMEOUT;
+extern NSString* const FB_SETTING_CUSTOM_SNAPSHOT_TIMEOUT;
+extern NSString* const FB_SETTING_SNAPSHOT_MAX_DEPTH;
+extern NSString* const FB_SETTING_USE_FIRST_MATCH;
+extern NSString* const FB_SETTING_BOUND_ELEMENTS_BY_INDEX;
+extern NSString* const FB_SETTING_REDUCE_MOTION;
+extern NSString* const FB_SETTING_DEFAULT_ACTIVE_APPLICATION;
+extern NSString* const FB_SETTING_ACTIVE_APP_DETECTION_POINT;
+extern NSString* const FB_SETTING_INCLUDE_NON_MODAL_ELEMENTS;
+extern NSString* const FB_SETTING_DEFAULT_ALERT_ACTION;
+extern NSString* const FB_SETTING_ACCEPT_ALERT_BUTTON_SELECTOR;
+extern NSString* const FB_SETTING_DISMISS_ALERT_BUTTON_SELECTOR;
+extern NSString* const FB_SETTING_SCREENSHOT_ORIENTATION;
+extern NSString* const FB_SETTING_WAIT_FOR_IDLE_TIMEOUT;
+extern NSString* const FB_SETTING_ANIMATION_COOL_OFF_TIMEOUT;
 
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentLib/Utilities/FBSettings.m

@@ -9,26 +9,26 @@
 
 #import "FBSettings.h"
 
-NSString* const USE_COMPACT_RESPONSES = @"shouldUseCompactResponses";
-NSString* const ELEMENT_RESPONSE_ATTRIBUTES = @"elementResponseAttributes";
-NSString* const MJPEG_SERVER_SCREENSHOT_QUALITY = @"mjpegServerScreenshotQuality";
-NSString* const MJPEG_SERVER_FRAMERATE = @"mjpegServerFramerate";
-NSString* const MJPEG_SCALING_FACTOR = @"mjpegScalingFactor";
-NSString* const SCREENSHOT_QUALITY = @"screenshotQuality";
-NSString* const KEYBOARD_AUTOCORRECTION = @"keyboardAutocorrection";
-NSString* const KEYBOARD_PREDICTION = @"keyboardPrediction";
-NSString* const SNAPSHOT_TIMEOUT = @"snapshotTimeout";
-NSString* const CUSTOM_SNAPSHOT_TIMEOUT = @"customSnapshotTimeout";
-NSString* const SNAPSHOT_MAX_DEPTH = @"snapshotMaxDepth";
-NSString* const USE_FIRST_MATCH = @"useFirstMatch";
-NSString* const BOUND_ELEMENTS_BY_INDEX = @"boundElementsByIndex";
-NSString* const REDUCE_MOTION = @"reduceMotion";
-NSString* const DEFAULT_ACTIVE_APPLICATION = @"defaultActiveApplication";
-NSString* const ACTIVE_APP_DETECTION_POINT = @"activeAppDetectionPoint";
-NSString* const INCLUDE_NON_MODAL_ELEMENTS = @"includeNonModalElements";
-NSString* const DEFAULT_ALERT_ACTION = @"defaultAlertAction";
-NSString* const ACCEPT_ALERT_BUTTON_SELECTOR = @"acceptAlertButtonSelector";
-NSString* const DISMISS_ALERT_BUTTON_SELECTOR = @"dismissAlertButtonSelector";
-NSString* const SCREENSHOT_ORIENTATION = @"screenshotOrientation";
-NSString* const WAIT_FOR_IDLE_TIMEOUT = @"waitForIdleTimeout";
-NSString* const ANIMATION_COOL_OFF_TIMEOUT = @"animationCoolOffTimeout";
+NSString* const FB_SETTING_USE_COMPACT_RESPONSES = @"shouldUseCompactResponses";
+NSString* const FB_SETTING_ELEMENT_RESPONSE_ATTRIBUTES = @"elementResponseAttributes";
+NSString* const FB_SETTING_MJPEG_SERVER_SCREENSHOT_QUALITY = @"mjpegServerScreenshotQuality";
+NSString* const FB_SETTING_MJPEG_SERVER_FRAMERATE = @"mjpegServerFramerate";
+NSString* const FB_SETTING_MJPEG_SCALING_FACTOR = @"mjpegScalingFactor";
+NSString* const FB_SETTING_SCREENSHOT_QUALITY = @"screenshotQuality";
+NSString* const FB_SETTING_KEYBOARD_AUTOCORRECTION = @"keyboardAutocorrection";
+NSString* const FB_SETTING_KEYBOARD_PREDICTION = @"keyboardPrediction";
+NSString* const FB_SETTING_SNAPSHOT_TIMEOUT = @"snapshotTimeout";
+NSString* const FB_SETTING_CUSTOM_SNAPSHOT_TIMEOUT = @"customSnapshotTimeout";
+NSString* const FB_SETTING_SNAPSHOT_MAX_DEPTH = @"snapshotMaxDepth";
+NSString* const FB_SETTING_USE_FIRST_MATCH = @"useFirstMatch";
+NSString* const FB_SETTING_BOUND_ELEMENTS_BY_INDEX = @"boundElementsByIndex";
+NSString* const FB_SETTING_REDUCE_MOTION = @"reduceMotion";
+NSString* const FB_SETTING_DEFAULT_ACTIVE_APPLICATION = @"defaultActiveApplication";
+NSString* const FB_SETTING_ACTIVE_APP_DETECTION_POINT = @"activeAppDetectionPoint";
+NSString* const FB_SETTING_INCLUDE_NON_MODAL_ELEMENTS = @"includeNonModalElements";
+NSString* const FB_SETTING_DEFAULT_ALERT_ACTION = @"defaultAlertAction";
+NSString* const FB_SETTING_ACCEPT_ALERT_BUTTON_SELECTOR = @"acceptAlertButtonSelector";
+NSString* const FB_SETTING_DISMISS_ALERT_BUTTON_SELECTOR = @"dismissAlertButtonSelector";
+NSString* const FB_SETTING_SCREENSHOT_ORIENTATION = @"screenshotOrientation";
+NSString* const FB_SETTING_WAIT_FOR_IDLE_TIMEOUT = @"waitForIdleTimeout";
+NSString* const FB_SETTING_ANIMATION_COOL_OFF_TIMEOUT = @"animationCoolOffTimeout";

package/WebDriverAgentTests/IntegrationTests/XCUIElementFBFindTests.m

@@ -18,6 +18,7 @@
 #import "XCElementSnapshot+FBHelpers.h"
 #import "XCUIElement+FBIsVisible.h"
 #import "XCUIElement+FBClassChain.h"
+#import "XCUIElement+FBResolve.h"
 #import "FBXPath.h"
 #import "FBXCodeCompatibility.h"
 
@@ -86,6 +87,16 @@
   XCTAssertEqualObjects(matchingSnapshots.lastObject.label, @"Alerts");
 }
 
+- (void)testStableInstance
+{
+  NSArray<XCUIElement *> *matchingSnapshots = [self.testedView fb_descendantsMatchingIdentifier:@"Alerts" shouldReturnAfterFirstMatch:YES];
+  XCTAssertEqual(matchingSnapshots.count, 1);
+  for (XCUIElement *el in @[matchingSnapshots.lastObject, matchingSnapshots.lastObject.fb_stableInstance]) {
+    XCTAssertEqual(el.elementType, XCUIElementTypeButton);
+    XCTAssertEqualObjects(el.label, @"Alerts");
+  }
+}
+
 - (void)testSingleDescendantWithMissingIdentifier
 {
   NSArray<XCUIElement *> *matchingSnapshots = [self.testedView fb_descendantsMatchingIdentifier:@"blabla" shouldReturnAfterFirstMatch:YES];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "3.11.1",
+  "version": "3.12.0",
   "description": "Package bundling WebDriverAgent",
   "main": "build/index.js",
   "scripts": {