Fix: Splat.NLog - Faster with switch on Enum value, than dictionary lookup (#1257)

snakefoot · web-flow · commit ddef2eda5f14 · 2024-12-31T20:22:45.000+11:00
diff --git a/src/Splat.NLog/NLogLogger.cs b/src/Splat.NLog/NLogLogger.cs
@@ -3,7 +3,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for full license information.
 
-using System.Collections.Immutable;
 using System.Diagnostics;
 using System.Globalization;
 
@@ -15,17 +14,6 @@ namespace Splat.NLog;
 [DebuggerDisplay("Name={_inner.Name} Level={Level}")]
 public sealed class NLogLogger : IFullLogger, IDisposable
 {
-    private static readonly KeyValuePair<LogLevel, global::NLog.LogLevel>[] _mappings =
-    [
-        new(LogLevel.Debug, global::NLog.LogLevel.Debug),
-        new(LogLevel.Info, global::NLog.LogLevel.Info),
-        new(LogLevel.Warn, global::NLog.LogLevel.Warn),
-        new(LogLevel.Error, global::NLog.LogLevel.Error),
-        new(LogLevel.Fatal, global::NLog.LogLevel.Fatal),
-    ];
-
-    private static readonly ImmutableDictionary<LogLevel, global::NLog.LogLevel> _mappingsDictionary = _mappings.ToImmutableDictionary();
-
     private readonly global::NLog.Logger _inner;
 
     /// <summary>
@@ -47,34 +35,34 @@ public LogLevel Level
     }
 
     /// <inheritdoc />
-    public bool IsDebugEnabled => _inner.IsEnabled(global::NLog.LogLevel.Debug);
+    public bool IsDebugEnabled => _inner.IsDebugEnabled;
 
     /// <inheritdoc />
-    public bool IsInfoEnabled => _inner.IsEnabled(global::NLog.LogLevel.Info);
+    public bool IsInfoEnabled => _inner.IsInfoEnabled;
 
     /// <inheritdoc />
-    public bool IsWarnEnabled => _inner.IsEnabled(global::NLog.LogLevel.Warn);
+    public bool IsWarnEnabled => _inner.IsWarnEnabled;
 
     /// <inheritdoc />
-    public bool IsErrorEnabled => _inner.IsEnabled(global::NLog.LogLevel.Error);
+    public bool IsErrorEnabled => _inner.IsErrorEnabled;
 
     /// <inheritdoc />
-    public bool IsFatalEnabled => _inner.IsEnabled(global::NLog.LogLevel.Fatal);
+    public bool IsFatalEnabled => _inner.IsFatalEnabled;
 
     /// <inheritdoc />
     public void Dispose() => _inner.LoggerReconfigured -= OnInnerLoggerReconfigured;
 
     /// <inheritdoc />
-    public void Write(string message, LogLevel logLevel) => _inner.Log(_mappingsDictionary[logLevel], message);
+    public void Write(string message, LogLevel logLevel) => _inner.Log(ResolveLogLevel(logLevel), message);
 
     /// <inheritdoc />
-    public void Write(Exception exception, string message, LogLevel logLevel) => _inner.Log(_mappingsDictionary[logLevel], exception, message);
+    public void Write(Exception exception, string message, LogLevel logLevel) => _inner.Log(ResolveLogLevel(logLevel), exception, message);
 
     /// <inheritdoc />
-    public void Write(string message, Type type, LogLevel logLevel) => LogResolver.Resolve(type).Log(_mappingsDictionary[logLevel], message);
+    public void Write(string message, Type type, LogLevel logLevel) => LogResolver.Resolve(type).Log(ResolveLogLevel(logLevel), message);
 
     /// <inheritdoc />
-    public void Write(Exception exception, string message, Type type, LogLevel logLevel) => LogResolver.Resolve(type).Log(_mappingsDictionary[logLevel], exception, message);
+    public void Write(Exception exception, string message, Type type, LogLevel logLevel) => LogResolver.Resolve(type).Log(ResolveLogLevel(logLevel), exception, message);
 
     /// <inheritdoc/>
     public void Debug<TArgument>(string message, TArgument args) => _inner.Debug(CultureInfo.InvariantCulture, message, args);
@@ -556,6 +544,16 @@ public LogLevel Level
     /// <inheritdoc/>
     public void Fatal<TArgument1, TArgument2, TArgument3, TArgument4, TArgument5, TArgument6, TArgument7, TArgument8, TArgument9, TArgument10>(Exception exception, string messageFormat, TArgument1 argument1, TArgument2 argument2, TArgument3 argument3, TArgument4 argument4, TArgument5 argument5, TArgument6 argument6, TArgument7 argument7, TArgument8 argument8, TArgument9 argument9, TArgument10 argument10) => _inner.Fatal(exception, messageFormat, argument1, argument2, argument3, argument4, argument5, argument6, argument7, argument8, argument9, argument10);
 
+    private static global::NLog.LogLevel ResolveLogLevel(LogLevel logLevel) => logLevel switch
+    {
+        LogLevel.Debug => global::NLog.LogLevel.Debug,
+        LogLevel.Info => global::NLog.LogLevel.Info,
+        LogLevel.Warn => global::NLog.LogLevel.Warn,
+        LogLevel.Error => global::NLog.LogLevel.Error,
+        LogLevel.Fatal => global::NLog.LogLevel.Fatal,
+        _ => throw new ArgumentException($"Unknown LogLevel {logLevel}", nameof(logLevel)),
+    };
+
     private void OnInnerLoggerReconfigured(object? sender, EventArgs e) => SetLogLevel();
 
     /// <summary>
@@ -566,11 +564,11 @@ public LogLevel Level
     /// </remarks>
     private void SetLogLevel()
     {
-        foreach (var mapping in _mappings)
+        foreach (LogLevel logLevel in Enum.GetValues(typeof(LogLevel)))
         {
-            if (_inner.IsEnabled(mapping.Value))
+            if (_inner.IsEnabled(ResolveLogLevel(logLevel)))
             {
-                Level = mapping.Key;
+                Level = logLevel;
                 return;
             }
         }
diff --git a/src/Splat.NLog/Splat.NLog.csproj b/src/Splat.NLog/Splat.NLog.csproj
@@ -10,7 +10,6 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="NLog" />
-    <PackageReference Include="System.Collections.Immutable" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Splat\Splat.csproj" />
diff --git a/src/Splat/Logging/ILogger.cs b/src/Splat/Logging/ILogger.cs
@@ -33,15 +33,15 @@ public interface ILogger
     void Write(Exception exception, [Localizable(false)] string message, LogLevel logLevel);
 
     /// <summary>
-    /// Writes a messge to the target.
+    /// Writes a message to the target.
     /// </summary>
     /// <param name="message">The message.</param>
     /// <param name="type">The type.</param>
     /// <param name="logLevel">The log level.</param>
     void Write([Localizable(false)] string message, [Localizable(false)] Type type, LogLevel logLevel);
 
     /// <summary>
-    /// Writes a messge to the target.
+    /// Writes a message to the target.
     /// </summary>
     /// <param name="exception">The exception that occured.</param>
     /// <param name="message">The message.</param>
diff --git a/src/Splat/Logging/IStaticFullLogger.cs b/src/Splat/Logging/IStaticFullLogger.cs
@@ -341,7 +341,7 @@ public interface IStaticFullLogger
     void Write(Exception exception, [Localizable(false)] string message, LogLevel logLevel, [CallerMemberName]string? callerMemberName = null);
 
     /// <summary>
-    /// Writes a messge to the target.
+    /// Writes a message to the target.
     /// </summary>
     /// <param name="message">The message.</param>
     /// <param name="type">The type.</param>
@@ -350,7 +350,7 @@ public interface IStaticFullLogger
     void Write([Localizable(false)] string message, [Localizable(false)] Type type, LogLevel logLevel, [CallerMemberName]string? callerMemberName = null);
 
     /// <summary>
-    /// Writes a messge to the target.
+    /// Writes a message to the target.
     /// </summary>
     /// <param name="exception">The exception that occured.</param>
     /// <param name="message">The message.</param>
