Read Elasticsearch server version from a root page response (#502)

nenadvicentic · Nenad Vicentic · web-flow · commit a537c60f9c56 · 2023-01-29T00:43:37.000+01:00
Co-authored-by: Nenad Vicentic &lt;vicentic@immounited.com&gt;
diff --git a/src/Serilog.Sinks.Elasticsearch/Sinks/ElasticSearch/ElasticsearchVersionManager.cs b/src/Serilog.Sinks.Elasticsearch/Sinks/ElasticSearch/ElasticsearchVersionManager.cs
@@ -56,19 +56,18 @@ public Version EffectiveVersion
         {
             try
             {
-                var response = _client.Cat.Nodes<StringResponse>(new CatNodesRequestParameters()
-                {
-                    Headers = new[] { "v" }
-                });
+                var response = _client.DoRequest<DynamicResponse>(HttpMethod.GET, "/");
                 if (!response.Success) return null;
 
-                var discoveredVersion = response.Body.Split(new[] { '\r', '\n' }, StringSplitOptions.RemoveEmptyEntries)
-                    .FirstOrDefault();
+                var discoveredVersion = response.Dictionary["version"]["number"];
 
-                if (discoveredVersion == null)
+                if (!discoveredVersion.HasValue)
                     return null;
 
-                return new Version(discoveredVersion);
+                if (discoveredVersion.Value is not string strVersion)
+                    return null;
+
+                return new Version(strVersion);
 
             }
             catch (Exception ex)
diff --git a/test/Serilog.Sinks.Elasticsearch.Tests/ElasticsearchSinkTests.cs b/test/Serilog.Sinks.Elasticsearch.Tests/ElasticsearchSinkTests.cs
@@ -1,4 +1,5 @@
 ﻿using Elasticsearch.Net;
+using Serilog.Sinks.Elasticsearch.Tests.Stubs;
 using System.Text;
 using Xunit;
 
@@ -18,7 +19,7 @@ public void Ctor_DetectElasticsearchVersionSetToTrue_SetsTypeName(string elastic
             /* ARRANGE */
             var options = new ElasticsearchSinkOptions
             {
-                Connection = FakeResponse(elasticVersion),
+                Connection = FakeProductCheckResponse(elasticVersion),
                 TypeName = configuredTypeName
             };
 
@@ -41,7 +42,7 @@ public void Ctor_DetectElasticsearchVersionSetToFalseAssumesVersion7_SetsTypeNam
             /* ARRANGE */
             var options = new ElasticsearchSinkOptions
             {
-                Connection = FakeResponse(elasticVersion),
+                Connection = FakeProductCheckResponse(elasticVersion),
                 DetectElasticsearchVersion = false,
                 TypeName = configuredTypeName
             };
@@ -65,7 +66,7 @@ public void CreateLogger_DetectElasticsearchVersionSetToTrue_SetsTypeName(string
             /* ARRANGE */
             var options = new ElasticsearchSinkOptions
             {
-                Connection = FakeResponse(elasticVersion),
+                Connection = FakeProductCheckResponse(elasticVersion),
                 DetectElasticsearchVersion = true,
                 TypeName = configuredTypeName
             };
@@ -83,10 +84,10 @@ public void CreateLogger_DetectElasticsearchVersionSetToTrue_SetsTypeName(string
             Assert.Equal(expectedTypeName, options.TypeName);
         }
 
-        private static IConnection FakeResponse(string responseText)
+        private static IConnection FakeProductCheckResponse(string responseText)
         {
-            byte[] responseBody = Encoding.UTF8.GetBytes(responseText);
-            return new InMemoryConnection(responseBody, contentType: "text/plain; charset=UTF-8");
+            var productCheckResponse = ConnectionStub.ModifiedProductCheckResponse(responseText);
+            return new InMemoryConnection(productCheckResponse);
         }
     }
 }
diff --git a/test/Serilog.Sinks.Elasticsearch.Tests/Stubs/ConnectionStub.cs b/test/Serilog.Sinks.Elasticsearch.Tests/Stubs/ConnectionStub.cs
@@ -53,7 +53,7 @@ public override TReturn Request<TReturn>(RequestData requestData)
                         $" to be productCheck pre-flight request");
 
                 _productCheckDone = true;
-                return ReturnConnectionStatus<TReturn>(requestData); // root page returned
+                return ReturnConnectionStatus<TReturn>(requestData); // hard-coded root page returned
             }
 
             byte[] responseBytes = Array.Empty<byte>();
@@ -66,6 +66,7 @@ public override TReturn Request<TReturn>(RequestData requestData)
 
             int responseStatusCode = 200;
             string contentType = null;
