Fix NRE in DiagnosticSourceListener when property values are null (#143)

* Put back DiagnosticSourceListener tests * Fix NRE in DiagnosticSourceListener when property value is null
microsoft · Jan 16, 2018 · 969e71a · 969e71a
1 parent 98c0b10
commit 969e71a
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 1 deletion.
diff --git a/Logging.sln b/Logging.sln
@@ -52,6 +52,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TraceListener", "src\TraceL
 EndProject
 Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "EventSource.Shared", "src\EventSource.Shared\EventSource.Shared\EventSource.Shared.shproj", "{A964DE6D-9750-4013-8BE2-79C2AFC056E5}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DiagnosticSourceListener.netcoreapp1.Tests", "test\DiagnosticSourceListener.netcoreapp10.Tests\DiagnosticSourceListener.netcoreapp1.Tests.csproj", "{625DABF6-C4AD-41A9-B2C0-04C9FEC2ADCF}"
+EndProject
 Global
 	GlobalSection(SharedMSBuildProjectFiles) = preSolution
 		test\CommonTestShared\CommonTestShared.projitems*{3b9ab7fa-562d-4e4e-86e3-3348426bc0d9}*SharedItemsImports = 13
@@ -174,6 +176,14 @@ Global
 		{E3766DD1-F376-43F8-B242-6CF06E186179}.Release|Any CPU.Build.0 = Release|Any CPU
 		{E3766DD1-F376-43F8-B242-6CF06E186179}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU
 		{E3766DD1-F376-43F8-B242-6CF06E186179}.Release|Mixed Platforms.Build.0 = Release|Any CPU
+		{625DABF6-C4AD-41A9-B2C0-04C9FEC2ADCF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{625DABF6-C4AD-41A9-B2C0-04C9FEC2ADCF}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{625DABF6-C4AD-41A9-B2C0-04C9FEC2ADCF}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU
+		{625DABF6-C4AD-41A9-B2C0-04C9FEC2ADCF}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU
+		{625DABF6-C4AD-41A9-B2C0-04C9FEC2ADCF}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{625DABF6-C4AD-41A9-B2C0-04C9FEC2ADCF}.Release|Any CPU.Build.0 = Release|Any CPU
+		{625DABF6-C4AD-41A9-B2C0-04C9FEC2ADCF}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU
+		{625DABF6-C4AD-41A9-B2C0-04C9FEC2ADCF}.Release|Mixed Platforms.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -195,6 +205,7 @@ Global
 		{57F41D53-A8D1-42D6-AFBE-406436CFA7DF} = {EE933574-C82B-4E59-A0D1-05328197B937}
 		{E3766DD1-F376-43F8-B242-6CF06E186179} = {EE933574-C82B-4E59-A0D1-05328197B937}
 		{A964DE6D-9750-4013-8BE2-79C2AFC056E5} = {EE933574-C82B-4E59-A0D1-05328197B937}
+		{625DABF6-C4AD-41A9-B2C0-04C9FEC2ADCF} = {2FCC45B3-D820-405D-87FA-467C96465BB1}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {AC8888B1-0E98-49D7-BE15-EB97A6261C0D}

diff --git a/src/DiagnosticSourceListener/DiagnosticSourceListenerSubscription.cs b/src/DiagnosticSourceListener/DiagnosticSourceListenerSubscription.cs
@@ -58,7 +58,7 @@ public void OnNext(KeyValuePair<string, object> @event)
                 {
                     if (!property.IsSpecialName)
                     {
-                        telemetry.Properties.Add(property.Name, property.GetValue(payload).ToString());
+                        telemetry.Properties.Add(property.Name, Convert.ToString(property.GetValue(payload)));
                     }
                 }
             }

diff --git a/test/DiagnosticSourceListener.netcoreapp10.Tests/DiagnosticSourceTelemetryModuleTests.cs b/test/DiagnosticSourceListener.netcoreapp10.Tests/DiagnosticSourceTelemetryModuleTests.cs
@@ -59,6 +59,25 @@ public void ReportsSingleEvent()
             }
         }
 
+        [TestMethod]
+        public void HandlesPropertiesWithNullValues()
+        {
+            using (var module = new DiagnosticSourceTelemetryModule())
+            {
+                var testDiagnosticSource = new TestDiagnosticSource();
+                var listeningRequest = new DiagnosticSourceListeningRequest(testDiagnosticSource.Name);
+                module.Sources.Add(listeningRequest);
+
+                module.Initialize(GetTestTelemetryConfiguration());
+
+                testDiagnosticSource.Write("Hey!", new { Prop1 = (object)null });
+
+                TraceTelemetry telemetry = (TraceTelemetry)this.adapterHelper.Channel.SentItems.First();
+                Assert.AreEqual("Hey!", telemetry.Message);
+                Assert.AreEqual(Convert.ToString(null), telemetry.Properties["Prop1"]);
+            }
+        }
+
         private TelemetryConfiguration GetTestTelemetryConfiguration(bool resetChannel = true)
         {
             var configuration = new TelemetryConfiguration();
-Original file line number
+Diff line change
@@ Expand Up / @@ -58,7 +58,7 @@ public void OnNext(KeyValuePair<string, object> @event) @@
                     {
                         if (!property.IsSpecialName)
                         {
-                            telemetry.Properties.Add(property.Name, property.GetValue(payload).ToString());
+                            telemetry.Properties.Add(property.Name, Convert.ToString(property.GetValue(payload)));
                         }
                     }
                 }
@@ Expand Down @@