Migrate getReferenceDocument to upstream textDocumentContent

Author: fwcd

Contributor Documentation/LSP Extensions.md

@@ -595,30 +595,3 @@ export interface PeekDocumentsResult {
   success: boolean;
 }
 ```
-
-## `workspace/getReferenceDocument`
-
-Request from the client to the server asking for contents of a URI having a custom scheme.
-For example: "sourcekit-lsp:"
-
-Enable the experimental client capability `"workspace/getReferenceDocument"` so that the server responds with reference document URLs for certain requests or commands whenever possible.
-
-- params: `GetReferenceDocumentParams`
-
-- result: `GetReferenceDocumentResponse`
-
-```ts
-export interface GetReferenceDocumentParams {
-  /**
-   * The `DocumentUri` of the custom scheme url for which content is required
-   */
-  uri: DocumentUri;
-}
-
-/**
- * Response containing `content` of `GetReferenceDocumentRequest`
- */
-export interface GetReferenceDocumentResult {
-  content: string;
-}
-```

Sources/LanguageServerProtocol/CMakeLists.txt

@@ -55,7 +55,6 @@ add_library(LanguageServerProtocol STATIC
   Requests/ExecuteCommandRequest.swift
   Requests/FoldingRangeRequest.swift
   Requests/FormattingRequests.swift
-  Requests/GetReferenceDocumentRequest.swift
   Requests/HoverRequest.swift
   Requests/ImplementationRequest.swift
   Requests/IndexedRenameRequest.swift
@@ -79,6 +78,7 @@ add_library(LanguageServerProtocol STATIC
   Requests/ShutdownRequest.swift
   Requests/SignatureHelpRequest.swift
   Requests/SymbolInfoRequest.swift
+  Requests/TextDocumentContentRequest.swift
   Requests/TriggerReindexRequest.swift
   Requests/TypeDefinitionRequest.swift
   Requests/TypeHierarchyPrepareRequest.swift

Sources/LanguageServerProtocol/Messages.swift

@@ -48,7 +48,6 @@ public let builtinRequests: [_RequestType.Type] = [
   DocumentTestsRequest.self,
   ExecuteCommandRequest.self,
   FoldingRangeRequest.self,
-  GetReferenceDocumentRequest.self,
   HoverRequest.self,
   ImplementationRequest.self,
   InitializeRequest.self,
@@ -71,6 +70,7 @@ public let builtinRequests: [_RequestType.Type] = [
   ShutdownRequest.self,
   SignatureHelpRequest.self,
   SymbolInfoRequest.self,
+  TextDocumentContentRequest.self,
   TriggerReindexRequest.self,
   TypeDefinitionRequest.self,
   TypeHierarchyPrepareRequest.self,

Sources/LanguageServerProtocol/Requests/GetReferenceDocumentRequest.swift Sources/LanguageServerProtocol/Requests/TextDocumentContentRequest.swift

@@ -10,22 +10,22 @@
 //
 //===----------------------------------------------------------------------===//
 
-/// Request from the client to the server asking for contents of a URI having a custom scheme **(LSP Extension)**
+/// Request from the client to the server asking for contents of a URI having a custom scheme
 /// For example: "sourcekit-lsp:"
 ///
 /// - Parameters:
 ///   - uri: The `DocumentUri` of the custom scheme url for which content is required
 ///
-/// - Returns: `GetReferenceDocumentResponse` which contains the `content` to be displayed.
+/// - Returns: `TextDocumentContentResponse` which contains the `content` to be displayed.
 ///
 /// ### LSP Extension
 ///
 /// This request is an extension to LSP supported by SourceKit-LSP.
-/// Enable the experimental client capability `"workspace/getReferenceDocument"` so that the server responds with
+/// Enable the experimental client capability `"workspace/textDocumentContent"` so that the server responds with
 /// reference document URLs for certain requests or commands whenever possible.
-public struct GetReferenceDocumentRequest: RequestType {
-  public static let method: String = "workspace/getReferenceDocument"
-  public typealias Response = GetReferenceDocumentResponse
+public struct TextDocumentContentRequest: RequestType {
+  public static let method: String = "workspace/textDocumentContent"
+  public typealias Response = TextDocumentContentResponse
 
   public var uri: DocumentURI
 
@@ -34,11 +34,11 @@ public struct GetReferenceDocumentRequest: RequestType {
   }
 }
 
-/// Response containing `content` of `GetReferenceDocumentRequest`
-public struct GetReferenceDocumentResponse: ResponseType {
-  public var content: String
+/// Response containing `text` of `TextDocumentContentRequest`
+public struct TextDocumentContentResponse: ResponseType {
+  public var text: String
 
-  public init(content: String) {
-    self.content = content
+  public init(text: String) {
+    self.text = text
   }
 }

Sources/SourceKitLSP/Clang/ClangLanguageService.swift

@@ -648,7 +648,7 @@ extension ClangLanguageService {
     return try await forwardRequestToClangd(req)
   }
 
-  func getReferenceDocument(_ req: GetReferenceDocumentRequest) async throws -> GetReferenceDocumentResponse {
+  func textDocumentContent(_ req: TextDocumentContentRequest) async throws -> TextDocumentContentResponse {
     throw ResponseError.unknown("unsupported method")
   }
 }

Sources/SourceKitLSP/LanguageService.swift

@@ -252,7 +252,7 @@ package protocol LanguageService: AnyObject, Sendable {
 
   func executeCommand(_ req: ExecuteCommandRequest) async throws -> LSPAny?
 
-  func getReferenceDocument(_ req: GetReferenceDocumentRequest) async throws -> GetReferenceDocumentResponse
+  func textDocumentContent(_ req: TextDocumentContentRequest) async throws -> TextDocumentContentResponse
 
   /// Perform a syntactic scan of the file at the given URI for test cases and test classes.
   ///

Sources/SourceKitLSP/MessageHandlingDependencyTracker.swift

@@ -179,7 +179,7 @@ enum MessageHandlingDependencyTracker: DependencyTracker {
       } else {
         self = .freestanding
       }
-    case let request as GetReferenceDocumentRequest:
+    case let request as TextDocumentContentRequest:
       self = .documentRequest(request.uri)
     case is InitializeRequest:
       self = .globalConfigurationChange

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -746,8 +746,8 @@ extension SourceKitLSPServer: MessageHandler {
       await request.reply { try await executeCommand(request.params) }
     case let request as RequestAndReply<FoldingRangeRequest>:
       await self.handleRequest(for: request, requestHandler: self.foldingRange)
-    case let request as RequestAndReply<GetReferenceDocumentRequest>:
-      await request.reply { try await getReferenceDocument(request.params) }
+    case let request as RequestAndReply<TextDocumentContentRequest>:
+      await request.reply { try await textDocumentContent(request.params) }
     case let request as RequestAndReply<HoverRequest>:
       await self.handleRequest(for: request, requestHandler: self.hover)
     case let request as RequestAndReply<ImplementationRequest>:
@@ -986,8 +986,6 @@ extension SourceKitLSPServer {
     //
     // The below is a workaround for the vscode-swift extension since it cannot set client capabilities.
     // It passes "workspace/peekDocuments" through the `initializationOptions`.
-    //
-    // Similarly, for "workspace/getReferenceDocument".
     var clientCapabilities = req.capabilities
     if case .dictionary(let initializationOptions) = req.initializationOptions {
       if let peekDocuments = initializationOptions["workspace/peekDocuments"] {
@@ -999,15 +997,6 @@ extension SourceKitLSPServer {
         }
       }
 
-      if let getReferenceDocument = initializationOptions["workspace/getReferenceDocument"] {
-        if case .dictionary(var experimentalCapabilities) = clientCapabilities.experimental {
-          experimentalCapabilities["workspace/getReferenceDocument"] = getReferenceDocument
-          clientCapabilities.experimental = .dictionary(experimentalCapabilities)
-        } else {
-          clientCapabilities.experimental = .dictionary(["workspace/getReferenceDocument": getReferenceDocument])
-        }
-      }
-
       // The client announces what CodeLenses it supports, and the LSP will only return
       // ones found in the supportedCommands dictionary.
       if let codeLens = initializationOptions["textDocument/codeLens"],
@@ -1176,7 +1165,6 @@ extension SourceKitLSPServer {
         "workspace/tests": .dictionary(["version": .int(2)]),
         "textDocument/tests": .dictionary(["version": .int(2)]),
         "workspace/triggerReindex": .dictionary(["version": .int(1)]),
-        "workspace/getReferenceDocument": .dictionary(["version": .int(1)]),
       ])
     )
   }
@@ -1744,7 +1732,7 @@ extension SourceKitLSPServer {
     return try await languageService.executeCommand(executeCommand)
   }
 
-  func getReferenceDocument(_ req: GetReferenceDocumentRequest) async throws -> GetReferenceDocumentResponse {
+  func textDocumentContent(_ req: TextDocumentContentRequest) async throws -> TextDocumentContentResponse {
     let primaryFileURI = try ReferenceDocumentURL(from: req.uri).primaryFile
 
     guard let workspace = await workspaceForDocument(uri: primaryFileURI) else {
@@ -1755,7 +1743,7 @@ extension SourceKitLSPServer {
       throw ResponseError.unknown("No Language Service for URI: \(primaryFileURI)")
     }
 
-    return try await languageService.getReferenceDocument(req)
+    return try await languageService.textDocumentContent(req)
   }
 
   func codeAction(

Sources/SourceKitLSP/Swift/MacroExpansion.swift

@@ -218,8 +218,7 @@ extension SwiftLanguageService {
     }
 
     if case .dictionary(let experimentalCapabilities) = self.capabilityRegistry.clientCapabilities.experimental,
-      case .bool(true) = experimentalCapabilities["workspace/peekDocuments"],
-      case .bool(true) = experimentalCapabilities["workspace/getReferenceDocument"]
+      case .bool(true) = experimentalCapabilities["workspace/peekDocuments"]
     {
       let expansionURIs = try macroExpansionReferenceDocumentURLs.map {
         return DocumentURI(try $0.url)

Sources/SourceKitLSP/Swift/ReferenceDocumentURL.swift

@@ -14,7 +14,7 @@ import Foundation
 import LanguageServerProtocol
 
 /// A Reference Document is a document whose url scheme is `sourcekit-lsp:` and whose content can only be retrieved
-/// using `GetReferenceDocumentRequest`. The enum represents a specific type of reference document and its
+/// using `TextDocumentContentRequest`. The enum represents a specific type of reference document and its
 /// associated value represents the data necessary to generate the document's contents and its url
 ///
 /// The `url` will be of the form: `sourcekit-lsp://<document-type>/<display-name>?<parameters>`

