src/MassTransit.Analyzers/AsyncMethodAnalyzer.cs - develop - vshmidt/masstransit

src/MassTransit.Analyzers/AsyncMethodAnalyzer.cs
59 строк2 KB
Chris Patterson
Analyzer message punctuation
02 сен 2020, 23:53
02 сен 2020, 23:5382ee0dd
namespace MassTransit.Analyzers
{
    using System;
    using System.Collections.Immutable;
    using Microsoft.CodeAnalysis;
    using Microsoft.CodeAnalysis.CSharp;
    using Microsoft.CodeAnalysis.CSharp.Syntax;
    using Microsoft.CodeAnalysis.Diagnostics;


    [DiagnosticAnalyzer(LanguageNames.CSharp)]
    public class AsyncMethodAnalyzer :
        DiagnosticAnalyzer
    {
        public const string MissingAwaitRuleId = "MTA0001";

        const string Category = "Usage";

        static readonly DiagnosticDescriptor MissingAwaitRule = new DiagnosticDescriptor(MissingAwaitRuleId,
            "MassTransit method is not awaited or captured",
            "Method {0} is not awaited or captured and may result in message loss",
            Category, DiagnosticSeverity.Warning, true,
            "MassTransit method is not awaited or captured.");

        public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(MissingAwaitRule);

        public override void Initialize(AnalysisContext context)
        {
            if (context == null)
                throw new ArgumentNullException(nameof(context));

            context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
            context.EnableConcurrentExecution();

            context.RegisterSyntaxNodeAction(AnalyzeNode, SyntaxKind.InvocationExpression);
        }

        static void AnalyzeNode(SyntaxNodeAnalysisContext context)
        {
            var invocationExpression = (InvocationExpressionSyntax)context.Node;

            var symbol = context.SemanticModel.GetSymbolInfo(invocationExpression);
            if (symbol.Symbol?.Kind == SymbolKind.Method)
            {
                var methodSymbol = (IMethodSymbol)symbol.Symbol;

                if (methodSymbol.IsProducerMethod(out _) && methodSymbol.ReturnsTask())
                {
                    if (invocationExpression.Parent is ExpressionStatementSyntax)
                    {
                        context.ReportDiagnostic(Diagnostic.Create(MissingAwaitRule, invocationExpression.GetLocation(),
                            SymbolDisplay.ToDisplayString(methodSymbol,
                                SymbolDisplayFormat.CSharpShortErrorMessageFormat.WithParameterOptions(SymbolDisplayParameterOptions.None))));
                    }
                }
            }
        }
    }
}