Merge #241

241: Feature/Analytics r=brunoocasali a=brunoocasali

- Add custom User-Agent to every HTTP call.

Related to meilisearch/integration-guides#150


Co-authored-by: Bruno Casali <[email protected]>

Author: bors[bot]

src/Meilisearch/Extensions/HttpExtensions.cs

@@ -74,6 +74,13 @@ public static void AddApiKeyToHeader(this HttpClient client, string apiKey)
             }
         }
 
+        public static void AddDefaultUserAgent(this HttpClient client)
+        {
+            var version = new Version();
+
+            client.DefaultRequestHeaders.Add("User-Agent", version.GetQualifiedVersion());
+        }
+
         private static StringContent PrepareJsonPayload<T>(T body, JsonSerializerOptions options = null)
         {
             options = options ?? Constants.JsonSerializerOptionsWriteNulls;

src/Meilisearch/MeilisearchClient.cs

@@ -26,10 +26,11 @@ public class MeilisearchClient
         /// </summary>
         /// <param name="url">URL corresponding to Meilisearch server.</param>
         /// <param name="apiKey">API Key to connect to the Meilisearch server.</param>
-        public MeilisearchClient(string url, string apiKey = default)
+        public MeilisearchClient(string url, string apiKey = default, HttpClient client = null)
         {
             _http = new HttpClient(new MeilisearchMessageHandler(new HttpClientHandler())) { BaseAddress = new Uri(url) };
             _http.AddApiKeyToHeader(apiKey);
+            _http.AddDefaultUserAgent();
             _taskEndpoint = null;
         }
 
@@ -43,6 +44,7 @@ public MeilisearchClient(HttpClient client, string apiKey = default)
         {
             _http = client;
             _http.AddApiKeyToHeader(apiKey);
+            _http.AddDefaultUserAgent();
         }
 
         /// <summary>

tests/Meilisearch.Tests/MeilisearchClientTests.cs

@@ -145,5 +145,16 @@ public async Task DeleteIndex()
             var finishedTask = await _defaultClient.Index(indexUid).WaitForTaskAsync(task.Uid);
             Assert.Equal("succeeded", finishedTask.Status);
         }
+
+        [Fact]
+        public void GetDefaultUserAgentHeader()
+        {
+            var httpClient = ClientFactory.Instance.CreateClient<MeilisearchClient>();
+            var client = new MeilisearchClient(httpClient);
+            var userAgent = string.Join(' ', httpClient.DefaultRequestHeaders.GetValues("User-Agent"));
+            var version = new Version();
+
+            Assert.Equal(version.GetQualifiedVersion(), userAgent);
+        }
     }
 }