[Microsoft.Gen.Logging] Clear thread-local state when logging throws - #7682
Merged
Conversation
Fixes dotnet#7634 Clear LoggerMessageHelper.ThreadLocalState in a finally block to prevent stale structured fields from leaking into subsequent log calls. Add regression coverage for throwing ILogger implementations.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Microsoft.Gen.Logging source generator to always clear LoggerMessageHelper.ThreadLocalState even when ILogger.Log throws, preventing stale structured fields from leaking into subsequent log calls on the same thread.
Changes:
- Wrap generated thread-local state usage in
try/finallyand clear state in thefinallyblock. - Add new generated logging test methods to reproduce the leak scenario.
- Add a regression test that uses a throwing
ILoggerand then validates the next log does not observe staleRequestId.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| test/Generators/Microsoft.Gen.Logging/TestClasses/ArgTestExtensions.cs | Adds new [LoggerMessage] methods used by tests to exercise structured state reuse across calls. |
| test/Generators/Microsoft.Gen.Logging/Generated/LogMethodTests.cs | Adds a regression test (throwing logger + capturing logger) to validate state cleanup behavior. |
| src/Generators/Microsoft.Gen.Logging/Emission/Emitter.Method.cs | Changes emitted code to clear thread-local state in a finally block. |
rafal-mz
approved these changes
Aug 6, 2026
evgenyfedorov2
approved these changes
Aug 6, 2026
dariusclay
approved these changes
Aug 6, 2026
dariusclay
approved these changes
Aug 6, 2026
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 #7634
Clear LoggerMessageHelper.ThreadLocalState in a finally block to prevent stale structured fields from leaking into subsequent log calls.
Add regression coverage for throwing ILogger implementations.
Microsoft Reviewers: Open in CodeFlow