appium-webdriveragent 16.5.0 → 16.6.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [16.6.0](https://github.com/appium/WebDriverAgent/compare/v16.5.1...v16.6.0) (2026-08-22)
+
+### Features
+
+* Add MJPEG screenshot streaming support to watchOS ([#1220](https://github.com/appium/WebDriverAgent/issues/1220)) ([c6dcf03](https://github.com/appium/WebDriverAgent/commit/c6dcf03096dd5faab83398f16fb772724fcc5220))
+
+## [16.5.1](https://github.com/appium/WebDriverAgent/compare/v16.5.0...v16.5.1) (2026-08-20)
+
+### Bug Fixes
+
+* add watchOS assets to GitHub release artifacts ([#1219](https://github.com/appium/WebDriverAgent/issues/1219)) ([ce5a9e8](https://github.com/appium/WebDriverAgent/commit/ce5a9e8af36747a72669c34b38bd39e495b57f5b))
+
 ## [16.5.0](https://github.com/appium/WebDriverAgent/compare/v16.4.0...v16.5.0) (2026-08-20)
 
 ### Features

package/WebDriverAgent.xcodeproj/project.pbxproj

@@ -310,6 +310,7 @@
 		641EE5F62240C5CA00173FCB /* FBRouteRequest.m in Sources */ = {isa = PBXBuildFile; fileRef = EE9AB7881CAEDF0C008C271F /* FBRouteRequest.m */; };
 		641EE5F72240C5CA00173FCB /* FBResponseJSONPayload.m in Sources */ = {isa = PBXBuildFile; fileRef = EE9AB7811CAEDF0C008C271F /* FBResponseJSONPayload.m */; };
 		641EE5F92240C5CA00173FCB /* FBMjpegServer.m in Sources */ = {isa = PBXBuildFile; fileRef = 7155D702211DCEF400166C20 /* FBMjpegServer.m */; };
+		AA11BB22CC33DD44EE55FF02 /* FBMjpegServer.m in Sources */ = {isa = PBXBuildFile; fileRef = 7155D702211DCEF400166C20 /* FBMjpegServer.m */; };
 		641EE5FA2240C5CA00173FCB /* XCUIDevice+FBHealthCheck.m in Sources */ = {isa = PBXBuildFile; fileRef = EEDFE1201D9C06F800E6FFE5 /* XCUIDevice+FBHealthCheck.m */; };
 		641EE5FD2240C5CA00173FCB /* FBBaseActionsSynthesizer.m in Sources */ = {isa = PBXBuildFile; fileRef = 7140974D1FAE20EE008FB2C5 /* FBBaseActionsSynthesizer.m */; };
 		641EE5FE2240C5CA00173FCB /* XCUIElement+FBWebDriverAttributes.m in Sources */ = {isa = PBXBuildFile; fileRef = EEE376481D59FAE900ED88DD /* XCUIElement+FBWebDriverAttributes.m */; };
@@ -1320,6 +1321,7 @@
 		FBDF04E5916B91FCEC0190CB /* Route.h in Headers */ = {isa = PBXBuildFile; fileRef = E444DCA324913C210060D7EB /* Route.h */; };
 		FBF064E4D96CFCD08E1F4EF7 /* XCUIDevice.h in Headers */ = {isa = PBXBuildFile; fileRef = EE35ACFD1E3B77D600A02D78 /* XCUIDevice.h */; };
 		FBFEC05ED2C01D1EAE34BE9A /* WDAScreenshotAndSourceIntegrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 75F677B5B7737E7E1F321C20 /* WDAScreenshotAndSourceIntegrationTests.swift */; };
+		AA11BB22CC33DD44EE55FF04 /* WDAMjpegStreamingIntegrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = AA11BB22CC33DD44EE55FF03 /* WDAMjpegStreamingIntegrationTests.swift */; };
 		FC607DB5132FEF425237267B /* XCTMessagingRole_MemoryTesting-Protocol.h in Headers */ = {isa = PBXBuildFile; fileRef = 13D863EAE7F6F8B7E42D99B9 /* XCTMessagingRole_MemoryTesting-Protocol.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		FC73EE781D24A598B44C3337 /* XCUIElement+FBScrolling.m in Sources */ = {isa = PBXBuildFile; fileRef = EE9AB74A1CAEDF0C008C271F /* XCUIElement+FBScrolling.m */; };
 		FD89236D119E129E8CEBDBCD /* XCTMessagingRole_HIDEventRecording-Protocol.h in Headers */ = {isa = PBXBuildFile; fileRef = 94D7F0C1E30FBDB5D2583908 /* XCTMessagingRole_HIDEventRecording-Protocol.h */; };
@@ -1739,6 +1741,7 @@
 		75438FC693C39052C82C27DB /* XCUIApplicationRegistry.h */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.c.h; path = XCUIApplicationRegistry.h; sourceTree = "<group>"; };
 		758FC0D745C185A2C28BEDA1 /* IntegrationApp_watchOS.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = IntegrationApp_watchOS.app; sourceTree = BUILT_PRODUCTS_DIR; };
 		75F677B5B7737E7E1F321C20 /* WDAScreenshotAndSourceIntegrationTests.swift */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.swift; path = WDAScreenshotAndSourceIntegrationTests.swift; sourceTree = "<group>"; };
+		AA11BB22CC33DD44EE55FF03 /* WDAMjpegStreamingIntegrationTests.swift */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.swift; path = WDAMjpegStreamingIntegrationTests.swift; sourceTree = "<group>"; };
 		7AA21CEBA6E92AAC73FB6A48 /* XCTAggregateSuiteRunStatistics.h */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.c.h; path = XCTAggregateSuiteRunStatistics.h; sourceTree = "<group>"; };
 		7CBAA574F7786985E01D0B6F /* XCTHarnessEventReporting-Protocol.h */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.c.h; path = "XCTHarnessEventReporting-Protocol.h"; sourceTree = "<group>"; };
 		7E079E00FE148476F94BC42F /* XCTTestIdentifierSet.h */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = sourcecode.c.h; path = XCTTestIdentifierSet.h; sourceTree = "<group>"; };
