Handle null scope values in EventLogLogger (dotnet/extensions#1850)

- Added test Commit migrated from dotnet/extensions@3d0c881
shadow-cs · Jun 15, 2019 · 57f49f7 · 57f49f7
1 parent 8b07c9a
commit 57f49f7
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogLogger.cs b/src/libraries/Microsoft.Extensions.Logging.EventLog/src/EventLogLogger.cs
@@ -98,10 +98,10 @@ public void Log<TState>(
                 {
                     foreach (var pair in properties)
                     {
-                        sb.Append(pair.Key).Append(": ").AppendLine(pair.Value.ToString());
+                        sb.Append(pair.Key).Append(": ").AppendLine(pair.Value?.ToString());
                     }
                 }
-                else
+                else if (scope != null)
                 {
                     sb.AppendLine(scope.ToString());
                 }

diff --git a/src/libraries/Microsoft.Extensions.Logging/tests/Common/EventLogLoggerTest.cs b/src/libraries/Microsoft.Extensions.Logging/tests/Common/EventLogLoggerTest.cs
@@ -157,14 +157,26 @@ public void Message_WritesFullMessageWithScopes()
             var expectedMessage = "Category: " + loggerName + Environment.NewLine +
                                   "EventId: 0" + Environment.NewLine +
                                   "Outer Scope" + Environment.NewLine +
-                                  "Inner Scope" + Environment.NewLine + Environment.NewLine +
+                                  "Inner Scope" + Environment.NewLine +
+                                  "K1: V1" + Environment.NewLine +
+                                  "K2: " + Environment.NewLine +
+                                  "K3: " + Environment.NewLine +
+                                  Environment.NewLine +
                                   "Message" + Environment.NewLine;
             var testEventLog = new TestEventLog(expectedMessage.Length);
             var logger = new EventLogLogger(loggerName, new EventLogSettings() { EventLog = testEventLog }, new LoggerExternalScopeProvider());
+            var scopeWithValues = new Dictionary<string, object>
+            {
+                { "K1", "V1" },
+                { "K2", "" },
+                { "K3", null },
+            };
 
             // Act
             using (logger.BeginScope("Outer Scope"))
             using (logger.BeginScope("Inner Scope"))
+            using (logger.BeginScope(scopeWithValues))
+            using (logger.BeginScope((object)null))
             {
                 logger.LogInformation("Message");
             }