Skip to main content

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 be able to use globally.
3. Creating Model Binder to convert all incoming DateTime to UTC format automatically.
4. Modifying JSON serializer to parse UTC to User's local time zone.
5. Register ModelBinder and JSON Converter on Startup
6. MVC Views using @inject keyword to get the class and convert to Native timezone.
7. A client side TimeZone detection technique to prompt the user to change TimeZone and save data into the persistent layer. [Not covered]  

1. Class to save current TimeZone for user and conversion logic. 

This class is responsible for holding the value of User's timezone, and date format. Also at this place codes are written to convert Universal time to local or vice-versa to be consistent. For any DateTime conversion related to user this class would be used, for the same reason Dependency Injection has to be implemented.

 using System;  
 /// <summary>  
 /// User's culture information.  
 /// </summary>  
 public class UserCultureInfo  
 {  
   /// <summary>  
   /// Initializes a new instance of the <see cref="UserCultureInfo"/> class.  
   /// </summary>  
   public UserCultureInfo()  
   {  
     // TODO: Need to through DB Context.  
     TimeZone = TimeZoneInfo.FindSystemTimeZoneById("India Standard Time");  
     DateTimeFormat = "M/d/yyyy h:m:ss tt"; // Default format.  
   }  
   /// <summary>  
   /// Gets or sets the date time format.  
   /// </summary>  
   /// <value>  
   /// The date time format.  
   /// </value>  
   public string DateTimeFormat { get; set; }  
   /// <summary>  
   /// Gets or sets the time zone.  
   /// </summary>  
   /// <value>  
   /// The time zone.  
   /// </value>  
   public TimeZoneInfo TimeZone { get; set; }  
   /// <summary>  
   /// Gets the user local time.  
   /// </summary>  
   /// <returns></returns>  
   public DateTime GetUserLocalTime()  
   {  
     return TimeZoneInfo.ConvertTime(DateTime.UtcNow, TimeZone);  
   }  
   /// <summary>  
   /// Gets the UTC time.  
   /// </summary>  
   /// <param name="datetime">The datetime.</param>  
   /// <returns>Get universal date time based on User's Timezone</returns>  
   public DateTime GetUtcTime(DateTime datetime)  
   {  
     return TimeZoneInfo.ConvertTime(datetime, TimeZone).ToUniversalTime();  
   }  
 }  

The class is plain and self-explanatory to understand. On this place, we should get user's TimeZone population through Database or any other persistent medium like Cookie/Session.

2. Dependency Injection for UserCultureInfo on Startup.cs

This would allow us to get the class throughout the application and same would be used on View to convert date time.
 services.AddScoped<UserCultureInfo>();  

3. Model Binder for DateTime

This would be divided into several classed/tasks to create and register model binder for DateTime. This would be responsible for collecting all incoming DateTime data and converting to UTC format. With this approach, developers do not have to manually convert DateTime data to UTC format while saving into the database.

DateTime binder 

It tries to get DateTime and convert to UTC format through UserCultureInfo class if unsuccessful generates model state error. I have not spent much time on ModelState error generation part which can be improved.

 using Microsoft.AspNetCore.Mvc.Internal;  
 using Microsoft.AspNetCore.Mvc.ModelBinding;  
 using System;  
 using System.Globalization;  
 using System.Threading.Tasks;  
 /// <summary>  
 /// Date time model binder.  
 /// </summary>  
 /// <seealso cref="IModelBinder" />  
 public class DateTimeBinder  
     : IModelBinder  
 {  
   /// <summary>  
   /// The user culture  
   /// </summary>  
   protected readonly UserCultureInfo UserCulture;  
   /// <summary>  
   /// Initializes a new instance of the <see cref="DateTimeBinder"/> class.  
   /// </summary>  
   /// <param name="userCulture">The user culture.</param>  
   public DateTimeBinder(UserCultureInfo userCulture)  
   {  
     UserCulture = userCulture;  
   }  
   public Task BindModelAsync(ModelBindingContext bindingContext)  
   {  
     if (bindingContext == null)  
     {  
       throw new ArgumentNullException(nameof(bindingContext));  
     }  
     var valueProviderResult = bindingContext.ValueProvider  
       .GetValue(bindingContext.ModelName);  
     if (string.IsNullOrEmpty(valueProviderResult.FirstValue))  
     {  
       return null;  
     }  
     DateTime datetime;  
     if (DateTime.TryParse(valueProviderResult.FirstValue, null, DateTimeStyles.AdjustToUniversal, out datetime))  
     {  
       bindingContext.Result =  
           ModelBindingResult.Success(UserCulture.GetUtcTime(datetime));  
     }  
     else  
     {  
       // TODO: [Enhancement] Could be implemented in better way.  
       bindingContext.ModelState.TryAddModelError(  
           bindingContext.ModelName,  
           bindingContext.ModelMetadata  
           .ModelBindingMessageProvider.AttemptedValueIsInvalidAccessor(  
             valueProviderResult.ToString(), nameof(DateTime)));  
     }  
     return TaskCache.CompletedTask;  
   }  
 }  