@@ -2503,6 +2506,7 @@
 				C878996F07A9B26E66FC4EAC /* WDAClickIntegrationTests.swift */,
 				912F32C353FE7C3E7C841405 /* WDATypingIntegrationTests.swift */,
 				75F677B5B7737E7E1F321C20 /* WDAScreenshotAndSourceIntegrationTests.swift */,
+				AA11BB22CC33DD44EE55FF03 /* WDAMjpegStreamingIntegrationTests.swift */,
 				EB1B9A793C9EFB7853C1AA13 /* WDAAppLifecycleIntegrationTests.swift */,
 				646D714BC17FE9258CFBDF55 /* WDADeviceIntegrationTests.swift */,
 				28F75AEC6442F32A3C4394AD /* WDAAlertIntegrationTests.swift */,
@@ -4741,6 +4745,7 @@
 				6AF8892AEF5C6BF01896B6DA /* WDAAppLifecycleIntegrationTests.swift in Sources */,
 				6EDF83DA0A6C7A7E67C30AF6 /* WDADeviceIntegrationTests.swift in Sources */,
 				FBFEC05ED2C01D1EAE34BE9A /* WDAScreenshotAndSourceIntegrationTests.swift in Sources */,
+				AA11BB22CC33DD44EE55FF04 /* WDAMjpegStreamingIntegrationTests.swift in Sources */,
 				D22FED0B3856919DA4BCFA67 /* WDATypingIntegrationTests.swift in Sources */,
 				68EB0B8D53270CB68C53D028 /* WDAAlertIntegrationTests.swift in Sources */,
 			);
@@ -4862,6 +4867,7 @@
 				C2D22426DB9FCE6AD84FA16A /* RouteRequest.m in Sources */,
 				3FEF512914A962C5E30579FC /* RouteResponse.m in Sources */,
 				91FF05D51401D1F1A88FB0B0 /* FBWatchHTTPServer.m in Sources */,
