Skip to content

Capture code snippet from diagnostic compiler output #9362

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.

Sign up for GitHub

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
bripeticca wants to merge 22 commits into
base: main
Choose a base branch
from
+669 −193
Open

Capture code snippet from diagnostic compiler output #9362

Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
235dd3e
Forray into capturing swift compiler output logs
bripeticca Nov 5, 2025
f9dfdf3
Revert usage of JSON parser; selectively emit DiagnosticInfo
bripeticca Nov 11, 2025
b1ff231
Implement per-task-buffer of Data output
bripeticca Nov 13, 2025
ac6b81b
Fallback to locationContext if locationContext2 properties are nil
bripeticca Nov 13, 2025
1ae0f38
Merge branch 'main' into swb/diagnosticcodesnippet
bripeticca Nov 13, 2025
b81bfca
Cleanup; add descriptions related to redundant task output
bripeticca Nov 13, 2025
f3aaabf
attempt to parse decoded string into individual diagnostics
bripeticca Nov 20, 2025
c48e606
cleanup
bripeticca Nov 20, 2025
f14600c
Revert diagnostic parsing and emit directly to outputStream
bripeticca Nov 21, 2025
359331a
Address PR comments
bripeticca Nov 21, 2025
56f0a45
implement generic print method for observability scope
bripeticca Nov 24, 2025
dd1505a
Introduce model to store data buffer per task type
bripeticca Nov 25, 2025
08306e2
minor changes to TaskDataBuffer + cleanup
bripeticca Nov 25, 2025
424492f
Modify emission of command line display strings
bripeticca Nov 27, 2025
4074c59
cleanup; stronger assertions for redundant task output
bripeticca Nov 27, 2025
05ee043
Fix protocol adherence errors
bripeticca Dec 2, 2025
7a00f35
Address PR comments
bripeticca Dec 4, 2025
e88ab96
Fix check on global task for LocationContext
bripeticca Dec 5, 2025
5f0911d
Track serialized diagnostic path by targetID
bripeticca Dec 5, 2025
8f713a0
Merge branch 'main' into swb/diagnosticcodesnippet
bripeticca Dec 5, 2025
fd21a42
Add FIXME + richer model to track emitted tasks
bripeticca Dec 8, 2025
7a91843
Merge branch 'main' into swb/diagnosticcodesnippet
bripeticca Dec 8, 2025
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
14 changes: 14 additions & 0 deletions Sources/Basics/Observability.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ public class ObservabilitySystem {
func handleDiagnostic(scope: ObservabilityScope, diagnostic: Diagnostic) {
self.underlying(scope, diagnostic)
}

func printToOutput(message: String) {
self.diagnosticsHandler.printToOutput(message: message)
}
}

public static var NOOP: ObservabilityScope {
Expand Down Expand Up @@ -128,6 +132,10 @@ public final class ObservabilityScope: DiagnosticsEmitterProtocol, Sendable, Cus
return parent?.errorsReportedInAnyScope ?? false
}

public func print(message: String) {
self.diagnosticsHandler.printToOutput(message: message)
}

// DiagnosticsEmitterProtocol
public func emit(_ diagnostic: Diagnostic) {
var diagnostic = diagnostic
Expand All @@ -150,6 +158,10 @@ public final class ObservabilityScope: DiagnosticsEmitterProtocol, Sendable, Cus
self.underlying.handleDiagnostic(scope: scope, diagnostic: diagnostic)
}

public func printToOutput(message: String) {
self.underlying.printToOutput(message: message)
}

var errorsReported: Bool {
self._errorsReported.get() ?? false
}
Expand All @@ -160,6 +172,8 @@ public final class ObservabilityScope: DiagnosticsEmitterProtocol, Sendable, Cus

public protocol DiagnosticsHandler: Sendable {
func handleDiagnostic(scope: ObservabilityScope, diagnostic: Diagnostic)

func printToOutput(message: String)
Copy link
Contributor

@jakepetroules jakepetroules Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Call this func print(_ output: String, verbose: Bool) instead? Since we already have a viable implementation.

Copy link
Contributor

@bkhouri bkhouri Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's the DiagnosticHandlers responsibility to print the diagnostic here. We should instead have a "LoggingHandler" which would know where to emit the "message", whether it's to stdout, stderr, to a file, or some other place.

Copy link
Contributor

@bkhouri bkhouri Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: the function name is a bit misleading. Where if the output going to? to a file, stdout, stderr, somewhere else? can we please update the function name to make this more explicit?

Copy link
Contributor Author

@bripeticca bripeticca Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function is meant to be a temporary workaround given that we are emitting diagnostics from the compiler output accumulated as one string blob, and observability scope usually demands a severity along with this despite the fact that these diagnostics could very possibly have differing severities.

It's a little hacky but I'm hoping that future discussion surrounding how we'd like to architect logging will improve this :)

}

/// Helper protocol to share default behavior.
Expand Down
6 changes: 6 additions & 0 deletions Sources/CoreCommands/SwiftCommandObservabilityHandler.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,12 @@ public struct SwiftCommandObservabilityHandler: ObservabilityHandlerProvider {
}
}

func printToOutput(message: String) {
self.queue.async(group: self.sync) {
self.write(message)
}
}

// for raw output reporting
func print(_ output: String, verbose: Bool) {
self.queue.async(group: self.sync) {
Expand Down
Loading