Merge branch 'FoneticSolutions-2308-TookAsLongIn2x' into 2.x

Author: russcam

src/Benchmarking/PartitionExtension.cs

@@ -35,10 +35,10 @@ public static IEnumerable<IEnumerable<T>> Partition<T>(this IEnumerable<T> sourc
 			}
 		}
 
-		public static decimal GetMedian(this IEnumerable<int> source)
+		public static decimal GetMedian(this IEnumerable<long> source)
 		{
 			// Create a copy of the input, and sort the copy
-			int[] temp = source.ToArray();
+			long[] temp = source.ToArray();
 			Array.Sort(temp);
 
 			int count = temp.Length;
@@ -50,13 +50,13 @@ public static decimal GetMedian(this IEnumerable<int> source)
 			if (count % 2 == 0)
 			{
 				// count is even, average two middle elements
-				int a = temp[count / 2 - 1];
-				int b = temp[count / 2];
+				long a = temp[count / 2 - 1];
+				long b = temp[count / 2];
 				return (a + b) / 2m;
 			}
-			
+
 			// count is odd, return the middle element
 			return temp[count / 2];
 		}
 	}
-}
+}

src/Benchmarking/Results.cs

@@ -15,7 +15,7 @@ public class Results
 
 		public int IndexedDocuments { get; set; }
 
-		public IEnumerable<int> EsTimings { get; set; }
+		public IEnumerable<long> EsTimings { get; set; }
 
 		public Metrics Before { get; set; }
 
@@ -30,4 +30,4 @@ public void Write(TextWriter output)
 			output.WriteLine("  memory after:{0} thread count after:{1}", After.MemorySize.Bytes(), After.ThreadCount);
 		}
 	}
-}
+}

src/Benchmarking/Tester.cs

@@ -75,7 +75,7 @@ public Results RunTests(int numMessages = NumberOfMessages, int bufferSize = Buf
 
 		protected ConnectionSettings CreateSettings()
 		{
-			var host = Process.GetProcessesByName("fiddler").Any() 
+			var host = Process.GetProcessesByName("fiddler").Any()
 				? "ipv4.fiddler"
 				: "localhost";
 
@@ -99,7 +99,7 @@ protected void Connect()
 		protected class IndexResults
 		{
 			public double Elapsed { get; set; }
-			public IEnumerable<int> EsTimings { get; set; }
+			public IEnumerable<long> EsTimings { get; set; }
 		}
 
 		protected IndexResults GenerateAndIndex(int numMessages, int bufferSize)
@@ -132,7 +132,7 @@ protected IndexResults GenerateAndIndex(int numMessages, int bufferSize)
 					{
 						Interlocked.Add(ref NumSent, bufferSize);
 						Console.Write("\r{2}: {0:0,0} msgs es-time: {1}      ",
-							NumSent, tt.Result.Took, this.Type);
+							NumSent, tt.Result.TookAsLong, this.Type);
 						return tt.Result;
 					})
 				).ToArray();
@@ -151,7 +151,7 @@ protected IndexResults GenerateAndIndex(int numMessages, int bufferSize)
 			return new IndexResults
 			{
 				Elapsed = sw.ElapsedMilliseconds,
-				EsTimings = array.Select(a => a.Result.Took).ToList()
+				EsTimings = array.Select(a => a.Result.TookAsLong).ToList()
 			};
 		}
 
@@ -173,4 +173,4 @@ public void SearchUsingSingleClient(int numberOfSearches)
 			Task.WaitAll(tasks.ToArray());
 		}
 	}
-}
+}

src/Nest/Document/Multiple/Bulk/BulkResponse.cs

@@ -2,12 +2,23 @@
 using System.Linq;
 using System.Text;
 using Newtonsoft.Json;
