Apply PR feedback

Author: sebastienros

src/Middleware/OutputCaching/src/CachedResponseBody.cs

@@ -8,7 +8,7 @@ namespace Microsoft.AspNetCore.OutputCaching;
 /// <summary>
 /// Represents a cached response body.
 /// </summary>
-public class CachedResponseBody
+internal sealed class CachedResponseBody
 {
     /// <summary>
     /// Creates a new <see cref="CachedResponseBody"/> instance.

src/Middleware/OutputCaching/src/IOutputCacheStore.cs

@@ -12,17 +12,17 @@ public interface IOutputCacheStore
     /// Evicts cached responses by tag.
     /// </summary>
     /// <param name="tag">The tag to evict.</param>
-    /// <param name="token">Indicates that the operation should be cancelled.</param>
-    ValueTask EvictByTagAsync(string tag, CancellationToken token);
+    /// <param name="cancellationToken">Indicates that the operation should be cancelled.</param>
+    ValueTask EvictByTagAsync(string tag, CancellationToken cancellationToken);
 
     /// <summary>
     /// Gets the cached response for the given key, if it exists.
     /// If no cached response exists for the given key, <c>null</c> is returned.
     /// </summary>
     /// <param name="key">The cache key to look up.</param>
-    /// <param name="token">Indicates that the operation should be cancelled.</param>
+    /// <param name="cancellationToken">Indicates that the operation should be cancelled.</param>
     /// <returns>The response cache entry if it exists; otherwise <c>null</c>.</returns>
-    ValueTask<byte[]?> GetAsync(string key, CancellationToken token);
+    ValueTask<byte[]?> GetAsync(string key, CancellationToken cancellationToken);
 
     /// <summary>
     /// Stores the given response in the response cache.
@@ -31,6 +31,6 @@ public interface IOutputCacheStore
     /// <param name="value">The response cache entry to store.</param>
     /// <param name="tags">The tags associated with the cache entry to store.</param>
     /// <param name="validFor">The amount of time the entry will be kept in the cache before expiring, relative to now.</param>
-    /// <param name="token">Indicates that the operation should be cancelled.</param>
-    ValueTask SetAsync(string key, byte[] value, string[] tags, TimeSpan validFor, CancellationToken token);
+    /// <param name="cancellationToken">Indicates that the operation should be cancelled.</param>
+    ValueTask SetAsync(string key, byte[] value, string[] tags, TimeSpan validFor, CancellationToken cancellationToken);
 }

src/Middleware/OutputCaching/src/Memory/MemoryOutputCacheStore.cs

@@ -18,7 +18,7 @@ internal MemoryOutputCacheStore(IMemoryCache cache)
         _cache = cache;
     }
 
-    public ValueTask EvictByTagAsync(string tag, CancellationToken token)
+    public ValueTask EvictByTagAsync(string tag, CancellationToken cancellationToken)
     {
         ArgumentNullException.ThrowIfNull(tag);
 
@@ -34,7 +34,7 @@ public ValueTask EvictByTagAsync(string tag, CancellationToken token)
     }
 
     /// <inheritdoc />
-    public ValueTask<byte[]?> GetAsync(string key, CancellationToken token)
+    public ValueTask<byte[]?> GetAsync(string key, CancellationToken cancellationToken)
     {
         ArgumentNullException.ThrowIfNull(key);
 
@@ -43,7 +43,7 @@ public ValueTask EvictByTagAsync(string tag, CancellationToken token)
     }
 
     /// <inheritdoc />
