Skip to main content

Kendo MVC Grid DataSourceRequest with AutoMapper

Kendo Grid does not work directly with AutoMapper but could be managed by simple trick using mapping through ToDataSourceResult. The solution works fine until different filters are applied.

The problems occurs because passed filters refer to view model properties where as database model properties are required after AutoMapper is implemented.

So, the plan is to intercept DataSourceRequest  and modify names based on database model. To do that we are going to create implementation of CustomModelBinderAttribute to catch calls and have our own implementation of DataSourceRequestAttribute from Kendo MVC. I will be using same source code from Kendo but will replace column names for different criteria for sort, filters, group etc.

Let's first look into how that will be implemented.

     public ActionResult GetRoles([MyDataSourceRequest(GridId.RolesUserGrid)] DataSourceRequest request)  
     {  
       if (request == null)  
       {  
         throw new ArgumentNullException("request");  
       }  
       return Json(UnitOfWork.RoleRepository.All()  // DB Call
         .ToDataSourceResult(request, data => Mapper.Map<RoleViewModel>(data)), JsonRequestBehavior.AllowGet);  
     }  

As per above example it looks pretty simple to implement. The whole logic and idea is hidden under MyDataSourceRequest and GridId enum. MyDataSourceRequest is a direct implementation of original DataSourceRequest from Kendo MVC but with column name changes.

To know which database model is mapped to which view model. We will have enum for all AJAX grid calls and then through that we will be able to know mapped view model.

KendoHelper.cs
   /// <summary>  
     /// Grid Ids  
     /// </summary>  
     public enum GridId  
     {  
       /// <summary>  
       /// The roles user grid  
       /// </summary>  
       RolesUserGrid,  
     }  
     /// <summary>  
     /// Gets the type of the grid's AutoMapper class.  
     /// </summary>  
     /// <param name="gridId">The grid identifier.</param>  
     /// <returns></returns>  
     public static Type GetGridAutoMapperType(this GridId gridId)  
     {  
       switch (gridId)  
       {  
         case GridId.RolesUserGrid:  
           return typeof(RoleViewModel);  
       }  
       return null;  
     }  

The GetGridAutoMapperType is giving us type for the mapped class. Through this we know that GridId.RolesUserGrid is mapped to RoleViewModel class.

This is the minimum thing required to know the mapping. Now, we need two more things, the original property names by passing view model type from GetGridAutoMapperType and another function to replace view model property names with database model property names.

KendoHelper.cs
 /// <summary>  
     /// Gets the mapped property names from AutoMapper configuration.  
     /// </summary>  
     /// <param name="autoMapperType">Type of the automatic mapper.</param>  
     /// <returns></returns>  
     /// <exception cref="System.ArgumentNullException"><T>;Unable to find given type in AutoMapper.</exception>  
     public static IDictionary<string, string> GetMappedNames(Type autoMapperType)  
     {  
       if (autoMapperType == null)  
       {  
         return null;  
       }  
       var mainItem = Mapper.GetAllTypeMaps().SingleOrDefault(m => m.DestinationType.Equals(autoMapperType));  
       if (mainItem == null)  
       {  
         throw new ArgumentNullException("<T>", "Unable to find given type in AutoMapper.");  
       }  
       return (from prop in mainItem.GetPropertyMaps()  
           where prop != null &&  
           prop.DestinationProperty != null &&  
           prop.SourceMember != null &&  
           prop.DestinationProperty.Name != prop.SourceMember.Name  
           let sourceName = Convert.ToString(prop.CustomExpression.Body)  
           select new  
           {  
             DestinationPropertyName = prop.DestinationProperty.Name,  
             SourceMemberName = (sourceName != null ? sourceName.Remove(0, String.Join(String.Empty,  
             prop.CustomExpression.Parameters.Select(p => p.Name)).Length + 1) : prop.SourceMember.Name)  
           }).ToDictionary(prop => prop.DestinationPropertyName, prop => prop.SourceMemberName);  
     }  
     /// <summary>  
     /// Gets the name of the mapped property.  
     /// </summary>  
     /// <param name="value">The value.</param>  
     /// <param name="mappedProperties">The mapped properties.</param>  
     /// <param name="isReverse">if set to <c>true</c> reverse mapping.</param>  
     /// <returns>Mapped property for given value</returns>  
     public static string GetMappedName(this string value, IDictionary<string, string> mappedProperties,  
       bool isReverse = false)  
     {  
       if (String.IsNullOrEmpty(value) ||  
         mappedProperties == null || mappedProperties.Count == 0)  
       {  
         return value;  
       }  
       var mappedPropertyValue = value;  
       foreach (var mappedproperty in mappedProperties)  
       {  
         var dicKey = isReverse ? mappedproperty.Value : mappedproperty.Key;  
         var dicValue = isReverse ? mappedproperty.Key : mappedproperty.Value;  
         var regex = new Regex(String.Format(@"\b{0}\b", dicKey));  
         if (regex.IsMatch(dicKey))  
         {  
           mappedPropertyValue = regex.Replace(mappedPropertyValue, dicValue);  
         }  
       }  
       return mappedPropertyValue;  
     }  