+				AA11BB22CC33DD44EE55FF02 /* FBMjpegServer.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

package/WebDriverAgentLib/Info.plist

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

package/WebDriverAgentLib/Routing/FBTCPSocket.h

@@ -92,6 +92,13 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nullable, nonatomic, assign) id<FBTCPSocketDelegate> delegate;
 #endif
 
+/**
+ The port this socket is listening on. Equal to the port passed to -initWithPort: unless that was
+ 0 ("let the system assign a port"), in which case this reflects the actually assigned port once
+ -startWithError: has returned successfully.
+ */
+@property (nonatomic, readonly) uint16_t port;
+
 /**
  Creates TCP socket isntance which is going to be started on the specified port
 

package/WebDriverAgentLib/Routing/FBTCPSocket.m

@@ -14,7 +14,6 @@
 @property (readonly, nonatomic) dispatch_queue_t socketQueue;
 @property (nullable, nonatomic) nw_listener_t listener;
 @property (readonly, nonatomic) NSMutableArray<nw_connection_t> *connectedClients;
-@property (readonly, nonatomic) uint16_t port;
 @end
 
 
@@ -61,6 +60,10 @@
     // if/else, not switch: -Wswitch-enum, -Wswitch-default, and -Wcovered-switch-default can't
     // all be satisfied by one switch statement at once.
     if (nw_listener_state_ready == state) {
+      __strong typeof(weakSelf) strongSelf = weakSelf;
+      if (strongSelf) {
+        strongSelf->_port = nw_listener_get_port(listener);
+      }
       dispatch_semaphore_signal(startupSemaphore);
     } else if (nw_listener_state_failed == state || nw_listener_state_cancelled == state) {
       // NSLocalizedDescriptionKey must be a string, not the underlying NSError itself, or
@@ -210,7 +213,6 @@
 @property (readonly, nonatomic) dispatch_queue_t socketQueue;
 @property (readonly, nonatomic) GCDAsyncSocket *listeningSocket;
 @property (readonly, nonatomic) NSMutableArray *connectedClients;
-@property (readonly, nonatomic) uint16_t port;
 @end
 
 
@@ -239,6 +241,7 @@
     return NO;
   }
 
+  _port = self.listeningSocket.localPort;
   return YES;
 }
 

package/WebDriverAgentLib/Routing/FBWebServer.m

@@ -13,9 +13,9 @@
 #else
 #import "RoutingConnection.h"
 #import "RoutingHTTPServer.h"
+#endif
 #import "FBMjpegServer.h"
 #import "FBTCPSocket.h"
-#endif
 
 #import "FBCommandHandler.h"
 #import "FBErrorBuilder.h"
@@ -59,9 +59,9 @@ static NSString *const FBServerURLEndMarker = @"<-ServerURLHere";
 @property (nonatomic, strong) FBWatchHTTPServer *server;
 #else
 @property (nonatomic, strong) RoutingHTTPServer *server;
+#endif
 @property (nonatomic, nullable) FBTCPSocket *screenshotsBroadcaster;
 @property (nonatomic, nullable, strong) FBMjpegServer *mjpegServer;
-#endif
 @property (atomic, assign) BOOL keepAlive;
 @end
 
@@ -69,9 +69,7 @@ static NSString *const FBServerURLEndMarker = @"<-ServerURLHere";
 
 - (void)dealloc
 {
-#if !TARGET_OS_WATCH
   [self stopScreenshotsBroadcaster];
-#endif
 }
 
 + (NSArray<Class<FBCommandHandler>> *)collectCommandHandlerClasses
@@ -96,9 +94,7 @@ static NSString *const FBServerURLEndMarker = @"<-ServerURLHere";
   if (![self startHTTPServer]) {
     return;
   }
-#if !TARGET_OS_WATCH
   [self initScreenshotsBroadcaster];
-#endif
 
   self.keepAlive = YES;
   NSRunLoop *runLoop = [NSRunLoop mainRunLoop];
@@ -163,13 +159,15 @@ static NSString *const FBServerURLEndMarker = @"<-ServerURLHere";
   return YES;
 }
 
-#if !TARGET_OS_WATCH
 - (void)initScreenshotsBroadcaster
 {
   [self readMjpegSettingsFromEnv];
   self.mjpegServer = [[FBMjpegServer alloc] init];
   self.screenshotsBroadcaster = [[FBTCPSocket alloc]
                                  initWithPort:(uint16_t)FBConfiguration.sharedInstance.mjpegServerPort];
+#if TARGET_OS_WATCH
+  self.mjpegServer.socket = self.screenshotsBroadcaster;
+#endif
   self.screenshotsBroadcaster.delegate = self.mjpegServer;
   NSError *error;
   if (![self.screenshotsBroadcaster startWithError:&error]) {
@@ -209,14 +207,11 @@ static NSString *const FBServerURLEndMarker = @"<-ServerURLHere";
     FBConfiguration.sharedInstance.mjpegServerScreenshotQuality = [screenshotQuality integerValue];
   }
 }
-#endif
 
 - (void)stopServing
 {
   [FBSession.activeSession kill];
-#if !TARGET_OS_WATCH
   [self stopScreenshotsBroadcaster];
-#endif
   if (self.server.isRunning) {
     [self.server stop:NO];
   }

package/WebDriverAgentLib/Utilities/FBMjpegServer.h

@@ -19,6 +19,15 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (instancetype)init;
 
+#if TARGET_OS_WATCH
+/**
+ The socket that owns this instance as its delegate. watchOS clients are bare nw_connection_t
+ values with no write method of their own (unlike GCDAsyncSocket on other platforms), so frame
+ writes are routed through -[FBTCPSocket writeData:toClient:]. Must be set before streaming starts.
+ */
+@property (nonatomic, weak, nullable) FBTCPSocket *socket;
+#endif
+
 /**
  Stops screenshot broadcasting and prevents future scheduling.
  */

