use a helper document in cursorInfo()

Author: matthewbastien

Sources/BuildSystemIntegration/FileBuildSettings.swift

@@ -55,7 +55,15 @@ package struct FileBuildSettings: Equatable, Sendable {
   ///
   /// This patches the arguments by searching for the argument corresponding to
   /// `originalFile` and replacing it.
-  func patching(newFile: DocumentURI, originalFile: DocumentURI) -> FileBuildSettings {
+  package func patching(newFile: DocumentURI, originalFile: DocumentURI) -> FileBuildSettings {
+    return patching(newFile: newFile.pseudoPath, originalFile: originalFile)
+  }
+
+  /// Return arguments suitable for use by `newFile`.
+  ///
+  /// This patches the arguments by searching for the argument corresponding to
+  /// `originalFile` and replacing it.
+  package func patching(newFile: String, originalFile: DocumentURI) -> FileBuildSettings {
     var arguments = self.compilerArguments
     // URL.lastPathComponent is only set for file URLs but we want to also infer a file extension for non-file URLs like
     // untitled:file.cpp
@@ -66,7 +74,7 @@ package struct FileBuildSettings: Equatable, Sendable {
       // the file system.
       $0.hasSuffix(basename) && originalFile.pseudoPath.hasSuffix($0)
     }) {
-      arguments[index] = newFile.pseudoPath
+      arguments[index] = newFile
       // The `-x<lang>` flag needs to be before the possible `-c <header file>`
       // argument in order for Clang to respect it. If there is a pre-existing `-x`
       // flag though, Clang will honor that one instead since it comes after.

Sources/DocCDocumentation/DocCDocumentationManager.swift

@@ -159,7 +159,7 @@ package struct DocCDocumentationManager: Sendable {
   ) async throws -> DoccDocumentationResponse {
     // Make inputs consumable by DocC
     var externalIDsToConvert: [String]? = nil
-    var overridingDocumentationComments = [String: [String]]()
+    var overridingDocumentationComments: [String: [String]] = [:]
     if let symbolUSR {
       externalIDsToConvert = [symbolUSR]
       if let overrideDocComments {

Sources/SKTestSupport/TestSourceKitLSPClient.swift

@@ -425,6 +425,11 @@ package final class TestSourceKitLSPClient: MessageHandler, Sendable {
 
     return DocumentPositions(markers: markers, textWithoutMarkers: textWithoutMarkers)
   }
+
+  /// Closes the document with the given URI.
+  package func closeDocument(uri: DocumentURI) {
+    self.send(DidCloseTextDocumentNotification(textDocument: TextDocumentIdentifier(uri)))
+  }
 }
 
 // MARK: - DocumentPositions

Sources/SourceKitLSP/Documentation/DoccDocumentationHandler.swift

@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 #if canImport(DocCDocumentation)
+import BuildSystemIntegration
 import DocCDocumentation
 import Foundation
 @preconcurrency import IndexStoreDB

Sources/SourceKitLSP/Rename.swift

@@ -355,7 +355,7 @@ extension SwiftLanguageService {
     let req = sourcekitd.dictionary([
       keys.request: sourcekitd.requests.nameTranslation,
       keys.sourceFile: snapshot.uri.pseudoPath,
-      keys.compilerArgs: await self.buildSettings(for: snapshot.uri, fallbackAfterTimeout: false)?.compilerArgs
+      keys.compilerArgs: await self.compileCommand(for: snapshot.uri, fallbackAfterTimeout: false)?.compilerArgs
         as [SKDRequestValue]?,
       keys.offset: snapshot.utf8Offset(of: snapshot.position(of: symbolLocation)),
       keys.nameKind: sourcekitd.values.nameSwift,
@@ -407,7 +407,7 @@ extension SwiftLanguageService {
     let req = sourcekitd.dictionary([
       keys.request: sourcekitd.requests.nameTranslation,
       keys.sourceFile: snapshot.uri.pseudoPath,
-      keys.compilerArgs: await self.buildSettings(for: snapshot.uri, fallbackAfterTimeout: false)?.compilerArgs
+      keys.compilerArgs: await self.compileCommand(for: snapshot.uri, fallbackAfterTimeout: false)?.compilerArgs
         as [SKDRequestValue]?,
       keys.offset: snapshot.utf8Offset(of: snapshot.position(of: symbolLocation)),
       keys.nameKind: sourcekitd.values.nameObjc,

Sources/SourceKitLSP/Swift/CodeCompletion.swift

@@ -23,7 +23,7 @@ extension SwiftLanguageService {
     let completionPos = await adjustPositionToStartOfIdentifier(req.position, in: snapshot)
     let filterText = String(snapshot.text[snapshot.index(of: completionPos)..<snapshot.index(of: req.position)])
 
-    let buildSettings = await buildSettings(for: snapshot.uri, fallbackAfterTimeout: false)
+    let compileCommand = await compileCommand(for: snapshot.uri, fallbackAfterTimeout: false)
 
     let inferredIndentationWidth = BasicFormat.inferIndentation(of: await syntaxTreeManager.syntaxTree(for: snapshot))
 
@@ -34,7 +34,7 @@ extension SwiftLanguageService {
       indentationWidth: inferredIndentationWidth,
       completionPosition: completionPos,
       cursorPosition: req.position,
-      compileCommand: buildSettings,
+      compileCommand: compileCommand,
       clientCapabilities: capabilityRegistry.clientCapabilities,
       filterText: filterText
     )

Sources/SourceKitLSP/Swift/CursorInfo.swift

@@ -10,6 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
+import BuildSystemIntegration
 import Csourcekitd
 import LanguageServerProtocol
 import SKLogging
@@ -121,13 +122,62 @@ extension CursorInfoError: CustomStringConvertible {
 }
 
 extension SwiftLanguageService {
+  fileprivate func openHelperDocument(_ snapshot: DocumentSnapshot) async throws {
+    let skreq = sourcekitd.dictionary([
+      keys.request: self.requests.editorOpen,
+      keys.name: snapshot.uri.pseudoPath,
+      keys.sourceText: snapshot.text,
+      keys.syntacticOnly: 1,
+    ])
+    _ = try await sendSourcekitdRequest(skreq, fileContents: snapshot.text)
+  }
+
+  fileprivate func closeHelperDocument(_ snapshot: DocumentSnapshot) async {
+    let skreq = sourcekitd.dictionary([
+      keys.request: requests.editorClose,
+      keys.name: snapshot.uri.pseudoPath,
+      keys.cancelBuilds: 0,
+    ])
+    _ = await orLog("Close helper document for cursor info") {
+      try await sendSourcekitdRequest(skreq, fileContents: snapshot.text)
+    }
+  }
+
+  /// Ensures that the snapshot is open in sourcekitd before calling body(_:).
+  ///
+  /// - Parameters:
+  ///   - uri: The URI of the document to be opened.
+  ///   - body: A closure that accepts the DocumentSnapshot as a parameter.
+  fileprivate func withSnapshot<Result>(
+    uri: DocumentURI,
+    _ body: (_ snapshot: DocumentSnapshot) async throws -> Result
+  ) async throws -> Result where Result: Sendable {
+    let documentManager = try self.documentManager
+    let snapshot = try await self.latestSnapshotOrDisk(for: uri)
+
+    // If the document is not opened in the DocumentManager then send an open
+    // request to sourcekitd.
+    guard documentManager.openDocuments.contains(uri) else {
+      try await openHelperDocument(snapshot)
+      defer {
+        Task { await closeHelperDocument(snapshot) }
+      }
+      return try await body(snapshot)
+    }
+    return try await body(snapshot)
+  }
+
   /// Provides detailed information about a symbol under the cursor, if any.
   ///
   /// Wraps the information returned by sourcekitd's `cursor_info` request, such as symbol name,
   /// USR, and declaration location. This request does minimal processing of the result.
   ///
+  /// Ensures that the document is actually open in sourcekitd before sending the request. If not,
+  /// then the document will be opened for the duration of the request so that sourcekitd does not
+  /// have to read from disk.
+  ///
   /// - Parameters:
-  ///   - url: Document URI in which to perform the request. Must be an open document.
+  ///   - url: Document URI in which to perform the request.
   ///   - range: The position range within the document to lookup the symbol at.
   ///   - includeSymbolGraph: Whether or not to ask sourcekitd for the complete symbol graph.
   ///   - fallbackSettingsAfterTimeout: Whether fallback build settings should be used for the cursor info request if no
@@ -139,46 +189,46 @@ extension SwiftLanguageService {
     fallbackSettingsAfterTimeout: Bool,
     additionalParameters appendAdditionalParameters: ((SKDRequestDictionary) -> Void)? = nil
   ) async throws -> (cursorInfo: [CursorInfo], refactorActions: [SemanticRefactorCommand], symbolGraph: String?) {
-    let documentManager = try self.documentManager
-    let snapshot = try await self.latestSnapshotOrDisk(for: uri)
-
-    let offsetRange = snapshot.utf8OffsetRange(of: range)
-
-    let keys = self.keys
-
-    let skreq = sourcekitd.dictionary([
-      keys.request: requests.cursorInfo,
-      keys.cancelOnSubsequentRequest: 0,
-      keys.offset: offsetRange.lowerBound,
-      keys.length: offsetRange.upperBound != offsetRange.lowerBound ? offsetRange.count : nil,
-      keys.sourceFile: snapshot.uri.sourcekitdSourceFile,
-      keys.primaryFile: snapshot.uri.primaryFile?.pseudoPath,
-      keys.retrieveSymbolGraph: includeSymbolGraph ? 1 : 0,
-      keys.compilerArgs: await self.buildSettings(for: uri, fallbackAfterTimeout: fallbackSettingsAfterTimeout)?
-        .compilerArgs as [SKDRequestValue]?,
-    ])
-
-    appendAdditionalParameters?(skreq)
-
-    let dict = try await sendSourcekitdRequest(skreq, fileContents: snapshot.text)
-
-    var cursorInfoResults: [CursorInfo] = []
-    if let cursorInfo = CursorInfo(dict, documentManager: documentManager, sourcekitd: sourcekitd) {
-      cursorInfoResults.append(cursorInfo)
+    try await withSnapshot(uri: uri) { snapshot in
+      let documentManager = try self.documentManager
+      let offsetRange = snapshot.utf8OffsetRange(of: range)
+
+      let keys = self.keys
+
+      let skreq = sourcekitd.dictionary([
+        keys.request: requests.cursorInfo,
+        keys.cancelOnSubsequentRequest: 0,
+        keys.offset: offsetRange.lowerBound,
+        keys.length: offsetRange.upperBound != offsetRange.lowerBound ? offsetRange.count : nil,
+        keys.sourceFile: snapshot.uri.sourcekitdSourceFile,
+        keys.primaryFile: snapshot.uri.primaryFile?.pseudoPath,
+        keys.retrieveSymbolGraph: includeSymbolGraph ? 1 : 0,
+        keys.compilerArgs: await self.compileCommand(for: uri, fallbackAfterTimeout: fallbackSettingsAfterTimeout)?
+          .compilerArgs as [SKDRequestValue]?,
+      ])
+
+      appendAdditionalParameters?(skreq)
+
+      let dict = try await sendSourcekitdRequest(skreq, fileContents: snapshot.text)
+
+      var cursorInfoResults: [CursorInfo] = []
+      if let cursorInfo = CursorInfo(dict, documentManager: documentManager, sourcekitd: sourcekitd) {
+        cursorInfoResults.append(cursorInfo)
+      }
+      cursorInfoResults +=
+        dict[keys.secondarySymbols]?
+        .compactMap { CursorInfo($0, documentManager: documentManager, sourcekitd: sourcekitd) } ?? []
+      let refactorActions =
+        [SemanticRefactorCommand](
+          array: dict[keys.refactorActions],
+          range: range,
+          textDocument: TextDocumentIdentifier(uri),
+          keys,
+          self.sourcekitd.api
+        ) ?? []
+      let symbolGraph: String? = dict[keys.symbolGraph]
+
+      return (cursorInfoResults, refactorActions, symbolGraph)
     }
-    cursorInfoResults +=
-      dict[keys.secondarySymbols]?
-      .compactMap { CursorInfo($0, documentManager: documentManager, sourcekitd: sourcekitd) } ?? []
-    let refactorActions =
-      [SemanticRefactorCommand](
-        array: dict[keys.refactorActions],
-        range: range,
-        textDocument: TextDocumentIdentifier(uri),
-        keys,
-        self.sourcekitd.api
-      ) ?? []
-    let symbolGraph: String? = dict[keys.symbolGraph]
-
-    return (cursorInfoResults, refactorActions, symbolGraph)
   }
 }

Sources/SourceKitLSP/Swift/DoccDocumentation.swift

@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 #if canImport(DocCDocumentation)
+import BuildSystemIntegration
 import DocCDocumentation
 import Foundation
 package import LanguageServerProtocol
@@ -125,9 +126,7 @@ fileprivate struct DocumentableSymbol {
       }
     }
   }
-}
 
-fileprivate extension DocumentableSymbol {
   static func findNearestSymbol(syntaxTree: SourceFileSyntax, position: AbsolutePosition) -> DocumentableSymbol? {
     guard let token = syntaxTree.token(at: position) else {
       return nil

Sources/SourceKitLSP/Swift/GeneratedInterfaceManager.swift

@@ -119,7 +119,7 @@ actor GeneratedInterfaceManager {
       keys.groupName: document.groupName,
       keys.name: document.sourcekitdDocumentName,
       keys.synthesizedExtension: 1,
-      keys.compilerArgs: await swiftLanguageService.buildSettings(for: try document.uri, fallbackAfterTimeout: false)?
+      keys.compilerArgs: await swiftLanguageService.compileCommand(for: try document.uri, fallbackAfterTimeout: false)?
         .compilerArgs as [SKDRequestValue]?,
     ])
 

Sources/SourceKitLSP/Swift/MacroExpansion.swift

@@ -88,16 +88,16 @@ actor MacroExpansionManager {
     }
 
     let snapshot = try await swiftLanguageService.latestSnapshot(for: uri)
-    let buildSettings = await swiftLanguageService.buildSettings(for: uri, fallbackAfterTimeout: false)
+    let compileCommand = await swiftLanguageService.compileCommand(for: uri, fallbackAfterTimeout: false)
 
     if let cacheEntry = cache.first(where: {
-      $0.snapshotID == snapshot.id && $0.range == range && $0.buildSettings == buildSettings
+      $0.snapshotID == snapshot.id && $0.range == range && $0.buildSettings == compileCommand
     }) {
       return cacheEntry.value
     }
-    let macroExpansions = try await macroExpansionsImpl(in: snapshot, at: range, buildSettings: buildSettings)
+    let macroExpansions = try await macroExpansionsImpl(in: snapshot, at: range, buildSettings: compileCommand)
     cache.insert(
-      CacheEntry(snapshot: snapshot, range: range, buildSettings: buildSettings, value: macroExpansions),
+      CacheEntry(snapshot: snapshot, range: range, buildSettings: compileCommand, value: macroExpansions),
       at: 0
     )