File: UseMvcAnalyzer.cs
Web Access
Project: src\aspnetcore\src\Analyzers\Analyzers\src\Microsoft.AspNetCore.Analyzers.csproj (Microsoft.AspNetCore.Analyzers)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Diagnostics;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Diagnostics;

namespace Microsoft.AspNetCore.Analyzers;

internal sealed class UseMvcAnalyzer
{
    private readonly StartupAnalysis _context;

    public UseMvcAnalyzer(StartupAnalysis context)
    {
        _context = context;
    }

    public void AnalyzeSymbol(SymbolAnalysisContext context)
    {
        Debug.Assert(context.Symbol.Kind == SymbolKind.NamedType);

        var type = (INamedTypeSymbol)context.Symbol;

        var optionsAnalysis = _context.GetRelatedSingletonAnalysis<OptionsAnalysis>(type);
        if (optionsAnalysis == null)
        {
            return;
        }

        // Find the middleware analysis foreach of the Configure methods defined by this class and validate.
        //
        // Note that this doesn't attempt to handle inheritance scenarios.
        foreach (var middlewareAnalysis in _context.GetRelatedAnalyses<MiddlewareAnalysis>(type))
        {
            foreach (var middlewareItem in middlewareAnalysis.Middleware)
            {
                if (middlewareItem.UseMethod.Name == "UseMvc" || middlewareItem.UseMethod.Name == "UseMvcWithDefaultRoute")
                {
                    // Report a diagnostic if it's unclear that the user turned off Endpoint Routing.
                    if (!OptionsFacts.IsEndpointRoutingExplicitlyDisabled(optionsAnalysis))
                    {
                        context.ReportDiagnostic(Diagnostic.Create(
                            StartupAnalyzer.Diagnostics.UnsupportedUseMvcWithEndpointRouting,
                            middlewareItem.Operation.Syntax.GetLocation(),
                            middlewareItem.UseMethod.Name,
                            optionsAnalysis.ConfigureServicesMethod.Name));
                    }
                }
            }
        }
    }
}