[.net8] Investigate some binlogs that break MSBuild.StructuredLogger and our tests

[dalexsoto]

The following dotnet tests had to be disabled because they break MSBuild.StructuredLogger

Xamarin.Tests.DotNetProjectTest.BuildMyCatalystApp ("maccatalyst-arm64"): System.IO.InvalidDataException : String record number 28318 is invalid: string index 1192150 is not within 13922.
Xamarin.Tests.DotNetProjectTest.BuildInterdependentBindingProjects ("macOS"): System.FormatException : One of the identified items was in an invalid format.
Xamarin.Tests.TemplateTest.CreateAndBuildProjectTemplate (ios-visualbasic): System.FormatException : One of the identified items was in an invalid format.
Xamarin.Tests.TemplateTest.CreateAndBuildProjectTemplate (macos-visualbasic): System.IO.InvalidDataException : String record number 22542 is invalid: string index 15468 is not within 10808.
Xamarin.Tests.DotNetProjectTest.BuildFatApp (MacOSX,"osx-arm64;osx-x64"): System.IO.InvalidDataException : String record number 46159 is invalid: string index 89406745 is not within 15366.
Xamarin.Tests.DotNetProjectTest.BuildEmbeddedResourcesTest ("iOS"): System.IO.InvalidDataException : String record number 19850 is invalid: string index 1929743 is not within 5761.
Xamarin.Tests.TemplateTest.CreateAndBuildProjectTemplate (macos-csharp): System.FormatException : One of the identified items was in an invalid format.

Xamarin.Tests.DotNetProjectTest.BuildFSharpLibraryTest("tvOS"): System.IO.InvalidDataException : String record number 19699 is invalid: string index 16248 is not within 5887.
Xamarin.Tests.TemplateTest.CreateAndBuildItemTemplates(iOS,FSharp): System.IO.InvalidDataException : NameValueList record number 22332 is invalid: index -7 is not within 10679.
Xamarin.Tests.BundleStructureTest.Build(MacCatalyst,"maccatalyst-x64",All,"Debug"): System.ArgumentOutOfRangeException : Ticks must be between DateTime.MinValue.Ticks and DateTime.MaxValue.Ticks. (Parameter 'ticks')
Xamarin.Tests.TemplateTest.CreateAndBuildItemTemplates(TVOS,CSharp): System.IO.InvalidDataException : String record number 21785 is invalid: string index -2 is not within 10318.
Xamarin.Tests.DotNetProjectTest.CatalystAppOptimizedForMacOS(MacOSX,"osx-x64;osx-arm64",True): System.IO.InvalidDataException : String record number 6977 is invalid: string index 991666 is not within 3666.
Xamarin.Tests.PublishTrimmedTest.DisableLinker(MacOSX,"osx-x64"): System.IO.InvalidDataException : String record number 6737 is invalid: string index 11115 is not within 3534.
Xamarin.Tests.DotNetProjectTest.CatalystAppOptimizedForMacOS(TVOS,"tvossimulator-x64",True): System.FormatException : One of the identified items was in an invalid format.
Xamarin.Tests.PostBuildTest.ArchiveTest(MacOSX,"osx-x64"): System.IO.InvalidDataException : String record number 27897 is invalid: string index 1423922 is not within 11636.
Xamarin.Tests.DotNetProjectTest.BuildCoreCLR(MacOSX,"osx-x64"): System.IO.InvalidDataException : String record number 27620 is invalid: string index 1423916 is not within 11570.
Xamarin.Tests.PostBuildTest.PublishFailureTest(TVOS,"tvossimulator-x64"): System.FormatException : One of the identified items was in an invalid format.
Xamarin.Tests.TemplateTest.CreateAndBuildItemTemplates(MacCatalyst,CSharp): System.ArgumentOutOfRangeException : Ticks must be between DateTime.MinValue.Ticks and DateTime.MaxValue.Ticks. (Parameter 'ticks')
Xamarin.Tests.DotNetProjectTest.BuildMyTVApp("tvossimulator-arm64"): System.IO.InvalidDataException : String record number 26480 is invalid: string index 74022368 is not within 12898.

Disabled them with:

Breaks MSBuild.StructuredLogger #18568

[filipnavara]

Here's one of the broken logs.
log-build-14450105_151911.binlog.zip

/cc @KirillOsenkov in case there's something obvious. By the time the decoding error shows up it already read BuildEventArgsFieldFlags with value 0x486C6 which seems wrong because only first 15 bits are defined.

[filipnavara]

The last successfully read message is BuildFinishedEventArgs. It's followed by ProjectImportArchive which may be problematic (?).

UPD: The corruption happens at the beginning of ProjectImportArchive. It reads the following bytes:

There are 5 stray bytes before the PK header of the embedded .zip file begin.

[filipnavara]

Here's the corrupted part of the .binlog stream:

Yellow is the end of "Build succeeded" message. It's followed by 0x11 (record type = ProjectImportArchive) and the size in green... then the corrupted zero bytes... followed by the actual archive data. It blows on the next record after that.

[filipnavara]

The only relevant recent change is dotnet/msbuild#9022, so adding @rainersigwald.

[filipnavara]

...and here's the root cause: https://github.com/dotnet/msbuild/pull/9022/files#r1271468212

[KirillOsenkov]

@filipnavara you are my hero

[rainersigwald]

@filipnavara you are my hero

💯, ace work, thanks!

If you can bump

https://github.com/xamarin/xamarin-macios/blob/23dfec4067843968b124acab382c901b5de44e1b/tests/dotnet/UnitTests/DotNetUnitTests.csproj#L15

to 2.1.844, you should be able to reenable the tests right away even before the MSBuild fix flows.

[KirillOsenkov]

oops I forgot to publish the NuGet package, will do it today

[KirillOsenkov]

Published: https://www.nuget.org/packages/MSBuild.StructuredLogger/2.1.844