Add AOT support to Elastic.Transport. (#162)

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.

---------

Co-authored-by: Florian Bernd <[email protected]>

Author: Mpdreamz

.editorconfig

@@ -133,6 +133,7 @@ resharper_redundant_case_label_highlighting=do_not_show
 resharper_redundant_argument_default_value_highlighting=do_not_show
 # Do not penalize code that explicitly lists generic arguments
 resharper_redundant_type_arguments_of_method_highlighting=do_not_show
+resharper_switch_expression_handles_some_known_enum_values_with_exception_in_default_highlighting=error
 
 [Jenkinsfile]
 indent_style = space

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/Pipeline/PipelineFailure.cs

@@ -2,6 +2,7 @@
 // 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 Elastic.Transport.Products;
 
 namespace Elastic.Transport;
@@ -56,3 +57,21 @@ public enum PipelineFailure
 	/// </summary>
 	NoNodesAttempted
 }
+
+internal static class PipelineFailureExtensions
+{
+	public static string ToStringFast(this PipelineFailure failure) => failure switch
+	{
+		PipelineFailure.BadAuthentication => nameof(PipelineFailure.BadAuthentication),
+		PipelineFailure.BadResponse => nameof(PipelineFailure.BadResponse),
+		PipelineFailure.PingFailure => nameof(PipelineFailure.PingFailure),
+		PipelineFailure.SniffFailure => nameof(PipelineFailure.SniffFailure),
+		PipelineFailure.CouldNotStartSniffOnStartup => nameof(PipelineFailure.CouldNotStartSniffOnStartup),
+		PipelineFailure.MaxTimeoutReached => nameof(PipelineFailure.MaxTimeoutReached),
+		PipelineFailure.MaxRetriesReached => nameof(PipelineFailure.MaxRetriesReached),
+		PipelineFailure.Unexpected => nameof(PipelineFailure.Unexpected),
+		PipelineFailure.BadRequest => nameof(PipelineFailure.BadRequest),
+		PipelineFailure.NoNodesAttempted => nameof(PipelineFailure.NoNodesAttempted),
+		_ => throw new ArgumentOutOfRangeException(nameof(failure), failure, null)
+	};
+}

src/Elastic.Transport/Components/Serialization/Converters/DynamicDictionaryConverter.cs

@@ -7,6 +7,8 @@
 using System.Globalization;
 using System.Text.Json;
 using System.Text.Json.Serialization;
+using System.Text.Json.Serialization.Metadata;
+using Elastic.Transport.Products.Elasticsearch;
 using JsonSerializer = System.Text.Json.JsonSerializer;
 
 namespace Elastic.Transport;
