Skip to content

Add filtered binary log replay #961

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
KirillOsenkov merged 3 commits into from
Aug 12, 2026
Merged

Add filtered binary log replay #961

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
88d6661
Add filtered binary log replay
YuliiaKovalova Aug 11, 2026
d310dab
Fix filtered replay cleanup
YuliiaKovalova Aug 11, 2026
bdc2ba9
Address PR feedback on filtered replay
YuliiaKovalova Aug 12, 2026
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
318 changes: 318 additions & 0 deletions src/StructuredLogger.Tests/BinaryLoggerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
using System.IO;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Threading;
using FluentAssertions;
using Microsoft.Build.Framework;
using Microsoft.Build.Logging;
Expand Down Expand Up @@ -158,6 +159,177 @@ public void TestReaderWriterRoundtripEquality()
AssertFilesAreBinaryEqualAfterUnpack(binLog, replayedBinlog);
}

[Fact]
public void Replay_EventFilter_ProducesAValidCompactBinlog()
{
var metadataSeen = new List<BinaryLogEventMetadata>();
var reader = new BinLogReader
{
EventFilter = metadata =>
{
metadataSeen.Add(metadata);
return metadata.BuildEventContext == null ||
metadata.BuildEventContext.ProjectContextId == 101 ||
metadata.OriginalBuildEventContext?.ProjectContextId == 101;
}
};

string outputPath = GetTestFile("filtered-replay.binlog");
File.Delete(outputPath);

var outputLogger = new BinaryLogger
{
Parameters = $"LogFile={outputPath};OmitInitialInfo",
CollectProjectImports = BinaryLogger.ProjectImportsCollectionMode.None,
};

outputLogger.Initialize(reader);
using (var input = CreateFilteredReplayStream())
{
reader.Replay(input);
}
outputLogger.Shutdown();

metadataSeen.Should().Contain(metadata =>
metadata.RecordKind == BinaryLogRecordKind.Warning &&
metadata.BuildEventContext != null &&
metadata.BuildEventContext.ProjectContextId == 202);
metadataSeen.Should().Contain(metadata =>
metadata.RecordKind == BinaryLogRecordKind.TargetSkipped &&
metadata.OriginalBuildEventContext != null &&
metadata.OriginalBuildEventContext.ProjectContextId == 101);

var replayedEvents = new List<BuildEventArgs>();
var outputReader = new BinLogReader();
outputReader.AnyEventRaised += (_, args) => replayedEvents.Add(args);
outputReader.Replay(outputPath);

replayedEvents.Should().Contain(e =>
e.GetType() == typeof(BuildMessageEventArgs) &&
e.Message == "selected message");
replayedEvents.Should().NotContain(e => e is BuildWarningEventArgs);
replayedEvents.Should().ContainSingle(e => e is TargetSkippedEventArgs);

var replayedStrings = new List<string>();
var recordReader = new BinLogReader();
recordReader.OnStringRead += (text, _) => replayedStrings.Add(text);
using (var file = File.OpenRead(outputPath))
using (var gzip = new System.IO.Compression.GZipStream(
file,
System.IO.Compression.CompressionMode.Decompress))
using (var buffered = new BufferedStream(gzip, 32768))
{
recordReader.ReadRecordsFromDecompressedStream(buffered, includeAuxiliaryRecords: true)
.ToList();
}

replayedStrings.Should().NotContain("excluded warning");
replayedStrings.Should().NotContain("WARN");
}

[Fact]
public void Replay_EventFilter_PreservesTruncationRecoveryWhenRejectingEvents()
{
using var stream = CreateBinlogStream(withEndOfFileMarker: false);

var reader = new BinLogReader
{
EventFilter = _ => false,
};

Action replay = () => reader.Replay(stream);

replay.Should().NotThrow();
reader.HasEncounteredTruncation.Should().BeTrue();
}

