Skip to main content

Gracefully notifying end user about application error in .Net and .Net Core versions

We generally do error logging for the application to know what error might have occurred in the application. Notifying the end user about the error is equally important. Also, it is always better to implement this at first place rather than doing at a later stage. I have seen many big company's websites ending with .NET yellow page of death. Now, it is really good that the default behavior is removed from .Net Core framework with some generic error message.

We would look how to implement generically and use in older frameworks and some tips on .Net Core as well.

The idea is to create MVC Controller for error and then redirect it from any locations like Filters or Global Exception handling. Also, we would briefly look into the global AJAX error handling system since heavy usage of AJAX in current development trend.

The few steps that we are going to do.
- Represent application errors with enum as system/application have different ways to deal with errors like though Exception or status code.
- Domain model to generate respective error message based on Enum.
- Global exception handling to catch the exception and redirect to MVC Action.

Error Enum

This can be extended as you required. I would be using Unknown as a default initialization but could be set as zero to get initial value.

 /// <summary>  
 /// Error codes for requests  
 /// </summary>  
 public enum ErrorCode  
 {  
   /// <summary>  
   /// The HTTP request error  
   /// </summary>  
   HttpRequestError,  
   /// <summary>  
   /// The page not found  
   /// </summary>  
   PageNotFound,  
   /// <summary>  
   /// The unknown  
   /// </summary>  
   Unknown,  
   /// <summary>  
   /// The unauthorized user  
   /// </summary>  
   UnauthorizedUser,  
   /// <summary>  
   /// The anti forgery token  
   /// </summary>  
   AntiForgeryToken  
 }  

Domain model to generate message

This is pretty straight forward to initialize class based on ErrorCode enum which in turn gives us messages to display to the end users.

 /// <summary>  
 /// Error model  
 /// </summary>  
 public class ErrorModel  
 {  
   /// <summary>  
   /// Initializes a new instance of the <see cref="ErrorModel"/> class.  
   /// </summary>  
   /// <param name="errCode">The error code.</param>  
   public ErrorModel(ErrorCode errCode)  
   {  
     ErrorCode = errCode;  
     switch (errCode)  
     {  
       case ErrorCode.HttpRequestError:  
         ErrorHeader = "Invalid inputs given.";  
         ErrorMessage = "Request terminated. Invalid characters found. Please try putting correct values.";  
         break;  
       case ErrorCode.PageNotFound:  
         ErrorHeader = "Page Not Available";  
         ErrorMessage = "The requested page is either moved or invalid.";  
         break;  
       case ErrorCode.UnauthorizedUser:  
         ErrorHeader = "Unauthorized Access";  
         ErrorMessage = "You don't have permission to access this area.";  
         break;  
       case ErrorCode.AntiForgeryToken:  
         ErrorHeader = "Security Issue";  
         ErrorMessage = "Source and destination does not match each other. Please try again.";  
         break;  
       case ErrorCode.Unknown:  
       default:  
         ErrorHeader = "Unknown error";  
         ErrorMessage = "We are sorry but it appears that this page is missing or some error has occurred.";  
         break;  
     }  
   }  
   /// <summary>  
   /// Gets or sets the error code.  
   /// </summary>  
   /// <value>  
   /// The error code.  
   /// </value>  
   public ErrorCode ErrorCode { get; set; }  
   /// <summary>  
   /// Gets or sets the error header.  
   /// </summary>  
   /// <value>  
   /// The error header.  
   /// </value>  
   public string ErrorHeader { get; set; }  
   /// <summary>  
   /// Gets or sets the error message.  
   /// </summary>  
   /// <value>  
   /// The error message.  
   /// </value>  
   public string ErrorMessage { get; set; }  
 }  

Error Controller along with View

