optimize cache logic

nager · Feb 13, 2024 · 4a5bfd7 · 4a5bfd7
1 parent 6a82eb0
commit 4a5bfd7
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 18 deletions.
diff --git a/src/Nager.PublicSuffix.UnitTest/RuleProviderTest.cs b/src/Nager.PublicSuffix.UnitTest/RuleProviderTest.cs
@@ -1,7 +1,7 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Nager.PublicSuffix.CacheProviders;
 using Nager.PublicSuffix.RuleProviders;
-using System.Linq;
 using System.Net.Http;
 using System.Threading.Tasks;
 
@@ -18,7 +18,8 @@ public async Task WebTldRuleProviderTest()
 
             var configuration = builder.Build();
 
-            var webRuleProvider = new WebRuleProvider(configuration, httpClient);
+            var cacheProvider = new LocalFileSystemCacheProvider();
+            var webRuleProvider = new WebRuleProvider(configuration, cacheProvider, httpClient);
             var domainDataStructure = await webRuleProvider.BuildAsync();
             Assert.IsNotNull(domainDataStructure);
         }

diff --git a/src/Nager.PublicSuffix.WebApi/Program.cs b/src/Nager.PublicSuffix.WebApi/Program.cs
@@ -1,4 +1,5 @@
 using Nager.PublicSuffix;
+using Nager.PublicSuffix.CacheProviders;
 using Nager.PublicSuffix.RuleProviders;
 using System.Text.Json.Serialization;
 
@@ -7,6 +8,7 @@
 // Add services to the container.
 
 builder.Services.AddHttpClient();
+builder.Services.AddSingleton<ICacheProvider, LocalFileSystemCacheProvider>();
 builder.Services.AddSingleton<IRuleProvider, WebRuleProvider>();
 builder.Services.AddSingleton<IDomainParser, DomainParser>();
 

diff --git a/...uffix/CacheProviders/FileCacheProvider.cs → ...Providers/LocalFileSystemCacheProvider.cs b/...uffix/CacheProviders/FileCacheProvider.cs → ...Providers/LocalFileSystemCacheProvider.cs
@@ -5,20 +5,22 @@
 namespace Nager.PublicSuffix.CacheProviders
 {
     /// <summary>
-    /// FileCacheProvider, write the data to a cache file in the temp directory
+    /// LocalFileSystemCacheProvider, write the data to a cache file in the temp directory
     /// </summary>
-    public class FileCacheProvider : ICacheProvider
+    public class LocalFileSystemCacheProvider : ICacheProvider
     {
         private readonly string _cacheFilePath;
         private readonly TimeSpan _timeToLive;
 
         /// <summary>
-        /// FileCacheProvider
+        /// LocalFileSystemCacheProvider
         /// </summary>
         /// <param name="cacheFileName"></param>
+        /// <param name="cachePath">The path of the cache file, default use the temp path of the os</param>
         /// <param name="cacheTimeToLive"></param>
-        public FileCacheProvider(
+        public LocalFileSystemCacheProvider(
             string cacheFileName = "publicsuffixcache.dat",
+            string? cachePath = null,
             TimeSpan? cacheTimeToLive = null)
         {
             if (cacheTimeToLive.HasValue)
@@ -30,7 +32,7 @@ public FileCacheProvider(
                 this._timeToLive = TimeSpan.FromDays(1);
             }
 
-            var tempPath = Path.GetTempPath();
+            var tempPath = cachePath ?? Path.GetTempPath();
             this._cacheFilePath = Path.Combine(tempPath, cacheFileName);
         }
 

diff --git a/src/Nager.PublicSuffix/RuleProviders/WebRuleProvider.cs b/src/Nager.PublicSuffix/RuleProviders/WebRuleProvider.cs
@@ -31,13 +31,15 @@ public class WebRuleProvider : IRuleProvider
         /// </summary>
         /// <remarks>It is possible to overwrite the url via configuration parameters <c>Nager:PublicSuffix:DataUrl</c></remarks>
         /// <param name="configuration"></param>
+        /// <param name="cacheProvider"></param>
         /// <param name="httpClient"></param>
-        /// <param name="cacheProvider">default is <see cref="FileCacheProvider"/></param>
         public WebRuleProvider(
             IConfiguration configuration,
-            HttpClient httpClient,
-            ICacheProvider cacheProvider = null)
+            ICacheProvider cacheProvider,
+            HttpClient httpClient
+            )
         {
+            this._cacheProvider = cacheProvider;
             this._httpClient = httpClient;
 
             var url = configuration["Nager:PublicSuffix:DataUrl"];
@@ -47,14 +49,6 @@ public WebRuleProvider(
             }
 
             this._dataFileUrl = url;
-
-            if (cacheProvider == null)
-            {
-                this._cacheProvider = new FileCacheProvider();
-                return;
-            }
-
-            this._cacheProvider = cacheProvider;
         }
 
         /// <inheritdoc/>