fix: false positive for guarded call to LoggerMessage#52306
Open
Thomas-Shephard wants to merge 7 commits intodotnet:mainfrom
Open
fix: false positive for guarded call to LoggerMessage#52306Thomas-Shephard wants to merge 7 commits intodotnet:mainfrom
Thomas-Shephard wants to merge 7 commits intodotnet:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a false positive in the CA1873 analyzer where logging calls guarded by IsEnabled checks were incorrectly flagged when using LoggerMessage attribute-based logging methods.
Key Changes
- Updated
AreInvocationsOnSameInstancemethod to recognize when a LoggerMessage method and an IsEnabled check are using the same logger instance - Added special handling for both static LoggerMessage methods (with explicit logger parameter) and instance LoggerMessage methods (with captured logger from class members)
- Added test coverage for guarded LoggerMessage scenarios
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| AvoidPotentiallyExpensiveCallWhenLogging.cs | Enhanced logger instance matching logic to support LoggerMessage patterns, including heuristic for instance methods that capture loggers from class fields/properties/constructor parameters |
| AvoidPotentiallyExpensiveCallWhenLoggingTests.cs | Added test case for guarded LoggerMessage calls using both instance and static patterns with primary constructor parameters |
...nalyzers/Microsoft.NetCore.Analyzers/Performance/AvoidPotentiallyExpensiveCallWhenLogging.cs
Show resolved
Hide resolved
a4f9c9c to
bacda6c
Compare
This was referenced Jan 4, 2026
stephentoub
reviewed
Feb 15, 2026
|
|
||
| if (loggerParameter is not null) | ||
| { | ||
| var argument = invocation1.Arguments.GetArgumentForParameterAtIndex(loggerParameter.Ordinal); |
Member
There was a problem hiding this comment.
Could this throw / crash if the code isn't well formed when the analyzer runs?
Author
There was a problem hiding this comment.
Good point, hopefully the latest commit should do the trick
3 tasks
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.
Summary
Fixes a bug in the CA1873 analyzer where logging calls that were guarded by
IsEnabledwere being incorrectly flagged when usingLoggerMessage.Problem
The analyzer was not associating the
Iloggerinstance used in theIsEnabledcheck with the one used inLoggerMessagecausing false positives even when the code was being guarded correctly.Fixes #50893
Fix
Updated the
AreInvocationsOnSameInstancelogic to correctly identify whether this is the case.Testing
Added a new test
GuardedLoggerMessage_NoDiagnostic_CSand ensured all existing tests continue to pass