[WIP] Capture code snippet from diagnostic compiler output #9362
Conversation
* Built tentative test class SwiftBuildSystemOutputParser to handle the compiler output specifically * Added a handleDiagnostic method to possibly substitute the emitEvent local scope implementation of handling a SwiftBuildMessage diagnostic
* the flag `appendToOutputStream` helps us to determine whether a diagnostic is to be emitted or whether we'll be emitting the compiler output via OutputInfo * separate the emitEvent method into the SwiftBuildSystemMessageHandler
| emitInfoAsDiagnostic(info: info) | ||
| } | ||
| case .output(let info): | ||
| let parsedOutput = String(decoding: info.data, as: UTF8.self) |
There was a problem hiding this comment.
One consideration here: I don't think output messages are guaranteed to be split at character boundaries. So for example, we could emit two output messages, with the last byte of one message being the first byte of a 2-byte character and the second message having the second byte of that character. And then this String(decoding:) call might mangle the character.
I think it's also possible we receive something like (output message) -> (progress update message) -> (output message) which could split the output at arbitrary points.
Maybe when we receive an output message, we should append to a per-task buffer, then only decode it as a string and emit the output when the taskComplete message arrives?
There was a problem hiding this comment.
Good point, I've found this to be the case with some light local testing as well -- I'll give the per-task buffer a shot!
2 participants
SwiftBuildSystemOutputParserSwiftBuildSystemMessageHandlerto handle the compiler output specificallyemitEventmethod into theSwiftBuildSystemMessageHandlerDiagnosticInfodepending on whether the flagappendToOutputStreamis true.OutputInfowill capture the compiler output with the code snippet + fixits, so emit diagnostics withappendToOutputStreamset to false here insteadTODO:
Properly identify diagnostic-related output; much of theSwiftBuildMessage.OutputInfodoes not pertain to diagnostic-related code snippetsAssess whether separation ofemitEventhandling would be better-suited within the SwiftBuildSystemOutputParser; if so, to consolidate behaviour for this classSwiftBuildSystemMessageHandlerfor variousSwiftBuildMessagetypes