Force selection of calendar or fixed intervals in date histo aggregat…

…ions (#3988) Implements elastic/elasticsearch#33727
elastic · Aug 9, 2019 · 802c570 · 802c570
1 parent d4c9cef
commit 802c570
Show file tree

Hide file tree

Showing 23 changed files with 67 additions and 0 deletions.
diff --git a/src/Nest/Aggregations/Bucket/DateHistogram/DateHistogramAggregation.cs b/src/Nest/Aggregations/Bucket/DateHistogram/DateHistogramAggregation.cs
@@ -19,9 +19,16 @@ public interface IDateHistogramAggregation : IBucketAggregation
 		[DataMember(Name ="format")]
 		string Format { get; set; }
 
+		[Obsolete("Deprecated in version 7.2.0, use CalendarInterval or FixedInterval instead")]
 		[DataMember(Name ="interval")]
 		Union<DateInterval, Time> Interval { get; set; }
 
+		[DataMember(Name ="calendar_interval")]
+		Union<DateInterval, Time> CalendarInterval { get; set; }
+
+		[DataMember(Name ="fixed_interval")]
+		Union<DateInterval, Time> FixedInterval { get; set; }
+
 		[DataMember(Name ="min_doc_count")]
 		int? MinimumDocumentCount { get; set; }
 
@@ -65,7 +72,11 @@ public string Format
 			set => _format = value;
 		}
 
+
+		[Obsolete("Deprecated in version 7.2.0, use CalendarInterval or FixedInterval instead")]
 		public Union<DateInterval, Time> Interval { get; set; }
+		public Union<DateInterval, Time> CalendarInterval { get; set; }
+		public Union<DateInterval, Time> FixedInterval { get; set; }
 
 		public int? MinimumDocumentCount { get; set; }
 		public DateTime? Missing { get; set; }
@@ -99,7 +110,10 @@ string IDateHistogramAggregation.Format
 			set => _format = value;
 		}
 
+		[Obsolete("Deprecated in version 7.2.0, use CalendarInterval or FixedInterval instead")]
 		Union<DateInterval, Time> IDateHistogramAggregation.Interval { get; set; }
+		Union<DateInterval, Time> IDateHistogramAggregation.CalendarInterval { get; set; }
+		Union<DateInterval, Time> IDateHistogramAggregation.FixedInterval { get; set; }
 
 		int? IDateHistogramAggregation.MinimumDocumentCount { get; set; }
 
@@ -124,11 +138,18 @@ string IDateHistogramAggregation.Format
 		public DateHistogramAggregationDescriptor<T> Script(Func<ScriptDescriptor, IScript> scriptSelector) =>
 			Assign(scriptSelector, (a, v) => a.Script = v?.Invoke(new ScriptDescriptor()));
 
+		[Obsolete("Deprecated in version 7.2.0, use CalendarInterval or FixedInterval instead")]
 		public DateHistogramAggregationDescriptor<T> Interval(Time interval) => Assign(interval, (a, v) => a.Interval = v);
 
+		[Obsolete("Deprecated in version 7.2.0, use CalendarInterval or FixedInterval instead")]
 		public DateHistogramAggregationDescriptor<T> Interval(DateInterval interval) =>
 			Assign(interval, (a, v) => a.Interval = v);
 
+		public DateHistogramAggregationDescriptor<T> CalendarInterval(Time interval) => Assign(interval, (a, v) => a.CalendarInterval = v);
+		public DateHistogramAggregationDescriptor<T> CalendarInterval(DateInterval interval) => Assign(interval, (a, v) => a.CalendarInterval = v);
+		public DateHistogramAggregationDescriptor<T> FixedInterval(Time interval) => Assign(interval, (a, v) => a.FixedInterval = v);
+		public DateHistogramAggregationDescriptor<T> FixedInterval(DateInterval interval) => Assign(interval, (a, v) => a.FixedInterval = v);
+
 		public DateHistogramAggregationDescriptor<T> Format(string format) => Assign(format, (a, v) => a.Format = v);
 
 		public DateHistogramAggregationDescriptor<T> MinimumDocumentCount(int? minimumDocumentCount) =>

