Add AOT support to Elastic.Transport.

Promote ApiKey as default implementation (also documentated default as part of client bootstrapping instruction on serverless).

Make it easier to bootstrap a transport/cloudnodepool using a cloud endpoint an authentication method. No need to externally construct a cloud id.

Author: Mpdreamz

Playground/Playground.csproj

@@ -5,6 +5,7 @@
     <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+    <PublishAot>true</PublishAot>
   </PropertyGroup>
 
   <ItemGroup>

Playground/Program.cs

@@ -2,8 +2,27 @@
 // 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 Elastic.Transport;
 using Elastic.Transport.Products.Elasticsearch;
+using HttpMethod = Elastic.Transport.HttpMethod;
 
 var registration = new ElasticsearchProductRegistration(typeof(Elastic.Clients.Elasticsearch.ElasticsearchClient));
 
+var apiKey = Environment.GetEnvironmentVariable("ELASTIC_API_KEY") ?? throw new Exception();
+var url = Environment.GetEnvironmentVariable("ELASTIC_URL") ?? throw new Exception();
+
+var configuration = new TransportConfiguration(new Uri(url), new ApiKey(apiKey), ElasticsearchProductRegistration.Default)
+{
+	DebugMode = true
+};
+var transport = new DistributedTransport(configuration);
+
+var response = transport.Request<EsResponse>(HttpMethod.GET, "/does-not-exist");
+Console.WriteLine(response.DebugInformation);
+
+var dynamicResponse = transport.Request<DynamicResponse>(HttpMethod.GET, "/");
+Console.WriteLine(dynamicResponse.Body.Get<string>("version.build_flavor"));
+
 Console.WriteLine(registration.DefaultContentType ?? "NOT SPECIFIED");
+
+public class EsResponse : ElasticsearchResponse;

src/Elastic.Transport/Components/NodePool/CloudNodePool.cs

@@ -16,6 +16,8 @@ namespace Elastic.Transport;
 /// </summary>
 public sealed class CloudNodePool : SingleNodePool
 {
+	private readonly record struct ParsedCloudId(string ClusterName, Uri Uri);
+
 	/// <summary>
 	/// An <see cref="NodePool"/> implementation that can be seeded with a cloud id
 	/// and will signal the right defaults for the client to use for Elastic Cloud to <see cref="ITransportConfiguration"/>.
@@ -39,8 +41,17 @@ public sealed class CloudNodePool : SingleNodePool
 	public CloudNodePool(string cloudId, AuthorizationHeader credentials) : this(ParseCloudId(cloudId)) =>
 		AuthenticationHeader  = credentials;
 
+	/// <summary>
+	/// An <see cref="NodePool"/> implementation that can be seeded with a cloud enpoint
+	/// and will signal the right defaults for the client to use for Elastic Cloud to <see cref="ITransportConfiguration"/>.
+	/// </summary>
+	/// <param name="cloudEndpoint">Elastic Cloud endpoint</param>
+	/// <param name="credentials">The credentials to use with cloud</param>
+	public CloudNodePool(Uri cloudEndpoint, AuthorizationHeader credentials) : this(CreateCloudId(cloudEndpoint)) =>
+		AuthenticationHeader  = credentials;
+
 	private CloudNodePool(ParsedCloudId parsedCloudId) : base(parsedCloudId.Uri) =>
-		ClusterName = parsedCloudId.Name;
+		ClusterName = parsedCloudId.ClusterName;
 
 	//TODO implement debugger display for NodePool implementations and display it there and its ToString()
 	// ReSharper disable once UnusedAutoPropertyAccessor.Local
@@ -49,16 +60,13 @@ private CloudNodePool(ParsedCloudId parsedCloudId) : base(parsedCloudId.Uri) =>
 	/// <inheritdoc cref="AuthorizationHeader"/>
 	public AuthorizationHeader AuthenticationHeader { get; }
 
-	private readonly struct ParsedCloudId
+	private static ParsedCloudId CreateCloudId(Uri uri)
 	{
-		public ParsedCloudId(string clusterName, Uri uri)
-		{
-			Name = clusterName;
-			Uri = uri;
-		}
-
-		public string Name { get; }
-		public Uri Uri { get; }
+		var moniker = $"{uri.Host}${Guid.NewGuid():N}";
+		var base64 = Convert.ToBase64String(Encoding.UTF8.GetBytes(moniker));
+		var cloudId = $"name:{base64}";
+		return new ParsedCloudId(cloudId, uri);
+
 	}
 
 	private static ParsedCloudId ParseCloudId(string cloudId)

src/Elastic.Transport/Components/Serialization/LowLevelRequestResponseSerializer.cs

@@ -5,6 +5,8 @@
 using System.Collections.Generic;
 using System.Text.Json;
 using System.Text.Json.Serialization;
+using System.Text.Json.Serialization.Metadata;
+using Elastic.Transport.Products.Elasticsearch;
 
 namespace Elastic.Transport;
 
@@ -32,6 +34,10 @@ public LowLevelRequestResponseSerializer(IReadOnlyCollection<JsonConverter>? con
 			new ErrorCauseConverter(),
 			new ErrorConverter(),
 			new DynamicDictionaryConverter()
-		], converters, options => { options.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull; })) { }
+		], converters, options =>
+		{
+			options.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull;
+			options.TypeInfoResolver = JsonTypeInfoResolver.Combine(new DefaultJsonTypeInfoResolver(), ErrorSerializerContext.Default);
+		})) { }
 
 }

