feat: Adds Data support to Messenger

Author: NeedleInAJayStack

Sources/GraphQLTransportWS/Client.swift

@@ -35,7 +35,7 @@ public actor Client<InitPayload: Equatable & Codable> {
         self.onError = onError
         self.onComplete = onComplete
     }
-    
+
     /// Listen and react to the provided async sequence of server messages. This function will block until the stream is completed.
     /// - Parameter incoming: The server message sequence that the client should react to.
     public func listen<A: AsyncSequence & Sendable>(to incoming: A) async throws
@@ -107,28 +107,34 @@ 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 `subscribe` request through the messenger
     public func sendStart(payload: GraphQLRequest, id: String) async throws {
         try await messenger.send(
-            SubscribeRequest(
-                payload: payload,
-                id: id
-            ).toJSON(encoder)
+            encoder.encode(
+                SubscribeRequest(
+                    payload: payload,
+                    id: id
+                )
+            )
         )
     }
 
     /// Send a `complete` request through the messenger
     public func sendStop(id: String) async throws {
         try await messenger.send(
-            CompleteRequest(
-                id: id
-            ).toJSON(encoder)
+            encoder.encode(
+                CompleteRequest(
+                    id: id
+                )
+            )
         )
     }
 

Sources/GraphQLTransportWS/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/GraphQLTransportWS/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 = .connectionInit
     public let payload: InitPayload
 
@@ -30,7 +30,7 @@ public struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable
 }
 
 /// A websocket `subscribe` request from the client to the server
-public struct SubscribeRequest: Equatable, JsonEncodable {
+public struct SubscribeRequest: Equatable, Codable {
     public let type = RequestMessageType.subscribe
     public let payload: GraphQLRequest
     public let id: String
@@ -56,7 +56,7 @@ public struct SubscribeRequest: Equatable, JsonEncodable {
 }
 
 /// A websocket `complete` request from the client to the server
-public struct CompleteRequest: Equatable, JsonEncodable {
+public struct CompleteRequest: Equatable, Codable {
     public let type = RequestMessageType.complete
     public let id: String
 

Sources/GraphQLTransportWS/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 = .connectionAck
     public let payload: [String: Map]?
 
@@ -30,7 +30,7 @@ public struct ConnectionAckResponse: Equatable, JsonEncodable {
 }
 
 /// A websocket `next` response from the server to the client
-public struct NextResponse: Equatable, JsonEncodable {
+public struct NextResponse: Equatable, Codable {
     public let type: ResponseMessageType = .next
     public let payload: GraphQLResult?
     public let id: String
@@ -56,7 +56,7 @@ public struct NextResponse: 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 = .complete
     public let id: String
 
@@ -79,7 +79,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 = .error
     public let payload: [GraphQLError]
     public let id: String
@@ -148,7 +148,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/GraphQLTransportWS/Responses.swift

@@ -51,11 +51,11 @@ where
         self.onOperationComplete = onOperationComplete
         self.onOperationError = onOperationError
     }
-    
+
     deinit {
         subscriptionTasks.values.forEach { $0.cancel() }
     }
-    
+
     /// Listen and react to the provided async sequence of client messages. This function will block until the stream is completed.
     /// - Parameter incoming: The client message sequence that the server should react to.
     public func listen<A: AsyncSequence & Sendable>(to incoming: A) async throws
@@ -206,37 +206,45 @@ 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 `next` response through the messenger
     private func sendNext(_ payload: GraphQLResult? = nil, id: String) async throws {
         try await messenger.send(
-            NextResponse(
-                payload: payload,
-                id: id
-            ).toJSON(encoder)
+            encoder.encode(
+                NextResponse(
+                    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)
     }