Skip to content

Allow clients to pass experimental capabilities they want to enable as a dictionary #2204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions Contributor Documentation/LSP Extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

SourceKit-LSP extends the LSP protocol in the following ways.

To enable some of these extensions, the client needs to communicate that it can support them. To do so, it should pass a dictionary for the `capabilities.experimental` field in the `initialize` request. For each capability to enable, it should pass an entry as follows.

```json
"<capabilityName>": {
"supported": true
}
```

## `PublishDiagnosticsClientCapabilities`

Added field (this is an extension from clangd that SourceKit-LSP re-exposes):
Expand Down
13 changes: 12 additions & 1 deletion Sources/SourceKitLSP/CapabilityRegistry.swift
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,18 @@ package final actor CapabilityRegistry {
guard case .dictionary(let experimentalCapabilities) = clientCapabilities.experimental else {
return false
}
return experimentalCapabilities[name] == .bool(true)
// Before Swift 6.3 we expected experimental client capabilities to be passed as `"capabilityName": true`.
// This proved to be insufficient for experimental capabilities that evolved over time. Since 6.3 we encourage
// clients to pass experimental capabilities as `"capabilityName": { "supported": true }`, which allows the addition
// of more configuration parameters to the capability.
switch experimentalCapabilities[name] {
case .bool(true):
return true
case .dictionary(let dict):
return dict["supported"] == .bool(true)
default:
return false
}
}

// MARK: Initializer
Expand Down
14 changes: 8 additions & 6 deletions Sources/SourceKitLSP/SourceKitLSPServer.swift
Original file line number Diff line number Diff line change
Expand Up @@ -938,12 +938,14 @@ extension SourceKitLSPServer {
guard let experimentalCapability = initializationOptions[capabilityName] else {
continue
}
if case .dictionary(var experimentalCapabilities) = clientCapabilities.experimental {
experimentalCapabilities[capabilityName] = experimentalCapability
clientCapabilities.experimental = .dictionary(experimentalCapabilities)
} else {
clientCapabilities.experimental = .dictionary([capabilityName: experimentalCapability])
}
var experimentalCapabilities: [String: LSPAny] =
if case .dictionary(let experimentalCapabilities) = clientCapabilities.experimental {
experimentalCapabilities
} else {
[:]
}
experimentalCapabilities[capabilityName] = experimentalCapability
clientCapabilities.experimental = .dictionary(experimentalCapabilities)
}

// The client announces what CodeLenses it supports, and the LSP will only return
Expand Down
4 changes: 1 addition & 3 deletions Sources/SourceKitLSP/Swift/OpenInterface.swift
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,7 @@ extension SwiftLanguageService {
nil
}

if case .dictionary(let experimentalCapabilities) = self.capabilityRegistry.clientCapabilities.experimental,
case .bool(true) = experimentalCapabilities["workspace/getReferenceDocument"]
{
if self.capabilityRegistry.clientHasExperimentalCapability(GetReferenceDocumentRequest.method) {
return GeneratedInterfaceDetails(uri: try urlData.uri, position: position)
}
let interfaceFilePath = self.generatedInterfacesPath.appendingPathComponent(urlData.displayName)
Expand Down
12 changes: 6 additions & 6 deletions Tests/SourceKitLSPTests/ExpandMacroTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ final class ExpandMacroTests: XCTestCase {
files: files,
manifest: SwiftPMTestProject.macroPackageManifest,
capabilities: ClientCapabilities(experimental: [
"workspace/peekDocuments": .bool(peekDocuments),
"workspace/getReferenceDocument": .bool(getReferenceDocument),
PeekDocumentsRequest.method: .dictionary(["supported": .bool(peekDocuments)]),
GetReferenceDocumentRequest.method: .dictionary(["supported": .bool(getReferenceDocument)]),
]),
options: SourceKitLSPOptions.testDefault(),
enableBackgroundIndexing: true
Expand Down Expand Up @@ -268,8 +268,8 @@ final class ExpandMacroTests: XCTestCase {
files: files,
manifest: SwiftPMTestProject.macroPackageManifest,
capabilities: ClientCapabilities(experimental: [
PeekDocumentsRequest.method: .bool(peekDocuments),
GetReferenceDocumentRequest.method: .bool(getReferenceDocument),
PeekDocumentsRequest.method: .dictionary(["supported": .bool(peekDocuments)]),
GetReferenceDocumentRequest.method: .dictionary(["supported": .bool(getReferenceDocument)]),
]),
options: SourceKitLSPOptions.testDefault(),
enableBackgroundIndexing: true
Expand Down Expand Up @@ -464,8 +464,8 @@ final class ExpandMacroTests: XCTestCase {
files: files,
manifest: SwiftPMTestProject.macroPackageManifest,
capabilities: ClientCapabilities(experimental: [
"workspace/peekDocuments": .bool(true),
"workspace/getReferenceDocument": .bool(true),
PeekDocumentsRequest.method: .dictionary(["supported": .bool(true)]),
GetReferenceDocumentRequest.method: .dictionary(["supported": .bool(true)]),
]),
options: SourceKitLSPOptions.testDefault(),
enableBackgroundIndexing: true
Expand Down
8 changes: 4 additions & 4 deletions Tests/SourceKitLSPTests/SwiftInterfaceTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ final class SwiftInterfaceTests: XCTestCase {
func testSystemModuleInterfaceReferenceDocument() async throws {
let testClient = try await TestSourceKitLSPClient(
capabilities: ClientCapabilities(experimental: [
"workspace/getReferenceDocument": .bool(true)
GetReferenceDocumentRequest.method: .dictionary(["supported": .bool(true)])
])
)
let uri = DocumentURI(for: .swift)
Expand Down Expand Up @@ -117,7 +117,7 @@ final class SwiftInterfaceTests: XCTestCase {
}
""",
capabilities: ClientCapabilities(experimental: [
"workspace/getReferenceDocument": .bool(true)
GetReferenceDocumentRequest.method: .dictionary(["supported": .bool(true)])
]),
indexSystemModules: true
)
Expand Down Expand Up @@ -210,7 +210,7 @@ final class SwiftInterfaceTests: XCTestCase {
)
""",
capabilities: ClientCapabilities(experimental: [
"workspace/getReferenceDocument": .bool(true)
GetReferenceDocumentRequest.method: .dictionary(["supported": .bool(true)])
]),
enableBackgroundIndexing: true
)
Expand Down Expand Up @@ -292,7 +292,7 @@ final class SwiftInterfaceTests: XCTestCase {
func testNoDiagnosticsInGeneratedInterface() async throws {
let testClient = try await TestSourceKitLSPClient(
capabilities: ClientCapabilities(experimental: [
"workspace/getReferenceDocument": .bool(true)
GetReferenceDocumentRequest.method: .dictionary(["supported": .bool(true)])
])
)
let uri = DocumentURI(for: .swift)
Expand Down
2 changes: 1 addition & 1 deletion Tests/SourceKitLSPTests/WorkspaceTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1125,7 +1125,7 @@ final class WorkspaceTests: XCTestCase {
)
""",
capabilities: ClientCapabilities(experimental: [
DidChangeActiveDocumentNotification.method: .bool(true)
DidChangeActiveDocumentNotification.method: .dictionary(["supported": .bool(true)])
]),
hooks: Hooks(
indexHooks: IndexHooks(preparationTaskDidStart: { task in
Expand Down