PR feedback

Author: khellang

benchmarks/Microsoft.AspNetCore.ResponseCompression.Benchmarks/AssemblyInfo.cs

@@ -1 +1,4 @@
-[assembly: BenchmarkDotNet.Attributes.AspNetCoreBenchmark]
+// 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.
+
+[assembly: BenchmarkDotNet.Attributes.AspNetCoreBenchmark]

benchmarks/Microsoft.AspNetCore.ResponseCompression.Benchmarks/ResponseCompressionProviderBenchmark.cs

@@ -1,4 +1,7 @@
-using System.Collections.Generic;
+// 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.Collections.Generic;
 using BenchmarkDotNet.Attributes;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;

src/Microsoft.AspNetCore.ResponseCompression/BrotliCompressionProvider.cs

@@ -41,6 +41,7 @@ public Stream CreateStream(Stream outputStream)
 #if NETCOREAPP2_1
             return new BrotliStream(outputStream, Options.Level, leaveOpen: true);
 #elif NET461 || NETSTANDARD2_0
+            // Brotli is only supported in .NET Core 2.1+
             throw new PlatformNotSupportedException();
 #else
 #error Target frameworks need to be updated.

src/Microsoft.AspNetCore.ResponseCompression/ResponseCompressionOptions.cs

@@ -22,7 +22,8 @@ public class ResponseCompressionOptions
         public bool EnableForHttps { get; set; } = false;
 
         /// <summary>
-        /// The ICompressionProviders to use for responses.
+        /// The <see cref="ICompressionProvider"/> types to use for responses.
+        /// Providers are prioritized based on the order they are added.
         /// </summary>
         public CompressionProviderCollection Providers { get; } = new CompressionProviderCollection();
     }

src/Microsoft.AspNetCore.ResponseCompression/ResponseCompressionProvider.cs

@@ -125,7 +125,9 @@ public virtual ICompressionProvider GetCompressionProvider(HttpContext context)
 
                     if (StringSegment.Equals("identity", encodingName, StringComparison.OrdinalIgnoreCase))
                     {
-                        candidates.Add(new ProviderCandidate(encodingName.Value, quality, int.MaxValue, null));
+                        // We add 'identity' to the list of "candidates" with a very low priority and no provider.
+                        // This will allow it to be ordered based on its quality (and priority) later in the method.
+                        candidates.Add(new ProviderCandidate(encodingName.Value, quality, priority: int.MaxValue, provider: null));
                     }
                 }