+using System;
 
 namespace Nest
 {
 	public interface IBulkResponse : IResponse
 	{
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		[Obsolete(@"returned value may be larger than int. In this case, value will be int.MaxValue and TookAsLong field can be checked. Took is long in 5.0.0")]
 		int Took { get; }
+
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		long TookAsLong { get; }
+
 		bool Errors { get; }
 		IEnumerable<BulkResponseItemBase> Items { get; }
 		IEnumerable<BulkResponseItemBase> ItemsWithErrors { get; }
@@ -20,13 +31,23 @@ public class BulkResponse : ResponseBase, IBulkResponse
 		protected override void DebugIsValid(StringBuilder sb)
 		{
 			if (this.Items == null) return;
-			sb.AppendLine($"# Invalid Bulk items:");
+			sb.AppendLine("# Invalid Bulk items:");
 			foreach(var i in Items.Select((item, i) => new { item, i}).Where(i=>!i.item.IsValid))
 				sb.AppendLine($"  operation[{i.i}]: {i.item}");
 		}
 
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
 		[JsonProperty("took")]
-		public int Took { get; internal set; }
+		public long TookAsLong { get;  internal set;}
+
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		[Obsolete(@"returned value may be larger than int. In this case, value will be int.MaxValue and TookAsLong field can be checked. Took is long in 5.0.0")]
+		[JsonIgnore]
+		public int Took => TookAsLong > int.MaxValue ? int.MaxValue : (int)TookAsLong;
 
 		[JsonProperty("errors")]
 		public bool Errors { get; internal set; }
@@ -35,12 +56,7 @@ protected override void DebugIsValid(StringBuilder sb)
 		public IEnumerable<BulkResponseItemBase> Items { get; internal set; }
 
 		[JsonIgnore]
-		public IEnumerable<BulkResponseItemBase> ItemsWithErrors
-		{
-			get
-			{
-				return !this.Items.HasAny() ? Enumerable.Empty<BulkResponseItemBase>() : this.Items.Where(i => !i.IsValid);
-			}
-		}
+		public IEnumerable<BulkResponseItemBase> ItemsWithErrors =>
+			!this.Items.HasAny() ? Enumerable.Empty<BulkResponseItemBase>() : this.Items.Where(i => !i.IsValid);
 	}
 }

src/Nest/Document/Single/TermVectors/TermVectorsResponse.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using Newtonsoft.Json;
+using System;
 
 namespace Nest
 {
@@ -10,7 +11,18 @@ public interface ITermVectorsResponse : IResponse
 		string Id { get; }
 		long Version { get; }
 		bool Found { get; }
+
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		[Obsolete(@"returned value may be larger than int. In this case, value will be int.MaxValue and TookAsLong field can be checked. Took is long in 5.0.0")]
 		int Took { get; }
+
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		long TookAsLong { get; }
+
 		IDictionary<string, TermVector> TermVectors { get; }
 	}
 
@@ -32,8 +44,18 @@ public class TermVectorsResponse : ResponseBase, ITermVectorsResponse
 		[JsonProperty("found")]
 		public bool Found { get; internal set; }
 
-		[JsonProperty(PropertyName = "took")]
-		public int Took { get; internal set; }
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		[JsonProperty("took")]
+		public long TookAsLong { get; internal set; }
+
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		[Obsolete(@"returned value may be larger than int. In this case, value will be int.MaxValue and TookAsLong field can be checked. Took is long in 5.0.0")]
+		[JsonIgnore]
+		public int Took => TookAsLong > int.MaxValue ? int.MaxValue : (int)TookAsLong;
 
 		[JsonProperty("term_vectors")]
 		public IDictionary<string, TermVector> TermVectors { get; internal set; } =  new Dictionary<string, TermVector>();

src/Nest/Search/Percolator/Percolate/PercolateResponse.cs

@@ -1,12 +1,23 @@
 using System.Collections.Generic;
 using Elasticsearch.Net;
 using Newtonsoft.Json;
