Fix issues with deserializing mappings when retrieving mappings from the server.

John Daniels · gmarz · commit 37b95460e747 · 2014-07-31T16:48:21.000-04:00
We need to make sure that we can deserialize the interfaces on the
RootObjectMapping, which requires specifying ResolveAsTypeConverter
on all the appropriate interfaces. I added a test as well, though I'm
not sure it's in the right place, and I added a Deserialize function
on TestElasticClient to make it easier to roundtrip the serialization.
diff --git a/src/Nest/Domain/Mapping/SpecialFields/AnalyzerFieldMapping.cs b/src/Nest/Domain/Mapping/SpecialFields/AnalyzerFieldMapping.cs
@@ -5,6 +5,7 @@
 
 namespace Nest
 {
+	[JsonConverter(typeof(ReadAsTypeConverter<AnalyzerFieldMapping>))]
 	public interface IAnalyzerFieldMapping : ISpecialField
 	{
 		[JsonProperty("index"), JsonConverter(typeof(YesNoBoolConverter))]
diff --git a/src/Nest/Domain/Mapping/SpecialFields/BoostFieldMapping.cs b/src/Nest/Domain/Mapping/SpecialFields/BoostFieldMapping.cs
@@ -1,9 +1,11 @@
 ﻿using System;
 using System.Linq.Expressions;
 using Newtonsoft.Json;
+using Nest.Resolvers.Converters;
 
 namespace Nest
 {
+	[JsonConverter(typeof(ReadAsTypeConverter<BoostFieldMapping>))]
 	public interface IBoostFieldMapping : ISpecialField
 	{
 		[JsonProperty("name")]
diff --git a/src/Nest/Domain/Mapping/SpecialFields/IdFieldMapping.cs b/src/Nest/Domain/Mapping/SpecialFields/IdFieldMapping.cs
@@ -1,7 +1,9 @@
-﻿using Newtonsoft.Json;
+﻿using Nest.Resolvers.Converters;
+using Newtonsoft.Json;
 
 namespace Nest
 {
+	[JsonConverter(typeof(ReadAsTypeConverter<IdFieldMapping>))]
 	public interface IIdFieldMapping : ISpecialField
 	{
 		[JsonProperty("path")]
diff --git a/src/Nest/Domain/Mapping/SpecialFields/IndexFieldMapping.cs b/src/Nest/Domain/Mapping/SpecialFields/IndexFieldMapping.cs
@@ -1,7 +1,9 @@
-﻿using Newtonsoft.Json;
+﻿using Nest.Resolvers.Converters;
+using Newtonsoft.Json;
 
 namespace Nest
 {
+	[JsonConverter(typeof(ReadAsTypeConverter<IndexFieldMapping>))]
 	public interface IIndexFieldMapping : ISpecialField
 	{
 		[JsonProperty("enabled")]
diff --git a/src/Nest/Domain/Mapping/SpecialFields/RoutingFieldMapping.cs b/src/Nest/Domain/Mapping/SpecialFields/RoutingFieldMapping.cs
@@ -1,9 +1,11 @@
 ﻿using System;
 using Newtonsoft.Json;
 using System.Linq.Expressions;
+using Nest.Resolvers.Converters;
 
 namespace Nest
 {
+	[JsonConverter(typeof(ReadAsTypeConverter<RoutingFieldMapping>))]
 	public interface IRoutingFieldMapping : ISpecialField
 	{
 		[JsonProperty("required")]
diff --git a/src/Nest/Domain/Mapping/SpecialFields/SizeFieldMapping.cs b/src/Nest/Domain/Mapping/SpecialFields/SizeFieldMapping.cs
@@ -1,7 +1,9 @@
-﻿using Newtonsoft.Json;
+﻿using Nest.Resolvers.Converters;
+using Newtonsoft.Json;
 
 namespace Nest
 {
+	[JsonConverter(typeof(ReadAsTypeConverter<SizeFieldMapping>))]
 	public interface ISizeFieldMapping : ISpecialField
 	{
 		[JsonProperty("enabled")]
diff --git a/src/Nest/Domain/Mapping/SpecialFields/SourceFieldMapping.cs b/src/Nest/Domain/Mapping/SpecialFields/SourceFieldMapping.cs
@@ -1,8 +1,10 @@
 ﻿using System.Collections.Generic;
 using Newtonsoft.Json;
+using Nest.Resolvers.Converters;
 
 namespace Nest
 {
+	[JsonConverter(typeof(ReadAsTypeConverter<SourceFieldMapping>))]
 	public interface ISourceFieldMapping : ISpecialField
 	{
 		[JsonProperty("enabled")]
diff --git a/src/Nest/Domain/Mapping/SpecialFields/TimestampFieldMapping.cs b/src/Nest/Domain/Mapping/SpecialFields/TimestampFieldMapping.cs
@@ -1,9 +1,11 @@
 ﻿using System;
 using Newtonsoft.Json;
 using System.Linq.Expressions;
+using Nest.Resolvers.Converters;
 
 namespace Nest
 {
+	[JsonConverter(typeof(ReadAsTypeConverter<TimestampFieldMapping>))]
 	public interface ITimestampFieldMapping : ISpecialField
 	{
 		[JsonProperty("enabled")]
diff --git a/src/Nest/Domain/Mapping/SpecialFields/TtlFieldMapping.cs b/src/Nest/Domain/Mapping/SpecialFields/TtlFieldMapping.cs
@@ -1,7 +1,9 @@
-﻿using Newtonsoft.Json;
+﻿using Nest.Resolvers.Converters;
+using Newtonsoft.Json;
 
 namespace Nest
 {
+	[JsonConverter(typeof(ReadAsTypeConverter<TtlFieldMapping>))]
 	public interface ITtlFieldMapping : ISpecialField
 	{
 		[JsonProperty("enabled")]
diff --git a/src/Nest/Domain/Mapping/SpecialFields/TypeFieldMapping.cs b/src/Nest/Domain/Mapping/SpecialFields/TypeFieldMapping.cs
@@ -1,8 +1,10 @@
-﻿using Newtonsoft.Json;
+﻿using Nest.Resolvers.Converters;
+using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 
 namespace Nest
 {
+	[JsonConverter(typeof(ReadAsTypeConverter<TypeFieldMapping>))]
 	public interface ITypeFieldMapping : ISpecialField
 	{
 		[JsonProperty("index"), JsonConverter(typeof(StringEnumConverter))]
diff --git a/src/Tests/Nest.Tests.Unit/Core/Map/GetMappingSerializationTests.cs b/src/Tests/Nest.Tests.Unit/Core/Map/GetMappingSerializationTests.cs
@@ -0,0 +1,104 @@
+﻿using Newtonsoft.Json;
+using NUnit.Framework;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Reflection;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Nest.Tests.Unit.Core.Map
+{
+	class GetMappingSerializationTests : BaseJsonTests
+	{
+		/// <summary>
+		/// Verify that we can serialize/deserialize a populated root mapping.
+		/// If we can round trip a full root mapping, we're in a pretty good place.
+		/// </summary>
+		[Test]
+		public void CanDeserializeRootMapping()
+		{
+			var rootMapping = new RootObjectMapping()
+			{
+				AllFieldMapping = new AllFieldMapping()
+				{
+					Enabled = true,
+					IndexAnalyzer = "index_analyzer"
+				},
+				SourceFieldMappingDescriptor = new SourceFieldMapping()
+				{
+					Compress = false,
+					Excludes = new[] { "excluded" }
+				},
+				RoutingFieldMapping = new RoutingFieldMapping()
+				{
+					Path = "routing_path"
+				},
+				SizeFieldMapping = new SizeFieldMapping()
+				{
+					Enabled = true,
+				},
+				TtlFieldMappingDescriptor = new TtlFieldMapping()
+				{
+					Enabled = true,
+				},
+				IdFieldMappingDescriptor = new IdFieldMapping()
+				{
+					Index = "not_analyzed",
+					Store = false,
+					Path = "id_field",
+				},
+				TimestampFieldMapping = new TimestampFieldMapping()
+				{
+					Enabled = true,
+					Format = "YYY-MM-dd",
+					Path = "the_timestamp",
+				},
+				IndexFieldMapping = new IndexFieldMapping()
+				{
+					Enabled = true,
+				},
+				AnalyzerFieldMapping = new AnalyzerFieldMapping()
+				{
+					Path = "index_path",
+				},
+				BoostFieldMapping = new BoostFieldMapping()
+				{
+					Name = "boost",
+					NullValue = 2.0,
+				},
+				Parent = new ParentTypeMapping()
+				{
+					Type = "type"
+				},
+				TypeFieldMappingDescriptor = new TypeFieldMapping()
+				{
+					Index = NonStringIndexOption.NotAnalyzed, 
+					Store = false,
+				}
+			};
+			var json = TestElasticClient.Serialize(rootMapping);
+
+			var mapping = TestElasticClient.Deserialize<RootObjectMapping>(json);
+			TestElasticClient.Serialize(mapping).JsonEquals(json);
+		}
+
+		/// <summary>
+		/// Verify that we can serialize/deserialize an empty root mapping. One of the
+		/// failure modes of serialization/deserialization is handling data that's not there.
+		/// </summary>
+		[Test]
+		public void CanDeserializeEmptyRootMapping()
+		{
+			var rootMapping = new RootObjectMapping()
+			{
+			};
+			var json = TestElasticClient.Serialize(rootMapping);
+
+			var mapping = TestElasticClient.Deserialize<RootObjectMapping>(json);
+			TestElasticClient.Serialize(mapping).JsonEquals(json);
+		}
+		
+	}
+}
diff --git a/src/Tests/Nest.Tests.Unit/Nest.Tests.Unit.csproj b/src/Tests/Nest.Tests.Unit/Nest.Tests.Unit.csproj
@@ -125,6 +125,7 @@
     <Compile Include="Core\Indices\Analysis\Analyzers\AnalyzerTests.cs" />
     <Compile Include="Core\Indices\Similarity\SimilarityTests.cs" />
     <Compile Include="Core\Map\CustomMapping\ImagePluginMappingTests.cs" />
+    <Compile Include="Core\Map\GetMappingSerializationTests.cs" />
     <Compile Include="Core\Map\MappingBehaviourTests.cs" />
     <None Include="Cluster\PutSettings\PutSettings.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
@@ -1216,7 +1217,6 @@
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
   </ItemGroup>
-  <ItemGroup />
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
   <Import Project="$(SolutionDir)\.nuget\NuGet.targets" Condition="Exists('$(SolutionDir)\.nuget\NuGet.targets')" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
diff --git a/src/Tests/Nest.Tests.Unit/TestElasticClient.cs b/src/Tests/Nest.Tests.Unit/TestElasticClient.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
 using System.Text;
 
@@ -15,9 +16,15 @@ static TestElasticClient()
 
 			Client = new ElasticClient(Settings);
 		}
+
 		public static string Serialize<T>(T obj) where T : class
 		{
 			return Encoding.UTF8.GetString(Client.Serializer.Serialize(obj));
 		}
+
+		public static T Deserialize<T>(string json) where T : class
+		{
+			return Client.Serializer.Deserialize<T>(new MemoryStream(Encoding.UTF8.GetBytes(json)));
+		}
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`
`6`	`6`	`namespace Nest`
`7`	`7`	`{`
	`8`	`+ [JsonConverter(typeof(ReadAsTypeConverter<AnalyzerFieldMapping>))]`
`8`	`9`	`public interface IAnalyzerFieldMapping : ISpecialField`
`9`	`10`	`{`
`10`	`11`	`[JsonProperty("index"), JsonConverter(typeof(YesNoBoolConverter))]`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,11 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Linq.Expressions;`
`3`	`3`	`using Newtonsoft.Json;`
	`4`	`+using Nest.Resolvers.Converters;`
`4`	`5`
`5`	`6`	`namespace Nest`
`6`	`7`	`{`
	`8`	`+ [JsonConverter(typeof(ReadAsTypeConverter<BoostFieldMapping>))]`
`7`	`9`	`public interface IBoostFieldMapping : ISpecialField`
`8`	`10`	`{`
`9`	`11`	`[JsonProperty("name")]`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`		`-using Newtonsoft.Json;`
	`1`	`+using Nest.Resolvers.Converters;`
	`2`	`+using Newtonsoft.Json;`
`2`	`3`
`3`	`4`	`namespace Nest`
`4`	`5`	`{`
	`6`	`+ [JsonConverter(typeof(ReadAsTypeConverter<IdFieldMapping>))]`
`5`	`7`	`public interface IIdFieldMapping : ISpecialField`
`6`	`8`	`{`
`7`	`9`	`[JsonProperty("path")]`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,10 @@`
`1`	`1`	`using System.Collections.Generic;`
`2`	`2`	`using Newtonsoft.Json;`
	`3`	`+using Nest.Resolvers.Converters;`
`3`	`4`
`4`	`5`	`namespace Nest`
`5`	`6`	`{`
	`7`	`+ [JsonConverter(typeof(ReadAsTypeConverter<SourceFieldMapping>))]`
`6`	`8`	`public interface ISourceFieldMapping : ISpecialField`
`7`	`9`	`{`
`8`	`10`	`[JsonProperty("enabled")]`