fix Elasticsearch.Net style violations and warnings

Mpdreamz · Mpdreamz · commit c6aec5dea697 · 2020-10-01T15:56:25.000+02:00
(cherry picked from commit 2698710)
diff --git a/.editorconfig b/.editorconfig
@@ -82,30 +82,30 @@ csharp_prefer_braces = false:warning
 csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:error
 
 # ---
-# formatting conventions https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#formatting-conventions
+# formatting conventions https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-formatting-conventions
 
 # Newline settings (Allman yo!)
-csharp_new_line_before_open_brace = all:error
-csharp_new_line_before_else = true:error
-csharp_new_line_before_catch = true:error
-csharp_new_line_before_finally = true:error
+csharp_new_line_before_open_brace = all
+csharp_new_line_before_else = true
+csharp_new_line_before_catch = true
+csharp_new_line_before_finally = true
 csharp_new_line_before_members_in_object_initializers = true
 # just a suggestion do to our JSON tests that use anonymous types to 
 # represent json quite a bit (makes copy paste easier).
-csharp_new_line_before_members_in_anonymous_types = true:suggestion
-csharp_new_line_between_query_expression_clauses = true:error
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_between_query_expression_clauses = true
 
 # Indent
-csharp_indent_case_contents = true:error
-csharp_indent_switch_labels = true:error
-csharp_space_after_cast = false:error
-csharp_space_after_keywords_in_control_flow_statements = true:error
-csharp_space_between_method_declaration_parameter_list_parentheses = false:error
-csharp_space_between_method_call_parameter_list_parentheses = false:error
+csharp_indent_case_contents = true
+csharp_indent_switch_labels = true
+csharp_space_after_cast = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_method_call_parameter_list_parentheses = false
 
 #Wrap
-csharp_preserve_single_line_statements = false:error
-csharp_preserve_single_line_blocks = true:error
+csharp_preserve_single_line_statements = false
+csharp_preserve_single_line_blocks = true
 
 # Resharper
 resharper_csharp_braces_for_lock=required_for_complex
@@ -118,6 +118,5 @@ resharper_csharp_braces_for_ifelse=required_for_complex
 
 resharper_csharp_accessor_owner_body=expression_body
 
-
 resharper_redundant_case_label_highlighting=do_not_show
-
+resharper_redundant_argument_default_value_highlighting=do_not_show
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -35,6 +35,7 @@
 
     <DefineConstants Condition="'$(TargetFramework)'=='net461' or '$(TargetFramework)'=='net472'">$(DefineConstants);FULLFRAMEWORK</DefineConstants>
     <DefineConstants Condition="$(DefineConstants.Contains(FULLFRAMEWORK)) == False">$(DefineConstants);DOTNETCORE</DefineConstants>
+    <DefineConstants Condition="$(DefineConstants.Contains(FULLFRAMEWORK)) == False and '$(TargetFramework)'!='netstandard2.0'">$(DefineConstants);DOTNETCORE_2_1_OR_HIGHER</DefineConstants>
 
     <ExposedPublicKey>002400000480000094000000060200000024000052534131000400000100010025d3a22bf3781ba85067374ad832dfcba3c4fa8dd89227e36121ba17b2c33ad6b6ce03e45e562050a031e2ff7fe12cff9060a50acbc6a0eef9ef32dc258d90f874b2e76b581938071ccc4b4d98204d1d6ca7a1988d7a211f9fc98efd808cf85f61675b11007d0eb0461dc86a968d6af8ebba7e6b540303b54f1c1f5325c252be</ExposedPublicKey>
   </PropertyGroup>