-
+using System;
+
 namespace Nest
 {
 	public interface IPercolateCountResponse : IResponse
-	{
-		int Took { get; }
+	{
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		[Obsolete(@"returned value may be larger than int. In this case, value will be int.MaxValue and TookAsLong field can be checked. Took is long in 5.0.0")]
+		int Took { get; }
+
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		long TookAsLong { get; }
+
 		long Total { get; }
 	}
 
@@ -17,20 +28,30 @@ public interface IPercolateResponse : IPercolateCountResponse
 
 	[JsonObject]
 	public class PercolateCountResponse : ResponseBase, IPercolateCountResponse
-	{
-		[JsonProperty(PropertyName = "took")]
-		public int Took { get; internal set; }
+	{
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		[JsonProperty("took")]
+		public long TookAsLong { get; internal set; }
+
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		[Obsolete(@"returned value may be larger than int. In this case, value will be int.MaxValue and TookAsLong field can be checked. Took is long in 5.0.0")]
+		[JsonIgnore]
+		public int Took => TookAsLong > int.MaxValue? int.MaxValue : (int)TookAsLong;
 
-		[JsonProperty(PropertyName = "total")]
+		[JsonProperty("total")]
 		public long Total { get; internal set; }
-		
-		[JsonProperty(PropertyName = "_shards")]
+
+		[JsonProperty("_shards")]
 		public ShardsMetaData Shards { get; internal set; }
-		
+
 		/// <summary>
 		/// The individual error for separate requests on the _mpercolate API
 		/// </summary>
-		[JsonProperty(PropertyName = "error")]
+		[JsonProperty("error")]
 		internal ServerError Error { get; set; }
 
 		public override ServerError ServerError => this.Error ?? base.ServerError;
@@ -39,24 +60,23 @@ public class PercolateCountResponse : ResponseBase, IPercolateCountResponse
 	[JsonObject]
 	public class PercolateResponse : PercolateCountResponse, IPercolateResponse
 	{
-
-		[JsonProperty(PropertyName = "matches")]
+		[JsonProperty("matches")]
 		public IEnumerable<PercolatorMatch> Matches { get; internal set; }
 	}
 
 	public class PercolatorMatch
 	{
-		[JsonProperty(PropertyName = "highlight")]
+		[JsonProperty("highlight")]
 		public Dictionary<string, IList<string>> Highlight { get; set; }
 
-		[JsonProperty(PropertyName = "_id")]
+		[JsonProperty("_id")]
 		public string Id { get; set; }
 
-		[JsonProperty(PropertyName = "_index")]
+		[JsonProperty("_index")]
 		public string Index { get; set; }
 
-		[JsonProperty(PropertyName = "_score")]
+		[JsonProperty("_score")]
 		public double Score { get; set; }
 	}
 
-}
+}

src/Nest/Search/Search/SearchResponse.cs

@@ -14,7 +14,18 @@ public interface ISearchResponse<T> : IResponse where T : class
 		Profile Profile { get; }
 		AggregationsHelper Aggs { get; }
 		IDictionary<string, Suggest[]> Suggest { get; }
+
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		[Obsolete(@"returned value may be larger than int. In this case, value will be int.MaxValue and TookAsLong field can be checked. Took is long in 5.0.0")]
 		int Took { get; }
+
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		long TookAsLong { get; }
+
 		bool TimedOut { get; }
 		bool TerminatedEarly { get; }
 		string ScrollId { get; }
@@ -64,8 +75,18 @@ public class SearchResponse<T> : ResponseBase, ISearchResponse<T> where T : clas
 		[JsonProperty(PropertyName = "suggest")]
 		public IDictionary<string, Suggest[]> Suggest { get; internal set; }
 
-		[JsonProperty(PropertyName = "took")]
-		public int Took { get; internal set; }
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		[JsonProperty("took")]
+		public long TookAsLong { get; internal set; }
+
+		/// <summary>
+		/// Time in milliseconds for Elasticsearch to execute the search
+		/// </summary>
+		[Obsolete(@"returned value may be larger than int. In this case, value will be int.MaxValue and TookAsLong field can be checked. Took is long in 5.0.0")]
+		[JsonIgnore]
+		public int Took => TookAsLong > int.MaxValue ? int.MaxValue : (int)TookAsLong;
 
 		[JsonProperty("timed_out")]
 		public bool TimedOut { get; internal set; }

src/Tests/Document/Multiple/Bulk/BulkApiTests.cs

@@ -92,7 +92,10 @@ protected override LazyResponses ClientUsage() => Calls(
 
 		protected override void ExpectResponse(IBulkResponse response)
 		{
+#pragma warning disable 618
 			response.Took.Should().BeGreaterThan(0);
+#pragma warning restore 618
+			response.TookAsLong.Should().BeGreaterThan(0);
 			response.Errors.Should().BeFalse();
 			response.ItemsWithErrors.Should().NotBeNull().And.BeEmpty();
 			response.Items.Should().NotBeEmpty();

src/Tests/Document/Multiple/Bulk/BulkInvalidApiTests.cs

@@ -37,7 +37,10 @@ protected override LazyResponses ClientUsage() => Calls(
 
 		protected override void ExpectResponse(IBulkResponse response)
 		{
+#pragma warning disable 618
 			response.Took.Should().BeGreaterThan(0);
+#pragma warning restore 618
+			response.TookAsLong.Should().BeGreaterThan(0);
 			response.Errors.Should().BeTrue();
 
 			//a delete not found is not an error (also in Elasticsearch)

src/Tests/Document/Multiple/MultiTermVectors/MultiTermVectorsApiTests.cs

@@ -61,7 +61,10 @@ protected override void ExpectResponse(IMultiTermVectorsResponse response)
 			termvectorDoc.Index.Should().NotBeNull();
 			termvectorDoc.Type.Should().NotBeNull();
 			termvectorDoc.Id.Should().NotBeNull();
+#pragma warning disable 618
 			termvectorDoc.Took.Should().BeGreaterThan(0);
+#pragma warning restore 618
+			termvectorDoc.TookAsLong.Should().BeGreaterThan(0);
 
 			termvectorDoc.TermVectors.Should().NotBeEmpty().And.ContainKey("firstName");
 			var vectors = termvectorDoc.TermVectors["firstName"];