DateTime Binder Provider

Registers model binder against DateTime data type.

 using Microsoft.AspNetCore.Mvc.ModelBinding;  
 using ProjecTales.Web.Infrastructure.Globalization;  
 using System;  
 /// <summary>  
 /// <see cref="DateTimeBinder"/> provider.  
 /// </summary>  
 /// <seealso cref="IModelBinderProvider" />  
 public class DateTimeBinderProvider  
     : IModelBinderProvider  
 {  
   /// <summary>  
   /// The user culture  
   /// </summary>  
   protected readonly Func<UserCultureInfo> UserCulture;  
   /// <summary>  
   /// Initializes a new instance of the <see cref="DateTimeBinderProvider"/> class.  
   /// </summary>  
   /// <param name="userCulture">The user culture.</param>  
   public DateTimeBinderProvider(Func<UserCultureInfo> userCulture)  
   {  
     UserCulture = userCulture;  
   }  
   /// <summary>  
   /// Creates a <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder" /> based on <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext" />.  
   /// </summary>  
   /// <param name="context">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.ModelBinderProviderContext" />.</param>  
   /// <returns>  
   /// An <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder" />.  
   /// </returns>  
   /// <exception cref="System.ArgumentNullException">context</exception>  
   public IModelBinder GetBinder(ModelBinderProviderContext context)  
   {  
     if (context == null)  
     {  
       throw new ArgumentNullException(nameof(context));  
     }  
     if (context.Metadata.UnderlyingOrModelType == typeof(DateTime))  
     {  
       return new DateTimeBinder(UserCulture());  
     }  
     return null; // TODO: Find alternate.  
   }  
 }  

Initialize Binder through extension method

DateTimeBinderProviderExtension.cs

 using Microsoft.AspNetCore.Mvc;  
 using Microsoft.Extensions.DependencyInjection;  
 using System;  
 /// <summary>  
 /// <see cref="DateTimeBinderProvider"/> initializer  
 /// </summary>  
 public static class DateTimeBinderProviderExtension  
 {  
   /// <summary>  
   /// Registers the date time provider.  
   /// </summary>  
   /// <param name="option">The option.</param>  
   /// <param name="serviceCollection">The service collection.</param>  
   /// <returns></returns>  
   /// <exception cref="System.ArgumentNullException">option</exception>  
   public static MvcOptions RegisterDateTimeProvider(this MvcOptions option,  
     IServiceCollection serviceCollection)  
   {  
     if (option == null)  
     {  
       throw new ArgumentNullException(nameof(option));  
     }  
     // TODO: BuildServiceProvider could be optimized
     option.ModelBinderProviders.Insert(0, new DateTimeBinderProvider(  
       () => serviceCollection.BuildServiceProvider().GetService<UserCultureInfo>()  
       ));  
     return option;  
   }  
 }  


The registration of this extension method would be shown later on Startup.cs.

4. JSON Converter to help while doing serialization

More of all this acts like Model Binder but just to return values from web server to client, through WebApi JSON serialization settings.

DateTimeConverter .cs

 using Newtonsoft.Json;  
 using Newtonsoft.Json.Converters;  
 using ProjecTales.Web.Infrastructure.Globalization;  
 using System;  
 /// <summary>  
 /// JSON Date time converter.  
 /// </summary>  
 /// <seealso cref="DateTimeConverterBase" />  
 public class DateTimeConverter  
 : DateTimeConverterBase  
 {  
   /// <summary>  
   /// The user culture  
   /// </summary>  
   protected readonly Func<UserCultureInfo> UserCulture;  
   /// <summary>  
   /// Initializes a new instance of the <see cref="DateTimeConverter"/> class.  
   /// </summary>  
   /// <param name="userCulture">The user culture.</param>  
   public DateTimeConverter(Func<UserCultureInfo> userCulture)  
   {  
     UserCulture = userCulture;  
   }  
   /// <summary>  
   /// Determines whether this instance can convert the specified object type.  
   /// </summary>  
   /// <param name="objectType">Type of the object.</param>  
   /// <returns>  
   /// <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.  
   /// </returns>  
   public override bool CanConvert(Type objectType)  
   {  
     return objectType == typeof(DateTime) || objectType == typeof(DateTime?);  
   }  
   /// <summary>  
   /// Reads the JSON representation of the object.  
   /// </summary>  
   /// <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader" /> to read from.</param>  
   /// <param name="objectType">Type of the object.</param>  
   /// <param name="existingValue">The existing value of object being read.</param>  
   /// <param name="serializer">The calling serializer.</param>  
   /// <returns>  
   /// The object value.  
   /// </returns>  
   /// <exception cref="System.NotImplementedException"></exception>  
   public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)  
   {  
     throw new NotImplementedException();  
   }  
   /// <summary>  
   /// Writes the JSON representation of the object.  
   /// </summary>  
   /// <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter" /> to write to.</param>  
   /// <param name="value">The value.</param>  
   /// <param name="serializer">The calling serializer.</param>  
   public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)  
   {  
     // Null are already filtered  
     var userCulture = UserCulture();  
     writer.WriteValue(TimeZoneInfo.ConvertTime(Convert.ToDateTime(value), userCulture.TimeZone)  
     .ToString(userCulture.DateTimeFormat));  
     writer.Flush();  
   }  
 }  

