Add DiagnosticsTelemetryModule.AddOrSetHeartbeatProperty extension method (#326)

Author: xavierdecoster

src/NuGet.Services.Logging/Extensions/DiagnosticsTelemetryModuleExtensions.cs

@@ -0,0 +1,39 @@
+// 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 System;
+using Microsoft.ApplicationInsights.Extensibility.Implementation.Tracing;
+
+namespace NuGet.Services.Logging
+{
+    public static class DiagnosticsTelemetryModuleExtensions
+    {
+        /// <summary>
+        /// Tries to add or set a heartbeat property.
+        /// </summary>
+        /// <param name="module">The <see cref="DiagnosticsTelemetryModule"/>.</param>
+        /// <param name="propertyName">Name of the heartbeat value to add.</param>
+        /// <param name="propertyValue">Current value of the heartbeat value to add.</param>
+        /// <param name="isHealthy">Flag indicating whether or not the property represents a healthy value.</param>
+        /// <returns><c>True</c> if the property was set; otherwise <c>False</c>.</returns>
+        public static bool AddOrSetHeartbeatProperty(
+            this DiagnosticsTelemetryModule module,
+            string propertyName,
+            string propertyValue,
+            bool isHealthy)
+        {
+            if (module == null)
+            {
+                throw new ArgumentNullException(nameof(module));
+            }
+
+            var propertySet = module.AddHeartbeatProperty(propertyName, propertyValue, isHealthy);
+            if (!propertySet)
+            {
+                return module.SetHeartbeatProperty(propertyName, propertyValue, isHealthy);
+            }
+
+            return propertySet;
+        }
+    }
+}

…ces.Logging/TelemetryClientExtensions.cs …/Extensions/TelemetryClientExtensions.cssrc/NuGet.Services.Logging/TelemetryClientExtensions.cs renamed to src/NuGet.Services.Logging/Extensions/TelemetryClientExtensions.cs src/NuGet.Services.Logging/TelemetryClientExtensions.cs renamed to src/NuGet.Services.Logging/Extensions/TelemetryClientExtensions.cs

@@ -53,11 +53,12 @@
     <Compile Include="DeploymentLabelEnricher.cs" />
     <Compile Include="DurationMetric.cs" />
     <Compile Include="ExceptionTelemetryProcessor.cs" />
+    <Compile Include="Extensions\DiagnosticsTelemetryModuleExtensions.cs" />
     <Compile Include="LoggingSetup.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Properties\AssemblyInfo.*.cs" />
     <Compile Include="RequestTelemetryProcessor.cs" />
-    <Compile Include="TelemetryClientExtensions.cs" />
+    <Compile Include="Extensions\TelemetryClientExtensions.cs" />
     <Compile Include="TelemetryClientWrapper.cs" />
     <Compile Include="TelemetryContextInitializer.cs" />
   </ItemGroup>

src/NuGet.Services.Logging/NuGet.Services.Logging.csproj

@@ -0,0 +1,123 @@
+// 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 System;
+using System.Collections.Generic;
+using System.Reflection;
+using Microsoft.ApplicationInsights.Extensibility.Implementation.Tracing;
+using Xunit;
+
+namespace NuGet.Services.Logging.Tests
+{
+    public class DiagnosticsTelemetryModuleExtensionsTests
+    {
+        public class TheAddOrSetHeartbeatPropertyMethod
+        {
+            [Fact]
+            public void ThrowsForNullModule()
+            {
+                Assert.Throws<ArgumentNullException>(
+                    "module",
+                    () => DiagnosticsTelemetryModuleExtensions.AddOrSetHeartbeatProperty(null, "name", "value", true));
+            }
+
+            [Fact]
+            public void ReturnsFalseForNullPropertyName()
+            {
+                // Arrange
+                var module = new DiagnosticsTelemetryModule();
+
+                // Act 
+                var result = DiagnosticsTelemetryModuleExtensions.AddOrSetHeartbeatProperty(module, null, "value", true);
+
+                // Assert
+                Assert.False(result);
+            }
+
+            [Theory]
+            [InlineData("propertyName", "propertyValue", true)]
+            [InlineData("propertyName", "propertyValue", false)]
+            public void ReturnsTrueAndAddsPayloadWhenNotAddedYet(string propertyName, string propertyValue, bool isHealthy)
+            {
+                // Arrange
+                var module = new DiagnosticsTelemetryModule();
+
+                // Act 
+                var result = DiagnosticsTelemetryModuleExtensions.AddOrSetHeartbeatProperty(
+                    module,
+                    propertyName,
+                    propertyValue,
+                    isHealthy);
+
+                // Assert
+                Assert.True(result);
+
+                VerifyHeartbeatPropertyPayload(module, propertyName, propertyValue, isHealthy);
+            }
+
+            [Theory]
+            [InlineData("propertyName", "propertyValue", true)]
+            [InlineData("propertyName", "propertyValue", false)]
+            public void ReturnsTrueAndSetsPayloadWhenAlreadyAdded(string propertyName, string propertyValue, bool isHealthy)
+            {
+                // Arrange
+                var module = new DiagnosticsTelemetryModule();
+                module.AddHeartbeatProperty(propertyName, propertyValue, isHealthy);
+
+                // Act 
+                var result = DiagnosticsTelemetryModuleExtensions.AddOrSetHeartbeatProperty(
+                    module,
+                    propertyName,
+                    propertyValue,
+                    isHealthy);
+
+                // Assert
+                Assert.True(result);
+
+                VerifyHeartbeatPropertyPayload(module, propertyName, propertyValue, isHealthy);
+            }
+
+            private void VerifyHeartbeatPropertyPayload(
+                DiagnosticsTelemetryModule module,
+                string propertyName,
+                string propertyValue,
+                bool isHealthy)
+            {
+                // Verify payload settings using reflection
+                var heartbeatPropertyManager = typeof(DiagnosticsTelemetryModule)
+                    .GetField("HeartbeatProvider", BindingFlags.NonPublic | BindingFlags.Instance)
+                    .GetValue(module) as IHeartbeatPropertyManager;
+
+                var heartbeatProperties = heartbeatPropertyManager
+                    .GetType()
+                    .GetField("heartbeatProperties", BindingFlags.NonPublic | BindingFlags.Instance)
+                    .GetValue(heartbeatPropertyManager); // returns ConcurrentDictionary<string, HeartbeatPropertyPayload>
+
+                var propertyNames = heartbeatProperties
+                    .GetType()
+                    .GetProperty("Keys", BindingFlags.Public | BindingFlags.Instance)
+                    .GetValue(heartbeatProperties) as ICollection<string>;
+
+                Assert.Contains(propertyNames, i => i.Equals(propertyName));
+
+                var propertyPayload = heartbeatProperties
+                    .GetType()
+                    .GetProperty("Item", BindingFlags.Public | BindingFlags.Instance)
+                    .GetValue(heartbeatProperties, new object[] { propertyName }); // returns internal type HeartbeatPropertyPayload
+
+                var payloadValue = propertyPayload
+                    .GetType()
+                    .GetProperty("PayloadValue", BindingFlags.Public | BindingFlags.Instance)
+                    .GetValue(propertyPayload) as string;
+
+                var payloadIsHealthy = (bool)propertyPayload
+                    .GetType()
+                    .GetProperty("IsHealthy", BindingFlags.Public | BindingFlags.Instance)
+                    .GetValue(propertyPayload);
+
+                Assert.Equal(propertyValue, payloadValue);
+                Assert.Equal(isHealthy, payloadIsHealthy);
+            }
+        }
+    }
+}

tests/NuGet.Services.Logging.Tests/Extensions/DiagnosticsTelemetryModuleExtensionsTests.cs

@@ -55,11 +55,12 @@
   <ItemGroup>
     <Compile Include="ApplicationInsightsTests.cs" />
     <Compile Include="DeploymentLabelEnricherTests.cs" />
+    <Compile Include="Extensions\DiagnosticsTelemetryModuleExtensionsTests.cs" />
     <Compile Include="ExceptionTelemetryProcessorTests.cs" />
     <Compile Include="LoggingSetupTests.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="RequestTelemetryProcessorTests.cs" />
-    <Compile Include="TelemetryClientExtensionsTests.cs" />
+    <Compile Include="Extensions\TelemetryClientExtensionsTests.cs" />
     <Compile Include="TelemetryProcessorTest.cs" />
   </ItemGroup>
   <ItemGroup>