Merge pull request #1117 from ahoppen/ahoppen/sendability

Add Sendable annotations to LanguageServerProtocol, LSPLogging and SKSupport

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(
@@ -137,7 +138,7 @@ let package = Package(
         .product(name: "Crypto", package: "swift-crypto")
       ],
       exclude: ["CMakeLists.txt"],
-      swiftSettings: lspLoggingSwiftSettings
+      swiftSettings: lspLoggingSwiftSettings + [.enableExperimentalFeature("StrictConcurrency")]
     ),
 
     .testTarget(
@@ -197,7 +198,8 @@ let package = Package(
         "LanguageServerProtocol",
         "LSPLogging",
       ],
-      exclude: ["CMakeLists.txt"]
+      exclude: ["CMakeLists.txt"],
+      swiftSettings: [.enableExperimentalFeature("StrictConcurrency")]
     ),
 
     .testTarget(

Sources/LSPLogging/NonDarwinLogging.swift

@@ -45,7 +45,7 @@ public enum LogConfig {
 ///
 /// For documentation of the different log levels see
 /// https://developer.apple.com/documentation/os/oslogtype.
-public enum NonDarwinLogLevel: Comparable, CustomStringConvertible {
+public enum NonDarwinLogLevel: Comparable, CustomStringConvertible, Sendable {
   case debug
   case info
   case `default`
@@ -102,7 +102,7 @@ public enum NonDarwinLogLevel: Comparable, CustomStringConvertible {
 ///
 /// For documentation of the different privacy levels see
 /// https://developer.apple.com/documentation/os/oslogprivacy.
-public enum NonDarwinLogPrivacy: Comparable {
+public enum NonDarwinLogPrivacy: Comparable, Sendable {
   case `public`
   case `private`
   case sensitive
@@ -132,16 +132,16 @@ public enum NonDarwinLogPrivacy: Comparable {
 /// sourcekit-lsp.
 ///
 /// This is used on platforms that don't have OSLog.
-public struct NonDarwinLogInterpolation: StringInterpolationProtocol {
-  private enum LogPiece {
+public struct NonDarwinLogInterpolation: StringInterpolationProtocol, Sendable {
+  private enum LogPiece: Sendable {
     /// A segment of the log message that will always be displayed.
     case string(String)
 
     /// A segment of the log message that might need to be redacted if the
     /// privacy level is lower than `privacy`.
     case possiblyRedacted(
-      description: () -> String,
-      redactedDescription: () -> String,
+      description: @Sendable () -> String,
+      redactedDescription: @Sendable () -> String,
       privacy: NonDarwinLogPrivacy
     )
   }
@@ -158,8 +158,8 @@ public struct NonDarwinLogInterpolation: StringInterpolationProtocol {
   }
 
   private mutating func append(
-    description: @autoclosure @escaping () -> String,
-    redactedDescription: @autoclosure @escaping () -> String,
+    description: @autoclosure @escaping @Sendable () -> String,
+    redactedDescription: @autoclosure @escaping @Sendable () -> String,
     privacy: NonDarwinLogPrivacy
   ) {
     if privacy == .public {
@@ -181,13 +181,15 @@ public struct NonDarwinLogInterpolation: StringInterpolationProtocol {
   }
 
   @_disfavoredOverload  // Prefer to use the StaticString overload when possible.
-  public mutating func appendInterpolation(_ message: CustomStringConvertible, privacy: NonDarwinLogPrivacy = .private)
-  {
+  public mutating func appendInterpolation(
+    _ message: some CustomStringConvertible & Sendable,
+    privacy: NonDarwinLogPrivacy = .private
+  ) {
     append(description: message.description, redactedDescription: "<private>", privacy: privacy)
   }
 
   public mutating func appendInterpolation(
-    _ message: CustomLogStringConvertibleWrapper,
+    _ message: some CustomLogStringConvertibleWrapper & Sendable,
     privacy: NonDarwinLogPrivacy = .private
   ) {
     append(description: message.description, redactedDescription: message.redactedDescription, privacy: privacy)
@@ -198,7 +200,7 @@ public struct NonDarwinLogInterpolation: StringInterpolationProtocol {
   }
 
   /// Builds the string that represents the log message, masking all interpolation
-  /// segments whose privacy level is greater thatn `logPrivacyLevel`.
+  /// segments whose privacy level is greater that `logPrivacyLevel`.
   fileprivate func string(for logPrivacyLevel: NonDarwinLogPrivacy) -> String {
     var result = ""
     for piece in pieces {
@@ -221,7 +223,7 @@ public struct NonDarwinLogInterpolation: StringInterpolationProtocol {
 /// sourcekit-lsp.
 ///
 /// This is used on platforms that don't have OSLog.
-public struct NonDarwinLogMessage: ExpressibleByStringInterpolation, ExpressibleByStringLiteral {
+public struct NonDarwinLogMessage: ExpressibleByStringInterpolation, ExpressibleByStringLiteral, Sendable {
   fileprivate let value: NonDarwinLogInterpolation
 
   public init(stringInterpolation: NonDarwinLogInterpolation) {
@@ -257,12 +259,12 @@ private let loggingQueue: DispatchQueue = DispatchQueue(label: "loggingQueue", q
 ///
 /// This logger is used to log messages to stderr on platforms where OSLog is
 /// not available.
-public struct NonDarwinLogger {
+public struct NonDarwinLogger: Sendable {
   private let subsystem: String
   private let category: String
   private let logLevel: NonDarwinLogLevel
   private let privacyLevel: NonDarwinLogPrivacy
-  private let logHandler: (String) -> Void
+  private let logHandler: @Sendable (String) -> Void
 
   /// - Parameters:
   ///   - subsystem: See os.Logger
@@ -277,7 +279,7 @@ public struct NonDarwinLogger {
     category: String,
     logLevel: NonDarwinLogLevel? = nil,
     privacyLevel: NonDarwinLogPrivacy? = nil,
-    logHandler: @escaping (String) -> Void = { fputs($0 + "\n", stderr) }
+    logHandler: @escaping @Sendable (String) -> Void = { fputs($0 + "\n", stderr) }
   ) {
     self.subsystem = subsystem
     self.category = category
@@ -292,7 +294,7 @@ public struct NonDarwinLogger {
   /// program to finish as quickly as possible.
   public func log(
     level: NonDarwinLogLevel,
-    _ message: @autoclosure @escaping () -> NonDarwinLogMessage
+    _ message: @autoclosure @escaping @Sendable () -> NonDarwinLogMessage
   ) {
     guard level >= self.logLevel else { return }
     let date = Date()

Sources/LSPTestSupport/TestJSONRPCConnection.swift

@@ -196,7 +196,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
@@ -207,7 +207,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?
@@ -220,7 +220,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/Connection.swift

@@ -13,7 +13,7 @@
 import Dispatch
 
 /// An abstract connection, allow messages to be sent to a (potentially remote) `MessageHandler`.
-public protocol Connection: AnyObject {
+public protocol Connection: AnyObject, Sendable {
 
   /// Send a notification without a reply.
   func send(_ notification: some NotificationType)
@@ -61,7 +61,9 @@ public protocol MessageHandler: AnyObject {
 /// conn.send(...) // handled by server
 /// conn.close()
 /// ```
-public final class LocalConnection {
+///
+/// - Note: Unchecked sendable conformance because shared state is guarded by `queue`.
+public final class LocalConnection: @unchecked Sendable {
 
   enum State {
     case ready, started, closed

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]