Fix command-line binlog replay to respect minimum reader version#12775
Closed
Fix command-line binlog replay to respect minimum reader version#12775
Conversation
Contributor
|
Hello @@copilot, I noticed that you’re changing an .swr file or any file under src/Package/MSBuild.VSSetup.. Please make sure to validate this change by an experimental VS insertion. This is accomplished by pushing to an exp/* branch, which requires write permissions to this repo. |
- Set AllowForwardCompatibility = true when creating BinaryLogReplayEventSource - Made BinaryLogger.FileFormatVersion public to allow version comparison - Added warning message when log file version is newer than supported version - Only fail when minimum reader version is too high (not just newer format) Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>
- Subscribe to RecoverableReadError event to satisfy forward compatibility requirements - Output recoverable read errors as warnings to the console - Tested: binlog replay now works correctly with current version binlogs Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>
- Test that BinaryLogReplayEventSource can be configured with AllowForwardCompatibility - Test that BinaryLogger.FileFormatVersion is publicly accessible - Both tests pass successfully Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>
- Modified Replay(string, CancellationToken) to properly pass forward compatibility flag - Fixed warning message formatting to not depend on missing resource - Tested: v26 binlog with min reader 18 shows warning and continues - Tested: v26 binlog with min reader 26 correctly fails - Tested: v25 binlog works without warnings Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>
- Changed XMake to manually open BinaryReader and use the overload that respects AllowForwardCompatibility - Reverted changes to BinaryLogReplayEventSource.Replay(string, CancellationToken) to avoid test regressions - Verified: v26 with min 18 shows warning and continues - Verified: v26 with min 26 shows error and fails - Note: Pre-existing test failures in BinaryLogger_Tests are not related to these changes Co-authored-by: JanProvaznik <25267098+JanProvaznik@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix command-line log replay versioning error
Fix command-line binlog replay to respect minimum reader version
Nov 16, 2025
YuliiaKovalova
approved these changes
Dec 11, 2025
Member
|
I dislike this PR and will recreate it by a newer model |
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
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.
Fixes #(issue number needed)
Context
MSBuild throws fatal exceptions when replaying binlog files with format versions newer than supported, even when the minimum required reader version is within range. The minimum reader version field exists precisely to enable forward compatibility—older MSBuilds should read (possibly partial) logs from newer versions.
Example failure:
Changes Made
XMake.cs:
AllowForwardCompatibilityonBinaryLogReplayEventSourceRecoverableReadErrorfor graceful error handlingBinaryReaderoverload to ensure compatibility flag is respectedBinaryLogger.cs:
FileFormatVersionconstant public (was internal) for version comparisonBinaryLogger_Tests.cs:
AllowForwardCompatibilityproperty and publicFileFormatVersionaccessTesting
Verified with simulated binlog files:
Unit tests pass for new API surface.
Notes
Pre-existing test failures in
BinaryLogger_Testsare unrelated (confirmed on base commit).Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.