Add support for dictionaries in destructured objects

serilog-contrib · Oct 20, 2022 · 1514169 · 1514169
1 parent 6a6e6cc
commit 1514169
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 1 deletion.
diff --git a/Changelog.md b/Changelog.md
@@ -1,5 +1,9 @@
 # Changelog for Serilog.Enrichers.Sensitive
 
+## 1.5.1 
+
+- Add support for dictionaries in destructured objects
+
 ## 1.5.0
 
 - Add support for collections in destructured objects

diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,6 +1,6 @@
 <Project>
 	<PropertyGroup>
-		<Version>1.5.0.0</Version>
+		<Version>1.5.1.0</Version>
 		<Authors>Sander van Vliet, Huibert Jan Nieuwkamer, Scott Toberman</Authors>
 		<Company>Codenizer BV</Company>
 		<Copyright>2022 Sander van Vliet</Copyright>

diff --git a/src/Serilog.Enrichers.Sensitive/SensitiveDataEnricher.cs b/src/Serilog.Enrichers.Sensitive/SensitiveDataEnricher.cs
@@ -161,6 +161,28 @@ public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
 
                         return (anyMasked, new StructureValue(propList));
                     }
+                case DictionaryValue dictionaryValue:
+                {
+                    var resultDictionary = new List<KeyValuePair<ScalarValue, LogEventPropertyValue>>();
+                    var anyKeyMasked = false;
+
+                    foreach (var pair in dictionaryValue.Elements)
+                    {
+                        var (wasPairMasked, pairResult) = MaskProperty(new KeyValuePair<string, LogEventPropertyValue>(pair.Key.Value as string, pair.Value));
+
+                        if (wasPairMasked)
+                        {
+                            resultDictionary.Add(new KeyValuePair<ScalarValue, LogEventPropertyValue>(pair.Key, pairResult));
+                            anyKeyMasked = true;
+                        }
+                        else
+                        {
+                            resultDictionary.Add(new KeyValuePair<ScalarValue, LogEventPropertyValue>(pair.Key, pair.Value));
+                        }
+                    }
+
+                    return (anyKeyMasked, new DictionaryValue(resultDictionary));
+                }
                 default:
                     return (false, null);
             }

diff --git a/test/Serilog.Enrichers.Sensitive.Tests.Unit/WhenMaskingDestructuredObject.cs b/test/Serilog.Enrichers.Sensitive.Tests.Unit/WhenMaskingDestructuredObject.cs
@@ -221,6 +221,38 @@ public void GivenDestructuredObjectIsCollectionOfObjects()
                 sensitiveProperty.Value.ToString().Should().Be("\"***MASKED***\"");
             }
         }
+
+        [Fact]
+        public void GivenDestructuredObjectIsADictionary()
+        {
+            var dictionary = new Dictionary<string, string>
+            {
+                { "SensitiveProperty", "sensitive value"},
+                { "OtherProp", "not sensitive" }
+            };
+
+            _logger.Information("Test message {@Dictionary}", dictionary);
+
+            var dictionaryProperty = _sink
+                .Should()
+                .HaveMessage("Test message {@Dictionary}")
+                .Appearing()
+                .Once()
+                .WithProperty("Dictionary")
+                .Subject as DictionaryValue;
+
+            dictionaryProperty
+                .Elements[new ScalarValue("SensitiveProperty")]
+                .ToString()
+                .Should()
+                .Be("\"***MASKED***\"");
+
+            dictionaryProperty
+                .Elements[new ScalarValue("OtherProp")]
+                .ToString()
+                .Should()
+                .Be("\"not sensitive\"");
+        }
     }
 
     public class TestObject