Add a send method to InProcessSourceKitLSPClient in which the client specifies the request ID

Author: ahoppen

Sources/InProcessClient/InProcessSourceKitLSPClient.swift

@@ -14,6 +14,7 @@ import BuildSystemIntegration
 public import Foundation
 public import LanguageServerProtocol
 import LanguageServerProtocolExtensions
+import SKLogging
 import SwiftExtensions
 import TSCExtensions
 
@@ -35,6 +36,8 @@ public final class InProcessSourceKitLSPClient: Sendable {
 
   private let nextRequestID = AtomicUInt32(initialValue: 0)
 
+  private let requestIDPrefix = "inproc-"
+
   public convenience init(
     toolchainPath: URL?,
     capabilities: ClientCapabilities = ClientCapabilities(),
@@ -124,11 +127,35 @@ public final class InProcessSourceKitLSPClient: Sendable {
     _ request: R,
     reply: @Sendable @escaping (LSPResult<R.Response>) -> Void
   ) -> RequestID {
-    let requestID = RequestID.number(Int(nextRequestID.fetchAndIncrement()))
+    let requestID = RequestID.string("\(requestIDPrefix)\(Int(nextRequestID.fetchAndIncrement()))")
     server.handle(request, id: requestID, reply: reply)
     return requestID
   }
 
+  /// Send the request to `server` and return the request result via a completion handler.
+  ///
+  /// The request ID must not start with `inproc-` to avoid conflicting with the request IDs that are created by
+  /// `send(:reply:)`.
+  public func send<R: RequestType>(
+    _ request: R,
+    requestID: RequestID,
+    reply: @Sendable @escaping (LSPResult<R.Response>) -> Void
+  ) {
+    #if DEBUG
+    if case .string(let string) = requestID {
+      if string.starts(with: requestIDPrefix) {
+        logger.fault(
+          """
+          Manually specified request ID to InProcessSoruceKitLSPClient has reserved prefix \
+          '\(self.requestIDPrefix, privacy: .public)'
+          """
+        )
+      }
+    }
+    #endif
+    server.handle(request, id: requestID, reply: reply)
+  }
+
   /// Send the notification to `server`.
   public func send(_ notification: some NotificationType) {
     server.handle(notification)