Cleanup Results helper (#34296)

* Cleanup Results helper

* Add Results.Bytes, Results.Stream, and Results.Text overloads.
* Consolidate Physical and Virtual files helpers.
* Use default arguments to consolidate overloads.
* Remove Accepted(Uri?) / Accepted(Uri?, object? value) overload to remove ambiguity with AcceptedAt(string?, object? value);

Author: pranavkm

src/Http/Http.Extensions/src/ResponseHeaders.cs

@@ -153,7 +153,7 @@ public DateTimeOffset? Expires
         }
 
         /// <summary>
-        /// Gets or sets the <c>Last=Modified</c> header for an HTTP response.
+        /// Gets or sets the <c>Last-Modified</c> header for an HTTP response.
         /// </summary>
         public DateTimeOffset? LastModified
         {

src/Http/Http.Results/src/AcceptedAtRouteResult.cs

@@ -1,7 +1,6 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-using System;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -48,7 +47,7 @@ public AcceptedAtRouteResult(
         public RouteValueDictionary RouteValues { get; }
 
         /// <inheritdoc />
-        protected override void OnFormatting(HttpContext context)
+        protected override void ConfigureResponseHeaders(HttpContext context)
         {
             var linkGenerator = context.RequestServices.GetRequiredService<LinkGenerator>();
             var url = linkGenerator.GetUriByAddress(

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

@@ -58,13 +58,8 @@ public AcceptedResult(Uri locationUri, object? value)
         public string? Location { get; set; }
 
         /// <inheritdoc />
-        protected override void OnFormatting(HttpContext context)
+        protected override void ConfigureResponseHeaders(HttpContext context)
         {
-            if (context == null)
-            {
-                throw new ArgumentNullException(nameof(context));
-            }
-
             if (!string.IsNullOrEmpty(Location))
             {
                 context.Response.Headers.Location = Location;

src/Http/Http.Results/src/BadRequestResult.cs

@@ -48,7 +48,7 @@ public CreatedAtRouteResult(
         public RouteValueDictionary? RouteValues { get; set; }
 
         /// <inheritdoc />
-        protected override void OnFormatting(HttpContext context)
+        protected override void ConfigureResponseHeaders(HttpContext context)
         {
             var linkGenerator = context.RequestServices.GetRequiredService<LinkGenerator>();
             var url = linkGenerator.GetUriByRouteValues(

src/Http/Http.Results/src/ConflictResult.cs

@@ -49,7 +49,7 @@ public CreatedResult(Uri location, object? value)
         public string Location { get; init; }
 
         /// <inheritdoc />
-        protected override void OnFormatting(HttpContext context)
+        protected override void ConfigureResponseHeaders(HttpContext context)
         {
             context.Response.Headers.Location = Location;
         }

src/Http/Http.Results/src/CreatedAtRouteResult.cs

@@ -1,8 +1,6 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-using System.IO;
-using System.Threading.Tasks;
 using Microsoft.AspNetCore.Internal;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
@@ -18,7 +16,7 @@ internal sealed partial class FileContentResult : FileResult, IResult
         /// </summary>
         /// <param name="fileContents">The bytes that represent the file contents.</param>
         /// <param name="contentType">The Content-Type header of the response.</param>
-        public FileContentResult(byte[] fileContents, string contentType)
+        public FileContentResult(byte[] fileContents, string? contentType)
             : base(contentType)
         {
             FileContents = fileContents;

src/Http/Http.Results/src/CreatedResult.cs

@@ -1,7 +1,6 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-using System;
 using System.Diagnostics.CodeAnalysis;
 using Microsoft.Extensions.Logging;
 using Microsoft.Net.Http.Headers;
@@ -17,14 +16,9 @@ internal abstract partial class FileResult
         /// the provided <paramref name="contentType"/>.
         /// </summary>
         /// <param name="contentType">The Content-Type header of the response.</param>
-        protected FileResult(string contentType)
+        protected FileResult(string? contentType)
         {
-            if (contentType == null)
-            {
-                throw new ArgumentNullException(nameof(contentType));
-            }
-
-            ContentType = contentType;
+            ContentType = contentType ?? "application/octet-stream";
         }
 
         /// <summary>

src/Http/Http.Results/src/FileContentResult.cs

@@ -1,13 +1,9 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-using System;
-using System.IO;
-using System.Threading.Tasks;
 using Microsoft.AspNetCore.Internal;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
-using Microsoft.Net.Http.Headers;
 
 namespace Microsoft.AspNetCore.Http.Result
 {
@@ -24,26 +20,8 @@ internal sealed class FileStreamResult : FileResult, IResult
         /// </summary>
         /// <param name="fileStream">The stream with the file.</param>
         /// <param name="contentType">The Content-Type header of the response.</param>
-        public FileStreamResult(Stream fileStream, string contentType)
-            : this(fileStream, MediaTypeHeaderValue.Parse(contentType))
-        {
-            if (fileStream == null)
-            {
-                throw new ArgumentNullException(nameof(fileStream));
-            }
-
-            FileStream = fileStream;
-        }
-
-        /// <summary>
-        /// Creates a new <see cref="FileStreamResult"/> instance with
-        /// the provided <paramref name="fileStream"/> and the
-        /// provided <paramref name="contentType"/>.
-        /// </summary>
-        /// <param name="fileStream">The stream with the file.</param>
-        /// <param name="contentType">The Content-Type header of the response.</param>
-        public FileStreamResult(Stream fileStream, MediaTypeHeaderValue contentType)
-            : base(contentType.ToString())
+        public FileStreamResult(Stream fileStream, string? contentType)
+            : base(contentType)
         {
             if (fileStream == null)
             {
@@ -58,10 +36,10 @@ public FileStreamResult(Stream fileStream, MediaTypeHeaderValue contentType)
         /// </summary>
         public Stream FileStream { get; }
 
-        public Task ExecuteAsync(HttpContext httpContext)
+        public async Task ExecuteAsync(HttpContext httpContext)
         {
             var logger = httpContext.RequestServices.GetRequiredService<ILogger<FileStreamResult>>();
-            using (FileStream)
+            await using (FileStream)
             {
                 Log.ExecutingFileResult(logger, this);
 
@@ -90,20 +68,20 @@ public Task ExecuteAsync(HttpContext httpContext)
 
                 if (!serveBody)
                 {
-                    return Task.CompletedTask;
+                    return;
                 }
 
                 if (range != null && rangeLength == 0)
                 {
-                    return Task.CompletedTask;
+                    return;
                 }
 
                 if (range != null)
                 {
                     FileResultHelper.Log.WritingRangeToBody(logger);
                 }
 
-                return FileResultHelper.WriteFileAsync(httpContext, FileStream, range, rangeLength);
+                await FileResultHelper.WriteFileAsync(httpContext, FileStream, range, rangeLength);
             }
         }
     }