devexpress / devextreme.aspnet.data

DevExtreme data layer extension for ASP.NET

DevExtreme ASP.NET Data

This library enables DevExtreme client-side widgets to perform CRUD operations via ASP.NET controllers and handlers and allows you to delegate all data-intensive operations to the server:

• a widget sends data loading options (filtering, grouping, sorting, etc.) to the server;
• the server processes data according to these options;
• the processed data is sent back to the widget.

Can be used with:

• DevExtreme client-side widgets
• DevExtreme-based ASP.NET Core controls
• DevExtreme ASP.NET MVC 5 controls

Installation and Configuration

DevExtreme.AspNet.Data consists of server-side and client-side parts. The following topics explain how to install and configure these parts:

• Server Side Configuration
• Client Side with jQuery
• Client Side without jQuery (Angular, etc.)

CI Builds

We recommend that you use release builds. However, you can also use CI builds to get urgent bug fixes or to test unreleased functionality.

devextreme.aspnet.data's Issues

Performance issue

I've set up a grid with total summaries of count and a sum.
Everytime I change the page, the summaries and total count are re-queried. No filter, sorting or grouping has been changed, just the page (Skip/take parameter).

I would love to see that the summaries and totalcount are only fetched on the first page request and after the filter, sorting or grouping have been changed. Any time else the summaries stays the same and should't be fetched on every pagination operation.

Interval grouping by Nullable<DateTime> doesn't work properly

See the Filter row does not filter properly for nullable date field ticket for details.
T458279.zip

Mention NPM in README

@RomanTsukanov
Now that we have https://www.npmjs.com/package/devextreme-aspnet-data would you please update README accordingly?

README: missing code samples for MVC 5

"Custom Model Binder" and "Controller Example" don't provide examples for MVC 5 controllers.

A custom store created using the DevExpress.data.AspNet.createStore method sends date values with a timezone offset to the server

It can be reproduced with the Widget Gallery for ASP.NET MVC Wrappers using the following code:
Scheduler.cshtml:

@(Html.DevExtreme().Scheduler()
        .DataSource(d => d.WebApi()
            .Controller("SchedulerData")
            .LoadAction("Appointments")
            .Key("OrderID")
        )
        .Editing(e => e.AllowAdding(true).AllowDeleting(false))
        ...
)

SchedulerDataController.cs:

public class SchedulerDataController : ApiController {
         ...
        [HttpPut]
        public HttpResponseMessage Put(FormDataCollection form) {
            var key = Convert.ToInt32(form.Get("key"));
            var values = JsonConvert.DeserializeObject<JObject>(form.Get("values"));

            var order = _nwind.Orders.Find(key);
            order.OrderDate = (DateTime)values["OrderDate"];
            order.ShippedDate = (DateTime)values["ShippedDate"];
            order.ShipVia = (int)values["ShipVia"];

            Validate(order);
            if(!ModelState.IsValid)
                return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState.GetFullErrorMessage());

            _nwind.SaveChanges();

            return Request.CreateResponse(HttpStatusCode.OK);
        }
}

Support old SQL Servers in Sample

Info: http://stackoverflow.com/a/34165599

The DataSourceLoader.Load method - Filtering does not work correctly with enum typed fields

The DataSourceLoader.Load method returns an empty result with enum typed fields.

Debugging a user's sample project in the T412494 ticket, I reproduced this issue with the simple code below:

using System;
using System.Collections.Generic;
using DevExtreme.AspNet.Data;
using Newtonsoft.Json;

namespace EnumField {

    class Program {
        public enum OrderType { One, Two }

        class Order {
            public Enum OrderType { get; set; }
        }

        public partial class DataSourceLoadOptions : DataSourceLoadOptionsBase { }

        static void Main(string[] args) {

            var orders = new List<Order>() {
                new Order { OrderType = OrderType.One },
                new Order { OrderType = OrderType.Two }
            };

            var loadOptions = new DataSourceLoadOptions() {
                Filter = new List<object>(new object[] { "OrderType", "=", 1 })
            };

            var result = DataSourceLoader.Load(orders, loadOptions);
            Console.WriteLine(JsonConvert.SerializeObject(result));
        }
    }
}

