Replace ISystemClock with TimeProvider in ResponseCaching

dotnet · Apr 17, 2023 · d55d2a3 · d55d2a3
1 parent ab46872
commit d55d2a3
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 58 deletions.
diff --git a/src/Middleware/ResponseCaching/src/Interfaces/ISystemClock.cs b/src/Middleware/ResponseCaching/src/Interfaces/ISystemClock.cs
diff --git a/src/Middleware/ResponseCaching/src/ResponseCachingMiddleware.cs b/src/Middleware/ResponseCaching/src/ResponseCachingMiddleware.cs
@@ -142,7 +142,7 @@ internal async Task<bool> TryServeCachedResponseAsync(ResponseCachingContext con
 
         context.CachedResponse = cachedResponse;
         context.CachedResponseHeaders = cachedResponse.Headers;
-        context.ResponseTime = _options.SystemClock.UtcNow;
+        context.ResponseTime = _options.Time.GetUtcNow();
         var cachedEntryAge = context.ResponseTime.Value - context.CachedResponse.Created;
         context.CachedEntryAge = cachedEntryAge > TimeSpan.Zero ? cachedEntryAge : TimeSpan.Zero;
 
@@ -374,7 +374,7 @@ private bool OnStartResponse(ResponseCachingContext context)
         if (!context.ResponseStarted)
         {
             context.ResponseStarted = true;
-            context.ResponseTime = _options.SystemClock.UtcNow;
+            context.ResponseTime = _options.Time.GetUtcNow();
 
             return true;
         }

diff --git a/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs b/src/Middleware/ResponseCaching/src/ResponseCachingOptions.cs
@@ -1,8 +1,6 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System.ComponentModel;
-
 namespace Microsoft.AspNetCore.ResponseCaching;
 
 /// <summary>
@@ -31,6 +29,5 @@ public class ResponseCachingOptions
     /// <summary>
     /// For testing purposes only.
     /// </summary>
-    [EditorBrowsable(EditorBrowsableState.Never)]
-    internal ISystemClock SystemClock { get; set; } = new SystemClock();
+    internal TimeProvider Time { get; set; } = TimeProvider.System;
 }
diff --git a/src/Middleware/ResponseCaching/src/SystemClock.cs b/src/Middleware/ResponseCaching/src/SystemClock.cs
diff --git a/src/Middleware/ResponseCaching/test/ResponseCachingMiddlewareTests.cs b/src/Middleware/ResponseCaching/test/ResponseCachingMiddlewareTests.cs
@@ -356,44 +356,44 @@ public void ContentIsNotModified_IfNoneMatch_MatchesAtLeastOneValue_True()
     [Fact]
     public void StartResponsegAsync_IfAllowResponseCaptureIsTrue_SetsResponseTime()
     {
-        var clock = new TestClock
+        var time = new TestTime
         {
             UtcNow = DateTimeOffset.UtcNow
         };
         var middleware = TestUtils.CreateTestMiddleware(options: new ResponseCachingOptions
         {
-            SystemClock = clock
+            Time = time
         });
         var context = TestUtils.CreateTestContext();
         context.ResponseTime = null;
 
         middleware.StartResponse(context);
 
-        Assert.Equal(clock.UtcNow, context.ResponseTime);
+        Assert.Equal(time.UtcNow, context.ResponseTime);
     }
 
     [Fact]
     public void StartResponseAsync_IfAllowResponseCaptureIsTrue_SetsResponseTimeOnlyOnce()
     {
-        var clock = new TestClock
+        var time = new TestTime
         {
             UtcNow = DateTimeOffset.UtcNow
         };
         var middleware = TestUtils.CreateTestMiddleware(options: new ResponseCachingOptions
         {
-            SystemClock = clock
+            Time = time
         });
         var context = TestUtils.CreateTestContext();
-        var initialTime = clock.UtcNow;
+        var initialTime = time.UtcNow;
         context.ResponseTime = null;
 
         middleware.StartResponse(context);
         Assert.Equal(initialTime, context.ResponseTime);
 
-        clock.UtcNow += TimeSpan.FromSeconds(10);
+        time.UtcNow += TimeSpan.FromSeconds(10);
 
         middleware.StartResponse(context);
-        Assert.NotEqual(clock.UtcNow, context.ResponseTime);
+        Assert.NotEqual(time.UtcNow, context.ResponseTime);
         Assert.Equal(initialTime, context.ResponseTime);
     }
 