[Fact]
public void Read_EventFilter_PreservesTruncationRecoveryInsideRejectedEvent()
{
byte[] full = WriteEventRecords(count: 6, withEndOfFileMarker: false);
byte[] truncated = full.Take(full.Length / 2).ToArray();

var memoryStream = new MemoryStream(truncated);
var binaryReader = new BinaryReader(memoryStream);
using var reader = new Logging.StructuredLogger.BuildEventArgsReader(
binaryReader,
BinaryLogger.FileFormatVersion);

Action read = () =>
{
while (reader.Read(_ => false) != null)
{
}
};

read.Should().NotThrow();
reader.ReachedEndOfStreamPrematurely.Should().BeTrue();
}

[Fact]
public void Replay_EventFilter_RetainsRequiredCulturePreamble()
{
using var stream = CreateCulturePreambleStream();
AssertCulturePreambleRetained(stream);
}

[Fact]
public void Replay_EventFilter_RetainsRequiredCulturePreambleForLegacyFormat()
{
using var stream = CreateCulturePreambleStream(fileFormatVersion: 14);
AssertCulturePreambleRetained(stream);
}

private static void AssertCulturePreambleRetained(Stream stream)
{
var replayedEvents = new List<BuildEventArgs>();
var reader = new BinLogReader
{
EventFilter = _ => false,
};
reader.AnyEventRaised += (_, args) => replayedEvents.Add(args);

reader.Replay(stream);

var cultureMessages = replayedEvents
.OfType<BuildMessageEventArgs>()
.Where(message =>
message.SenderName == "BinaryLogger" &&
message.Message.StartsWith("CurrentUICulture", StringComparison.Ordinal))
.ToList();
cultureMessages.Should().ContainSingle();
}

[Fact]
public void Replay_EventFilter_PropagatesFilterExceptionsWithoutLeakingWorkers()
{
var expected = new InvalidOperationException("filter failed");
ThreadPool.GetAvailableThreads(out int availableWorkersBefore, out _);

for (int i = 0; i < 8; i++)
{
using var stream = CreateFilteredReplayStream();
var reader = new BinLogReader
{
EventFilter = _ => throw expected,
};

Action replay = () => reader.Replay(stream);

replay.Should().Throw<InvalidOperationException>().Which.Should().BeSameAs(expected);
}

bool workersReleased = SpinWait.SpinUntil(
() =>
{
ThreadPool.GetAvailableThreads(out int availableWorkersAfter, out _);
return availableWorkersAfter >= availableWorkersBefore;
},
TimeSpan.FromSeconds(5));

workersReleased.Should().BeTrue("filter failures must not leave replay workers blocked");
}

private static void AssertFilesAreBinaryEqualAfterUnpack(string firstPath, string secondPath)
{
using var br1 = Logging.StructuredLogger.BinaryLogReplayEventSource.OpenReader(firstPath);
Expand Down Expand Up @@ -648,6 +820,152 @@ private static Stream CreateBinlogStream(bool withEndOfFileMarker)
return compressed;
}

