Swift: add infrastructure for emitting JSON diagnostics #13012
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
New `DIAGNOSE_ERROR` and `DIAGNOSE_CRITICAL` macros are added. These accept an ID which should indicate a diagnostic source via a function definition in `codeql::diagnostics`, together with the usual format + arguments accepted by other `LOG_*` macros. When the log is flushed, these special logs will result in an error JSON diagnostic entry in the database.
redsun82
commented
May 3, 2023
swift/log/SwiftDiagnostics.h
Outdated
| namespace diagnostics { | ||
| inline void internal_error() { | ||
| SwiftDiagnosticsSource::create("internal_error", "Internal error", {}, | ||
| "Contact us about this issue"); |
There was a problem hiding this comment.
this needs rewording and proper links, but in any case it's not used yet
|
I've tested it on a dummy |
redsun82
commented
May 3, 2023
sashabu
reviewed
May 3, 2023
sashabu
suggested changes
May 3, 2023
|
@sashabu I've somewhat simplified how diagnostics source are defined, a more direct |
sashabu
suggested changes
May 4, 2023
sashabu
approved these changes
May 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New
DIAGNOSE_ERRORandDIAGNOSE_CRITICALmacros are added. These accept an ID which should indicate aSwiftDiagnosticsSourcedefinition incodeql_diagnostics, together with the usual format + arguments accepted by otherLOG_*macros. This peculiar API was somewhat conditioned by binlog's API: its macros take a category that is then stringified before usage (as opposed to accepting a string directly). In particular in order to use the category as a diagnostic source discriminant we cannot rely on any kind of evaluation giving us the category to use.When the log is flushed, these special logs will result in an error JSON diagnostic entry in the database.
Also this moves all the logging infrastructure in a common
logdirectory withinswift, as this will need to be used by thexcode-autobuilderas well.