feat: add possibility to follow HTTP redirects (#233)

bednar · web-flow · commit 25639c8c6f50 · 2021-08-31T10:51:40.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,8 @@
 Adds a `Type` overload for POCOs to `QueryAsync`. This will add `object ConvertToEntity(FluxRecord, Type)` to `IFluxResultMapper`
 
 ### Features
-1. [#232](https://github.com/influxdata/influxdb-client-csharp/pull/232): Adds a `Type` overload for POCOs to `QueryAsync`.
+1. [#232](https://github.com/influxdata/influxdb-client-csharp/pull/232): Add a `Type` overload for POCOs to `QueryAsync`.
+1. [#233](https://github.com/influxdata/influxdb-client-csharp/pull/233): Add possibility to follow HTTP redirects
 
 ## 2.1.0 [2021-08-20]
 
diff --git a/Client.Core.Test/AbstractMockServerTest.cs b/Client.Core.Test/AbstractMockServerTest.cs
@@ -13,7 +13,7 @@ public class AbstractMockServerTest : AbstractTest
         [SetUp]
         public new void SetUp()
         {
-            if (MockServer != null && MockServer.IsStarted)
+            if (MockServer is { IsStarted: true })
             {
                 return;
             }
diff --git a/Client.Test/InfluxDbClientFactoryTest.cs b/Client.Test/InfluxDbClientFactoryTest.cs
@@ -24,6 +24,9 @@ public void CreateInstance()
             var client = InfluxDBClientFactory.Create("http://localhost:9999");
 
             Assert.IsNotNull(client);
+            
+            var options = GetDeclaredField<InfluxDBClientOptions>(client.GetType(), client, "_options");
+            Assert.AreEqual(false, options.AllowHttpRedirects);
         }
 
         [Test]
@@ -46,13 +49,14 @@ public void CreateInstanceToken() {
         public void LoadFromConnectionString()
         {
             var client = InfluxDBClientFactory.Create("http://localhost:9999?" +
-                                                      "timeout=1000&readWriteTimeout=3000&logLevel=HEADERS&token=my-token&bucket=my-bucket&org=my-org");
+                                                      "timeout=1000&readWriteTimeout=3000&logLevel=HEADERS&token=my-token&bucket=my-bucket&org=my-org&allowHttpRedirects=true");
 
             var options = GetDeclaredField<InfluxDBClientOptions>(client.GetType(), client, "_options");
             Assert.AreEqual("http://localhost:9999/", options.Url);
             Assert.AreEqual("my-org", options.Org);
             Assert.AreEqual("my-bucket", options.Bucket);
             Assert.AreEqual("my-token".ToCharArray(), options.Token);
+            Assert.AreEqual(true, options.AllowHttpRedirects);
             Assert.AreEqual(LogLevel.Headers, options.LogLevel);
             Assert.AreEqual(LogLevel.Headers, client.GetLogLevel());
 
diff --git a/Client.Test/InfluxDbClientTest.cs b/Client.Test/InfluxDbClientTest.cs
@@ -10,6 +10,9 @@
 using InfluxDB.Client.Core.Test;
 using NUnit.Framework;
 using WireMock.RequestBuilders;
+using WireMock.ResponseBuilders;
+using WireMock.Server;
+using WireMock.Settings;
 
 namespace InfluxDB.Client.Test
 {
@@ -105,9 +108,9 @@ public void LogLevelWithQueryString()
         {
             var writer = new StringWriter();
             Trace.Listeners.Add(new TextWriterTraceListener(writer));
-            
+
             _client.SetLogLevel(LogLevel.Headers);
-            
+
             MockServer
                 .Given(Request.Create().WithPath("/api/v2/write").UsingPost())
                 .RespondWith(CreateResponse("{}"));
@@ -117,20 +120,20 @@ public void LogLevelWithQueryString()
                 writeApi.WriteRecord("b1", "org1", WritePrecision.Ns,
                     "h2o_feet,location=coyote_creek water_level=1.0 1");
             }
-            
+
             StringAssert.Contains("org=org1", writer.ToString());
             StringAssert.Contains("bucket=b1", writer.ToString());
             StringAssert.Contains("precision=ns", writer.ToString());
         }
-        
+
         [Test]
         public void LogLevelWithoutQueryString()
         {
             var writer = new StringWriter();
             Trace.Listeners.Add(new TextWriterTraceListener(writer));
-            
+
             _client.SetLogLevel(LogLevel.Basic);
-            
+
             MockServer
                 .Given(Request.Create().WithPath("/api/v2/write").UsingPost())
                 .RespondWith(CreateResponse("{}"));
@@ -140,12 +143,12 @@ public void LogLevelWithoutQueryString()
                 writeApi.WriteRecord("b1", "org1", WritePrecision.Ns,
                     "h2o_feet,location=coyote_creek water_level=1.0 1");
             }
-            
+
             StringAssert.DoesNotContain("org=org1", writer.ToString());
             StringAssert.DoesNotContain("bucket=b1", writer.ToString());
             StringAssert.DoesNotContain("precision=ns", writer.ToString());
         }
-        
+
         [Test]
         public async Task UserAgentHeader()
         {
@@ -155,11 +158,11 @@ public async Task UserAgentHeader()
 
             await _client.GetAuthorizationsApi().FindAuthorizationByIdAsync("id");
 
-            var request= MockServer.LogEntries.Last();
+            var request = MockServer.LogEntries.Last();
             StringAssert.StartsWith("influxdb-client-csharp/3.", request.RequestMessage.Headers["User-Agent"].First());
             StringAssert.EndsWith(".0.0", request.RequestMessage.Headers["User-Agent"].First());
         }
-        
+
         [Test]
         public void TrailingSlashInUrl()
         {
@@ -217,14 +220,14 @@ public void TrailingSlashInUrl()
             request = MockServer.LogEntries.Last();
             Assert.AreEqual(MockServerUrl + "/api/v2/write?org=org1&bucket=b1&precision=ns",
                 request.RequestMessage.AbsoluteUrl);
-            
+
             Assert.True(MockServer.LogEntries.Any());
             foreach (var logEntry in MockServer.LogEntries)
             {
                 StringAssert.StartsWith(MockServerUrl + "/api/v2/", logEntry.RequestMessage.AbsoluteUrl);
             }
         }
-        
+
         [Test]
         public void ProduceTypedException()
         {
@@ -242,9 +245,45 @@ public void ProduceTypedException()
         public void CreateService()
         {
             var service = _client.CreateService<DBRPsService>(typeof(DBRPsService));
-            
+
             Assert.IsNotNull(service);
             Assert.IsInstanceOf(typeof(DBRPsService), service);
         }
+
+        [Test]
+        public async Task RedirectToken()
+        {
+            _client.Dispose();
+            _client = InfluxDBClientFactory.Create(new InfluxDBClientOptions.Builder()
+                .Url(MockServerUrl)
+                .AuthenticateToken("my-token")
+                .AllowRedirects(true)
+                .Build());
+            
+            var anotherServer = WireMockServer.Start(new WireMockServerSettings
+            {
+                UseSSL = false
+            });
+
+            // redirect to another server
+            MockServer
+                .Given(Request.Create().UsingGet())
+                .RespondWith(Response.Create().WithStatusCode(301).WithHeader("location", anotherServer.Urls[0]));
+
+
+            // success response
+            anotherServer
+                .Given(Request.Create().UsingGet())
+                .RespondWith(CreateResponse("{\"status\":\"active\"}", "application/json"));
+
+            var authorization = await _client.GetAuthorizationsApi().FindAuthorizationByIdAsync("id");
+            Assert.AreEqual(AuthorizationUpdateRequest.StatusEnum.Active, authorization.Status);
+
+            StringAssert.StartsWith("Token my-token",
+                MockServer.LogEntries.Last().RequestMessage.Headers["Authorization"].First());
+            Assert.False(anotherServer.LogEntries.Last().RequestMessage.Headers.ContainsKey("Authorization"));
+
+            anotherServer.Stop();
+        }
     }
 }
diff --git a/Client/Configurations/Influx2.cs b/Client/Configurations/Influx2.cs
@@ -74,6 +74,16 @@ public string Timeout
             get => (string) base["timeout"];
             set => base["timeout"] = value;
         }
+        
+        /// <summary>
+        /// Configure automatically following HTTP 3xx redirects.
+        /// </summary>
+        [ConfigurationProperty("allowHttpRedirects", IsKey = true, IsRequired = false)]
+        public bool AllowHttpRedirects
+        {
+            get => (bool) base["allowHttpRedirects"];
+            set => base["allowHttpRedirects"] = value;
+        }
 
         [ConfigurationProperty("tags", IsRequired = false)]
         public TagCollection Tags
diff --git a/Client/InfluxDBClientOptions.cs b/Client/InfluxDBClientOptions.cs
@@ -36,6 +36,7 @@ public class InfluxDBClientOptions
         public TimeSpan ReadWriteTimeout { get; }
         
         public IWebProxy WebProxy { get; }
+        public bool AllowHttpRedirects { get; }
 
         public PointSettings PointSettings { get; }
 
@@ -57,6 +58,7 @@ private InfluxDBClientOptions(Builder builder)
             ReadWriteTimeout = builder.ReadWriteTimeout;
             
             WebProxy = builder.WebProxy;
+            AllowHttpRedirects = builder.AllowHttpRedirects;
 
             PointSettings = builder.PointSettings;
         }
@@ -95,7 +97,8 @@ public sealed class Builder
             internal string OrgString;
             internal string BucketString;
 
-            internal IWebProxy WebProxy = null;
+            internal IWebProxy WebProxy;
+            internal bool AllowHttpRedirects;
 
             internal PointSettings PointSettings = new PointSettings();
 
@@ -265,6 +268,20 @@ public Builder Proxy(IWebProxy webProxy)
                 
                 return this;
             }
