Skip to content

Fix the read global properties backcompat issue #743

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

Merged
merged 1 commit into from
Jan 10, 2024
Merged

Fix the read global properties backcompat issue #743

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 10 additions & 5 deletions src/StructuredLogger/BinaryLogger/BuildEventArgsReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -724,7 +724,12 @@ private BuildEventArgs ReadProjectEvaluationFinishedEventArgs()
if (_fileFormatVersion >= 12)
{
IEnumerable globalProperties = null;
if (ReadBoolean())
// In newer versions, we store the global properties always, as it handles
// null and empty within WriteProperties already.
// This saves a single boolean, but mainly doesn't hide the difference between null and empty
// during write->read roundtrip.
if (_fileFormatVersion >= BinaryLogger.ForwardCompatibilityMinimalVersion ||
ReadBoolean())
{
globalProperties = ReadStringDictionary();
}
Expand Down Expand Up @@ -778,12 +783,12 @@ private BuildEventArgs ReadProjectStartedEventArgs()

if (_fileFormatVersion > 6)
{
if (_fileFormatVersion < BinaryLogger.ForwardCompatibilityMinimalVersion)
// See ReadProjectEvaluationFinishedEventArgs for details on why we always store global properties in newer version.
if (_fileFormatVersion >= BinaryLogger.ForwardCompatibilityMinimalVersion ||
ReadBoolean())
{
// Throw away, but need to advance past it
ReadBoolean();
globalProperties = ReadStringDictionary();
}
globalProperties = ReadStringDictionary();
}

var propertyList = ReadPropertyList();
Expand Down