diff --git a/src/Elasticsearch.Net/Api/NativeMethods.cs b/src/Elasticsearch.Net/Api/NativeMethods.cs
@@ -19,13 +19,15 @@ internal static string RtlGetVersion()
 			{
 				var osvi = new RTL_OSVERSIONINFOEX();
 				osvi.dwOSVersionInfoSize = (uint)Marshal.SizeOf(osvi);
-				if (RtlGetVersion(out osvi) == 0)
-					return $"Microsoft Windows {osvi.dwMajorVersion}.{osvi.dwMinorVersion}.{osvi.dwBuildNumber}";
-
-				return null;
+				return RtlGetVersion(out osvi) == 0
+					? $"Microsoft Windows {osvi.dwMajorVersion}.{osvi.dwMinorVersion}.{osvi.dwBuildNumber}"
+					: null;
 			}
 
 			[StructLayout(LayoutKind.Sequential)]
+			// ReSharper disable once MemberCanBePrivate.Global
+			// ReSharper disable InconsistentNaming
+			// ReSharper disable FieldCanBeMadeReadOnly.Global
 			internal struct RTL_OSVERSIONINFOEX
 			{
 				internal uint dwOSVersionInfoSize;
@@ -37,6 +39,8 @@ internal struct RTL_OSVERSIONINFOEX
 				[MarshalAs(UnmanagedType.ByValTStr, SizeConst = 128)]
 				internal string szCSDVersion;
 			}
+			// ReSharper restore InconsistentNaming
+			// ReSharper restore FieldCanBeMadeReadOnly.Global
 		}
 	}
 }
diff --git a/src/Elasticsearch.Net/Configuration/ConnectionConfiguration.cs b/src/Elasticsearch.Net/Configuration/ConnectionConfiguration.cs
@@ -202,6 +202,8 @@ public abstract class ConnectionConfiguration<T> : IConnectionConfigurationValue
 		private bool _transferEncodingChunked;
 		private IMemoryStreamFactory _memoryStreamFactory = RecyclableMemoryStreamFactory.Default;
 		private bool _enableTcpStats;
+		//public static IMemoryStreamFactory Default { get; } = RecyclableMemoryStreamFactory.Default;
+		public static IMemoryStreamFactory DefaultMemoryStreamFactory { get; } = Elasticsearch.Net.MemoryStreamFactory.Default;
 		private bool _enableThreadPoolStats;
 
 		private string _userAgent = ConnectionConfiguration.DefaultUserAgent;
diff --git a/src/Elasticsearch.Net/Connection/Content/RequestDataContent.cs b/src/Elasticsearch.Net/Connection/Content/RequestDataContent.cs
@@ -155,10 +155,7 @@ public override int WriteTimeout
 
 			protected override void Dispose(bool disposing)
 			{
-				if (disposing)
-				{
-					_innerStream.Dispose();
-				}
+				if (disposing) _innerStream.Dispose();
 				base.Dispose(disposing);
 			}
 
diff --git a/src/Elasticsearch.Net/Connection/HandlerTracking/RequestDataHttpClientFactory.cs b/src/Elasticsearch.Net/Connection/HandlerTracking/RequestDataHttpClientFactory.cs
@@ -5,13 +5,9 @@
 #if DOTNETCORE
 using System;
 using System.Collections.Concurrent;
-using System.Collections.Generic;
 using System.Diagnostics;
-using System.Linq;
 using System.Net.Http;
 using System.Threading;
-using System.Xml;
-using Elasticsearch.Net;
 
 namespace Elasticsearch.Net
 {
@@ -129,6 +125,7 @@ private void ExpiryTimer_Tick(object state)
 			if (removed)
 				Interlocked.Increment(ref _removedHandlers);
 			Debug.Assert(removed, "Entry not found. We should always be able to remove the entry");
+			// ReSharper disable once RedundantNameQualifier
 			Debug.Assert(object.ReferenceEquals(active, found.Value), "Different entry found. The entry should not have been replaced");
 
 			// At this point the handler is no longer 'active' and will not be handed out to any new clients.
@@ -205,12 +202,10 @@ private void CleanupTimer_Tick()
 							// ignored (ignored in HttpClientFactory too)
 						}
 					}
+					// If the entry is still live, put it back in the queue so we can process it
+					// during the next cleanup cycle.
 					else
