Add ZLogger.Param(keyName, value)

Cysharp · Oct 20, 2023 · a77f06b · a77f06b
1 parent f00cde0
commit a77f06b
Show file tree

Hide file tree

Showing 8 changed files with 97 additions and 3 deletions.
diff --git a/src/ZLogger/Formatters/SystemTextJsonZLoggerFormatter.cs b/src/ZLogger/Formatters/SystemTextJsonZLoggerFormatter.cs
@@ -1,4 +1,3 @@
-using System;
 using System.Buffers;
 using System.Text.Encodings.Web;
 using System.Text.Json;

diff --git a/src/ZLogger/ZLoggerInterpolatedStringHandler.LogLevel.cs b/src/ZLogger/ZLoggerInterpolatedStringHandler.LogLevel.cs
@@ -28,6 +28,11 @@ public void AppendFormatted<T>(Nullable<T> value, int alignment = 0, string? for
     {
         this.innerHandler.AppendFormatted<T>(value, alignment, format, argumentName);
     }
+
+    public void AppendFormatted<T>(ZLoggerNamedParam<T> value, int alignment = 0, string? format = null, string? _ = null)
+    {
+        this.innerHandler.AppendFormatted(value, alignment, format);
+    }
 }
 
 [InterpolatedStringHandler]
@@ -54,6 +59,11 @@ public void AppendFormatted<T>(Nullable<T> value, int alignment = 0, string? for
     {
         this.innerHandler.AppendFormatted<T>(value, alignment, format, argumentName);
     }
+
+    public void AppendFormatted<T>(ZLoggerNamedParam<T> value, int alignment = 0, string? format = null, string? _ = null)
+    {
+        this.innerHandler.AppendFormatted(value, alignment, format);
+    }
 }
 
 [InterpolatedStringHandler]
@@ -80,6 +90,11 @@ public void AppendFormatted<T>(Nullable<T> value, int alignment = 0, string? for
     {
         this.innerHandler.AppendFormatted<T>(value, alignment, format, argumentName);
     }
+
+    public void AppendFormatted<T>(ZLoggerNamedParam<T> value, int alignment = 0, string? format = null, string? _ = null)
+    {
+        this.innerHandler.AppendFormatted(value, alignment, format);
+    }
 }
 
 [InterpolatedStringHandler]
@@ -106,6 +121,11 @@ public void AppendFormatted<T>(Nullable<T> value, int alignment = 0, string? for
     {
         this.innerHandler.AppendFormatted<T>(value, alignment, format, argumentName);
     }
+
+    public void AppendFormatted<T>(ZLoggerNamedParam<T> value, int alignment = 0, string? format = null, string? _ = null)
+    {
+        this.innerHandler.AppendFormatted(value, alignment, format);
+    }
 }
 
 [InterpolatedStringHandler]
@@ -132,6 +152,11 @@ public void AppendFormatted<T>(Nullable<T> value, int alignment = 0, string? for
     {
         this.innerHandler.AppendFormatted<T>(value, alignment, format, argumentName);
     }
+
+    public void AppendFormatted<T>(ZLoggerNamedParam<T> value, int alignment = 0, string? format = null, string? _ = null)
+    {
+        this.innerHandler.AppendFormatted(value, alignment, format);
+    }
 }
 
 [InterpolatedStringHandler]
@@ -158,5 +183,10 @@ public void AppendFormatted<T>(Nullable<T> value, int alignment = 0, string? for
     {
         this.innerHandler.AppendFormatted<T>(value, alignment, format, argumentName);
     }
+
+    public void AppendFormatted<T>(ZLoggerNamedParam<T> value, int alignment = 0, string? format = null, string? _ = null)
+    {
+        this.innerHandler.AppendFormatted(value, alignment, format);
+    }
 }
 
diff --git a/src/ZLogger/ZLoggerInterpolatedStringHandler.LogLevel.tt b/src/ZLogger/ZLoggerInterpolatedStringHandler.LogLevel.tt
@@ -38,6 +38,11 @@ public ref struct ZLogger<#= logLevel #>InterpolatedStringHandler
     {
         this.innerHandler.AppendFormatted<T>(value, alignment, format, argumentName);
     }
+
+    public void AppendFormatted<T>(ZLoggerNamedParam<T> value, int alignment = 0, string? format = null, string? _ = null)
+    {
+        this.innerHandler.AppendFormatted(value, alignment, format);
+    }
 }
 
 <# } #>