Remove MVC dependency

Why?

• To have a single build/package suitable for MVC 5, MVC 6 and any other platform
• To have stable dependencies, therefore be able to publish a non-preview package

Drawbacks

• DataSourceLoadOptions and DataSourceLoadOptionsBinder must be defined externally (like here).

Work started in https://github.com/AlekseyMartynov/DevExtreme.AspNet.Data/tree/no-mvc

@IlyaKhD when you have a minute, please review and share your thoughts

"LessThan is not defined for the types System.String and System.String"

String-based filters (startsWith, contains etc) don't work with nullable TimeSpan columns

To reproduce the issue input any text to the find panel.
timeSpanIssue.zip

Converting null to empty string breaks dxDataGrid grouping

Handle unexpected AJAX responses

For example, if the load endpoint returns a JSON string, then the following error occurs:

dx.aspnet.data.js:225 Uncaught TypeError: Cannot use 'in' operator to search for 'totalCount' in abc
    at createLoadExtra (dx.aspnet.data.js:225)
    at dx.aspnet.data.js:148
    at Object.<anonymous> (dx.aspnet.data.js:59)
    ...

ArgumentOutOfRangeException if Filter is empty list

Originally reported in https://www.devexpress.com/Support/Center/Question/Details/T483154

Angular 2 and dx.aspnet.data.d.ts

Hi!
I am tring to use dx.aspnet.data.js from typescript (Angular 2).
As far as I understand it is needed to create interface definition file - dx.aspnet.data.d.ts
Maybe somebody did it? Or there is some example of using devextreme's aspnet data store from Angular 2?

Throw meaningful error from byKey, insert, update, remove, when key is not specified

Unit tests don't pass with locales which use comma decimal separator

Test Name: FilterExpressionCompilerTypeConversionTests.IntegralFromFloatString

byKey doesn't throw if key is missing

Broken here

Add README.md file

It is necessary to add info about:

• NuGet package.
• Bower package.
• DataSourceLoadOptionsBinder implementation.
• Simple code example on how to use DataSourceLoadOptions in a controller.
• How to use client-side API - DevExpress.data.AspNet.createStore
• Link to Sample project

Migrate the DevExtreme data library Sample project to ASP.NET Core 1.0.0

Now the DevExtreme.AspNet.Data library has several incompatibility issues with the ASP.NET Core 1.0.0 release version.

For instance, the Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult.Success method signature was changed in
this commit and the DevExtreme.AspNet.Data.DataSourceLoadOptionsBinder.BindModelAsync method raises the System.MissingMethodException error.

Add missing trivia to the project

• deal with launchSettings.json
• xUnit runner GUID in xproj
• add global.json
• views web.config for IIS

Time-zone problem when filtering by date

For instance, fitlering by 1/1/2016 produces the following query:

filter=[["OrderDate",">=","2015-12-31T21:00:00.000Z"],"and",["OrderDate","<","2016-01-01T21:00:00.000Z"]]

support $select functionality

Currently the DataSourceLoader does not support the $select functionality. At the minimum, can you please make the following class public so that I can replicate that functionality on my side by using this class?
DevExtreme.AspNet.Data.DataSourceLoadResult

You can see how I'm using that here: https://www.devexpress.com/Support/Center/Question/Details/T430399

Error: Value was either too large or too small for a Decimal

Hallo,

When I get large values (type of double) back from our database, I'm getting the following error:

System.OverflowException: Value was either too large or too small for a Decimal.     
at System.Decimal..ctor(Double value)   
  at System.Double.System.IConvertible.ToDecimal(IFormatProvider provider)     
  at DevExtreme.AspNet.Data.Aggregation.SumAggregator`1.Step(T container, String selector)    
   at DevExtreme.AspNet.Data.Aggregation.AggregateCalculator`1.Step(Object obj, Aggregator`1[] aggregators, String[] selectors) 
       at DevExtreme.AspNet.Data.Aggregation.AggregateCalculator`1.ProcessItem(Object item)
            at DevExtreme.AspNet.Data.Aggregation.AggregateCalculator`1.Run() 
                at DevExtreme.AspNet.Data.DataSourceLoader.Load[T](IQueryable`1 source, DataSourceLoadOptionsBase options)