@@ -17,15 +19,15 @@ public override DynamicDictionary Read(ref Utf8JsonReader reader, Type typeToCon
 	{
 		if (reader.TokenType == JsonTokenType.StartArray)
 		{
-			var array = JsonSerializer.Deserialize<object[]>(ref reader, options);
+			var array = JsonSerializer.Deserialize<object[]>(ref reader, ErrorSerializerContext.Default.ObjectArray); // TODO: Test! This might not work without adding `object[]` to `ErrorSerializationContext`
 			var arrayDict = new Dictionary<string, object>();
 			for (var i = 0; i < array.Length; i++)
 				arrayDict[i.ToString(CultureInfo.InvariantCulture)] = new DynamicValue(array[i]);
 			return DynamicDictionary.Create(arrayDict);
 		}
 		if (reader.TokenType != JsonTokenType.StartObject) throw new JsonException();
 
-		var dict = JsonSerializer.Deserialize<Dictionary<string, object>>(ref reader, options);
+		var dict = JsonSerializer.Deserialize<Dictionary<string, object>>(ref reader, ErrorSerializerContext.Default.DictionaryStringObject); // TODO: Test! This might not work without adding `Dictionary<string, object>` to `ErrorSerializationContext`
 		return DynamicDictionary.Create(dict);
 	}
 
@@ -35,11 +37,14 @@ public override void Write(Utf8JsonWriter writer, DynamicDictionary dictionary,
 
 		foreach (var kvp in dictionary)
 		{
-			if (kvp.Value == null) continue;
+			if (kvp.Value is null) continue;
 
 			writer.WritePropertyName(kvp.Key);
 
-			JsonSerializer.Serialize(writer, kvp.Value?.Value, options);
+			// TODO: Test! We have to make sure all possible "Value" types are registered in the `ErrorSerializationContext`
+#pragma warning disable IL2026, IL3050 // ErrorSerializerContext is registered.
+			JsonSerializer.Serialize(writer, kvp.Value.Value, kvp.Value.GetType(), options);
+#pragma warning restore IL2026, IL3050
 		}
 
 		writer.WriteEndObject();

src/Elastic.Transport/Components/Serialization/Converters/ErrorCauseConverter.cs

@@ -22,7 +22,9 @@ public class ErrorConverter : ErrorCauseConverter<Error>
 	protected override bool ReadMore(ref Utf8JsonReader reader, JsonSerializerOptions options, string propertyName, Error errorCause)
 	{
 		void ReadAssign<T>(ref Utf8JsonReader r, Action<Error, T> set) =>
+#pragma warning disable IL2026, IL3050 // ErrorSerializerContext is registered.
 			set(errorCause, JsonSerializer.Deserialize<T>(ref r, options));
+#pragma warning restore IL2026, IL3050
 		switch (propertyName)
 		{
 			case "headers":
@@ -55,9 +57,14 @@ public override TErrorCause Read(ref Utf8JsonReader reader, Type typeToConvert,
 		errorCause.AdditionalProperties = additionalProperties;
 
 		void ReadAssign<T>(ref Utf8JsonReader r, Action<ErrorCause, T> set) =>
+#pragma warning disable IL2026, IL3050 // ErrorSerializerContext is registered.
 			set(errorCause, JsonSerializer.Deserialize<T>(ref r, options));
+#pragma warning restore IL2026, IL3050
+
 		void ReadAny(ref Utf8JsonReader r, string property, Action<ErrorCause, string, object> set) =>
-			set(errorCause, property, JsonSerializer.Deserialize<object>(ref r, options));
+#pragma warning disable IL2026, IL3050 // ErrorSerializerContext is registered.
+			set(errorCause, property, JsonSerializer.Deserialize<JsonElement>(ref r, options));
+#pragma warning restore IL2026, IL3050
 
 		while (reader.Read())
 		{
@@ -140,45 +147,6 @@ void ReadAny(ref Utf8JsonReader r, string property, Action<ErrorCause, string, o
 		return errorCause;
 	}
 
-	private static int? ReadIntFromString(ref Utf8JsonReader reader, JsonSerializerOptions options)
-	{
-		reader.Read();
-		switch (reader.TokenType)
-		{
-			case JsonTokenType.Null: return null;
-			case JsonTokenType.Number:
-				return JsonSerializer.Deserialize<int?>(ref reader, options);
-			case JsonTokenType.String:
-				var s = JsonSerializer.Deserialize<string>(ref reader, options);
-				if (int.TryParse(s, out var i)) return i;
-				return null;
-			default:
-				reader.TrySkip();
-				return null;
-		}
-	}
-
-	private static IReadOnlyCollection<string> ReadSingleOrCollection(ref Utf8JsonReader reader, JsonSerializerOptions options)
-	{
-		reader.Read();
-		switch (reader.TokenType)
-		{
-			case JsonTokenType.Null: return EmptyReadOnly<string>.Collection;
-			case JsonTokenType.StartArray:
-				var list = new List<string>();
-				while (reader.Read())
-				{
-					if (reader.TokenType == JsonTokenType.EndArray)
-						break;
-					list.Add(JsonSerializer.Deserialize<string>(ref reader, options));
-				}
-				return new ReadOnlyCollection<string>(list);
-			default:
-				var v = JsonSerializer.Deserialize<string>(ref reader, options);
-				return new ReadOnlyCollection<string>(new List<string>(1) { v});
-		}
-	}
-
 	/// Read additional properties for the particular <see cref="ErrorCause"/> implementation
 	protected virtual bool ReadMore(ref Utf8JsonReader reader, JsonSerializerOptions options, string propertyName, TErrorCause errorCause) => false;
 
@@ -189,10 +157,22 @@ public override void Write(Utf8JsonWriter writer, TErrorCause value, JsonSeriali
 
 		static void Serialize<T>(Utf8JsonWriter writer, JsonSerializerOptions options, string name, T value)
 		{
-			if (value == null) return;
+			if (value is null) return;
 
 			writer.WritePropertyName(name);
+#pragma warning disable IL2026, IL3050 // ErrorSerializerContext is registered.
 			JsonSerializer.Serialize(writer, value, options);
+#pragma warning restore IL2026, IL3050
+		}
+
+		static void SerializeDynamic(Utf8JsonWriter writer, JsonSerializerOptions options, string name, object? value, Type inputType)
+		{
+			if (value is null) return;
+
+			writer.WritePropertyName(name);
+#pragma warning disable IL2026, IL3050 // ErrorSerializerContext is registered.
+			JsonSerializer.Serialize(writer, value, inputType, options);
+#pragma warning restore IL2026, IL3050
 		}
 
 		//Serialize(writer, options, "bytes_limit", value.BytesLimit);
@@ -217,7 +197,7 @@ static void Serialize<T>(Utf8JsonWriter writer, JsonSerializerOptions options, s
 		Serialize(writer, options, "type", value.Type);
 
 		foreach (var kv in value.AdditionalProperties)
-			Serialize(writer, options, kv.Key, kv.Value);
+			SerializeDynamic(writer, options, kv.Key, kv.Value, kv.Value.GetType());
 		writer.WriteEndObject();
 	}
 }

src/Elastic.Transport/Components/Serialization/Converters/ExceptionConverter.cs

@@ -6,6 +6,7 @@
 using System.Collections.Generic;
 using System.Text.Json;
 using System.Text.Json.Serialization;
+using Elastic.Transport.Products.Elasticsearch;
 using JsonSerializer = System.Text.Json.JsonSerializer;
 
 namespace Elastic.Transport;
@@ -71,7 +72,7 @@ public override void Write(Utf8JsonWriter writer, Exception value, JsonSerialize
 			foreach (var kv in flattenedException)
 			{
 				writer.WritePropertyName(kv.Key);
-				JsonSerializer.Serialize(writer, kv.Value, options);
+				JsonSerializer.Serialize(writer, kv.Value, ErrorSerializerContext.Default.Object); // TODO: Test! This might not work without adding `KeyValuePair<string, object>` to `ErrorSerializationContext`
 			}
 			writer.WriteEndObject();
 		}

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,12 @@ public LowLevelRequestResponseSerializer(IReadOnlyCollection<JsonConverter>? con
 			new ErrorCauseConverter(),
 			new ErrorConverter(),
 			new DynamicDictionaryConverter()
-		], converters, options => { options.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull; })) { }
+		], converters, options =>
+		{
+			options.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull;
+#pragma warning disable IL2026, IL3050
+			options.TypeInfoResolver = JsonTypeInfoResolver.Combine(new DefaultJsonTypeInfoResolver(), ErrorSerializerContext.Default);
+#pragma warning restore IL2026, IL3050
+		})) { }
 
 }

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

@@ -10,6 +10,8 @@
 
 namespace Elastic.Transport;
 
+#pragma warning disable IL2026, IL3050 // Implementing classes must make sure to use an AOT compatible JsonSerializerOptions.TypeInfoResolver
+
 /// <summary>
 /// An abstract implementation of a transport <see cref="Serializer"/> which serializes using the Microsoft
 /// <c>System.Text.Json</c> library.
@@ -133,3 +135,5 @@ private static bool TryReturnDefault<T>(Stream? stream, out T deserialize)
 		return (stream is null) || stream == Stream.Null || (stream.CanSeek && stream.Length == 0);
 	}
 }
+
+#pragma warning restore IL2026, IL3050