Fix CA1862 false positive with same variable on both sides of comparison

dotnet · Dec 23, 2024 · fa98aa7 · fa98aa7
1 parent 5ed3367
commit fa98aa7
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 0 deletions.
diff --git a/...rosoft.NetCore.Analyzers/Performance/RecommendCaseInsensitiveStringComparison.Analyzer.cs b/...rosoft.NetCore.Analyzers/Performance/RecommendCaseInsensitiveStringComparison.Analyzer.cs
@@ -322,6 +322,15 @@ private static void AnalyzeBinaryOperation(OperationAnalysisContext context, IBi
                 return;
             }
 
+            // If using the same parameter on both sides of the binary operation, don't emit a diagnostic.
+            var lParam = GetParameter(binaryOperation.LeftOperand);
+            var rParam = GetParameter(binaryOperation.RightOperand);
+
+            if (lParam is not null && lParam == rParam)
+            {
+                return;
+            }
+
             ImmutableDictionary<string, string?> dict = new Dictionary<string, string?>()
                 {
                     { LeftOffendingMethodName, leftOffendingMethodName },
@@ -380,5 +389,15 @@ private static bool IsOffendingMethod(IInvocationOperation invocation, ITypeSymb
             offendingMethodName = invocation.TargetMethod.Name;
             return true;
         }
+
+        private static IParameterSymbol? GetParameter(IOperation op)
+        {
+            return op switch
+            {
+                IParameterReferenceOperation paramRefOp => paramRefOp.Parameter,
+                IInvocationOperation invocationOp => GetParameter(invocationOp.Children.FirstOrDefault()),
+                _ => null,
+            };
+        }
     }
 }
diff --git a/...ft.NetCore.Analyzers/Performance/RecommendCaseInsensitiveStringComparison.CSharp.Tests.cs b/...ft.NetCore.Analyzers/Performance/RecommendCaseInsensitiveStringComparison.CSharp.Tests.cs
@@ -431,6 +431,30 @@ void M(string s)
             }.RunAsync();
         }
 
+        [Theory]
+        [InlineData("s != s.ToLowerInvariant()")]
+        [InlineData("s.ToLower() == s")]
+        [InlineData("s.ToUpperInvariant() == s.ToUpper()")]
+        [InlineData("s.ToLower().ToUpper() != s")]
+        [WorkItem(7074, "https://github.com/dotnet/roslyn-analyzers/issues/7074")]
+        public async Task NoDiagnostic_SameParameterOnBothSidesOfComparison(string expression)
+        {
+            var originalCode = $$"""
+                using System;
+
+                class C
+                {
+                    void M(string s)
+                    {
+                        if ({{expression}})
+                            Console.WriteLine("string comparison was true");
+                    }
+                }
+                """;
+
+            await VerifyNoDiagnosticCSharpAsync(originalCode);
+        }
+
         private async Task VerifyNoDiagnosticCSharpAsync(string originalSource)
         {
             VerifyCS.Test test = new()