AutoDateHistogramAggregate Interval should be DateMathTime (#4725)

This commit fixes a bug with AutoDateHistogramAggregate Interval
property that uses the Time type to represent valid intervals. The Time
type however does not support Months and Years, which are valid units
for the AutoDateHistogram interval.

Fixes #4333

(cherry picked from commit a693da3)

Author: russcam

src/Nest/Aggregations/AggregateDictionary.cs

@@ -221,7 +221,7 @@ public AutoDateHistogramAggregate AutoDateHistogram(string key)
 			{
 				Buckets = bucket.Items.OfType<DateHistogramBucket>().ToList(),
 				Meta = bucket.Meta,
-				Interval = bucket.Interval
+				AutoInterval = bucket.AutoInterval
 			};
 		}
 

src/Nest/Aggregations/AggregateFormatter.cs

@@ -665,7 +665,7 @@ private IAggregate GetMultiBucketAggregate(ref JsonReader reader, IJsonFormatter
 				reader.ReadNext();
 				propertyName = reader.ReadPropertyNameSegmentRaw();
 				if (propertyName.EqualsBytes(JsonWriter.GetEncodedPropertyNameWithoutQuotation("interval")))
-					bucket.Interval = formatterResolver.GetFormatter<Time>().Deserialize(ref reader, formatterResolver);
+					bucket.AutoInterval = formatterResolver.GetFormatter<DateMathTime>().Deserialize(ref reader, formatterResolver);
 				else
 					// skip for now
 					reader.ReadNextBlock();

src/Nest/Aggregations/Bucket/AutoDateHistogram/AutoDateHistogramBucket.cs

@@ -2,10 +2,15 @@
 // 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
+using System;
+
+namespace Nest
 {
 	public class AutoDateHistogramAggregate : MultiBucketAggregate<DateHistogramBucket>
 	{
+		[Obsolete("Use AutoInterval. This property is incorrectly mapped to the wrong type")]
 		public Time Interval { get; internal set; }
+
+		public DateMathTime AutoInterval { get; internal set; }
 	}
 }

src/Nest/Aggregations/Bucket/BucketAggregate.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 System.Collections.Generic;
 using Elasticsearch.Net;
 
@@ -68,6 +69,10 @@ public class BucketAggregate : IAggregate
 		public IReadOnlyCollection<IBucket> Items { get; set; } = EmptyReadOnly<IBucket>.Collection;
 		public IReadOnlyDictionary<string, object> Meta { get; set; } = EmptyReadOnly<string, object>.Dictionary;
 		public long? SumOtherDocCount { get; set; }
+
+		[Obsolete("Use AutoInterval. This property is incorrectly mapped to the wrong type")]
 		public Time Interval { get; set; }
+
+		public DateMathTime AutoInterval { get; set; }
 	}
 }

tests/Tests.Reproduce/GitHubIssue4333.cs

@@ -0,0 +1,95 @@
+// 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;
+using System.Text;
+using Elastic.Elasticsearch.Xunit.XunitPlumbing;
+using Elasticsearch.Net;
+using FluentAssertions;
+using Nest;
+
+namespace Tests.Reproduce
+{
+	public class GitHubIssue4333
+	{
+		[U]
+		public void CanDeserializeYearIntervalUnit()
+		{
+			var json = @"{
+			""took"" : 162,
+			""timed_out"" : false,
+			""_shards"" : {
+				""total"" : 3,
+				""successful"" : 3,
+				""skipped"" : 0,
+				""failed"" : 0
+			},
+			""hits"" : {
+				""total"" : 4089559,
+				""max_score"" : 0.0,
+				""hits"" : [ ]
+			},
+			""aggregations"" : {
+				""modDate"" : {
+					""buckets"" : [
+					{
+						""key_as_string"" : ""2013-01-01T00:00:00.000Z"",
+						""key"" : 1356998400000,
+						""doc_count"" : 32
+					},
+					{
+						""key_as_string"" : ""2014-01-01T00:00:00.000Z"",
+						""key"" : 1388534400000,
+						""doc_count"" : 617
+					},
+					{
+						""key_as_string"" : ""2015-01-01T00:00:00.000Z"",
+						""key"" : 1420070400000,
+						""doc_count"" : 183
+					},
+					{
+						""key_as_string"" : ""2016-01-01T00:00:00.000Z"",
+						""key"" : 1451606400000,
+						""doc_count"" : 3479
+					},
+					{
+						""key_as_string"" : ""2017-01-01T00:00:00.000Z"",
+						""key"" : 1483228800000,
+						""doc_count"" : 1948427
+					},
+					{
+						""key_as_string"" : ""2018-01-01T00:00:00.000Z"",
+						""key"" : 1514764800000,
+						""doc_count"" : 555748
+					},
+					{
+						""key_as_string"" : ""2019-01-01T00:00:00.000Z"",
+						""key"" : 1546300800000,
+						""doc_count"" : 1268034
+					},
+					{
+						""key_as_string"" : ""2020-01-01T00:00:00.000Z"",
+						""key"" : 1577836800000,
+						""doc_count"" : 313039
+					}
+					],
+					""interval"" : ""1y""
+				}
+			}
+		}";
+
+			var bytes = Encoding.UTF8.GetBytes(json);
+			var pool = new SingleNodeConnectionPool(new Uri("http://localhost:9200"));
+			var connectionSettings = new ConnectionSettings(pool, new InMemoryConnection(bytes)).DefaultIndex("default_index");
+			var client = new ElasticClient(connectionSettings);
+
+			var response = client.Search<object>();
+
+			Func<AutoDateHistogramAggregate> func = () => response.Aggregations.AutoDateHistogram("modDate");
+
+			var agg = func.Should().NotThrow().Subject;
+			agg.AutoInterval.Should().Be("1y");
+		}
+	}
+}

tests/Tests/Aggregations/Bucket/AutoDateHistogram/AutoDateHistogramAggregationUsageTests.cs

@@ -107,7 +107,7 @@ protected override void ExpectResponse(ISearchResponse<Project> response)
 
 			var dateHistogram = response.Aggregations.AutoDateHistogram("projects_started_per_month");
 			dateHistogram.Should().NotBeNull();
-			dateHistogram.Interval.Should().NotBeNull();
+			dateHistogram.AutoInterval.Should().NotBeNull();
 			dateHistogram.Buckets.Should().NotBeNull();
 			dateHistogram.Buckets.Count.Should().BeGreaterThan(1);
 			foreach (var item in dateHistogram.Buckets)
@@ -202,13 +202,13 @@ protected override void ExpectResponse(ISearchResponse<Project> response)
 			/** ==== Handling responses
 			* The `AggregateDictionary found on `.Aggregations` on `SearchResponse<T>` has several helper methods
 			* so we can fetch our aggregation results easily in the correct type.
-			 * <<handling-aggregate-response, Be sure to read more about these helper methods>>
+			* <<handling-aggregate-response, Be sure to read more about these helper methods>>
 			*/
 			response.ShouldBeValid();
 
 			var dateHistogram = response.Aggregations.AutoDateHistogram("projects_started_per_month");
 			dateHistogram.Should().NotBeNull();
-			dateHistogram.Interval.Should().NotBeNull();
+			dateHistogram.AutoInterval.Should().NotBeNull();
 			dateHistogram.Buckets.Should().NotBeNull();
 			dateHistogram.Buckets.Count.Should().BeGreaterThan(1);
 			foreach (var item in dateHistogram.Buckets)