Regards,
Erik

Questions on dx.aspnet.data.js

1. Does this dx.aspnet.data.js available on npm? similar to devextreme-angular2.
2. Is there a way to pass parameter in GET url? Any documentation available for this?
   pivotStore = DevExpress.data.AspNet.createStore({ "loadUrl": "/Detail/Get", });

dx.aspnet.data.js: in getErrorMessageFromXhr, mime can be null

When request is aborted before respnse is received.

Allow using data sources containing ExpandoObject instances

This feature was requested in the DevExpress support center several times

Make assembly CLS-compliant

Correct a typo

#29 (comment)

Grouping by a certain number of fields (for example, 3) fails with EF

Starting with version 1.2.2, the Load method throws the following exception:

Value cannot be null.
Parameter name: constructor

Please make DataSourceLoadResult public

Please make DataSourceLoadResult a public class so everyone can use it.

In our case it's required to access the result data in order to calculate some properties on the returned objects.

Try add default OrderBy for EF

See http://stackoverflow.com/q/11222694/

Add cache=false to AJAX requests

Reason: https://github.com/DevExpress/DevExtreme.AspNet.TagHelpers/issues/29

Add .jshintrc, and use more strict checks for dx.aspnet.data.js

Add NuGet icon

https://secure.gravatar.com/avatar/abb60c275d6f175df3393a6369988c3a?s=32&r=g

Grouping: NRE when group key is null

Steps:
in Sample site, enable remote grouping and group by ShipRegion

Paging is broken when dxDataGrid is sorted by a column with non-unique values

Once the grid is sorted by a column that has duplicated values, paging works wrong

T454358(new).zip

Allow custom Aggregators/Calculators

I'd like to be able to register my own calculators with your framework. You can see how I'm doing it below. It would be nice if this was incorporated into your library - you can make the changes or allow me to commit.
In DevExtreme.AspNet.Data.Aggregation.AggregateCalculator:

        private static Dictionary<String, Type> customCalculators = new Dictionary<string, Type>();

        public static void registerCustomCalc(String name, Type type)
        {
            customCalculators[name] = type;
        }

        Aggregator<T> CreateAggregator(string summaryType)
        {
            /* existing calculators */

            Type type;
            if (customCalculators.TryGetValue(summaryType, out type))
                return Activator.CreateInstance(type, _accessor) as Aggregator<T>;

            throw new NotSupportedException();
        }

Usage in my service:

DevExtreme.AspNet.Data.Aggregation.AggregateCalculator<PositionModel>.registerCustomCalc("countLS", typeof(CountLSAggregator<PositionModel>));

Then in dxDataGrid:

