feat!: Add required user agent details (#36)

Author: dylanlerch

src/Octopus.OpenFeature.Provider.Tests/OctopusFeatureContextProviderTests.cs

@@ -8,7 +8,7 @@ namespace Octopus.OpenFeature.Provider.Tests;
 
 public class OctopusFeatureContextProviderTests
 {
-    readonly OctopusFeatureConfiguration configuration = new("identifier")
+    readonly OctopusFeatureConfiguration configuration = new("identifier", new ProductMetadata("test-agent"))
     {
         CacheDuration = TimeSpan.FromSeconds(1)
     };

src/Octopus.OpenFeature.Provider/OctopusFeatureClient.cs

@@ -1,4 +1,5 @@
 using System.Net;
+using System.Net.Http.Headers;
 using System.Text.Json;
 using Microsoft.Extensions.Logging;
 
@@ -44,6 +45,7 @@ public async Task<bool> HaveFeaturesChanged(byte[] contentHash, CancellationToke
         {
             BaseAddress = configuration.ServerUri
         };
+        client.DefaultRequestHeaders.UserAgent.Add(new ProductInfoHeaderValue(configuration.ProductMetadata.ProductHeaderValue));
 
         FeatureCheck? hash = null;
         client.DefaultRequestHeaders.Add("Authorization", $"Bearer {configuration.ClientIdentifier}");
@@ -86,6 +88,7 @@ class FeatureCheck(byte[] contentHash)
         {
             BaseAddress = configuration.ServerUri
         };
+        client.DefaultRequestHeaders.UserAgent.Add(new ProductInfoHeaderValue(configuration.ProductMetadata.ProductHeaderValue));
 
         if (configuration.ReleaseVersionOverride is not null)
         {

src/Octopus.OpenFeature.Provider/OctopusFeatureConfiguration.cs

@@ -7,9 +7,10 @@ public class OctopusFeatureConfiguration
 {
     const string DefaultServerUri = "https://features.octopus.com";
 
-    public OctopusFeatureConfiguration(string clientIdentifier)
+    public OctopusFeatureConfiguration(string clientIdentifier, ProductMetadata productMetadata)
     {
         ClientIdentifier = clientIdentifier;
+        ProductMetadata = productMetadata;
         var serverUri = Environment.GetEnvironmentVariable("OctoToggle__Url");
         ServerUri = serverUri is not null ? new Uri(serverUri) : new Uri(DefaultServerUri);
     }
@@ -26,6 +27,11 @@ public OctopusFeatureConfiguration(string clientIdentifier)
     /// </summary>
     public string ClientIdentifier { get; set; }
 
+    /// <summary>
+    /// Metadata about the product using the OpenFeature provider
+    /// </summary>
+    public ProductMetadata ProductMetadata { get; set; }
+
     /// <summary>
     /// The amount of time between checks to see if new feature toggles are available
     /// The cache will be refreshed if new feature toggles are available

src/Octopus.OpenFeature.Provider/ProductMetadata.cs

@@ -0,0 +1,24 @@
+using System.Net.Http.Headers;
+
+namespace Octopus.OpenFeature.Provider;
+
+/// <summary>
+/// Metadata about the application using the OpenFeature provider. Used to build 
+/// the User-Agent sent in HTTP requests.
+/// </summary>
+/// <param name="productName">The name of the product</param>
+/// <param name="productVersion">The version of the product</param>
+public class ProductMetadata
+{
+    public ProductMetadata(string productName)
+    {
+        ProductHeaderValue = new ProductHeaderValue(productName);
+    }
+
+    public ProductMetadata(string productName, string productVersion)
+    {
+        ProductHeaderValue = new ProductHeaderValue(productName, productVersion);
+    }
+
+    public ProductHeaderValue ProductHeaderValue { get; }
+}