+            InMemoryHttpResponse productCheckResponse = null;
 
             switch (requestData.Method)
             {
@@ -79,13 +80,10 @@ public override TReturn Request<TReturn>(RequestData requestData)
                     switch (requestData.Uri.PathAndQuery.ToLower())
                     {
                         case "/":
-                            // ReturnConnectionStatus(...) call at the bottom will return dummy product page
-                            // when root "/" is requested.
+                            productCheckResponse = ModifiedProductCheckResponse(_productVersion);
                             break;
-                        case "/_cat/nodes":
                         case "/_cat/nodes?h=v":
                             responseBytes = Encoding.UTF8.GetBytes(_productVersion);
-                            responseStatusCode = 200;
                             contentType = "text/plain; charset=UTF-8";
                             break;
                     }
@@ -100,12 +98,29 @@ public override TReturn Request<TReturn>(RequestData requestData)
                     break;
             }
 
-            return ReturnConnectionStatus<TReturn>(requestData, responseBytes, responseStatusCode, contentType);
+            return ReturnConnectionStatus<TReturn>(requestData, productCheckResponse, responseBytes, responseStatusCode, contentType);
         }
 
         public override Task<TResponse> RequestAsync<TResponse>(RequestData requestData, CancellationToken cancellationToken)
         {
             return Task.FromResult(Request<TResponse>(requestData));
         }
+
+        public static InMemoryHttpResponse ModifiedProductCheckResponse(string productVersion)
+        {
+            var productCheckResponse = ValidProductCheckResponse();
+            if (productVersion is not null)
+            {
+                using var originalMemoryStream = new MemoryStream(productCheckResponse.ResponseBytes, false);
+                {
+                    var json = LowLevelRequestResponseSerializer.Instance.Deserialize<dynamic>(originalMemoryStream);
+                    json["version"]["number"] = productVersion;
+                    using var modifiedMemoryStream = new MemoryStream();
+                    LowLevelRequestResponseSerializer.Instance.Serialize(json, modifiedMemoryStream);
+                    productCheckResponse.ResponseBytes = modifiedMemoryStream.ToArray();
+                }
+            }
+            return productCheckResponse;
+        }
     }
 }
