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

Do not suggest passing IFormatProvider to certain Convert methods #7244

Merged
merged 3 commits into from
Aug 30, 2024
Merged

Do not suggest passing IFormatProvider to certain Convert methods #7244

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
233b8d4
Do not suggest passing IFormatProvider to certain Convert methods
CollinAlpert Mar 13, 2024
f92614a
Merge branch 'main' into issue-7154
CollinAlpert Aug 30, 2024
65a0697
Implement PR suggestions
CollinAlpert Aug 30, 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
26 changes: 23 additions & 3 deletions src/NetAnalyzers/Core/Microsoft.NetCore.Analyzers/Runtime/SpecifyIFormatProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// Copyright (c) Microsoft. All Rights Reserved. Licensed under the MIT license. See License.txt in the project root for license information.

using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
Expand Down Expand Up @@ -147,8 +148,6 @@ protected override void InitializeWorker(CompilationStartAnalysisContext context
GetParameterInfo(stringType),
GetParameterInfo(objectType, isArray: true, arrayRank: 1, isParams: true));

var currentCultureProperty = cultureInfoType.GetMembers("CurrentCulture").OfType<IPropertySymbol>().FirstOrDefault();
var invariantCultureProperty = cultureInfoType.GetMembers("InvariantCulture").OfType<IPropertySymbol>().FirstOrDefault();
var currentUICultureProperty = cultureInfoType.GetMembers("CurrentUICulture").OfType<IPropertySymbol>().FirstOrDefault();
var installedUICultureProperty = cultureInfoType.GetMembers("InstalledUICulture").OfType<IPropertySymbol>().FirstOrDefault();

