Add Sendable annotations to LanguageServerProtocol

Author: ahoppen

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.7
+// swift-tools-version:5.8
 
 import Foundation
 import PackageDescription
@@ -97,7 +97,8 @@ let package = Package(
     .target(
       name: "LanguageServerProtocol",
       dependencies: [],
-      exclude: ["CMakeLists.txt"]
+      exclude: ["CMakeLists.txt"],
+      swiftSettings: [.enableExperimentalFeature("StrictConcurrency")]
     ),
 
     .testTarget(

Sources/LSPTestSupport/TestJSONRPCConnection.swift

@@ -185,7 +185,7 @@ extension String: @retroactive ResponseType {}
 #endif
 
 public struct EchoRequest: RequestType {
-  public static var method: String = "test_server/echo"
+  public static let method: String = "test_server/echo"
   public typealias Response = String
 
   public var string: String
@@ -196,7 +196,7 @@ public struct EchoRequest: RequestType {
 }
 
 public struct EchoError: RequestType {
-  public static var method: String = "test_server/echo_error"
+  public static let method: String = "test_server/echo_error"
   public typealias Response = VoidResponse
 
   public var code: ErrorCode?
@@ -209,7 +209,7 @@ public struct EchoError: RequestType {
 }
 
 public struct EchoNotification: NotificationType {
-  public static var method: String = "test_server/echo_note"
+  public static let method: String = "test_server/echo_note"
 
   public var string: String
 

Sources/LanguageServerProtocol/CustomCodable.swift

@@ -51,6 +51,8 @@ public struct CustomCodable<CustomCoder: CustomCodableWrapper> {
   }
 }
 
+extension CustomCodable: Sendable where CustomCoder.WrappedValue: Sendable {}
+
 extension CustomCodable: Codable {
   public init(from decoder: Decoder) throws {
     self.wrappedValue = try CustomCoder(from: decoder).wrappedValue

Sources/LanguageServerProtocol/Error.swift

@@ -14,7 +14,7 @@
 public typealias LSPResult<T> = Swift.Result<T, ResponseError>
 
 /// Error code suitable for use between language server and client.
-public struct ErrorCode: RawRepresentable, Codable, Hashable {
+public struct ErrorCode: RawRepresentable, Codable, Hashable, Sendable {
 
   public var rawValue: Int
 
@@ -100,9 +100,9 @@ public struct ResponseError: Error, Codable, Hashable {
 extension ResponseError {
   // MARK: Convenience properties for common errors.
 
-  public static var cancelled: ResponseError = ResponseError(code: .cancelled, message: "request cancelled by client")
+  public static let cancelled: ResponseError = ResponseError(code: .cancelled, message: "request cancelled by client")
 
-  public static var serverCancelled: ResponseError = ResponseError(
+  public static let serverCancelled: ResponseError = ResponseError(
     code: .serverCancelled,
     message: "request cancelled by server"
   )
@@ -136,7 +136,7 @@ public struct MessageDecodingError: Error, Hashable {
   /// If it was possible to recover the request id, it is stored here. This can be used e.g. to reply with a `ResponseError` to invalid requests.
   public var id: RequestID?
 
-  public enum MessageKind {
+  public enum MessageKind: Sendable {
     case request
     case response
     case notification

Sources/LanguageServerProtocol/Message.swift

@@ -12,7 +12,7 @@
 
 import Dispatch
 
-public protocol MessageType: Codable {}
+public protocol MessageType: Codable, Sendable {}
 
 /// `RequestType` with no associated type or same-type requirements. Most users should prefer
 /// `RequestType`.

Sources/LanguageServerProtocol/MessageRegistry.swift

@@ -10,7 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-public final class MessageRegistry {
+public final class MessageRegistry: Sendable {
 
   public static let lspProtocol: MessageRegistry =
     MessageRegistry(requests: builtinRequests, notifications: builtinNotifications)

Sources/LanguageServerProtocol/Notifications/CancelWorkDoneProgressNotification.swift

@@ -11,7 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 public struct CancelWorkDoneProgressNotification: NotificationType {
-  public static var method: String = "window/workDoneProgress/cancel"
+  public static let method: String = "window/workDoneProgress/cancel"
 
   public var token: ProgressToken
 

Sources/LanguageServerProtocol/Notifications/DidChangeFileNotifications.swift

@@ -11,7 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 public struct DidCreateFilesNotification: NotificationType {
-  public static var method: String = "workspace/didCreateFiles"
+  public static let method: String = "workspace/didCreateFiles"
 
   /// An array of all files/folders created in this operation.
   public var files: [FileCreate]
@@ -22,7 +22,7 @@ public struct DidCreateFilesNotification: NotificationType {
 }
 
 public struct DidRenameFilesNotification: NotificationType {
-  public static var method: String = "workspace/didRenameFiles"
+  public static let method: String = "workspace/didRenameFiles"
 
   /// An array of all files/folders renamed in this operation. When a folder
   /// is renamed, only the folder will be included, and not its children.
@@ -34,7 +34,7 @@ public struct DidRenameFilesNotification: NotificationType {
 }
 
 public struct DidDeleteFilesNotification: NotificationType {
-  public static var method: String = "workspace/didDeleteFiles"
+  public static let method: String = "workspace/didDeleteFiles"
 
   /// An array of all files/folders created in this operation.
   public var files: [FileDelete]

Sources/LanguageServerProtocol/Notifications/DidChangeWorkspaceFoldersNotification.swift

@@ -27,7 +27,7 @@ public struct DidChangeWorkspaceFoldersNotification: NotificationType {
 }
 
 /// The workspace folder change event.
-public struct WorkspaceFoldersChangeEvent: Codable, Hashable {
+public struct WorkspaceFoldersChangeEvent: Codable, Hashable, Sendable {
 
   /// The array of added workspace folders
   public var added: [WorkspaceFolder]?

Sources/LanguageServerProtocol/Notifications/TextSynchronizationNotifications.swift

@@ -169,7 +169,7 @@ public struct DidOpenNotebookDocumentNotification: NotificationType, Hashable {
 
 /// The change notification is sent from the client to the server when a notebook document changes. It is only sent by a client if the server requested the synchronization mode `notebook` in its `notebookDocumentSync` capability.
 public struct DidChangeNotebookDocumentNotification: NotificationType, Hashable {
-  public static var method: String = "notebookDocument/didChange"
+  public static let method: String = "notebookDocument/didChange"
 
   /// The notebook document that did change. The version number points
   /// to the version after all provided changes have been applied.
@@ -196,7 +196,7 @@ public struct DidChangeNotebookDocumentNotification: NotificationType, Hashable
 
 /// The save notification is sent from the client to the server when a notebook document is saved. It is only sent by a client if the server requested the synchronization mode `notebook` in its `notebookDocumentSync` capability.
 public struct DidSaveNotebookDocumentNotification: NotificationType {
-  public static var method: String = "notebookDocument/didSave"
+  public static let method: String = "notebookDocument/didSave"
 
   /// The notebook document that got saved.
   public var notebookDocument: NotebookDocumentIdentifier
@@ -208,7 +208,7 @@ public struct DidSaveNotebookDocumentNotification: NotificationType {
 
 /// The close notification is sent from the client to the server when a notebook document is closed. It is only sent by a client if the server requested the synchronization mode `notebook` in its `notebookDocumentSync` capability.
 public struct DidCloseNotebookDocumentNotification: NotificationType {
-  public static var method: String = "notebookDocument/didClose"
+  public static let method: String = "notebookDocument/didClose"
 
   /// The notebook document that got closed.
   public var notebookDocument: NotebookDocumentIdentifier