+            
+            /// <summary>
+            /// Configure automatically following HTTP 3xx redirects.
+            /// </summary>
+            /// <param name="allowHttpRedirects">configure HTTP redirects</param>
+            /// <returns><see cref="Builder"/></returns>
+            public Builder AllowRedirects(bool allowHttpRedirects)
+            {
+                Arguments.CheckNotNull(allowHttpRedirects, nameof(allowHttpRedirects));
+
+                AllowHttpRedirects = allowHttpRedirects;
+                
+                return this;
+            }
 
             /// <summary>
             /// Configure Builder via App.config.
@@ -291,6 +308,7 @@ internal Builder LoadConfig(string sectionName = "influx2")
                 var logLevel = config.LogLevel;
                 var timeout = config.Timeout;
                 var readWriteTimeout = config.ReadWriteTimeout;
+                var allowHttpRedirects = config.AllowHttpRedirects;
 
                 var tags = config.Tags;
                 if (tags != null)
@@ -301,7 +319,7 @@ internal Builder LoadConfig(string sectionName = "influx2")
                     }
                 }
 
-                return Configure(url, org, bucket, token, logLevel, timeout, readWriteTimeout);
+                return Configure(url, org, bucket, token, logLevel, timeout, readWriteTimeout, allowHttpRedirects);
             }
 
             /// <summary>
