| | | 1 | | using System.Collections.Immutable; |
| | | 2 | | |
| | | 3 | | using Microsoft.CodeAnalysis; |
| | | 4 | | using Microsoft.CodeAnalysis.CSharp; |
| | | 5 | | using Microsoft.CodeAnalysis.CSharp.Syntax; |
| | | 6 | | using Microsoft.CodeAnalysis.Diagnostics; |
| | | 7 | | |
| | | 8 | | namespace NexusLabs.Needlr.Analyzers; |
| | | 9 | | |
| | | 10 | | /// <summary> |
| | | 11 | | /// Analyzer that detects plugin implementations with constructor dependencies. |
| | | 12 | | /// </summary> |
| | | 13 | | [DiagnosticAnalyzer(LanguageNames.CSharp)] |
| | | 14 | | public sealed class PluginConstructorDependenciesAnalyzer : DiagnosticAnalyzer |
| | | 15 | | { |
| | | 16 | | // Plugin interfaces that are instantiated before DI is available |
| | 1 | 17 | | private static readonly ImmutableHashSet<string> PluginInterfaceNames = ImmutableHashSet.Create( |
| | 1 | 18 | | "IServiceCollectionPlugin", |
| | 1 | 19 | | "IPostBuildServiceCollectionPlugin", |
| | 1 | 20 | | "IWebApplicationBuilderPlugin", |
| | 1 | 21 | | "IHostApplicationBuilderPlugin"); |
| | | 22 | | |
| | | 23 | | public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => |
| | 529 | 24 | | ImmutableArray.Create(DiagnosticDescriptors.PluginHasConstructorDependencies); |
| | | 25 | | |
| | | 26 | | public override void Initialize(AnalysisContext context) |
| | | 27 | | { |
| | 42 | 28 | | context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None); |
| | 42 | 29 | | context.EnableConcurrentExecution(); |
| | | 30 | | |
| | 42 | 31 | | context.RegisterSyntaxNodeAction(AnalyzeClassDeclaration, SyntaxKind.ClassDeclaration); |
| | 42 | 32 | | } |
| | | 33 | | |
| | | 34 | | private static void AnalyzeClassDeclaration(SyntaxNodeAnalysisContext context) |
| | | 35 | | { |
| | 27 | 36 | | var classDeclaration = (ClassDeclarationSyntax)context.Node; |
| | | 37 | | |
| | | 38 | | // Skip abstract classes |
| | 27 | 39 | | if (classDeclaration.Modifiers.Any(SyntaxKind.AbstractKeyword)) |
| | | 40 | | { |
| | 3 | 41 | | return; |
| | | 42 | | } |
| | | 43 | | |
| | | 44 | | // Check if class implements a plugin interface |
| | 24 | 45 | | if (!ImplementsPluginInterface(classDeclaration, context.SemanticModel)) |
| | | 46 | | { |
| | 5 | 47 | | return; |
| | | 48 | | } |
| | | 49 | | |
| | | 50 | | // Check constructors |
| | 19 | 51 | | var constructors = classDeclaration.Members |
| | 19 | 52 | | .OfType<ConstructorDeclarationSyntax>() |
| | 21 | 53 | | .Where(c => !c.Modifiers.Any(SyntaxKind.StaticKeyword)) |
| | 19 | 54 | | .ToList(); |
| | | 55 | | |
| | | 56 | | // If no explicit constructors, there's an implicit parameterless constructor - OK |
| | 19 | 57 | | if (constructors.Count == 0) |
| | | 58 | | { |
| | 1 | 59 | | return; |
| | | 60 | | } |
| | | 61 | | |
| | | 62 | | // Check if there's at least one public parameterless constructor |
| | 18 | 63 | | var hasParameterlessConstructor = constructors.Any(c => |
| | 38 | 64 | | c.Modifiers.Any(SyntaxKind.PublicKeyword) && |
| | 38 | 65 | | c.ParameterList.Parameters.Count == 0); |
| | | 66 | | |
| | 18 | 67 | | if (hasParameterlessConstructor) |
| | | 68 | | { |
| | 2 | 69 | | return; |
| | | 70 | | } |
| | | 71 | | |
| | | 72 | | // Report diagnostic on any constructor with parameters |
| | 86 | 73 | | foreach (var constructor in constructors.Where(c => c.ParameterList.Parameters.Count > 0)) |
| | | 74 | | { |
| | 18 | 75 | | var diagnostic = Diagnostic.Create( |
| | 18 | 76 | | DiagnosticDescriptors.PluginHasConstructorDependencies, |
| | 18 | 77 | | constructor.Identifier.GetLocation(), |
| | 18 | 78 | | classDeclaration.Identifier.Text); |
| | | 79 | | |
| | 18 | 80 | | context.ReportDiagnostic(diagnostic); |
| | | 81 | | } |
| | 16 | 82 | | } |
| | | 83 | | |
| | | 84 | | /// <summary> |
| | | 85 | | /// True when <paramref name="classDeclaration"/> lists a Needlr plugin interface, |
| | | 86 | | /// directly or through any base type or inherited interface. |
| | | 87 | | /// </summary> |
| | | 88 | | /// <remarks> |
| | | 89 | | /// Matching is exclusively symbol based: a base-list entry the semantic model cannot |
| | | 90 | | /// resolve to a type at all is skipped rather than matched on its simple name, since |
| | | 91 | | /// a bare <c>IServiceCollectionPlugin</c> identifier in incomplete code may just as |
| | | 92 | | /// easily refer to an unrelated same-named interface from another namespace. An |
| | | 93 | | /// unresolved but namespace-qualified entry (an error symbol still carrying the |
| | | 94 | | /// <c>NexusLabs.Needlr</c> namespace and a plugin interface name) is unambiguous and |
| | | 95 | | /// is still diagnosed. |
| | | 96 | | /// </remarks> |
| | | 97 | | private static bool ImplementsPluginInterface( |
| | | 98 | | ClassDeclarationSyntax classDeclaration, |
| | | 99 | | SemanticModel semanticModel) |
| | | 100 | | { |
| | 24 | 101 | | if (classDeclaration.BaseList == null) |
| | | 102 | | { |
| | 2 | 103 | | return false; |
| | | 104 | | } |
| | | 105 | | |
| | 73 | 106 | | foreach (var baseType in classDeclaration.BaseList.Types) |
| | | 107 | | { |
| | 24 | 108 | | var typeInfo = semanticModel.GetTypeInfo(baseType.Type); |
| | 24 | 109 | | var typeSymbol = typeInfo.Type; |
| | | 110 | | |
| | 24 | 111 | | if (typeSymbol == null) |
| | | 112 | | { |
| | | 113 | | continue; |
| | | 114 | | } |
| | | 115 | | |
| | | 116 | | // Check the type and all its interfaces |
| | 24 | 117 | | if (IsPluginInterface(typeSymbol)) |
| | | 118 | | { |
| | 15 | 119 | | return true; |
| | | 120 | | } |
| | | 121 | | |
| | 22 | 122 | | foreach (var iface in typeSymbol.AllInterfaces) |
| | | 123 | | { |
| | 4 | 124 | | if (IsPluginInterface(iface)) |
| | | 125 | | { |
| | 4 | 126 | | return true; |
| | | 127 | | } |
| | | 128 | | } |
| | | 129 | | } |
| | | 130 | | |
| | 3 | 131 | | return false; |
| | | 132 | | } |
| | | 133 | | |
| | | 134 | | private static bool IsPluginInterface(ITypeSymbol typeSymbol) |
| | | 135 | | { |
| | 28 | 136 | | return PluginInterfaceNames.Contains(typeSymbol.Name) && |
| | 28 | 137 | | typeSymbol.ContainingNamespace?.ToString() == "NexusLabs.Needlr"; |
| | | 138 | | } |
| | | 139 | | } |