diff --git a/src/Tests/Tests.Reproduce/GithubIssue3673.cs b/src/Tests/Tests.Reproduce/GithubIssue3673.cs
@@ -16,6 +16,7 @@ public class GithubIssue3673 : IClusterFixture<ReadOnlyCluster>
 		[I]
 		public void DeserializeDateAggregation()
 		{
+#pragma warning disable 612, 618
 			Action action = () => _cluster.Client.Search<Project>(s => s
 				.Size(0)
 				.Aggregations(a => a
@@ -27,6 +28,7 @@ public void DeserializeDateAggregation()
 					)
 				)
 			);
+#pragma warning restore 612, 618
 
 			action.Should().NotThrow();
 		}

diff --git a/src/Tests/Tests/Aggregations/Bucket/DateHistogram/DateHistogramAggregationUsageTests.cs b/src/Tests/Tests/Aggregations/Bucket/DateHistogram/DateHistogramAggregationUsageTests.cs
@@ -64,6 +64,7 @@ public DateHistogramAggregationUsageTests(ReadOnlyCluster i, EndpointUsage usage
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", date => date
 				.Field(p => p.StartedOn)
@@ -106,6 +107,7 @@ public DateHistogramAggregationUsageTests(ReadOnlyCluster i, EndpointUsage usage
 					}
 				}
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{
@@ -160,6 +162,7 @@ public DateHistogramAggregationNoSubAggregationsUsageTests(ReadOnlyCluster i, En
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", date => date
 				.Field(p => p.StartedOn)
@@ -186,6 +189,7 @@ public DateHistogramAggregationNoSubAggregationsUsageTests(ReadOnlyCluster i, En
 				Order = HistogramOrder.CountAscending,
 				Missing = FixedDate
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/src/Tests/Tests/Aggregations/Pipeline/AverageBucket/AverageBucketAggregationUsageTests.cs b/src/Tests/Tests/Aggregations/Pipeline/AverageBucket/AverageBucketAggregationUsageTests.cs
@@ -42,6 +42,7 @@ public AverageBucketAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -68,6 +69,7 @@ public AverageBucketAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage
 			{
 				GapPolicy = GapPolicy.InsertZeros
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/src/Tests/Tests/Aggregations/Pipeline/BucketScript/BucketScriptAggregationUsageTests.cs b/src/Tests/Tests/Aggregations/Pipeline/BucketScript/BucketScriptAggregationUsageTests.cs
@@ -72,6 +72,7 @@ public BucketScriptAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -125,6 +126,7 @@ public BucketScriptAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage
 						Script = new InlineScript("params.stableCommits / params.totalCommits * 100")
 					}
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/src/Tests/Tests/Aggregations/Pipeline/BucketSelector/BucketSelectorAggregationUsageTests.cs b/src/Tests/Tests/Aggregations/Pipeline/BucketSelector/BucketSelectorAggregationUsageTests.cs
@@ -48,6 +48,7 @@ public BucketSelectorAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsag
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -80,6 +81,7 @@ public BucketSelectorAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsag
 						Script = new InlineScript("params.totalCommits >= 500")
 					}
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/src/Tests/Tests/Aggregations/Pipeline/BucketSort/BucketSortAggregationUsageTests.cs b/src/Tests/Tests/Aggregations/Pipeline/BucketSort/BucketSortAggregationUsageTests.cs
@@ -50,6 +50,7 @@ public BucketSortAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage us
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -87,6 +88,7 @@ public BucketSortAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage us
 						GapPolicy = GapPolicy.InsertZeros
 					}
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/src/Tests/Tests/Aggregations/Pipeline/CumulativeSum/CumulativeSumAggregationUsageTests.cs b/src/Tests/Tests/Aggregations/Pipeline/CumulativeSum/CumulativeSumAggregationUsageTests.cs
@@ -41,6 +41,7 @@ public CumulativeSumAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -64,6 +65,7 @@ public CumulativeSumAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage
 					new SumAggregation("commits", "numberOfCommits") &&
 					new CumulativeSumAggregation("cumulative_commits", "commits")
 			};
