[Backport master] Implement version field type (#5250)

* Implement version field type (#5200)

* Implement version field type
* Fix failing test
* Add skip version to test

* Fixup namespace for master

Co-authored-by: Steve Gordon <[email protected]>

Author: github-actions[bot]

src/Nest/Mapping/DynamicTemplate/SingleMapping.cs

@@ -148,6 +148,10 @@ public IProperty ConstantKeyword(Func<ConstantKeywordPropertyDescriptor<T>, ICon
 		/// <inheritdoc />
 		public IProperty Wildcard(Func<WildcardPropertyDescriptor<T>, IWildcardProperty> selector) =>
 			selector?.Invoke(new WildcardPropertyDescriptor<T>());
+		
+		/// <inheritdoc />
+		public IProperty Version(Func<VersionPropertyDescriptor<T>, IVersionProperty> selector) =>
+			selector?.Invoke(new VersionPropertyDescriptor<T>());
 
 #pragma warning disable CS3001 // Argument type is not CLS-compliant
 		public IProperty Scalar(Expression<Func<T, int>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null) =>

src/Nest/Mapping/Types/FieldType.cs

@@ -154,5 +154,11 @@ public enum FieldType
 
 		[EnumMember(Value = "point")]
 		Point,
+
+		/// <summary>
+		/// Version field type for storing semver compatible version numbers.
+		/// </summary>
+		[EnumMember(Value = "version")]
+		Version
 	}
 }

src/Nest/Mapping/Types/Properties.cs

@@ -151,6 +151,9 @@ TReturnType Nested<TChild>(Func<NestedPropertyDescriptor<T, TChild>, INestedProp
 
 		/// <inheritdoc cref="IWildcardProperty"/>
 		TReturnType Wildcard(Func<WildcardPropertyDescriptor<T>, IWildcardProperty> selector);
+
+		/// <inheritdoc cref="IVersionProperty"/>
+		TReturnType Version(Func<VersionPropertyDescriptor<T>, IVersionProperty> selector);
 	}
 
 	public partial class PropertiesDescriptor<T> where T : class
@@ -263,8 +266,10 @@ public PropertiesDescriptor<T> ConstantKeyword(Func<ConstantKeywordPropertyDescr
 			SetProperty(selector);
 
 		/// <inheritdoc cref="IWildcardProperty"/>
-		public PropertiesDescriptor<T> Wildcard(Func<WildcardPropertyDescriptor<T>, IWildcardProperty> selector) =>
-			SetProperty(selector);
+		public PropertiesDescriptor<T> Wildcard(Func<WildcardPropertyDescriptor<T>, IWildcardProperty> selector) => SetProperty(selector);
+
+		/// <inheritdoc cref="IVersionProperty"/>
+		public PropertiesDescriptor<T> Version(Func<VersionPropertyDescriptor<T>, IVersionProperty> selector) => SetProperty(selector);
 
 		/// <summary>
 		/// Map a custom property.

src/Nest/Mapping/Types/PropertyFormatter.cs

@@ -97,6 +97,7 @@ public IProperty Deserialize(ref JsonReader reader, IJsonFormatterResolver forma
 				case FieldType.Histogram: return Deserialize<HistogramProperty>(ref segmentReader, formatterResolver);
 				case FieldType.ConstantKeyword: return Deserialize<ConstantKeywordProperty>(ref segmentReader, formatterResolver);
 				case FieldType.Wildcard: return Deserialize<WildcardProperty>(ref segmentReader, formatterResolver);
+				case FieldType.Version: return Deserialize<VersionProperty>(ref segmentReader, formatterResolver);
 				case FieldType.None:
 					// no "type" field in the property mapping, or FieldType enum could not be parsed from typeString
 					return Deserialize<ObjectProperty>(ref segmentReader, formatterResolver);
@@ -217,6 +218,9 @@ public void Serialize(ref JsonWriter writer, IProperty value, IJsonFormatterReso
 				case IGenericProperty genericProperty:
 					Serialize(ref writer, genericProperty, formatterResolver);
 					break;
+				case IVersionProperty versionProperty:
+					Serialize(ref writer, versionProperty, formatterResolver);
+					break;
 				default:
 					var formatter = formatterResolver.GetFormatter<object>();
 					formatter.Serialize(ref writer, value, formatterResolver);

src/Nest/Mapping/Types/Specialized/Version/VersionAttribute.cs

@@ -0,0 +1,13 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// 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
+
+namespace Nest
+{
+	public class VersionAttribute : ElasticsearchPropertyAttributeBase, IVersionProperty
+	{
+		public VersionAttribute() : base(FieldType.Version) { }
+
+		private IVersionProperty Self => this;
+	}
+}

src/Nest/Mapping/Types/Specialized/Version/VersionProperty.cs

@@ -0,0 +1,33 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// 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.Diagnostics;
+using Nest.Utf8Json;
+
+namespace Nest
+{
+	/// <summary>
+	/// A version field can index/store semver version numbers.
+	/// </summary>
+	[InterfaceDataContract]
+	public interface IVersionProperty : IProperty
+	{
+	}
+
+	/// <inheritdoc cref="IVersionProperty"/>
+	[DebuggerDisplay("{DebugDisplay}")]
+	public class VersionProperty : PropertyBase, IVersionProperty
+	{
+		public VersionProperty() : base(FieldType.Version) { }
+	}
+
+	/// <inheritdoc cref="IVersionProperty" />
+	[DebuggerDisplay("{DebugDisplay}")]
+	public class VersionPropertyDescriptor<T>
+		: PropertyDescriptorBase<VersionPropertyDescriptor<T>, IVersionProperty, T>, IVersionProperty
+		where T : class
+	{
+		public VersionPropertyDescriptor() : base(FieldType.Version) { }
+	}
+}

src/Nest/Mapping/Visitor/IMappingVisitor.cs

@@ -71,6 +71,8 @@ public interface IMappingVisitor
 		void Visit(IHistogramProperty property);
 
 		void Visit(IConstantKeywordProperty property);
+
+		void Visit(IVersionProperty property);
 	}
 
 	public class NoopMappingVisitor : IMappingVisitor
@@ -140,5 +142,7 @@ public virtual void Visit(IFlattenedProperty property) { }
 		public virtual void Visit(IHistogramProperty property) { }
 
 		public virtual void Visit(IConstantKeywordProperty property) { }
+
+		public virtual void Visit(IVersionProperty property) { }
 	}
 }

src/Nest/Mapping/Visitor/IPropertyVisitor.cs

@@ -76,6 +76,8 @@ public interface IPropertyVisitor
 
 		void Visit(IWildcardProperty type, PropertyInfo propertyInfo, ElasticsearchPropertyAttributeBase attribute);
 
+		void Visit(IVersionProperty type, PropertyInfo propertyInfo, ElasticsearchPropertyAttributeBase attribute);
+
 		IProperty Visit(PropertyInfo propertyInfo, ElasticsearchPropertyAttributeBase attribute);
 
 		bool SkipProperty(PropertyInfo propertyInfo, ElasticsearchPropertyAttributeBase attribute);

src/Nest/Mapping/Visitor/MappingWalker.cs

@@ -273,6 +273,12 @@ public void Accept(IProperties properties)
 							_visitor.Visit(t);
 						});
 						break;