-    public ValueTask SetAsync(string key, byte[] value, string[] tags, TimeSpan validFor, CancellationToken token)
+    public ValueTask SetAsync(string key, byte[] value, string[] tags, TimeSpan validFor, CancellationToken cancellationToken)
     {
         ArgumentNullException.ThrowIfNull(key);
         ArgumentNullException.ThrowIfNull(value);

src/Middleware/OutputCaching/src/OutputCacheAttribute.cs

@@ -7,7 +7,7 @@ namespace Microsoft.AspNetCore.OutputCaching;
 /// Specifies the parameters necessary for setting appropriate headers in output caching.
 /// </summary>
 [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
-public class OutputCacheAttribute : Attribute
+public sealed class OutputCacheAttribute : Attribute
 {
     // A nullable-int cannot be used as an Attribute parameter.
     // Hence this nullable-int is present to back the Duration property.

src/Middleware/OutputCaching/src/OutputCacheEntryFormatter.cs

@@ -9,13 +9,13 @@ namespace Microsoft.AspNetCore.OutputCaching;
 /// <summary>
 /// Formats <see cref="OutputCacheEntry"/> instance to match structures supported by the <see cref="IOutputCacheStore"/> implementations.
 /// </summary>
-internal class OutputCacheEntryFormatter
+internal static class OutputCacheEntryFormatter
 {
-    public static async ValueTask<OutputCacheEntry?> GetAsync(string key, IOutputCacheStore store, CancellationToken token)
+    public static async ValueTask<OutputCacheEntry?> GetAsync(string key, IOutputCacheStore store, CancellationToken cancellationToken)
     {
         ArgumentNullException.ThrowIfNull(key);
 
-        var content = await store.GetAsync(key, token);
+        var content = await store.GetAsync(key, cancellationToken);
 
         if (content == null)
         {
@@ -24,7 +24,7 @@ internal class OutputCacheEntryFormatter
 
         using var br = new MemoryStream(content);
 
-        var formatter = await JsonSerializer.DeserializeAsync(br, FormatterEntrySerializerContext.Default.FormatterEntry, cancellationToken: token);
+        var formatter = await JsonSerializer.DeserializeAsync(br, FormatterEntrySerializerContext.Default.FormatterEntry, cancellationToken: cancellationToken);
 
         if (formatter == null)
         {
@@ -52,7 +52,7 @@ internal class OutputCacheEntryFormatter
         return outputCacheEntry;
     }
 
-    public static async ValueTask StoreAsync(string key, OutputCacheEntry value, TimeSpan duration, IOutputCacheStore store, CancellationToken token)
+    public static async ValueTask StoreAsync(string key, OutputCacheEntry value, TimeSpan duration, IOutputCacheStore store, CancellationToken cancellationToken)
     {
         ArgumentNullException.ThrowIfNull(value);
 
@@ -75,7 +75,7 @@ public static async ValueTask StoreAsync(string key, OutputCacheEntry value, Tim
 
         using var br = new MemoryStream();
 
-        await JsonSerializer.SerializeAsync(br, formatterEntry, FormatterEntrySerializerContext.Default.FormatterEntry, token);
-        await store.SetAsync(key, br.ToArray(), value.Tags ?? Array.Empty<string>(), duration, token);
+        await JsonSerializer.SerializeAsync(br, formatterEntry, FormatterEntrySerializerContext.Default.FormatterEntry, cancellationToken);
+        await store.SetAsync(key, br.ToArray(), value.Tags ?? Array.Empty<string>(), duration, cancellationToken);
     }
 }

src/Middleware/OutputCaching/src/OutputCacheKeyProvider.cs

@@ -174,7 +174,7 @@ public string CreateStorageKey(OutputCacheContext context)
         }
     }
 
-    private class QueryKeyComparer : IComparer<KeyValuePair<string, StringValues>>
+    private sealed class QueryKeyComparer : IComparer<KeyValuePair<string, StringValues>>
     {
         private readonly StringComparer _stringComparer;
 

src/Middleware/OutputCaching/src/OutputCacheMiddleware.cs

@@ -14,7 +14,7 @@ namespace Microsoft.AspNetCore.OutputCaching;
 /// <summary>
 /// Enable HTTP response caching.
 /// </summary>
-internal class OutputCacheMiddleware
+internal sealed class OutputCacheMiddleware
 {
     // see https://tools.ietf.org/html/rfc7232#section-4.1
     private static readonly string[] HeadersToIncludeIn304 =
@@ -79,15 +79,19 @@ internal OutputCacheMiddleware(
     /// </summary>
     /// <param name="httpContext">The <see cref="HttpContext"/>.</param>
     /// <returns>A <see cref="Task"/> that completes when the middleware has completed processing.</returns>
-    public async Task Invoke(HttpContext httpContext)
+    public Task Invoke(HttpContext httpContext)
     {
         // Skip the middleware if there is no policy for the current request
         if (!TryGetRequestPolicies(httpContext, out var policies))
         {
-            await _next(httpContext);
-            return;
+            return _next(httpContext);
         }
 
+        return InvokeAwaited(httpContext, policies);
+    }
+
+    private async Task InvokeAwaited(HttpContext httpContext, IReadOnlyList<IOutputCachePolicy> policies)
+    {
         var context = new OutputCacheContext(httpContext, _store, _options, _logger);
 
         // Add IOutputCacheFeature

src/Middleware/OutputCaching/src/Policies/VaryByQueryPolicy.cs

@@ -11,7 +11,7 @@ namespace Microsoft.AspNetCore.OutputCaching;
 /// </summary>
 internal sealed class VaryByQueryPolicy : IOutputCachePolicy
 {
-    private StringValues _queryKeys { get; set; }
+    private readonly StringValues _queryKeys;
 
     /// <summary>
     /// Creates a policy that doesn't vary the cached content based on query string.

src/Middleware/OutputCaching/src/PublicAPI.Unshipped.txt

@@ -1,10 +1,5 @@
 #nullable enable
 Microsoft.AspNetCore.Builder.OutputCacheApplicationBuilderExtensions
-Microsoft.AspNetCore.OutputCaching.CachedResponseBody
-Microsoft.AspNetCore.OutputCaching.CachedResponseBody.CachedResponseBody(System.Collections.Generic.List<byte[]!>! segments, long length) -> void
-Microsoft.AspNetCore.OutputCaching.CachedResponseBody.CopyToAsync(System.IO.Pipelines.PipeWriter! destination, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task!
-Microsoft.AspNetCore.OutputCaching.CachedResponseBody.Length.get -> long
-Microsoft.AspNetCore.OutputCaching.CachedResponseBody.Segments.get -> System.Collections.Generic.List<byte[]!>!
 Microsoft.AspNetCore.OutputCaching.CachedVaryByRules
 Microsoft.AspNetCore.OutputCaching.CachedVaryByRules.CachedVaryByRules() -> void
 Microsoft.AspNetCore.OutputCaching.CachedVaryByRules.Headers.get -> Microsoft.Extensions.Primitives.StringValues
@@ -20,10 +15,10 @@ Microsoft.AspNetCore.OutputCaching.IOutputCachePolicy.CacheRequestAsync(Microsof
 Microsoft.AspNetCore.OutputCaching.IOutputCachePolicy.ServeFromCacheAsync(Microsoft.AspNetCore.OutputCaching.OutputCacheContext! context) -> System.Threading.Tasks.ValueTask
 Microsoft.AspNetCore.OutputCaching.IOutputCachePolicy.ServeResponseAsync(Microsoft.AspNetCore.OutputCaching.OutputCacheContext! context) -> System.Threading.Tasks.ValueTask
 Microsoft.AspNetCore.OutputCaching.IOutputCacheStore
-Microsoft.AspNetCore.OutputCaching.IOutputCacheStore.EvictByTagAsync(string! tag, System.Threading.CancellationToken token) -> System.Threading.Tasks.ValueTask
+Microsoft.AspNetCore.OutputCaching.IOutputCacheStore.EvictByTagAsync(string! tag, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask
 Microsoft.AspNetCore.OutputCaching.IOutputCachePolicy
-Microsoft.AspNetCore.OutputCaching.IOutputCacheStore.GetAsync(string! key, System.Threading.CancellationToken token) -> System.Threading.Tasks.ValueTask<byte[]?>
-Microsoft.AspNetCore.OutputCaching.IOutputCacheStore.SetAsync(string! key, byte[]! value, string![]! tags, System.TimeSpan validFor, System.Threading.CancellationToken token) -> System.Threading.Tasks.ValueTask
+Microsoft.AspNetCore.OutputCaching.IOutputCacheStore.GetAsync(string! key, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask<byte[]?>
+Microsoft.AspNetCore.OutputCaching.IOutputCacheStore.SetAsync(string! key, byte[]! value, string![]! tags, System.TimeSpan validFor, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.ValueTask
 Microsoft.AspNetCore.OutputCaching.OutputCacheAttribute
 Microsoft.AspNetCore.OutputCaching.OutputCacheAttribute.Duration.get -> int
 Microsoft.AspNetCore.OutputCaching.OutputCacheAttribute.Duration.init -> void