-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Make GeneratedFileUsedEventArgs internal #9905
Make GeneratedFileUsedEventArgs internal #9905
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we then also adjust the way unrecognized events are presented in the UI so users are not confused?
This probably doesn't have correct answer :-) |
To be clear, I am not suggesting to not show the error/warning but instead of "reading errors encountered", it should probably say something like "you need a newer version to view all data in this log". If we wanted to be fancy, new events could indicate how important they are, maybe simply encoded in the numerical value so the above could have a different wording/color according to the severity. |
I like the ideas! But then decided to simplify it. As - if the update is available - user will be notified anyways. If it is not available - then it's nonstandard situation that event is unknown. |
Context
GeneratedFileUsedEventArgs
do not need to be written to binlog. It's important to have the generated file being embedded into the binlog files, other than that the event doesn't bring additional value.While forward compatibility of binlog allows us to introduce new events (or events additions) without breaking the viewer - there is still a minor impact that can confuse some users:
So it's safer to not to write the event now.
Mid-term, we should think about generalizing the event - so that it can be used for other scenarios (e.g. response file, .editorconfig file etc.), with the same structured format - #9906
Changes Made
Made
GeneratedFileUsedEventArgs
internal and dismounting sending it to the binlog (but kept the pushing of the generated file content itself - as that's the main gain brought by the feature).AddedMessage
representation of the event - for the verbouse logging viaConsoleLogger
andFileLogger
.Testing
Kept existing tests.
Manual tests with binlog viewer and ConsoleLogger and FileLogger.
FYI @KirillOsenkov