Implement Analyzer and best-effort Code Fix for SafeHandle Public Parameterless Constructor guidance. #5043
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| // Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| using System; | ||
| using System.Collections.Immutable; | ||
| using System.Composition; | ||
| using System.Linq; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Analyzer.Utilities; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.CodeFixes; | ||
| using Microsoft.CodeAnalysis.Editing; | ||
|
|
||
| namespace Microsoft.NetCore.Analyzers.InteropServices | ||
| { | ||
| [ExportCodeFixProvider(LanguageNames.CSharp, LanguageNames.VisualBasic), Shared] | ||
| public sealed class ProvidePublicParameterlessSafeHandleConstructorFixer : CodeFixProvider | ||
| { | ||
| public override ImmutableArray<string> FixableDiagnosticIds => ImmutableArray.Create(ProvidePublicParameterlessSafeHandleConstructorAnalyzer.RuleId); | ||
|
|
||
| public sealed override FixAllProvider GetFixAllProvider() | ||
| { | ||
| // See https://github.com/dotnet/roslyn/blob/main/docs/analyzers/FixAllProvider.md for more information on Fix All Providers | ||
| return WellKnownFixAllProviders.BatchFixer; | ||
| } | ||
|
|
||
| public override async Task RegisterCodeFixesAsync(CodeFixContext context) | ||
| { | ||
| SyntaxGenerator generator = SyntaxGenerator.GetGenerator(context.Document); | ||
| SyntaxNode root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); | ||
|
|
||
| SyntaxNode enclosingNode = root.FindNode(context.Span); | ||
|
There was a problem hiding this comment. @mavasani I'm quite confused regarding CodeFixContext when it has multiple diagnostics, which diagnostic will the value of There was a problem hiding this comment. All diagnostics in the code fix context should have the same ID and span. |
||
| SyntaxNode declaration = generator.GetDeclaration(enclosingNode); | ||
| if (declaration == null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| Diagnostic diagnostic = context.Diagnostics.First(); | ||
| if (diagnostic.Properties.ContainsKey(ProvidePublicParameterlessSafeHandleConstructorAnalyzer.DiagnosticPropertyConstructorExists)) | ||
| { | ||
| context.RegisterCodeFix( | ||
| new MyCodeAction( | ||
| MicrosoftNetCoreAnalyzersResources.MakeParameterlessConstructorPublic, | ||
| async ct => await MakeParameterlessConstructorPublic(declaration, context.Document, context.CancellationToken).ConfigureAwait(false), | ||
| equivalenceKey: nameof(MicrosoftNetCoreAnalyzersResources.MakeParameterlessConstructorPublic)), | ||
| diagnostic); | ||
| } | ||
| else if (diagnostic.Properties.ContainsKey(ProvidePublicParameterlessSafeHandleConstructorAnalyzer.DiagnosticPropertyBaseConstructorAccessible)) | ||
mavasani marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| context.RegisterCodeFix( | ||
| new MyCodeAction( | ||
| MicrosoftNetCoreAnalyzersResources.AddPublicParameterlessConstructor, | ||
| async ct => await AddParameterlessConstructor(declaration, context.Document, context.CancellationToken).ConfigureAwait(false), | ||
| equivalenceKey: nameof(MicrosoftNetCoreAnalyzersResources.AddPublicParameterlessConstructor)), | ||
| diagnostic); | ||
| } | ||
| } | ||
|
|
||
| private static async Task<Document> AddParameterlessConstructor(SyntaxNode declaration, Document document, CancellationToken ct) | ||
| { | ||
| var editor = await DocumentEditor.CreateAsync(document, ct).ConfigureAwait(false); | ||
| INamedTypeSymbol type = (INamedTypeSymbol)editor.SemanticModel.GetDeclaredSymbol(declaration, ct); | ||
| var generator = editor.Generator; | ||
|
|
||
| var parameterlessConstructor = generator.ConstructorDeclaration(type.Name, accessibility: Accessibility.Public); | ||
|
|
||
| editor.AddMember(declaration, parameterlessConstructor); | ||
|
|
||
| return editor.GetChangedDocument(); | ||
| } | ||
|
|
||
| private static async Task<Document> MakeParameterlessConstructorPublic(SyntaxNode declaration, Document document, CancellationToken ct) | ||
| { | ||
| var editor = await DocumentEditor.CreateAsync(document, ct).ConfigureAwait(false); | ||
| editor.SetAccessibility(declaration, Accessibility.Public); | ||
| return editor.GetChangedDocument(); | ||
| } | ||
|
|
||
| private class MyCodeAction : DocumentChangeAction | ||
| { | ||
| public MyCodeAction(string title, Func<CancellationToken, Task<Document>> createChangedDocument, string equivalenceKey) | ||
| : base(title, createChangedDocument, equivalenceKey) | ||
| { | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| // Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| using System.Collections.Immutable; | ||
| using Analyzer.Utilities; | ||
| using Analyzer.Utilities.Extensions; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.Diagnostics; | ||
|
|
||
| namespace Microsoft.NetCore.Analyzers.InteropServices | ||
| { | ||
| [DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)] | ||
| public sealed class ProvidePublicParameterlessSafeHandleConstructorAnalyzer : DiagnosticAnalyzer | ||
| { | ||
| internal const string RuleId = "CA1419"; | ||
|
|
||
| internal const string DiagnosticPropertyConstructorExists = "ConstructorExists"; | ||
| internal const string DiagnosticPropertyBaseConstructorAccessible = "BaseConstructorAccessible"; | ||
|
|
||
| private static readonly LocalizableString s_localizableTitle = new LocalizableResourceString(nameof(MicrosoftNetCoreAnalyzersResources.ProvidePublicParameterlessSafeHandleConstructorTitle), MicrosoftNetCoreAnalyzersResources.ResourceManager, typeof(MicrosoftNetCoreAnalyzersResources)); | ||
| private static readonly LocalizableString s_localizableMessage = new LocalizableResourceString(nameof(MicrosoftNetCoreAnalyzersResources.ProvidePublicParameterlessSafeHandleConstructorMessage), MicrosoftNetCoreAnalyzersResources.ResourceManager, typeof(MicrosoftNetCoreAnalyzersResources)); | ||
| private static readonly LocalizableString s_localizableDescription = new LocalizableResourceString(nameof(MicrosoftNetCoreAnalyzersResources.ProvidePublicParameterlessSafeHandleConstructorDescription), MicrosoftNetCoreAnalyzersResources.ResourceManager, typeof(MicrosoftNetCoreAnalyzersResources)); | ||
| internal static DiagnosticDescriptor Rule = DiagnosticDescriptorHelper.Create( | ||
| RuleId, | ||
| s_localizableTitle, | ||
| s_localizableMessage, | ||
| DiagnosticCategory.Interoperability, | ||
| RuleLevel.IdeSuggestion, | ||
| description: s_localizableDescription, | ||
| isPortedFxCopRule: false, | ||
| isDataflowRule: false); | ||
|
|
||
| public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule); | ||
|
|
||
| public override void Initialize(AnalysisContext context) | ||
| { | ||
| context.EnableConcurrentExecution(); | ||
| context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None); | ||
| context.RegisterCompilationStartAction( | ||
| context => | ||
| { | ||
| if (context.Compilation.TryGetOrCreateTypeByMetadataName(WellKnownTypeNames.SystemRuntimeInteropServicesSafeHandle, out var safeHandleType)) | ||
| { | ||
| context.RegisterSymbolAction(context => AnalyzeSymbol(context, safeHandleType), SymbolKind.NamedType); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| private static void AnalyzeSymbol(SymbolAnalysisContext context, INamedTypeSymbol safeHandleType) | ||
| { | ||
| INamedTypeSymbol type = (INamedTypeSymbol)context.Symbol; | ||
|
|
||
| if (type.TypeKind != TypeKind.Class) | ||
| { | ||
| // SafeHandle-derived types can only be classes. | ||
| return; | ||
| } | ||
|
|
||
| if (type.IsAbstract || !type.Inherits(safeHandleType)) | ||
| { | ||
| // We only want to put the diagnostic on concrete SafeHandle-derived types. | ||
| return; | ||
| } | ||
|
|
||
| ImmutableDictionary<string, string?> diagnosticPropertyBag = ImmutableDictionary<string, string?>.Empty; | ||
| ISymbol targetWarningSymbol = type; | ||
| foreach (var constructor in type.InstanceConstructors) | ||
| { | ||
| if (constructor.Parameters.Length == 0) | ||
| { | ||
| if (constructor.DeclaredAccessibility == Accessibility.Public) | ||
| { | ||
| // The parameterless constructor is public, so there is no diagnostic to emit. | ||
| return; | ||
| } | ||
|
|
||
| // If a parameterless constructor has been defined, emit the diagnostic on the constructor instead of on the type. | ||
| targetWarningSymbol = constructor; | ||
| diagnosticPropertyBag = diagnosticPropertyBag.Add(DiagnosticPropertyConstructorExists, null); | ||
jkoritzinsky marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| break; | ||
| } | ||
| } | ||
|
|
||
| foreach (var constructor in type.BaseType.InstanceConstructors) | ||
| { | ||
| if (constructor.Parameters.Length == 0 && | ||
| context.Compilation.IsSymbolAccessibleWithin(constructor, type)) | ||
| { | ||
| diagnosticPropertyBag = diagnosticPropertyBag.Add(DiagnosticPropertyBaseConstructorAccessible, null); | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| context.ReportDiagnostic(targetWarningSymbol.CreateDiagnostic(Rule, diagnosticPropertyBag, type.Name)); | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to pass true for
getInnermostNodeForTie? If so, we should add a test too.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know what that flag does, so I don't know if I need to pass it or what a test case would look like.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jkoritzinsky The flag is when two nodes have the same span, which one to get?
I don't think this can happen for the case of this analyzer, but will let @mavasani confirm in case there is any corner case I'm missing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't believe that can happen with the nodes we're looking at in this analyzer, so I don't think we need to worry about it.