-					{
-						// If the entry is still live, put it back in the queue so we can process it
-						// during the next cleanup cycle.
 						_expiredHandlers.Enqueue(entry);
-					}
 				}
 			}
 			finally
diff --git a/src/Elasticsearch.Net/Connection/HandlerTracking/ValueStopWatch.cs b/src/Elasticsearch.Net/Connection/HandlerTracking/ValueStopWatch.cs
@@ -4,7 +4,6 @@
 
 #if DOTNETCORE
 using System;
-using System.Diagnostics;
 using System.Threading;
 
 namespace Elasticsearch.Net
diff --git a/src/Elasticsearch.Net/Connection/HttpConnection.cs b/src/Elasticsearch.Net/Connection/HttpConnection.cs
@@ -4,7 +4,6 @@
 
 #if DOTNETCORE
 using System;
-using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Diagnostics;
@@ -63,7 +62,7 @@ public virtual TResponse Request<TResponse>(RequestData requestData)
 			where TResponse : class, IElasticsearchResponse, new()
 		{
 			var client = GetClient(requestData);
-			HttpResponseMessage responseMessage = null;
+			HttpResponseMessage responseMessage;
 			int? statusCode = null;
 			IEnumerable<string> warnings = null;
 			Stream responseStream = null;
@@ -130,7 +129,7 @@ public virtual async Task<TResponse> RequestAsync<TResponse>(RequestData request
 			where TResponse : class, IElasticsearchResponse, new()
 		{
 			var client = GetClient(requestData);
-			HttpResponseMessage responseMessage = null;
+			HttpResponseMessage responseMessage;
 			int? statusCode = null;
 			IEnumerable<string> warnings = null;
 			Stream responseStream = null;
@@ -261,7 +260,7 @@ protected virtual void SetAuthenticationIfNeeded(HttpRequestMessage requestMessa
 				var header = AuthenticationHeaderValue.Parse(requestData.Headers["Authorization"]);
 				requestMessage.Headers.Authorization = header;
 				return;
-			};
+			}
 
 			// Api Key authentication takes precedence
 			var apiKeySet = SetApiKeyAuthenticationIfNeeded(requestMessage, requestData);
@@ -339,9 +338,7 @@ protected virtual HttpRequestMessage CreateRequestMessage(RequestData requestDat
 		private static void SetContent(HttpRequestMessage message, RequestData requestData)
 		{
 			if (requestData.TransferEncodingChunked)
-			{
 				message.Content = new RequestDataContent(requestData);
-			}
 			else
 			{
 				var stream = requestData.MemoryStreamFactory.Create();
@@ -373,9 +370,7 @@ private static void SetContent(HttpRequestMessage message, RequestData requestDa
 		private static async Task SetContentAsync(HttpRequestMessage message, RequestData requestData, CancellationToken cancellationToken)
 		{
 			if (requestData.TransferEncodingChunked)
-			{
 				message.Content = new RequestDataContent(requestData, cancellationToken);
-			}
 			else
 			{
 				var stream = requestData.MemoryStreamFactory.Create();
@@ -389,7 +384,12 @@ private static async Task SetContentAsync(HttpRequestMessage message, RequestDat
 				if (requestData.PostData.DisableDirectStreaming.GetValueOrDefault(false) && !requestData.HttpCompression)
 				{
 					message.Content = new ByteArrayContent(requestData.PostData.WrittenBytes);
-					stream.Dispose();
+#if DOTNETCORE_2_1_OR_HIGHER
+						await stream.DisposeAsync().ConfigureAwait(false);
+
+#else
+						stream.Dispose();
+#endif
 				}
 				else
 				{
diff --git a/src/Elasticsearch.Net/Connection/HttpWebRequestConnection.cs b/src/Elasticsearch.Net/Connection/HttpWebRequestConnection.cs
@@ -118,7 +118,7 @@ CancellationToken cancellationToken
 					if (data != null)
 					{
 						var apmGetRequestStreamTask =
-							Task.Factory.FromAsync<Stream>(request.BeginGetRequestStream, r => request.EndGetRequestStream(r), null);
+							Task.Factory.FromAsync(request.BeginGetRequestStream, r => request.EndGetRequestStream(r), null);
 						unregisterWaitHandle = RegisterApmTaskTimeout(apmGetRequestStreamTask, request, requestData);
 
 						using (var stream = await apmGetRequestStreamTask.ConfigureAwait(false))
diff --git a/src/Elasticsearch.Net/ConnectionPool/CloudConnectionPool.cs b/src/Elasticsearch.Net/ConnectionPool/CloudConnectionPool.cs
@@ -5,7 +5,7 @@
 using System;
 using System.Text;
 
-namespace Elasticsearch.Net 
+namespace Elasticsearch.Net
 {
 	/// <summary>
 	/// An <see cref="IConnectionPool"/> implementation that can be seeded with a cloud id
@@ -64,8 +64,9 @@ private CloudConnectionPool(ParsedCloudId parsedCloudId, IDateTimeProvider dateT
 			ClusterName = parsedCloudId.Name;
 
 		//TODO implement debugger display for IConnectionPool implementations and display it there and its ToString()
+		// ReSharper disable once UnusedAutoPropertyAccessor.Local
 		private string ClusterName { get; }
-		
+
 		public BasicAuthenticationCredentials BasicCredentials { get; }
 
 		public ApiKeyAuthenticationCredentials ApiKeyCredentials { get; }
@@ -101,11 +102,11 @@ private static ParsedCloudId ParseCloudId(string cloudId)
 			var parts = decoded.Split(new[] { '$' });
 			if (parts.Length < 2)
 				throw new ArgumentException($"Parameter {nameof(cloudId)} decoded base_64_data contains less then 2 tokens, {exceptionSuffix}", nameof(cloudId));
-			
+
 			var domainName = parts[0].Trim();
 			if (string.IsNullOrWhiteSpace(domainName))
 				throw new ArgumentException($"Parameter {nameof(cloudId)} decoded base_64_data contains no domain name, {exceptionSuffix}", nameof(cloudId));
-			
+
 			var elasticsearchUuid = parts[1].Trim();
 			if (string.IsNullOrWhiteSpace(elasticsearchUuid))
 				throw new ArgumentException($"Parameter {nameof(cloudId)} decoded base_64_data contains no elasticsearch UUID, {exceptionSuffix}", nameof(cloudId));
diff --git a/src/Elasticsearch.Net/ConnectionPool/SingleNodeConnectionPool.cs b/src/Elasticsearch.Net/ConnectionPool/SingleNodeConnectionPool.cs
@@ -1,7 +1,7 @@
-// Licensed to Elasticsearch B.V under one or more agreements.
-// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-// See the LICENSE file in the project root for more information
-
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
 using System;
 using System.Collections.Generic;
 
@@ -10,7 +10,6 @@ namespace Elasticsearch.Net
 	/// <summary> A connection pool to a single node or endpoint </summary>
 	public class SingleNodeConnectionPool : IConnectionPool
 	{
-		/// <inheritdoc />
 		public SingleNodeConnectionPool(Uri uri, IDateTimeProvider dateTimeProvider = null)
 		{
 			var node = new Node(uri);
diff --git a/src/Elasticsearch.Net/ConnectionPool/SniffingConnectionPool.cs b/src/Elasticsearch.Net/ConnectionPool/SniffingConnectionPool.cs
@@ -51,12 +51,12 @@ public override IReadOnlyCollection<Node> Nodes
 		/// <inheritdoc />
 		public override void Reseed(IEnumerable<Node> nodes)
 		{
-			if (!nodes.HasAny()) return;
+			if (!nodes.HasAny(out var nodesArray)) return;
 
 			try
 			{
 				_readerWriter.EnterWriteLock();
-				var sortedNodes = SortNodes(nodes)
+				var sortedNodes = SortNodes(nodesArray)
 					.DistinctBy(n => n.Uri)
 					.ToList();
 
diff --git a/src/Elasticsearch.Net/ElasticLowLevelClient.cs b/src/Elasticsearch.Net/ElasticLowLevelClient.cs
@@ -13,6 +13,7 @@ namespace Elasticsearch.Net
 	/// <summary>
 	/// Low level client that exposes all of Elasticsearch API endpoints but leaves you in charge of building request and handling the response
 	/// </summary>
+	// ReSharper disable once RedundantExtendsListEntry
 	public partial class ElasticLowLevelClient : IElasticLowLevelClient
 	{
 		/// <summary>Instantiate a new low level Elasticsearch client to http://localhost:9200</summary>
diff --git a/src/Elasticsearch.Net/Exceptions/ElasticsearchClientException.cs b/src/Elasticsearch.Net/Exceptions/ElasticsearchClientException.cs
@@ -51,11 +51,9 @@ public string DebugInformation
 							.AppendLine(" on an empty node, likely a node predicate on ConnectionSettings not matching ANY nodes");
 				}
 				else if (Response != null)
-				{
 					sb.Append(Response.HttpMethod.GetStringValue())
 						.Append(" on ")
 						.AppendLine(Response.Uri.ToString());
-				}
 				else
 					sb.AppendLine("a request");
 
@@ -68,11 +66,9 @@ public string DebugInformation
 				}
 
 				if (InnerException != null)
-				{
 					sb.Append("# Inner Exception: ")
 						.AppendLine(InnerException.Message)
 						.AppendLine(InnerException.ToString());
-				}
 
 				sb.AppendLine("# Exception:")
 					.AppendLine(ToString());
diff --git a/src/Elasticsearch.Net/Extensions/UtilExtensions.cs b/src/Elasticsearch.Net/Extensions/UtilExtensions.cs
@@ -1,7 +1,7 @@
-// Licensed to Elasticsearch B.V under one or more agreements.
-// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-// See the LICENSE file in the project root for more information
-
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
 using System;
 using System.Collections.Generic;
 using System.Globalization;
@@ -36,13 +36,20 @@ internal static string Utf8String(this MemoryStream ms)
 
 		internal static void ThrowIfEmpty<T>(this IEnumerable<T> @object, string parameterName)
 		{
-			@object.ThrowIfNull(parameterName);
-			if (!@object.Any())
+			var enumerated = @object == null ? null : (@object as T[] ?? @object.ToArray());
+			enumerated.ThrowIfNull(parameterName);
+			if (!enumerated!.Any())
 				throw new ArgumentException("Argument can not be an empty collection", parameterName);
 		}
 
 		internal static bool HasAny<T>(this IEnumerable<T> list) => list != null && list.Any();
 
+		internal static bool HasAny<T>(this IEnumerable<T> list, out T[] enumerated)
+		{
+			enumerated = list == null ? null : (list as T[] ?? list.ToArray());
+			return enumerated.HasAny();
+		}
+
 		internal static Exception AsAggregateOrFirst(this IEnumerable<Exception> exceptions)
 		{
 			var es = exceptions as Exception[] ?? exceptions?.ToArray();
@@ -66,7 +73,7 @@ internal static string ToTimeUnit(this TimeSpan timeSpan)
 		{
 			var ms = timeSpan.TotalMilliseconds;
 			string interval;
-			double factor = 0;
+			double factor;
 
 			if (ms >= MillisecondsInAWeek)
 			{
diff --git a/src/Elasticsearch.Net/Providers/RecyclableMemoryStream.cs b/src/Elasticsearch.Net/Providers/RecyclableMemoryStream.cs
diff --git a/src/Elasticsearch.Net/Providers/RecyclableMemoryStreamManager-Events.cs b/src/Elasticsearch.Net/Providers/RecyclableMemoryStreamManager-Events.cs
diff --git a/src/Elasticsearch.Net/Providers/RecyclableMemoryStreamManager.cs b/src/Elasticsearch.Net/Providers/RecyclableMemoryStreamManager.cs
diff --git a/src/Elasticsearch.Net/Responses/ResponseStatics.cs b/src/Elasticsearch.Net/Responses/ResponseStatics.cs
diff --git a/src/Elasticsearch.Net/Serialization/DiagnosticsSerializerProxy.cs b/src/Elasticsearch.Net/Serialization/DiagnosticsSerializerProxy.cs
diff --git a/src/Elasticsearch.Net/Transport/Pipeline/RequestData.cs b/src/Elasticsearch.Net/Transport/Pipeline/RequestData.cs
diff --git a/src/Elasticsearch.Net/Transport/Transport.cs b/src/Elasticsearch.Net/Transport/Transport.cs

Original file line number	Diff line number	Diff line change
`@@ -19,13 +19,15 @@ internal static string RtlGetVersion()`
`19`	`19`	`{`
`20`	`20`	`var osvi = new RTL_OSVERSIONINFOEX();`
`21`	`21`	`osvi.dwOSVersionInfoSize = (uint)Marshal.SizeOf(osvi);`
`22`		`- if (RtlGetVersion(out osvi) == 0)`
`23`		`- return $"Microsoft Windows {osvi.dwMajorVersion}.{osvi.dwMinorVersion}.{osvi.dwBuildNumber}";`
`24`		`-`
`25`		`- return null;`
	`22`	`+ return RtlGetVersion(out osvi) == 0`
	`23`	`+ ? $"Microsoft Windows {osvi.dwMajorVersion}.{osvi.dwMinorVersion}.{osvi.dwBuildNumber}"`
	`24`	`+ : null;`
`26`	`25`	`}`
`27`	`26`
`28`	`27`	`[StructLayout(LayoutKind.Sequential)]`
	`28`	`+ // ReSharper disable once MemberCanBePrivate.Global`
	`29`	`+ // ReSharper disable InconsistentNaming`
	`30`	`+ // ReSharper disable FieldCanBeMadeReadOnly.Global`
`29`	`31`	`internal struct RTL_OSVERSIONINFOEX`
`30`	`32`	`{`
`31`	`33`	`internal uint dwOSVersionInfoSize;`
`@@ -37,6 +39,8 @@ internal struct RTL_OSVERSIONINFOEX`
`37`	`39`	`[MarshalAs(UnmanagedType.ByValTStr, SizeConst = 128)]`
`38`	`40`	`internal string szCSDVersion;`
`39`	`41`	`}`
	`42`	`+ // ReSharper restore InconsistentNaming`
	`43`	`+ // ReSharper restore FieldCanBeMadeReadOnly.Global`
`40`	`44`	`}`
`41`	`45`	`}`
`42`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -155,10 +155,7 @@ public override int WriteTimeout`
`155`	`155`
`156`	`156`	`protected override void Dispose(bool disposing)`
`157`	`157`	`{`
`158`		`- if (disposing)`
`159`		`- {`
`160`		`- _innerStream.Dispose();`
`161`		`- }`
	`158`	`+ if (disposing) _innerStream.Dispose();`
`162`	`159`	`base.Dispose(disposing);`
`163`	`160`	`}`
`164`	`161`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ CancellationToken cancellationToken`
`118`	`118`	`if (data != null)`
`119`	`119`	`{`
`120`	`120`	`var apmGetRequestStreamTask =`
`121`		`- Task.Factory.FromAsync<Stream>(request.BeginGetRequestStream, r => request.EndGetRequestStream(r), null);`
	`121`	`+ Task.Factory.FromAsync(request.BeginGetRequestStream, r => request.EndGetRequestStream(r), null);`
`122`	`122`	`unregisterWaitHandle = RegisterApmTaskTimeout(apmGetRequestStreamTask, request, requestData);`
`123`	`123`
`124`	`124`	`using (var stream = await apmGetRequestStreamTask.ConfigureAwait(false))`