Update settings for type mappings (#6383) (#6384)

* Move inference types to their own files

* Extract some types into files

* Rename and restructure Descriptor base types

* Support use of DefaultFieldNameInferrer setting with STJ

* Update playground

* Fix BOM and file cleanup

* Fix BOMs

* Nullable attributes for infer methods

* Remove commented code

Co-authored-by: Steve Gordon <sgordon@hotmail.co.uk>

Author: github-actions[bot]

src/Elastic.Clients.Elasticsearch/Client/ElasticsearchClient-Manual.cs

@@ -17,6 +17,12 @@ public IndexResponse Index<TDocument>(TDocument document, Action<IndexRequestDes
 			return DoRequest<IndexRequestDescriptor<TDocument>, IndexResponse>(descriptor);
 		}
 
+		public Task<IndexResponse> IndexAsync<TDocument>(TDocument document, CancellationToken cancellationToken = default)
+		{
+			var descriptor = new IndexRequestDescriptor<TDocument>(documentWithId: document);
+			return DoRequestAsync<IndexRequestDescriptor<TDocument>, IndexResponse>(descriptor);
+		}
+
 		public Task<IndexResponse> IndexAsync<TDocument>(TDocument document, Action<IndexRequestDescriptor<TDocument>> configureRequest, CancellationToken cancellationToken = default)
 		{
 			var descriptor = new IndexRequestDescriptor<TDocument>(documentWithId: document);

src/Elastic.Clients.Elasticsearch/Common/Configuration/ClrTypeDefaults.cs

@@ -3,46 +3,57 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
-using System.Collections.Generic;
 using System.Linq.Expressions;
-using System.Text.Json;
 
 namespace Elastic.Clients.Elasticsearch
 {
 	public class ClrTypeMapping
 	{
 		/// <summary>
-		/// Initializes a new instance of <see cref="ClrTypeMapping" />
+		/// Initializes a new instance of <see cref="ClrTypeMapping" />.
 		/// </summary>
 		public ClrTypeMapping(Type type) => ClrType = type;
 
-		/// <inheritdoc />
+		/// <summary>
+		/// The CLR type the mapping relates to.
+		/// </summary>
 		public Type ClrType { get; }
 
-		/// <inheritdoc />
+		/// <summary>
+		/// The property for the given <see cref="ClrType" /> to resolve IDs from.
+		/// </summary>
 		public string IdPropertyName { get; set; }
 
-		/// <inheritdoc />
+		/// <summary>
+		/// The default Elasticsearch index name for the given <see cref="ClrType" />.
+		/// </summary>
 		public string IndexName { get; set; }
 
-		/// <inheritdoc />
+		/// <summary>
+		/// The relation name for the given <see cref="ClrType" /> to resolve to.
+		/// </summary>
 		public string RelationName { get; set; }
 
-		/// <inheritdoc />
+		/// <summary>
+		/// Disables ID inference for the given <see cref="ClrType"/>.
+		/// By default, the _id value for a document is inferred from a property named Id,
+		/// or from the property named by <see cref="IdPropertyName"/>, if set.
+		/// </summary>
 		public bool DisableIdInference { get; set; }
 	}
 
-	public sealed class ClrTypeMapping<TDocument> : ClrTypeMapping where TDocument : class
+	public sealed class ClrTypeMapping<TDocument> : ClrTypeMapping
 	{
 		public ClrTypeMapping() : base(typeof(TDocument)) { }
 
-		/// <inheritdoc />
+		/// <summary>
+		/// Set a default Id property on CLR type <typeparamref name="TDocument" /> that NEST will evaluate
+		/// </summary>
 		public Expression<Func<TDocument, object>> IdProperty { get; set; }
 
-		/// <inheritdoc />
-		public IList<IClrPropertyMapping<TDocument>> Properties { get; set; }
-
-		/// <inheritdoc />
+		/// <summary>
+		/// Provide a default routing parameter lookup based on <typeparamref name="TDocument" />
+		/// </summary>
 		public Expression<Func<TDocument, object>> RoutingProperty { get; set; }
 	}
 
@@ -54,34 +65,26 @@ public sealed class ClrTypeMappingDescriptor : DescriptorBase<ClrTypeMappingDesc
 		internal string _idProperty;
 		internal bool _disableIdInference;
 
-		 // TODO - XML Comments
-
 		/// <summary>
 		/// Instantiates a new instance of <see cref="ClrTypeMappingDescriptor" />
 		/// </summary>
 		/// <param name="type">The CLR type to map</param>
 		public ClrTypeMappingDescriptor(Type type) => _clrType = type;
 
-		///// <inheritdoc cref="IClrTypeMapping.IndexName"/>
+		/// <inheritdoc cref="ClrTypeMapping.IndexName"/>
 		public ClrTypeMappingDescriptor IndexName(string indexName) => Assign(indexName, (a, v) => a._indexName = v);
 
-		///// <inheritdoc cref="IClrTypeMapping.RelationName"/>
+		/// <inheritdoc cref="ClrTypeMapping.RelationName"/>
 		public ClrTypeMappingDescriptor RelationName(string relationName) => Assign(relationName, (a, v) => a._relationName = v);
 
-		/// <summary>
-		/// The property for the given <see cref="Type" /> to resolve IDs from.
-		/// </summary>
+		/// <inheritdoc cref="ClrTypeMapping{T}.IdProperty"/>
 		public ClrTypeMappingDescriptor IdProperty(string idProperty) => Assign(idProperty, (a, v) => a._idProperty = v);
 
-		///// <inheritdoc cref="IClrTypeMapping.DisableIdInference"/>
+		/// <inheritdoc cref="ClrTypeMapping.DisableIdInference"/>
 		public ClrTypeMappingDescriptor DisableIdInference(bool disable = true) => Assign(disable, (a, v) => a._disableIdInference = v);
-
-		protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) => throw new NotImplementedException();
 	}
 
-	public sealed class ClrTypeMappingDescriptor<TDocument>
-		: DescriptorBase<ClrTypeMappingDescriptor<TDocument>>
-			where TDocument : class
+	public sealed class ClrTypeMappingDescriptor<TDocument> : DescriptorBase<ClrTypeMappingDescriptor<TDocument>>
 	{
 		internal Type _clrType = typeof(TDocument);
 		internal string _indexName;
@@ -91,47 +94,24 @@ public sealed class ClrTypeMappingDescriptor<TDocument>
 
 		internal Expression<Func<TDocument, object>> _idPropertyExpression;
 		internal Expression<Func<TDocument, object>> _routingPropertyExpression;
-		internal IList<IClrPropertyMapping<TDocument>> _properties = new List<IClrPropertyMapping<TDocument>>();
 
-		/// <summary>
-		/// The default Elasticsearch index name for <typeparamref name="TDocument" />
-		/// </summary>
+		/// <inheritdoc cref="ClrTypeMapping.IndexName"/>
 		public ClrTypeMappingDescriptor<TDocument> IndexName(string indexName) => Assign(indexName, (a, v) => a._indexName = v);
 
-		/// <summary>
-		/// The relation name for <typeparamref name="TDocument" /> to resolve to.
-		/// </summary>
+		/// <inheritdoc cref="ClrTypeMapping.RelationName"/>
 		public ClrTypeMappingDescriptor<TDocument> RelationName(string relationName) => Assign(relationName, (a, v) => a._relationName = v);
 
-		/// <summary>
-		/// Set a default Id property on CLR type <typeparamref name="TDocument" /> that Elastic.Clients.Elasticsearch will evaluate
-		/// </summary>
+		/// <inheritdoc cref="ClrTypeMapping{T}.IdProperty"/>
 		public ClrTypeMappingDescriptor<TDocument> IdProperty(Expression<Func<TDocument, object>> property) => Assign(property, (a, v) => a._idPropertyExpression = v);
 
-		/// <summary>
-		/// Set a default Id property on CLR type <typeparamref name="TDocument" /> that Elastic.Clients.Elasticsearch will evaluate
-		/// </summary>
+		/// <inheritdoc cref="ClrTypeMapping{T}.IdProperty"/>
 		public ClrTypeMappingDescriptor<TDocument> IdProperty(string property) => Assign(property, (a, v) => a._idProperty = v);
 
-		/// <summary> Provide a default routing parameter lookup based on <typeparamref name="TDocument" /> </summary>
+		/// <inheritdoc cref="ClrTypeMapping{T}.RoutingProperty"/>
 		public ClrTypeMappingDescriptor<TDocument> RoutingProperty(Expression<Func<TDocument, object>> property) =>
 			Assign(property, (a, v) => a._routingPropertyExpression = v);
 
-		/// <summary>
-		/// Ignore <paramref name="property" /> on CLR type <typeparamref name="TDocument" />
-		/// </summary>
-		public ClrTypeMappingDescriptor<TDocument> Ignore(Expression<Func<TDocument, object>> property) =>
-			Assign(property, (a, v) => a._properties.Add(new IgnoreClrPropertyMapping<TDocument>(v)));
-
-		/// <summary>
-		/// Rename <paramref name="property" /> on CLR type <typeparamref name="TDocument" />
-		/// </summary>
-		public ClrTypeMappingDescriptor<TDocument> PropertyName(Expression<Func<TDocument, object>> property, string newName) =>
-			Assign(new RenameClrPropertyMapping<TDocument>(property, newName), (a, v) => a._properties.Add(v));
-
-		///// <inheritdoc cref="IClrTypeMapping.DisableIdInference"/>
+		/// <inheritdoc cref="ClrTypeMapping.DisableIdInference"/>
 		public ClrTypeMappingDescriptor<TDocument> DisableIdInference(bool disable = true) => Assign(disable, (a, v) => a._disableIdInference = v);
-
-		protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) => throw new NotImplementedException();
 	}
 }

