Added functionality to support the destructurer operator in BeginScope.

Author: wlo023

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

@@ -58,7 +58,16 @@ public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
                     if (stateProperty.Key == SerilogLoggerProvider.OriginalFormatPropertyName && stateProperty.Value is string)
                         continue;
 
-                    var property = propertyFactory.CreateProperty(stateProperty.Key, stateProperty.Value);
+                    var key = stateProperty.Key;
+                    var destructureObject = false;
+
+                    if (key.StartsWith("@"))
+                    {
+                        key = key.Substring(1);
+                        destructureObject = true;
+                    }
+                    
+                    var property = propertyFactory.CreateProperty(key, stateProperty.Value, destructureObject);
                     logEvent.AddPropertyIfAbsent(property);
                 }
             }

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

@@ -288,6 +288,82 @@ public void WhenDisposeIsTrueProvidedLoggerIsDisposed()
             Assert.True(logger.IsDisposed);
         }
 
+        [Fact]
+        public void BeginScopeDestructuresObjectsWhenDestructurerIsUsedInMessageTemplate()
+        {
+            var t = SetUp(LogLevel.Trace);
+            var logger = t.Item1;
+            var sink = t.Item2;
+
+            using (logger.BeginScope("{@Person}", new Person { FirstName = "John", LastName = "Smith" }))
+            {
+                logger.Log(LogLevel.Information, 0, TestMessage, null, null);
+            }
+
+            Assert.Equal(1, sink.Writes.Count);
+            Assert.True(sink.Writes[0].Properties.ContainsKey("Person"));
+
+            var person = (StructureValue)sink.Writes[0].Properties["Person"];
+            var firstName = (ScalarValue)person.Properties.Single(p => p.Name == "FirstName").Value;
+            var lastName = (ScalarValue)person.Properties.Single(p => p.Name == "LastName").Value;
+            Assert.Equal("John", firstName.Value);
+            Assert.Equal("Smith", lastName.Value);
+        }
+
+        [Fact]
+        public void BeginScopeDestructuresObjectsWhenDestructurerIsUsedInDictionary()
+        {
+            var t = SetUp(LogLevel.Trace);
+            var logger = t.Item1;
+            var sink = t.Item2;
+            
+            using (logger.BeginScope(new Dictionary<string, object> {{ "@Person", new Person { FirstName = "John", LastName = "Smith" }}}))
+            {
+                logger.Log(LogLevel.Information, 0, TestMessage, null, null);
+            }
+
+            Assert.Equal(1, sink.Writes.Count);
+            Assert.True(sink.Writes[0].Properties.ContainsKey("Person"));
+
+            var person = (StructureValue)sink.Writes[0].Properties["Person"];
+            var firstName = (ScalarValue)person.Properties.Single(p => p.Name == "FirstName").Value;
+            var lastName = (ScalarValue)person.Properties.Single(p => p.Name == "LastName").Value;
+            Assert.Equal("John", firstName.Value);
+            Assert.Equal("Smith", lastName.Value);
+        }
+
+        [Fact]
+        public void BeginScopeDoesNotModifyKeyWhenDestructurerIsNotUsedInMessageTemplate()
+        {
+            var t = SetUp(LogLevel.Trace);
+            var logger = t.Item1;
+            var sink = t.Item2;
+
+            using (logger.BeginScope("{FirstName}", "John"))
+            {
+                logger.Log(LogLevel.Information, 0, TestMessage, null, null);
+            }
+
+            Assert.Equal(1, sink.Writes.Count);
+            Assert.True(sink.Writes[0].Properties.ContainsKey("FirstName"));
+        }
+
+        [Fact]
+        public void BeginScopeDoesNotModifyKeyWhenDestructurerIsNotUsedInDictionary()
+        {
+            var t = SetUp(LogLevel.Trace);
+            var logger = t.Item1;
+            var sink = t.Item2;
+
+            using (logger.BeginScope(new Dictionary<string, object> { { "FirstName", "John"}}))
+            {
+                logger.Log(LogLevel.Information, 0, TestMessage, null, null);
+            }
+
+            Assert.Equal(1, sink.Writes.Count);
+            Assert.True(sink.Writes[0].Properties.ContainsKey("FirstName"));
+        }
+
         private class FoodScope : IEnumerable<KeyValuePair<string, object>>
         {
             readonly string _name;
@@ -327,5 +403,11 @@ IEnumerator IEnumerable.GetEnumerator()
                 return GetEnumerator();
             }
         }
+
+        private class Person
+        {
+            public string FirstName { get; set; }
+            public string LastName { get; set; }
+        }
     }
 }