package/WebDriverAgentLib/Utilities/FBMjpegServer.m

@@ -11,7 +11,12 @@
 #import <mach/mach_time.h>
 @import UniformTypeIdentifiers;
 
+#if TARGET_OS_WATCH
+// Textual import, not `@import Network;` - see the comment in FBTCPSocket.h.
+#import <Network/Network.h>
+#else
 #import "GCDAsyncSocket.h"
+#endif
 #import "FBConfiguration.h"
 #import "FBLogger.h"
 #import "FBScreenshot.h"
@@ -36,7 +41,11 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
 @interface FBMjpegServer()
 
 @property (nonatomic, readonly) dispatch_queue_t backgroundQueue;
+#if TARGET_OS_WATCH
+@property (nonatomic, readonly) NSMutableArray<nw_connection_t> *listeningClients;
+#else
 @property (nonatomic, readonly) NSMutableArray<GCDAsyncSocket *> *listeningClients;
+#endif
 @property (nonatomic, readonly) FBImageProcessor *imageProcessor;
 @property (nonatomic, readonly) long long mainScreenID;
 @property (nonatomic, assign) NSUInteger consecutiveScreenshotFailures;
@@ -148,10 +157,16 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
       return;
     }
     NSUInteger clientCount = self.listeningClients.count;
+#if TARGET_OS_WATCH
+    for (nw_connection_t client in self.listeningClients) {
+      [self.socket writeData:chunk toClient:client];
+    }
+#else
     for (GCDAsyncSocket *client in self.listeningClients) {
       // Slow clients should fail/close instead of buffering indefinitely.
       [client writeData:chunk withTimeout:FRAME_TIMEOUT tag:0];
     }
+#endif
     self.sentFramesCount++;
     self.sentBytesCount += chunk.length * clientCount;
     NSUInteger framerate = FBNormalizedMjpegFramerate(FBConfiguration.sharedInstance.mjpegServerFramerate);
@@ -164,6 +179,53 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
   }
 }
 
+#if TARGET_OS_WATCH
+
+- (void)didClientConnect:(nw_connection_t)newClient
+{
+  [FBLogger log:@"Got screenshots broadcast client connection"];
+  // FBTCPSocket already schedules the receive that -client:didReceiveData: relies on below;
+  // unlike GCDAsyncSocket, there is nothing to arm here.
+}
+
+- (void)client:(nw_connection_t)client didReceiveData:(NSData *)data
+{
+  @synchronized (self.listeningClients) {
+    if ([self.listeningClients containsObject:client]) {
+      return;
+    }
+  }
+
+  [FBLogger log:@"Starting screenshots broadcast for the client"];
+  NSString *streamHeader = [NSString stringWithFormat:@"HTTP/1.0 200 OK\r\nServer: %@\r\nConnection: close\r\nMax-Age: 0\r\nExpires: 0\r\nCache-Control: no-cache, private\r\nPragma: no-cache\r\nContent-Type: multipart/x-mixed-replace; boundary=--BoundaryString\r\n\r\n", SERVER_NAME];
+  [self.socket writeData:(id)[streamHeader dataUsingEncoding:NSUTF8StringEncoding] toClient:client];
+  @synchronized (self.listeningClients) {
+    [self.listeningClients addObject:client];
+  }
+}
+
+- (void)didClientDisconnect:(nw_connection_t)client
+{
+  @synchronized (self.listeningClients) {
+    [self.listeningClients removeObject:client];
+  }
+  [FBLogger log:@"Disconnected a client from screenshots broadcast"];
+}
+
+- (void)stopStreaming
+{
+  self.isStreaming = NO;
+  @synchronized (self.listeningClients) {
+    NSArray<nw_connection_t> *clients = self.listeningClients.copy;
+    [self.listeningClients removeAllObjects];
+    for (nw_connection_t client in clients) {
+      nw_connection_cancel(client);
+    }
+  }
+}
+
+#else
+
 - (void)didClientConnect:(GCDAsyncSocket *)newClient
 {
   [FBLogger logFmt:@"Got screenshots broadcast client connection at %@:%d", newClient.connectedHost, newClient.connectedPort];
@@ -207,6 +269,8 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
   }
 }
 
