appium-webdriveragent 16.5.1 → 16.7.0

package/WebDriverAgentLib/Utilities/FBMjpegServer.m

@@ -11,7 +11,8 @@
 #import <mach/mach_time.h>
 @import UniformTypeIdentifiers;
 
-#import "GCDAsyncSocket.h"
+// Textual import, not `@import Network;` - see the comment in FBTCPSocket.h.
+#import <Network/Network.h>
 #import "FBConfiguration.h"
 #import "FBLogger.h"
 #import "FBScreenshot.h"
@@ -36,7 +37,7 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
 @interface FBMjpegServer()
 
 @property (nonatomic, readonly) dispatch_queue_t backgroundQueue;
-@property (nonatomic, readonly) NSMutableArray<GCDAsyncSocket *> *listeningClients;
+@property (nonatomic, readonly) NSMutableArray<nw_connection_t> *listeningClients;
 @property (nonatomic, readonly) FBImageProcessor *imageProcessor;
 @property (nonatomic, readonly) long long mainScreenID;
 @property (nonatomic, assign) NSUInteger consecutiveScreenshotFailures;
@@ -148,9 +149,8 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
       return;
     }
     NSUInteger clientCount = self.listeningClients.count;
-    for (GCDAsyncSocket *client in self.listeningClients) {
-      // Slow clients should fail/close instead of buffering indefinitely.
-      [client writeData:chunk withTimeout:FRAME_TIMEOUT tag:0];
+    for (nw_connection_t client in self.listeningClients) {
+      [self.socket writeData:chunk toClient:client];
     }
     self.sentFramesCount++;
     self.sentBytesCount += chunk.length * clientCount;
@@ -164,14 +164,13 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
   }
 }
 
-- (void)didClientConnect:(GCDAsyncSocket *)newClient
+- (void)didClientConnect:(nw_connection_t)newClient
 {
-  [FBLogger logFmt:@"Got screenshots broadcast client connection at %@:%d", newClient.connectedHost, newClient.connectedPort];
-  // Start broadcast only after there is any data from the client
-  [newClient readDataWithTimeout:-1 tag:0];
+  [FBLogger log:@"Got screenshots broadcast client connection"];
+  // FBTCPSocket already schedules the receive that -client:didReceiveData: relies on below.
 }
 
-- (void)didClientSendData:(GCDAsyncSocket *)client
+- (void)client:(nw_connection_t)client didReceiveData:(NSData *)data
 {
   @synchronized (self.listeningClients) {
     if ([self.listeningClients containsObject:client]) {
@@ -179,15 +178,15 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
     }
   }
 
-  [FBLogger logFmt:@"Starting screenshots broadcast for the client at %@:%d", client.connectedHost, client.connectedPort];
+  [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];
-  [client writeData:(id)[streamHeader dataUsingEncoding:NSUTF8StringEncoding] withTimeout:-1 tag:0];
+  [self.socket writeData:(id)[streamHeader dataUsingEncoding:NSUTF8StringEncoding] toClient:client];
   @synchronized (self.listeningClients) {
     [self.listeningClients addObject:client];
   }
 }
 
-- (void)didClientDisconnect:(GCDAsyncSocket *)client
+- (void)didClientDisconnect:(nw_connection_t)client
 {
   @synchronized (self.listeningClients) {
     [self.listeningClients removeObject:client];
@@ -199,10 +198,10 @@ static NSUInteger FBNormalizedMjpegFramerate(NSUInteger framerate)
 {
   self.isStreaming = NO;
   @synchronized (self.listeningClients) {
-    NSArray<GCDAsyncSocket *> *clients = self.listeningClients.copy;
+    NSArray<nw_connection_t> *clients = self.listeningClients.copy;
     [self.listeningClients removeAllObjects];
-    for (GCDAsyncSocket *client in clients) {
-      [client disconnect];
+    for (nw_connection_t client in clients) {
+      nw_connection_cancel(client);
     }
   }
 }

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.1",
+  "version": "16.7.0",
   "description": "Package bundling WebDriverAgent",
   "keywords": [
     "Appium",