add ilogger

nager · Feb 13, 2024 · 7f2cbf1 · 7f2cbf1
1 parent 4a5bfd7
commit 7f2cbf1
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 10 deletions.
diff --git a/src/Nager.PublicSuffix.UnitTest/Helpers/LoggerHelper.cs b/src/Nager.PublicSuffix.UnitTest/Helpers/LoggerHelper.cs
@@ -0,0 +1,37 @@
+using Microsoft.Extensions.Logging;
+using Moq;
+using System;
+using System.Diagnostics;
+
+namespace Nager.PublicSuffix.UnitTest.Helpers
+{
+    public static class LoggerHelper
+    {
+        public static Mock<ILogger<T>> GetLogger<T>()
+        {
+            var logger = new Mock<ILogger<T>>();
+
+            logger.Setup(x => x.Log(
+                It.IsAny<LogLevel>(),
+                It.IsAny<EventId>(),
+                It.IsAny<It.IsAnyType>(),
+                It.IsAny<Exception>(),
+                (Func<It.IsAnyType, Exception?, string>)It.IsAny<object>()))
+                .Callback(new InvocationAction(invocation =>
+                {
+                    var logLevel = (LogLevel)invocation.Arguments[0]; // The first two will always be whatever is specified in the setup above
+                    var eventId = (EventId)invocation.Arguments[1];  // so I'm not sure you would ever want to actually use them
+                    var state = invocation.Arguments[2];
+                    var exception = (Exception)invocation.Arguments[3];
+                    var formatter = invocation.Arguments[4];
+
+                    var invokeMethod = formatter.GetType().GetMethod("Invoke");
+                    var logMessage = (string?)invokeMethod?.Invoke(formatter, new[] { state, exception });
+
+                    Trace.WriteLine($"{logLevel} - {logMessage}");
+                }));
+
+            return logger;
+        }
+    }
+}
diff --git a/src/Nager.PublicSuffix.UnitTest/Nager.PublicSuffix.UnitTest.csproj b/src/Nager.PublicSuffix.UnitTest/Nager.PublicSuffix.UnitTest.csproj
@@ -9,6 +9,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Configuration" Version="8.0.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
+    <PackageReference Include="Moq" Version="4.20.70" />
     <PackageReference Include="MSTest.TestAdapter" Version="3.2.0" />
     <PackageReference Include="MSTest.TestFramework" Version="3.2.0" />
   </ItemGroup>

diff --git a/src/Nager.PublicSuffix.UnitTest/RuleProviderTest.cs b/src/Nager.PublicSuffix.UnitTest/RuleProviderTest.cs
@@ -2,6 +2,7 @@
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Nager.PublicSuffix.CacheProviders;
 using Nager.PublicSuffix.RuleProviders;
+using Nager.PublicSuffix.UnitTest.Helpers;
 using System.Net.Http;
 using System.Threading.Tasks;
 
@@ -13,13 +14,15 @@ public class RuleProviderTest
         [TestMethod]
         public async Task WebTldRuleProviderTest()
         {
+            var loggerMock = LoggerHelper.GetLogger<WebRuleProvider>();
+
             var builder = new ConfigurationBuilder();
             using var httpClient = new HttpClient();
 
             var configuration = builder.Build();
 
             var cacheProvider = new LocalFileSystemCacheProvider();
-            var webRuleProvider = new WebRuleProvider(configuration, cacheProvider, httpClient);
+            var webRuleProvider = new WebRuleProvider(loggerMock.Object, configuration, cacheProvider, httpClient);
             var domainDataStructure = await webRuleProvider.BuildAsync();
             Assert.IsNotNull(domainDataStructure);
         }

