feat: expose HTTP response headers in InfluxDBApiException (#118)

* feat: expose HTTP response headers in ApiException, refactor integration tests. * chore: cleaning up lint. * docs: add General example Runner and HttpErrorHandled example * chore: cleanup lint * docs: update Examples/README.md * chore: lint README.md * test: adds test of null message value in InfluxDBApiException * chore: refactor Headers and StatusCode to property * chore: add Examples/General to global solution * docs: update CHANGELOG.md * chore: change assert in integration write test
InfluxCommunity · Sep 3, 2024 · fe8e214 · fe8e214
1 parent 7fed31d
commit fe8e214
Show file tree

Hide file tree

Showing 13 changed files with 378 additions and 49 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,9 @@
 ## 0.8.0 [unreleased]
+
+### Features
+
+1.[#118](https://github.com/InfluxCommunity/influxdb3-csharp/pull/118): Simplify getting response headers and status code from `InfluxDBApiException`.  Includes example runnable through `Examples/General`.
+
 ## 0.7.0 [2024-08-12]
 
 ### Migration Notice

diff --git a/Client.Test.Integration/IntegrationTest.cs b/Client.Test.Integration/IntegrationTest.cs
@@ -0,0 +1,40 @@
+
+
+using System;
+using System.Diagnostics;
+using NUnit.Framework;
+
+namespace InfluxDB3.Client.Test.Integration;
+
+public abstract class IntegrationTest
+{
+    private static readonly TraceListener ConsoleOutListener = new TextWriterTraceListener(Console.Out);
+
+    protected string Host { get; private set; } = Environment.GetEnvironmentVariable("TESTING_INFLUXDB_URL") ??
+                                                throw new InvalidOperationException(
+                                                    "TESTING_INFLUXDB_URL environment variable is not set.");
+
+    protected string Token { get; private set; } = Environment.GetEnvironmentVariable("TESTING_INFLUXDB_TOKEN") ??
+                                                   throw new InvalidOperationException(
+                                                       "TESTING_INFLUXDB_TOKEN environment variable is not set.");
+
+    protected string Database { get; private set; } = Environment.GetEnvironmentVariable("TESTING_INFLUXDB_DATABASE") ??
+                                                      throw new InvalidOperationException(
+                                                          "TESTING_INFLUXDB_DATABASE environment variable is not set.");
+
+    [OneTimeSetUp]
+    public void OneTimeSetUp()
+    {
+        if (!Trace.Listeners.Contains(ConsoleOutListener))
+        {
+            Console.SetOut(TestContext.Progress);
+            Trace.Listeners.Add(ConsoleOutListener);
+        }
+    }
+
+    [OneTimeTearDownAttribute]
+    public void OneTimeTearDownAttribute()
+    {
+        ConsoleOutListener.Dispose();
+    }
+}
diff --git a/Client.Test.Integration/QueryWriteTest.cs b/Client.Test.Integration/QueryWriteTest.cs
@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.Linq;
 using System.Threading.Tasks;
 using Grpc.Core;
@@ -12,41 +11,17 @@
 
 namespace InfluxDB3.Client.Test.Integration;
 
-public class QueryWriteTest
+public class QueryWriteTest : IntegrationTest
 {
-    private static readonly TraceListener ConsoleOutListener = new TextWriterTraceListener(Console.Out);
-
-    private readonly string _host = Environment.GetEnvironmentVariable("TESTING_INFLUXDB_URL") ??
-                                       throw new InvalidOperationException("TESTING_INFLUXDB_URL environment variable is not set.");
-    private readonly string _token = Environment.GetEnvironmentVariable("TESTING_INFLUXDB_TOKEN") ??
-                                         throw new InvalidOperationException("TESTING_INFLUXDB_TOKEN environment variable is not set.");
-    private readonly string _database = Environment.GetEnvironmentVariable("TESTING_INFLUXDB_DATABASE") ??
-                                        throw new InvalidOperationException("TESTING_INFLUXDB_DATABASE environment variable is not set.");
-
-    [OneTimeSetUp]
-    public void OneTimeSetUp()
-    {
-        if (!Trace.Listeners.Contains(ConsoleOutListener))
-        {
-            Console.SetOut(TestContext.Progress);
-            Trace.Listeners.Add(ConsoleOutListener);
-        }
-    }
-
-    [OneTimeTearDownAttribute]
-    public void OneTimeTearDownAttribute()
-    {
-        ConsoleOutListener.Dispose();
-    }
 
     [Test]
     public async Task QueryWrite()
     {
         using var client = new InfluxDBClient(new ClientConfig
         {
-            Host = _host,
-            Token = _token,
-            Database = _database
+            Host = Host,
+            Token = Token,
+            Database = Database
         });
 
         const string measurement = "integration_test";
@@ -82,8 +57,8 @@ public void QueryNotAuthorized()
     {
         using var client = new InfluxDBClient(new ClientConfig
         {
-            Host = _host,
-            Database = _database
+            Host = Host,
+            Database = Database
         });
 
         var ae = Assert.ThrowsAsync<RpcException>(async () =>
@@ -102,9 +77,9 @@ public async Task WriteDontFailForEmptyData()
     {
         using var client = new InfluxDBClient(new ClientConfig
         {
-            Host = _host,
-            Database = _database,
-            Token = _token
+            Host = Host,
+            Database = Database,
+            Token = Token
         });
 
         await client.WritePointAsync(PointData.Measurement("cpu").SetTag("tag", "c"));
@@ -115,9 +90,9 @@ public async Task CanDisableCertificateValidation()
     {
         using var client = new InfluxDBClient(new ClientConfig
         {
-            Host = _host,
-            Database = _database,
-            Token = _token,
+            Host = Host,
+            Database = Database,
+            Token = Token,
             DisableServerCertificateValidation = true
         });
 
@@ -129,9 +104,9 @@ public async Task WriteDataGzipped()
     {
         using var client = new InfluxDBClient(new ClientConfig
         {
-            Host = _host,
-            Database = _database,
-            Token = _token,
+            Host = Host,
+            Database = Database,
+            Token = Token,
             WriteOptions = new WriteOptions
             {
                 GzipThreshold = 1
@@ -146,9 +121,9 @@ public async Task QueryWriteParameters()
     {
         using var client = new InfluxDBClient(new ClientConfig
         {
-            Host = _host,
-            Token = _token,
-            Database = _database
+            Host = Host,
+            Token = Token,
+            Database = Database
         });
 
         var testId = DateTime.UtcNow.Millisecond;

diff --git a/Client.Test.Integration/WriteTest.cs b/Client.Test.Integration/WriteTest.cs
@@ -0,0 +1,58 @@
+using System;
+using System.Collections.Frozen;
+using System.Linq;
+using System.Threading.Tasks;
+using InfluxDB3.Client.Config;
+using NUnit.Framework;
+
+namespace InfluxDB3.Client.Test.Integration;
+
+public class WriteTest : IntegrationTest
+{
+
+    [Test]
+    public async Task WriteWithError()
+    {
+        using var client = new InfluxDBClient(new ClientConfig
+        {
+            Host = Host,
+            Token = Token,
+            Database = Database,
+        });
+
+        try
+        {
+            await client.WriteRecordAsync("vehicle,id=vwbus vel=0.0,distance=,status=\"STOPPED\"");
+        }
+        catch (Exception ex)
+        {
+            if (ex is InfluxDBApiException)
+            {
+                var iaex = (InfluxDBApiException)ex;
+                Assert.Multiple(() =>
+                {
+                    Assert.That(iaex.Message,
+                        Contains.Substring("Found trailing content: 'distance=,status=\"STOPPED\"'"));
+                    Assert.That(iaex.StatusCode.ToString(), Is.EqualTo("BadRequest"));
+                    Assert.That(iaex.StatusCode, Is.EqualTo(System.Net.HttpStatusCode.BadRequest));
+                });
+                var headersDix = iaex.Headers.ToFrozenDictionary();
+                Assert.DoesNotThrow(() =>
+                {
+                    Assert.Multiple(() =>
+                    {
+                        Assert.That(headersDix["trace-id"].First(), Is.Not.Empty);
+                        Assert.That(headersDix["trace-sampled"].First(), Is.EqualTo("false"));
+                        Assert.That(headersDix["Strict-Transport-Security"].First(), Is.Not.Empty);
+                        Assert.That(headersDix["X-Influxdb-Request-ID"].First(), Is.Not.Empty);
+                        Assert.That(headersDix["X-Influxdb-Build"].First(), Is.EqualTo("Cloud"));
+                    });
+                });
+            }
+            else
+            {
+                Assert.Fail($"Should catch InfluxDBApiException, but received {ex.GetType()}: {ex.Message}.");
+            }
+        }
+    }
+}
diff --git a/Client.Test/InfluxDBApiExceptionTest.cs b/Client.Test/InfluxDBApiExceptionTest.cs
@@ -0,0 +1,86 @@
+using System;
+using System.Collections.Frozen;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using WireMock.RequestBuilders;
+using WireMock.ResponseBuilders;
+
+namespace InfluxDB3.Client.Test;
+
+public class InfluxDBApiExceptionTest : MockServerTest
+{
+
+    private InfluxDBClient _client;
+
+    [TearDown]
+    public void TearDown()
+    {
+        base.TearDown();
+        _client?.Dispose();
+    }
+
+    [Test]
+    public void NullValuesTest()
+    {
+        var exception = new InfluxDBApiException("Testing exception", null);
+        Assert.That(exception.StatusCode.ToString(), Is.EqualTo("0"));
+        var headers = exception.Headers;
+        Assert.That(exception.Headers, Is.Null);
+    }
+
+    [Test]
+    public async Task GeneratedInfluxDbException()
+    {
+        var requestId = Guid.NewGuid().ToString();
+
+        MockServer
+            .Given(Request.Create().WithPath("/api/v2/write").UsingPost())
+            .RespondWith(Response.Create()
+                .WithStatusCode(400)
+                .WithBody("{ \"message\": \"just testing\", \"statusCode\": \"bad request\" }")
+                .WithHeaders(new Dictionary<string, string>()
+                {
+                    {"Content-Type", "application/json"},
+                    {"Trace-Id", "123456789ABCDEF0"},
+                    {"Trace-Sampled", "false"},
+                    {"X-Influxdb-Request-ID", requestId},
+                    {"X-Influxdb-Build", "Cloud"}
+                })
+            );
+
+        _client = new InfluxDBClient(MockServerUrl,
+            "my-token",
+            "my-org",
+            "my-database");
+        try
+        {
+            await _client.WriteRecordAsync("wetbulb,location=prg val=20.1");
+        }
+        catch (Exception ex)
+        {
+            if (ex is InfluxDBApiException)
+            {
+                var idbae = (InfluxDBApiException)ex;
+                Assert.Multiple(() =>
+                {
+                    Assert.That(idbae.Message, Is.EqualTo("just testing"));
+                    Assert.That(idbae.StatusCode.ToString(), Is.EqualTo("BadRequest"));
+                    Assert.That(idbae.Headers.Count() == 7);
+                });
+                var headersDix = idbae.Headers.ToFrozenDictionary();
+                Assert.Multiple(() =>
+                {
+                    Assert.That(headersDix["Trace-Id"].First(), Is.EqualTo("123456789ABCDEF0"));
+                    Assert.That(headersDix["Trace-Sampled"].First(), Is.EqualTo("false"));
+                    Assert.That(headersDix["X-Influxdb-Request-ID"].First(), Is.EqualTo(requestId));
+                    Assert.That(headersDix["X-Influxdb-Build"].First(), Is.EqualTo("Cloud"));
+                });
+            }
+            else
+            {
+                Assert.Fail($"Should have thrown InfluxdbApiException. Not - {ex}");
+            }
+        }
+    }
+}
diff --git a/Client/InfluxDBApiException.cs b/Client/InfluxDBApiException.cs
@@ -1,5 +1,7 @@
 using System;
+using System.Net;
 using System.Net.Http;
+using System.Net.Http.Headers;
 
 namespace InfluxDB3.Client;
 
@@ -14,4 +16,21 @@ internal InfluxDBApiException(string message, HttpResponseMessage httpResponseMe
     }
 
     public HttpResponseMessage? HttpResponseMessage { get; private set; }
+
+    public HttpResponseHeaders? Headers
+    {
+        get
+        {
+            return HttpResponseMessage?.Headers;
+        }
+    }
+
+    public HttpStatusCode StatusCode
+    {
+        get
+        {
+            return HttpResponseMessage?.StatusCode ?? 0;
+        }
+    }
+
 }
diff --git a/Examples/Downsampling/DownsamplingExample.cs b/Examples/Downsampling/DownsamplingExample.cs
@@ -9,9 +9,9 @@ public class DownsamplingExample
 {
     static async Task Main(string[] args)
     {
-        const string host = "https://us-east-1-1.aws.cloud2.influxdata.com";
-        const string token = "my-token";
-        const string database = "my-database";
+        var host = Environment.GetEnvironmentVariable("INFLUXDB_URL") ?? "https://us-east-1-1.aws.cloud2.influxdata.com";
+        var token = Environment.GetEnvironmentVariable("INFLUXDB_TOKEN") ?? "my-token";
+        var database = Environment.GetEnvironmentVariable("INFLUXDB_DATABASE") ?? "my-database";
 
         using var client = new InfluxDBClient(host: host, token: token, database: database);
 
@@ -60,4 +60,9 @@ GROUP BY window_start
             await client.WritePointAsync(downsampledPoint);
         }
     }
+
+    public static async Task Run()
+    {
+        await Main(Array.Empty<string>());
+    }
 }
diff --git a/Examples/General/General.csproj b/Examples/General/General.csproj
@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net8.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <AssemblyName>InfluxDB3.Examples.General</AssemblyName>
+        <RootNamespace>InfluxDB3.Examples.General</RootNamespace>
+        <StartupObject>InfluxDB3.Examples.General.Runner</StartupObject>
+        <AssemblyOriginatorKeyFile>../../Keys/Key.snk</AssemblyOriginatorKeyFile>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\..\Client\Client.csproj" />
+        <ProjectReference Include="..\Downsampling\Downsampling.csproj" />
+        <ProjectReference Include="..\IOx\Examples.IOx.csproj" />
+    </ItemGroup>
+
+</Project>