appium-webdriveragent 16.9.3 → 16.10.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [16.10.0](https://github.com/appium/WebDriverAgent/compare/v16.9.4...v16.10.0) (2026-08-29)
+
+### Features
+
+* add displayId in the wda/screen ([#1238](https://github.com/appium/WebDriverAgent/issues/1238)) ([bfbe6b0](https://github.com/appium/WebDriverAgent/commit/bfbe6b00b196647f87267827627a5ff675496c30))
+
+## [16.9.4](https://github.com/appium/WebDriverAgent/compare/v16.9.3...v16.9.4) (2026-08-29)
+
+### Bug Fixes
+
+* drop MJPEG frames for clients that stop draining their socket ([#1227](https://github.com/appium/WebDriverAgent/issues/1227)) ([00cb6b6](https://github.com/appium/WebDriverAgent/commit/00cb6b612a5a1a1d00a386e23de01c4eca811df8))
+
 ## [16.9.3](https://github.com/appium/WebDriverAgent/compare/v16.9.2...v16.9.3) (2026-08-29)
 
 ### Bug Fixes

package/WebDriverAgentLib/Commands/FBCustomCommands.m

@@ -174,6 +174,7 @@
     @"statusBarSize": @{@"width": @(statusBarSize.width),
                         @"height": @(statusBarSize.height),
     },
+    @"displayId": @([FBScreen displayID]),
     @"scale": @([FBScreen scale]),
   });
 }

package/WebDriverAgentLib/Info.plist

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

package/WebDriverAgentLib/Utilities/FBMjpegServer.m

@@ -22,6 +22,9 @@
 
 static const NSUInteger MAX_FPS = 60;
 static const NSTimeInterval FRAME_TIMEOUT = 1.;
+// nw_connection_send buffers without backpressure, so a client that stops reading would retain
+// every generated frame. Frames past this cap are dropped instead of queued.
+static const NSUInteger MAX_PENDING_FRAMES_PER_CLIENT = 4;
 static const NSTimeInterval FAILURE_BACKOFF_MIN = 1.0;
 static const NSTimeInterval FAILURE_BACKOFF_MAX = 10.0;
 
@@ -44,6 +47,9 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
 @property (atomic, assign) BOOL isStreaming;
 @property (nonatomic, assign) NSUInteger sentFramesCount;
 @property (nonatomic, assign) NSUInteger sentBytesCount;
+@property (nonatomic, assign) NSUInteger droppedFramesCount;
+// Frames submitted but not sent yet, per client. Guarded by @synchronized (self.listeningClients).
+@property (nonatomic, readonly) NSMapTable<id, NSNumber *> *pendingFrameCounts;
 
 @end
 
@@ -58,6 +64,8 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
     _sentFramesCount = 0;
     _sentBytesCount = 0;
     _listeningClients = [NSMutableArray array];
+    _pendingFrameCounts = [NSMapTable mapTableWithKeyOptions:(NSPointerFunctionsOptions)(NSMapTableObjectPointerPersonality | NSMapTableStrongMemory)
+                                                valueOptions:(NSPointerFunctionsOptions)NSMapTableStrongMemory];
     _imageProcessor = [[FBImageProcessor alloc] init];
     _mainScreenID = [XCUIScreen.mainScreen displayID];
     dispatch_queue_attr_t queueAttributes = dispatch_queue_attr_make_with_qos_class(DISPATCH_QUEUE_SERIAL, QOS_CLASS_UTILITY, 0);
@@ -149,17 +157,38 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
       return;
     }
     NSUInteger clientCount = self.listeningClients.count;
+    __weak typeof(self) weakSelf = self;
     for (nw_connection_t client in self.listeningClients) {
-      [self.socket writeData:chunk toClient:client];
+      NSUInteger pendingFrames = [self.pendingFrameCounts objectForKey:client].unsignedIntegerValue;
+      if (pendingFrames >= MAX_PENDING_FRAMES_PER_CLIENT) {
+        self.droppedFramesCount++;
+        continue;
+      }
+      [self.pendingFrameCounts setObject:@(pendingFrames + 1) forKey:client];
+      [self.socket writeData:chunk toClient:client completion:^{
+        __strong typeof(weakSelf) strongSelf = weakSelf;
+        if (nil == strongSelf) {
+          return;
+        }
+        @synchronized (strongSelf.listeningClients) {
+          NSUInteger stillPending = [strongSelf.pendingFrameCounts objectForKey:client].unsignedIntegerValue;
+          if (stillPending > 1) {
+            [strongSelf.pendingFrameCounts setObject:@(stillPending - 1) forKey:client];
+          } else {
+            [strongSelf.pendingFrameCounts removeObjectForKey:client];
+          }
+        }
+      }];
     }
     self.sentFramesCount++;
     self.sentBytesCount += chunk.length * clientCount;
     NSUInteger framerate = FBNormalizedMjpegFramerate(FBConfiguration.sharedInstance.mjpegServerFramerate);
     if (0 == self.sentFramesCount % framerate) {
-      [FBLogger verboseLog:[NSString stringWithFormat:@"MJPEG stats: clients=%@ sentFrames=%@ sentBytes=%@",
+      [FBLogger verboseLog:[NSString stringWithFormat:@"MJPEG stats: clients=%@ sentFrames=%@ sentBytes=%@ droppedFrames=%@",
                             @(clientCount),
                             @(self.sentFramesCount),
-                            @(self.sentBytesCount)]];
+                            @(self.sentBytesCount),
+                            @(self.droppedFramesCount)]];
     }
   }
 }
@@ -190,6 +219,7 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
 {
   @synchronized (self.listeningClients) {
     [self.listeningClients removeObject:client];
+    [self.pendingFrameCounts removeObjectForKey:client];
   }
   [FBLogger log:@"Disconnected a client from screenshots broadcast"];
 }
@@ -200,6 +230,7 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
   @synchronized (self.listeningClients) {
     NSArray<nw_connection_t> *clients = self.listeningClients.copy;
     [self.listeningClients removeAllObjects];
+    [self.pendingFrameCounts removeAllObjects];
     for (nw_connection_t client in clients) {
       nw_connection_cancel(client);
     }

package/WebDriverAgentLib/Utilities/FBScreen.h

@@ -12,6 +12,11 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface FBScreen : NSObject
 
+/**
+ The identifier of the main device's display
+ */
++ (long long)displayID;
+
 /**
  The scale factor of the main device's screen
  */

package/WebDriverAgentLib/Utilities/FBScreen.m

@@ -13,6 +13,11 @@
 
 @implementation FBScreen
 
++ (long long)displayID
+{
+  return XCUIScreen.mainScreen.displayID;
+}
+
 + (double)scale
 {
   return [XCUIScreen.mainScreen scale];

package/WebDriverAgentTests/IntegrationTests/FBScreenTests.m

@@ -22,10 +22,14 @@
   [self launchApplication];
 }
 
+- (void)testDisplayID
+{
+  XCTAssertGreaterThanOrEqual([FBScreen displayID], 0LL);
+}
+
 - (void)testScreenScale
 {
   XCTAssertTrue([FBScreen scale] >= 2);
 }
 
 @end
-

package/package.json

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