Support product name of ApiCallDetails

Author: stevejgordon

src/Elasticsearch.Net/Responses/ElasticsearchResponse.cs

@@ -6,6 +6,7 @@
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Net.NetworkInformation;
+using System.Text;
 using Elasticsearch.Net.Diagnostics;
 
 namespace Elasticsearch.Net
@@ -45,20 +46,31 @@ public ReadOnlyDictionary<string, ThreadPoolStatistics> ThreadPoolStats
 
 		/// <inheritdoc cref="IApiCallDetails.DeprecationWarnings"/>
 		public IEnumerable<string> DeprecationWarnings => ApiCall.DeprecationWarnings;
+
+		/// <inheritdoc cref="IApiCallDetails.ProductName"/>
+		public string ProductName => ApiCall.ProductName;
+
 		/// <inheritdoc cref="IApiCallDetails.SuccessOrKnownError"/>
 		public bool SuccessOrKnownError => ApiCall.SuccessOrKnownError;
+
 		/// <inheritdoc cref="IApiCallDetails.HttpStatusCode"/>
 		public int? HttpStatusCode => ApiCall.HttpStatusCode;
 
 		/// <inheritdoc cref="IApiCallDetails.Success"/>
 		public bool Success => ApiCall.Success;
+
 		/// <inheritdoc cref="IApiCallDetails.OriginalException"/>
 		public Exception OriginalException => ApiCall.OriginalException;
+
 		/// <inheritdoc cref="IApiCallDetails.ResponseMimeType"/>
 		public string ResponseMimeType => ApiCall.ResponseMimeType;
+
 		/// <inheritdoc cref="IApiCallDetails.Uri"/>
 		public Uri Uri => ApiCall.Uri;
 
+		/// <inheritdoc cref="IApiCallDetails.BuildDebugInformationPrefix"/>
+		public Action<StringBuilder> BuildDebugInformationPrefix => ApiCall.BuildDebugInformationPrefix;
+
 		/// <inheritdoc cref="IApiCallDetails.ConnectionConfiguration"/>
 		public IConnectionConfigurationValues ConnectionConfiguration => ApiCall.ConnectionConfiguration;
 

src/Elasticsearch.Net/Responses/HttpDetails/ApiCallDetails.cs

@@ -28,13 +28,15 @@ public string DebugInformation
 
 				var sb = new StringBuilder();
 				sb.AppendLine(ToString());
+
 				_debugInformation = ResponseStatics.DebugInformationBuilder(this, sb);
 
 				return _debugInformation;
 			}
 		}
 
 		public IEnumerable<string> DeprecationWarnings { get; set; }
+		public string ProductName { get; set; }
 		public HttpMethod HttpMethod { get; set; }
 		public int? HttpStatusCode { get; set; }
 		public Exception OriginalException { get; set; }
@@ -50,6 +52,8 @@ public string DebugInformation
 			&& HttpStatusCode != 502;
 
 		public Uri Uri { get; set; }
+		
+		public Action<StringBuilder> BuildDebugInformationPrefix { get; set; }
 
 		public IConnectionConfigurationValues ConnectionConfiguration { get; set; }
 

src/Elasticsearch.Net/Responses/HttpDetails/IApiCallDetails.cs

@@ -7,6 +7,7 @@
 using System.Collections.ObjectModel;
 using System.Diagnostics;
 using System.Net.NetworkInformation;
+using System.Text;
 using Elasticsearch.Net.Diagnostics;
 
 namespace Elasticsearch.Net
@@ -50,6 +51,11 @@ public interface IApiCallDetails
 		/// </summary>
 		IEnumerable<string> DeprecationWarnings { get; }
 
+		/// <summary>
+		/// The product name, if present in the 'X-elastic-product' response header.
+		/// </summary>
+		string ProductName { get; }
+
 		/// <summary>
 		/// The HTTP method used by the request
 		/// </summary>
@@ -98,5 +104,10 @@ public interface IApiCallDetails
 		/// The url as requested
 		/// </summary>
 		Uri Uri { get; }
+
+		/// <summary>
+		/// A delegate which may render a prefix to the debug information.
+		/// </summary>
+		Action<StringBuilder> BuildDebugInformationPrefix { get; }
 	}
 }

