Merge pull request #48 from rintaro/sourcekit-extensions

Prefix LSP/BSP extension methods with `sourcekit/`

Author: rintaro

Package.swift

@@ -91,6 +91,7 @@ var targets: [Target] = [
       "LanguageServerProtocol",
       "LanguageServerProtocolTransport",
       "SKLogging",
+      "ToolsProtocolsSwiftExtensions",
       "ToolsProtocolsTestSupport",
     ],
     swiftSettings: globalSwiftSettings

Sources/BuildServerProtocol/Messages.swift

@@ -42,7 +42,22 @@ private let notificationTypes: [NotificationType.Type] = [
 
 extension MessageRegistry {
   public static let bspProtocol: MessageRegistry =
-    MessageRegistry(requests: requestTypes, notifications: notificationTypes)
+    MessageRegistry(requests: requestTypes, notifications: notificationTypes, legacyNames: bspLegacyNames)
+
+  /// Maps current `sourcekit/`-prefixed BSP method names to the legacy names used before the
+  /// prefix migration. Consumed by `MessageRegistry` (incoming routing) and
+  /// `LegacyNameFallbackConnection` (outgoing retries).
+  ///
+  /// This table is frozen. Do not add new entries for newly introduced methods.
+  public static let bspLegacyNames: [String: String] = [
+    BuildTargetPrepareRequest.method: "buildTarget/prepare",
+    FileOptionsChangedNotification.method: "build/sourceKitOptionsChanged",
+    TextDocumentSourceKitOptionsRequest.method: "textDocument/sourceKitOptions",
+    WorkspaceWaitForBuildSystemUpdatesRequest.method: "workspace/waitForBuildSystemUpdates",
+  ]
+  #if compiler(>=6.7)
+  #warning("Remove the legacy method names")
+  #endif
 }
 
 @available(*, deprecated, message: "use MessageRegistry.bspProtocol instead")

Sources/BuildServerProtocol/Messages/BuildTargetPrepareRequest.swift

@@ -26,7 +26,7 @@ public typealias OriginId = String
 /// The server communicates during the initialize handshake whether this method is supported or not by setting
 /// `prepareProvider: true` in `SourceKitInitializeBuildResponseData`.
 public struct BuildTargetPrepareRequest: BSPRequest, Hashable {
-  public static let method: String = "buildTarget/prepare"
+  public static let method: String = "sourcekit/buildTarget/prepare"
   public typealias Response = BuildTargetPrepareResponse
 
   /// A list of build targets to prepare.

Sources/BuildServerProtocol/Messages/InitializeBuildRequest.swift

@@ -82,9 +82,13 @@ public struct BuildClientCapabilities: Codable, Hashable, Sendable {
   /// it's safe to return classpath in ScalacOptionsItem empty. */
   public var jvmCompileClasspathReceiver: Bool?
 
-  public init(languageIds: [Language], jvmCompileClasspathReceiver: Bool? = nil) {
+  /// Experimental client capabilities.
+  public var experimental: LSPAny?
+
+  public init(languageIds: [Language], jvmCompileClasspathReceiver: Bool? = nil, experimental: LSPAny? = nil) {
     self.languageIds = languageIds
     self.jvmCompileClasspathReceiver = jvmCompileClasspathReceiver
+    self.experimental = experimental
   }
 }
 

Sources/BuildServerProtocol/Messages/RegisterForChangeNotifications.swift

@@ -57,7 +57,7 @@ public struct FileOptionsChangedNotification: BSPNotification {
     public var workingDirectory: String?
   }
 
-  public static let method: String = "build/sourceKitOptionsChanged"
+  public static let method: String = "sourcekit/build/sourceKitOptionsChanged"
 
   /// The URI of the document that has changed settings.
   public var uri: URI

Sources/BuildServerProtocol/Messages/TextDocumentSourceKitOptionsRequest.swift

@@ -20,7 +20,7 @@ public import LanguageServerProtocol
 ///
 /// The request may return `nil` if it doesn't have any build settings for this file in the given target.
 public struct TextDocumentSourceKitOptionsRequest: BSPRequest, Hashable {
-  public static let method: String = "textDocument/sourceKitOptions"
+  public static let method: String = "sourcekit/textDocument/sourceKitOptions"
   public typealias Response = TextDocumentSourceKitOptionsResponse?
 
   /// The URI of the document to get options for

Sources/BuildServerProtocol/Messages/WorkspaceWaitForBuildSystemUpdates.swift

@@ -19,7 +19,7 @@ public import LanguageServerProtocol
 public struct WorkspaceWaitForBuildSystemUpdatesRequest: BSPRequest, Hashable {
   public typealias Response = VoidResponse
 
-  public static let method: String = "workspace/waitForBuildSystemUpdates"
+  public static let method: String = "sourcekit/workspace/waitForBuildSystemUpdates"
 
   public init() {}
 }

Sources/LanguageServerProtocol/Connection.swift

@@ -28,8 +28,11 @@ public protocol Connection: Sendable {
   /// Send a request with a pre-defined request ID and (asynchronously) receive a reply.
   ///
   /// The request ID must not conflict with any request ID generated by `nextRequestID()`.
+  /// `method` is the JSON-RPC method string; pass `Request.method` for the normal case or a
+  /// legacy method name when talking to an old peer.
   func send<Request: RequestType>(
     _ request: Request,
+    method: String,
     id: RequestID,
     reply: @escaping @Sendable (LSPResult<Request.Response>) -> Void
   )
@@ -42,7 +45,7 @@ extension Connection {
     reply: @escaping @Sendable (LSPResult<Request.Response>) -> Void
   ) -> RequestID {
     let id = nextRequestID()
-    self.send(request, id: id, reply: reply)
+    self.send(request, method: Request.method, id: id, reply: reply)
     return id
   }
 }

Sources/LanguageServerProtocol/MessageRegistry.swift

@@ -14,9 +14,26 @@ public final class MessageRegistry: Sendable {
   private let methodToRequest: [String: _RequestType.Type]
   private let methodToNotification: [String: NotificationType.Type]
 
-  public init(requests: [_RequestType.Type], notifications: [NotificationType.Type]) {
-    self.methodToRequest = Dictionary(uniqueKeysWithValues: requests.map { ($0.method, $0) })
-    self.methodToNotification = Dictionary(uniqueKeysWithValues: notifications.map { ($0.method, $0) })
+  public init(
+    requests: [_RequestType.Type],
+    notifications: [NotificationType.Type],
+    legacyNames: [String: String] = [:]
+  ) {
+    var methodToRequest: [String: _RequestType.Type] = Dictionary(
+      uniqueKeysWithValues: requests.map { ($0.method, $0) }
+    )
+    for request in requests {
+      if let legacy = legacyNames[request.method] { methodToRequest[legacy] = request }
+    }
+    self.methodToRequest = methodToRequest
+
+    var methodToNotification: [String: NotificationType.Type] = Dictionary(
+      uniqueKeysWithValues: notifications.map { ($0.method, $0) }
+    )
+    for notification in notifications {
+      if let legacy = legacyNames[notification.method] { methodToNotification[legacy] = notification }
+    }
+    self.methodToNotification = methodToNotification
   }
 
   /// Returns the type of the message named `method`, or nil if it is unknown.

Sources/LanguageServerProtocol/Messages.swift

@@ -134,7 +134,33 @@ public let builtinNotifications: [NotificationType.Type] = [
 
 extension MessageRegistry {
   public static let lspProtocol: MessageRegistry =
-    MessageRegistry(requests: builtinRequests, notifications: builtinNotifications)
+    MessageRegistry(requests: builtinRequests, notifications: builtinNotifications, legacyNames: lspLegacyNames)
+
+  /// Maps current `sourcekit/`-prefixed method names to the legacy names used before the prefix
+  /// migration. Consumed by `MessageRegistry` (incoming routing) and `LegacyNameFallbackConnection`
+  /// (outgoing retries).
+  ///
+  /// This table is frozen. Do not add new entries for newly introduced methods.
+  public static let lspLegacyNames: [String: String] = [
+    DidChangeActiveDocumentNotification.method: "window/didChangeActiveDocument",
+    DoccDocumentationRequest.method: "textDocument/doccDocumentation",
+    DocumentTestsRequest.method: "textDocument/tests",
+    GetReferenceDocumentRequest.method: "workspace/getReferenceDocument",
+    IsIndexingRequest.method: "sourceKit/_isIndexing",
+    OutputPathsRequest.method: "workspace/_outputPaths",
+    PeekDocumentsRequest.method: "workspace/peekDocuments",
+    SetOptionsRequest.method: "workspace/_setOptions",
+    SourceKitOptionsRequest.method: "workspace/_sourceKitOptions",
+    SynchronizeRequest.method: "workspace/synchronize",
+    TriggerReindexRequest.method: "workspace/triggerReindex",
+    WorkspacePlaygroundsRefreshRequest.method: "workspace/playgrounds/refresh",
+    WorkspacePlaygroundsRequest.method: "workspace/playgrounds",
+    WorkspaceTestsRefreshRequest.method: "workspace/tests/refresh",
+    WorkspaceTestsRequest.method: "workspace/tests",
+  ]
+  #if compiler(>=6.7)
+  #warning("Remove the legacy method names")
+  #endif
 }
 
 // MARK: Miscellaneous Message Types