+#endif
+
 - (void)dealloc
 {
   [self stopStreaming];

package/WebDriverAgentTests/IntegrationTests_watchOS/IntegrationTests_watchOS-Bridging-Header.h

@@ -19,3 +19,5 @@
 #import "XCUIDevice+FBHelpers.h"
 #import "FBAlert.h"
 #import "FBElement.h"
+#import "FBMjpegServer.h"
+#import "FBTCPSocket.h"

package/WebDriverAgentTests/IntegrationTests_watchOS/WDAMjpegStreamingIntegrationTests.swift

@@ -0,0 +1,81 @@
+/**
+ * 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 Network
+import XCTest
+
+/// Exercises FBMjpegServer+FBTCPSocket the same way FBWebServer wires them together in
+/// -initScreenshotsBroadcaster, but standalone (no full FBWebServer/HTTP command server needed).
+/// A client NWConnection reads the raw wire bytes back to confirm the multipart/x-mixed-replace
+/// stream and its JPEG frames actually arrive, since watchOS has no BSD sockets/GCDAsyncSocket -
+/// the production implementation is Network.framework-backed and worth covering for real.
+final class WDAMjpegStreamingIntegrationTests: WDAWatchInProcessTestCase {
+  override class var relaunchForEachTest: Bool { false }
+
+  private static let jpegMagicBytes: [UInt8] = [0xFF, 0xD8, 0xFF]
+
+  func testMjpegStreamingProducesJpegFrames() throws {
+    // Port 0 asks the system to assign an ephemeral port; -[FBTCPSocket port] then reflects the
+    // actual bound port once -start returns, per nw_listener_get_port's documented behavior.
+    let socket = FBTCPSocket(port: 0)
+    let server = FBMjpegServer()
+    server.socket = socket
+    socket.delegate = server
+    defer {
+      server.stopStreaming()
+      socket.stop()
+    }
+    try socket.start()
+    let boundPort = socket.port
+    XCTAssertNotEqual(boundPort, 0, "FBTCPSocket did not report its bound ephemeral port")
+
+    let connection = NWConnection(host: "127.0.0.1", port: NWEndpoint.Port(rawValue: boundPort)!, using: .tcp)
+    defer { connection.cancel() }
+
+    let connected = expectation(description: "client connected to the mjpeg broadcaster")
+    connection.stateUpdateHandler = { state in
+      if case .ready = state {
+        connected.fulfill()
+      }
+    }
+    connection.start(queue: .main)
+    wait(for: [connected], timeout: 15)
+
+    // FBMjpegServer only starts broadcasting once it has seen any data from the client - mimic the
+    // request line a real HTTP client would send.
+    let sent = expectation(description: "sent the request line")
+    connection.send(content: Data("GET / HTTP/1.0\r\n\r\n".utf8), completion: .contentProcessed { _ in
+      sent.fulfill()
+    })
+    wait(for: [sent], timeout: 15)
+
+    var received = Data()
+    let jpegMagicData = Data(Self.jpegMagicBytes)
+    let sawJpegFrame = expectation(description: "received at least one jpeg frame")
+    func receiveMore() {
+      connection.receive(minimumIncompleteLength: 1, maximumLength: 65536) { data, _, _, error in
+        if let data = data {
+          received.append(data)
+          if received.range(of: jpegMagicData) != nil {
+            sawJpegFrame.fulfill()
+            return
+          }
+        }
+        if error == nil {
+          receiveMore()
+        }
+      }
+    }
+    receiveMore()
+    wait(for: [sawJpegFrame], timeout: 15)
+
+    XCTAssertNotNil(received.range(of: Data("multipart/x-mixed-replace".utf8)), "Response is not a multipart stream")
+    XCTAssertNotNil(received.range(of: Data("Content-type: image/jpeg".utf8)), "No JPEG part header found")
+    XCTAssertNotNil(received.range(of: jpegMagicData), "No JPEG frame data found")
+  }
+}

package/package.json

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