totalItems: [
                    {
                        column: "Quantity",
                        summaryType: "countLS",
                        alignByColumn: true
                    },
                    . . . 

The "sum" summary is not calculated for the TimeSpan column

See the DataGrid MVC Wrapper - Summary for TimeSpan values is not calculated ticket for details.
T458296.zip

Add DataSourceLoader.Load overload accepting IQueryable

Weird query when using derived types

I've following class setting:

public class Result
{
	public int Value { get; set; }
	public string Name { get; set; }
}	

public class ResultExtended : Result
{
	public int CustomerId { get; set; }
}

When I use following call using the filter option

var query = _provider.Get<Address>()
	.Where(a => a.ID > 10)
	.Select(a => new ResultExtended { CustomerId = a.County, Name = a.City });			

var options = new TestLoadOptions
{
	Skip = 0,
	Take = 10,
	Filter = new List<object> { "Name", "contains", "test" }
};

var result = DataSourceLoader.Load(query, options);

The resulting query looks like
from Address a in Query(CHG.Demo.Objects.Address) where ([a].ID > 10) where new ResultExtended() {CustomerId = [a].County, Name = [a].City}.Name.ToLower().Contains("test") select new ResultExtended() {CustomerId = [a].County, Name = [a].City} => Take(10)

But when I express the same query "directly"

var query = _provider.Get<Address>()
	.Where(a => a.ID > 10)
	.Select(dto => new ResultExtended { CustomerId = dto.County, Name = dto.City })
	.Where(obj => obj.Name.ToLower().Contains("test"))
	.Take(10);

var result = query.ToList();

the resulting query is correct
from Address a in Query(CHG.Demo.Objects.Address) where ([a].ID > 10) where [a].City.ToLower().Contains("test") select new ResultExtended() {CustomerId = [a].County, Name = [a].City} => Take(10)

I guess the expression builder if the DataSourceLoader creates a wrong expression when applying the filter.

Update:
By comparing the two expression trees I found out that the MemberExpression obj.Name are different. The MemberInfo of the first query says that the ReflectedType is ResultExtended, the value for the second query is Result.

So when I call it
var result = DataSourceLoader.Load<Result>(query, options);
the error is gone.

Update DevExtreme to 17.1.4

Reason:

node_modules/devextreme/bundles/dx.all.d.ts(2206,22): error TS2430: Interface 'dxLoadPanelOptions' incorrectly extends interface 'dxOverlayOptions'.
  Types of property 'animation' are incompatible.
    Type 'AnimationOptions' has no properties in common with type '{ show?: AnimationOptions; hide?: AnimationOptions; }'.

https://devexpress.com/issue=T525720

DevExtreme.AspNet.Data returns the response in an incorrect format if the byKey is used

DevExtreme.AspNet.Data of version 1.3.0-rc3 returns the response in a format like {data: [{id: 1, name: "Two"}]} when the byKey method is used. Wrapping the data array into the "data" field leads to nothing being resolved. This breaks DevExtreme lookup editors. See the screencast that illustrates this and the sample project is attached.
WebApplication1.zip

Support sortByGroupSummaryInfo

Hallo,

The dxDataGrid has an option: sortByGroupSummaryInfo. This allows sorting on grouped columns.
Not sure what else to type... if you need more info let me know.

Regards,
Erik

Performance improvements

If the LoadOptions have a single TotalSummary with a "count" aggregate, the DataSourceLoader will execute first a "SELECT Count(*).." statement to get the overall amount of items (required for pagination I guess) and then executes a statement WITHOUT a top/skip because it want's to calculate the summary in memory.

For this case (which very often exists) it could be much better if the summary is not calculated in memory and the already retrieved count value will be used.

DataSourceLoader fails on collections of value types (structures)

[Fact]
public void Test1() {
    DataSourceLoader.Load(
        new[] {
            new KeyValuePair<int, int>(1, 2)
        },
        new SampleLoadOptions {
            Filter = new object[] { "Key", 0 }
        }
    );
}

throws: System.ArgumentNullException: 'Value cannot be null.'

Add default (and customizable) limits for a number of data items in the response

To prevent querying for excessive amounts of data with large or missing take parameter.

[1.2.6] DataSourceLoader with requireTotalCount : true fails

All working fine with 1.2.5, however when upgrading to 1.2.6 count queries fail.
In DataSourceLoader:100
return (int)source.Provider.Execute(builder.BuildCountExpr(source.Expression));
throws something along the lines: cannot convert IEnumerable<int> to IEnumerable<object>

EF6: Remote groups are not ordered

The following query:

var q = _nwind.Orders
    .OrderBy(o => o.Freight)
    .GroupBy(o => new { o.Freight })
    .Select(g => new { g.Key });

is translated into

SELECT 
    [Distinct1].[C1] AS [C1], 
    [Distinct1].[Freight] AS [Freight]
    FROM ( SELECT DISTINCT 
        [Extent1].[Freight] AS [Freight], 
        1 AS [C1]
        FROM [dbo].[Orders] AS [Extent1]
    )  AS [Distinct1]

ordering is lost.

Possible solution: order groups by keys.

Promise rejects are not handled in dx.aspnet.data.js

Provide error helper/logging

I've an error in my setup. The filter criteria does not fit to the queried entity.
Unfortunately the error ("'LeaseState' is not a member of type 'MyEntity'") won't bubble up to the developer. Instead the query will be created with an .Where(false) expression.

In some scenarios no one would even notice there's an error because the grid just shows no data.

Either let the exception (FilterExpressionCompiler.CompileCore) bubble up to the caller or provide any mechanism where the developer can check if any error occurred.