Skip to main content

Strong typed MVC routing on TypeScript/JavaScript

Very often we mess up with routing by giving path which does not exist due to various reason like spelling mistake, name confusions etc. for forming correct URLs . This happens on both server side codes and client side code. There are few strong typed routing provider library present for server side but none is present on the client side.

We will look into creating a classes and function to set up our routing paths which will help us to give correct URL based on MVC routing.
The idea is to create T4 template file which will be generating client side codes based on MVC routing.

I have tried to keep it simple in this version which reads up MVC controllers and public function.

The end result looks like this, which is TypeScript code. Makes it pretty simple to use these classes directly without worrying about correct URLs.

 module Routing {  
   export declare var DomainName: string;  
   export function GetDomainName(): string {  
     return (DomainName != undefined && DomainName.length) ?  
       (DomainName.lastIndexOf("/") == -1 ? DomainName + "/" : DomainName)  
       : "";  
   }  
   // Routing for Web.Controllers.TestController  
   export class TestRoute {  
         static TestConfiguration() : string  
     {  
       return GetDomainName() + "Test/" + "QuestionConfiguration";  
     }  
     static GetAnswerTypes() : string  
     {  
       return GetDomainName() + "Test/" + "GetAnswerTypes";  
     }  
     static GetCascadeValues() : string  
     {  
       return GetDomainName() + "Test/" + "GetCascadeValues";  
     }  
   }  
 }  

The DomainName variable can be initialized out of the class to get full path for URLs.
Ex:
 Routing.DomainName = '@MvcApplication.WebsiteDomainName';  

Let's look into T4 template, which generates above code.

 <#@ template debug="true" hostSpecific="true" #>  
 <#@ assembly name="System.Core" #>  
 <#@ Assembly Name="EnvDTE" #>  
 <#@ import namespace="EnvDTE" #>  
 <#@ import namespace="System.Linq" #>  
 <#@ import namespace="System.Text" #>  
 <#@ import namespace="System.Collections.Generic" #>  
 <#@ output extension=".ts" #>  
 module Routing {  
   export declare var DomainName: string;  
   export function GetDomainName(): string {  
     return (DomainName != undefined && DomainName.length) ?  
       (DomainName.lastIndexOf("/") == -1 ? DomainName + "/" : DomainName)  
       : "";  
   }  
 <#  
   // TODO: Give any controllers which need to be avoided.  
   var avoidClassNames = new List<string>{"BaseController"};  
   // TODO: Function names to avoid in code generation.  
   var avoidFunctionNames = new List<string>();  
   var env = (DTE)((IServiceProvider)this.Host)  
     .GetService(typeof(EnvDTE.DTE));  
   var project = env.ActiveDocument.ProjectItem.ContainingProject;  
   foreach(CodeClass clas in   
     GetAllCodeElementsOfType(project.CodeModel.CodeElements,EnvDTE.vsCMElement.vsCMElementClass,false)  
     .OfType<CodeClass>()  
     .Where(cc => cc.IsDerivedFrom["System.Web.Mvc.Controller"] &&  
         !avoidClassNames.Contains(cc.Name)  
       )  
     )  
   {  
     var clasName = clas.Name.Substring(0, clas.Name.Length-10);  
     #>  
   // Routing for <#= clas.FullName #>  
   export class <#=      clasName #>Route {  
     <#  
     var allFunctions = GetAllCodeElementsOfType(clas.Members, EnvDTE.vsCMElement.vsCMElementFunction, false);  
         foreach(var funcName in allFunctions.OfType<CodeFunction>()  
             .Where(fun => fun.Access == EnvDTE.vsCMAccess.vsCMAccessPublic &&   
               fun.Name != clas.Name &&  
               !avoidFunctionNames.Contains(fun.Name)  
             )          
             .Select(fun=>fun.Name).Distinct()  
           )          
     {  
 #>  
     static <#=funcName #>() : string  
     {  
       return GetDomainName() + "<#=clasName #>/" + "<#=funcName #>";  
     }  
 <#  
     }  
     #>  
   }  
 <#  
   }  
     #>  
 }  
 <#+  
   // https://github.com/PombeirP/T4Factories/blob/master/T4Factories.Testbed/CodeTemplates/VisualStudioAutomationHelper.ttinclude  
   // This function is from Tangible T4. All credit goes to them  
   public List<EnvDTE.CodeElement> GetAllCodeElementsOfType(EnvDTE.CodeElements elements, EnvDTE.vsCMElement elementType, bool includeExternalTypes)  
   {  
     var ret = new List<EnvDTE.CodeElement>();  
     foreach (EnvDTE.CodeElement elem in elements)  
     {  
       // iterate all namespaces (even if they are external)  
       // > they might contain project code  
       if (elem.Kind == EnvDTE.vsCMElement.vsCMElementNamespace)  
       {  
         ret.AddRange(GetAllCodeElementsOfType(((EnvDTE.CodeNamespace)elem).Members, elementType, includeExternalTypes));  
       }  
         // if its not a namespace but external  
         // > ignore it  
       else if (elem.InfoLocation == EnvDTE.vsCMInfoLocation.vsCMInfoLocationExternal  
         && !includeExternalTypes)  
         continue;  
         // if its from the project  
         // > check its members  
       else if (elem.IsCodeType)  
       {  
         ret.AddRange(GetAllCodeElementsOfType(((EnvDTE.CodeType)elem).Members, elementType, includeExternalTypes));  
       }  
       // if this item is of the desired type  
       // > store it  
       if (elem.Kind == elementType)  
         ret.Add(elem);  
     }  
     return ret;  
   }  
  #>  