DateTimeConverterExtension.cs
 using Microsoft.AspNetCore.Mvc;  
 using Microsoft.Extensions.DependencyInjection;  
   /// <summary>  
   /// <see cref="DateTimeConverter"/> initializer.  
   /// </summary>  
   public static class DateTimeConverterExtension  
   {  
     /// <summary>  
     /// Registers the date time converter.  
     /// </summary>  
     /// <param name="option">The option.</param>  
     /// <param name="serviceCollection">The service collection.</param>  
     /// <returns></returns>  
     public static MvcJsonOptions RegisterDateTimeConverter(this MvcJsonOptions option,  
       IServiceCollection serviceCollection)  
     {  
       // TODO: BuildServiceProvider could be optimized  
       option.SerializerSettings.Converters.Add(  
           new DateTimeConverter(() => serviceCollection.BuildServiceProvider().GetService<UserCultureInfo>())  
           );  
       return option;  
     }  
   }  

5. Register Model binder and JSON converter on Startup.cs

Through both extension classes, JSON Converter and model binder are registered in a much simpler manner.

 services.AddMvc(option =>  
         option.RegisterDateTimeProvider(services))  
       .AddJsonOptions(jsonOption =>  
         jsonOption.RegisterDateTimeConverter(services));  

6. Controller and view to test Approach

TestController.cs

   public class TestModel  
   {  
     public int Id { get; set; }  
     public DateTime Date { get; set; }  
     public DateTime? NullableDate { get; set; }  
   }  
   public class TestController : Controller  
   {  
     // GET: /<controller>/  
     public IActionResult Index()  
     {  
       return View();  
     }  
     [HttpPost]  
     public IActionResult Index(TestModel model)  
     {  
       return View(model);  
     }  
     public IActionResult Json()  
     {  
       return Json(new TestModel  
       {  
         Id = 1,  
         Date = DateTime.UtcNow,  
         NullableDate = null,  
       });  
     }  
   }  

Index and Json actions can be directly tested. 


Views/Test.cshtml

 @model MyProject.Web.Controllers.TestModel  
 @inject MyProject.Web.Infrastructure.Globalization.UserCultureInfo culture;  
 @{  
   Layout = null;  
 }  
 <form asp-action="Index" asp-controller="Test">  
   <label asp-for="@Model.Id" /><br />  
   <input asp-for="@Model.Id" value="1276"/>  
   <label asp-for="@Model.Date" /><br />  
   <input asp-for="@Model.Date" value="@culture.GetUserLocalTime()" />  
   <label asp-for="@Model.NullableDate" /><br />  
   <input asp-for="@Model.NullableDate" value="@culture.GetUserLocalTime()" /><br />  
   <input type="submit"/>  
 </form>  


GetUserLocalTime has to be on Views whenever accessing anything related to DateTime to convert based on user's local TimeZone. Since there are not many ways to handle this it seems to be a clean approach.

Comments

  1. Hello!

    .net Core 2.2

    serviceCollection.BuildServiceProvider()

    CS1061 'IServiceCollection' does not contain a definition for 'BuildServiceProvider' and no accessible extension method 'BuildServiceProvider' accepting a first argument of type 'IServiceCollection' could be found (are you missing a using directive or an assembly reference?)

    ReplyDelete
    Replies
    1. Hi,

      Sorry for late reply, it is this only
      using Microsoft.Extensions.DependencyInjection;
      Not sure if it got changed with new version.

      Delete
  2. Please do share code on GitHub as well.

    ReplyDelete
  3. Really you have done a good job. Thanks for sharing this valuable information....
    Inplant Training Certificate
    Inplant Training For CSE Students

    ReplyDelete

Post a Comment

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

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

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

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

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

Strongly typed SingalR on server and client end through TypeScript.

SignalR is a very flexible framework to create bidirectional communication between client and server. The general process that is followed won't allow to have strongly typed calls on the server and also in client code. We will look into how to make strongly typed calls on the server through interface and client end through TypeScript. SignalR - making strong type on server side code Since client-side methods are very dynamic in nature, so calling those from server side behaves similarly to allow any calls. SignalR Hubs are derived from Microsoft.AspNet.SignalR.Hub class, there is also a generic version available to follow typed items. Ex: The interface is the replication of possible calls that would be received on the client end and calling of client-side methods on server code. /// <summary> /// Client(JS) side chatting interface callbacks. /// </summary> public interface IChatHub { /// <summary> /// Gets the online users...