Skip to content

Fix ObjectDisposedException race condition in TimestampedFileLogger #53241

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
marcpopMSFT merged 3 commits into from
Mar 4, 2026
Merged

Fix ObjectDisposedException race condition in TimestampedFileLogger #53241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3dea47a
Initial plan
Copilot Mar 3, 2026
694af54
Initial plan
Copilot Mar 3, 2026
adf4fc4
Fix ObjectDisposedException race condition in TimestampedFileLogger.W…
Copilot Mar 3, 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
13 changes: 12 additions & 1 deletion src/Cli/dotnet/Installer/Windows/TimestampedFileLogger.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,18 @@ protected override void WriteMessage(string message)
{
if (!_messageQueue.IsAddingCompleted)
{
_messageQueue.Add(message);
try
{
_messageQueue.Add(message);
Comment on lines 177 to +181
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IsAddingCompleted check is still a TOCTOU gate (state can change immediately after the check). Since Add is now wrapped to handle disposal/completion races, consider removing the IsAddingCompleted check (or including it inside the try/catch) and just attempt the Add, dropping messages on InvalidOperationException/ObjectDisposedException. This reduces duplicated branching and eliminates an extra race window.

Copilot uses AI. Check for mistakes.
}
catch (ObjectDisposedException)
{
// The logger was disposed between the IsAddingCompleted check and Add.
}
catch (InvalidOperationException)
{
// CompleteAdding was called between the IsAddingCompleted check and Add.
}
Comment on lines +179 to +190
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is intended to prevent unhandled exceptions when Dispose() races with background logging threads. Please add a regression test that disposes the TimestampedFileLogger while one or more threads are concurrently calling LogMessage/WriteMessage, and asserts the operation completes without throwing (and optionally that logging stops cleanly).

Copilot uses AI. Check for mistakes.
}
}
}
2 changes: 1 addition & 1 deletion src/Microsoft.CodeAnalysis.NetAnalyzers/src/Microsoft.CodeAnalysis.NetAnalyzers.sarif
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7092,4 +7092,4 @@
}
}
]
}
}
Loading