Uses Data inputs and outputs

README.md

@@ -20,7 +20,7 @@ To use this package, include it in your `Package.swift` dependencies:
 .package(url: "https://github.com/GraphQLSwift/GraphQLWS", from: "<version>"),
 ```
 
-Then create a class to implement the `Messenger` protocol. Here's an example using
+Then create a concrete type that conforms to the `Messenger` protocol. Here's an example using
 [`WebSocketKit`](https://github.com/vapor/websocket-kit):
 
 ```swift
@@ -31,12 +31,12 @@ import GraphQLWS
 struct WebSocketMessenger: Messenger {
  let websocket: WebSocket
 
- func send<S>(_ message: S) async throws where S: Collection, S.Element == Character async throws {
- try await websocket.send(message)
+ func send(_ message: Data) async throws {
+ try await websocket.send(String(decoding: message, as: UTF8.self))
  }
 
  func error(_ message: String, code: Int) async throws {
- try await websocket.send("\(code): \(message)")
+ try await websocket.close(code: code)
  }
 
  func close() async throws {
@@ -73,9 +73,9 @@ routes.webSocket(
  )
  }
  )
- let incoming = AsyncStream<String> { continuation in
+ let incoming = AsyncStream<Data> { continuation in
  websocket.onText { _, message in
- continuation.yield(message)
+ continuation.yield(Data(message.utf8))
  }
  }
  try await server.listen(to: incoming)

Sources/GraphQLWS/Client.swift

@@ -51,118 +51,133 @@ public actor Client<InitPayload: Equatable & Codable> {
  /// 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
- where A.Element == String {
+ where A.Element == Data {
  for try await message in incoming {
- // Detect and ignore error responses.
- if message.starts(with: "44") {
- // TODO: Determine what to do with returned error messages
+ try await respond(to: message)
+ }
+ }
+
+ /// 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.
+ @available(*, deprecated, message: "Use `Data` sequence instead.")
+ public func listen<A: AsyncSequence & Sendable>(to incoming: A) async throws
+ where A.Element == String {
+ for try await stringMessage in incoming {
+ guard let message = stringMessage.data(using: .utf8) else {
+ try await self.error(.invalidEncoding())
  return
  }
+ try await respond(to: message)
+ }
+ }
 
- guard let json = message.data(using: .utf8) else {
- try await error(.invalidEncoding())
+ private func respond(to message: Data) async throws {
+ let response: Response
+ do {
+ response = try decoder.decode(Response.self, from: message)
+ } catch {
+ try await self.error(.noType())
+ return
+ }
+
+ switch response.type {
+ case .GQL_CONNECTION_ERROR:
+ guard
+ let connectionErrorResponse = try? decoder.decode(
+ ConnectionErrorResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- let response: Response
- do {
- response = try decoder.decode(Response.self, from: json)
- } catch {
- try await self.error(.noType())
+ try await onConnectionError(connectionErrorResponse, self)
+ case .GQL_CONNECTION_ACK:
+ guard
+ let connectionAckResponse = try? decoder.decode(
+ ConnectionAckResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- switch response.type {
- case .GQL_CONNECTION_ERROR:
- guard
- let connectionErrorResponse = try? decoder.decode(
- ConnectionErrorResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionError(connectionErrorResponse, self)
- case .GQL_CONNECTION_ACK:
- guard
- let connectionAckResponse = try? decoder.decode(
- ConnectionAckResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionAck(connectionAckResponse, self)
- case .GQL_CONNECTION_KEEP_ALIVE:
- guard
- let connectionKeepAliveResponse = try? decoder.decode(
- ConnectionKeepAliveResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
- return
- }
- try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
- case .GQL_DATA:
- guard let nextResponse = try? decoder.decode(DataResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_DATA))
- return
- }
- try await onData(nextResponse, self)
- case .GQL_ERROR:
- guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
- return
- }
- try await onError(errorResponse, self)
- case .GQL_COMPLETE:
- guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: json)
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
- return
- }
- try await onComplete(completeResponse, self)
- default:
- try await error(.invalidType())
+ try await onConnectionAck(connectionAckResponse, self)
+ case .GQL_CONNECTION_KEEP_ALIVE:
+ guard
+ let connectionKeepAliveResponse = try? decoder.decode(
+ ConnectionKeepAliveResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
+ return
+ }
+ try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
+ case .GQL_DATA:
+ guard let nextResponse = try? decoder.decode(DataResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_DATA))
+ return
+ }
+ try await onData(nextResponse, self)
+ case .GQL_ERROR:
+ guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
+ return
+ }
+ try await onError(errorResponse, self)
+ case .GQL_COMPLETE:
+ guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: message)
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
+ return
  }
+ try await onComplete(completeResponse, self)
+ default:
+ try await error(.invalidType())
  }
  }
 
  /// 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/GraphQLWSError.swift

@@ -88,7 +88,7 @@ struct GraphQLWSError: Error {
 }
 
 /// Error codes for miscellaneous issues
-public enum ErrorCode: Int, CustomStringConvertible, Sendable {
+enum ErrorCode: Int, CustomStringConvertible, Sendable {
  /// Miscellaneous
  case miscellaneous = 4400
 

Sources/GraphQLWS/Messenger.swift

@@ -4,7 +4,7 @@ import Foundation
 public protocol Messenger: Sendable {
  /// Send a message through this messenger
  /// - Parameter message: The message to send
- func send<S: Sendable & Collection>(_ message: S) async throws where S.Element == Character
+ func send(_ message: Data) async throws
 
  /// Close the messenger
  func close() async throws

Sources/GraphQLWS/Requests.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() {}

README.md

@@ -20,7 +20,7 @@ To use this package, include it in your `Package.swift` dependencies:
 .package(url: "https://github.com/GraphQLSwift/GraphQLWS", from: "<version>"),
 ```
 
-Then create a class to implement the `Messenger` protocol. Here's an example using
+Then create a concrete type that conforms to the `Messenger` protocol. Here's an example using
 [`WebSocketKit`](https://github.com/vapor/websocket-kit):
 
 ```swift
@@ -31,12 +31,12 @@ import GraphQLWS
 struct WebSocketMessenger: Messenger {
  let websocket: WebSocket
 
- func send<S>(_ message: S) async throws where S: Collection, S.Element == Character async throws {
- try await websocket.send(message)
+ func send(_ message: Data) async throws {
+ try await websocket.send(String(decoding: message, as: UTF8.self))
  }
 
  func error(_ message: String, code: Int) async throws {
- try await websocket.send("\(code): \(message)")
+ try await websocket.close(code: code)
  }
 
  func close() async throws {
@@ -73,9 +73,9 @@ routes.webSocket(
  )
  }
  )
- let incoming = AsyncStream<String> { continuation in
+ let incoming = AsyncStream<Data> { continuation in
  websocket.onText { _, message in
- continuation.yield(message)
+ continuation.yield(Data(message.utf8))
  }
  }
  try await server.listen(to: incoming)

Sources/GraphQLWS/Client.swift

@@ -51,118 +51,133 @@ public actor Client<InitPayload: Equatable & Codable> {
  /// 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
- where A.Element == String {
+ where A.Element == Data {
  for try await message in incoming {
- // Detect and ignore error responses.
- if message.starts(with: "44") {
- // TODO: Determine what to do with returned error messages
+ try await respond(to: message)
+ }
+ }
+
+ /// 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.
+ @available(*, deprecated, message: "Use `Data` sequence instead.")
+ public func listen<A: AsyncSequence & Sendable>(to incoming: A) async throws
+ where A.Element == String {
+ for try await stringMessage in incoming {
+ guard let message = stringMessage.data(using: .utf8) else {
+ try await self.error(.invalidEncoding())
  return
  }
+ try await respond(to: message)
+ }
+ }
 
- guard let json = message.data(using: .utf8) else {
- try await error(.invalidEncoding())
+ private func respond(to message: Data) async throws {
+ let response: Response
+ do {
+ response = try decoder.decode(Response.self, from: message)
+ } catch {
+ try await self.error(.noType())
+ return
+ }
+
+ switch response.type {
+ case .GQL_CONNECTION_ERROR:
+ guard
+ let connectionErrorResponse = try? decoder.decode(
+ ConnectionErrorResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- let response: Response
- do {
- response = try decoder.decode(Response.self, from: json)
- } catch {
- try await self.error(.noType())
+ try await onConnectionError(connectionErrorResponse, self)
+ case .GQL_CONNECTION_ACK:
+ guard
+ let connectionAckResponse = try? decoder.decode(
+ ConnectionAckResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- switch response.type {
- case .GQL_CONNECTION_ERROR:
- guard
- let connectionErrorResponse = try? decoder.decode(
- ConnectionErrorResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionError(connectionErrorResponse, self)
- case .GQL_CONNECTION_ACK:
- guard
- let connectionAckResponse = try? decoder.decode(
- ConnectionAckResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionAck(connectionAckResponse, self)
- case .GQL_CONNECTION_KEEP_ALIVE:
- guard
- let connectionKeepAliveResponse = try? decoder.decode(
- ConnectionKeepAliveResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
- return
- }
- try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
- case .GQL_DATA:
- guard let nextResponse = try? decoder.decode(DataResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_DATA))
- return
- }
- try await onData(nextResponse, self)
- case .GQL_ERROR:
- guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
- return
- }
- try await onError(errorResponse, self)
- case .GQL_COMPLETE:
- guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: json)
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
- return
- }
- try await onComplete(completeResponse, self)
- default:
- try await error(.invalidType())
+ try await onConnectionAck(connectionAckResponse, self)
+ case .GQL_CONNECTION_KEEP_ALIVE:
+ guard
+ let connectionKeepAliveResponse = try? decoder.decode(
+ ConnectionKeepAliveResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
+ return
+ }
+ try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
+ case .GQL_DATA:
+ guard let nextResponse = try? decoder.decode(DataResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_DATA))
+ return
+ }
+ try await onData(nextResponse, self)
+ case .GQL_ERROR:
+ guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
+ return
+ }
+ try await onError(errorResponse, self)
+ case .GQL_COMPLETE:
+ guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: message)
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
+ return
  }
+ try await onComplete(completeResponse, self)
+ default:
+ try await error(.invalidType())
  }
  }
 
  /// 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/GraphQLWSError.swift

@@ -88,7 +88,7 @@ struct GraphQLWSError: Error {
 }
 
 /// Error codes for miscellaneous issues
-public enum ErrorCode: Int, CustomStringConvertible, Sendable {
+enum ErrorCode: Int, CustomStringConvertible, Sendable {
  /// Miscellaneous
  case miscellaneous = 4400
 

Sources/GraphQLWS/Messenger.swift

@@ -4,7 +4,7 @@ import Foundation
 public protocol Messenger: Sendable {
  /// Send a message through this messenger
  /// - Parameter message: The message to send
- func send<S: Sendable & Collection>(_ message: S) async throws where S.Element == Character
+ func send(_ message: Data) async throws
 
  /// Close the messenger
  func close() async throws

Sources/GraphQLWS/Requests.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() {}

README.md

@@ -20,7 +20,7 @@ To use this package, include it in your `Package.swift` dependencies:
 .package(url: "https://github.com/GraphQLSwift/GraphQLWS", from: "<version>"),
 ```
 
-Then create a class to implement the `Messenger` protocol. Here's an example using
+Then create a concrete type that conforms to the `Messenger` protocol. Here's an example using
 [`WebSocketKit`](https://github.com/vapor/websocket-kit):
 
 ```swift
@@ -31,12 +31,12 @@ import GraphQLWS
 struct WebSocketMessenger: Messenger {
  let websocket: WebSocket
 
- func send<S>(_ message: S) async throws where S: Collection, S.Element == Character async throws {
- try await websocket.send(message)
+ func send(_ message: Data) async throws {
+ try await websocket.send(String(decoding: message, as: UTF8.self))
  }
 
  func error(_ message: String, code: Int) async throws {
- try await websocket.send("\(code): \(message)")
+ try await websocket.close(code: code)
  }
 
  func close() async throws {
@@ -73,9 +73,9 @@ routes.webSocket(
  )
  }
  )
- let incoming = AsyncStream<String> { continuation in
+ let incoming = AsyncStream<Data> { continuation in
  websocket.onText { _, message in
- continuation.yield(message)
+ continuation.yield(Data(message.utf8))
  }
  }
  try await server.listen(to: incoming)

Sources/GraphQLWS/Client.swift

@@ -51,118 +51,133 @@ public actor Client<InitPayload: Equatable & Codable> {
  /// 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
- where A.Element == String {
+ where A.Element == Data {
  for try await message in incoming {
- // Detect and ignore error responses.
- if message.starts(with: "44") {
- // TODO: Determine what to do with returned error messages
+ try await respond(to: message)
+ }
+ }
+
+ /// 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.
+ @available(*, deprecated, message: "Use `Data` sequence instead.")
+ public func listen<A: AsyncSequence & Sendable>(to incoming: A) async throws
+ where A.Element == String {
+ for try await stringMessage in incoming {
+ guard let message = stringMessage.data(using: .utf8) else {
+ try await self.error(.invalidEncoding())
  return
  }
+ try await respond(to: message)
+ }
+ }
 
- guard let json = message.data(using: .utf8) else {
- try await error(.invalidEncoding())
+ private func respond(to message: Data) async throws {
+ let response: Response
+ do {
+ response = try decoder.decode(Response.self, from: message)
+ } catch {
+ try await self.error(.noType())
+ return
+ }
+
+ switch response.type {
+ case .GQL_CONNECTION_ERROR:
+ guard
+ let connectionErrorResponse = try? decoder.decode(
+ ConnectionErrorResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- let response: Response
- do {
- response = try decoder.decode(Response.self, from: json)
- } catch {
- try await self.error(.noType())
+ try await onConnectionError(connectionErrorResponse, self)
+ case .GQL_CONNECTION_ACK:
+ guard
+ let connectionAckResponse = try? decoder.decode(
+ ConnectionAckResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- switch response.type {
- case .GQL_CONNECTION_ERROR:
- guard
- let connectionErrorResponse = try? decoder.decode(
- ConnectionErrorResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionError(connectionErrorResponse, self)
- case .GQL_CONNECTION_ACK:
- guard
- let connectionAckResponse = try? decoder.decode(
- ConnectionAckResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionAck(connectionAckResponse, self)
- case .GQL_CONNECTION_KEEP_ALIVE:
- guard
- let connectionKeepAliveResponse = try? decoder.decode(
- ConnectionKeepAliveResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
- return
- }
- try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
- case .GQL_DATA:
- guard let nextResponse = try? decoder.decode(DataResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_DATA))
- return
- }
- try await onData(nextResponse, self)
- case .GQL_ERROR:
- guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
- return
- }
- try await onError(errorResponse, self)
- case .GQL_COMPLETE:
- guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: json)
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
- return
- }
- try await onComplete(completeResponse, self)
- default:
- try await error(.invalidType())
+ try await onConnectionAck(connectionAckResponse, self)
+ case .GQL_CONNECTION_KEEP_ALIVE:
+ guard
+ let connectionKeepAliveResponse = try? decoder.decode(
+ ConnectionKeepAliveResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
+ return
+ }
+ try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
+ case .GQL_DATA:
+ guard let nextResponse = try? decoder.decode(DataResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_DATA))
+ return
+ }
+ try await onData(nextResponse, self)
+ case .GQL_ERROR:
+ guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
+ return
+ }
+ try await onError(errorResponse, self)
+ case .GQL_COMPLETE:
+ guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: message)
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
+ return
  }
+ try await onComplete(completeResponse, self)
+ default:
+ try await error(.invalidType())
  }
  }
 
  /// 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/GraphQLWSError.swift

@@ -88,7 +88,7 @@ struct GraphQLWSError: Error {
 }
 
 /// Error codes for miscellaneous issues
-public enum ErrorCode: Int, CustomStringConvertible, Sendable {
+enum ErrorCode: Int, CustomStringConvertible, Sendable {
  /// Miscellaneous
  case miscellaneous = 4400
 

Sources/GraphQLWS/Messenger.swift

@@ -4,7 +4,7 @@ import Foundation
 public protocol Messenger: Sendable {
  /// Send a message through this messenger
  /// - Parameter message: The message to send
- func send<S: Sendable & Collection>(_ message: S) async throws where S.Element == Character
+ func send(_ message: Data) async throws
 
  /// Close the messenger
  func close() async throws

Sources/GraphQLWS/Requests.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() {}

README.md

@@ -20,7 +20,7 @@ To use this package, include it in your `Package.swift` dependencies:
 .package(url: "https://github.com/GraphQLSwift/GraphQLWS", from: "<version>"),
 ```
 
-Then create a class to implement the `Messenger` protocol. Here's an example using
+Then create a concrete type that conforms to the `Messenger` protocol. Here's an example using
 [`WebSocketKit`](https://github.com/vapor/websocket-kit):
 
 ```swift
@@ -31,12 +31,12 @@ import GraphQLWS
 struct WebSocketMessenger: Messenger {
  let websocket: WebSocket
 
- func send<S>(_ message: S) async throws where S: Collection, S.Element == Character async throws {
- try await websocket.send(message)
+ func send(_ message: Data) async throws {
+ try await websocket.send(String(decoding: message, as: UTF8.self))
  }
 
  func error(_ message: String, code: Int) async throws {
- try await websocket.send("\(code): \(message)")
+ try await websocket.close(code: code)
  }
 
  func close() async throws {
@@ -73,9 +73,9 @@ routes.webSocket(
  )
  }
  )
- let incoming = AsyncStream<String> { continuation in
+ let incoming = AsyncStream<Data> { continuation in
  websocket.onText { _, message in
- continuation.yield(message)
+ continuation.yield(Data(message.utf8))
  }
  }
  try await server.listen(to: incoming)

Sources/GraphQLWS/Client.swift

@@ -51,118 +51,133 @@ public actor Client<InitPayload: Equatable & Codable> {
  /// 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
- where A.Element == String {
+ where A.Element == Data {
  for try await message in incoming {
- // Detect and ignore error responses.
- if message.starts(with: "44") {
- // TODO: Determine what to do with returned error messages
+ try await respond(to: message)
+ }
+ }
+
+ /// 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.
+ @available(*, deprecated, message: "Use `Data` sequence instead.")
+ public func listen<A: AsyncSequence & Sendable>(to incoming: A) async throws
+ where A.Element == String {
+ for try await stringMessage in incoming {
+ guard let message = stringMessage.data(using: .utf8) else {
+ try await self.error(.invalidEncoding())
  return
  }
+ try await respond(to: message)
+ }
+ }
 
- guard let json = message.data(using: .utf8) else {
- try await error(.invalidEncoding())
+ private func respond(to message: Data) async throws {
+ let response: Response
+ do {
+ response = try decoder.decode(Response.self, from: message)
+ } catch {
+ try await self.error(.noType())
+ return
+ }
+
+ switch response.type {
+ case .GQL_CONNECTION_ERROR:
+ guard
+ let connectionErrorResponse = try? decoder.decode(
+ ConnectionErrorResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- let response: Response
- do {
- response = try decoder.decode(Response.self, from: json)
- } catch {
- try await self.error(.noType())
+ try await onConnectionError(connectionErrorResponse, self)
+ case .GQL_CONNECTION_ACK:
+ guard
+ let connectionAckResponse = try? decoder.decode(
+ ConnectionAckResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- switch response.type {
- case .GQL_CONNECTION_ERROR:
- guard
- let connectionErrorResponse = try? decoder.decode(
- ConnectionErrorResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionError(connectionErrorResponse, self)
- case .GQL_CONNECTION_ACK:
- guard
- let connectionAckResponse = try? decoder.decode(
- ConnectionAckResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionAck(connectionAckResponse, self)
- case .GQL_CONNECTION_KEEP_ALIVE:
- guard
- let connectionKeepAliveResponse = try? decoder.decode(
- ConnectionKeepAliveResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
- return
- }
- try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
- case .GQL_DATA:
- guard let nextResponse = try? decoder.decode(DataResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_DATA))
- return
- }
- try await onData(nextResponse, self)
- case .GQL_ERROR:
- guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
- return
- }
- try await onError(errorResponse, self)
- case .GQL_COMPLETE:
- guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: json)
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
- return
- }
- try await onComplete(completeResponse, self)
- default:
- try await error(.invalidType())
+ try await onConnectionAck(connectionAckResponse, self)
+ case .GQL_CONNECTION_KEEP_ALIVE:
+ guard
+ let connectionKeepAliveResponse = try? decoder.decode(
+ ConnectionKeepAliveResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
+ return
+ }
+ try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
+ case .GQL_DATA:
+ guard let nextResponse = try? decoder.decode(DataResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_DATA))
+ return
+ }
+ try await onData(nextResponse, self)
+ case .GQL_ERROR:
+ guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
+ return
+ }
+ try await onError(errorResponse, self)
+ case .GQL_COMPLETE:
+ guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: message)
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
+ return
  }
+ try await onComplete(completeResponse, self)
+ default:
+ try await error(.invalidType())
  }
  }
 
  /// 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/GraphQLWSError.swift

@@ -88,7 +88,7 @@ struct GraphQLWSError: Error {
 }
 
 /// Error codes for miscellaneous issues
-public enum ErrorCode: Int, CustomStringConvertible, Sendable {
+enum ErrorCode: Int, CustomStringConvertible, Sendable {
  /// Miscellaneous
  case miscellaneous = 4400
 

Sources/GraphQLWS/Messenger.swift

@@ -4,7 +4,7 @@ import Foundation
 public protocol Messenger: Sendable {
  /// Send a message through this messenger
  /// - Parameter message: The message to send
- func send<S: Sendable & Collection>(_ message: S) async throws where S.Element == Character
+ func send(_ message: Data) async throws
 
  /// Close the messenger
  func close() async throws

Sources/GraphQLWS/Requests.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() {}

README.md

@@ -20,7 +20,7 @@ To use this package, include it in your `Package.swift` dependencies:
 .package(url: "https://github.com/GraphQLSwift/GraphQLWS", from: "<version>"),
 ```
 
-Then create a class to implement the `Messenger` protocol. Here's an example using
+Then create a concrete type that conforms to the `Messenger` protocol. Here's an example using
 [`WebSocketKit`](https://github.com/vapor/websocket-kit):
 
 ```swift
@@ -31,12 +31,12 @@ import GraphQLWS
 struct WebSocketMessenger: Messenger {
  let websocket: WebSocket
 
- func send<S>(_ message: S) async throws where S: Collection, S.Element == Character async throws {
- try await websocket.send(message)
+ func send(_ message: Data) async throws {
+ try await websocket.send(String(decoding: message, as: UTF8.self))
  }
 
  func error(_ message: String, code: Int) async throws {
- try await websocket.send("\(code): \(message)")
+ try await websocket.close(code: code)
  }
 
  func close() async throws {
@@ -73,9 +73,9 @@ routes.webSocket(
  )
  }
  )
- let incoming = AsyncStream<String> { continuation in
+ let incoming = AsyncStream<Data> { continuation in
  websocket.onText { _, message in
- continuation.yield(message)
+ continuation.yield(Data(message.utf8))
  }
  }
  try await server.listen(to: incoming)

Sources/GraphQLWS/Client.swift

@@ -51,118 +51,133 @@ public actor Client<InitPayload: Equatable & Codable> {
  /// 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
- where A.Element == String {
+ where A.Element == Data {
  for try await message in incoming {
- // Detect and ignore error responses.
- if message.starts(with: "44") {
- // TODO: Determine what to do with returned error messages
+ try await respond(to: message)
+ }
+ }
+
+ /// 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.
+ @available(*, deprecated, message: "Use `Data` sequence instead.")
+ public func listen<A: AsyncSequence & Sendable>(to incoming: A) async throws
+ where A.Element == String {
+ for try await stringMessage in incoming {
+ guard let message = stringMessage.data(using: .utf8) else {
+ try await self.error(.invalidEncoding())
  return
  }
+ try await respond(to: message)
+ }
+ }
 
- guard let json = message.data(using: .utf8) else {
- try await error(.invalidEncoding())
+ private func respond(to message: Data) async throws {
+ let response: Response
+ do {
+ response = try decoder.decode(Response.self, from: message)
+ } catch {
+ try await self.error(.noType())
+ return
+ }
+
+ switch response.type {
+ case .GQL_CONNECTION_ERROR:
+ guard
+ let connectionErrorResponse = try? decoder.decode(
+ ConnectionErrorResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- let response: Response
- do {
- response = try decoder.decode(Response.self, from: json)
- } catch {
- try await self.error(.noType())
+ try await onConnectionError(connectionErrorResponse, self)
+ case .GQL_CONNECTION_ACK:
+ guard
+ let connectionAckResponse = try? decoder.decode(
+ ConnectionAckResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- switch response.type {
- case .GQL_CONNECTION_ERROR:
- guard
- let connectionErrorResponse = try? decoder.decode(
- ConnectionErrorResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionError(connectionErrorResponse, self)
- case .GQL_CONNECTION_ACK:
- guard
- let connectionAckResponse = try? decoder.decode(
- ConnectionAckResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionAck(connectionAckResponse, self)
- case .GQL_CONNECTION_KEEP_ALIVE:
- guard
- let connectionKeepAliveResponse = try? decoder.decode(
- ConnectionKeepAliveResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
- return
- }
- try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
- case .GQL_DATA:
- guard let nextResponse = try? decoder.decode(DataResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_DATA))
- return
- }
- try await onData(nextResponse, self)
- case .GQL_ERROR:
- guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
- return
- }
- try await onError(errorResponse, self)
- case .GQL_COMPLETE:
- guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: json)
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
- return
- }
- try await onComplete(completeResponse, self)
- default:
- try await error(.invalidType())
+ try await onConnectionAck(connectionAckResponse, self)
+ case .GQL_CONNECTION_KEEP_ALIVE:
+ guard
+ let connectionKeepAliveResponse = try? decoder.decode(
+ ConnectionKeepAliveResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
+ return
+ }
+ try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
+ case .GQL_DATA:
+ guard let nextResponse = try? decoder.decode(DataResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_DATA))
+ return
+ }
+ try await onData(nextResponse, self)
+ case .GQL_ERROR:
+ guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
+ return
+ }
+ try await onError(errorResponse, self)
+ case .GQL_COMPLETE:
+ guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: message)
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
+ return
  }
+ try await onComplete(completeResponse, self)
+ default:
+ try await error(.invalidType())
  }
  }
 
  /// 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/GraphQLWSError.swift

@@ -88,7 +88,7 @@ struct GraphQLWSError: Error {
 }
 
 /// Error codes for miscellaneous issues
-public enum ErrorCode: Int, CustomStringConvertible, Sendable {
+enum ErrorCode: Int, CustomStringConvertible, Sendable {
  /// Miscellaneous
  case miscellaneous = 4400
 

Sources/GraphQLWS/Messenger.swift

@@ -4,7 +4,7 @@ import Foundation
 public protocol Messenger: Sendable {
  /// Send a message through this messenger
  /// - Parameter message: The message to send
- func send<S: Sendable & Collection>(_ message: S) async throws where S.Element == Character
+ func send(_ message: Data) async throws
 
  /// Close the messenger
  func close() async throws

Sources/GraphQLWS/Requests.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() {}

README.md

@@ -20,7 +20,7 @@ To use this package, include it in your `Package.swift` dependencies:
 .package(url: "https://github.com/GraphQLSwift/GraphQLWS", from: "<version>"),
 ```
 
-Then create a class to implement the `Messenger` protocol. Here's an example using
+Then create a concrete type that conforms to the `Messenger` protocol. Here's an example using
 [`WebSocketKit`](https://github.com/vapor/websocket-kit):
 
 ```swift
@@ -31,12 +31,12 @@ import GraphQLWS
 struct WebSocketMessenger: Messenger {
  let websocket: WebSocket
 
- func send<S>(_ message: S) async throws where S: Collection, S.Element == Character async throws {
- try await websocket.send(message)
+ func send(_ message: Data) async throws {
+ try await websocket.send(String(decoding: message, as: UTF8.self))
  }
 
  func error(_ message: String, code: Int) async throws {
- try await websocket.send("\(code): \(message)")
+ try await websocket.close(code: code)
  }
 
  func close() async throws {
@@ -73,9 +73,9 @@ routes.webSocket(
  )
  }
  )
- let incoming = AsyncStream<String> { continuation in
+ let incoming = AsyncStream<Data> { continuation in
  websocket.onText { _, message in
- continuation.yield(message)
+ continuation.yield(Data(message.utf8))
  }
  }
  try await server.listen(to: incoming)

Sources/GraphQLWS/Client.swift

@@ -51,118 +51,133 @@ public actor Client<InitPayload: Equatable & Codable> {
  /// 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
- where A.Element == String {
+ where A.Element == Data {
  for try await message in incoming {
- // Detect and ignore error responses.
- if message.starts(with: "44") {
- // TODO: Determine what to do with returned error messages
+ try await respond(to: message)
+ }
+ }
+
+ /// 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.
+ @available(*, deprecated, message: "Use `Data` sequence instead.")
+ public func listen<A: AsyncSequence & Sendable>(to incoming: A) async throws
+ where A.Element == String {
+ for try await stringMessage in incoming {
+ guard let message = stringMessage.data(using: .utf8) else {
+ try await self.error(.invalidEncoding())
  return
  }
+ try await respond(to: message)
+ }
+ }
 
- guard let json = message.data(using: .utf8) else {
- try await error(.invalidEncoding())
+ private func respond(to message: Data) async throws {
+ let response: Response
+ do {
+ response = try decoder.decode(Response.self, from: message)
+ } catch {
+ try await self.error(.noType())
+ return
+ }
+
+ switch response.type {
+ case .GQL_CONNECTION_ERROR:
+ guard
+ let connectionErrorResponse = try? decoder.decode(
+ ConnectionErrorResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- let response: Response
- do {
- response = try decoder.decode(Response.self, from: json)
- } catch {
- try await self.error(.noType())
+ try await onConnectionError(connectionErrorResponse, self)
+ case .GQL_CONNECTION_ACK:
+ guard
+ let connectionAckResponse = try? decoder.decode(
+ ConnectionAckResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- switch response.type {
- case .GQL_CONNECTION_ERROR:
- guard
- let connectionErrorResponse = try? decoder.decode(
- ConnectionErrorResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionError(connectionErrorResponse, self)
- case .GQL_CONNECTION_ACK:
- guard
- let connectionAckResponse = try? decoder.decode(
- ConnectionAckResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionAck(connectionAckResponse, self)
- case .GQL_CONNECTION_KEEP_ALIVE:
- guard
- let connectionKeepAliveResponse = try? decoder.decode(
- ConnectionKeepAliveResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
- return
- }
- try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
- case .GQL_DATA:
- guard let nextResponse = try? decoder.decode(DataResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_DATA))
- return
- }
- try await onData(nextResponse, self)
- case .GQL_ERROR:
- guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
- return
- }
- try await onError(errorResponse, self)
- case .GQL_COMPLETE:
- guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: json)
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
- return
- }
- try await onComplete(completeResponse, self)
- default:
- try await error(.invalidType())
+ try await onConnectionAck(connectionAckResponse, self)
+ case .GQL_CONNECTION_KEEP_ALIVE:
+ guard
+ let connectionKeepAliveResponse = try? decoder.decode(
+ ConnectionKeepAliveResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
+ return
+ }
+ try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
+ case .GQL_DATA:
+ guard let nextResponse = try? decoder.decode(DataResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_DATA))
+ return
+ }
+ try await onData(nextResponse, self)
+ case .GQL_ERROR:
+ guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
+ return
+ }
+ try await onError(errorResponse, self)
+ case .GQL_COMPLETE:
+ guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: message)
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
+ return
  }
+ try await onComplete(completeResponse, self)
+ default:
+ try await error(.invalidType())
  }
  }
 
  /// 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/GraphQLWSError.swift

@@ -88,7 +88,7 @@ struct GraphQLWSError: Error {
 }
 
 /// Error codes for miscellaneous issues
-public enum ErrorCode: Int, CustomStringConvertible, Sendable {
+enum ErrorCode: Int, CustomStringConvertible, Sendable {
  /// Miscellaneous
  case miscellaneous = 4400
 

Sources/GraphQLWS/Messenger.swift

@@ -4,7 +4,7 @@ import Foundation
 public protocol Messenger: Sendable {
  /// Send a message through this messenger
  /// - Parameter message: The message to send
- func send<S: Sendable & Collection>(_ message: S) async throws where S.Element == Character
+ func send(_ message: Data) async throws
 
  /// Close the messenger
  func close() async throws

Sources/GraphQLWS/Requests.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() {}

README.md

@@ -20,7 +20,7 @@ To use this package, include it in your `Package.swift` dependencies:
 .package(url: "https://github.com/GraphQLSwift/GraphQLWS", from: "<version>"),
 ```
 
-Then create a class to implement the `Messenger` protocol. Here's an example using
+Then create a concrete type that conforms to the `Messenger` protocol. Here's an example using
 [`WebSocketKit`](https://github.com/vapor/websocket-kit):
 
 ```swift
@@ -31,12 +31,12 @@ import GraphQLWS
 struct WebSocketMessenger: Messenger {
  let websocket: WebSocket
 
- func send<S>(_ message: S) async throws where S: Collection, S.Element == Character async throws {
- try await websocket.send(message)
+ func send(_ message: Data) async throws {
+ try await websocket.send(String(decoding: message, as: UTF8.self))
  }
 
  func error(_ message: String, code: Int) async throws {
- try await websocket.send("\(code): \(message)")
+ try await websocket.close(code: code)
  }
 
  func close() async throws {
@@ -73,9 +73,9 @@ routes.webSocket(
  )
  }
  )
- let incoming = AsyncStream<String> { continuation in
+ let incoming = AsyncStream<Data> { continuation in
  websocket.onText { _, message in
- continuation.yield(message)
+ continuation.yield(Data(message.utf8))
  }
  }
  try await server.listen(to: incoming)

Sources/GraphQLWS/Client.swift

@@ -51,118 +51,133 @@ public actor Client<InitPayload: Equatable & Codable> {
  /// 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
- where A.Element == String {
+ where A.Element == Data {
  for try await message in incoming {
- // Detect and ignore error responses.
- if message.starts(with: "44") {
- // TODO: Determine what to do with returned error messages
+ try await respond(to: message)
+ }
+ }
+
+ /// 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.
+ @available(*, deprecated, message: "Use `Data` sequence instead.")
+ public func listen<A: AsyncSequence & Sendable>(to incoming: A) async throws
+ where A.Element == String {
+ for try await stringMessage in incoming {
+ guard let message = stringMessage.data(using: .utf8) else {
+ try await self.error(.invalidEncoding())
  return
  }
+ try await respond(to: message)
+ }
+ }
 
- guard let json = message.data(using: .utf8) else {
- try await error(.invalidEncoding())
+ private func respond(to message: Data) async throws {
+ let response: Response
+ do {
+ response = try decoder.decode(Response.self, from: message)
+ } catch {
+ try await self.error(.noType())
+ return
+ }
+
+ switch response.type {
+ case .GQL_CONNECTION_ERROR:
+ guard
+ let connectionErrorResponse = try? decoder.decode(
+ ConnectionErrorResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- let response: Response
- do {
- response = try decoder.decode(Response.self, from: json)
- } catch {
- try await self.error(.noType())
+ try await onConnectionError(connectionErrorResponse, self)
+ case .GQL_CONNECTION_ACK:
+ guard
+ let connectionAckResponse = try? decoder.decode(
+ ConnectionAckResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- switch response.type {
- case .GQL_CONNECTION_ERROR:
- guard
- let connectionErrorResponse = try? decoder.decode(
- ConnectionErrorResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionError(connectionErrorResponse, self)
- case .GQL_CONNECTION_ACK:
- guard
- let connectionAckResponse = try? decoder.decode(
- ConnectionAckResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionAck(connectionAckResponse, self)
- case .GQL_CONNECTION_KEEP_ALIVE:
- guard
- let connectionKeepAliveResponse = try? decoder.decode(
- ConnectionKeepAliveResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
- return
- }
- try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
- case .GQL_DATA:
- guard let nextResponse = try? decoder.decode(DataResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_DATA))
- return
- }
- try await onData(nextResponse, self)
- case .GQL_ERROR:
- guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
- return
- }
- try await onError(errorResponse, self)
- case .GQL_COMPLETE:
- guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: json)
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
- return
- }
- try await onComplete(completeResponse, self)
- default:
- try await error(.invalidType())
+ try await onConnectionAck(connectionAckResponse, self)
+ case .GQL_CONNECTION_KEEP_ALIVE:
+ guard
+ let connectionKeepAliveResponse = try? decoder.decode(
+ ConnectionKeepAliveResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
+ return
+ }
+ try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
+ case .GQL_DATA:
+ guard let nextResponse = try? decoder.decode(DataResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_DATA))
+ return
+ }
+ try await onData(nextResponse, self)
+ case .GQL_ERROR:
+ guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
+ return
+ }
+ try await onError(errorResponse, self)
+ case .GQL_COMPLETE:
+ guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: message)
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
+ return
  }
+ try await onComplete(completeResponse, self)
+ default:
+ try await error(.invalidType())
  }
  }
 
  /// 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/GraphQLWSError.swift

@@ -88,7 +88,7 @@ struct GraphQLWSError: Error {
 }
 
 /// Error codes for miscellaneous issues
-public enum ErrorCode: Int, CustomStringConvertible, Sendable {
+enum ErrorCode: Int, CustomStringConvertible, Sendable {
  /// Miscellaneous
  case miscellaneous = 4400
 

Sources/GraphQLWS/Messenger.swift

@@ -4,7 +4,7 @@ import Foundation
 public protocol Messenger: Sendable {
  /// Send a message through this messenger
  /// - Parameter message: The message to send
- func send<S: Sendable & Collection>(_ message: S) async throws where S.Element == Character
+ func send(_ message: Data) async throws
 
  /// Close the messenger
  func close() async throws

Sources/GraphQLWS/Requests.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() {}

README.md

@@ -20,7 +20,7 @@ To use this package, include it in your `Package.swift` dependencies:
 .package(url: "https://github.com/GraphQLSwift/GraphQLWS", from: "<version>"),
 ```
 
-Then create a class to implement the `Messenger` protocol. Here's an example using
+Then create a concrete type that conforms to the `Messenger` protocol. Here's an example using
 [`WebSocketKit`](https://github.com/vapor/websocket-kit):
 
 ```swift
@@ -31,12 +31,12 @@ import GraphQLWS
 struct WebSocketMessenger: Messenger {
  let websocket: WebSocket
 
- func send<S>(_ message: S) async throws where S: Collection, S.Element == Character async throws {
- try await websocket.send(message)
+ func send(_ message: Data) async throws {
+ try await websocket.send(String(decoding: message, as: UTF8.self))
  }
 
  func error(_ message: String, code: Int) async throws {
- try await websocket.send("\(code): \(message)")
+ try await websocket.close(code: code)
  }
 
  func close() async throws {
@@ -73,9 +73,9 @@ routes.webSocket(
  )
  }
  )
- let incoming = AsyncStream<String> { continuation in
+ let incoming = AsyncStream<Data> { continuation in
  websocket.onText { _, message in
- continuation.yield(message)
+ continuation.yield(Data(message.utf8))
  }
  }
  try await server.listen(to: incoming)

Sources/GraphQLWS/Client.swift

@@ -51,118 +51,133 @@ public actor Client<InitPayload: Equatable & Codable> {
  /// 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
- where A.Element == String {
+ where A.Element == Data {
  for try await message in incoming {
- // Detect and ignore error responses.
- if message.starts(with: "44") {
- // TODO: Determine what to do with returned error messages
+ try await respond(to: message)
+ }
+ }
+
+ /// 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.
+ @available(*, deprecated, message: "Use `Data` sequence instead.")
+ public func listen<A: AsyncSequence & Sendable>(to incoming: A) async throws
+ where A.Element == String {
+ for try await stringMessage in incoming {
+ guard let message = stringMessage.data(using: .utf8) else {
+ try await self.error(.invalidEncoding())
  return
  }
+ try await respond(to: message)
+ }
+ }
 
- guard let json = message.data(using: .utf8) else {
- try await error(.invalidEncoding())
+ private func respond(to message: Data) async throws {
+ let response: Response
+ do {
+ response = try decoder.decode(Response.self, from: message)
+ } catch {
+ try await self.error(.noType())
+ return
+ }
+
+ switch response.type {
+ case .GQL_CONNECTION_ERROR:
+ guard
+ let connectionErrorResponse = try? decoder.decode(
+ ConnectionErrorResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- let response: Response
- do {
- response = try decoder.decode(Response.self, from: json)
- } catch {
- try await self.error(.noType())
+ try await onConnectionError(connectionErrorResponse, self)
+ case .GQL_CONNECTION_ACK:
+ guard
+ let connectionAckResponse = try? decoder.decode(
+ ConnectionAckResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
  return
  }
-
- switch response.type {
- case .GQL_CONNECTION_ERROR:
- guard
- let connectionErrorResponse = try? decoder.decode(
- ConnectionErrorResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionError(connectionErrorResponse, self)
- case .GQL_CONNECTION_ACK:
- guard
- let connectionAckResponse = try? decoder.decode(
- ConnectionAckResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_ERROR))
- return
- }
- try await onConnectionAck(connectionAckResponse, self)
- case .GQL_CONNECTION_KEEP_ALIVE:
- guard
- let connectionKeepAliveResponse = try? decoder.decode(
- ConnectionKeepAliveResponse.self,
- from: json
- )
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
- return
- }
- try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
- case .GQL_DATA:
- guard let nextResponse = try? decoder.decode(DataResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_DATA))
- return
- }
- try await onData(nextResponse, self)
- case .GQL_ERROR:
- guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: json) else {
- try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
- return
- }
- try await onError(errorResponse, self)
- case .GQL_COMPLETE:
- guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: json)
- else {
- try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
- return
- }
- try await onComplete(completeResponse, self)
- default:
- try await error(.invalidType())
+ try await onConnectionAck(connectionAckResponse, self)
+ case .GQL_CONNECTION_KEEP_ALIVE:
+ guard
+ let connectionKeepAliveResponse = try? decoder.decode(
+ ConnectionKeepAliveResponse.self,
+ from: message
+ )
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_CONNECTION_KEEP_ALIVE))
+ return
+ }
+ try await onConnectionKeepAlive(connectionKeepAliveResponse, self)
+ case .GQL_DATA:
+ guard let nextResponse = try? decoder.decode(DataResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_DATA))
+ return
+ }
+ try await onData(nextResponse, self)
+ case .GQL_ERROR:
+ guard let errorResponse = try? decoder.decode(ErrorResponse.self, from: message) else {
+ try await error(.invalidResponseFormat(messageType: .GQL_ERROR))
+ return
+ }
+ try await onError(errorResponse, self)
+ case .GQL_COMPLETE:
+ guard let completeResponse = try? decoder.decode(CompleteResponse.self, from: message)
+ else {
+ try await error(.invalidResponseFormat(messageType: .GQL_COMPLETE))
+ return
  }
+ try await onComplete(completeResponse, self)
+ default:
+ try await error(.invalidType())
  }
  }
 
  /// 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/GraphQLWSError.swift

@@ -88,7 +88,7 @@ struct GraphQLWSError: Error {
 }
 
 /// Error codes for miscellaneous issues
-public enum ErrorCode: Int, CustomStringConvertible, Sendable {
+enum ErrorCode: Int, CustomStringConvertible, Sendable {
  /// Miscellaneous
  case miscellaneous = 4400
 

Sources/GraphQLWS/Messenger.swift

@@ -4,7 +4,7 @@ import Foundation
 public protocol Messenger: Sendable {
  /// Send a message through this messenger
  /// - Parameter message: The message to send
- func send<S: Sendable & Collection>(_ message: S) async throws where S.Element == Character
+ func send(_ message: Data) async throws
 
  /// Close the messenger
  func close() async throws

Sources/GraphQLWS/Requests.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() {}