Skip to content
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

Jump to bottom

Fix false positive for CA1854 across instances #7309

Merged
merged 3 commits into from
Oct 16, 2024
Merged

Fix false positive for CA1854 across instances #7309

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
fb87fa2
Fix false positive for CA1854 across instances
CollinAlpert May 10, 2024
af2b39a
Merge branch 'main' into issue-7295
CollinAlpert Oct 15, 2024
e15cd4a
Apply PR feedback
CollinAlpert Oct 15, 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
18 changes: 16 additions & 2 deletions ...t.NetCore.Analyzers/Performance/PreferDictionaryTryMethodsOverContainsKeyGuardAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,9 +556,9 @@ private static bool IsSameReferenceOperation(IOperation? sourceReference, IOpera
case IParameterReferenceOperation source when targetReference is IParameterReferenceOperation target:
return target.Parameter.Equals(source.Parameter, SymbolEqualityComparer.Default);
case IFieldReferenceOperation source when targetReference is IFieldReferenceOperation target:
return target.Field.Equals(source.Field, SymbolEqualityComparer.Default);
return target.Field.Equals(source.Field, SymbolEqualityComparer.Default) && AreInstancesEqual(source, target);
case IPropertyReferenceOperation source when targetReference is IPropertyReferenceOperation target:
return target.Property.Equals(source.Property, SymbolEqualityComparer.Default);
return target.Property.Equals(source.Property, SymbolEqualityComparer.Default) && AreInstancesEqual(source, target);
Copy link
Contributor

@buyaa-n buyaa-n Oct 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I would expect to add something like && source.Instance == target.Instance, but it doesn't work.

Comparing string representation looks bit weird, though don't see any other way (no action needed here)

case IMemberReferenceOperation source when targetReference is IMemberReferenceOperation target:
return target.Member.Equals(source.Member, SymbolEqualityComparer.Default);
case IArrayElementReferenceOperation source when targetReference is IArrayElementReferenceOperation target:
Expand Down Expand Up @@ -607,6 +607,20 @@ private static IEnumerable<IOperation> GetNonConditionalDescendantsAndSelf(IOper
return[operation, .. childOperations];
}

private static bool AreInstancesEqual(IOperation instance1, IOperation instance2)
{
string syntax1 = instance1.Syntax
.ToString()
.Replace("this.", string.Empty)
.Replace("Me.", string.Empty);
string syntax2 = instance2.Syntax
.ToString()
.Replace("this.", string.Empty)
.Replace("Me.", string.Empty);

return syntax1 == syntax2;
}

private enum SearchContext
{
None = 0,
Expand Down
117 changes: 117 additions & 0 deletions ...tTests/Microsoft.NetCore.Analyzers/Performance/PreferDictionaryTryGetValueMethodsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1821,6 +1821,123 @@ public class DbContext
return VerifyCS.VerifyAnalyzerAsync(code);
}

[Fact, WorkItem(7295, "https://github.com/dotnet/roslyn-analyzers/issues/7295")]
public Task WhenDifferentPropertyInstanceContainingDictionary_NoDiagnostic()
{
const string code = """
using System;
using System.Collections.Generic;

class Test
{
private Dictionary<int, int> PermissionsData => throw null;

void M(int objId) {
Test otherTest = new Test();
if (PermissionsData.ContainsKey(objId))
{
Console.WriteLine(otherTest.PermissionsData[objId]);
}
}
}
""";

return VerifyCS.VerifyAnalyzerAsync(code);
}

[Fact, WorkItem(7295, "https://github.com/dotnet/roslyn-analyzers/issues/7295")]
public Task WhenDifferentFieldInstanceContainingDictionary_NoDiagnostic()
{
const string code = """
using System;
using System.Collections.Generic;

class Test
{
private Dictionary<int, int> permissionsData;

void M(int objId) {
Test otherTest = new Test();
if (permissionsData.ContainsKey(objId))
{
Console.WriteLine(otherTest.permissionsData[objId]);
}
}
}
""";

return VerifyCS.VerifyAnalyzerAsync(code);
}

[Fact, WorkItem(7295, "https://github.com/dotnet/roslyn-analyzers/issues/7295")]
public Task WhenDifferentLocalInstancesContainingDictionary_NoDiagnostic()
{
const string code = """
using System;
using System.Collections.Generic;

class Test
{
private Dictionary<int, int> permissionsData;

void M(int objId) {
Test test1 = new Test();
Test test2 = new Test();
if (test1.permissionsData.ContainsKey(objId))
{
Console.WriteLine(test2.permissionsData[objId]);
}
}
}
""";

return VerifyCS.VerifyAnalyzerAsync(code);
}

[Fact, WorkItem(7295, "https://github.com/dotnet/roslyn-analyzers/issues/7295")]
public Task WhenReferencingSameInstanceWithThisQualifier_Diagnostic()
{
const string code = """
using System;
using System.Collections.Generic;

class Test
{
private Dictionary<int, int> permissionsData;

void M(int objId) {
if ({|#0:permissionsData.ContainsKey(objId)|})
{
Console.WriteLine({|#1:this.permissionsData[objId]|});
}
}
}
""";

const string fixedCode = """
using System;
using System.Collections.Generic;

class Test
{
private Dictionary<int, int> permissionsData;

void M(int objId) {
if (permissionsData.TryGetValue(objId, out int value))
{
Console.WriteLine(value);
}
}
}
""";

var result = new DiagnosticResult(PreferDictionaryTryMethodsOverContainsKeyGuardAnalyzer.PreferTryGetValueDiagnostic)
.WithLocation(0)
.WithLocation(1);

return VerifyCS.VerifyCodeFixAsync(code, result, fixedCode);
}

private static string CreateCSharpCode(string content)
{
return string.Format(CultureInfo.InvariantCulture, CSharpTemplate, content);
Expand Down