src/Elasticsearch.Net/Responses/ResponseStatics.cs

@@ -20,6 +20,8 @@ public static class ResponseStatics
 
 		public static string DebugInformationBuilder(IApiCallDetails r, StringBuilder sb)
 		{
+			r.BuildDebugInformationPrefix?.Invoke(sb);
+
 			if (r.DeprecationWarnings.HasAny())
 			{
 				sb.AppendLine($"# Server indicated deprecations:");
@@ -107,8 +109,10 @@ private static void AuditNodeUrl(StringBuilder sb, Audit audit)
 
 			if (!string.IsNullOrEmpty(uri.UserInfo))
 			{
-				var builder = new UriBuilder(uri);
-				builder.Password = "redacted";
+				var builder = new UriBuilder(uri)
+				{
+					Password = "redacted"
+				};
 				uri = builder.Uri;
 			}
 			sb.Append($" Node: {uri}");

src/Elasticsearch.Net/Transport/Pipeline/ResponseBuilder.cs

@@ -25,12 +25,13 @@ public static TResponse ToResponse<TResponse>(
 			int? statusCode,
 			IEnumerable<string> warnings,
 			Stream responseStream,
-			string mimeType = null
+			string mimeType = null,
+			string productName = null
 		)
 			where TResponse : class, IElasticsearchResponse, new()
 		{
 			responseStream.ThrowIfNull(nameof(responseStream));
-			var details = Initialize(requestData, ex, statusCode, warnings, mimeType);
+			var details = Initialize(requestData, ex, statusCode, warnings, mimeType, productName);
 			//TODO take ex and (responseStream == Stream.Null) into account might not need to flow to SetBody in that case
 			var response = SetBody<TResponse>(details, requestData, responseStream, mimeType) ?? new TResponse();
 			response.ApiCall = details;
@@ -44,21 +45,26 @@ public static async Task<TResponse> ToResponseAsync<TResponse>(
 			IEnumerable<string> warnings,
 			Stream responseStream,
 			string mimeType = null,
+			string productName = null,
 			CancellationToken cancellationToken = default
 		)
 			where TResponse : class, IElasticsearchResponse, new()
 		{
 			responseStream.ThrowIfNull(nameof(responseStream));
-			var details = Initialize(requestData, ex, statusCode, warnings, mimeType);
+			var details = Initialize(requestData, ex, statusCode, warnings, mimeType, productName);
 			var response = await SetBodyAsync<TResponse>(details, requestData, responseStream, mimeType, cancellationToken).ConfigureAwait(false)
 				?? new TResponse();
 			response.ApiCall = details;
 			return response;
 		}
 
 		private static ApiCallDetails Initialize(
-			RequestData requestData, Exception exception, int? statusCode, IEnumerable<string> warnings, string mimeType
-		)
+			RequestData requestData,
+			Exception exception,
+			int? statusCode,
+			IEnumerable<string> warnings,
+			string mimeType,
+			string productName)
 		{
 			var success = false;
 			var allowedStatusCodes = requestData.AllowedStatusCodes;
@@ -83,7 +89,8 @@ private static ApiCallDetails Initialize(
 				HttpMethod = requestData.Method,
 				DeprecationWarnings = warnings ?? Enumerable.Empty<string>(),
 				ResponseMimeType = mimeType,
-				ConnectionConfiguration = requestData.ConnectionSettings
+				ConnectionConfiguration = requestData.ConnectionSettings,
+				ProductName = productName
 			};
 			return details;
 		}
@@ -171,8 +178,10 @@ private static bool SetSpecialTypes<TResponse>(string mimeType, byte[] bytes, IM
 				//if not json store the result under "body"
 				if (!RequestData.IsJsonMimeType(mimeType))
 				{
-					var dictionary = new DynamicDictionary();
-					dictionary["body"] = new DynamicValue(bytes.Utf8String());
+					var dictionary = new DynamicDictionary
+					{
+						["body"] = new(bytes.Utf8String())
+					};
 					cs = new DynamicResponse(dictionary) as TResponse;
 				}
 				else