With GetMappedNames function we can get properties names from database model and view model. The GetMappedName helper method would help us to replace string on model.

These are all helper methods we need, we can start creating attribute and own implementation of DataSourceRequest.

MyDataSourceRequestAttribute.cs
 /// <summary>  
   /// Custom data source request attribute  
   /// </summary>  
   public class MyDataSourceRequestAttribute  
     : CustomModelBinderAttribute  
   {  
     /// <summary>  
     /// Gets or sets the prefix.  
     /// </summary>  
     /// <value>  
     /// The prefix.  
     /// </value>  
     public string Prefix { get; set; }  
     /// <summary>  
     /// Gets or sets the grid identifier.  
     /// </summary>  
     /// <value>  
     /// The grid identifier.  
     /// </value>  
     public GridId? GridUniqueId { get; set; }  
     /// <summary>  
     /// Initializes a new instance of the <see cref="MyDataSourceRequestAttribute"/> class.  
     /// </summary>  
     public MyDataSourceRequestAttribute()  
     {  
     }  
     /// <summary>  
     /// Initializes a new instance of the <see cref="MyDataSourceRequestAttribute"/> class.  
     /// </summary>  
     /// <param name="gridId">The grid identifier.</param>  
     public MyDataSourceRequestAttribute(GridId gridId)  
     {  
       GridUniqueId = gridId;  
     }  
     /// <summary>  
     /// Retrieves the associated model binder.  
     /// </summary>  
     /// <returns>  
     /// A reference to an object that implements the <see cref="T:System.Web.Mvc.IModelBinder" /> interface.  
     /// </returns>  
     public override IModelBinder GetBinder()  
     {  
       var dataSourceRequestModelBinder = new MyDataSourceRequestModelBinder(GridUniqueId);  
       dataSourceRequestModelBinder.Prefix = this.Prefix;  
       return dataSourceRequestModelBinder;  
     }  
   }  

The above attribute is pretty simple takes GridId and pass it to MyDataSourceRequestModelBinder. This is the model binder which will consume our helper classes and replace property names.

