New rule MA0124: Log Parameter type is not valid (#433)

Author: meziantou

README.md

@@ -139,5 +139,8 @@ If you are already using other analyzers, you can check [which rules are duplica
 |[MA0121](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0121.md)|Design|Do not overwrite parameter value|ℹ️|❌|❌|
 |[MA0122](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0122.md)|Design|Parameters with \[SupplyParameterFromQuery\] attributes are only valid in routable components (@page)|ℹ️|✔️|❌|
 |[MA0123](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0123.md)|Design|Sequence number must be a constant|⚠️|✔️|❌|
+|[MA0124](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0124.md)|Design|Log Parameter type is not valid|⚠️|✔️|❌|
+|[MA0125](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0125.md)|Design|The list of log parameter types contains an invalid type|⚠️|✔️|❌|
+|[MA0126](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0126.md)|Design|The list of log parameter types contains a duplicate|⚠️|✔️|❌|
 
 <!-- rules -->

docs/README.md

@@ -123,6 +123,9 @@
 |[MA0121](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0121.md)|Design|Do not overwrite parameter value|<span title='Info'>ℹ️</span>|❌|❌|
 |[MA0122](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0122.md)|Design|Parameters with \[SupplyParameterFromQuery\] attributes are only valid in routable components (@page)|<span title='Info'>ℹ️</span>|✔️|❌|
 |[MA0123](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0123.md)|Design|Sequence number must be a constant|<span title='Warning'>⚠️</span>|✔️|❌|
+|[MA0124](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0124.md)|Design|Log Parameter type is not valid|<span title='Warning'>⚠️</span>|✔️|❌|
+|[MA0125](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0125.md)|Design|The list of log parameter types contains an invalid type|<span title='Warning'>⚠️</span>|✔️|❌|
+|[MA0126](https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0126.md)|Design|The list of log parameter types contains a duplicate|<span title='Warning'>⚠️</span>|✔️|❌|
 
 # .editorconfig - default values
 
@@ -492,6 +495,15 @@ dotnet_diagnostic.MA0122.severity = suggestion
 
  # MA0123: Sequence number must be a constant
 dotnet_diagnostic.MA0123.severity = warning
+
+ # MA0124: Log Parameter type is not valid
+dotnet_diagnostic.MA0124.severity = warning
+
+ # MA0125: The list of log parameter types contains an invalid type
+dotnet_diagnostic.MA0125.severity = warning
+
+ # MA0126: The list of log parameter types contains a duplicate
+dotnet_diagnostic.MA0126.severity = warning
 ```
 
 # .editorconfig - all rules disabled
@@ -862,4 +874,13 @@ dotnet_diagnostic.MA0122.severity = none
 
  # MA0123: Sequence number must be a constant
 dotnet_diagnostic.MA0123.severity = none
+
+ # MA0124: Log Parameter type is not valid
+dotnet_diagnostic.MA0124.severity = none
+
+ # MA0125: The list of log parameter types contains an invalid type
+dotnet_diagnostic.MA0125.severity = none
+
+ # MA0126: The list of log parameter types contains a duplicate
+dotnet_diagnostic.MA0126.severity = none
 ```

docs/Rules/MA0124.md

@@ -0,0 +1,39 @@
+# MA0124 - Log Parameter type is not valid
+
+This rule ensures the parameters for Microsoft.Extensions.Logging's logger are of the expected types. You can configure the expected types using a configuration file.
+
+To configure the rule, you need to create a file named `LoggerParameterTypes.txt` or `LoggerParameterTypes.*.txt`.
+- Each line is of the form `PropertyName;ExpectedType1;ExpectedType2;ExpectedType3;...`
+- A type is represented by its CLR metadata name or [XML Comment ID](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d42-id-string-format)
+- Lines starting with `#` are comments
+
+````
+# This is a comment
+
+Name;System.String
+Count;System.Int32;System.Int64
+Length;T:System.Nullable{System.Int32}
+````
+
+Then, you need to add the file to the `AdditionalFiles` collection in the `csproj` file:
+
+````xml
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <ItemGroup>
+    <AdditionalFiles Include="$(MSBuildThisFileDirectory)\LoggerParameterTypes.txt" />
+  </ItemGroup>
+
+</Project>
+````
+
+Then, the analyzer reports log parameters of the wrong type:
+
+````
+using Microsoft.Extensions.Logging;
+
+ILogger logger = ...;
+logger.LogInformation("{Name}", 123); # report diagnostic because the configuration file indicates Name should be of type string
+logger.LogInformation("{Name}", "dummy");
+````
+

docs/Rules/MA0125.md

@@ -0,0 +1,7 @@
+# MA0125 - The list of log parameter types contains an invalid type
+
+The configuration file for the rule [MA0124](./MA0124.md) contains a type that is not found in the current compilation.
+
+````
+PropName;System.Unknown type # Report diagnostic
+````

docs/Rules/MA0126.md

@@ -0,0 +1,8 @@
+# MA0126 - The list of log parameter types contains a duplicate
+
+The configuration file for the rule [MA0124](./MA0124.md) contains duplicated names.
+
+````
+PropName;type
+PropName;type # Report diagnostic
+````

src/Meziantou.Analyzer/Configurations/AnalyzerOptionsExtensions.cs

@@ -17,6 +17,11 @@ public static string GetConfigurationValue(this AnalyzerOptions options, SyntaxT
         return defaultValue;
     }
 
+    public static string GetConfigurationValue(this AnalyzerOptions options, IOperation operation, string key, string defaultValue)
+    {
+        return GetConfigurationValue(options, operation.Syntax.SyntaxTree, key, defaultValue);
+    }
+
     public static bool GetConfigurationValue(this AnalyzerOptions options, SyntaxTree syntaxTree, string key, bool defaultValue)
     {
         var configuration = options.AnalyzerConfigOptionsProvider.GetOptions(syntaxTree);

src/Meziantou.Analyzer/Internals/CompilationExtensions.cs

@@ -1,16 +1,20 @@
 using System.Collections.Generic;
+using System.Collections.Immutable;
 using System.Diagnostics;
 using Microsoft.CodeAnalysis;
 
 namespace Meziantou.Analyzer;
 
 internal static class CompilationExtensions
 {
-    public static IEnumerable<INamedTypeSymbol> GetTypesByMetadataName(this Compilation compilation, string typeMetadataName)
+    public static ImmutableArray<INamedTypeSymbol> GetTypesByMetadataName(this Compilation compilation, string typeMetadataName)
     {
+        var result = ImmutableArray.CreateBuilder<INamedTypeSymbol>();
         var symbol = compilation.Assembly.GetTypeByMetadataName(typeMetadataName);
         if (symbol != null)
-            yield return symbol;
+        {
+            result.Add(symbol);
+        }
 
         foreach (var reference in compilation.References)
         {
@@ -20,8 +24,12 @@ public static IEnumerable<INamedTypeSymbol> GetTypesByMetadataName(this Compilat
 
             symbol = assemblySymbol.GetTypeByMetadataName(typeMetadataName);
             if (symbol != null)
-                yield return symbol;
+            {
+                result.Add(symbol);
+            }
         }
+
+        return result.ToImmutable();
     }
 
     // Copy from https://github.com/dotnet/roslyn/blob/d2ff1d83e8fde6165531ad83f0e5b1ae95908289/src/Workspaces/SharedUtilitiesAndExtensions/Compiler/Core/Extensions/CompilationExtensions.cs#L11-L68

src/Meziantou.Analyzer/RuleIdentifiers.cs

@@ -126,6 +126,9 @@ internal static class RuleIdentifiers
     public const string DoNotOverwriteRazorComponentParameterValue = "MA0121";
     public const string SupplyParameterFromQueryRequiresRoutableComponent = "MA0122";
     public const string SequenceNumberMustBeAConstant = "MA0123";
+    public const string LoggerParameterType = "MA0124";
+    public const string LoggerParameterType_InvalidType = "MA0125";
+    public const string LoggerParameterType_DuplicateRule = "MA0126";
 
     public static string GetHelpUri(string idenfifier)
     {