-
Notifications
You must be signed in to change notification settings - Fork 294
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #714 from CommunityToolkit/dev/async-void-command-…
…analyzer Add new analyzer/fixer for async void [RelayCommand] methods
- Loading branch information
Showing
9 changed files
with
304 additions
and
7 deletions.
There are no files selected for viewing
85 changes: 85 additions & 0 deletions
85
src/CommunityToolkit.Mvvm.CodeFixers/AsyncVoidReturningRelayCommandMethodCodeFixer.cs
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,85 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System.Collections.Immutable; | ||
| using System.Composition; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.CodeActions; | ||
| using Microsoft.CodeAnalysis.CodeFixes; | ||
| using Microsoft.CodeAnalysis.CSharp.Syntax; | ||
| using Microsoft.CodeAnalysis.Editing; | ||
| using Microsoft.CodeAnalysis.Simplification; | ||
| using Microsoft.CodeAnalysis.Text; | ||
| using static CommunityToolkit.Mvvm.SourceGenerators.Diagnostics.DiagnosticDescriptors; | ||
|
|
||
| namespace CommunityToolkit.Mvvm.CodeFixers; | ||
|
|
||
| /// <summary> | ||
| /// A code fixer that automatically updates the return type of <see langword="async"/> <see cref="void"/> methods using <c>[RelayCommand]</c> to return a <see cref="Task"/> instead. | ||
| /// </summary> | ||
| [ExportCodeFixProvider(LanguageNames.CSharp)] | ||
| [Shared] | ||
| public sealed class AsyncVoidReturningRelayCommandMethodCodeFixer : CodeFixProvider | ||
| { | ||
| /// <inheritdoc/> | ||
| public override ImmutableArray<string> FixableDiagnosticIds { get; } = ImmutableArray.Create(AsyncVoidReturningRelayCommandMethodId); | ||
|
|
||
| /// <inheritdoc/> | ||
| public override FixAllProvider? GetFixAllProvider() | ||
| { | ||
| return WellKnownFixAllProviders.BatchFixer; | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public override async Task RegisterCodeFixesAsync(CodeFixContext context) | ||
| { | ||
| Diagnostic diagnostic = context.Diagnostics[0]; | ||
| TextSpan diagnosticSpan = context.Span; | ||
|
|
||
| SyntaxNode? root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false); | ||
|
|
||
| // Get the method declaration from the target diagnostic | ||
| if (root!.FindNode(diagnosticSpan) is MethodDeclarationSyntax methodDeclaration) | ||
| { | ||
| // Register the code fix to update the return type to be Task instead | ||
| context.RegisterCodeFix( | ||
| CodeAction.Create( | ||
| title: "Change return type to Task", | ||
| createChangedDocument: token => ChangeReturnType(context.Document, root, methodDeclaration, token), | ||
| equivalenceKey: "Change return type to Task"), | ||
| diagnostic); | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Applies the code fix to a target method declaration and returns an updated document. | ||
| /// </summary> | ||
| /// <param name="document">The original document being fixed.</param> | ||
| /// <param name="root">The original tree root belonging to the current document.</param> | ||
| /// <param name="methodDeclaration">The <see cref="MethodDeclarationSyntax"/> to update.</param> | ||
| /// <param name="cancellationToken">The cancellation token for the operation.</param> | ||
| /// <returns>An updated document with the applied code fix, and the return type of the method being <see cref="Task"/>.</returns> | ||
| private static async Task<Document> ChangeReturnType(Document document, SyntaxNode root, MethodDeclarationSyntax methodDeclaration, CancellationToken cancellationToken) | ||
| { | ||
| // Get the semantic model (bail if it's not available) | ||
| if (await document.GetSemanticModelAsync(cancellationToken) is not SemanticModel semanticModel) | ||
| { | ||
| return document; | ||
| } | ||
|
|
||
| // Also bail if we can't resolve the Task symbol (this should really never happen) | ||
| if (semanticModel.Compilation.GetTypeByMetadataName("System.Threading.Tasks.Task") is not INamedTypeSymbol taskSymbol) | ||
| { | ||
| return document; | ||
| } | ||
|
|
||
| // Create the new syntax node for the return, and configure it to automatically add "using System.Threading.Tasks;" if needed | ||
| SyntaxNode typeSyntax = SyntaxGenerator.GetGenerator(document).TypeExpression(taskSymbol).WithAdditionalAnnotations(Simplifier.AddImportsAnnotation); | ||
|
|
||
| // Replace the void return type with the newly created Task type expression | ||
| return document.WithSyntaxRoot(root.ReplaceNode(methodDeclaration.ReturnType, typeSyntax)); | ||
| } | ||
| } |
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
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
59 changes: 59 additions & 0 deletions
59
...vm.SourceGenerators/Diagnostics/Analyzers/AsyncVoidReturningRelayCommandMethodAnalyzer.cs
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,59 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System.Collections.Immutable; | ||
| using System.Linq; | ||
| using CommunityToolkit.Mvvm.SourceGenerators.Extensions; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.Diagnostics; | ||
| using static CommunityToolkit.Mvvm.SourceGenerators.Diagnostics.DiagnosticDescriptors; | ||
|
|
||
| namespace CommunityToolkit.Mvvm.SourceGenerators; | ||
|
|
||
| /// <summary> | ||
| /// A diagnostic analyzer that generates a warning when using <c>[RelayCommand]</c> over an <see langword="async"/> <see cref="void"/> method. | ||
| /// </summary> | ||
| [DiagnosticAnalyzer(LanguageNames.CSharp)] | ||
| public sealed class AsyncVoidReturningRelayCommandMethodAnalyzer : DiagnosticAnalyzer | ||
| { | ||
| /// <inheritdoc/> | ||
| public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(AsyncVoidReturningRelayCommandMethod); | ||
|
|
||
| /// <inheritdoc/> | ||
| public override void Initialize(AnalysisContext context) | ||
| { | ||
| context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics); | ||
| context.EnableConcurrentExecution(); | ||
|
|
||
| context.RegisterCompilationStartAction(static context => | ||
| { | ||
| // Get the symbol for [RelayCommand] | ||
| if (context.Compilation.GetTypeByMetadataName("CommunityToolkit.Mvvm.Input.RelayCommandAttribute") is not INamedTypeSymbol relayCommandSymbol) | ||
| { | ||
| return; | ||
| } | ||
| context.RegisterSymbolAction(context => | ||
| { | ||
| // We're only looking for async void methods | ||
| if (context.Symbol is not IMethodSymbol { IsAsync: true, ReturnsVoid: true } methodSymbol) | ||
| { | ||
| return; | ||
| } | ||
| // We only care about methods annotated with [RelayCommand] | ||
| if (!methodSymbol.HasAttributeWithType(relayCommandSymbol)) | ||
| { | ||
| return; | ||
| } | ||
| // Warn on async void methods using [RelayCommand] (they should return a Task instead) | ||
| context.ReportDiagnostic(Diagnostic.Create( | ||
| AsyncVoidReturningRelayCommandMethod, | ||
| context.Symbol.Locations.FirstOrDefault(), | ||
| context.Symbol)); | ||
| }, SymbolKind.Method); | ||
| }); | ||
| } | ||
| } |
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
113 changes: 113 additions & 0 deletions
113
...ourceGenerators.Roslyn401.UnitTests/Test_AsyncVoidReturningRelayCommandMethodCodeFixer.cs
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,113 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System.Threading.Tasks; | ||
| using CommunityToolkit.Mvvm.Input; | ||
| using Microsoft.CodeAnalysis.Testing; | ||
| using Microsoft.VisualStudio.TestTools.UnitTesting; | ||
| using CSharpCodeFixTest = Microsoft.CodeAnalysis.CSharp.Testing.CSharpCodeFixTest< | ||
| CommunityToolkit.Mvvm.SourceGenerators.AsyncVoidReturningRelayCommandMethodAnalyzer, | ||
| CommunityToolkit.Mvvm.CodeFixers.AsyncVoidReturningRelayCommandMethodCodeFixer, | ||
| Microsoft.CodeAnalysis.Testing.Verifiers.MSTestVerifier>; | ||
| using CSharpCodeFixVerifier = Microsoft.CodeAnalysis.CSharp.Testing.CSharpCodeFixVerifier< | ||
| CommunityToolkit.Mvvm.SourceGenerators.AsyncVoidReturningRelayCommandMethodAnalyzer, | ||
| CommunityToolkit.Mvvm.CodeFixers.AsyncVoidReturningRelayCommandMethodCodeFixer, | ||
| Microsoft.CodeAnalysis.Testing.Verifiers.MSTestVerifier>; | ||
|
|
||
| namespace CommunityToolkit.Mvvm.SourceGenerators.Roslyn401.UnitTests; | ||
|
|
||
| [TestClass] | ||
| public class Test_AsyncVoidReturningRelayCommandMethodCodeFixer | ||
| { | ||
| [TestMethod] | ||
| public async Task AsyncVoidMethod_FileContainsSystemThreadingTasksUsingDirective() | ||
| { | ||
| string original = """ | ||
| using System.Threading.Tasks; | ||
| using CommunityToolkit.Mvvm.Input; | ||
|
|
||
| partial class C | ||
| { | ||
| [RelayCommand] | ||
| private async void Foo() | ||
| { | ||
| } | ||
| } | ||
| """; | ||
|
|
||
| string @fixed = """ | ||
| using System.Threading.Tasks; | ||
| using CommunityToolkit.Mvvm.Input; | ||
|
|
||
| partial class C | ||
| { | ||
| [RelayCommand] | ||
| private async Task Foo() | ||
| { | ||
| } | ||
| } | ||
| """; | ||
|
|
||
| CSharpCodeFixTest test = new() | ||
| { | ||
| TestCode = original, | ||
| FixedCode = @fixed, | ||
| ReferenceAssemblies = ReferenceAssemblies.Net.Net60 | ||
| }; | ||
|
|
||
| test.TestState.AdditionalReferences.Add(typeof(RelayCommand).Assembly); | ||
| test.ExpectedDiagnostics.AddRange(new[] | ||
| { | ||
| // /0/Test0.cs(7,24): error MVVMTK0039: The method C.Foo() annotated with [RelayCommand] is async void (make sure to return a Task type instead) | ||
| CSharpCodeFixVerifier.Diagnostic().WithSpan(7, 24, 7, 27).WithArguments("C.Foo()") | ||
| }); | ||
|
|
||
| await test.RunAsync(); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public async Task AsyncVoidMethod_FileDoesNotContainSystemThreadingTasksUsingDirective() | ||
| { | ||
| string original = """ | ||
| using CommunityToolkit.Mvvm.Input; | ||
|
|
||
| partial class C | ||
| { | ||
| [RelayCommand] | ||
| private async void Foo() | ||
| { | ||
| } | ||
| } | ||
| """; | ||
|
|
||
| string @fixed = """ | ||
| using System.Threading.Tasks; | ||
| using CommunityToolkit.Mvvm.Input; | ||
|
|
||
| partial class C | ||
| { | ||
| [RelayCommand] | ||
| private async Task Foo() | ||
| { | ||
| } | ||
| } | ||
| """; | ||
|
|
||
| CSharpCodeFixTest test = new() | ||
| { | ||
| TestCode = original, | ||
| FixedCode = @fixed, | ||
| ReferenceAssemblies = ReferenceAssemblies.Net.Net60 | ||
| }; | ||
|
|
||
| test.TestState.AdditionalReferences.Add(typeof(RelayCommand).Assembly); | ||
| test.ExpectedDiagnostics.AddRange(new[] | ||
| { | ||
| // /0/Test0.cs(7,24): error MVVMTK0039: The method C.Foo() annotated with [RelayCommand] is async void (make sure to return a Task type instead) | ||
| CSharpCodeFixVerifier.Diagnostic().WithSpan(6, 24, 6, 27).WithArguments("C.Foo()") | ||
| }); | ||
|
|
||
| await test.RunAsync(); | ||
| } | ||
| } |
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