@@ -448,19 +448,19 @@ public void FinalizeCacheHeadersAsync_DefaultResponseValidity_Is10Seconds()
     [Fact]
     public void FinalizeCacheHeadersAsync_ResponseValidity_UseExpiryIfAvailable()
     {
-        var clock = new TestClock
+        var time = new TestTime
         {
             UtcNow = DateTimeOffset.MinValue
         };
         var sink = new TestSink();
         var middleware = TestUtils.CreateTestMiddleware(testSink: sink, options: new ResponseCachingOptions
         {
-            SystemClock = clock
+            Time = time
         });
         var context = TestUtils.CreateTestContext();
 
-        context.ResponseTime = clock.UtcNow;
-        context.HttpContext.Response.Headers.Expires = HeaderUtilities.FormatDate(clock.UtcNow + TimeSpan.FromSeconds(11));
+        context.ResponseTime = time.UtcNow;
+        context.HttpContext.Response.Headers.Expires = HeaderUtilities.FormatDate(time.UtcNow + TimeSpan.FromSeconds(11));
 
         middleware.FinalizeCacheHeaders(context);
 
@@ -471,24 +471,24 @@ public void FinalizeCacheHeadersAsync_ResponseValidity_UseExpiryIfAvailable()
     [Fact]
     public void FinalizeCacheHeadersAsync_ResponseValidity_UseMaxAgeIfAvailable()
     {
-        var clock = new TestClock
+        var time = new TestTime
         {
             UtcNow = DateTimeOffset.UtcNow
         };
         var sink = new TestSink();
         var middleware = TestUtils.CreateTestMiddleware(testSink: sink, options: new ResponseCachingOptions
         {
-            SystemClock = clock
+            Time = time
         });
         var context = TestUtils.CreateTestContext();
 
-        context.ResponseTime = clock.UtcNow;
+        context.ResponseTime = time.UtcNow;
         context.HttpContext.Response.Headers.CacheControl = new CacheControlHeaderValue()
         {
             MaxAge = TimeSpan.FromSeconds(12)
         }.ToString();
 
-        context.HttpContext.Response.Headers.Expires = HeaderUtilities.FormatDate(clock.UtcNow + TimeSpan.FromSeconds(11));
+        context.HttpContext.Response.Headers.Expires = HeaderUtilities.FormatDate(time.UtcNow + TimeSpan.FromSeconds(11));
 
         middleware.FinalizeCacheHeaders(context);
 
@@ -499,24 +499,24 @@ public void FinalizeCacheHeadersAsync_ResponseValidity_UseMaxAgeIfAvailable()
     [Fact]
     public void FinalizeCacheHeadersAsync_ResponseValidity_UseSharedMaxAgeIfAvailable()
     {
-        var clock = new TestClock
+        var time = new TestTime
         {
             UtcNow = DateTimeOffset.UtcNow
         };
         var sink = new TestSink();
         var middleware = TestUtils.CreateTestMiddleware(testSink: sink, options: new ResponseCachingOptions
         {
-            SystemClock = clock
+            Time = time
         });
         var context = TestUtils.CreateTestContext();
 
-        context.ResponseTime = clock.UtcNow;
+        context.ResponseTime = time.UtcNow;
         context.HttpContext.Response.Headers.CacheControl = new CacheControlHeaderValue()
         {
             MaxAge = TimeSpan.FromSeconds(12),
             SharedMaxAge = TimeSpan.FromSeconds(13)
         }.ToString();
-        context.HttpContext.Response.Headers.Expires = HeaderUtilities.FormatDate(clock.UtcNow + TimeSpan.FromSeconds(11));
+        context.HttpContext.Response.Headers.Expires = HeaderUtilities.FormatDate(time.UtcNow + TimeSpan.FromSeconds(11));
 
         middleware.FinalizeCacheHeaders(context);
 

diff --git a/src/Middleware/ResponseCaching/test/TestUtils.cs b/src/Middleware/ResponseCaching/test/TestUtils.cs
@@ -172,7 +172,7 @@ internal static IResponseCachingKeyProvider CreateTestKeyProvider(ResponseCachin
                             {
                                 responseCachingOptions.MaximumBodySize = options.MaximumBodySize;
                                 responseCachingOptions.UseCaseSensitivePaths = options.UseCaseSensitivePaths;
-                                responseCachingOptions.SystemClock = options.SystemClock;
+                                responseCachingOptions.Time = options.Time;
                             }
                         });
                     })
@@ -390,7 +390,9 @@ public void Set(string key, IResponseCacheEntry entry, TimeSpan validFor)
     }
 }
 
-internal class TestClock : ISystemClock
+internal class TestTime : TimeProvider
 {
     public DateTimeOffset UtcNow { get; set; }
+
+    public override DateTimeOffset GetUtcNow() => UtcNow;
 }