This has a just few logic to check if it is AJAX call and response accordingly. Just in case of Unauthorized it redirects to login page.

 public class ErrorController  
   : Controller  
 {  
   /// <summary>  
   /// Indexes the specified error code.  
   /// </summary>  
   /// <param name="id">The error code.</param>  
   /// <returns></returns>  
   [AllowAnonymous]  
   public ActionResult Index(ErrorCode id)  
   {  
     var error = new ErrorModel(id);  
     if (Request.IsAjaxRequest())  
     {  
       return Content($"{error.ErrorHeader} - {error.ErrorMessage}");  
     }  
     else if (id == ErrorCode.UnauthorizedUser)  
     {  
       return RedirectToAction("Index", "Login", new { area = "Account" });  
     }  
     return View(error);  
   }  
   /// <summary>  
   /// Error view based on Context Error code.  
   /// </summary>  
   /// <param name="statusCode">The status code.</param>  
   /// <returns>Redirects to Index</returns>  
   [AllowAnonymous]  
   [Route("Error/Code/{statusCode}")]  
   public ActionResult Code(int statusCode)  
   {  
     var errCode = ErrorCode.Unknown;  
     switch (statusCode)  
     {  
       case 404:  
         errCode = ErrorCode.PageNotFound;  
         break;  
       case 401:  
         errCode = ErrorCode.UnauthorizedUser;  
         break;  
     }  
     return RedirectToAction(nameof(Index), new { id = errCode });  
   }  
 }  

In the case of  .NET Core, IsAjaxRequest won't be available. So, you can use this extension method.

 public static bool IsAjaxRequest(this HttpRequest request)  
 {  
   if (request == null)  
   {  
     throw new ArgumentNullException(nameof(request));  
   }  
   if (request.Headers != null)  
   {  
     return request.Headers["X-Requested-With"] == "XMLHttpRequest";  
   }  
   return false;  
 }  

View for Action: Index.cshtml

 @model ErrorModel  
 @{  
   ViewBag.Title = "Error";  
   //Layout = "~/Views/Shared/_Layout.cshtml";  
 }  
 <h2 class="text-danger">@Model.ErrorHeader</h2>  
 <div class="text-info">  
   @Model.ErrorMessage  
 </div>  

Global exception handling and redirection: Global.asax.cs

This is not applicable in .Net Core we would have another section for same.
Based on certain condition it is composing correct ErrorCode enum and redirecting to ErrorController.

 protected void Application_Error(object sender, EventArgs e)  
 {  
   // Skip error logging and page redirect if application is running on local machine  
   if (Request.IsLocal)  
   {  
     return;  
   }  
   // Get exception  
   var ex = Server.GetLastError();  
   if (ex == null)  
   {  
     return;  
   }  
   Server.ClearError();  
   ErrorCode errCode = ErrorCode.Unknown;  
   // Form error code.  
   if (ex is HttpRequestValidationException)  
   {  
     errCode = ErrorCode.HttpRequestError;  
   }  
   else if ((ex as HttpException) != null &&  
         (ex as HttpException).GetHttpCode() == 404)  
   {  
     errCode = ErrorCode.PageNotFound;  
   }  
   else if (ex as System.Web.Mvc.HttpAntiForgeryException != null)  
   {  
     errCode = ErrorCode.AntiForgeryToken;  
   }
   Log.Error(String.Format("{0} error:", errCode.ToString()), ex);  
   Response.Redirect("/error?id=" + errCode);  
 }  

Since it won't work in .Net Core there have to be few extra things required.

.Net Core exception handling

A while back I had written an article Global exception handling and custom logging in AspNet Core with MongoDB. Under GlobalExceptionFilter we can hook this up and the same thing is done as well in that article.

The 401 or some others does not get properly redirected through Global exception filter in .Net Core. Maybe due to Pipeline of filters is directly associated with MVC. We can overcome by using this under Startup.cs along with GlobalExceptionFilter.

 app.UseStatusCodePagesWithReExecute("/error/code/{0}");  

Client side notification

This actually depends on the approach that you might have taken for clients side scripting. If there is common functions for get, post, AJAX requests then you could hook up there. In Angular these can be hooked on observable.

In the case of jQuery, AJAX calls can be globally registered.
Sample:

   $(document).ajaxError(  
     function (e, xhr, settings) {  
       if (xhr.status == 401) {  
         // Notify user for redirection and redirect  
       }  
     });  





Popular posts from this blog

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 tha…

LDAP with ASPNet Core Identity in MVC Core

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.

AspNet Identity Core is a new offering from Microsoft in replacement of AspNet Identity for managing users.

In this tutorial, we would be looking for implementing LDAP with AspNet Identity Core to allow users to be able to log in through AD or AspNet Identity Core members.

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 functiona…

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(); throw; }…