MyDataSourceRequestModelBinder.cs
   /// <summary>  
   /// Custom DataSourceRequestModelBinder to handle AutoMapper mappings  
   /// </summary>  
   public class MyDataSourceRequestModelBinder  
     : IModelBinder  
   {  
     /// <summary>  
     /// Initializes a new instance of the <see cref="MyDataSourceRequestModelBinder"/> class.  
     /// </summary>  
     /// <param name="gridId">The grid identifier.</param>  
     public MyDataSourceRequestModelBinder(GridId? gridId)  
     {  
       GridUniqueId = gridId;  
     }  
     /// <summary>  
     /// Gets or sets the prefix.  
     /// </summary>  
     /// <value>  
     /// The prefix.  
     /// </value>  
     public string Prefix { get; set; }  
     /// <summary>  
     /// Gets or sets the grid identifier.  
     /// </summary>  
     /// <value>  
     /// The grid identifier.  
     /// </value>  
     public GridId? GridUniqueId { get; set; }  
     /// <summary>  
     /// Gets or sets the mapped properties.  
     /// </summary>  
     /// <value>  
     /// The mapped properties.  
     /// </value>  
     private IDictionary<string, string> MappedProperties { get; set; }  
     /// <summary>  
     /// Binds the model to a value by using the specified controller context and binding context.  
     /// </summary>  
     /// <param name="controllerContext">The controller context.</param>  
     /// <param name="bindingContext">The binding context.</param>  
     /// <returns>  
     /// The bound value.  
     /// </returns>  
     public object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)  
     {  
       if (!GridUniqueId.HasValue)  
       {  
         DataSourceRequestModelBinder kendoDataRequestBinder = new DataSourceRequestModelBinder();  
         return kendoDataRequestBinder.BindModel(controllerContext, bindingContext);  
       }  
       MappedProperties = GridUniqueId.Value.GetMappedPropertyNames();  
       string sorts;  
       string groups;  
       string filters;  
       string aggregates;  
       int pageIndex;  
       int pageSize;  
       DataSourceRequest dataSourceRequest = new DataSourceRequest();  
       if (this.TryGetValue<string>(bindingContext, GridUrlParameters.Sort, out sorts))  
       {  
         dataSourceRequest.Sorts = GridDescriptorSerializer.  
           Deserialize<SortDescriptor>(sorts.GetMappedName(MappedProperties));  
       }  
       if (this.TryGetValue<int>(bindingContext, GridUrlParameters.Page, out pageIndex))  
       {  
         dataSourceRequest.Page = pageIndex;  
       }  
       if (this.TryGetValue<int>(bindingContext, GridUrlParameters.PageSize, out pageSize))  
       {  
         dataSourceRequest.PageSize = pageSize;  
       }  
       if (this.TryGetValue<string>(bindingContext, GridUrlParameters.Filter, out filters))  
       {  
         dataSourceRequest.Filters = FilterDescriptorFactory.Create(filters.GetMappedName(MappedProperties));  
       }  
       if (this.TryGetValue<string>(bindingContext, GridUrlParameters.Group, out groups))  
       {  
         dataSourceRequest.Groups = GridDescriptorSerializer.  
           Deserialize<GroupDescriptor>(groups.GetMappedName(MappedProperties));  
       }  
       if (this.TryGetValue<string>(bindingContext, GridUrlParameters.Aggregates, out aggregates))  
       {  
         dataSourceRequest.Aggregates = GridDescriptorSerializer.  
           Deserialize<AggregateDescriptor>(aggregates.GetMappedName(MappedProperties));  
       }  
       return dataSourceRequest;  
     }  
     /// <summary>  
     /// Tries to get the value and typecast.  
     /// </summary>  
     /// <typeparam name="T"></typeparam>  
     /// <param name="bindingContext">The binding context.</param>  
     /// <param name="key">The key.</param>  
     /// <param name="result">The result.</param>  
     /// <returns>Typecasted value</returns>  
     private bool TryGetValue<T>(ModelBindingContext bindingContext, string key, out T result)  
     {  
       if (this.Prefix.HasValue())  
       {  
         key = string.Concat(this.Prefix, "-", key);  
       }  
       ValueProviderResult value = bindingContext.ValueProvider.GetValue(key);  
       if (value == null)  
       {  
         result = default(T);  
         return false;  
       }  
       result = (T)value.ConvertTo(typeof(T));  
       return true;  
     }  
   }  

