Skip to content

When a sourcekitd diagnostics request fails, show the request error as a diagnostic on the source file #1886

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

Merged
merged 1 commit into from
Dec 13, 2024
Merged
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
26 changes: 21 additions & 5 deletions Sources/SourceKitLSP/Swift/DiagnosticReportManager.swift
Original file line number Diff line number Diff line change
Expand Up @@ -110,11 +110,27 @@ actor DiagnosticReportManager {
keys.compilerArgs: compilerArgs as [SKDRequestValue],
])

let dict = try await self.sourcekitd.send(
skreq,
timeout: options.sourcekitdRequestTimeoutOrDefault,
fileContents: snapshot.text
)
let dict: SKDResponseDictionary
do {
dict = try await self.sourcekitd.send(
skreq,
timeout: options.sourcekitdRequestTimeoutOrDefault,
fileContents: snapshot.text
)
} catch SKDError.requestFailed(let sourcekitdError) {
var errorMessage = sourcekitdError
if errorMessage.hasPrefix("error response (Request Failed): error: ") {
errorMessage = String(errorMessage.dropFirst(40))
}
return RelatedFullDocumentDiagnosticReport(items: [
Diagnostic(
range: Position(line: 0, utf16index: 0)..<Position(line: 0, utf16index: 0),
severity: .error,
source: "SourceKit",
message: "Internal SourceKit error: \(errorMessage)"
)
])
}

try Task.checkCancellation()

Expand Down
26 changes: 26 additions & 0 deletions Tests/SourceKitLSPTests/PullDiagnosticsTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -376,4 +376,30 @@ final class PullDiagnosticsTests: XCTestCase {
let note = try XCTUnwrap(diagnostic.relatedInformation?.only)
XCTAssertEqual(note.location, try project.location(from: "1️⃣", to: "1️⃣", in: "FileA.swift"))
}

func testDiagnosticsFromSourcekitdRequestError() async throws {
let project = try await MultiFileTestProject(
files: [
"test.swift": """
func test() {}
""",
"compile_flags.txt": "-invalid-argument",
]
)
let (uri, _) = try project.openDocument("test.swift")
let diagnostics = try await project.testClient.send(
DocumentDiagnosticsRequest(textDocument: TextDocumentIdentifier(uri))
)
XCTAssertEqual(
diagnostics.fullReport?.items,
[
Diagnostic(
range: Range(Position(line: 0, utf16index: 0)),
severity: .error,
source: "SourceKit",
message: "Internal SourceKit error: unknown argument: '-invalid-argument'"
)
]
)
}
}