Add support for jump to definition (#95)

iMostfa · web-flow · commit 40792383f4db · 2025-11-30T16:34:30.000+01:00
* Initial logic, still need to :w so it works * Refactoring the logic * Send request that we finished * Modify Package.swift to point to master of sourcekit-lsp * Revert "Send request that we finished" This reverts commit 65d4159. * More Changes to be able to use latest upstream
diff --git a/Example/.vscode/settings.json b/Example/.vscode/settings.json
@@ -10,4 +10,4 @@
             ]
         }
     }
-}
+}
diff --git a/Package.swift b/Package.swift
@@ -16,13 +16,22 @@ let package = Package(
         .macOS(.v15),
     ],
     dependencies: [
+        .package(
+            url:
+            "https://github.com/swiftlang/swift-tools-protocols",
+            revision: "f86b413a803761408e5e718912c46d75a340801b"
+        ),
+
         .package(
             url: "https://github.com/apple/swift-argument-parser",
             revision: "1.5.0"
         ),
         .package(
-            url: "https://github.com/rockbruno/sourcekit-lsp",
-            revision: "c052baae81ec6532bb2f939a21acc4650fb1dc86"
+            url: "https://github.com/swiftlang/sourcekit-lsp",
+            revision: "0e061c5c1075152bc2e6187679a11b81d0c3e326" // latest main commit November 29, 2025
+            // TODO: Ideally it would be better to upstream these changes to sourceKit-lsp
+            // url: "https://github.com/rockbruno/sourcekit-lsp",
+            // revision: "c052baae81ec6532bb2f939a21acc4650fb1dc86"
         ),
         .package(
             url: "https://github.com/apple/swift-protobuf.git",
@@ -44,18 +53,22 @@ let package = Package(
             name: "SourceKitBazelBSP",
             dependencies: [
                 "BazelProtobufBindings",
+                .product(
+                    name: "LanguageServerProtocolTransport",
+                    package: "swift-tools-protocols"
+                ),
                 .product(
                     name: "BuildServerProtocol",
-                    package: "sourcekit-lsp"
+                    package: "swift-tools-protocols"
                 ),
                 .product(
-                    name: "LSPBindings",
-                    package: "sourcekit-lsp"
+                    name: "ToolsProtocolsSwiftExtensions",
+                    package: "swift-tools-protocols"
                 ),
                 .product(
                     name: "ArgumentParser",
                     package: "swift-argument-parser"
-                )
+                ),
             ],
         ),
         .testTarget(
@@ -71,7 +84,7 @@ let package = Package(
         .target(
             name: "BazelProtobufBindings",
             dependencies: [
-                .product(name: "SwiftProtobuf", package: "swift-protobuf")
+                .product(name: "SwiftProtobuf", package: "swift-protobuf"),
             ],
             exclude: [
                 "README.md",
@@ -87,6 +100,6 @@ let package = Package(
                 .copy("Resources/actions.pb"),
                 .copy("Resources/streamdeps.pb"),
             ],
-        )
+        ),
     ]
 )
diff --git a/Sources/SourceKitBazelBSP/RequestHandlers/InitializeHandler.swift b/Sources/SourceKitBazelBSP/RequestHandlers/InitializeHandler.swift
@@ -204,10 +204,10 @@ final class InitializeHandler {
             data: SourceKitInitializeBuildResponseData(
                 indexDatabasePath: initializedConfig.indexDatabasePath,
                 indexStorePath: initializedConfig.indexStorePath,
-                multiTargetPreparation: MultiTargetPreparationSupport(
-                    supported: true,
-                    batchSize: batchSize
-                ),
+//                multiTargetPreparation: MultiTargetPreparationSupport(
+//                    supported: true,
+//                    batchSize: batchSize
+//                ),
                 outputPathsProvider: nil,
                 prepareProvider: true,
                 sourceKitOptionsProvider: true,
diff --git a/Sources/SourceKitBazelBSP/RequestHandlers/TargetSourcesHandler.swift b/Sources/SourceKitBazelBSP/RequestHandlers/TargetSourcesHandler.swift
@@ -27,7 +27,6 @@ private let logger = makeFileLevelBSPLogger()
 ///
 /// Returns the sources for the provided target based on previously gathered information.
 final class TargetSourcesHandler {
-
     private let initializedConfig: InitializedServerConfig
     private let targetStore: BazelTargetStore
 
@@ -38,7 +37,7 @@ final class TargetSourcesHandler {
 
     func buildTargetSources(
         _ request: BuildTargetSourcesRequest,
-        _ id: RequestID
+        _: RequestID
     ) throws -> BuildTargetSourcesResponse {
         let targets = request.targets
         logger.info("Fetching sources for \(targets.count, privacy: .public) targets")
@@ -62,10 +61,40 @@ final class TargetSourcesHandler {
         return BuildTargetSourcesResponse(items: srcs)
     }
 
+    private func computeCopyDestinations(for src: URI) -> [DocumentURI]? {
+        guard let srcPath = src.fileURL?.path else {
+            return nil
+        }
+
+        var destinations: [DocumentURI] = []
+
+        let workspaceRoot = initializedConfig.rootUri
+        let execRoot = initializedConfig.executionRoot
+
+        func trimmedRelativePath(fullPath: String, base: String) -> String {
+            var relativePath = fullPath.dropFirst(base.count)
+            if relativePath.first == "/" {
+                relativePath = relativePath.dropFirst()
+            }
+            return String(relativePath)
+        }
+
+        if srcPath.hasPrefix(workspaceRoot) {
+            // Workspace file -> single execroot location Bazel copies to.
+            // We need to tell the LSP about the path of each file in execution root to later help it mapping it again to original Workspace path.
+            let relativePath = trimmedRelativePath(fullPath: srcPath, base: workspaceRoot)
+            let destination = DocumentURI(filePath: execRoot + "/" + relativePath, isDirectory: false)
+            destinations.append(destination)
+        }
+
+        return destinations.isEmpty ? nil : destinations
+    }
+
     func convertToSourceItems(_ targetSrcs: [URI]) -> [SourceItem] {
         var result: [SourceItem] = []
         for src in targetSrcs {
             let srcString = src.stringValue
+            let copyDestinations = computeCopyDestinations(for: src)
             let kind: SourceKitSourceItemKind
             if srcString.hasSuffix("h") {
                 kind = .header
@@ -84,12 +113,13 @@ final class TargetSourcesHandler {
                 SourceItem(
                     uri: src,
                     kind: .file,
-                    generated: false,  // FIXME: Need to handle this properly
+                    generated: false, // FIXME: Need to handle this properly
                     dataKind: .sourceKit,
                     data: SourceKitSourceItemData(
                         language: language,
                         kind: kind,
-                        outputPath: nil  // FIXME: Related to the same flag on initialize?
+                        outputPath: nil, // FIXME: Related to the same flag on initialize?
+                        copyDestinations: copyDestinations
                     ).encodeToLSPAny()
                 )
             )
diff --git a/Sources/SourceKitBazelBSP/Server/LSPConnection.swift b/Sources/SourceKitBazelBSP/Server/LSPConnection.swift
@@ -20,7 +20,7 @@
 import BuildServerProtocol
 import Foundation
 import LanguageServerProtocol
-import LanguageServerProtocolJSONRPC
+import LanguageServerProtocolTransport
 
 package protocol LSPTaskLogger: AnyObject {
     func startWorkTask(id: TaskId, title: String)
@@ -30,15 +30,22 @@ package protocol LSPTaskLogger: AnyObject {
 /// Extends the original sourcekit-lsp `Connection` type to include JSONRPCConnection's start method
 /// and task logging utilities.
 package protocol LSPConnection: Connection, LSPTaskLogger, AnyObject {
-    func start(receiveHandler: MessageHandler, closeHandler: @escaping @Sendable () async -> Void)
+    func startJSONRPC(receiveHandler: MessageHandler, closeHandler: @escaping @Sendable () async -> Void)
 }
 
 extension JSONRPCConnection: LSPConnection {
+    package func startJSONRPC(
+        receiveHandler: any LanguageServerProtocol.MessageHandler,
+        closeHandler: @escaping @Sendable () async -> Void
+    ) {
+        self.start(receiveHandler: receiveHandler, closeHandler: closeHandler as nonisolated(nonsending) @Sendable () async -> Void)
+    }
+
     package func startWorkTask(id: TaskId, title: String) {
         send(TaskStartNotification(taskId: id, data: WorkDoneProgressTask(title: title).encodeToLSPAny()))
     }
 
     package func finishTask(id: TaskId, status: StatusCode) {
-        send(TaskFinishNotification(taskId: id, status: .ok, ))
+        send(TaskFinishNotification(taskId: id, status: status))
     }
 }
diff --git a/Sources/SourceKitBazelBSP/Server/SourceKitBazelBSPServer.swift b/Sources/SourceKitBazelBSP/Server/SourceKitBazelBSPServer.swift
@@ -20,7 +20,7 @@
 import BuildServerProtocol
 import Foundation
 import LanguageServerProtocol
-import LanguageServerProtocolJSONRPC
+import LanguageServerProtocolTransport
 
 private let logger = makeFileLevelBSPLogger()
 
@@ -130,7 +130,7 @@ package final class SourceKitBazelBSPServer {
     package func run(parkThread: Bool = true) {
         logger.info("Connecting to sourcekit-lsp...")
 
-        connection.start(
+        connection.startJSONRPC(
             receiveHandler: handler,
             closeHandler: {
                 logger.info("Connection closed, exiting.")
diff --git a/Tests/SourceKitBazelBSPTests/BSPMessageHandlerTests.swift b/Tests/SourceKitBazelBSPTests/BSPMessageHandlerTests.swift
@@ -20,7 +20,7 @@
 import BuildServerProtocol
 import Foundation
 import LanguageServerProtocol
-import LanguageServerProtocolJSONRPC
+import LanguageServerProtocolTransport
 import Testing
 
 @testable import SourceKitBazelBSP
diff --git a/Tests/SourceKitBazelBSPTests/BazelTargetCompilerArgsExtractorTests.swift b/Tests/SourceKitBazelBSPTests/BazelTargetCompilerArgsExtractorTests.swift
@@ -20,7 +20,7 @@
 import BuildServerProtocol
 import Foundation
 import LanguageServerProtocol
-import LanguageServerProtocolJSONRPC
+import LanguageServerProtocolTransport
 import Testing
 
 @testable import SourceKitBazelBSP
diff --git a/Tests/SourceKitBazelBSPTests/Fakes/LSPConnectionFake.swift b/Tests/SourceKitBazelBSPTests/Fakes/LSPConnectionFake.swift
@@ -19,17 +19,16 @@
 
 import BuildServerProtocol
 import LanguageServerProtocol
-import LanguageServerProtocolJSONRPC
+import LanguageServerProtocolTransport
 
 @testable import SourceKitBazelBSP
 
 final class LSPConnectionFake: LSPConnection {
-
     nonisolated(unsafe) private(set) var startCalled = false
     nonisolated(unsafe) private(set) var startReceivedHandler: MessageHandler?
     nonisolated(unsafe) private(set) var sentNotifications: [any NotificationType] = []
 
-    func start(receiveHandler: MessageHandler, closeHandler: @escaping @Sendable () async -> Void) {
+    func startJSONRPC(receiveHandler: MessageHandler, closeHandler: @escaping @Sendable () async -> Void) {
         startCalled = true
         startReceivedHandler = receiveHandler
     }
diff --git a/Tests/SourceKitBazelBSPTests/SourceKitBazelBSPServerTests.swift b/Tests/SourceKitBazelBSPTests/SourceKitBazelBSPServerTests.swift
@@ -19,7 +19,7 @@
 
 import BuildServerProtocol
 import LanguageServerProtocol
-import LanguageServerProtocolJSONRPC
+import LanguageServerProtocolTransport
 import Testing
 
 @testable import SourceKitBazelBSP

Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,4 @@`
`10`	`10`	`]`
`11`	`11`	`}`
`12`	`12`	`}`
`13`		`-}`
	`13`	`+}`