diff --git a/test/Serilog.Sinks.Elasticsearch.Tests/Templating/DiscoverVersionTests.cs b/test/Serilog.Sinks.Elasticsearch.Tests/Templating/DiscoverVersionTests.cs
@@ -34,7 +34,7 @@ public DiscoverVersionTests()
         public void TemplatePutToCorrectUrl()
         {
             var uri = _templateGet.Item1;
-            uri.AbsolutePath.Should().Be("/_cat/nodes");
+            uri.AbsolutePath.Should().Be("/");
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using Elasticsearch.Net;`
	`2`	`+using Serilog.Sinks.Elasticsearch.Tests.Stubs;`
`2`	`3`	`using System.Text;`
`3`	`4`	`using Xunit;`
`4`	`5`
`@@ -18,7 +19,7 @@ public void Ctor_DetectElasticsearchVersionSetToTrue_SetsTypeName(string elastic`
`18`	`19`	`/* ARRANGE */`
`19`	`20`	`var options = new ElasticsearchSinkOptions`
`20`	`21`	`{`
`21`		`- Connection = FakeResponse(elasticVersion),`
	`22`	`+ Connection = FakeProductCheckResponse(elasticVersion),`
`22`	`23`	`TypeName = configuredTypeName`
`23`	`24`	`};`
`24`	`25`
`@@ -41,7 +42,7 @@ public void Ctor_DetectElasticsearchVersionSetToFalseAssumesVersion7_SetsTypeNam`
`41`	`42`	`/* ARRANGE */`
`42`	`43`	`var options = new ElasticsearchSinkOptions`
`43`	`44`	`{`
`44`		`- Connection = FakeResponse(elasticVersion),`
	`45`	`+ Connection = FakeProductCheckResponse(elasticVersion),`
`45`	`46`	`DetectElasticsearchVersion = false,`
`46`	`47`	`TypeName = configuredTypeName`
`47`	`48`	`};`
`@@ -65,7 +66,7 @@ public void CreateLogger_DetectElasticsearchVersionSetToTrue_SetsTypeName(string`
`65`	`66`	`/* ARRANGE */`
`66`	`67`	`var options = new ElasticsearchSinkOptions`
`67`	`68`	`{`
`68`		`- Connection = FakeResponse(elasticVersion),`
	`69`	`+ Connection = FakeProductCheckResponse(elasticVersion),`
`69`	`70`	`DetectElasticsearchVersion = true,`
`70`	`71`	`TypeName = configuredTypeName`
`71`	`72`	`};`
`@@ -83,10 +84,10 @@ public void CreateLogger_DetectElasticsearchVersionSetToTrue_SetsTypeName(string`
`83`	`84`	`Assert.Equal(expectedTypeName, options.TypeName);`
`84`	`85`	`}`
`85`	`86`
`86`		`- private static IConnection FakeResponse(string responseText)`
	`87`	`+ private static IConnection FakeProductCheckResponse(string responseText)`
`87`	`88`	`{`
`88`		`- byte[] responseBody = Encoding.UTF8.GetBytes(responseText);`
`89`		`- return new InMemoryConnection(responseBody, contentType: "text/plain; charset=UTF-8");`
	`89`	`+ var productCheckResponse = ConnectionStub.ModifiedProductCheckResponse(responseText);`
	`90`	`+ return new InMemoryConnection(productCheckResponse);`
`90`	`91`	`}`
`91`	`92`	`}`
`92`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public override TReturn Request<TReturn>(RequestData requestData)`
`53`	`53`	`$" to be productCheck pre-flight request");`
`54`	`54`
`55`	`55`	`_productCheckDone = true;`
`56`		`- return ReturnConnectionStatus<TReturn>(requestData); // root page returned`
	`56`	`+ return ReturnConnectionStatus<TReturn>(requestData); // hard-coded root page returned`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`byte[] responseBytes = Array.Empty<byte>();`
`@@ -66,6 +66,7 @@ public override TReturn Request<TReturn>(RequestData requestData)`
`66`	`66`
`67`	`67`	`int responseStatusCode = 200;`
`68`	`68`	`string contentType = null;`
	`69`	`+ InMemoryHttpResponse productCheckResponse = null;`
`69`	`70`
`70`	`71`	`switch (requestData.Method)`
`71`	`72`	`{`
`@@ -79,13 +80,10 @@ public override TReturn Request<TReturn>(RequestData requestData)`
`79`	`80`	`switch (requestData.Uri.PathAndQuery.ToLower())`
`80`	`81`	`{`
`81`	`82`	`case "/":`
`82`		`- // ReturnConnectionStatus(...) call at the bottom will return dummy product page`
`83`		`- // when root "/" is requested.`
	`83`	`+ productCheckResponse = ModifiedProductCheckResponse(_productVersion);`
`84`	`84`	`break;`
`85`		`- case "/_cat/nodes":`
`86`	`85`	`case "/_cat/nodes?h=v":`
`87`	`86`	`responseBytes = Encoding.UTF8.GetBytes(_productVersion);`
`88`		`- responseStatusCode = 200;`
`89`	`87`	`contentType = "text/plain; charset=UTF-8";`
`90`	`88`	`break;`
`91`	`89`	`}`
`@@ -100,12 +98,29 @@ public override TReturn Request<TReturn>(RequestData requestData)`
`100`	`98`	`break;`
`101`	`99`	`}`
`102`	`100`
`103`		`- return ReturnConnectionStatus<TReturn>(requestData, responseBytes, responseStatusCode, contentType);`
	`101`	`+ return ReturnConnectionStatus<TReturn>(requestData, productCheckResponse, responseBytes, responseStatusCode, contentType);`
`104`	`102`	`}`
`105`	`103`
`106`	`104`	`public override Task<TResponse> RequestAsync<TResponse>(RequestData requestData, CancellationToken cancellationToken)`
`107`	`105`	`{`
`108`	`106`	`return Task.FromResult(Request<TResponse>(requestData));`
`109`	`107`	`}`
	`108`	`+`
	`109`	`+ public static InMemoryHttpResponse ModifiedProductCheckResponse(string productVersion)`
	`110`	`+ {`
	`111`	`+ var productCheckResponse = ValidProductCheckResponse();`
	`112`	`+ if (productVersion is not null)`
	`113`	`+ {`
	`114`	`+ using var originalMemoryStream = new MemoryStream(productCheckResponse.ResponseBytes, false);`
	`115`	`+ {`
	`116`	`+ var json = LowLevelRequestResponseSerializer.Instance.Deserialize<dynamic>(originalMemoryStream);`
	`117`	`+ json["version"]["number"] = productVersion;`
	`118`	`+ using var modifiedMemoryStream = new MemoryStream();`
	`119`	`+ LowLevelRequestResponseSerializer.Instance.Serialize(json, modifiedMemoryStream);`
	`120`	`+ productCheckResponse.ResponseBytes = modifiedMemoryStream.ToArray();`
	`121`	`+ }`
	`122`	`+ }`
	`123`	`+ return productCheckResponse;`
	`124`	`+ }`
`110`	`125`	`}`
`111`	`126`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public DiscoverVersionTests()`
`34`	`34`	`public void TemplatePutToCorrectUrl()`
`35`	`35`	`{`
`36`	`36`	`var uri = _templateGet.Item1;`
`37`		`- uri.AbsolutePath.Should().Be("/_cat/nodes");`
	`37`	`+ uri.AbsolutePath.Should().Be("/");`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`	`}`