[DocC Live Preview] Support parameter and return type disambiguations #2216
Conversation
…cument/doccDocumentation` requests
matthewbastien
requested review from
ahoppen,
bnbarham,
hamishknight and
rintaro
as code owners
|
Depends on PR from swift-docc: swiftlang/swift-docc#1253 |
|
@swift-ci please test |
| else { | ||
| throw ResponseError.internalError("Unable to find Swift language service for \(location.documentUri)") | ||
| } | ||
| return try await languageService.withSnapshotFromDiskOpenedInSourcekitd( |
There was a problem hiding this comment.
If I understand correctly, we run multiple cursor info requests for a single docc request, right? Wit this implementation we need to open a new sourcekitd document for every request, which means that we also need to build as many ASTs, which is really the expensive part for the cursor info request. Would it be possible to only open each document once?
There was a problem hiding this comment.
This is correct. I can cache the snapshots instead of throwing them away, but that will require a rework of withSnapshotFromDiskOpenedInSourcekitd(uri:fallbackSettingsAfterTimeout:body:). I'll see how feasible that is.
FWIW I don't expect there to be too many lookups, but it'll only get worse with the size of the project and the number of colliding symbol names...
Sources/SourceKitLSP/Documentation/DoccDocumentationHandler.swift
Outdated
Show resolved
Hide resolved
| for occurrence in topLevelSymbolOccurrences { | ||
| let info = try await doccSymbolInformation(ofUSR: occurrence.symbol.usr, fetchSymbolGraph: fetchSymbolGraph) | ||
| if let info, info.matches(symbolLink) { | ||
| result.append(occurrence) | ||
| } | ||
| // If we have exactly one component left, check to see if it's the module name | ||
| if components.count == 1 { | ||
| let lastComponent = components.removeLast() | ||
| guard lastComponent.name == topLevelSymbolOccurrence.location.moduleName else { | ||
| return false | ||
| } | ||
| } | ||
| // Ensure that this is deterministic by sorting the results | ||
| result.sort() |
There was a problem hiding this comment.
Could this be just a filter?
| for occurrence in topLevelSymbolOccurrences { | |
| let info = try await doccSymbolInformation(ofUSR: occurrence.symbol.usr, fetchSymbolGraph: fetchSymbolGraph) | |
| if let info, info.matches(symbolLink) { | |
| result.append(occurrence) | |
| } | |
| // If we have exactly one component left, check to see if it's the module name | |
| if components.count == 1 { | |
| let lastComponent = components.removeLast() | |
| guard lastComponent.name == topLevelSymbolOccurrence.location.moduleName else { | |
| return false | |
| } | |
| } | |
| // Ensure that this is deterministic by sorting the results | |
| result.sort() | |
| let result = try await topLevelSymbolOccurrences.asyncFilter { occurrence in | |
| let info = try await doccSymbolInformation(ofUSR: occurrence.symbol.usr, fetchSymbolGraph: fetchSymbolGraph) | |
| return info?.matches(symbolLink) ?? false | |
| }.sorted() |
There was a problem hiding this comment.
I wanted to use asyncFilter(_:), but got the following error when I tried it:
Capture of 'self' with non-Sendable type 'CheckedIndex' in a '@Sendable' closure
and it doesn't look like we can easily make CheckedIndex conform to Sendable.
Adds support for parameter and return type disambiguations to
textDocument/doccDocumentationrequests. See the docc documentation for more info.The information for parameter and return types of functions does not exist in the index. So, we have to fetch the symbol graph from sourcekitd in order to get all of the info we need. This adds some overhead, but not enough to cause any significant performance impacts in my testing.