Rename HttpCache->GetAsync to GetResponseAsync

Author: rmja

README.md

@@ -13,7 +13,6 @@ It supports file based caching of responses based on the HTTP/1.1 caching header
 - Pluggable caching for `HttpClient`
 - Customizable cache key computation (supports both shared and private caching)
 - Extensible cache entry and cache handler interfaces (defaults to file based caching)
-- Easy integration with dependency injection
 
 ## Getting Started
 

src/HttpClient.Cache/CacheHandler.cs

@@ -19,7 +19,7 @@ CancellationToken cancellationToken
 
         if (CanServeFromCache(request))
         {
-            var result = await cache.GetWithVariationAsync(request, cancellationToken);
+            var result = await cache.GetResponseWithVariationAsync(request, cancellationToken);
             if (result is not null)
             {
                 foundResponse = result.Response;

src/HttpClient.Cache/Files/FileCache.cs

@@ -82,16 +82,16 @@ TimeProvider timeProvider
         );
     }
 
-    public async ValueTask<HttpResponseMessage?> GetAsync(
+    public async ValueTask<HttpResponseMessage?> GetResponseAsync(
         HttpRequestMessage request,
         CancellationToken cancellationToken = default
     )
     {
-        var response = await GetWithVariationAsync(request);
+        var response = await GetResponseWithVariationAsync(request);
         return response?.Response;
     }
 
-    public async ValueTask<ResponseWithVariation?> GetWithVariationAsync(
+    public async ValueTask<ResponseWithVariation?> GetResponseWithVariationAsync(
         HttpRequestMessage request,
         CancellationToken cancellationToken = default
     )
@@ -173,7 +173,7 @@ TimeProvider timeProvider
         return null;
     }
 
-    public async Task<HttpResponseMessage?> SetResponseAsync(
+    public async ValueTask<HttpResponseMessage?> SetResponseAsync(
         HttpResponseMessage response,
         CancellationToken cancellationToken = default
     )

src/HttpClient.Cache/IHttpCache.cs

@@ -10,7 +10,7 @@ public interface IHttpCache : IAsyncDisposable, IDisposable
     /// </summary>
     /// <param name="request">The request</param>
     /// <returns>The cached response, or <see langword="null"/> if the response was not found</returns>
-    ValueTask<HttpResponseMessage?> GetAsync(
+    ValueTask<HttpResponseMessage?> GetResponseAsync(
         HttpRequestMessage request,
         CancellationToken cancellationToken = default
     );
@@ -20,7 +20,7 @@ public interface IHttpCache : IAsyncDisposable, IDisposable
     /// </summary>
     /// <param name="request">The request</param>
     /// <returns>The cached response including variation details, or <see langword="null"/> if the response was not found</returns>
-    ValueTask<ResponseWithVariation?> GetWithVariationAsync(
+    ValueTask<ResponseWithVariation?> GetResponseWithVariationAsync(
         HttpRequestMessage request,
         CancellationToken cancellationToken = default
     );
@@ -30,7 +30,7 @@ public interface IHttpCache : IAsyncDisposable, IDisposable
     /// </summary>
     /// <param name="response">The response to set</param>
     /// <returns>The cached response, or <see langword="null"/> if the response could not be cached</returns>
-    Task<HttpResponseMessage?> SetResponseAsync(
+    ValueTask<HttpResponseMessage?> SetResponseAsync(
         HttpResponseMessage response,
         CancellationToken cancellationToken = default
     );

test/HttpClient.Cache.Tests/File/FileCacheTests.cs

@@ -35,7 +35,7 @@ public async Task Get_KeyDoesNotExist()
         var request = new HttpRequestMessage(HttpMethod.Get, RepoUrl);
 
         // When
-        Assert.Null(await _cache.GetAsync(request, TestContext.Current.CancellationToken));
+        Assert.Null(await _cache.GetResponseAsync(request, TestContext.Current.CancellationToken));
 
         // Then
     }
@@ -67,7 +67,10 @@ public async Task Get_WithoutVariation()
         );
 
         // When
-        using var found = await _cache.GetAsync(request, TestContext.Current.CancellationToken);
+        using var found = await _cache.GetResponseAsync(
+            request,
+            TestContext.Current.CancellationToken
+        );
 
         // Then
         Assert.NotNull(found);
@@ -101,7 +104,7 @@ public async Task Get_WithVariation_SharedSingleHeader()
         );
 
         // When
-        using var found = await _cache.GetWithVariationAsync(
+        using var found = await _cache.GetResponseWithVariationAsync(
             request,
             TestContext.Current.CancellationToken
         );
@@ -135,7 +138,7 @@ public async Task Get_WithVariation_PrivateMultipleHeaders()
         );
 
         // When
-        using var found = await _cache.GetWithVariationAsync(
+        using var found = await _cache.GetResponseWithVariationAsync(
             request,
             TestContext.Current.CancellationToken
         );
@@ -168,14 +171,17 @@ public async Task Set_ResponseExpiration_WithoutVariation()
 
         // Then
         _timeProvider.Advance(TimeSpan.FromSeconds(8));
-        using var notExpired = await _cache.GetAsync(
+        using var notExpired = await _cache.GetResponseAsync(
             request,
             TestContext.Current.CancellationToken
         );
         Assert.Equal(TimeSpan.FromSeconds(2), notExpired?.Headers.CacheControl?.MaxAge);
 
         _timeProvider.Advance(TimeSpan.FromSeconds(10));
-        using var expired = await _cache.GetAsync(request, TestContext.Current.CancellationToken);
+        using var expired = await _cache.GetResponseAsync(
+            request,
+            TestContext.Current.CancellationToken
+        );
         Assert.Null(expired);
     }
 
@@ -203,7 +209,7 @@ public async Task Set_ResponseExpiration_WithVariation()
         );
 
         // Then
-        using var notExpired = await _cache.GetWithVariationAsync(
+        using var notExpired = await _cache.GetResponseWithVariationAsync(
             request,
             TestContext.Current.CancellationToken
         );
@@ -215,7 +221,10 @@ public async Task Set_ResponseExpiration_WithVariation()
         );
 
         _timeProvider.Advance(TimeSpan.FromSeconds(20));
-        using var expired = await _cache.GetAsync(request, TestContext.Current.CancellationToken);
+        using var expired = await _cache.GetResponseAsync(
+            request,
+            TestContext.Current.CancellationToken
+        );
         Assert.Null(expired);
     }
 
@@ -255,14 +264,17 @@ await _cache.RefreshResponseAsync(
 
         // Then
         _timeProvider.Advance(TimeSpan.FromSeconds(8));
-        using var notExpired = await _cache.GetAsync(
+        using var notExpired = await _cache.GetResponseAsync(
             request,
             TestContext.Current.CancellationToken
         );
         Assert.Equal(TimeSpan.FromSeconds(2), notExpired?.Headers.CacheControl?.MaxAge);
 
         _timeProvider.Advance(TimeSpan.FromSeconds(10));
-        using var expired = await _cache.GetAsync(request, TestContext.Current.CancellationToken);
+        using var expired = await _cache.GetResponseAsync(
+            request,
+            TestContext.Current.CancellationToken
+        );
         Assert.Null(expired);
     }
 
@@ -291,13 +303,16 @@ public async Task Refresh_NoMaxAge()
 
         // Then
         _timeProvider.Advance(TimeSpan.FromSeconds(18));
-        using var notExpired = await _cache.GetAsync(
+        using var notExpired = await _cache.GetResponseAsync(
             request,
             TestContext.Current.CancellationToken
         );
 
         _timeProvider.Advance(TimeSpan.FromSeconds(10));
-        using var expired = await _cache.GetAsync(request, TestContext.Current.CancellationToken);
+        using var expired = await _cache.GetResponseAsync(
+            request,
+            TestContext.Current.CancellationToken
+        );
         Assert.Null(expired);
     }
 }