Refactoring. Fixed warning. Made some fields nullable. Return string.…

…Empty instead of null.
skuill · Dec 25, 2024 · 63a9986 · 63a9986
1 parent b0937e8
commit 63a9986
Show file tree

Hide file tree

Showing 19 changed files with 65 additions and 40 deletions.
diff --git a/LyricsScraperNET.Client/Program.cs b/LyricsScraperNET.Client/Program.cs
@@ -15,6 +15,8 @@
 using Microsoft.Extensions.Logging;
 using System.Threading;
 
+#pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
+
 class Program
 {
     static async Task Main()
@@ -167,4 +169,6 @@ ILyricsScraperClient lyricsScraperClient
 
         return result;
     }
+
+#pragma warning restore CS1998 // Async method lacks 'await' operators and will run synchronously
 }
diff --git a/LyricsScraperNET/ILyricsScraperClient.cs b/LyricsScraperNET/ILyricsScraperClient.cs
@@ -24,7 +24,7 @@ public interface ILyricsScraperClient
         /// </summary>
         bool UseParallelSearch { get; set; }
 
-        IExternalProvider this[ExternalProviderType providerType] { get; }
+        IExternalProvider? this[ExternalProviderType providerType] { get; }
 
         /// <summary>
         /// Search lyric by different search requests:

diff --git a/LyricsScraperNET/LyricsScraperClient.cs b/LyricsScraperNET/LyricsScraperClient.cs
@@ -18,12 +18,12 @@ namespace LyricsScraperNET
 {
     public sealed class LyricsScraperClient : ILyricsScraperClient
     {
-        private ILoggerFactory _loggerFactory;
-        private ILogger<LyricsScraperClient> _logger;
+        private ILoggerFactory? _loggerFactory;
+        private ILogger<LyricsScraperClient>? _logger;
 
         private IProviderService _providerService;
         private IRequestValidator _requestValidator;
-        private readonly ILyricScraperClientConfig _lyricScraperClientConfig;
+        private readonly ILyricScraperClientConfig? _lyricScraperClientConfig;
 
         private bool? _useParallelSearch;
         /// <inheritdoc />
@@ -37,7 +37,7 @@ public bool UseParallelSearch
         public bool IsEnabled => _providerService.AnyEnabled();
 
         /// <inheritdoc />
-        public IExternalProvider this[ExternalProviderType providerType]
+        public IExternalProvider? this[ExternalProviderType providerType]
         {
             get => _providerService[providerType];
         }
@@ -221,6 +221,10 @@ public void RemoveProvider(ExternalProviderType providerType)
         public void Disable() => _providerService.DisableAllProviders();
 
         /// <inheritdoc />
-        public void WithLogger(ILoggerFactory loggerFactory) => _providerService.WithLogger(loggerFactory);
+        public void WithLogger(ILoggerFactory loggerFactory) 
+        {
+            _loggerFactory = loggerFactory;
+            _providerService.WithLogger(loggerFactory);
+        }
     }
 }
diff --git a/LyricsScraperNET/Network/HtmlAgilityWebClient.cs b/LyricsScraperNET/Network/HtmlAgilityWebClient.cs
@@ -14,7 +14,7 @@ namespace LyricsScraperNET.Network
     /// </summary>
     internal sealed class HtmlAgilityWebClient : IWebClient
     {
-        private readonly ILogger<HtmlAgilityWebClient> _logger;
+        private readonly ILogger<HtmlAgilityWebClient>? _logger;
         private readonly HtmlWeb _htmlWeb;
 
         public HtmlAgilityWebClient()
@@ -49,7 +49,7 @@ public async Task<string> LoadAsync(Uri uri, CancellationToken cancellationToken
             }
 
             CheckDocument(document, uri);
-            return document?.ParsedText;
+            return document?.ParsedText ?? string.Empty;
         }
 
         private void CheckDocument(HtmlDocument document, Uri uri)

