Rename Message -> JSONRPCMessage in preparation for making it public

Author: benlangmuir

Sources/LanguageServerProtocolJSONRPC/JSONRPCConnection.swift

@@ -144,7 +144,7 @@ public final class JSONRPCConection {
         return nil
       }
       return outstanding.responseType
-    } as Message.ResponseTypeCallback
+    } as JSONRPCMessage.ResponseTypeCallback
 
     var bytes = bytes[...]
 
@@ -156,7 +156,7 @@ public final class JSONRPCConection {
         bytes = rest
 
         let pointer = UnsafeMutableRawPointer(mutating: UnsafeBufferPointer(rebasing: messageBytes).baseAddress!)
-        let message = try decoder.decode(Message.self, from: Data(bytesNoCopy: pointer, count: messageBytes.count, deallocator: .none))
+        let message = try decoder.decode(JSONRPCMessage.self, from: Data(bytesNoCopy: pointer, count: messageBytes.count, deallocator: .none))
 
         handle(message)
 
@@ -166,7 +166,7 @@ public final class JSONRPCConection {
           case .request:
             if let id = error.id {
               send { encoder in
-                try encoder.encode(Message.errorResponse(ResponseError(error), id: id))
+                try encoder.encode(JSONRPCMessage.errorResponse(ResponseError(error), id: id))
               }
               continue MESSAGE_LOOP
             }
@@ -198,7 +198,7 @@ public final class JSONRPCConection {
   }
 
   /// Handle a single message by dispatching it to `receiveHandler` or an appropriate reply handler.
-  func handle(_ message: Message) {
+  func handle(_ message: JSONRPCMessage) {
     switch message {
     case .notification(let notification):
       notification._handle(receiveHandler!, connection: self)
@@ -289,7 +289,7 @@ extension JSONRPCConection: _IndirectConnection {
   public func send<Notification>(_ notification: Notification) where Notification: NotificationType {
     guard readyToSend() else { return }
     send { encoder in
-      return try encoder.encode(Message.notification(notification))
+      return try encoder.encode(JSONRPCMessage.notification(notification))
     }
   }
 
@@ -316,7 +316,7 @@ extension JSONRPCConection: _IndirectConnection {
     }
 
     send { encoder in
-      return try encoder.encode(Message.request(request, id: id))
+      return try encoder.encode(JSONRPCMessage.request(request, id: id))
     }
 
     return id
@@ -328,9 +328,9 @@ extension JSONRPCConection: _IndirectConnection {
     send { encoder in
       switch response {
       case .success(let result):
-        return try encoder.encode(Message.response(result, id: id))
+        return try encoder.encode(JSONRPCMessage.response(result, id: id))
       case .failure(let error):
-        return try encoder.encode(Message.errorResponse(error, id: id))
+        return try encoder.encode(JSONRPCMessage.errorResponse(error, id: id))
       }
     }
   }

Sources/LanguageServerProtocolJSONRPC/MessageCoding.swift

@@ -12,7 +12,8 @@
 
 import LanguageServerProtocol
 
-enum Message {
+/// A single JSONRPC message suitable for encoding/decoding.
+enum JSONRPCMessage {
   case notification(NotificationType)
   case request(_RequestType, id: RequestID)
   case response(ResponseType, id: RequestID)
@@ -23,7 +24,7 @@ extension CodingUserInfoKey {
   public static let responseTypeCallbackKey: CodingUserInfoKey = CodingUserInfoKey(rawValue: "lsp.jsonrpc.responseTypeCallback")!
 }
 
-extension Message: Codable {
+extension JSONRPCMessage: Codable {
 
   typealias ResponseTypeCallback = (RequestID) -> ResponseType.Type?
 

Tests/LanguageServerProtocolJSONRPCTests/CodingTests.swift

@@ -187,7 +187,7 @@ final class CodingTests: XCTestCase {
     {"jsonrpc":"2.0","method":"$/cancelRequest","params":{}}
     """)
 
-    let responseTypeCallback: Message.ResponseTypeCallback = {
+    let responseTypeCallback: JSONRPCMessage.ResponseTypeCallback = {
       return $0 == .string("unknown") ? nil : InitializeResult.self
     }
 
@@ -216,9 +216,9 @@ final class CodingTests: XCTestCase {
 }
 
 private func checkMessageCoding<Request>(_ value: Request, id: RequestID, json: String, file: StaticString = #file, line: UInt = #line) where Request: RequestType & Equatable {
-  checkCoding(Message.request(value, id: id), json: json, file: file, line: line) {
+  checkCoding(JSONRPCMessage.request(value, id: id), json: json, file: file, line: line) {
 
-    guard case Message.request(let decodedValueOpaque, let decodedID) = $0, let decodedValue = decodedValueOpaque as? Request else {
+    guard case JSONRPCMessage.request(let decodedValueOpaque, let decodedID) = $0, let decodedValue = decodedValueOpaque as? Request else {
       XCTFail("decodedValue \($0) does not match expected \(value)", file: file, line: line)
       return
     }
@@ -229,9 +229,9 @@ private func checkMessageCoding<Request>(_ value: Request, id: RequestID, json:
 }
 
 private func checkMessageCoding<Notification>(_ value: Notification, json: String, file: StaticString = #file, line: UInt = #line) where Notification: NotificationType & Equatable {
-  checkCoding(Message.notification(value), json: json, file: file, line: line) {
+  checkCoding(JSONRPCMessage.notification(value), json: json, file: file, line: line) {
 
-    guard case Message.notification(let decodedValueOpaque) = $0, let decodedValue = decodedValueOpaque as? Notification else {
+    guard case JSONRPCMessage.notification(let decodedValueOpaque) = $0, let decodedValue = decodedValueOpaque as? Notification else {
       XCTFail("decodedValue \($0) does not match expected \(value)", file: file, line: line)
       return
     }
@@ -242,13 +242,13 @@ private func checkMessageCoding<Notification>(_ value: Notification, json: Strin
 
 private func checkMessageCoding<Response>(_ value: Response, id: RequestID, json: String, file: StaticString = #file, line: UInt = #line) where Response: ResponseType & Equatable {
 
-  let callback: Message.ResponseTypeCallback = {
+  let callback: JSONRPCMessage.ResponseTypeCallback = {
     return $0 == .string("unknown") ? nil : Response.self
   }
 
-  checkCoding(Message.response(value, id: id), json: json, userInfo: [.responseTypeCallbackKey: callback], file: file, line: line) {
+  checkCoding(JSONRPCMessage.response(value, id: id), json: json, userInfo: [.responseTypeCallbackKey: callback], file: file, line: line) {
 
-    guard case Message.response(let decodedValueOpaque, let decodedID) = $0, let decodedValue = decodedValueOpaque as? Response else {
+    guard case JSONRPCMessage.response(let decodedValueOpaque, let decodedID) = $0, let decodedValue = decodedValueOpaque as? Response else {
       XCTFail("decodedValue \($0) does not match expected \(value)", file: file, line: line)
       return
     }
@@ -259,9 +259,9 @@ private func checkMessageCoding<Response>(_ value: Response, id: RequestID, json
 }
 
 private func checkMessageCoding(_ value: ResponseError, id: RequestID, json: String, file: StaticString = #file, line: UInt = #line) {
-  checkCoding(Message.errorResponse(value, id: id), json: json, file: file, line: line) {
+  checkCoding(JSONRPCMessage.errorResponse(value, id: id), json: json, file: file, line: line) {
 
-    guard case Message.errorResponse(let decodedValue, let decodedID) = $0 else {
+    guard case JSONRPCMessage.errorResponse(let decodedValue, let decodedID) = $0 else {
       XCTFail("decodedValue \($0) does not match expected \(value)", file: file, line: line)
       return
     }
@@ -277,7 +277,7 @@ private func checkMessageDecodingError(_ expected: MessageDecodingError, json: S
   decoder.userInfo = userInfo
 
   do {
-    _ = try decoder.decode(Message.self, from: data)
+    _ = try decoder.decode(JSONRPCMessage.self, from: data)
     XCTFail("expected error not seen", file: file, line: line)
   } catch let error as MessageDecodingError {
     XCTAssertEqual(expected, error, file: file, line: line)

Tests/LanguageServerProtocolJSONRPCTests/ConnectionTests.swift

@@ -60,8 +60,8 @@ class ConnectionTests: XCTestCase {
       expectation.fulfill()
     }
 
-    let note1 = try! JSONEncoder().encode(Message.notification(EchoNotification(string: "hello!")))
-    let note2 = try! JSONEncoder().encode(Message.notification(EchoNotification(string: "no way!")))
+    let note1 = try! JSONEncoder().encode(JSONRPCMessage.notification(EchoNotification(string: "hello!")))
+    let note2 = try! JSONEncoder().encode(JSONRPCMessage.notification(EchoNotification(string: "no way!")))
 
     let note1Str: String = "Content-Length: \(note1.count)\r\n\r\n\(String(data: note1, encoding: .utf8)!)"
     let note2Str: String = "Content-Length: \(note2.count)\r\n\r\n\(String(data: note2, encoding: .utf8)!)"