SerilogLoggerScope add support for ValueTuple<string, object?> state. Add SerilogLoggerScopeTests.

Author: jimbojim1997

src/Serilog.Extensions.Logging/Extensions/Logging/SerilogLoggerScope.cs

@@ -49,11 +49,9 @@ public void Dispose()
 
     public void EnrichAndCreateScopeItem(LogEvent logEvent, ILogEventPropertyFactory propertyFactory, out LogEventPropertyValue? scopeItem)
     {
-        void AddProperty(KeyValuePair<string, object> stateProperty)
+        void AddProperty(string key, object? value)
         {
-            var key = stateProperty.Key;
             var destructureObject = false;
-            var value = stateProperty.Value;
 
             if (key.StartsWith("@"))
             {
@@ -86,7 +84,7 @@ void AddProperty(KeyValuePair<string, object> stateProperty)
                 if (stateProperty.Key == SerilogLoggerProvider.OriginalFormatPropertyName && stateProperty.Value is string)
                     scopeItem = new ScalarValue(_state.ToString());
                 else
-                    AddProperty(stateProperty);
+                    AddProperty(stateProperty.Key, stateProperty.Value);
             }
         }
         else if (_state is IEnumerable<KeyValuePair<string, object>> stateProperties)
@@ -98,9 +96,18 @@ void AddProperty(KeyValuePair<string, object> stateProperty)
                 if (stateProperty.Key == SerilogLoggerProvider.OriginalFormatPropertyName && stateProperty.Value is string)
                     scopeItem = new ScalarValue(_state.ToString());
                 else
-                    AddProperty(stateProperty);
+                    AddProperty(stateProperty.Key, stateProperty.Value);
             }
         }
+        else if (_state is ValueTuple<string, object?> tuple)
+        {
+            scopeItem = null; // Unless it's `FormattedLogValues`, these are treated as property bags rather than scope items.
+
+            if (tuple.Item1 == SerilogLoggerProvider.OriginalFormatPropertyName && tuple.Item2 is string)
+                scopeItem = new ScalarValue(_state.ToString());
+            else
+                AddProperty(tuple.Item1, tuple.Item2);
+        }
         else
         {
             scopeItem = propertyFactory.CreateProperty(NoName, _state).Value;

test/Serilog.Extensions.Logging.Tests/SerilogLoggerScopeTests.cs

@@ -0,0 +1,100 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using Serilog.Events;
+using Serilog.Extensions.Logging.Tests.Support;
+
+using Xunit;
+
+namespace Serilog.Extensions.Logging.Tests;
+public class SerilogLoggerScopeTests
+{
+    static (SerilogLoggerProvider, LogEventPropertyFactory, LogEvent) SetUp()
+    {
+        var loggerProvider = new SerilogLoggerProvider();
+
+        var logEventPropertyFactory = new LogEventPropertyFactory();
+
+        var dateTimeOffset = new DateTimeOffset(2000, 1, 1, 0, 0, 0, TimeSpan.Zero);
+        var messageTemplate = new MessageTemplate(Enumerable.Empty<Parsing.MessageTemplateToken>());
+        var properties = Enumerable.Empty<LogEventProperty>();
+        var logEvent = new LogEvent(dateTimeOffset, LogEventLevel.Information, null, messageTemplate, properties);
+
+        return (loggerProvider, logEventPropertyFactory, logEvent);
+    }
+
+    [Fact]
+    public void EnrichWithDictionaryStringObject()
+    {
+        const string propertyName = "Foo";
+        const string expectedValue = "Bar";
+
+        var(loggerProvider, logEventPropertyFactory, logEvent) = SetUp();
+
+
+        var state = new Dictionary<string, object?>() { { propertyName, expectedValue } };
+
+        var loggerScope = new SerilogLoggerScope(loggerProvider, state);
+
+        loggerScope.EnrichAndCreateScopeItem(logEvent, logEventPropertyFactory, out LogEventPropertyValue? scopeItem);
+
+        Assert.Contains(propertyName, logEvent.Properties);
+
+        var scalarValue = logEvent.Properties[propertyName] as ScalarValue;
+        Assert.NotNull(scalarValue);
+
+        var actualValue = scalarValue.Value as string;
+        Assert.NotNull(actualValue);
+        Assert.Equal(expectedValue, actualValue);
+    }
+
+    [Fact]
+    public void EnrichWithIEnumerableKeyValuePairStringObject()
+    {
+        const string propertyName = "Foo";
+        const string expectedValue = "Bar";
+
+        var (loggerProvider, logEventPropertyFactory, logEvent) = SetUp();
+
+
+        var state = new KeyValuePair<string, object?>[] { new KeyValuePair<string, object?>(propertyName, expectedValue) };
+
+        var loggerScope = new SerilogLoggerScope(loggerProvider, state);
+
+        loggerScope.EnrichAndCreateScopeItem(logEvent, logEventPropertyFactory, out LogEventPropertyValue? scopeItem);
+
+        Assert.Contains(propertyName, logEvent.Properties);
+
+        var scalarValue = logEvent.Properties[propertyName] as ScalarValue;
+        Assert.NotNull(scalarValue);
+
+        var actualValue = scalarValue.Value as string;
+        Assert.NotNull(actualValue);
+        Assert.Equal(expectedValue, actualValue);
+    }
+
+    [Fact]
+    public void EnrichWithTupleStringObject()
+    {
+        const string propertyName = "Foo";
+        const string expectedValue = "Bar";
+
+        var (loggerProvider, logEventPropertyFactory, logEvent) = SetUp();
+
+
+        var state = (propertyName, (object)expectedValue);
+
+        var loggerScope = new SerilogLoggerScope(loggerProvider, state);
+
+        loggerScope.EnrichAndCreateScopeItem(logEvent, logEventPropertyFactory, out LogEventPropertyValue? scopeItem);
+
+        Assert.Contains(propertyName, logEvent.Properties);
+
+        var scalarValue = logEvent.Properties[propertyName] as ScalarValue;
+        Assert.NotNull(scalarValue);
+
+        var actualValue = scalarValue.Value as string;
+        Assert.NotNull(actualValue);
+        Assert.Equal(expectedValue, actualValue);
+    }
+}

test/Serilog.Extensions.Logging.Tests/Support/LogEventPropertyFactory.cs

@@ -0,0 +1,15 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using Serilog.Core;
+using Serilog.Events;
+
+namespace Serilog.Extensions.Logging.Tests.Support;
+internal class LogEventPropertyFactory : ILogEventPropertyFactory
+{
+    public LogEventProperty CreateProperty(string name, object? value, bool destructureObjects = false)
+    {
+        var scalarValue = new ScalarValue(value);
+        return new LogEventProperty(name, scalarValue);
+    }
+}