Mark that avoidClassNames and avoidFunctionNames is used to avoid classes and function which we want to avoid in generation of codes. In my case, class named with BaseController.

There are few things which are not supported in this version:
1. Attribute routing of MVC.
2. WebApi routing.

Note: GetAllCodeElementsOfType is taken from https://github.com/PombeirP/T4Factories/blob/master/T4Factories.Testbed/CodeTemplates/VisualStudioAutomationHelper.ttinclude 
.


Comments

Popular posts from this blog

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 /// <...

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 ...

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...

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 Argume...

LDAP with ASP.Net Identity Core in MVC with project.json

Lightweight Directory Access Protocol (LDAP), the name itself explain it. An application protocol used over an IP network to access the distributed directory information service. The first and foremost thing is to add references for consuming LDAP. This has to be done by adding reference from Global Assembly Cache (GAC) into project.json "frameworks": { "net461": { "frameworkAssemblies": { "System.DirectoryServices": "4.0.0.0", "System.DirectoryServices.AccountManagement": "4.0.0.0" } } }, These  System.DirectoryServices  and  System.DirectoryServices.AccountManagement  references are used to consume LDAP functionality. It is always better to have an abstraction for irrelevant items in consuming part. For an example, the application does not need to know about PrincipalContext or any other dependent items from those two references to make it extensible. So, we can begin wi...

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"; });

Custom SPA engine, similar to MVC pattern by using TypeScript

Single Page Application, a fundamental requirement for SPA is to develop the application with XMLHttpRequest (XHR) or AJAX. That is only main requirement, other things come as add-on stuff. Advancements of SPA? In today's world, we do not want to be restricted with basic features or functionalities. We want everything like any new Phone comes in market with some new shiny feature. There are a lot of functionalities available with SPA libraries and could be extended with more extension to have richer and easier implementation. To be specific we shall refer it as frameworks, not libraries. Earlier days one-way, two-way data binding with templates were very minimum things to expect from frameworks. Now they talk about component structure, Virtual Dom, IOC, state management, performance etc. Why building own framework/library? What I believe and experienced is each SPA JS Frameworks has its own set of rules and structure that has to be followed. If we want to have our own dyn...

Trim text in MVC Core through Model Binder

Trimming text can be done on client side codes, but I believe it is most suitable on MVC Model Binder since it would be at one place on infrastructure level which would be free from any manual intervention of developer. This would allow every post request to be processed and converted to a trimmed string. Let us start by creating Model binder using Microsoft.AspNetCore.Mvc.ModelBinding; using System; using System.Threading.Tasks; public class TrimmingModelBinder : IModelBinder { private readonly IModelBinder FallbackBinder; public TrimmingModelBinder(IModelBinder fallbackBinder) { FallbackBinder = fallbackBinder ?? throw new ArgumentNullException(nameof(fallbackBinder)); } public Task BindModelAsync(ModelBindingContext bindingContext) { if (bindingContext == null) { throw new ArgumentNullException(nameof(bindingContext)); } var valueProviderResult = bindingContext.ValueProvider.GetValue(bin...

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 ...

Data seed for the application with EF, MongoDB or any other ORM.

Most of ORMs has moved to Code first approach where everything is derived/initialized from codes rather than DB side. In this situation, it is better to set data through codes only. We would be looking through simple technique where we would be Seeding data through Codes. I would be using UnitOfWork and Repository pattern for implementing Data Seeding technique. This can be applied to any data source MongoDB, EF, or any other ORM or DB. Things we would be doing. - Creating a base class for easy usage. - Interface for Seed function for any future enhancements. - Individual seed classes. - Configuration to call all seeds. - AspNet core configuration to Seed data through Seed configuration. Creating a base class for easy usage public abstract class BaseSeed<TModel> where TModel : class { protected readonly IMyProjectUnitOfWork MyProjectUnitOfWork; public BaseSeed(IMyProjectUnitOfWork MyProjectUnitOfWork) { ...