@@ -324,12 +342,13 @@ internal Builder ConnectionString(string connectionString)
                 var logLevel = query.Get("logLevel");
                 var timeout = query.Get("timeout");
                 var readWriteTimeout = query.Get("readWriteTimeout");
+                var allowHttpRedirects = Convert.ToBoolean(query.Get("allowHttpRedirects"));
 
-                return Configure(url, org, bucket, token, logLevel, timeout, readWriteTimeout);
+                return Configure(url, org, bucket, token, logLevel, timeout, readWriteTimeout, allowHttpRedirects);
             }
 
             private Builder Configure(string url, string org, string bucket, string token, string logLevel,
-                string timeout, string readWriteTimeout)
+                string timeout, string readWriteTimeout, bool allowHttpRedirects = false)
             {
                 Url(url);
                 Org(org);
@@ -355,6 +374,8 @@ private Builder Configure(string url, string org, string bucket, string token, s
                     ReadWriteTimeOut(ToTimeout(readWriteTimeout));
                 }
 
+                AllowRedirects(allowHttpRedirects);
+
                 return this;
             }
 
diff --git a/Client/Internal/ApiClient.cs b/Client/Internal/ApiClient.cs
@@ -31,6 +31,7 @@ public ApiClient(InfluxDBClientOptions options, LoggingHandler loggingHandler, G
             var totalMilliseconds = (int) options.ReadWriteTimeout.TotalMilliseconds;
 
             RestClient = new RestClient(options.Url);
+            RestClient.FollowRedirects = options.AllowHttpRedirects;
             RestClient.AutomaticDecompression = false;
             Configuration = new Configuration
             {
diff --git a/Client/README.md b/Client/README.md
@@ -38,6 +38,7 @@ This section contains links to the client library documentation.
     - [Client connection string](#client-connection-string)
     - [Gzip support](#gzip-support)
     - [How to use WebProxy](#how-to-use-webproxy)
+    - [Proxy and redirects configuration](#proxy-and-redirects-configuration)
 
 ## Queries
 
@@ -1083,6 +1084,7 @@ The following options are supported:
 | LogLevel          | NONE      | rest client verbosity level |
 | ReadWriteTimeout  | 10000 ms  | read and write timeout |
 | Timeout           | 10000 ms  | socket timeout |
+| AllowHttpRedirects| false     | Configure automatically following HTTP 3xx redirects. |
 
 The `ReadWriteTimeout` and `Timeout` supports `ms`, `s` and `m` as unit. Default is milliseconds.
 
@@ -1131,6 +1133,7 @@ The following options are supported:
 | logLevel          | NONE      | rest client verbosity level |
 | readWriteTimeout  | 10000 ms  | read and write timeout |
 | timeout           | 10000 ms  | socket timeout |
+| allowHttpRedirects| false | Configure automatically following HTTP 3xx redirects. |
 
 The `readWriteTimeout` and `timeout` supports `ms`, `s` and `m` as unit. Default is milliseconds.
 
@@ -1155,6 +1158,34 @@ var options = new InfluxDBClientOptions.Builder()
 var client = InfluxDBClientFactory.Create(options);
 ```
 
+### Proxy and redirects configuration
+
+You can configure the client to tunnel requests through an HTTP proxy. To configure the proxy use `Proxy` configuration option:
+
+ ```csharp
+var options = new InfluxDBClientOptions.Builder()
+    .Url("http://localhost:8086")
+    .AuthenticateToken("my-token")
+    .Proxy(new WebProxy("http://proxyserver:80/", true))
+    .Build();
+
+using var client = InfluxDBClientFactory.Create(options);
+```
+
+Client automatically **doesn't** follows HTTP redirects. You can enable redirects by `AllowRedirects` configuration option:
+
+```csharp
+var options = new InfluxDBClientOptions.Builder()
+    .Url("http://localhost:8086")
+    .AllowRedirects(true)
+    .Build();
+
+using var client = InfluxDBClientFactory.Create(options);
+```
+
+> :warning: Due to a security reason `Authorization` header is not forwarded when redirect leads to a different domain.
+> You can create custom `Authenticator` which change this behaviour - [see more](https://stackoverflow.com/a/28285735/1953325).
+
 #### Log HTTP Request and Response
 
 The Requests and Responses can be logged by changing the LogLevel. LogLevel values are None, Basic, Headers, Body. Note that 

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public class AbstractMockServerTest : AbstractTest`
`13`	`13`	`[SetUp]`
`14`	`14`	`public new void SetUp()`
`15`	`15`	`{`
`16`		`- if (MockServer != null && MockServer.IsStarted)`
	`16`	`+ if (MockServer is { IsStarted: true })`
`17`	`17`	`{`
`18`	`18`	`return;`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ public ApiClient(InfluxDBClientOptions options, LoggingHandler loggingHandler, G`
`31`	`31`	`var totalMilliseconds = (int) options.ReadWriteTimeout.TotalMilliseconds;`
`32`	`32`
`33`	`33`	`RestClient = new RestClient(options.Url);`
	`34`	`+ RestClient.FollowRedirects = options.AllowHttpRedirects;`
`34`	`35`	`RestClient.AutomaticDecompression = false;`
`35`	`36`	`Configuration = new Configuration`
`36`	`37`	`{`