+					case FieldType.Version:
+						Visit<IVersionProperty>(field, t =>
+						{
+							_visitor.Visit(t);
+						});
+						break;
 					case FieldType.None:
 						continue;
 				}

src/Nest/Mapping/Visitor/NoopPropertyVisitor.cs

@@ -76,6 +76,8 @@ public virtual void Visit(IFieldAliasProperty type, PropertyInfo propertyInfo, E
 
 		public virtual void Visit(IWildcardProperty type, PropertyInfo propertyInfo, ElasticsearchPropertyAttributeBase attribute) { }
 
+		public virtual void Visit(IVersionProperty type, PropertyInfo propertyInfo, ElasticsearchPropertyAttributeBase attribute) { }
+
 		public virtual IProperty Visit(PropertyInfo propertyInfo, ElasticsearchPropertyAttributeBase attribute) => null;
 
 		public virtual void Visit(IProperty type, PropertyInfo propertyInfo, ElasticsearchPropertyAttributeBase attribute)
@@ -168,7 +170,7 @@ public virtual void Visit(IProperty type, PropertyInfo propertyInfo, Elasticsear
 					break;
 				case IPointProperty point:
 					Visit(point, propertyInfo, attribute);
-          break;
+					break;
 				case ISearchAsYouTypeProperty searchAsYouType:
 					Visit(searchAsYouType, propertyInfo, attribute);
 					break;
@@ -178,6 +180,9 @@ public virtual void Visit(IProperty type, PropertyInfo propertyInfo, Elasticsear
 				case IFieldAliasProperty fieldAlias:
 					Visit(fieldAlias, propertyInfo, attribute);
 					break;
+				case IVersionProperty version:
+					Visit(version, propertyInfo, attribute);
+					break;
 			}
 		}
 	}