private static Stream CreateFilteredReplayStream()
{
var selectedContext = new BuildEventContext(1, 1, 1, 1, 101, 11, 111);
var excludedContext = new BuildEventContext(1, 1, 2, 2, 202, 22, 222);
var skippedContext = new BuildEventContext(1, 1, 3, 3, 303, 33, 333);

var selectedMessage = new BuildMessageEventArgs(
"selected message", "Help", "Sender", MessageImportance.Normal)
{
BuildEventContext = selectedContext,
};

var excludedWarning = new BuildWarningEventArgs(
"Subcategory", "WARN", "File.cs", 1, 2, 3, 4,
"excluded warning", "Help", "Sender")
{
BuildEventContext = excludedContext,
};

var targetSkipped = new TargetSkippedEventArgs("target skipped")
{
BuildEventContext = skippedContext,
OriginalBuildEventContext = selectedContext,
TargetName = "SkippedTarget",
TargetFile = "Targets.targets",
ProjectFile = "Project.csproj",
BuildReason = TargetBuiltReason.DependsOn,
SkipReason = TargetSkipReason.PreviouslyBuiltSuccessfully,
OriginallySucceeded = true,
};

var decompressed = new MemoryStream();
var binaryWriter = new BinaryWriter(decompressed);
binaryWriter.Write(BinaryLogger.FileFormatVersion);
binaryWriter.Write(BinaryLogger.FileFormatVersion);

var writer = new BuildEventArgsWriter(binaryWriter);
writer.Write(new BuildStartedEventArgs("Build started", helpKeyword: null));
writer.Write(selectedMessage);
writer.Write(excludedWarning);
writer.Write(targetSkipped);
writer.Write(new BuildFinishedEventArgs("Build finished", helpKeyword: null, succeeded: true));
binaryWriter.Flush();
decompressed.WriteByte((byte)BinaryLogRecordKind.EndOfFile);
decompressed.Position = 0;

var compressed = new MemoryStream();
using (var gzip = new System.IO.Compression.GZipStream(
compressed,
System.IO.Compression.CompressionLevel.Optimal,
leaveOpen: true))
{
decompressed.CopyTo(gzip);
}

compressed.Position = 0;
return compressed;
}

private static Stream CreateCulturePreambleStream(
int fileFormatVersion = BinaryLogger.FileFormatVersion)
{
var framedRecords = new MemoryStream();
var framedWriter = new BinaryWriter(framedRecords);
var writer = new BuildEventArgsWriter(framedWriter);
writer.Write(new BuildMessageEventArgs(
"CurrentUICulture=en-US",
helpKeyword: null,
senderName: "BinaryLogger",
importance: MessageImportance.Low));
writer.Write(new BuildMessageEventArgs(
"filtered message",
helpKeyword: null,
senderName: "Sender",
importance: MessageImportance.Normal));
framedWriter.Flush();
framedRecords.WriteByte((byte)BinaryLogRecordKind.EndOfFile);
framedRecords.Position = 0;

var decompressed = new MemoryStream();
var binaryWriter = new BinaryWriter(decompressed);
binaryWriter.Write(fileFormatVersion);
if (fileFormatVersion >= BinaryLogger.ForwardCompatibilityMinimalVersion)
{
binaryWriter.Write(fileFormatVersion);
framedRecords.CopyTo(decompressed);
}
else
{
CopyRecordsWithoutLengths(framedRecords, binaryWriter);
}

binaryWriter.Flush();
decompressed.Position = 0;

var compressed = new MemoryStream();
using (var gzip = new System.IO.Compression.GZipStream(
compressed,
System.IO.Compression.CompressionLevel.Optimal,
leaveOpen: true))
{
decompressed.CopyTo(gzip);
}

compressed.Position = 0;
return compressed;
}

private static void CopyRecordsWithoutLengths(
Stream framedRecords,
BinaryWriter legacyWriter)
{
using var framedReader = new BinaryReader(framedRecords);

while (true)
{
int recordKindValue = Serialization.Read7BitEncodedInt(framedReader);
var recordKind = (BinaryLogRecordKind)recordKindValue;
Serialization.Write7BitEncodedInt(legacyWriter, recordKindValue);

if (recordKind == BinaryLogRecordKind.EndOfFile)
{
return;
}

if (recordKind == BinaryLogRecordKind.String)
{
legacyWriter.Write(framedReader.ReadString());
continue;
}

recordKind.Should().Be(
BinaryLogRecordKind.Message,
"the legacy culture test stream contains only strings and messages");

int recordLength = Serialization.Read7BitEncodedInt(framedReader);
byte[] record = framedReader.ReadBytes(recordLength);
if (record.Length != recordLength)
{
throw new EndOfStreamException();
}

legacyWriter.Write(record);
}
}

private static BuildEventArgs CreateEvent(int i) => (i % 3) switch
{
0 => new BuildMessageEventArgs($"message {i} with a reasonably long payload so records span several bytes", "Help", "Sender", MessageImportance.Normal),
Expand Down
Loading