Merge pull request #1979 from bnbarham/fix-sendable

Add sendable annotation to `userInfo` closure
swiftlang · Feb 17, 2025 · e8e1972 · e8e1972
2 parents 94ba7ea + 96247c0
commit e8e1972
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 7 deletions.
diff --git a/Sources/LanguageServerProtocolJSONRPC/JSONRPCConnection.swift b/Sources/LanguageServerProtocolJSONRPC/JSONRPCConnection.swift
@@ -367,7 +367,9 @@ public final class JSONRPCConnection: Connection {
     decoder.userInfo[.messageRegistryKey] = messageRegistry
 
     // Setup callback for response type.
-    decoder.userInfo[.responseTypeCallbackKey] = { (id: RequestID) -> ResponseType.Type? in
+    decoder.userInfo[.responseTypeCallbackKey] = { @Sendable (id: RequestID) -> ResponseType.Type? in
+      // `outstandingRequests` should never be mutated in this closure. Reading is fine as all of our other writes are
+      // guarded by `queue`, but `JSONDecoder` could (since this is sendable) invoke this concurrently.
       guard let outstanding = self.outstandingRequests[id] else {
         logger.error("Unknown request for \(id, privacy: .public)")
         return nil

diff --git a/Sources/LanguageServerProtocolJSONRPC/MessageCoding.swift b/Sources/LanguageServerProtocolJSONRPC/MessageCoding.swift
@@ -34,7 +34,7 @@ extension CodingUserInfoKey {
 
 extension JSONRPCMessage: Codable {
 
-  public typealias ResponseTypeCallback = (RequestID) -> ResponseType.Type?
+  public typealias ResponseTypeCallback = @Sendable (RequestID) -> ResponseType.Type?
 
   private enum CodingKeys: String, CodingKey {
     case jsonrpc

diff --git a/Sources/SKTestSupport/CheckCoding.swift b/Sources/SKTestSupport/CheckCoding.swift
@@ -95,7 +95,7 @@ package func checkDecoding<T: Codable & Equatable>(
 package func checkCoding<T: Codable>(
   _ value: T,
   json: String,
-  userInfo: [CodingUserInfoKey: Any] = [:],
+  userInfo: [CodingUserInfoKey: any Sendable] = [:],
   file: StaticString = #filePath,
   line: UInt = #line,
   body: (T) -> Void

diff --git a/Tests/LanguageServerProtocolJSONRPCTests/CodingTests.swift b/Tests/LanguageServerProtocolJSONRPCTests/CodingTests.swift
@@ -283,7 +283,7 @@ final class CodingTests: XCTestCase {
       return $0 == .string("unknown") ? nil : InitializeResult.self
     }
 
-    var info = defaultCodingInfo as [CodingUserInfoKey: Any]
+    var info = defaultCodingInfo
     info[CodingUserInfoKey.responseTypeCallbackKey] = responseTypeCallback
 
     checkMessageDecodingError(
@@ -366,7 +366,9 @@ final class CodingTests: XCTestCase {
   }
 }
 
-let defaultCodingInfo = [CodingUserInfoKey.messageRegistryKey: MessageRegistry.lspProtocol]
+let defaultCodingInfo: [CodingUserInfoKey: any Sendable] = [
+  CodingUserInfoKey.messageRegistryKey: MessageRegistry.lspProtocol
+]
 
 private func checkMessageCoding<Request: RequestType & Equatable>(
   _ value: Request,
@@ -417,7 +419,7 @@ private func checkMessageCoding<Response: ResponseType & Equatable>(
     return $0 == .string("unknown") ? nil : Response.self
   }
 
-  var codingInfo = defaultCodingInfo as [CodingUserInfoKey: Any]
+  var codingInfo = defaultCodingInfo
   codingInfo[.responseTypeCallbackKey] = callback
 
   checkCoding(JSONRPCMessage.response(value, id: id), json: json, userInfo: codingInfo, file: file, line: line) {
@@ -462,7 +464,7 @@ private func checkMessageCoding(
 private func checkMessageDecodingError(
   _ expected: MessageDecodingError,
   json: String,
-  userInfo: [CodingUserInfoKey: Any] = defaultCodingInfo,
+  userInfo: [CodingUserInfoKey: any Sendable] = defaultCodingInfo,
   file: StaticString = #filePath,
   line: UInt = #line
 ) {