Support DefaultStatusCode annotation on methods (#39255)

* Support DefaultStatusCode annotation on methods

* Address feedback from peer review

Author: captainsafia

src/Mvc/Mvc.Api.Analyzers/src/ActualApiResponseMetadataFactory.cs

@@ -61,6 +61,8 @@ void AnalyzeResponseExpression(IReturnOperation returnOperation)
         IReturnOperation returnOperation)
     {
         var returnedValue = returnOperation.ReturnedValue;
+        var defaultStatusCodeAttributeSymbol = symbolCache.DefaultStatusCodeAttribute;
+
         if (returnedValue is null || returnedValue is IInvalidOperation)
         {
             return null;
@@ -82,9 +84,23 @@ void AnalyzeResponseExpression(IReturnOperation returnOperation)
         }
 
         var defaultStatusCodeAttribute = statementReturnType
-            .GetAttributes(symbolCache.DefaultStatusCodeAttribute, inherit: true)
+            .GetAttributes(defaultStatusCodeAttributeSymbol, inherit: true)
             .FirstOrDefault();
 
+        // If the type is not annotated with a default status code, then examine
+        // the attributes on any invoked method returning the type.
+        if (defaultStatusCodeAttribute is null && returnedValue.Syntax is InvocationExpressionSyntax targetInvocation)
+        {
+            var methodOperation = returnOperation.SemanticModel.GetSymbolInfo(targetInvocation);
+            var methodSymbol = methodOperation.Symbol ?? methodOperation.CandidateSymbols.FirstOrDefault();
+            if (methodSymbol is not null)
+            {
+                defaultStatusCodeAttribute = methodSymbol
+                    .GetAttributes(defaultStatusCodeAttributeSymbol)
+                    .FirstOrDefault();
+            }
+        }
+
         var statusCode = GetDefaultStatusCode(defaultStatusCodeAttribute);
 
         ITypeSymbol? returnType = null;

src/Mvc/Mvc.Api.Analyzers/test/AddResponseTypeAttributeCodeFixProviderIntegrationTest.cs

@@ -55,6 +55,9 @@ public class AddResponseTypeAttributeCodeFixProviderIntegrationTest
     [Fact]
     public Task CodeFixWorksOnExpressionBodiedMethod() => RunTest();
 
+    [Fact]
+    public Task CodeFixWorksWithValidationProblem() => RunTest();
+
     private async Task RunTest([CallerMemberName] string testMethod = "")
     {
         // Arrange

src/Mvc/Mvc.Api.Analyzers/test/TestFiles/AddResponseTypeAttributeCodeFixProviderIntegrationTest/CodeFixWorksWithValidationProblem.Input.cs

@@ -0,0 +1,17 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Microsoft.AspNetCore.Http;
+
+namespace Microsoft.AspNetCore.Mvc.Api.Analyzers._INPUT_
+{
+    [ApiController]
+    [Route("[controller]/[action]")]
+    public class CodeFixWorksWithValidationProblem : ControllerBase
+    {
+        public IActionResult GetProblem()
+        {
+            return ValidationProblem();
+        }
+    }
+}

src/Mvc/Mvc.Api.Analyzers/test/TestFiles/AddResponseTypeAttributeCodeFixProviderIntegrationTest/CodeFixWorksWithValidationProblem.Output.cs

@@ -0,0 +1,19 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Microsoft.AspNetCore.Http;
+
+namespace Microsoft.AspNetCore.Mvc.Api.Analyzers._OUTPUT_
+{
+    [ApiController]
+    [Route("[controller]/[action]")]
+    public class CodeFixWorksWithValidationProblem : ControllerBase
+    {
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]
+        [ProducesDefaultResponseType]
+        public IActionResult GetProblem()
+        {
+            return ValidationProblem();
+        }
+    }
+}

src/Mvc/Mvc.Core/src/ControllerBase.cs

@@ -1920,6 +1920,7 @@ public virtual ObjectResult Problem(
     /// </summary>
     /// <returns>The created <see cref="BadRequestObjectResult"/> for the response.</returns>
     [NonAction]
+    [DefaultStatusCode(StatusCodes.Status400BadRequest)]
     public virtual ActionResult ValidationProblem([ActionResultObjectValue] ValidationProblemDetails descriptor)
     {
         if (descriptor == null)
@@ -1937,6 +1938,7 @@ public virtual ActionResult ValidationProblem([ActionResultObjectValue] Validati
     /// <param name="modelStateDictionary">The <see cref="ModelStateDictionary"/>.</param>
     /// <returns>The created <see cref="BadRequestObjectResult"/> for the response.</returns>
     [NonAction]
+    [DefaultStatusCode(StatusCodes.Status400BadRequest)]
     public virtual ActionResult ValidationProblem([ActionResultObjectValue] ModelStateDictionary modelStateDictionary)
          => ValidationProblem(detail: null, modelStateDictionary: modelStateDictionary);
 
@@ -1947,6 +1949,7 @@ public virtual ActionResult ValidationProblem([ActionResultObjectValue] ModelSta
     /// </summary>
     /// <returns>The created <see cref="ActionResult"/> for the response.</returns>
     [NonAction]
+    [DefaultStatusCode(StatusCodes.Status400BadRequest)]
     public virtual ActionResult ValidationProblem()
         => ValidationProblem(ModelState);
 
@@ -1963,6 +1966,7 @@ public virtual ActionResult ValidationProblem()
     /// When <see langword="null"/> uses <see cref="ModelState"/>.</param>
     /// <returns>The created <see cref="ActionResult"/> for the response.</returns>
     [NonAction]
+    [DefaultStatusCode(StatusCodes.Status400BadRequest)]
     public virtual ActionResult ValidationProblem(
         string? detail = null,
         string? instance = null,

src/Mvc/Mvc.Core/src/Infrastructure/DefaultStatusCodeAttribute.cs

@@ -11,8 +11,15 @@ namespace Microsoft.AspNetCore.Mvc.Infrastructure;
 /// </summary>
 /// <remarks>
 /// This attribute is informational only and does not have any runtime effects.
+/// Applying the attribute on a class indicates that the <see cref="ActionResult"/>
+/// represented by that class uses a particular status code by default. Applying the
+/// attribute to a method indicates that the <see cref="ActionResult"/> returned by the
+/// method uses that status code by default. The later is helpful in scenarios where we
+/// need to specify that a method modifies the status code that an <see cref="ActionResult"/>
+/// uses by default in its logic or for specifying the status code for consumption in
+/// the API analyzers.
 /// </remarks>
-[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
+[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
 public sealed class DefaultStatusCodeAttribute : Attribute
 {
     /// <summary>