Add UserAgent to IRequestConfiguration (#140)

As titled.

Closes #137

Author: flobernd

src/Elastic.Transport/Components/Pipeline/RequestData.cs

@@ -39,7 +39,7 @@ public RequestData(ITransportConfiguration global, IRequestConfiguration? local
 		ProxyUsername = global.ProxyUsername;
 		ProxyPassword = global.ProxyPassword;
 		DisableAutomaticProxyDetection = global.DisableAutomaticProxyDetection;
-		UserAgent = global.UserAgent;
+		UserAgent = global.UserAgent ?? local?.UserAgent ?? RequestConfiguration.DefaultUserAgent;
 		KeepAliveInterval = (int)(global.KeepAliveInterval?.TotalMilliseconds ?? 2000);
 		KeepAliveTime = (int)(global.KeepAliveTime?.TotalMilliseconds ?? 2000);
 		RunAs = local?.RunAs ?? global.RunAs;
@@ -135,7 +135,7 @@ public RequestData(ITransportConfiguration global, IRequestConfiguration? local
 	public string? ProxyUsername { get; }
 	/// <inheritdoc cref="ITransportConfiguration.SkipDeserializationForStatusCodes"/>
 	public IReadOnlyCollection<int> SkipDeserializationForStatusCodes { get; }
-	/// <inheritdoc cref="ITransportConfiguration.UserAgent"/>
+	/// <inheritdoc cref="IRequestConfiguration.UserAgent"/>
 	public UserAgent UserAgent { get; }
 	/// <inheritdoc cref="ITransportConfiguration.DnsRefreshTimeout"/>
 	public TimeSpan DnsRefreshTimeout { get; }

src/Elastic.Transport/Configuration/IRequestConfiguration.cs

@@ -152,4 +152,10 @@ public interface IRequestConfiguration
 	/// Holds additional meta data about the request.
 	/// </summary>
 	RequestMetaData? RequestMetaData { get; }
+
+	/// <summary>
+	/// The user agent string to send with requests. Useful for debugging purposes to understand client and framework
+	/// versions that initiate requests to Elasticsearch
+	/// </summary>
+	UserAgent? UserAgent { get; }
 }

src/Elastic.Transport/Configuration/ITransportConfiguration.cs

@@ -170,12 +170,6 @@ public interface ITransportConfiguration : IRequestConfiguration, IDisposable
 	/// </summary>
 	UrlFormatter UrlFormatter { get; }
 
-	/// <summary>
-	/// The user agent string to send with requests. Useful for debugging purposes to understand client and framework
-	/// versions that initiate requests to Elasticsearch
-	/// </summary>
-	UserAgent UserAgent { get; }
-
 	/// <summary>
 	/// Allow you to override the status code inspection that sets <see cref="ApiCallDetails.HasSuccessfulStatusCode"/>
 	/// <para>

src/Elastic.Transport/Configuration/RequestConfiguration.cs

@@ -21,6 +21,9 @@ public record RequestConfiguration : IRequestConfiguration
 	/// <summary> The default ping timeout when the connection is over HTTPS. Defaults to 5 seconds </summary>
 	public static readonly TimeSpan DefaultPingTimeoutOnSsl = TimeSpan.FromSeconds(5);
 
+	/// <summary> The default user-agent.</summary>
+	public static readonly UserAgent DefaultUserAgent = UserAgent.Create("elastic-transport-net");
+
 	/// <inheritdoc cref="IRequestConfiguration"/>
 	public RequestConfiguration()
 	{
@@ -63,6 +66,7 @@ public RequestConfiguration(IRequestConfiguration config)
 		ParseAllHeaders = config.ParseAllHeaders;
 		RequestMetaData = config.RequestMetaData;
 		ResponseBuilders = config.ResponseBuilders;
+		UserAgent = config.UserAgent;
 	}
 
 	/// <inheritdoc />
@@ -145,4 +149,7 @@ public RequestConfiguration(IRequestConfiguration config)
 
 	/// <inheritdoc />
 	public RequestMetaData? RequestMetaData { get; init; }
+
+	/// <inheritdoc />
+	public UserAgent? UserAgent { get; init; }
 }

src/Elastic.Transport/Configuration/RequestConfigurationDescriptor.cs

@@ -54,6 +54,7 @@ public RequestConfigurationDescriptor(IRequestConfiguration config)
 		_parseAllHeaders = config.ParseAllHeaders;
 		_requestMetaData = config.RequestMetaData;
 		_responseBuilders = [.. config.ResponseBuilders];
+		_userAgent = config.UserAgent;
 	}
 
 	private string? _accept;
