Move sniHostname to WebSocketClientConfiguration

Author: adam-fowler

Sources/WSClient/WebSocketClient.swift

@@ -50,7 +50,7 @@ public struct WebSocketClient {
     }
 
     enum MultiPlatformTLSConfiguration: Sendable {
-        case niossl(TLSConfiguration, serverName: String?)
+        case niossl(TLSConfiguration)
         #if canImport(Network)
         case ts(TSTLSOptions)
         #endif
@@ -91,34 +91,7 @@ public struct WebSocketClient {
         self.configuration = configuration
         self.eventLoopGroup = eventLoopGroup
         self.logger = logger
-        self.tlsConfiguration = tlsConfiguration.map { .niossl($0, serverName: nil) }
-    }
-
-    /// Initialize websocket client
-    ///
-    /// - Parametes:
-    ///   - url: URL of websocket
-    ///   - tlsConfiguration: TLS configuration
-    ///   - serverName: Server name indication
-    ///   - handler: WebSocket data handler
-    ///   - maxFrameSize: Max frame size for a single packet
-    ///   - eventLoopGroup: EventLoopGroup to run WebSocket client on
-    ///   - logger: Logger
-    public init(
-        url: String,
-        configuration: WebSocketClientConfiguration = .init(),
-        tlsConfiguration: TLSConfiguration,
-        serverName: String,
-        eventLoopGroup: EventLoopGroup = MultiThreadedEventLoopGroup.singleton,
-        logger: Logger,
-        handler: @escaping WebSocketDataHandler<Context>
-    ) {
-        self.url = .init(url)
-        self.handler = handler
-        self.configuration = configuration
-        self.eventLoopGroup = eventLoopGroup
-        self.logger = logger
-        self.tlsConfiguration = .niossl(tlsConfiguration, serverName: serverName)
+        self.tlsConfiguration = tlsConfiguration.map { .niossl($0) }
     }
 
     #if canImport(Network)
@@ -156,12 +129,12 @@ public struct WebSocketClient {
         let port = self.url.port ?? (requiresTLS ? 443 : 80)
         if requiresTLS {
             switch self.tlsConfiguration {
-            case .niossl(let tlsConfiguration, let serverName):
+            case .niossl(let tlsConfiguration):
                 let client = try ClientConnection(
                     TLSClientChannel(
                         WebSocketClientChannel(handler: handler, url: url, configuration: self.configuration),
                         tlsConfiguration: tlsConfiguration,
-                        serverHostname: serverName ?? host
+                        serverHostname: self.configuration.sniHostname ?? host
                     ),
                     address: .hostname(host, port: port),
                     eventLoopGroup: self.eventLoopGroup,
@@ -244,38 +217,6 @@ extension WebSocketClient {
         return try await ws.run()
     }
 
-    /// Create websocket client, connect and handle connection
-    ///
-    /// - Parametes:
-    ///   - url: URL of websocket
-    ///   - tlsConfiguration: TLS configuration
-    ///   - serverName: Server name indication
-    ///   - maxFrameSize: Max frame size for a single packet
-    ///   - eventLoopGroup: EventLoopGroup to run WebSocket client on
-    ///   - logger: Logger
-    ///   - process: Closure handling webSocket
-    /// - Returns: WebSocket close frame details if server returned any
-    @discardableResult public static func connect(
-        url: String,
-        configuration: WebSocketClientConfiguration = .init(),
-        tlsConfiguration: TLSConfiguration,
-        serverName: String,
-        eventLoopGroup: EventLoopGroup = MultiThreadedEventLoopGroup.singleton,
-        logger: Logger,
-        handler: @escaping WebSocketDataHandler<Context>
-    ) async throws -> WebSocketCloseFrame? {
-        let ws = self.init(
-            url: url,
-            configuration: configuration,
-            tlsConfiguration: tlsConfiguration,
-            serverName: serverName,
-            eventLoopGroup: eventLoopGroup,
-            logger: logger,
-            handler: handler
-        )
-        return try await ws.run()
-    }
-
     #if canImport(Network)
     /// Create websocket client, connect and handle connection
     ///

Sources/WSClient/WebSocketClientConfiguration.swift

@@ -29,6 +29,8 @@ public struct WebSocketClientConfiguration: Sendable {
     public var autoPing: AutoPingSetup
     /// Should text be validated to be UTF8
     public var validateUTF8: Bool
+    /// Hostname used during TLS handshake
+    public var sniHostname: String?
 
     /// Initialize WebSocketClient configuration
     ///   - Paramters
@@ -37,6 +39,7 @@ public struct WebSocketClientConfiguration: Sendable {
     ///     - extensions: WebSocket extensions
     ///     - autoPing: Automatic Ping configuration
     ///     - validateUTF8: Should text be checked to see if it is valid UTF8
+    @_disfavoredOverload
     public init(
         maxFrameSize: Int = (1 << 14),
         additionalHeaders: HTTPFields = .init(),
@@ -51,5 +54,32 @@ public struct WebSocketClientConfiguration: Sendable {
         self.closeTimeout = closeTimeout
         self.autoPing = autoPing
         self.validateUTF8 = validateUTF8
+        self.sniHostname = nil
+    }
+
+    /// Initialize WebSocketClient configuration
+    ///   - Paramters
+    ///     - maxFrameSize: Max websocket frame size that can be sent/received
+    ///     - additionalHeaders: Additional headers to be sent with the initial HTTP request
+    ///     - extensions: WebSocket extensions
+    ///     - autoPing: Automatic Ping configuration
+    ///     - validateUTF8: Should text be checked to see if it is valid UTF8
+    ///     - sniHostname: Hostname used during TLS handshake
+    public init(
+        maxFrameSize: Int = (1 << 14),
+        additionalHeaders: HTTPFields = .init(),
+        extensions: [WebSocketExtensionFactory] = [],
+        closeTimeout: Duration = .seconds(15),
+        autoPing: AutoPingSetup = .disabled,
+        validateUTF8: Bool = false,
+        sniHostname: String? = nil
+    ) {
+        self.maxFrameSize = maxFrameSize
+        self.additionalHeaders = additionalHeaders
+        self.extensions = extensions.map { $0.build() }
+        self.closeTimeout = closeTimeout
+        self.autoPing = autoPing
+        self.validateUTF8 = validateUTF8
+        self.sniHostname = sniHostname
     }
 }

Tests/WebSocketTests/ClientTests.swift

@@ -29,8 +29,8 @@ final class WebSocketClientTests: XCTestCase {
         }()
         try await WebSocketClient.connect(
             url: "wss://echo.websocket.org/",
+            configuration: .init(sniHostname: "echo.websocket.org"),
             tlsConfiguration: TLSConfiguration.makeClientConfiguration(),
-            serverName: "echo.websocket.org",
             logger: clientLogger
         ) { inbound, outbound, _ in
             var inboundIterator = inbound.messages(maxSize: .max).makeAsyncIterator()