averello/sourcekit-lsp
1
0
Fork 0
mirror of https://github.com/apple/sourcekit-lsp.git synced 2026-03-02 18:23:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add structure to the index logs

Browse Source 
When the client supports it, communicate the structure of tasks that were stared during background indexing or by the build server to the client. If there are multiple operations happening in parallel, this allows the client to display them in separate log tracks instead of interspersing them with the emoji prefixes like we do today.
This commit is contained in:
Alex Hoppen
2025-02-28 14:42:51 -08:00
parent bafd8babc1
commit 655a93f05a
22 changed files with 441 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
Sources/BuildSystemIntegration/SwiftPMBuildSystem.swift
View File

@@ -188,9 +188,23 @@ package actor SwiftPMBuildSystem: BuiltInBuildSystem {
self.testHooks = testHooks
self.connectionToSourceKitLSP = connectionToSourceKitLSP
// Start an open-ended log for messages that we receive during package loading. We never end this log.
let logTaskID = "swiftpm-log-\(UUID())"
connectionToSourceKitLSP.send(
OnBuildLogMessageNotification(
type: .info,
message: "",
structure: .begin(StructuredLogBegin(title: "SwiftPM log for \(projectRoot.path)", taskID: logTaskID))
)
)
self.observabilitySystem = ObservabilitySystem({ scope, diagnostic in
connectionToSourceKitLSP.send(
OnBuildLogMessageNotification(type: .info, task: TaskId(id: "swiftpm-log"), message: diagnostic.description)
OnBuildLogMessageNotification(
type: .info,
message: diagnostic.description,
structure: .report(StructuredLogReport(taskID: logTaskID))
)
)
logger.log(level: diagnostic.severity.asLogLevel, "SwiftPM log: \(diagnostic.description)")
})
@@ -638,12 +652,6 @@ package actor SwiftPMBuildSystem: BuiltInBuildSystem {
return VoidResponse()
}
private nonisolated func logMessageToIndexLog(_ taskID: TaskId, _ message: String) {
connectionToSourceKitLSP.send(
BuildServerProtocol.OnBuildLogMessageNotification(type: .info, task: taskID, message: message)
)
}
private func prepare(singleTarget target: BuildTargetIdentifier) async throws {
if target == .forPackageManifest {
// Nothing to prepare for package manifests.
@@ -698,15 +706,36 @@ package actor SwiftPMBuildSystem: BuiltInBuildSystem {
let start = ContinuousClock.now
let taskID: TaskId = TaskId(id: "preparation-\(preparationTaskID.fetchAndIncrement())")
logMessageToIndexLog(
taskID,
"""
Preparing \(self.swiftPMTargets[target]?.name ?? target.uri.stringValue)
\(arguments.joined(separator: " "))
"""
connectionToSourceKitLSP.send(
BuildServerProtocol.OnBuildLogMessageNotification(
type: .info,
message: "\(arguments.joined(separator: " "))",
structure: .begin(
StructuredLogBegin(
title: "Preparing \(self.swiftPMTargets[target]?.name ?? target.uri.stringValue)",
taskID: taskID.id
)
)
)
)
let stdoutHandler = PipeAsStringHandler { self.logMessageToIndexLog(taskID, $0) }
let stderrHandler = PipeAsStringHandler { self.logMessageToIndexLog(taskID, $0) }
let stdoutHandler = PipeAsStringHandler { message in
self.connectionToSourceKitLSP.send(
BuildServerProtocol.OnBuildLogMessageNotification(
type: .info,
message: message,
structure: .report(StructuredLogReport(taskID: taskID.id))
)
)
}
let stderrHandler = PipeAsStringHandler { message in
self.connectionToSourceKitLSP.send(
BuildServerProtocol.OnBuildLogMessageNotification(
type: .info,
message: message,
structure: .report(StructuredLogReport(taskID: taskID.id))
)
)
}
let result = try await Process.run(
arguments: arguments,
@@ -717,7 +746,13 @@ package actor SwiftPMBuildSystem: BuiltInBuildSystem {
)
)
let exitStatus = result.exitStatus.exhaustivelySwitchable
logMessageToIndexLog(taskID, "Finished with \(exitStatus.description) in \(start.duration(to: .now))")
self.connectionToSourceKitLSP.send(
BuildServerProtocol.OnBuildLogMessageNotification(
type: exitStatus.isSuccess ? .info : .error,
message: "Finished with \(exitStatus.description) in \(start.duration(to: .now))",
structure: .end(StructuredLogEnd(taskID: taskID.id))
)
)
switch exitStatus {
case .terminated(code: 0):
break