+#pragma warning restore 618
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/src/Tests/Tests/Aggregations/Pipeline/Derivative/DerivativeAggregationUsageTests.cs b/src/Tests/Tests/Aggregations/Pipeline/Derivative/DerivativeAggregationUsageTests.cs
@@ -42,6 +42,7 @@ public DerivativeAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage us
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -65,6 +66,7 @@ public DerivativeAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage us
 					new SumAggregation("commits", "numberOfCommits") &&
 					new DerivativeAggregation("commits_derivative", "commits")
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/...sts/Aggregations/Pipeline/ExtendedStatsBucket/ExtendedStatsBucketAggregationUsageTests.cs b/...sts/Aggregations/Pipeline/ExtendedStatsBucket/ExtendedStatsBucketAggregationUsageTests.cs
@@ -42,6 +42,7 @@ public ExtendedStatsBucketAggregationUsageTests(ReadOnlyCluster cluster, Endpoin
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -68,6 +69,7 @@ public ExtendedStatsBucketAggregationUsageTests(ReadOnlyCluster cluster, Endpoin
 			{
 				Sigma = 2.0
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/src/Tests/Tests/Aggregations/Pipeline/MaxBucket/MaxBucketAggregationUsageTests.cs b/src/Tests/Tests/Aggregations/Pipeline/MaxBucket/MaxBucketAggregationUsageTests.cs
@@ -41,6 +41,7 @@ public MaxBucketAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage usa
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -63,6 +64,7 @@ public MaxBucketAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage usa
 				Aggregations = new SumAggregation("commits", "numberOfCommits")
 			}
 			&& new MaxBucketAggregation("max_commits_per_month", "projects_started_per_month>commits");
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/src/Tests/Tests/Aggregations/Pipeline/MinBucket/MinBucketAggregationUsageTests.cs b/src/Tests/Tests/Aggregations/Pipeline/MinBucket/MinBucketAggregationUsageTests.cs
@@ -41,6 +41,7 @@ public MinBucketAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage usa
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -63,6 +64,7 @@ public MinBucketAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage usa
 				Aggregations = new SumAggregation("commits", "numberOfCommits")
 			}
 			&& new MinBucketAggregation("min_commits_per_month", "projects_started_per_month>commits");
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/...Tests/Tests/Aggregations/Pipeline/MovingAverage/MovingAverageEwmaAggregationUsageTests.cs b/...Tests/Tests/Aggregations/Pipeline/MovingAverage/MovingAverageEwmaAggregationUsageTests.cs
@@ -49,6 +49,7 @@ public MovingAverageEwmaAggregationUsageTests(ReadOnlyCluster cluster, EndpointU
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -83,6 +84,7 @@ public MovingAverageEwmaAggregationUsageTests(ReadOnlyCluster cluster, EndpointU
 						}
 					}
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/...Tests/Aggregations/Pipeline/MovingAverage/MovingAverageHoltLinearAggregationUsageTests.cs b/...Tests/Aggregations/Pipeline/MovingAverage/MovingAverageHoltLinearAggregationUsageTests.cs
@@ -50,6 +50,7 @@ public MovingAverageHoltLinearAggregationUsageTests(ReadOnlyCluster cluster, End
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -84,6 +85,7 @@ public MovingAverageHoltLinearAggregationUsageTests(ReadOnlyCluster cluster, End
 						}
 					}
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/...ests/Aggregations/Pipeline/MovingAverage/MovingAverageHoltWintersAggregationUsageTests.cs b/...ests/Aggregations/Pipeline/MovingAverage/MovingAverageHoltWintersAggregationUsageTests.cs
@@ -54,6 +54,7 @@ public MovingAverageHoltWintersUsageTests(ReadOnlyCluster cluster, EndpointUsage
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -100,6 +101,7 @@ public MovingAverageHoltWintersUsageTests(ReadOnlyCluster cluster, EndpointUsage
 						}
 					}
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/...sts/Tests/Aggregations/Pipeline/MovingAverage/MovingAverageLinearAggregationUsageTests.cs b/...sts/Tests/Aggregations/Pipeline/MovingAverage/MovingAverageLinearAggregationUsageTests.cs
@@ -47,6 +47,7 @@ public MovingAverageLinearAggregationUsageTests(ReadOnlyCluster cluster, Endpoin
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -78,6 +79,7 @@ public MovingAverageLinearAggregationUsageTests(ReadOnlyCluster cluster, Endpoin
 						Model = new LinearModel()
 					}
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/...sts/Tests/Aggregations/Pipeline/MovingAverage/MovingAverageSimpleAggregationUsageTests.cs b/...sts/Tests/Aggregations/Pipeline/MovingAverage/MovingAverageSimpleAggregationUsageTests.cs
@@ -48,6 +48,7 @@ public MovingAverageSimpleAggregationUsageTests(ReadOnlyCluster cluster, Endpoin
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -81,6 +82,7 @@ public MovingAverageSimpleAggregationUsageTests(ReadOnlyCluster cluster, Endpoin
 						Model = new SimpleModel()
 					}
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/src/Tests/Tests/Aggregations/Pipeline/MovingFunction/MovingFunctionAggregationUsageTests.cs b/src/Tests/Tests/Aggregations/Pipeline/MovingFunction/MovingFunctionAggregationUsageTests.cs
@@ -57,6 +57,7 @@ public MovingFunctionAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsag
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -86,6 +87,7 @@ public MovingFunctionAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsag
 						Script = "MovingFunctions.unweightedAvg(values)"
 					}
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/...s/Tests/Aggregations/Pipeline/PercentilesBucket/PercentilesBucketAggregationUsageTests.cs b/...s/Tests/Aggregations/Pipeline/PercentilesBucket/PercentilesBucketAggregationUsageTests.cs
@@ -42,6 +42,7 @@ public PercentilesBucketAggregationUsageTests(ReadOnlyCluster cluster, EndpointU
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -68,6 +69,7 @@ public PercentilesBucketAggregationUsageTests(ReadOnlyCluster cluster, EndpointU
 			{
 				Percents = new[] { 95, 99, 99.9 }
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/...Tests/Aggregations/Pipeline/SerialDifferencing/SerialDifferencingAggregationUsageTests.cs b/...Tests/Aggregations/Pipeline/SerialDifferencing/SerialDifferencingAggregationUsageTests.cs
@@ -42,6 +42,7 @@ public SerialDifferencingAggregationUsageTests(ReadOnlyCluster cluster, Endpoint
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -69,6 +70,7 @@ public SerialDifferencingAggregationUsageTests(ReadOnlyCluster cluster, Endpoint
 						Lag = 2
 					}
 			};
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{

diff --git a/src/Tests/Tests/Aggregations/Pipeline/StatsBucket/StatsBucketAggregationUsageTests.cs b/src/Tests/Tests/Aggregations/Pipeline/StatsBucket/StatsBucketAggregationUsageTests.cs
@@ -41,6 +41,7 @@ public StatsBucketAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage u
 			}
 		};
 
+#pragma warning disable 618, 612
 		protected override Func<AggregationContainerDescriptor<Project>, IAggregationContainer> FluentAggs => a => a
 			.DateHistogram("projects_started_per_month", dh => dh
 				.Field(p => p.StartedOn)
@@ -63,6 +64,7 @@ public StatsBucketAggregationUsageTests(ReadOnlyCluster cluster, EndpointUsage u
 				Aggregations = new SumAggregation("commits", "numberOfCommits")
 			}
 			&& new StatsBucketAggregation("stats_commits_per_month", "projects_started_per_month>commits");
+#pragma warning restore 618, 612
 
 		protected override void ExpectResponse(ISearchResponse<Project> response)
 		{