feat: Adds Data support to Messenger

This is backwards compatible support for Data sending.

Author: NeedleInAJayStack

Sources/GraphQLWS/Client.swift

@@ -141,35 +141,43 @@ public actor Client<InitPayload: Equatable & Codable> {
     /// Send a `connection_init` request through the messenger
     public func sendConnectionInit(payload: InitPayload) async throws {
         try await messenger.send(
-            ConnectionInitRequest(
-                payload: payload
-            ).toJSON(encoder)
+            encoder.encode(
+                ConnectionInitRequest(
+                    payload: payload
+                )
+            )
         )
     }
 
     /// Send a `start` request through the messenger
     public func sendStart(payload: GraphQLRequest, id: String) async throws {
         try await messenger.send(
-            StartRequest(
-                payload: payload,
-                id: id
-            ).toJSON(encoder)
+            encoder.encode(
+                StartRequest(
+                    payload: payload,
+                    id: id
+                )
+            )
         )
     }
 
     /// Send a `stop` request through the messenger
     public func sendStop(id: String) async throws {
         try await messenger.send(
-            StopRequest(
-                id: id
-            ).toJSON(encoder)
+            encoder.encode(
+                StopRequest(
+                    id: id
+                )
+            )
         )
     }
 
     /// Send a `connection_terminate` request through the messenger
     public func sendConnectionTerminate() async throws {
         try await messenger.send(
-            ConnectionTerminateRequest().toJSON(encoder)
+            encoder.encode(
+                ConnectionTerminateRequest()
+            )
         )
     }
 

Sources/GraphQLWS/JsonEncodable.swift

@@ -15,3 +15,15 @@ public protocol Messenger: Sendable {
     ///   - code: An error code
     func error(_ message: String, code: Int) async throws
 }
+
+extension Messenger {
+    /// Send a message through this messenger
+    /// - Parameter message: The message to send
+    func send(_ message: Data) async throws {
+        // TODO: Ideally Data is our native interface, and String is the extension.
+        // Since that change is breaking, we will do it on the next major version.
+        if let string = String(data: message, encoding: .utf8) {
+            try await send(string)
+        }
+    }
+}

Sources/GraphQLWS/Messenger.swift

@@ -2,12 +2,12 @@ import Foundation
 import GraphQL
 
 /// A general request. This object's type is used to triage to other, more specific request objects.
-public struct Request: Equatable, JsonEncodable {
+public struct Request: Equatable, Codable {
     public let type: RequestMessageType
 }
 
 /// A websocket `connection_init` request from the client to the server
-public struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
+public struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, Codable {
     public let type: RequestMessageType = .GQL_CONNECTION_INIT
     public let payload: InitPayload
 
@@ -31,7 +31,7 @@ public struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable
 }
 
 /// A websocket `start` request from the client to the server
-public struct StartRequest: Equatable, JsonEncodable {
+public struct StartRequest: Equatable, Codable {
     public let type: RequestMessageType = .GQL_START
     public let payload: GraphQLRequest
     public let id: String
@@ -57,7 +57,7 @@ public struct StartRequest: Equatable, JsonEncodable {
 }
 
 /// A websocket `stop` request from the client to the server
-public struct StopRequest: Equatable, JsonEncodable {
+public struct StopRequest: Equatable, Codable {
     public let type: RequestMessageType = .GQL_STOP
     public let id: String
 
@@ -81,7 +81,7 @@ public struct StopRequest: Equatable, JsonEncodable {
 }
 
 /// A websocket `connection_terminate` request from the client to the server
-public struct ConnectionTerminateRequest: Equatable, JsonEncodable {
+public struct ConnectionTerminateRequest: Equatable, Codable {
     public let type: RequestMessageType = .GQL_CONNECTION_TERMINATE
 
     public init() {}

Sources/GraphQLWS/Requests.swift

@@ -2,12 +2,12 @@ import Foundation
 import GraphQL
 
 /// A general response. This object's type is used to triage to other, more specific response objects.
-public struct Response: Equatable, JsonEncodable {
+public struct Response: Equatable, Codable {
     public let type: ResponseMessageType
 }
 
 /// A websocket `connection_ack` response from the server to the client
-public struct ConnectionAckResponse: Equatable, JsonEncodable {
+public struct ConnectionAckResponse: Equatable, Codable {
     public let type: ResponseMessageType = .GQL_CONNECTION_ACK
     public let payload: [String: Map]?
 
@@ -31,7 +31,7 @@ public struct ConnectionAckResponse: Equatable, JsonEncodable {
 }
 
 /// A websocket `connection_error` response from the server to the client
-public struct ConnectionErrorResponse: Equatable, JsonEncodable {
+public struct ConnectionErrorResponse: Equatable, Codable {
     public let type: ResponseMessageType = .GQL_CONNECTION_ERROR
     public let payload: [String: Map]?
 
@@ -55,7 +55,7 @@ public struct ConnectionErrorResponse: Equatable, JsonEncodable {
 }
 
 /// A websocket `ka` response from the server to the client
-public struct ConnectionKeepAliveResponse: Equatable, JsonEncodable {
+public struct ConnectionKeepAliveResponse: Equatable, Codable {
     public let type: ResponseMessageType = .GQL_CONNECTION_KEEP_ALIVE
     public let payload: [String: Map]?
 
@@ -81,7 +81,7 @@ public struct ConnectionKeepAliveResponse: Equatable, JsonEncodable {
 }
 
 /// A websocket `data` response from the server to the client
-public struct DataResponse: Equatable, JsonEncodable {
+public struct DataResponse: Equatable, Codable {
     public let type: ResponseMessageType = .GQL_DATA
     public let payload: GraphQLResult?
     public let id: String
@@ -107,7 +107,7 @@ public struct DataResponse: Equatable, JsonEncodable {
 }
 
 /// A websocket `complete` response from the server to the client
-public struct CompleteResponse: Equatable, JsonEncodable {
+public struct CompleteResponse: Equatable, Codable {
     public let type: ResponseMessageType = .GQL_COMPLETE
     public let id: String
 
@@ -130,7 +130,7 @@ public struct CompleteResponse: Equatable, JsonEncodable {
 }
 
 /// A websocket `error` response from the server to the client
-public struct ErrorResponse: Equatable, JsonEncodable {
+public struct ErrorResponse: Equatable, Codable {
     public let type: ResponseMessageType = .GQL_ERROR
     public let payload: [GraphQLError]
     public let id: String
@@ -203,7 +203,7 @@ public struct ResponseMessageType: Equatable, Codable, Sendable {
 
 /// A websocket `error` response from the server to the client that indicates an issue with encoding
 /// a response JSON
-struct EncodingErrorResponse: Equatable, Codable, JsonEncodable {
+struct EncodingErrorResponse: Equatable, Codable {
     let type: ResponseMessageType
     let payload: [String: String]
 

Sources/GraphQLWS/Responses.swift

@@ -226,51 +226,57 @@ where
     /// Send a `connection_ack` response through the messenger
     private func sendConnectionAck(_ payload: [String: Map]? = nil) async throws {
         try await messenger.send(
-            ConnectionAckResponse(payload: payload).toJSON(encoder)
+            encoder.encode(ConnectionAckResponse(payload: payload))
         )
     }
 
     /// Send a `connection_error` response through the messenger
     private func sendConnectionError(_ payload: [String: Map]? = nil) async throws {
         try await messenger.send(
-            ConnectionErrorResponse(payload: payload).toJSON(encoder)
+            encoder.encode(ConnectionErrorResponse(payload: payload))
         )
     }
 
     /// Send a `ka` response through the messenger
     private func sendConnectionKeepAlive(_ payload: [String: Map]? = nil) async throws {
         try await messenger.send(
-            ConnectionKeepAliveResponse(payload: payload).toJSON(encoder)
+            encoder.encode(ConnectionKeepAliveResponse(payload: payload))
         )
     }
 
     /// Send a `data` response through the messenger
     private func sendData(_ payload: GraphQLResult? = nil, id: String) async throws {
         try await messenger.send(
-            DataResponse(
-                payload: payload,
-                id: id
-            ).toJSON(encoder)
+            encoder.encode(
+                DataResponse(
+                    payload: payload,
+                    id: id
+                )
+            )
         )
     }
 
     /// Send a `complete` response through the messenger
     private func sendComplete(id: String) async throws {
         try await messenger.send(
-            CompleteResponse(
-                id: id
-            ).toJSON(encoder)
+            encoder.encode(
+                CompleteResponse(
+                    id: id
+                )
+            )
         )
         try await onOperationComplete(id)
     }
 
     /// Send an `error` response through the messenger
     private func sendError(_ errors: [Error], id: String) async throws {
         try await messenger.send(
-            ErrorResponse(
-                errors,
-                id: id
-            ).toJSON(encoder)
+            encoder.encode(
+                ErrorResponse(
+                    errors,
+                    id: id
+                )
+            )
         )
         try await onOperationError(id, errors)
     }