Expand All @@ -165,6 +164,27 @@ protected override void InitializeWorker(CompilationStartAnalysisContext context

var guidParseMethods = guidType?.GetMembers("Parse") ?? ImmutableArray<ISymbol>.Empty;

var convertType = typeProvider.GetOrCreateTypeByMetadataName(WellKnownTypeNames.SystemConvert);
var superfluousConvertToStringFormatProviderOverloads = convertType?.GetMembers(nameof(Convert.ToString))
.OfType<IMethodSymbol>()
.Where(m => m.IsStatic
&& m.Parameters is [{ Type.SpecialType: SpecialType.System_String or SpecialType.System_Boolean or SpecialType.System_Char }, var possibleFormatProvider]
&& possibleFormatProvider.Type.Equals(iformatProviderType, SymbolEqualityComparer.Default)) ?? [];
var superfluousConvertToToCharFormatProviderOverloads = convertType?.GetMembers(nameof(Convert.ToChar))
.OfType<IMethodSymbol>()
.Where(m => m.IsStatic
&& m.Parameters is [{ Type.SpecialType: SpecialType.System_String }, var possibleFormatProvider]
&& possibleFormatProvider.Type.Equals(iformatProviderType, SymbolEqualityComparer.Default)) ?? [];
var superfluousConvertToBooleanFormatProviderOverloads = convertType?.GetMembers(nameof(Convert.ToBoolean))
.OfType<IMethodSymbol>()
.Where(m => m.IsStatic
&& m.Parameters is [{ Type.SpecialType: SpecialType.System_String }, var possibleFormatProvider]
&& possibleFormatProvider.Type.Equals(iformatProviderType, SymbolEqualityComparer.Default)) ?? [];
ImmutableHashSet<IMethodSymbol> superfluousFormatProviderOverloads = superfluousConvertToStringFormatProviderOverloads
.Concat(superfluousConvertToToCharFormatProviderOverloads)
.Concat(superfluousConvertToBooleanFormatProviderOverloads)
.ToImmutableHashSet<IMethodSymbol>(SymbolEqualityComparer.Default);
Copy link
Member

Choose a reason for hiding this comment

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

Got some NITs:

  • Better to check null before head to avoid null check each reference and creating empty array
  • For ToChar, ToBoolean we expect only one method to get, no need to create array for this
  • m.IsStatic is redundant as Convert is a static type, all methods are static anyways
    Something like:
Suggested change
var superfluousConvertToStringFormatProviderOverloads = convertType?.GetMembers(nameof(Convert.ToString))
.OfType<IMethodSymbol>()
.Where(m => m.IsStatic
&& m.Parameters is [{ Type.SpecialType: SpecialType.System_String or SpecialType.System_Boolean or SpecialType.System_Char }, var possibleFormatProvider]
&& possibleFormatProvider.Type.Equals(iformatProviderType, SymbolEqualityComparer.Default)) ?? [];
var superfluousConvertToToCharFormatProviderOverloads = convertType?.GetMembers(nameof(Convert.ToChar))
.OfType<IMethodSymbol>()
.Where(m => m.IsStatic
&& m.Parameters is [{ Type.SpecialType: SpecialType.System_String }, var possibleFormatProvider]
&& possibleFormatProvider.Type.Equals(iformatProviderType, SymbolEqualityComparer.Default)) ?? [];
var superfluousConvertToBooleanFormatProviderOverloads = convertType?.GetMembers(nameof(Convert.ToBoolean))
.OfType<IMethodSymbol>()
.Where(m => m.IsStatic
&& m.Parameters is [{ Type.SpecialType: SpecialType.System_String }, var possibleFormatProvider]
&& possibleFormatProvider.Type.Equals(iformatProviderType, SymbolEqualityComparer.Default)) ?? [];
ImmutableHashSet<IMethodSymbol> superfluousFormatProviderOverloads = superfluousConvertToStringFormatProviderOverloads
.Concat(superfluousConvertToToCharFormatProviderOverloads)
.Concat(superfluousConvertToBooleanFormatProviderOverloads)
.ToImmutableHashSet<IMethodSymbol>(SymbolEqualityComparer.Default);
ImmutableHashSet<IMethodSymbol> superfluousFormatProviderOverloads = ImmutableHashSet<IMethodSymbol>.Empty;
if (convertType != null)
{
superfluousFormatProviderOverloads = convertType.GetMembers(nameof(Convert.ToString))
.OfType<IMethodSymbol>()
.Where(m => m.Parameters is [{ Type.SpecialType: SpecialType.System_String or SpecialType.System_Boolean or SpecialType.System_Char }, var possibleFormatProvider]
&& possibleFormatProvider.Type.Equals(iformatProviderType, SymbolEqualityComparer.Default)).ToImmutableHashSet();
superfluousFormatProviderOverloads = superfluousFormatProviderOverloads
.Add(convertType.GetMembers(nameof(Convert.ToChar))
.OfType<IMethodSymbol>()
.First(m => m.Parameters is [{ Type.SpecialType: SpecialType.System_String }, var possibleFormatProvider]
&& possibleFormatProvider.Type.Equals(iformatProviderType, SymbolEqualityComparer.Default)))
.Add(convertType.GetMembers(nameof(Convert.ToBoolean))
.OfType<IMethodSymbol>()
.First(m => m.Parameters is [{ Type.SpecialType: SpecialType.System_String }, var possibleFormatProvider]
&& possibleFormatProvider.Type.Equals(iformatProviderType, SymbolEqualityComparer.Default)));
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review!


#endregion

context.RegisterOperationAction(oaContext =>
Expand Down Expand Up @@ -224,7 +244,7 @@ protected override void InitializeWorker(CompilationStartAnalysisContext context

// Sample message for IFormatProviderAlternateRule: Because the behavior of Convert.ToInt64(string) could vary based on the current user's locale settings,
// replace this call in IFormatProviderStringTest.TestMethod() with a call to Convert.ToInt64(string, IFormatProvider).
if (correctOverload != null)
if (correctOverload != null && !superfluousFormatProviderOverloads.Contains(correctOverload))
{
oaContext.ReportDiagnostic(
invocationExpression.Syntax.CreateDiagnostic(
Expand Down
Loading