SortByPrimaryKey option (#415)

Author: AlekseyMartynov

net/DevExtreme.AspNet.Data.Tests/DataSourceExpressionBuilderTests.cs

@@ -86,6 +86,39 @@ public void Build_Sorting() {
             Assert.Equal("data.OrderBy(obj => obj.Item1).ThenByDescending(obj => obj.Item2)", expr.ToString());
         }
 
+        [Fact]
+        public void SortByPrimaryKey() {
+
+            void Case(Action<DataSourceLoadOptionsBase> initOptions, Action<string> assert) {
+                var source = new[] {
+                    new { ID = 1, Value = "A" }
+                };
+
+                var loadOptions = new SampleLoadOptions {
+                    GuardNulls = false,
+                    PrimaryKey = new[] { "ID" },
+                    SortByPrimaryKey = false
+                };
+
+                initOptions?.Invoke(loadOptions);
+
+                assert(Compat.CreateDataSourceExpressionBuilder(source.AsQueryable(), loadOptions).BuildLoadExpr().ToString());
+            }
+
+            Case(
+                null,
+                expr => Assert.DoesNotContain("OrderBy", expr)
+            );
+
+            Case(
+                options => options.DefaultSort = "Value",
+                expr => {
+                    Assert.Contains(".OrderBy(obj => obj.Value)", expr);
+                    Assert.DoesNotContain("ThenBy", expr);
+                }
+            );
+        }
+
         [Fact]
         public void GroupingAddedToSorting() {
             var loadOptions = new SampleLoadOptions {

net/DevExtreme.AspNet.Data/DataSourceLoadContext.cs

@@ -138,7 +138,7 @@ partial class DataSourceLoadContext {
         string[] _primaryKey;
         string _defaultSort;
 
-        public bool HasAnySort => HasGroups || HasSort || HasPrimaryKey || HasDefaultSort;
+        public bool HasAnySort => HasGroups || HasSort || ShouldSortByPrimaryKey || HasDefaultSort;
 
         bool HasSort => !IsEmpty(_options.Sort);
 
@@ -160,6 +160,8 @@ string DefaultSort {
 
         bool HasDefaultSort => !String.IsNullOrEmpty(DefaultSort);
 
+        bool ShouldSortByPrimaryKey => HasPrimaryKey && _options.SortByPrimaryKey.GetValueOrDefault(true);
+
         public IEnumerable<SortingInfo> GetFullSort() {
             var memo = new HashSet<string>();
             var result = new List<SortingInfo>();
@@ -189,7 +191,7 @@ public IEnumerable<SortingInfo> GetFullSort() {
             if(HasDefaultSort)
                 requiredSort = requiredSort.Concat(new[] { DefaultSort });
 
-            if(HasPrimaryKey)
+            if(ShouldSortByPrimaryKey)
                 requiredSort = requiredSort.Concat(PrimaryKey);
 
             return Utils.AddRequiredSort(result, requiredSort);

net/DevExtreme.AspNet.Data/DataSourceLoadOptionsBase.cs

@@ -110,6 +110,8 @@ public class DataSourceLoadOptionsBase {
         /// </summary>
         public bool? PaginateViaPrimaryKey { get; set; }
 
+        public bool? SortByPrimaryKey { get; set; }
+
         public bool AllowAsyncOverSync { get; set; }
 
 #if DEBUG