diff --git a/LyricsScraperNET/Network/NetHttpClient.cs b/LyricsScraperNET/Network/NetHttpClient.cs
@@ -14,7 +14,7 @@ namespace LyricsScraperNET.Network
     /// </summary>
     internal sealed class NetHttpClient : IWebClient
     {
-        private readonly ILogger<NetHttpClient> _logger;
+        private readonly ILogger<NetHttpClient>? _logger;
 
         // HttpClient is declared as static to prevent frequent creation and disposal of instances, 
         // which can lead to socket exhaustion due to delays in releasing resources.

diff --git a/LyricsScraperNET/Providers/AZLyrics/AZLyricsParser.cs b/LyricsScraperNET/Providers/AZLyrics/AZLyricsParser.cs
@@ -7,7 +7,7 @@ internal sealed class AZLyricsParser : IExternalProviderLyricParser
     {
         public string Parse(string lyric)
         {
-            return UnescapeString(RemoveAllHtmlTags(lyric))?.Trim();
+            return UnescapeString(RemoveAllHtmlTags(lyric))?.Trim() ?? string.Empty;
         }
 
         private string RemoveAllHtmlTags(string html)

diff --git a/LyricsScraperNET/Providers/AZLyrics/AZLyricsProvider.cs b/LyricsScraperNET/Providers/AZLyrics/AZLyricsProvider.cs
@@ -3,6 +3,7 @@
 using LyricsScraperNET.Network;
 using LyricsScraperNET.Providers.Abstract;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Extensions.Options;
 using System;
 using System.Threading;
@@ -43,13 +44,13 @@ public AZLyricsProvider(ILogger<AZLyricsProvider> logger, IOptionsSnapshot<AZLyr
         }
 
         public AZLyricsProvider(AZLyricsOptions options)
-            : this(null, options)
+            : this(NullLogger<AZLyricsProvider>.Instance, options)
         {
             Ensure.ArgumentNotNull(options, nameof(options));
         }
 
         public AZLyricsProvider(IOptionsSnapshot<AZLyricsOptions> options)
-            : this(null, options.Value)
+            : this(NullLogger<AZLyricsProvider>.Instance, options.Value)
         {
             Ensure.ArgumentNotNull(options, nameof(options));
         }

diff --git a/LyricsScraperNET/Providers/Abstract/ExternalProviderBase.cs b/LyricsScraperNET/Providers/Abstract/ExternalProviderBase.cs
@@ -8,7 +8,7 @@
 
 namespace LyricsScraperNET.Providers.Abstract
 {
-    public class ExternalProviderBase : IExternalProvider
+    public abstract class ExternalProviderBase : IExternalProvider
     {
         internal IExternalProviderLyricParser Parser { get; set; }
         internal IWebClient WebClient { get; set; }

diff --git a/LyricsScraperNET/Providers/Genius/GeniusParser.cs b/LyricsScraperNET/Providers/Genius/GeniusParser.cs
@@ -13,7 +13,7 @@ public string Parse(string lyric)
             lyric = CleanEnding(lyric);
             lyric = WebUtility.HtmlDecode(lyric);
 
-            return lyric?.Trim();
+            return lyric?.Trim() ?? string.Empty;
         }
 
         public static string StripTagsRegex(string source)

diff --git a/LyricsScraperNET/Providers/Genius/GeniusProvider.cs b/LyricsScraperNET/Providers/Genius/GeniusProvider.cs
@@ -7,6 +7,7 @@
 using LyricsScraperNET.Network;
 using LyricsScraperNET.Providers.Abstract;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Extensions.Options;
 using System;
 using System.Linq;
@@ -18,7 +19,7 @@ namespace LyricsScraperNET.Providers.Genius
 {
     public sealed class GeniusProvider : ExternalProviderBase
     {
-        private ILogger<GeniusProvider> _logger;
+        private ILogger<GeniusProvider>? _logger;
         private readonly IExternalUriConverter _uriConverter;
 
         // Format: "artist song". Example: "Parkway Drive Carrion".
@@ -56,13 +57,13 @@ public GeniusProvider(ILogger<GeniusProvider> logger, IOptionsSnapshot<GeniusOpt
         }
 
         public GeniusProvider(GeniusOptions options)
-            : this(null, options)
+            : this(NullLogger<GeniusProvider>.Instance, options)
         {
             Ensure.ArgumentNotNull(options, nameof(options));
         }
 
         public GeniusProvider(IOptionsSnapshot<GeniusOptions> options)
-            : this(null, options.Value)
+            : this(NullLogger<GeniusProvider>.Instance, options.Value)
         {
             Ensure.ArgumentNotNull(options, nameof(options));
         }
@@ -155,7 +156,7 @@ private string GetLyricUrlWithoutApiKey(string artist, string song, Cancellation
                 if (hitJsonProperty.TryGetProperty("result", out var resultJsonElement))
                 {
                     if (resultJsonElement.TryGetProperty("url", out var lyricUrl))
-                        return lyricUrl.GetString();
+                        return lyricUrl.GetString() ?? string.Empty;
                 }
             }
 
@@ -192,7 +193,7 @@ private string GetParsedLyricFromHtmlPageBody(string htmlPageBody, out bool inst
                 _logger?.LogWarning($"Genius. Can't parse lyric from the page.");
             }
 
-            return Parser.Parse(string.Join("", lyricNodes.Select(node => node.InnerHtml)));
+            return Parser.Parse(string.Join("", lyricNodes!.Select(node => node.InnerHtml)));
         }
 
         private string GetLyricUrlFromSearchResponse(SearchResponse searchResponse, string artist, string song)

diff --git a/LyricsScraperNET/Providers/IProviderService.cs b/LyricsScraperNET/Providers/IProviderService.cs
@@ -9,7 +9,7 @@ namespace LyricsScraperNET.Providers
     public interface IProviderService
     {
         IEnumerable<IExternalProvider> GetAvailableProviders(SearchRequest searchRequest);
-        IExternalProvider this[ExternalProviderType providerType] { get; }
+        IExternalProvider? this[ExternalProviderType providerType] { get; }
         bool AnyEnabled();
         bool AnyAvailable();
         bool IsProviderAvailable(ExternalProviderType providerType);

diff --git a/LyricsScraperNET/Providers/LyricFind/LyricFindParser.cs b/LyricsScraperNET/Providers/LyricFind/LyricFindParser.cs
@@ -7,7 +7,8 @@ internal sealed class LyricFindParser : IExternalProviderLyricParser
     {
         public string Parse(string lyric)
         {
-            return UnescapeString(RemoveAllHtmlTags(lyric))?.Trim()?.Replace("\\n", "\r\n");
+            return UnescapeString(RemoveAllHtmlTags(lyric))?.Trim()?.Replace("\\n", "\r\n") 
+                ?? string.Empty;
         }
 
         private string RemoveAllHtmlTags(string html)

diff --git a/LyricsScraperNET/Providers/LyricFind/LyricFindProvider.cs b/LyricsScraperNET/Providers/LyricFind/LyricFindProvider.cs
@@ -4,6 +4,7 @@
 using LyricsScraperNET.Network;
 using LyricsScraperNET.Providers.Abstract;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Extensions.Options;
 using System;
 using System.Text.RegularExpressions;
@@ -14,7 +15,7 @@ namespace LyricsScraperNET.Providers.LyricFind
 {
     public sealed class LyricFindProvider : ExternalProviderBase
     {
-        private ILogger<LyricFindProvider> _logger;
+        private ILogger<LyricFindProvider>? _logger;
         private readonly IExternalUriConverter _uriConverter;
 
         /// <summary>
@@ -57,13 +58,13 @@ public LyricFindProvider(ILogger<LyricFindProvider> logger, IOptionsSnapshot<Lyr
         }
 
         public LyricFindProvider(LyricFindOptions options)
-            : this(null, options)
+            : this(NullLogger<LyricFindProvider>.Instance, options)
         {
             Ensure.ArgumentNotNull(options, nameof(options));
         }
 
         public LyricFindProvider(IOptionsSnapshot<LyricFindOptions> options)
-            : this(null, options.Value)
+            : this(NullLogger<LyricFindProvider>.Instance, options.Value)
         {
             Ensure.ArgumentNotNull(options, nameof(options));
         }

diff --git a/LyricsScraperNET/Providers/Musixmatch/MusixmatchClientWrapper.cs b/LyricsScraperNET/Providers/Musixmatch/MusixmatchClientWrapper.cs
@@ -12,11 +12,12 @@ namespace LyricsScraperNET.Providers.Musixmatch
 {
     public sealed class MusixmatchClientWrapper : IMusixmatchClientWrapper
     {
-        private ILogger<MusixmatchClientWrapper> _logger;
+        private ILogger<MusixmatchClientWrapper>? _logger;
         private IMusixmatchTokenCache _tokenCache;
 
         public MusixmatchClientWrapper()
         {
+            _tokenCache = new MusixmatchTokenCache();
         }
 
         public MusixmatchClientWrapper(IMusixmatchTokenCache tokenCache) : this()

diff --git a/LyricsScraperNET/Providers/Musixmatch/MusixmatchProvider.cs b/LyricsScraperNET/Providers/Musixmatch/MusixmatchProvider.cs
@@ -2,6 +2,7 @@
 using LyricsScraperNET.Models.Responses;
 using LyricsScraperNET.Providers.Abstract;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Extensions.Options;
 using MusixmatchClientLib.API.Model.Exceptions;
 using MusixmatchClientLib.API.Model.Types;
@@ -13,7 +14,7 @@ namespace LyricsScraperNET.Providers.Musixmatch
 {
     public sealed class MusixmatchProvider : ExternalProviderBase
     {
-        private ILogger<MusixmatchProvider> _logger;
+        private ILogger<MusixmatchProvider>? _logger;
         private IMusixmatchClientWrapper _clientWrapper;
 
         private readonly int _searchRetryAmount = 2;
@@ -45,13 +46,13 @@ public MusixmatchProvider(ILogger<MusixmatchProvider> logger, IOptionsSnapshot<M
         }
 
         public MusixmatchProvider(MusixmatchOptions options, IMusixmatchClientWrapper clientWrapper)
-            : this(null, options, clientWrapper)
+            : this(NullLogger<MusixmatchProvider>.Instance, options, clientWrapper)
         {
             Ensure.ArgumentNotNull(options, nameof(options));
         }
 
         public MusixmatchProvider(IOptionsSnapshot<MusixmatchOptions> options, IMusixmatchClientWrapper clientWrapper)
-            : this(null, options.Value, clientWrapper)
+            : this(NullLogger<MusixmatchProvider>.Instance, options.Value, clientWrapper)
         {
             Ensure.ArgumentNotNull(options, nameof(options));
         }

diff --git a/LyricsScraperNET/Providers/Musixmatch/MusixmatchTokenCache.cs b/LyricsScraperNET/Providers/Musixmatch/MusixmatchTokenCache.cs
@@ -6,17 +6,23 @@ namespace LyricsScraperNET.Providers.Musixmatch
 {
     public sealed class MusixmatchTokenCache : IMusixmatchTokenCache
     {
-        private ILogger<MusixmatchTokenCache> _logger;
+        private ILogger<MusixmatchTokenCache>? _logger;
 
         // Musixmatch Token memory cache
-        private static IMemoryCache _memoryCache;
-        private static MemoryCacheEntryOptions _memoryCacheEntryOptions;
+        private static IMemoryCache? _memoryCache;
+        private static MemoryCacheEntryOptions? _memoryCacheEntryOptions;
 
         private static readonly object _syncLock = new object();
 
         private readonly string MusixmatchTokenKey = "MusixmatchToken";
 
         public MusixmatchTokenCache()
+        {
+            InitializeMemoryCache();
+            InitializeMemoryCacheEntryOptions();
+        }
+
+        private void InitializeMemoryCache()
         {
             if (_memoryCache == null)
             {
@@ -31,6 +37,10 @@ public MusixmatchTokenCache()
                     }
                 }
             }
+        }
+
+        private void InitializeMemoryCacheEntryOptions()
+        {
             if (_memoryCacheEntryOptions == null)
             {
                 lock (_syncLock)
@@ -54,7 +64,7 @@ public MusixmatchTokenCache(ILogger<MusixmatchTokenCache> logger) : this()
         public string GetOrCreateToken(bool regenerate = false)
         {
             if (regenerate)
-                _memoryCache.Remove(MusixmatchTokenKey);
+                _memoryCache!.Remove(MusixmatchTokenKey);
 
             _logger?.LogDebug("Musixmatch. Use default MusixmatchToken.");
             string musixmatchTokenValue;

diff --git a/LyricsScraperNET/Providers/ProviderService.cs b/LyricsScraperNET/Providers/ProviderService.cs
@@ -20,11 +20,11 @@ public IEnumerable<IExternalProvider> GetAvailableProviders(SearchRequest search
                 : _providers.Where(p => p.IsEnabled && p.Options.ExternalProviderType == providerType).OrderByDescending(p => p.SearchPriority);
         }
 
-        public IExternalProvider this[ExternalProviderType providerType]
+        public IExternalProvider? this[ExternalProviderType providerType]
         {
             get => IsProviderAvailable(providerType)
-                ? _providers.First(p => p.Options.ExternalProviderType == providerType)
-                : null;
+                ? _providers.FirstOrDefault(p => p.Options.ExternalProviderType == providerType)
+                : default;
         }
 
         public void AddProvider(IExternalProvider provider)
@@ -55,6 +55,6 @@ public bool IsProviderAvailable(ExternalProviderType providerType)
 
         public bool IsProviderEnabled(ExternalProviderType providerType)
             => IsProviderAvailable(providerType)
-                && this[providerType].IsEnabled;
+                && (this[providerType]?.IsEnabled ?? false);
     }
 }
diff --git a/LyricsScraperNET/Providers/SongLyrics/SongLyricsParser.cs b/LyricsScraperNET/Providers/SongLyrics/SongLyricsParser.cs
@@ -9,7 +9,7 @@ public string Parse(string lyric)
         {
             lyric = WebUtility.HtmlDecode(lyric);
 
-            return lyric?.Trim();
+            return lyric?.Trim() ?? string.Empty;
         }
     }
 }