Update IRequestCache interface.

Adds a 'Contains' method to test whether a cache entry exists.
avatar29A · Mar 24, 2024 · 6fc3c0e · 6fc3c0e
1 parent dd9d75e
commit 6fc3c0e
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 2 deletions.
diff --git a/src/Hqub.MusicBrainz.Client/FileRequestCache.cs b/src/Hqub.MusicBrainz.Client/FileRequestCache.cs
@@ -38,6 +38,7 @@ public FileRequestCache(string path)
             this.Timeout = TimeSpan.FromHours(24.0);
         }
 
+        /// <inheritdoc />
         public async Task Add(string request, Stream response)
         {
             if (!Directory.Exists(path))
@@ -48,6 +49,23 @@ public async Task Add(string request, Stream response)
             await CacheEntry.Write(path, request, response);
         }
 
+        /// <inheritdoc />
+        public Task<bool> Contains(string request)
+        {
+            return TryGetCachedItem(request, out Stream stream).ContinueWith(task =>
+            {
+                bool exists = task.Result;
+
+                if (task.IsCompleted && exists)
+                {
+                    stream.Dispose();
+                }
+
+                return exists;
+            });
+        }
+
+        /// <inheritdoc />
         public Task<bool> TryGetCachedItem(string request, out Stream stream)
         {
             var item = CacheEntry.Read(path, request);
@@ -61,7 +79,7 @@ public Task<bool> TryGetCachedItem(string request, out Stream stream)
 
             if ((DateTime.Now - item.TimeStamp) > Timeout)
             {
-                item.Stream.Close();
+                item.Stream.Dispose();
 
                 return Task.FromResult(false);
             }

diff --git a/src/Hqub.MusicBrainz/Cache/IRequestCache.cs b/src/Hqub.MusicBrainz/Cache/IRequestCache.cs
@@ -13,9 +13,16 @@ public interface IRequestCache
         /// Add a request and its response to the cache.
         /// </summary>
         /// <param name="request">The request url used to identify the cache item.</param>
-        /// <param name="response">The MusicbBrainz webservice response stream.</param>
+        /// <param name="response">The MusicbBrainz web service response stream.</param>
         Task Add(string request, Stream response);
 
+        /// <summary>
+        /// Test whether the cache contains an entry matching the given request url.
+        /// </summary>
+        /// <param name="request">The request url used to identify the cache item.</param>
+        /// <returns>True, if a cache entry matching the request was found.</returns>
+        Task<bool> Contains(string request);
+
         /// <summary>
         /// Try to find the cached response for given request url.
         /// </summary>

diff --git a/src/Hqub.MusicBrainz/Cache/NullCache.cs b/src/Hqub.MusicBrainz/Cache/NullCache.cs
@@ -28,6 +28,12 @@ public Task Add(string request, Stream response)
 #endif
         }
 
+        /// <inheritdoc />
+        public Task<bool> Contains(string request)
+        {
+            return Task.FromResult(false);
+        }
+
         /// <inheritdoc />
         public Task<bool> TryGetCachedItem(string request, out Stream stream)
         {