feat: add metrics extension data (applied from squash)

Unleash · Jul 9, 2024 · 31f3cbc · 31f3cbc
1 parent 26071d5
commit 31f3cbc
Show file tree

Hide file tree

Showing 8 changed files with 120 additions and 3 deletions.
diff --git a/src/Unleash/Internal/UnleashServices.cs b/src/Unleash/Internal/UnleashServices.cs
@@ -16,7 +16,7 @@ internal class UnleashServices : IDisposable
         private readonly CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
         private readonly IUnleashScheduledTaskManager scheduledTaskManager;
 
-        const string supportedSpecVersion = "4.5.1";
+        public const string supportedSpecVersion = "4.5.1";
 
         internal CancellationToken CancellationToken { get; }
         internal IUnleashContextProvider ContextProvider { get; }
@@ -70,7 +70,7 @@ public UnleashServices(UnleashSettings settings, EventCallbackConfig eventConfig
             }
             else
             {
-                // Mocked backend: fill instance collection 
+                // Mocked backend: fill instance collection
                 apiClient = settings.UnleashApiClient;
             }
 

diff --git a/src/Unleash/Metrics/ClientMetrics.cs b/src/Unleash/Metrics/ClientMetrics.cs
@@ -5,5 +5,34 @@ internal class ClientMetrics
         public string AppName { get; set; }
         public string InstanceId { get; set; }
         public MetricsBucket Bucket { get; set; }
+        public string PlatformName
+        {
+            get
+            {
+                return MetricsMetadata.GetPlatformName();
+
+            }
+        }
+        public string PlatformVersion
+        {
+            get
+            {
+                return MetricsMetadata.GetPlatformVersion();
+            }
+        }
+        public string YggdrasilVersion
+        {
+            get
+            {
+                return null;
+            }
+        }
+        public string SpecVersion
+        {
+            get
+            {
+                return UnleashServices.supportedSpecVersion;
+            }
+        }
     }
 }
diff --git a/src/Unleash/Metrics/ClientRegistration.cs b/src/Unleash/Metrics/ClientRegistration.cs
@@ -11,5 +11,34 @@ internal class ClientRegistration
         public List<string> Strategies { get; set; }
         public DateTimeOffset Started { get; set; }
         public long Interval { get; set; }
+        public string PlatformName
+        {
+            get
+            {
+                return MetricsMetadata.GetPlatformName();
+
+            }
+        }
+        public string PlatformVersion
+        {
+            get
+            {
+                return MetricsMetadata.GetPlatformVersion();
+            }
+        }
+        public string YggdrasilVersion
+        {
+            get
+            {
+                return null;
+            }
+        }
+        public string SpecVersion
+        {
+            get
+            {
+                return UnleashServices.supportedSpecVersion;
+            }
+        }
     }
 }
diff --git a/src/Unleash/Metrics/MetricsMetadata.cs b/src/Unleash/Metrics/MetricsMetadata.cs
@@ -0,0 +1,34 @@
+using System.Text.RegularExpressions;
+
+internal static class MetricsMetadata
+{
+    internal static string GetPlatformName()
+    {
+#if NETSTANDARD1_1_OR_GREATER || NETCOREAPP1_0_OR_GREATER
+        return GetPlatformName(System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription);
+#else
+            return "PreDotNetCore";
+#endif
+    }
+
+    internal static string GetPlatformName(string frameworkDescription)
+    {
+        var match = Regex.Match(frameworkDescription, @"^(?<name>.+?) \d");
+        return match.Success ? match.Groups["name"].Value : frameworkDescription;
+    }
+
+    internal static string GetPlatformVersion()
+    {
+#if NETSTANDARD1_1_OR_GREATER || NETCOREAPP1_0_OR_GREATER
+        return GetPlatformVersion(System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription);
+#else
+            return null;
+#endif
+    }
+
+    internal static string GetPlatformVersion(string frameworkDescription)
+    {
+        var match = Regex.Match(frameworkDescription, @"(\d+\.\d+\.\d+)");
+        return match.Success ? match.Value : null;
+    }
+}
diff --git a/tests/Unleash.Tests/Communication/UnleashApiClient_RegisterClient_Tests.cs b/tests/Unleash.Tests/Communication/UnleashApiClient_RegisterClient_Tests.cs
@@ -18,6 +18,10 @@ public async Task RegisterClient_Success()
                 .WithPartialContent("\"interval\":1000")
                 .WithPartialContent("\"sdkVersion\":\"1.0.1\"")
                 .WithPartialContent("\"strategies\":[\"abc\"]")
+                .WithPartialContent("specVersion")
+                .WithPartialContent("platformName")
+                .WithPartialContent("platformVersion")
+                .WithPartialContent("\"yggdrasilVersion\":null")
                 .Respond("application/json", "{ 'status': 'ok' }");
 
             var clientRegistration = new ClientRegistration()

diff --git a/tests/Unleash.Tests/Communication/UnleashApiClient_SendMetrics_Tests.cs b/tests/Unleash.Tests/Communication/UnleashApiClient_SendMetrics_Tests.cs
@@ -19,6 +19,10 @@ public async Task SendMetrics_Success()
                 .WithPartialContent("instanceId")
                 .WithPartialContent("\"no\":0")
                 .WithPartialContent("\"yes\":1")
+                .WithPartialContent("specVersion")
+                .WithPartialContent("platformName")
+                .WithPartialContent("platformVersion")
+                .WithPartialContent("\"yggdrasilVersion\":null")
                 .Respond("application/json", "{ 'status': 'ok' }");
 
             var metricsBucket = new ThreadSafeMetricsBucket();

diff --git a/tests/Unleash.Tests/Metrics/MetricsMetadataTests.cs b/tests/Unleash.Tests/Metrics/MetricsMetadataTests.cs
@@ -0,0 +1,17 @@
+using FluentAssertions;
+using NUnit.Framework;
+
+public class MetricsMetadataTests
+{
+    [TestCase(".NET Core 3.1.32", ".NET Core", "3.1.32")]
+    [TestCase(".NET 7.0.12", ".NET", "7.0.12")]
+    [TestCase(".NET", ".NET", null)] //apparently this can be a thing but the docs are very shady on when
+    public void GetPlatformName_ShouldReturnDotNet(string inputString, string expectedName, string expectedVersion)
+    {
+        var platformName = MetricsMetadata.GetPlatformName(inputString);
+        var platformVersion = MetricsMetadata.GetPlatformVersion(inputString);
+
+        platformName.Should().Be(expectedName);
+        platformVersion.Should().Be(expectedVersion);
+    }
+}
diff --git a/tests/Unleash.Tests/Strategy/Segments_Tests.cs b/tests/Unleash.Tests/Strategy/Segments_Tests.cs
@@ -131,4 +131,4 @@ public static IUnleash CreateUnleash(string name, ToggleCollection state)
             return unleash;
         }
     }
-}
+}