appium-webdriveragent 16.13.2 → 16.13.4

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [16.13.4](https://github.com/appium/WebDriverAgent/compare/v16.13.3...v16.13.4) (2026-09-30)
+
+### Performance Improvements
+
+* use native predicates for accessibility id lookups ([#1286](https://github.com/appium/WebDriverAgent/issues/1286)) ([2ceb940](https://github.com/appium/WebDriverAgent/commit/2ceb940939c2033cb37b846962a966d42bb0ddab))
+
+## [16.13.3](https://github.com/appium/WebDriverAgent/compare/v16.13.2...v16.13.3) (2026-09-30)
+
+### Bug Fixes
+
+* reject stale sessions without retaining past responses ([#1282](https://github.com/appium/WebDriverAgent/issues/1282)) ([f245ffb](https://github.com/appium/WebDriverAgent/commit/f245ffb4e6906143384410cf312abc5bcedf5486))
+
 ## [16.13.2](https://github.com/appium/WebDriverAgent/compare/v16.13.1...v16.13.2) (2026-09-30)
 
 ### Bug Fixes

package/WebDriverAgentLib/Categories/XCUIElement+FBFind.m

@@ -120,14 +120,27 @@
 - (NSArray<XCUIElement *> *)fb_descendantsMatchingIdentifier:(NSString *)accessibilityId
                                  shouldReturnAfterFirstMatch:(BOOL)shouldReturnAfterFirstMatch
 {
-  NSPredicate *predicate = [NSPredicate predicateWithBlock:^BOOL(id<FBXCElementSnapshot> snapshot,
-                                                                 NSDictionary<NSString *,id> * _Nullable bindings) {
-    @autoreleasepool {
-      return [[FBXCElementSnapshotWrapper wdNameWithSnapshot:snapshot] isEqualToString:accessibilityId];
+  // Standard snapshot attributes let XCTest evaluate a structured predicate
+  // without WDA's per-snapshot block callback, while preserving wdName semantics.
+  // Local benchmarks showed lower end-to-end lookup latency; see measurements
+  // and regression checks in https://github.com/appium/WebDriverAgent/pull/1286.
+  NSPredicate *predicate = [NSPredicate predicateWithFormat:
+    @"(identifier != nil AND identifier != '' AND identifier == %@) OR "
+     "((identifier == nil OR identifier == '') AND label != nil AND label != '' AND label == %@)",
+    accessibilityId, accessibilityId];
+  XCUIElementQuery *query = [[self.fb_query descendantsMatchingType:XCUIElementTypeAny]
+    matchingPredicate:predicate];
+  NSMutableArray<XCUIElement *> *result = [NSMutableArray arrayWithArray:
+    [self.class fb_extractMatchingElementsFromQuery:query
+                       shouldReturnAfterFirstMatch:shouldReturnAfterFirstMatch]];
+  id<FBXCElementSnapshot> cachedSnapshot = [self fb_cachedSnapshotWithQuery:query];
+  if ([predicate evaluateWithObject:cachedSnapshot]) {
+    if (shouldReturnAfterFirstMatch || result.count == 0) {
+      return @[self];
     }
-  }];
-  return [self fb_descendantsMatchingPredicate:predicate
-                   shouldReturnAfterFirstMatch:shouldReturnAfterFirstMatch];
+    [result insertObject:self atIndex:0];
+  }
+  return result.copy;
 }
 
 @end

package/WebDriverAgentLib/Info.plist

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

package/WebDriverAgentLib/Routing/FBHTTPServer.m

@@ -13,6 +13,7 @@
 #import "FBLogger.h"
 #import "FBResponsePayload.h"
 #import "FBTCPSocket.h"
+#import "FBSession.h"
 
 static NSData *FBCRLFCRLFData(void)
 {
@@ -131,10 +132,6 @@ static BOOL FBParseContentLength(NSString *value, NSUInteger *outLength)
 // standalone or not (except DELETE /session itself - see -dispatchMethod:). See
 // -abandonPendingRequestsForSessionID:. Guarded by @synchronized(self.pendingSessionRequests).
 @property (nonatomic, strong) NSMutableDictionary<NSString *, NSMutableSet<FBPendingRequest *> *> *pendingSessionRequests;
-// Already-abandoned sessions mapped to the response they were abandoned with, so a request parsed
-// after that point is answered at once instead of queueing for a session that is gone. Kept for
-// the server's lifetime; ids are UUIDs. Guarded by @synchronized(self.pendingSessionRequests).
-@property (nonatomic, strong) NSMutableDictionary<NSString *, RouteResponse *> *abandonedSessionResponses;
 // When each connection started waiting for its current request. The reaper closes connections
 // whose entry outlives FBIncompleteRequestTimeout; idle keep-alive connections have no entry and
 // are exempt. Guarded by @synchronized(self.connectionBuffers).
@@ -163,7 +160,6 @@ static const int64_t FBStaleConnectionSweepIntervalSec = 10;
     _connectionsAwaitingResponse = [NSMutableSet set];
     _standaloneWaiters = [NSMutableDictionary dictionary];
     _pendingSessionRequests = [NSMutableDictionary dictionary];
-    _abandonedSessionResponses = [NSMutableDictionary dictionary];
     _incompleteRequestStarts = [NSMapTable mapTableWithKeyOptions:(NSPointerFunctionsOptions)(NSMapTableObjectPointerPersonality | NSMapTableStrongMemory)
                                                      valueOptions:(NSPointerFunctionsOptions)NSMapTableStrongMemory];
   }
@@ -739,9 +735,15 @@ static const int64_t FBStaleConnectionSweepIntervalSec = 10;
 - (nullable RouteResponse *)trackPendingRequest:(FBPendingRequest *)pendingRequest forSessionID:(NSString *)sessionID
 {
   @synchronized (self.pendingSessionRequests) {
-    RouteResponse *abandonedResponse = self.abandonedSessionResponses[sessionID];
-    if (nil != abandonedResponse) {
-      return abandonedResponse;
+    // Checking the current session under this lock closes the admission/teardown
+    // race without retaining a tombstone and a full response for every past UUID.
+    // -kill clears the active session before posting its abandonment notification.
+    if (nil == [FBSession sessionWithIdentifier:sessionID]) {
+      RouteResponse *response = [RouteResponse new];
+      [FBResponseWithStatus([FBCommandStatus noSuchDriverErrorWithMessage:@"Session does not exist"
+                                                               traceback:nil]) dispatchWithResponse:response];
+      [self applyDefaultHeadersToResponse:response];
+      return response;
     }
     NSMutableSet<FBPendingRequest *> *pendingRequests = self.pendingSessionRequests[sessionID];
     if (nil == pendingRequests) {
@@ -776,8 +778,6 @@ static const int64_t FBStaleConnectionSweepIntervalSec = 10;
   @synchronized (self.pendingSessionRequests) {
     pendingRequests = [self.pendingSessionRequests[sessionID] copy];
     [self.pendingSessionRequests removeObjectForKey:sessionID];
-    // Recorded before the lock is dropped, so requests admitted from here on are rejected.
-    self.abandonedSessionResponses[sessionID] = response;
   }
   for (FBPendingRequest *pendingRequest in pendingRequests) {
     [self writeResponse:response toClient:pendingRequest.client];

package/WebDriverAgentTests/IntegrationApp/Classes/SceneDelegate.m

@@ -10,7 +10,40 @@
 
 @implementation SceneDelegate
 
+- (void)showIdentifierLookupFixture
+{
+  UIViewController *controller = [UIViewController new];
+  controller.view.backgroundColor = UIColor.whiteColor;
+  controller.view.accessibilityIdentifier = @"IdentifierLookupFixture";
+  NSArray *identifiers = @[@"something", @"different", @"", NSNull.null, @"something", @"", NSNull.null, @"quote'\"é", NSNull.null];
+  NSArray<NSString *> *labels = @[@"other label", @"something", @"something", @"something", @"something", @"", @"", @"quoted", @"日本語"];
+  NSMutableArray<UILabel *> *labelViews = [NSMutableArray array];
+  for (NSUInteger i = 0; i < identifiers.count; i++) {
+    UILabel *label = [[UILabel alloc] initWithFrame:CGRectMake(20, 90 + i * 40, 300, 35)];
+    label.text = [NSString stringWithFormat:@"Fixture %lu", (unsigned long)i];
+    label.accessibilityIdentifier = identifiers[i] == NSNull.null ? nil : identifiers[i];
+    label.accessibilityLabel = labels[i];
+    label.isAccessibilityElement = YES;
+    [labelViews addObject:label];
+    [controller.view addSubview:label];
+  }
+  UIButton *mutate = [UIButton buttonWithType:UIButtonTypeSystem];
+  mutate.frame = CGRectMake(20, 470, 220, 40);
+  [mutate setTitle:@"Change identifier" forState:UIControlStateNormal];
+  mutate.accessibilityIdentifier = @"mutateIdentifier";
+  [mutate addAction:[UIAction actionWithHandler:^(__kindof UIAction *action) {
+    labelViews[0].accessibilityIdentifier = @"changed";
+  }] forControlEvents:UIControlEventTouchUpInside];
+  [controller.view addSubview:mutate];
+  self.window.rootViewController = controller;
+  [self.window makeKeyAndVisible];
+}
+
 - (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session options:(UISceneConnectionOptions *)connectionOptions {
+  if ([NSProcessInfo.processInfo.arguments containsObject:@"--identifier-lookup-test"]) {
+    [self showIdentifierLookupFixture];
+    return;
+  }
   // Use this method to optionally configure and attach the UIWindow `window` to the provided UIWindowScene `scene`.
   // If using a storyboard, the `window` property will automatically be set and attached to the scene.
   // This delegate does not imply the connecting scene or session are new (see `application:configurationForConnectingSceneSession:` instead).

package/WebDriverAgentTests/IntegrationTests/XCUIElementFBFindTests.m

@@ -9,6 +9,7 @@
 #import <XCTest/XCTest.h>
 
 #import "FBIntegrationTestCase.h"
+#import "FBConfiguration.h"
 #import "FBElementUtils.h"
 #import "FBExceptions.h"
 #import "FBTestMacros.h"
@@ -558,3 +559,115 @@
 }
 
 @end
+
+
+@interface XCUIElementFBFindTests_IdentifierSemantics : FBIntegrationTestCase
+@end
+
+@implementation XCUIElementFBFindTests_IdentifierSemantics
+
+- (void)setUp
+{
+  [super setUp];
+  self.testedApplication.launchArguments = @[@"--identifier-lookup-test"];
+  [self.testedApplication launch];
+  XCTAssertTrue([self.testedApplication.otherElements[@"IdentifierLookupFixture"] waitForExistenceWithTimeout:5]);
+}
+
+- (void)tearDown
+{
+  [self.testedApplication terminate];
+  [super tearDown];
+}
+
+- (void)testIdentifierTakesPrecedenceOverLabel
+{
+  NSArray<XCUIElement *> *matches = [self.testedApplication fb_descendantsMatchingIdentifier:@"something"
+                                                              shouldReturnAfterFirstMatch:NO];
+  XCTAssertEqual(matches.count, 4);
+  XCTAssertEqualObjects([matches valueForKey:@"label"], (@[@"other label", @"something", @"something", @"something"]));
+  XCTAssertEqual([self.testedApplication fb_descendantsMatchingIdentifier:@"different" shouldReturnAfterFirstMatch:NO].count, 1);
+  // A matching label must not override a different, nonempty identifier.
+  XCTAssertEqual([self.testedApplication fb_descendantsMatchingIdentifier:@"other label" shouldReturnAfterFirstMatch:NO].count, 0);
+}
+
+- (void)testEmptyIdentifierDoesNotMatchEmptyAccessibilityId
+{
+  // The fixture has an empty identifier with a nonempty label at index 2,
+  // and an empty identifier with an empty label at index 5.
+  XCUIElement *labelFallback = [self.testedApplication.staticTexts elementBoundByIndex:2];
+  XCUIElement *unnamed = [self.testedApplication.staticTexts elementBoundByIndex:5];
+  XCTAssertEqualObjects(labelFallback.identifier, @"");
+  XCTAssertEqualObjects(labelFallback.label, @"something");
+  XCTAssertEqualObjects(unnamed.identifier, @"");
+  XCTAssertEqualObjects(unnamed.label, @"");
+
+  // Regression guard for "identifier != nil AND identifier != ''": the old
+  // wdName lookup used the nonempty label, or nil when both fields were empty.
+  // Thus an empty query matched neither element. Checking only identifier != nil
+  // would instead let identifier == @"" match both, changing existing behavior.
+  BOOL previousFirstMatch = FBConfiguration.sharedInstance.useFirstMatch;
+  @try {
+    for (NSNumber *useFirstMatch in @[@NO, @YES]) {
+      FBConfiguration.sharedInstance.useFirstMatch = useFirstMatch.boolValue;
+      for (NSNumber *firstMatch in @[@NO, @YES]) {
+        XCTAssertEqual([self.testedApplication fb_descendantsMatchingIdentifier:@""
+                                                  shouldReturnAfterFirstMatch:firstMatch.boolValue].count, 0,
+                       @"An empty accessibility ID must not match empty identifiers, even when they are non-nil");
+      }
+    }
+  } @finally {
+    FBConfiguration.sharedInstance.useFirstMatch = previousFirstMatch;
+  }
+}
+
+- (void)testMissingQuotedAndUnicodeIdentifiers
+{
+  for (NSNumber *firstMatch in @[@NO, @YES]) {
+    XCTAssertEqual([self.testedApplication fb_descendantsMatchingIdentifier:@"missing-target" shouldReturnAfterFirstMatch:firstMatch.boolValue].count, 0);
+    XCTAssertEqual([self.testedApplication fb_descendantsMatchingIdentifier:@"quote'\"é" shouldReturnAfterFirstMatch:firstMatch.boolValue].count, 1);
+    XCTAssertEqual([self.testedApplication fb_descendantsMatchingIdentifier:@"日本語" shouldReturnAfterFirstMatch:firstMatch.boolValue].count, 1);
+  }
+}
+
+- (void)testFirstMatchAndParentScopeWithBothBindings
+{
+  BOOL previousBinding = FBConfiguration.sharedInstance.boundElementsByIndex;
+  @try {
+    for (NSNumber *indexed in @[@NO, @YES]) {
+      FBConfiguration.sharedInstance.boundElementsByIndex = indexed.boolValue;
+      // Use the element returned by WDA lookup, as the element-scoped endpoint does.
+      XCUIElement *parent = [self.testedApplication fb_descendantsMatchingIdentifier:@"IdentifierLookupFixture"
+                                                          shouldReturnAfterFirstMatch:YES].firstObject;
+      XCTAssertNotNil(parent);
+      // The HTTP endpoint resolves the parent when registering its element ID.
+      XCTAssertNotNil(parent.fb_uid);
+      NSArray<XCUIElement *> *matches = [parent fb_descendantsMatchingIdentifier:@"something" shouldReturnAfterFirstMatch:NO];
+      NSArray<XCUIElement *> *first = [parent fb_descendantsMatchingIdentifier:@"something" shouldReturnAfterFirstMatch:YES];
+      XCTAssertEqual(matches.count, 4);
+      XCTAssertEqual(first.count, 1);
+      XCTAssertEqualObjects(first.firstObject.fb_uid, matches.firstObject.fb_uid);
+      NSArray<XCUIElement *> *selfMatches = [parent fb_descendantsMatchingIdentifier:@"IdentifierLookupFixture" shouldReturnAfterFirstMatch:NO];
+      XCTAssertEqual(selfMatches.count, 1);
+      XCTAssertEqualObjects(selfMatches.firstObject.fb_uid, parent.fb_uid);
+    }
+  } @finally {
+    FBConfiguration.sharedInstance.boundElementsByIndex = previousBinding;
+  }
+}
+
+- (void)testIdentifierChangesAreObserved
+{
+  NSArray<XCUIElement *> *before = [self.testedApplication fb_descendantsMatchingIdentifier:@"something" shouldReturnAfterFirstMatch:NO];
+  XCTAssertEqual(before.count, 4);
+  NSArray<NSString *> *beforeIds = [before valueForKey:@"fb_uid"];
+  [self.testedApplication.buttons[@"mutateIdentifier"] tap];
+  NSArray<XCUIElement *> *after = [self.testedApplication fb_descendantsMatchingIdentifier:@"something" shouldReturnAfterFirstMatch:NO];
+  NSArray<XCUIElement *> *changed = [self.testedApplication fb_descendantsMatchingIdentifier:@"changed" shouldReturnAfterFirstMatch:NO];
+  XCTAssertEqual(after.count, 3);
+  XCTAssertEqual(changed.count, 1);
+  XCTAssertEqualObjects([after valueForKey:@"fb_uid"], [beforeIds subarrayWithRange:NSMakeRange(1, 3)]);
+  XCTAssertEqualObjects(changed.firstObject.fb_uid, beforeIds.firstObject);
+}
+
+@end

package/WebDriverAgentTests/UnitTests/FBHTTPServerSessionTests.m

@@ -13,6 +13,7 @@
 #import <sys/socket.h>
 
 #import "FBHTTPServer.h"
+#import "FBSession-Private.h"
 
 static atomic_int gSessionProbeHits;
 
@@ -23,10 +24,26 @@ static atomic_int gSessionProbeHits;
 
 @implementation FBHTTPServerSessionTests
 
+- (void)testAbandonmentDoesNotRetainResponsesAfterPendingRequestsDrain
+{
+  __weak RouteResponse *weakResponse;
+  @autoreleasepool {
+    RouteResponse *response = [RouteResponse new];
+    [response respondWithString:@"deleted"];
+    weakResponse = response;
+    for (NSUInteger index = 0; index < 1000; index++) {
+      [self.server abandonPendingRequestsForSessionID:[NSString stringWithFormat:@"old-%lu", (unsigned long)index]
+                                         withResponse:response];
+    }
+  }
+  XCTAssertNil(weakResponse);
+}
+
 - (void)setUp
 {
   [super setUp];
   atomic_store(&gSessionProbeHits, 0);
+  [FBSession initWithApplication:nil].identifier = @"live-session";
   self.server = [FBHTTPServer new];
   [self.server get:@"/session/:sessionID/probe" withBlock:^(RouteRequest *request, RouteResponse *response) {
     atomic_fetch_add(&gSessionProbeHits, 1);
@@ -42,6 +59,7 @@ static atomic_int gSessionProbeHits;
 {
   [self.server stop:NO];
   self.server = nil;
+  [FBSession.activeSession kill];
   [super tearDown];
 }
 
@@ -93,14 +111,14 @@ static atomic_int gSessionProbeHits;
 
   NSString *response = [self responseForRawPayload:(NSData * _Nonnull)[@"GET /session/dead-session/probe HTTP/1.1\r\n\r\n" dataUsingEncoding:NSUTF8StringEncoding]
                                             timeout:5.0];
-  XCTAssertTrue([response containsString:@"session-was-deleted"], @"%@", response);
+  XCTAssertTrue([response containsString:@"invalid session id"], @"%@", response);
   XCTAssertEqual(atomic_load(&gSessionProbeHits), 0, @"the route must not run for a deleted session");
 }
 
 - (void)testAbandonedSessionIsRememberedAfterManyLaterAbandonments
 {
-  // Abandoned ids are kept for the server's lifetime; evicting them would let a stale request
-  // queue on a possibly wedged route queue again, which is the hang this rejection prevents.
+  // A stale UUID must still be rejected after arbitrarily many other sessions,
+  // without needing to remember every deleted UUID.
   RouteResponse *abandonedResponse = [RouteResponse new];
   [abandonedResponse respondWithString:@"session-was-deleted"];
   [self.server abandonPendingRequestsForSessionID:@"dead-session" withResponse:abandonedResponse];
@@ -113,7 +131,7 @@ static atomic_int gSessionProbeHits;
 
   NSString *response = [self responseForRawPayload:(NSData * _Nonnull)[@"GET /session/dead-session/probe HTTP/1.1\r\n\r\n" dataUsingEncoding:NSUTF8StringEncoding]
                                             timeout:5.0];
-  XCTAssertTrue([response containsString:@"session-was-deleted"], @"%@", response);
+  XCTAssertTrue([response containsString:@"invalid session id"], @"%@", response);
   XCTAssertEqual(atomic_load(&gSessionProbeHits), 0, @"the route must not run for a deleted session");
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "16.13.2",
+  "version": "16.13.4",
   "description": "Package bundling WebDriverAgent",
   "keywords": [
     "Appium",