src/Elastic.Transport/Configuration/Security/ApiKey.cs

@@ -7,7 +7,7 @@ namespace Elastic.Transport;
 /// <summary>
 /// Credentials for Api Key Authentication
 /// </summary>
-public sealed class ApiKey : AuthorizationHeader
+public class ApiKey : AuthorizationHeader
 {
 	private readonly string _apiKey;
 

src/Elastic.Transport/Configuration/Security/Base64ApiKey.cs

@@ -10,25 +10,12 @@ namespace Elastic.Transport;
 /// <summary>
 /// Credentials for Api Key Authentication
 /// </summary>
-public sealed class Base64ApiKey : AuthorizationHeader
+public class Base64ApiKey : ApiKey
 {
-	private readonly string _base64String;
-
 	/// <inheritdoc cref="Base64ApiKey"/>
-	public Base64ApiKey(string id, string apiKey) =>
-		_base64String = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{id}:{apiKey}"));
+	public Base64ApiKey(string id, string apiKey) :
+		base(Convert.ToBase64String(Encoding.UTF8.GetBytes($"{id}:{apiKey}"))) {}
 
 	/// <inheritdoc cref="Base64ApiKey"/>
-	public Base64ApiKey(string base64EncodedApiKey) =>
-		_base64String = base64EncodedApiKey;
-
-	/// <inheritdoc cref="AuthorizationHeader.AuthScheme"/>
-	public override string AuthScheme { get; } = "ApiKey";
-
-	/// <inheritdoc cref="AuthorizationHeader.TryGetAuthorizationParameters(out string)"/>
-	public override bool TryGetAuthorizationParameters(out string value)
-	{
-		value = _base64String;
-		return true;
-	}
+	public Base64ApiKey(string base64EncodedApiKey) : base(base64EncodedApiKey) {}
 }

src/Elastic.Transport/Configuration/TransportConfiguration.cs

@@ -54,23 +54,31 @@ public record TransportConfiguration : ITransportConfiguration
 	/// </summary>
 	/// <param name="uri">The root of the Elastic stack product node we want to connect to. Defaults to http://localhost:9200</param>
 	/// <param name="productRegistration"><inheritdoc cref="ProductRegistration" path="/summary"/></param>
-	public TransportConfiguration(Uri uri = null, ProductRegistration productRegistration = null)
+	public TransportConfiguration(Uri? uri = null, ProductRegistration? productRegistration = null)
 		: this(new SingleNodePool(uri ?? new Uri("http://localhost:9200")), productRegistration: productRegistration) { }
 
 	/// <summary>
 	/// Sets up the client to communicate to Elastic Cloud using <paramref name="cloudId"/>,
 	/// <para><see cref="CloudNodePool"/> documentation for more information on how to obtain your Cloud Id</para>
 	/// </summary>
-	public TransportConfiguration(string cloudId, BasicAuthentication credentials, ProductRegistration productRegistration = null)
+	public TransportConfiguration(string cloudId, BasicAuthentication credentials, ProductRegistration? productRegistration = null)
 		: this(new CloudNodePool(cloudId, credentials), productRegistration: productRegistration) { }
 
 	/// <summary>
 	/// Sets up the client to communicate to Elastic Cloud using <paramref name="cloudId"/>,
 	/// <para><see cref="CloudNodePool"/> documentation for more information on how to obtain your Cloud Id</para>
 	/// </summary>
-	public TransportConfiguration(string cloudId, Base64ApiKey credentials, ProductRegistration productRegistration = null)
+	public TransportConfiguration(string cloudId, ApiKey credentials, ProductRegistration? productRegistration = null)
 		: this(new CloudNodePool(cloudId, credentials), productRegistration: productRegistration) { }
 
+	/// <summary> Sets up the client to communicate to Elastic Cloud.</summary>
+	public TransportConfiguration(Uri cloudEndpoint, BasicAuthentication credentials, ProductRegistration? productRegistration = null)
+		: this(new CloudNodePool(cloudEndpoint, credentials), productRegistration: productRegistration) { }
+
+	/// <summary> Sets up the client to communicate to Elastic Cloud. </summary>
+	public TransportConfiguration(Uri cloudEndpoint, ApiKey credentials, ProductRegistration? productRegistration = null)
+		: this(new CloudNodePool(cloudEndpoint, credentials), productRegistration: productRegistration) { }
+
 	/// <summary> <inheritdoc cref="TransportConfigurationDescriptor" path="/summary"/></summary>
 	/// <param name="nodePool"><inheritdoc cref="NodePool" path="/summary"/></param>
 	/// <param name="requestInvoker"><inheritdoc cref="IRequestInvoker" path="/summary"/></param>

src/Elastic.Transport/Configuration/TransportConfigurationDescriptor.cs

@@ -51,7 +51,7 @@ public TransportConfigurationDescriptor(string cloudId, BasicAuthentication cred
 	/// Sets up the client to communicate to Elastic Cloud using <paramref name="cloudId"/>,
 	/// <para><see cref="CloudNodePool"/> documentation for more information on how to obtain your Cloud Id</para>
 	/// </summary>
-	public TransportConfigurationDescriptor(string cloudId, Base64ApiKey credentials, ProductRegistration? productRegistration = null)
+	public TransportConfigurationDescriptor(string cloudId, ApiKey credentials, ProductRegistration? productRegistration = null)
 		: this(new CloudNodePool(cloudId, credentials), productRegistration: productRegistration) { }
 
 	/// <summary>

src/Elastic.Transport/DistributedTransport.cs

@@ -19,15 +19,12 @@
 
 namespace Elastic.Transport;
 
-/// <inheritdoc cref="ITransport{TConfiguration}" />
 /// <summary>
 /// Transport coordinates the client requests over the node pool nodes and is in charge of falling over on
 /// different nodes
 /// </summary>
 /// <param name="configuration">The configuration to use for this transport</param>
-public sealed class DistributedTransport(ITransportConfiguration configuration) : DistributedTransport<ITransportConfiguration>(configuration)
-{
-}
+public sealed class DistributedTransport(ITransportConfiguration configuration) : DistributedTransport<ITransportConfiguration>(configuration);
 
 /// <summary>
 /// Transport coordinates the client requests over the node pool nodes and is in charge of falling over on

src/Elastic.Transport/Products/Elasticsearch/ErrorSerializationContext.cs

@@ -2,7 +2,6 @@
 // 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.Text.Json;
 using System.Text.Json.Serialization;
 using System.Text.Json.Serialization.Metadata;
 
@@ -13,4 +12,5 @@ namespace Elastic.Transport.Products.Elasticsearch;
 [JsonSerializable(typeof(ErrorCause))]
 [JsonSerializable(typeof(ElasticsearchServerError))]
 [JsonSerializable(typeof(ElasticsearchResponse))]
+[JsonSourceGenerationOptions(GenerationMode = JsonSourceGenerationMode.Default)]
 public partial class ErrorSerializerContext : JsonSerializerContext;