diff --git a/src/Nager.PublicSuffix/CacheProviders/ICacheProvider.cs b/src/Nager.PublicSuffix/CacheProviders/ICacheProvider.cs
@@ -8,13 +8,13 @@ namespace Nager.PublicSuffix.CacheProviders
     public interface ICacheProvider
     {
         /// <summary>
-        /// Get the data of the cache file
+        /// Get the data from the cache
         /// </summary>
         /// <returns>Returns null if the cache has expired</returns>
         Task<string> GetAsync();
 
         /// <summary>
-        /// Create or update the cache file
+        /// Store data in the cache
         /// </summary>
         /// <param name="data"></param>
         /// <returns></returns>

diff --git a/src/Nager.PublicSuffix/CacheProviders/LocalFileSystemCacheProvider.cs b/src/Nager.PublicSuffix/CacheProviders/LocalFileSystemCacheProvider.cs
@@ -36,7 +36,7 @@ public LocalFileSystemCacheProvider(
             this._cacheFilePath = Path.Combine(tempPath, cacheFileName);
         }
 
-        ///<inheritdoc/>
+        /// <inheritdoc/>
         public bool IsCacheValid()
         {
             var cacheInvalid = true;
@@ -53,7 +53,7 @@ public bool IsCacheValid()
             return !cacheInvalid;
         }
 
-        ///<inheritdoc/>
+        /// <inheritdoc/>
         public async Task<string> GetAsync()
         {
             if (!this.IsCacheValid())
@@ -65,7 +65,7 @@ public async Task<string> GetAsync()
             return await reader.ReadToEndAsync().ConfigureAwait(false);
         }
 
-        ///<inheritdoc/>
+        /// <inheritdoc/>
         public async Task SetAsync(string data)
         {
             using var streamWriter = File.CreateText(this._cacheFilePath);

diff --git a/src/Nager.PublicSuffix/Nager.PublicSuffix.csproj b/src/Nager.PublicSuffix/Nager.PublicSuffix.csproj
@@ -36,6 +36,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="8.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.0" />
   </ItemGroup>
 
 </Project>
diff --git a/src/Nager.PublicSuffix/RuleProviders/WebRuleProvider.cs b/src/Nager.PublicSuffix/RuleProviders/WebRuleProvider.cs
@@ -1,9 +1,11 @@
 using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;
 using Nager.PublicSuffix.CacheProviders;
 using Nager.PublicSuffix.Exceptions;
 using Nager.PublicSuffix.Extensions;
 using Nager.PublicSuffix.Models;
 using Nager.PublicSuffix.RuleParsers;
+using System;
 using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
@@ -16,6 +18,7 @@ namespace Nager.PublicSuffix.RuleProviders
     public class WebRuleProvider : IRuleProvider
     {
         private readonly string _dataFileUrl;
+        private readonly ILogger<WebRuleProvider> _logger;
         private readonly ICacheProvider _cacheProvider;
         private readonly HttpClient _httpClient;
         private DomainDataStructure _domainDataStructure;
@@ -30,15 +33,18 @@ public class WebRuleProvider : IRuleProvider
         /// Loads the public suffix definition file from the official website
         /// </summary>
         /// <remarks>It is possible to overwrite the url via configuration parameters <c>Nager:PublicSuffix:DataUrl</c></remarks>
+        /// <param name="logger"></param>
         /// <param name="configuration"></param>
         /// <param name="cacheProvider"></param>
         /// <param name="httpClient"></param>
         public WebRuleProvider(
+            ILogger<WebRuleProvider> logger,
             IConfiguration configuration,
             ICacheProvider cacheProvider,
             HttpClient httpClient
             )
         {
+            this._logger = logger;
             this._cacheProvider = cacheProvider;
             this._httpClient = httpClient;
 
@@ -60,12 +66,24 @@ public async Task<bool> BuildAsync(
             string ruleData;
             if (this._cacheProvider.IsCacheValid())
             {
+                this._logger.LogInformation($"{nameof(BuildAsync)} - Use data from cache");
                 ruleData = await this._cacheProvider.GetAsync().ConfigureAwait(false);
             }
             else
             {
-                ruleData = await this.LoadFromUrlAsync(this._dataFileUrl, cancellationToken).ConfigureAwait(false);
-                await this._cacheProvider.SetAsync(ruleData).ConfigureAwait(false);
+                this._logger.LogInformation($"{nameof(BuildAsync)} - Start downloading data from url");
+
+                try
+                {
+                    ruleData = await this.LoadFromUrlAsync(this._dataFileUrl, cancellationToken).ConfigureAwait(false);
+                    await this._cacheProvider.SetAsync(ruleData).ConfigureAwait(false);
+                }
+                catch (Exception exception)
+                {
+                    this._logger.LogError(exception, $"{nameof(BuildAsync)} - Failure on download");
+
+                    return false;
+                }
             }
 
             var rules = ruleParser.ParseRules(ruleData);
@@ -79,7 +97,7 @@ public async Task<bool> BuildAsync(
         }
 
         /// <inheritdoc/>
-        public DomainDataStructure GetDomainDataStructure()
+        public DomainDataStructure? GetDomainDataStructure()
         {
             return this._domainDataStructure;
         }
@@ -95,7 +113,6 @@ public async Task<string> LoadFromUrlAsync(
             CancellationToken cancellationToken)
         {
             using var response = await this._httpClient.GetAsync(url, cancellationToken).ConfigureAwait(false);
-
             if (!response.IsSuccessStatusCode)
             {
                 throw new RuleLoadException($"Cannot load from {url} {response.StatusCode}");