@@ -83,6 +84,7 @@ public RequestConfigurationDescriptor(IRequestConfiguration config)
 	private bool? _enableThreadPoolStats;
 	private RequestMetaData? _requestMetaData;
 	private List<IResponseBuilder>? _responseBuilders;
+	private UserAgent? _userAgent;
 
 	/// <inheritdoc cref="IRequestConfiguration.RunAs"/>
 	public RequestConfigurationDescriptor RunAs(string username)
@@ -289,6 +291,13 @@ public RequestConfigurationDescriptor ResponseBuilder(IResponseBuilder responseB
 		return this;
 	}
 
+	/// <inheritdoc cref="IRequestConfiguration.UserAgent" />
+	public RequestConfigurationDescriptor UserAgent(UserAgent userAgent)
+	{
+		_userAgent = userAgent;
+		return this;
+	}
+
 	string? IRequestConfiguration.Accept => _accept;
 
 	IReadOnlyCollection<int>? IRequestConfiguration.AllowedStatusCodes => _allowedStatusCodes;
@@ -342,4 +351,6 @@ public RequestConfigurationDescriptor ResponseBuilder(IResponseBuilder responseB
 	RequestMetaData? IRequestConfiguration.RequestMetaData => _requestMetaData;
 
 	IReadOnlyCollection<IResponseBuilder> IRequestConfiguration.ResponseBuilders => _responseBuilders ?? [];
+
+	UserAgent? IRequestConfiguration.UserAgent => _userAgent;
 }

src/Elastic.Transport/Configuration/TransportConfigurationDescriptor.cs

@@ -279,7 +279,7 @@ protected TransportConfigurationDescriptorBase(ITransportConfiguration config)
 	bool ITransportConfiguration.SniffsOnConnectionFault => _sniffsOnConnectionFault;
 	bool ITransportConfiguration.SniffsOnStartup => _sniffsOnStartup;
 	UrlFormatter ITransportConfiguration.UrlFormatter => _urlFormatter;
-	UserAgent ITransportConfiguration.UserAgent => _userAgent;
+	UserAgent IRequestConfiguration.UserAgent => _userAgent;
 	Func<HttpMethod, int, bool> ITransportConfiguration.StatusCodeToResponseSuccess => _statusCodeToResponseSuccess;
 	TimeSpan ITransportConfiguration.DnsRefreshTimeout => _dnsRefreshTimeout;
 	bool ITransportConfiguration.PrettyJson => _prettyJson;
@@ -513,7 +513,7 @@ public T ClientCertificate(string certificatePath) =>
 	public T SkipDeserializationForStatusCodes(params int[] statusCodes) =>
 		Assign(new ReadOnlyCollection<int>(statusCodes), static (a, v) => a._skipDeserializationForStatusCodes = v);
 
-	/// <inheritdoc cref="ITransportConfiguration.UserAgent"/>
+	/// <inheritdoc cref="IRequestConfiguration.UserAgent"/>
 	public T UserAgent(UserAgent userAgent) => Assign(userAgent, static (a, v) => a._userAgent = v);
 
 	/// <inheritdoc cref="IRequestConfiguration.TransferEncodingChunked"/>

src/Elastic.Transport/Configuration/UserAgent.cs

@@ -25,13 +25,13 @@ public sealed class UserAgent
 {
 	private readonly string _toString;
 
-	private UserAgent(string reposName, Type typeVersionLookup, string[] metadata = null)
+	private UserAgent(string reposName, Type typeVersionLookup, string[]? metadata = null)
 	{
 		var version = typeVersionLookup.Assembly
 			.GetCustomAttribute<AssemblyInformationalVersionAttribute>()
 			.InformationalVersion;
 
-		var meta = string.Join("; ", metadata ?? Array.Empty<string>());
+		var meta = string.Join("; ", metadata ?? []);
 		var assemblyName = typeVersionLookup.Assembly.GetName().Name;
 
 		_toString = $"{reposName}/{version} ({RuntimeInformation.OSDescription}; {RuntimeInformation.FrameworkDescription}; {assemblyName}{meta.Trim()})";