feat: add User-Agent request header (influxdata#62)

* chore: fix tests (beta vs nightly)

Author: bednar

CHANGELOG.md

@@ -1,5 +1,8 @@
 ## 1.6.0 [unreleased]
 
+### Features
+1. [#61](https://github.com/influxdata/influxdb-client-csharp/issues/61): Set User-Agent to influxdb-client-csharp/VERSION for all requests
+
 ## 1.5.0 [2020-02-14]
 
 ### Features

Client.Core/Internal/AssemblyHelper.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Reflection;
+
+namespace InfluxDB.Client.Core.Internal
+{
+ public static class AssemblyHelper
+ {
+ public static string GetVersion(Type type)
+ {
+ try
+ {
+ return type.GetTypeInfo()
+ .Assembly
+ .GetCustomAttribute<AssemblyFileVersionAttribute>()
+ .Version;
+ }
+ catch (Exception)
+ {
+ return "unknown";
+ }
+ }
+ }
+}

Client.Legacy.Test/FluxClientQueryTest.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using InfluxDB.Client.Core;
@@ -15,7 +16,6 @@ public class FluxClientQueryTest : AbstractFluxClientTest
  [Test]
  public async Task Query()
  {
-
  MockServer.Given(Request.Create().WithPath("/api/v2/query").UsingPost())
  .RespondWith(CreateResponse());
 
@@ -182,6 +182,19 @@ await FluxClient.QueryAsync("from(bucket:\"telegraf\")",
  WaitToCallback();
  }
 
+ [Test]
+ public async Task UserAgentHeader()
+ {
+ MockServer.Given(Request.Create().WithPath("/api/v2/query").UsingPost())
+ .RespondWith(CreateResponse());
+
+ await FluxClient.QueryAsync("from(bucket:\"telegraf\")");
+
+ var request= MockServer.LogEntries.Last();
+ StringAssert.StartsWith("influxdb-client-csharp/1.", request.RequestMessage.Headers["User-Agent"].First());
+ StringAssert.EndsWith(".0.0", request.RequestMessage.Headers["User-Agent"].First());
+ }
+
  private void AssertSuccessResult(List<FluxTable> tables)
  {
  Assert.IsNotNull(tables);

Client.Legacy/FluxClient.cs

@@ -20,9 +20,12 @@ public FluxClient(FluxConnectionOptions options) : base(new RestClient())
  {
  _loggingHandler = new LoggingHandler(LogLevel.None);
 
+ var version = AssemblyHelper.GetVersion(typeof(FluxClient));
+ 
  RestClient.BaseUrl = new Uri(options.Url);
  RestClient.Timeout = options.Timeout.Milliseconds;
  RestClient.AddDefaultHeader("Accept", "application/json");
+ RestClient.UserAgent = $"influxdb-client-csharp/{version}";
  }
 
  /// <summary>

Client.Test/AssemblyHelperTest.cs

@@ -0,0 +1,20 @@
+using System;
+using InfluxDB.Client.Core.Internal;
+using NUnit.Framework;
+
+namespace InfluxDB.Client.Test
+{
+ [TestFixture]
+ public class AssemblyHelperTest
+ {
+ [Test]
+ public void GetAssemblyVersion()
+ {
+ var version = AssemblyHelper.GetVersion(typeof(InfluxDBClient));
+ Assert.AreEqual(1, Version.Parse(version).Major);
+ Assert.Greater(Version.Parse(version).Minor, 5);
+ Assert.AreEqual(0, Version.Parse(version).Build);
+ Assert.AreEqual(0, Version.Parse(version).Revision);
+ }
+ }
+}

Client.Test/InfluxDbClientTest.cs

@@ -1,12 +1,13 @@
 using System.Diagnostics;
 using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
 using InfluxDB.Client.Api.Client;
 using InfluxDB.Client.Api.Domain;
 using InfluxDB.Client.Core;
 using InfluxDB.Client.Core.Test;
 using NUnit.Framework;
 using WireMock.RequestBuilders;
-using Task = System.Threading.Tasks.Task;
 
 namespace InfluxDB.Client.Test
 {
@@ -139,5 +140,19 @@ public void LogLevelWithoutQueryString()
  StringAssert.DoesNotContain("bucket=b1", writer.ToString());
  StringAssert.DoesNotContain("precision=ns", writer.ToString());
  }
+ 
+ [Test]
+ public async Task UserAgentHeader()
+ {
+ MockServer
+ .Given(Request.Create().UsingGet())
+ .RespondWith(CreateResponse("{\"status\":\"active\"}", "application/json"));
+
+ await _client.GetAuthorizationsApi().FindAuthorizationByIdAsync("id");
+
+ var request= MockServer.LogEntries.Last();
+ StringAssert.StartsWith("influxdb-client-csharp/1.", request.RequestMessage.Headers["User-Agent"].First());
+ StringAssert.EndsWith(".0.0", request.RequestMessage.Headers["User-Agent"].First());
+ }
  }
 }

Client.Test/ItChecksApiTest.cs

@@ -10,7 +10,6 @@
 namespace InfluxDB.Client.Test
 {
  [TestFixture]
- [Ignore("https://github.com/influxdata/influxdb/issues/16462")]
  public class ItChecksApiTest : AbstractItClientTest
  {
  private string _orgId;

Client.Test/ItTasksApiTest.cs

@@ -84,12 +84,13 @@ public async Task CancelRunNotExist()
  }
 
  [Test]
+ [Ignore("TODO uncomment after beta")]
  public void CancelRunTaskNotExist()
  {
  var message = Assert.ThrowsAsync<HttpException>(async () =>
  await _tasksApi.CancelRunAsync("020f755c3c082000", "020f755c3c082000")).Message;
 
- Assert.AreEqual("failed to cancel run: run not found", message);
+ Assert.AreEqual("failed to cancel run: task not found", message);
  }
 
  [Test]

Client.Test/WriteApiTest.cs

@@ -313,5 +313,24 @@ public void WaitToCondition()
  StringAssert.Contains("The WriteApi can't be gracefully dispose! - 1ms", writer.ToString());
  StringAssert.DoesNotContain("The WriteApi can't be gracefully dispose! - 30000ms", writer.ToString());
  }
+ 
+ [Test]
+ public void UserAgentHeader()
+ {
+ var listener = new EventListener(_writeApi);
+
+ MockServer
+ .Given(Request.Create().WithPath("/api/v2/write").UsingPost())
+ .RespondWith(CreateResponse("{}"));
+
+ _writeApi.WriteRecord("b1", "org1", WritePrecision.Ns,
+ "h2o_feet,location=coyote_creek level\\ description=\"feet 1\",water_level=1.0 1");
+
+ listener.Get<WriteSuccessEvent>();
+ 
+ var request= MockServer.LogEntries.Last();
+ StringAssert.StartsWith("influxdb-client-csharp/1.", request.RequestMessage.Headers["User-Agent"].First());
+ StringAssert.EndsWith(".0.0", request.RequestMessage.Headers["User-Agent"].First());
+ }
  }
 }

Client/InfluxDBClient.cs

@@ -36,7 +36,10 @@ protected internal InfluxDBClient(InfluxDBClientOptions options)
  _loggingHandler = new LoggingHandler(options.LogLevel);
  _gzipHandler = new GzipHandler();
 
+ var version = AssemblyHelper.GetVersion(typeof(InfluxDBClient));
+ 
  _apiClient = new ApiClient(options, _loggingHandler, _gzipHandler);
+ _apiClient.RestClient.UserAgent = $"influxdb-client-csharp/{version}";
 
  _exceptionFactory = (methodName, response) =>
  !response.IsSuccessful ? HttpException.Create(response) : null;