diff --git a/src/ZLogger/ZLoggerInterpolatedStringHandler.cs b/src/ZLogger/ZLoggerInterpolatedStringHandler.cs
@@ -109,6 +109,11 @@ public void AppendFormatted<T>(Nullable<T> value, int alignment = 0, string? for
             }
         }
 
+        public void AppendFormatted<T>(ZLoggerNamedParam<T> value, int alignment = 0, string? format = null, string? _ = null)
+        {
+            AppendFormatted(value.Value, alignment, format, value.Name);
+        }
+
         internal InterpolatedStringLogState GetStateAndClear()
         {
             // MessageSequence is immutable

diff --git a/src/ZLogger/ZLoggerParam.cs b/src/ZLogger/ZLoggerParam.cs
@@ -0,0 +1,20 @@
+namespace ZLogger
+{
+    // The helper class used directly with logger 
+    public static partial class ZLogger
+    {
+        public static ZLoggerNamedParam<T> Param<T>(string name, T value) => new(name, value);
+    }
+
+    public readonly struct ZLoggerNamedParam<T>
+    {
+        public readonly string Name;
+        public readonly T Value;
+
+        public ZLoggerNamedParam(string name, T value)
+        {
+            Name = name;
+            Value = value;
+        }
+    }
+}
diff --git a/tests/ZLogger.Tests/EnumDictionaryTest.cs b/tests/ZLogger.Tests/EnumDictionaryTest.cs
@@ -40,7 +40,7 @@ public void Lookup()
             flags.GetStringName(ToBytes(FlagsEnum.A | FlagsEnum.D)).Should().BeNull();
 
             duplicate.GetStringName(ToBytes(Duplicate.Foo)).Should().Be("Foo");
-            duplicate.GetStringName(ToBytes(Duplicate.Bar)).Should().Be("MoreBar");
+            duplicate.GetStringName(ToBytes(Duplicate.Bar)).Should().Be("Bar");
             duplicate.GetStringName(ToBytes(Duplicate.Baz)).Should().Be("Baz");
             duplicate.GetStringName(ToBytes(Duplicate.MoreBar)).Should().Be("MoreBar");
             duplicate.GetStringName(ToBytes(Duplicate.End)).Should().Be("End");

diff --git a/tests/ZLogger.Tests/MessageTest.cs b/tests/ZLogger.Tests/MessageTest.cs
@@ -163,6 +163,5 @@ public void StructuredLoggingOptions()
             doc.GetProperty("Hash").GetString().Should().Be(sourceCodeHash);
             doc.GetProperty("LogLevel").GetString().Should().Be("Debug");
         }
-
     }
 }
diff --git a/tests/ZLogger.Tests/NamedParamTest.cs b/tests/ZLogger.Tests/NamedParamTest.cs
@@ -0,0 +1,36 @@
+using System;
+using System.Text.Json;
+using FluentAssertions;
+using Microsoft.Extensions.Logging;
+using ZLogger.Formatters;
+
+namespace ZLogger.Tests
+{
+    public class NamedParamTest
+    {
+        [Fact]
+        public void StructuredLoggingOptions()
+        {
+            var options = new ZLoggerOptions();
+            options.UseJsonFormatter();
+
+            var processor = new TestProcessor(options);
+            using var loggerFactory = LoggerFactory.Create(x =>
+            {
+                x.SetMinimumLevel(LogLevel.Debug);
+                x.AddZLoggerLogProcessor(processor);
+            });
+            var logger = loggerFactory.CreateLogger("test");
+
+            logger.ZLogInformation($"{ZLogger.Param("TAKO", 100)} {ZLogger.Param("YAKI", 200):D5} {ZLogger.Param("T", new DateTime(2023, 12, 31)),15:yyyy-MM-dd}");
+
+            var json = processor.EntryMessages.Dequeue();
+            var doc = JsonDocument.Parse(json).RootElement;
+
+            doc.GetProperty("Message").GetString().Should().Be("100 00200      2023-12-31");
+            doc.GetProperty("TAKO").GetInt32().Should().Be(100);
+            doc.GetProperty("YAKI").GetInt32().Should().Be(200);
+            doc.GetProperty("T").GetDateTime().Should().Be(new DateTime(2023, 12, 31));
+        }
+    }    
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -163,6 +163,5 @@ public void StructuredLoggingOptions() @@
                 doc.GetProperty("Hash").GetString().Should().Be(sourceCodeHash);
                 doc.GetProperty("LogLevel").GetString().Should().Be("Debug");
             }
         }
     }