The entire source code of MyDataSourceRequestModelBinder is taken from original Kendo MVC binder. The only part that has been modified is for replacing property names by using created helper methods GridUniqueId.Value.GetMappedPropertyNames() and GetMappedName(MappedProperties) to restore it to correct value.

NOTE: This is compatible with Storing and restoring Kendo Grid state from Database. Just we need to implement described approach in it.

Update: AutoMapper Linq Projection implementation for avoiding getting all tuples from row.

Comments

Popular posts from this blog

Elegantly dealing with TimeZones in MVC Core / WebApi

In any new application handling TimeZone/DateTime is mostly least priority and generally, if someone is concerned then it would be handled by using DateTime.UtcNow on codes while creating current dates and converting incoming Date to UTC to save on servers. Basically, the process is followed by saving DateTime to UTC format in a database and keep converting data to native format based on user region or single region in the application's presentation layer. The above is tedious work and have to be followed religiously. If any developer misses out the manual conversion, then that area of code/view would not work. With newer frameworks, there are flexible ways to deal/intercept incoming or outgoing calls to simplify conversion of TimeZones. These are steps/process to achieve it. 1. Central code for storing user's state about TimeZone. Also, central code for conversion logic based on TimeZones. 2. Dependency injection for the above class to ...

Making FluentValidation compatible with Swagger including Enum or fixed List support

FluentValidation is not directly compatible with Swagger API to validate models. But they do provide an interface through which we can compose Swagger validation manually. That means we look under FluentValidation validators and compose Swagger validator properties to make it compatible. More of all mapping by reading information from FluentValidation and setting it to Swagger Model Schema. These can be done on any custom validation from FluentValidation too just that proper schema property has to be available from Swagger. Custom validation from Enum/List values on FluentValidation using FluentValidation.Validators; using System.Collections.Generic; using System.Linq; using static System.String; /// <summary> /// Validator as per list of items. /// </summary> /// <seealso cref="PropertyValidator" /> public class FixedListValidator : PropertyValidator { /// <summary> /// Gets the valid items /// <...

Architecture solution composting Repository Pattern, Unit Of Work, Dependency Injection, Factory Pattern and others

Project architecture is like garden, we plant the things in certain order and eventually they grow in similar manner. If things are planted well then they will all look(work) great and easier to manage. If they grow as cumbersome it would difficult to maintain and with time more problems would be happening in maintenance. There is no any fixed or known approach to decide project architecture and specially with Agile Methodology. In Agile Methodology, we cannot predict how our end products will look like similarly we cannot say a certain architecture will fit well for entire development lifespan for project. So, the best thing is to modify the architecture as per our application growth. I understand that it sounds good but will be far more problematic with actual development. If it is left as it is then more problems will arise with time. Just think about moving plant vs a full grown tree. Coming to technical side, In this article, I will be explaining about the various techniques ...

Handling JSON DateTime format on Asp.Net Core

This is a very simple trick to handle JSON date format on AspNet Core by global settings. This can be applicable for the older version as well. In a newer version by default, .Net depends upon Newtonsoft to process any JSON data. Newtonsoft depends upon Newtonsoft.Json.Converters.IsoDateTimeConverter class for processing date which in turns adds timezone for JSON data format. There is a global setting available for same that can be adjusted according to requirement. So, for example, we want to set default formatting to US format, we just need this code. services.AddMvc() .AddJsonOptions(options => { options.SerializerSettings.DateTimeZoneHandling = "MM/dd/yyyy HH:mm:ss"; });

Using Redis distributed cache in dotnet core with helper extension methods

