appium-webdriveragent 16.7.2 → 16.8.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [16.8.0](https://github.com/appium/WebDriverAgent/compare/v16.7.3...v16.8.0) (2026-08-24)
+
+### Features
+
+* bound accessibility snapshot requests to avoid indefinite hangs ([#1214](https://github.com/appium/WebDriverAgent/issues/1214)) ([cd829eb](https://github.com/appium/WebDriverAgent/commit/cd829eb9725f57efbfb9538a073de059020ddd38))
+
+## [16.7.3](https://github.com/appium/WebDriverAgent/compare/v16.7.2...v16.7.3) (2026-08-24)
+
+### Bug Fixes
+
+* let /status, /screenshot, and DELETE /session API methods to bypass the dispatch queue ([#1222](https://github.com/appium/WebDriverAgent/issues/1222)) ([f99b011](https://github.com/appium/WebDriverAgent/commit/f99b0111bba6f5cceabbddf1f9f0144d69d8f168))
+
 ## [16.7.2](https://github.com/appium/WebDriverAgent/compare/v16.7.1...v16.7.2) (2026-08-24)
 
 ### Bug Fixes

package/README.md

@@ -42,15 +42,5 @@ Then, you find `WebDriverAgentRunner-Runner-sim-<version>.zip`  for iOS and `Web
 
 [`WebDriverAgent` is BSD-licensed](LICENSE).
 
-## Third Party Sources
-
-WebDriverAgent depends on the following third-party frameworks:
-- [CocoaHTTPServer](https://github.com/robbiehanson/CocoaHTTPServer)
-- [RoutingHTTPServer](https://github.com/mattstevens/RoutingHTTPServer)
-
-These projects haven't been maintained in a while. That's why the source code of these
-projects has been integrated directly in the WebDriverAgent source tree.
-
-You can find the source files and their licenses in the `WebDriverAgentLib/Vendor` directory.
 
 Have fun!

package/WebDriverAgentLib/Categories/XCAXClient_iOS+FBSnapshotReqParams.m

@@ -10,6 +10,13 @@
 
 #import <objc/runtime.h>
 
+#import "FBConfiguration.h"
+#import "FBErrorBuilder.h"
+#import "FBLogger.h"
+#import "FBXCAccessibilityElement.h"
+#import "FBXCAXClientProxy.h"
+#import "XCUIApplication.h"
+
 /**
  Available parameters with their default values for XCTest:
   @"maxChildren" : (int)2147483647
@@ -60,6 +67,82 @@ static id swizzledSnapshotParameters(id self, SEL _cmd)
   return result;
 }
 
+static id (*original_requestSnapshotForElement)(id, SEL, id, id, id, NSError **);
+
+// pid -> last-unresponsive-at. XCTest retries a failed snapshot request several
+// times in a row; this lets retries fail fast within `timeout` of the last check
+// instead of each re-running the full wait.
+static NSMutableDictionary<NSNumber *, NSDate *> *unresponsiveApplicationPids;
+static NSObject *unresponsiveApplicationPidsLock;
+
+static NSError *FBBuildUnresponsiveApplicationError(int pid, NSTimeInterval timeout)
+{
+  // https://github.com/appium/WebDriverAgent/issues/1210
+  NSString *description = [NSString stringWithFormat:
+    @"The application with process identifier %d did not confirm its main run loop is "
+     @"responsive within %.1f second(s) and is likely in an unresponsive state. "
+     @"Aborting the accessibility snapshot request instead of risking an indefinite "
+     @"hang.",
+    pid, timeout];
+  [FBLogger logFmt:@"%@", description];
+  NSError *error;
+  [[[FBErrorBuilder builder] withDescription:description] buildError:&error];
+  return error;
+}
+
+// Guards -[XCAXClient_iOS requestSnapshotForElement:...] against hanging forever
+// on an unresponsive app (#1210). If accessibilityDeadline > 0, checks run loop
+// responsiveness first and aborts with an error instead of risking an unbounded
+// wait; otherwise falls through to the original, unbounded behavior.
+static id swizzledRequestSnapshotForElement(id self, SEL _cmd, id element, id attributes, id parameters, NSError **error)
+{
+  NSTimeInterval timeout = FBConfiguration.sharedInstance.accessibilityDeadline;
+  if (timeout < DBL_EPSILON) {
+    return original_requestSnapshotForElement(self, _cmd, element, attributes, parameters, error);
+  }
+
+  int pid = [(id<FBXCAccessibilityElement>)element processIdentifier];
+  XCUIApplication *application = [FBXCAXClientProxy.sharedClient monitoredApplicationWithProcessIdentifier:pid];
+  if (nil == application) {
+    // Nothing to confirm responsiveness for (e.g. the system element) - fall
+    // through to the original behavior.
+    return original_requestSnapshotForElement(self, _cmd, element, attributes, parameters, error);
+  }
+
+  NSNumber *pidKey = @(pid);
+  @synchronized (unresponsiveApplicationPidsLock) {
+    NSDate *markedUnresponsiveAt = unresponsiveApplicationPids[pidKey];
+    if (nil != markedUnresponsiveAt && -markedUnresponsiveAt.timeIntervalSinceNow < timeout) {
+      if (nil != error) {
+        *error = FBBuildUnresponsiveApplicationError(pid, timeout);
+      }
+      return nil;
+    }
+  }
+
+  dispatch_semaphore_t sem = dispatch_semaphore_create(0);
+  __block BOOL isResponsive = NO;
+  [FBXCAXClientProxy.sharedClient notifyWhenEventLoopIsIdleForApplication:application
+                                                                     reply:^(id result, NSError *idleError) {
+    isResponsive = (nil == idleError);
+    dispatch_semaphore_signal(sem);
+  }];
+  BOOL didReplyInTime = 0 == dispatch_semaphore_wait(sem, dispatch_time(DISPATCH_TIME_NOW, (int64_t)(timeout * NSEC_PER_SEC)));
+  if (didReplyInTime && isResponsive) {
+    @synchronized (unresponsiveApplicationPidsLock) {
+      [unresponsiveApplicationPids removeObjectForKey:pidKey];
+    }
+    return original_requestSnapshotForElement(self, _cmd, element, attributes, parameters, error);
+  }
+
+  @synchronized (unresponsiveApplicationPidsLock) {
+    unresponsiveApplicationPids[pidKey] = [NSDate date];
+  }
+  if (nil != error) {
+    *error = FBBuildUnresponsiveApplicationError(pid, timeout);
+  }
+  return nil;
+}
 
 @implementation XCAXClient_iOS (FBSnapshotReqParams)
 
@@ -69,6 +152,9 @@ static id swizzledSnapshotParameters(id self, SEL _cmd)
 
 + (void)load
 {
+  unresponsiveApplicationPids = [NSMutableDictionary new];
+  unresponsiveApplicationPidsLock = [NSObject new];
+
   Method original_defaultParametersMethod = class_getInstanceMethod(self.class, @selector(defaultParameters));
   IMP swizzledDefaultParametersImp = (IMP)swizzledDefaultParameters;
   original_defaultParameters = (id (*)(id, SEL)) method_setImplementation(original_defaultParametersMethod, swizzledDefaultParametersImp);
@@ -76,6 +162,10 @@ static id swizzledSnapshotParameters(id self, SEL _cmd)
   Method original_snapshotParametersMethod = class_getInstanceMethod(NSClassFromString(@"XCTElementQuery"), NSSelectorFromString(@"snapshotParameters"));
   IMP swizzledSnapshotParametersImp = (IMP)swizzledSnapshotParameters;
   original_snapshotParameters = (id (*)(id, SEL)) method_setImplementation(original_snapshotParametersMethod, swizzledSnapshotParametersImp);
+
+  Method original_requestSnapshotForElementMethod = class_getInstanceMethod(self.class, @selector(requestSnapshotForElement:attributes:parameters:error:));
+  IMP swizzledRequestSnapshotForElementImp = (IMP)swizzledRequestSnapshotForElement;
+  original_requestSnapshotForElement = (id (*)(id, SEL, id, id, id, NSError **)) method_setImplementation(original_requestSnapshotForElementMethod, swizzledRequestSnapshotForElementImp);
 }
 
 #pragma clang diagnostic pop

package/WebDriverAgentLib/Commands/FBCustomCommands.m

@@ -205,10 +205,13 @@
 + (id<FBResponsePayload>)handleActiveAppInfo:(FBRouteRequest *)request
 {
   XCUIApplication *app = request.session.activeApplication ?: XCUIApplication.fb_activeApplication;
+  // .identifier can be nil if the app stopped answering accessibility requests
+  // and accessibilityDeadline aborted the underlying snapshot fetch (#1210).
+  NSString *name = app.identifier ?: @"unknown";
   return FBResponseWithObject(@{
     @"pid": @(app.processID),
     @"bundleId": app.bundleID,
-    @"name": app.identifier,
+    @"name": name,
     @"processArguments": [self processArguments:app],
   });
 }

package/WebDriverAgentLib/Commands/FBScreenshotCommands.m

@@ -18,8 +18,8 @@
 {
   return
   @[
-    [[FBRoute GET:@"/screenshot"].withoutSession respondWithTarget:self action:@selector(handleGetScreenshot:)],
-    [[FBRoute GET:@"/screenshot"] respondWithTarget:self action:@selector(handleGetScreenshot:)],
+    [[FBRoute GET:@"/screenshot"].withoutSession.standalone respondWithTarget:self action:@selector(handleGetScreenshot:)],
+    [[FBRoute GET:@"/screenshot"].standalone respondWithTarget:self action:@selector(handleGetScreenshot:)],
   ];
 }
 

package/WebDriverAgentLib/Commands/FBSessionCommands.m

@@ -47,8 +47,8 @@
     [[FBRoute POST:@"/wda/apps/state"] respondWithTarget:self action:@selector(handleSessionAppState:)],
     [[FBRoute GET:@"/wda/apps/list"] respondWithTarget:self action:@selector(handleGetActiveAppsList:)],
     [[FBRoute GET:@""] respondWithTarget:self action:@selector(handleGetActiveSession:)],
-    [[FBRoute DELETE:@""] respondWithTarget:self action:@selector(handleDeleteSession:)],
-    [[FBRoute GET:@"/status"].withoutSession respondWithTarget:self action:@selector(handleGetStatus:)],
+    [[FBRoute DELETE:@""].standalone respondWithTarget:self action:@selector(handleDeleteSession:)],
+    [[FBRoute GET:@"/status"].withoutSession.standalone respondWithTarget:self action:@selector(handleGetStatus:)],
 
     // Health check might modify simulator state so it should only be called in-between testing sessions
     [[FBRoute GET:@"/wda/healthcheck"].withoutSession respondWithTarget:self action:@selector(handleGetHealthCheck:)],
@@ -89,9 +89,7 @@
 
 + (id<FBResponsePayload>)handleCreateSession:(FBRouteRequest *)request
 {
-  if (nil != FBSession.activeSession) {
-    [FBSession.activeSession kill];
-  }
+  [FBSession killActiveSessionAndWaitForTeardown];
 
   NSDictionary<NSString *, id> *capabilities;
   id<FBResponsePayload> errorResponse = [self capabilitiesFromCreateSessionRequest:request
@@ -311,6 +309,9 @@
   if (nil != capabilities[FB_SETTING_WAIT_FOR_IDLE_TIMEOUT]) {
     FBConfiguration.sharedInstance.waitForIdleTimeout = [capabilities[FB_SETTING_WAIT_FOR_IDLE_TIMEOUT] doubleValue];
   }
+  if (nil != capabilities[FB_SETTING_ACCESSIBILITY_DEADLINE]) {
+    FBConfiguration.sharedInstance.accessibilityDeadline = [capabilities[FB_SETTING_ACCESSIBILITY_DEADLINE] doubleValue];
+  }
   if (nil == capabilities[FB_CAP_FORCE_SIMULATOR_SOFTWARE_KEYBOARD_PRESENCE] ||
       [capabilities[FB_CAP_FORCE_SIMULATOR_SOFTWARE_KEYBOARD_PRESENCE] boolValue]) {
     [FBConfiguration.sharedInstance forceSimulatorSoftwareKeyboardPresence];

package/WebDriverAgentLib/Info.plist

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

package/WebDriverAgentLib/Routing/FBHTTPServer.h

@@ -47,17 +47,41 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  Registers a route handler for the given HTTP method and path pattern (":param" segments are
- captured into the request's `params`).
+ captured into the request's `params`). Equivalent to -handleMethod:withPath:standalone:block:
+ with standalone:NO.
  */
 - (void)handleMethod:(NSString *)method
             withPath:(NSString *)path
                block:(void (^)(RouteRequest *request, RouteResponse *response))block;
 
+/**
+ Registers a route handler that, when `standalone` is YES, bypasses -routeQueue entirely so a
+ handler stuck on that queue can never block it. Concurrent requests to the same method+path are
+ coalesced into a single in-flight execution, whose response is delivered to all of them; anything
+ else runs on its own queue, so distinct standalone endpoints always execute in parallel with each
+ other and with whatever is stuck on -routeQueue.
+ */
+- (void)handleMethod:(NSString *)method
+            withPath:(NSString *)path
+          standalone:(BOOL)standalone
+               block:(void (^)(RouteRequest *request, RouteResponse *response))block;
+
 /**
  Convenience for -handleMethod:@"GET" withPath:path block:block.
  */
 - (void)get:(NSString *)path withBlock:(void (^)(RouteRequest *request, RouteResponse *response))block;
 
+/**
+ Immediately sends `response` to every non-standalone request currently pending for the given
+ "sessionID" path param - whether still queued on -routeQueue or already executing - instead of
+ leaving their HTTP clients waiting on a session that no longer exists. A request that has already
+ started executing keeps running to completion in the background regardless (GCD gives no way to
+ abort a block once it starts), but its eventual result is discarded rather than ever reaching a
+ client. `response` is written as-is to every pending client, so the caller is expected to supply
+ a fully-populated, protocol-correct error response (e.g. a W3C-shaped JSON body).
+ */
+- (void)abandonPendingRequestsForSessionID:(NSString *)sessionID withResponse:(RouteResponse *)response;
+
 /**
  Starts listening on `port`.
  */