Make IResults types public (#40704)

* StatuCodeResult as base class

* StatuCodeResult as base class

* Making types public and renaming to HTTPResult

* Update comments

* Make setters internal

* Updating public API file

* Removing base classes

* Changing method name to WriteResultAsStatusCode

* Updating API

* code cleanup

* fixing public api

* Simplyfing interfaces

* Removing interfaces + Adding ctors

* Fixing xml docs

* Making EmptyResult public

* Updating JsonHttpResult

* Adding missing ctor

* Adding missing ctor

* Adding missing ctor

* Adding misssed xml comment

* Removing configureResponseHeader

* PR Feedback

* Moving ctors to internal

* Create logger using string category

* Adding more unittests

* Update src/Http/Http.Results/src/EmptyHttpResult.cs

Co-authored-by: Brennan <[email protected]>

* Update ContentHttpResult.cs

* avoid closure allocation

Co-authored-by: Brennan <[email protected]>

Author: brunolins16

src/Http/Http.Results/src/AcceptedAtRouteResult.cs renamed to src/Http/Http.Results/src/AcceptedAtRouteHttpResult.cs

@@ -1,41 +1,54 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+namespace Microsoft.AspNetCore.Http;
+
+using System.Threading.Tasks;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 
-namespace Microsoft.AspNetCore.Http.Result;
-
-internal sealed class AcceptedAtRouteResult : ObjectResult
+/// <summary>
+/// An <see cref="IResult"/> that on execution will write an object to the response
+/// with status code Accepted (202) and Location header.
+/// Targets a registered route.
+/// </summary>
+public sealed class AcceptedAtRouteHttpResult : IResult
 {
     /// <summary>
-    /// Initializes a new instance of the <see cref="AcceptedAtRouteResult"/> class with the values
+    /// Initializes a new instance of the <see cref="AcceptedAtRouteHttpResult"/> class with the values
     /// provided.
     /// </summary>
     /// <param name="routeValues">The route data to use for generating the URL.</param>
     /// <param name="value">The value to format in the entity body.</param>
-    public AcceptedAtRouteResult(object? routeValues, object? value)
+    internal AcceptedAtRouteHttpResult(object? routeValues, object? value)
         : this(routeName: null, routeValues: routeValues, value: value)
     {
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="AcceptedAtRouteResult"/> class with the values
+    /// Initializes a new instance of the <see cref="AcceptedAtRouteHttpResult"/> class with the values
     /// provided.
     /// </summary>
     /// <param name="routeName">The name of the route to use for generating the URL.</param>
     /// <param name="routeValues">The route data to use for generating the URL.</param>
     /// <param name="value">The value to format in the entity body.</param>
-    public AcceptedAtRouteResult(
+    internal AcceptedAtRouteHttpResult(
         string? routeName,
         object? routeValues,
         object? value)
-        : base(value, StatusCodes.Status202Accepted)
     {
+        Value = value;
         RouteName = routeName;
         RouteValues = new RouteValueDictionary(routeValues);
+        HttpResultsHelper.ApplyProblemDetailsDefaultsIfNeeded(Value, StatusCode);
     }
 
+    /// <summary>
+    /// Gets the object result.
+    /// </summary>
+    public object? Value { get; }
+
     /// <summary>
     /// Gets the name of the route to use for generating the URL.
     /// </summary>
@@ -46,12 +59,17 @@ public AcceptedAtRouteResult(
     /// </summary>
     public RouteValueDictionary RouteValues { get; }
 
-    /// <inheritdoc />
-    protected override void ConfigureResponseHeaders(HttpContext context)
+    /// <summary>
+    /// Gets the HTTP status code.
+    /// </summary>
+    public int StatusCode => StatusCodes.Status202Accepted;
+
+    /// <inheritdoc/>
+    public Task ExecuteAsync(HttpContext httpContext)
     {
-        var linkGenerator = context.RequestServices.GetRequiredService<LinkGenerator>();
+        var linkGenerator = httpContext.RequestServices.GetRequiredService<LinkGenerator>();
         var url = linkGenerator.GetUriByAddress(
-            context,
+            httpContext,
             RouteName,
             RouteValues,
             fragment: FragmentString.Empty);
@@ -61,6 +79,11 @@ protected override void ConfigureResponseHeaders(HttpContext context)
             throw new InvalidOperationException("No route matches the supplied values.");
         }
 
-        context.Response.Headers.Location = url;
+        // Creating the logger with a string to preserve the category after the refactoring.
+        var loggerFactory = httpContext.RequestServices.GetRequiredService<ILoggerFactory>();
+        var logger = loggerFactory.CreateLogger("Microsoft.AspNetCore.Http.Result.AcceptedAtRouteResult");
+
+        httpContext.Response.Headers.Location = url;
+        return HttpResultsHelper.WriteResultAsJsonAsync(httpContext, logger, Value, StatusCode);
     }
 }

src/Http/Http.Results/src/AcceptedHttpResult.cs

@@ -0,0 +1,88 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Microsoft.AspNetCore.Http;
+
+using System.Threading.Tasks;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+
+/// <summary>
+/// An <see cref="IResult"/> that on execution will write an object to the response
+/// with status code Accepted (202) and Location header.
+/// Targets a registered route.
+/// </summary>
+public sealed class AcceptedHttpResult : IResult
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AcceptedHttpResult"/> class with the values
+    /// provided.
+    /// </summary>
+    /// <param name="location">The location at which the status of requested content can be monitored.</param>
+    /// <param name="value">The value to format in the entity body.</param>
+    internal AcceptedHttpResult(string? location, object? value)
+    {
+        Value = value;
+        Location = location;
+        HttpResultsHelper.ApplyProblemDetailsDefaultsIfNeeded(Value, StatusCode);
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AcceptedHttpResult"/> class with the values
+    /// provided.
+    /// </summary>
+    /// <param name="locationUri">The location at which the status of requested content can be monitored.</param>
+    /// <param name="value">The value to format in the entity body.</param>
+    internal AcceptedHttpResult(Uri locationUri, object? value)
+    {
+        Value = value;
+        HttpResultsHelper.ApplyProblemDetailsDefaultsIfNeeded(Value, StatusCode);
+
+        if (locationUri == null)
+        {
+            throw new ArgumentNullException(nameof(locationUri));
+        }
+
+        if (locationUri.IsAbsoluteUri)
+        {
+            Location = locationUri.AbsoluteUri;
+        }
+        else
+        {
+            Location = locationUri.GetComponents(UriComponents.SerializationInfoString, UriFormat.UriEscaped);
+        }
+    }
+
+    /// <summary>
+    /// Gets the object result.
+    /// </summary>
+    public object? Value { get; }
+
+    /// <summary>
+    /// Gets the HTTP status code.
+    /// </summary>
+    public int StatusCode => StatusCodes.Status202Accepted;
+
+    /// <summary>
+    /// Gets the location at which the status of the requested content can be monitored.
+    /// </summary>
+    public string? Location { get; }
+
+    /// <inheritdoc/>
+    public Task ExecuteAsync(HttpContext httpContext)
+    {
+        if (!string.IsNullOrEmpty(Location))
+        {
+            httpContext.Response.Headers.Location = Location;
+        }
+
+        // Creating the logger with a string to preserve the category after the refactoring.
+        var loggerFactory = httpContext.RequestServices.GetRequiredService<ILoggerFactory>();
+        var logger = loggerFactory.CreateLogger("Microsoft.AspNetCore.Http.Result.AcceptedResult");
+        return HttpResultsHelper.WriteResultAsJsonAsync(
+                httpContext,
+                logger,
+                Value,
+                StatusCode);
+    }
+}

src/Http/Http.Results/src/AcceptedResult.cs

@@ -0,0 +1,49 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Microsoft.AspNetCore.Http;
+
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+
+/// <summary>
+/// An <see cref="IResult"/> that on execution will write an object to the response
+/// with Bad Request (400) status code.
+/// </summary>
+public sealed class BadRequestObjectHttpResult : IResult
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="BadRequestObjectHttpResult"/> class with the values
+    /// provided.
+    /// </summary>
+    /// <param name="error">The error content to format in the entity body.</param>
+    internal BadRequestObjectHttpResult(object? error)
+    {
+        Value = error;
+        HttpResultsHelper.ApplyProblemDetailsDefaultsIfNeeded(Value, StatusCode);
+    }
+
+    /// <summary>
+    /// Gets the object result.
+    /// </summary>
+    public object? Value { get; internal init; }
+
+    /// <summary>
+    /// Gets the HTTP status code.
+    /// </summary>
+    public int StatusCode => StatusCodes.Status400BadRequest;
+
+    /// <inheritdoc/>
+    public Task ExecuteAsync(HttpContext httpContext)
+    {
+        // Creating the logger with a string to preserve the category after the refactoring.
+        var loggerFactory = httpContext.RequestServices.GetRequiredService<ILoggerFactory>();
+        var logger = loggerFactory.CreateLogger("Microsoft.AspNetCore.Http.Result.BadRequestObjectResult");
+
+        return HttpResultsHelper.WriteResultAsJsonAsync(
+                httpContext,
+                logger: logger,
+                Value,
+                StatusCode);
+    }
+}