Redis cache is out process cache provider for a distributed environment. It is popular in Azure Cloud solution, but it also has a standalone application to operate upon in case of small enterprises application. How to install Redis Cache on a local machine? Redis can be used as a local cache server too on our local machines. At first install, Chocolatey https://chocolatey.org/ , to make installation of Redis easy. Also, the version under Chocolatey supports more commands and compatible with Official Cache package from Microsoft. After Chocolatey installation hit choco install redis-64 . Once the installation is done, we can start the server by running redis-server . Distributed Cache package and registration dotnet core provides IDistributedCache interface which can be overrided with our own implementation. That is one of the beauties of dotnet core, having DI implementation at heart of framework. There is already nuget package available to override IDistributedCache i...

Using LINQ to Entity efficiently with First/FirstOrDefault/Last/LastOrDefault/Single/SingleOrDefault

We generally use these extension methods First/FirstOrDefault/Last/LastOrDefault/Single/SingleOrDefault with predicates like ctx=> ctx.Model.FirstOrDefault(item => item.Id == 1 ) Or ctx=> ctx.Model.Where(item => item.Id == 1 ).FirstOrDefault() What is the problem with these? FirstOrDefault or similar methods immediately loads all data at once. So, let's say we have fifty columns on table then all those columns data would be retrieved from DB and saved into memory. This link gives a fair idea of different function behavior.  https://msdn.microsoft.com/en-us/library/bb882641.aspx .  So, even if we require only one value from selected field it retrieves all values. What is the solution? The solution is pretty simple. Whenever we need selected items better to do projection before calling FirstOrDefault or similar methods. Ex: Selecting single item ctx.Model.Where(itm => itm.Id == 1) .Select(itm => itm.Name).FirstO...

Visual Studio 2015 Code Analyzer and configuration with StyleCop

What is Diagnostic/Code Analyzer? To put it simply it is something similar to Resharper or Telerik JustCode. It analyzes codes while writing on code editor and suggest for improvements of codes through Squiggles, light icon and based on various severity. How it works? I had mentioned that it is similar to Resharper and Telerik JustCode but internal infrastructure is completely different. It is dependent on new compiler Roslyn . Roslyn has a clever compile technique, unlike older version which makes it faster and flexible for dynamic compilation without the need of the entire code base. The structure is basically divided into two categories Syntax Tree , and Semantic Model . The syntax tree is related to syntaxes only it does not require any reference check. It can be related to DOM elements structure in case of HTML.  Syntax Tree consists of very fine details as simple as WhiteSpace under the code. The Semantic Model is kind of references of Syntax Tree in which it ...

MongoDB navigation property or making it behave as ORM in .Net

This is an implementation to make models to have  navigation properties work like ORM does for us. What actually happens in ORM to make navigation properties work? Entity Framework has proxy classes implementation to allow lazy loading and eager loading implementation. While creating proxy classes it also changes definitions for actual classes to make navigation properties work to get values based on Model's for navigation properties. Most of ORMs work in same fashion like Telerik DataAccess has enhancer tool which changes class definition at compile time to enable navigation properties. In this implementation, we would retain the original class but we would have extension methods to allow initializing properties to have navigation proprieties work. Let's first create desire model on which we need to implement. I am picking up simple one-to-many relationship example from Person to Address. public class Person { public int PersonId { get; set; } ...

Configuring Ninject, Asp.Net Identity UserManager, DataProtectorTokenProvider with Owin

It can be bit tricky to configure both Ninject and Asp.Net Identity UserManager if some value is expected from DI to configure UserManager. We will look into configuring both and also use OwinContext to get UserManager. As usual, all configuration need to be done on Startup.cs. It is just a convention but can be used with different name, the important thing is to decorate class with following attribute to make it Owin start-up: [assembly: OwinStartup(typeof(MyProject.Web.Startup))] Ninject configuration Configuring Ninject kernel through method which would be used to register under Owin. Startup.cs public IKernel CreateKernel() { var kernel = new StandardKernel(); try { //kernel.Bind<IHttpModule>().To<HttpApplicationInitializationHttpModule>(); // TODO: Put any other injection which are required. return kernel; } catch { kernel.Dispose(); thro...