Sources/SourceKitLSP/Swift/SwiftLanguageService.swift

@@ -1002,13 +1002,13 @@ extension SwiftLanguageService {
     return nil
   }
 
-  package func getReferenceDocument(_ req: GetReferenceDocumentRequest) async throws -> GetReferenceDocumentResponse {
+  package func textDocumentContent(_ req: TextDocumentContentRequest) async throws -> TextDocumentContentResponse {
     let referenceDocumentURL = try ReferenceDocumentURL(from: req.uri)
 
     switch referenceDocumentURL {
     case let .macroExpansion(data):
-      return GetReferenceDocumentResponse(
-        content: try await macroExpansionManager.macroExpansion(for: data)
+      return TextDocumentContentResponse(
+        text: try await macroExpansionManager.macroExpansion(for: data)
       )
     }
   }

Tests/SourceKitLSPTests/ExpandMacroTests.swift

@@ -114,9 +114,9 @@ final class ExpandMacroTests: XCTestCase {
 
           var filesContents = [String]()
           for uri in uris {
-            let result = try await project.testClient.send(GetReferenceDocumentRequest(uri: uri))
+            let result = try await project.testClient.send(TextDocumentContentRequest(uri: uri))
 
-            filesContents.append(result.content)
+            filesContents.append(result.text)
           }
 
           XCTAssertEqual(
@@ -290,9 +290,9 @@ final class ExpandMacroTests: XCTestCase {
 
           var filesContents = [String]()
           for uri in uris {
-            let result = try await project.testClient.send(GetReferenceDocumentRequest(uri: uri))
+            let result = try await project.testClient.send(TextDocumentContentRequest(uri: uri))
 
-            filesContents.append(result.content)
+            filesContents.append(result.text)
           }
 
           XCTAssertEqual(
@@ -473,10 +473,10 @@ final class ExpandMacroTests: XCTestCase {
     try await fulfillmentOfOrThrow([outerPeekDocumentRequestReceived])
 
     let outerPeekDocumentURI = try XCTUnwrap(outerPeekDocumentsRequestURIs.value?.only)
-    let outerMacroExpansion = try await project.testClient.send(GetReferenceDocumentRequest(uri: outerPeekDocumentURI))
+    let outerMacroExpansion = try await project.testClient.send(TextDocumentContentRequest(uri: outerPeekDocumentURI))
 
-    guard outerMacroExpansion.content == "/* padding */ #intermediate" else {
-      XCTFail("Received unexpected macro expansion content: \(outerMacroExpansion.content)")
+    guard outerMacroExpansion.text == "/* padding */ #intermediate" else {
+      XCTFail("Received unexpected macro expansion content: \(outerMacroExpansion.text)")
       return
     }
 
@@ -509,11 +509,11 @@ final class ExpandMacroTests: XCTestCase {
 
     let intermediatePeekDocumentURI = try XCTUnwrap(intermediatePeekDocumentsRequestURIs.value?.only)
     let intermediateMacroExpansion = try await project.testClient.send(
-      GetReferenceDocumentRequest(uri: intermediatePeekDocumentURI)
+      TextDocumentContentRequest(uri: intermediatePeekDocumentURI)
     )
 
-    guard intermediateMacroExpansion.content == "#stringify(1 + 2)" else {
-      XCTFail("Received unexpected macro expansion content: \(intermediateMacroExpansion.content)")
+    guard intermediateMacroExpansion.text == "#stringify(1 + 2)" else {
+      XCTFail("Received unexpected macro expansion content: \(intermediateMacroExpansion.text)")
       return
     }
 
@@ -545,8 +545,8 @@ final class ExpandMacroTests: XCTestCase {
     try await fulfillmentOfOrThrow([innerPeekDocumentRequestReceived])
 
     let innerPeekDocumentURI = try XCTUnwrap(innerPeekDocumentsRequestURIs.value?.only)
-    let innerMacroExpansion = try await project.testClient.send(GetReferenceDocumentRequest(uri: innerPeekDocumentURI))
+    let innerMacroExpansion = try await project.testClient.send(TextDocumentContentRequest(uri: innerPeekDocumentURI))
 
-    XCTAssertEqual(innerMacroExpansion.content, #"(1 + 2, "1 + 2")"#)
+    XCTAssertEqual(innerMacroExpansion.text, #"(1 + 2, "1 + 2")"#)
   }
 }