Skip to content

Fix S2629 FP: Constant fields in interpolated string #9384

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
mary-georgiou-sonarsource merged 2 commits into from
Jun 4, 2024
Merged

Fix S2629 FP: Constant fields in interpolated string #9384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a5ef7c
fix FP
mary-georgiou-sonarsource Jun 4, 2024
06ca6d5
Cayc
mary-georgiou-sonarsource Jun 4, 2024
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
4 changes: 2 additions & 2 deletions analyzers/src/SonarAnalyzer.CSharp/Rules/UseConstantLoggingTemplate.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ protected override void Initialize(SonarAnalysisContext context) =>
&& ArgumentValue(invocation, method, messageParameter) is { } argumentValue
&& InvalidSyntaxNode(argumentValue, c.SemanticModel) is { } invalidNode)
{
c.ReportIssue(Diagnostic.Create(Rule, invalidNode.GetLocation(), Messages[invalidNode.Kind()]));
c.ReportIssue(Rule, invalidNode.GetLocation(), Messages[invalidNode.Kind()]);
}
},
SyntaxKind.InvocationExpression);
Expand All @@ -114,7 +114,7 @@ private static CSharpSyntaxNode ArgumentValue(InvocationExpressionSyntax invocat

private static SyntaxNode InvalidSyntaxNode(SyntaxNode messageArgument, SemanticModel model) =>
messageArgument.DescendantNodesAndSelf().FirstOrDefault(x =>
x.Kind() == SyntaxKind.InterpolatedStringExpression
(x as InterpolatedStringExpressionSyntax is { } interpolatedString && !interpolatedString.HasConstantValue(model))
|| (x is BinaryExpressionSyntax { RawKind: (int)SyntaxKind.AddExpression } concatenation && !AllMembersAreConstantStrings(concatenation, model))
|| IsStringFormatInvocation(x, model));

Expand Down
2 changes: 1 addition & 1 deletion analyzers/tests/SonarAnalyzer.Test/TestCases/UseConstantLoggingTemplate.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public void BasicScenarios(ILogger logger, int arg)
logger.Log(LogLevel.Warning, "First " + "Second " + "Third"); // Compliant - all strings in the concatenation are constants, the compiler can optimize it
logger.Log(LogLevel.Warning, FieldConstant + localConstant); // Compliant
logger.Log(LogLevel.Warning, FieldConstant + "Second"); // Compliant
logger.Log(LogLevel.Warning, $"Constant: {FieldConstant}"); // Noncompliant FP Repro https://github.com/SonarSource/sonar-dotnet/issues/9247
logger.Log(LogLevel.Warning, $"Constant: {FieldConstant}"); // Compliant, see https://github.com/SonarSource/sonar-dotnet/issues/9247
logger.Log(LogLevel.Warning, "First " + arg + "Third"); // Noncompliant
logger.Log(LogLevel.Warning, ("First " + "Second").ToLower()); // FN

Expand Down