src/Elastic.Clients.Elasticsearch/Common/Configuration/ElasticsearchClientSettings.cs

@@ -112,8 +112,8 @@ protected ElasticsearchClientSettingsBase(
 			IPropertyMappingProvider propertyMappingProvider)
 			: base(nodePool, connection, null, ElasticsearchClientProductRegistration.DefaultForElasticsearchClientsElasticsearch)
 		{
-			var defaultSerializer = new DefaultRequestResponseSerializer(this);
-			var sourceSerializer = sourceSerializerFactory?.Invoke(defaultSerializer, this) ?? new DefaultSourceSerializer(this);
+			var requestResponseSerializer = new DefaultRequestResponseSerializer(this);
+			var sourceSerializer = sourceSerializerFactory?.Invoke(requestResponseSerializer, this) ?? new DefaultSourceSerializer(this);
 
 			// TODO - Is the second condition ever true?
 			_propertyMappingProvider = propertyMappingProvider ?? sourceSerializer as IPropertyMappingProvider ?? new PropertyMappingProvider();
@@ -124,7 +124,7 @@ protected ElasticsearchClientSettingsBase(
 			_sourceSerializer = sourceSerializer;
 
 			//UseThisRequestResponseSerializer = new DiagnosticsSerializerProxy(defaultSerializer);
-			UseThisRequestResponseSerializer = defaultSerializer;
+			UseThisRequestResponseSerializer = requestResponseSerializer;
 
 			_defaultFieldNameInferrer = p => p.ToCamelCase();
 			_defaultIndices = new FluentDictionary<Type, string>();
@@ -134,7 +134,7 @@ protected ElasticsearchClientSettingsBase(
 			UserAgent(ElasticsearchClientSettings.DefaultUserAgent);
 		}
 
-		public Serializer SourceSerializer { get; }
+		public Serializer SourceSerializer => _sourceSerializer;
 
 		bool IElasticsearchClientSettings.DefaultDisableIdInference => _defaultDisableAllInference;
 		Func<string, string> IElasticsearchClientSettings.DefaultFieldNameInferrer => _defaultFieldNameInferrer;
@@ -171,8 +171,15 @@ public TConnectionSettings DefaultIndex(string defaultIndex) =>
 		/// <example>
 		///     CLR property EmailAddress will be inferred as "emailAddress" Elasticsearch document field name
 		/// </example>
-		public TConnectionSettings DefaultFieldNameInferrer(Func<string, string> fieldNameInferrer) =>
-			Assign(fieldNameInferrer, (a, v) => a._defaultFieldNameInferrer = v);
+		public TConnectionSettings DefaultFieldNameInferrer(Func<string, string> fieldNameInferrer)
+		{
+			if (_sourceSerializer is DefaultSourceSerializer dss)
+			{
+				dss.Options.PropertyNamingPolicy = new CustomizedNamingPolicy(fieldNameInferrer);
+			}
+			
+			return Assign<Func<string, string>>(fieldNameInferrer, (a, v) => a._defaultFieldNameInferrer = v);
+		}
 
 		public TConnectionSettings ExperimentalEnableSerializeNullInferredValues(bool enabled = true) =>
 			Assign(enabled, (a, v) => a._experimentalEnableSerializeNullInferredValues = v);
@@ -230,42 +237,6 @@ private void MapRoutePropertyFor<TDocument>(Expression<Func<TDocument, object>>
 			_routeProperties.Add(typeof(TDocument), fieldName);
 		}
 
-		private void ApplyPropertyMappings<TDocument>(IList<IClrPropertyMapping<TDocument>> mappings)
-			where TDocument : class
-		{
-			foreach (var mapping in mappings)
-			{
-				var e = mapping.Property;
-				var memberInfoResolver = new MemberInfoResolver(e);
-				if (memberInfoResolver.Members.Count > 1)
-					throw new ArgumentException($"{nameof(ApplyPropertyMappings)} can only map direct properties");
-
-				if (memberInfoResolver.Members.Count == 0)
-					throw new ArgumentException($"Expression {e} does contain any member access");
-
-				var memberInfo = memberInfoResolver.Members[0];
-
-				if (_propertyMappings.TryGetValue(memberInfo, out var propertyMapping))
-				{
-					var newName = mapping.NewName;
-					var mappedAs = propertyMapping.Name;
-					var typeName = typeof(TDocument).Name;
-					if (mappedAs.IsNullOrEmpty() && newName.IsNullOrEmpty())
-						throw new ArgumentException($"Property mapping '{e}' on type is already ignored");
-					if (mappedAs.IsNullOrEmpty())
-						throw new ArgumentException(
-							$"Property mapping '{e}' on type {typeName} can not be mapped to '{newName}' it already has an ignore mapping");
-					if (newName.IsNullOrEmpty())
-						throw new ArgumentException(
-							$"Property mapping '{e}' on type {typeName} can not be ignored it already has a mapping to '{mappedAs}'");
-
-					throw new ArgumentException(
-						$"Property mapping '{e}' on type {typeName} can not be mapped to '{newName}' already mapped as '{mappedAs}'");
-				}
-				_propertyMappings[memberInfo] = mapping.ToPropertyMapping();
-			}
-		}
-
 		/// <summary>
 		///     Specify how the mapping is inferred for a given CLR type.
 		///     The mapping can infer the index, id and relation name for a given CLR type, as well as control
@@ -293,9 +264,6 @@ public TConnectionSettings DefaultMappingFor<TDocument>(
 			if (inferMapping._routingPropertyExpression != null)
 				MapRoutePropertyFor(inferMapping._routingPropertyExpression);
 
-			if (inferMapping._properties != null)
-				ApplyPropertyMappings(inferMapping._properties);
-
 			if (inferMapping._disableIdInference)
 				_disableIdInference.Add(inferMapping._clrType);
 			else

src/Elastic.Clients.Elasticsearch/Common/Configuration/IElasticsearchClientSettings.cs

@@ -101,15 +101,15 @@ public interface IElasticsearchClientSettings : ITransportConfiguration
 		bool ExperimentalEnableSerializeNullInferredValues { get; }
 
 		/// <summary>
-		/// TODO
+		/// Experimental settings.
 		/// </summary>
 		ExperimentalSettings Experimental { get; }
 	}
 
 	public sealed class ExperimentalSettings
 	{
 		/// <summary>
-		/// When enabled, the parameters for a script will be serialised using the SourceSerializer
+		/// When enabled, the parameters for a script will be serialised using the SourceSerializer.
 		/// </summary>
 		public bool UseSourceSerializerForScriptParameters { get; set; }
 	}

src/Elastic.Clients.Elasticsearch/Common/Containers/VariantDescriptorBase.cs

@@ -4,7 +4,7 @@
 
 namespace Elastic.Clients.Elasticsearch;
 
-public abstract class VariantDescriptorBase<T> : DescriptorBase<T> where T : DescriptorBase<T>
+public abstract class VariantDescriptorBase<T> : SerializableDescriptorBase<T> where T : SerializableDescriptorBase<T>
 {
 	internal string VariantName { get; private set; }
 

src/Elastic.Clients.Elasticsearch/Common/Fluent/DescriptorBase.cs

@@ -7,28 +7,13 @@
 using System.Runtime.CompilerServices;
 using System.Runtime.Serialization;
 using System.Text.Json;
+using System.Text.Json.Serialization;
 
 namespace Elastic.Clients.Elasticsearch;
 
-/// <summary>
-/// Internal marker for descriptors.
-/// </summary>
-internal interface IDescriptor { }
-
-public abstract class DescriptorBase<TDescriptor> : IDescriptor, ISelfSerializable
-	where TDescriptor : DescriptorBase<TDescriptor>
+public abstract class Descriptor
 {
-	private readonly TDescriptor _self;
-
-	internal DescriptorBase() => _self = (TDescriptor)this;
-
-	[IgnoreDataMember]
-	protected TDescriptor Self => _self;
-
-	[MethodImpl(MethodImplOptions.AggressiveInlining)]
-	protected TDescriptor Assign<TValue>(TValue value, Action<TDescriptor, TValue> assign) => Fluent.Assign(_self, value, assign);
-
-	protected abstract void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings);
+	internal Descriptor() { }
 
 	/// <summary>
 	/// Hides the <see cref="Equals" /> method.
@@ -45,7 +30,7 @@ public abstract class DescriptorBase<TDescriptor> : IDescriptor, ISelfSerializab
 	[Browsable(false)]
 	[EditorBrowsable(EditorBrowsableState.Never)]
 	// ReSharper disable once BaseObjectGetHashCodeCallInGetHashCode
-	//only used to hide by default
+	// only used to hide by default
 	public override int GetHashCode() => base.GetHashCode();
 
 	/// <summary>
@@ -54,7 +39,29 @@ public abstract class DescriptorBase<TDescriptor> : IDescriptor, ISelfSerializab
 	[Browsable(false)]
 	[EditorBrowsable(EditorBrowsableState.Never)]
 	public override string ToString() => base.ToString();
+}
 
-	void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) => Serialize(writer, options, settings);
+public abstract class DescriptorBase<TDescriptor> : Descriptor
+	where TDescriptor : DescriptorBase<TDescriptor>
+{
+	private readonly TDescriptor _self;
+
+	internal DescriptorBase() : base() => _self = (TDescriptor)this;
+
+	[JsonIgnore]
+	[IgnoreDataMember]
+	protected TDescriptor Self => _self;
+
+	[MethodImpl(MethodImplOptions.AggressiveInlining)]
+	protected TDescriptor Assign<TValue>(TValue value, Action<TDescriptor, TValue> assign) => Fluent.Assign(_self, value, assign);
 }
 
+public abstract class SerializableDescriptorBase<TDescriptor> : DescriptorBase<TDescriptor>, ISelfSerializable
+	where TDescriptor : SerializableDescriptorBase<TDescriptor>
+{
+	internal SerializableDescriptorBase(): base() { }
+
+	void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) => Serialize(writer, options, settings);
+
+	protected abstract void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings);
+}