Skip to main content

ASP.NET MVC AsyncController Helper

The AsyncController is a really nice feature introduced in ASP.NET MVC 2. It allows you to process your actions  asynchronously increasing the throughput of your web server.
Although implementing it is not that hard, I’m not a big fan of the current syntax(The new async api in ASP.NET MVC 4 looks promising).
In the meanwhile I have written a small helper class to simplify the usage of the AsyncController.
public static class AsyncManagerExtensions
   {
       public static void RegisterTask<T>(this AsyncManager asyncManager, Task<T> task, Func<T, object> func)
       {
           asyncManager.OutstandingOperations.Increment();
           task.ContinueWith(task2 =>
           {
               object propertyObject = null;

               if (!task2.IsFaulted)
               {
                   //invoke the provided function with the
                   //result of running the task
                   propertyObject = func(task2.Result);
               }
               else
               {
                   propertyObject = func(default(T));
               }


               //use reflection to set asyncManager.Parameters
               //for the returned object's fields and properties
               var ty = propertyObject.GetType();

               foreach (var f in ty.GetFields())
               {
                   asyncManager.Parameters[f.Name] = f.GetValue(propertyObject);
               }

               foreach (var p in ty.GetProperties())
               {
                   var v = p.GetGetMethod().Invoke(propertyObject, null);
                   asyncManager.Parameters[p.Name] = v;
               }

               asyncManager.OutstandingOperations.Decrement();
           });
       }
   }

Using it is simple. I create a controller that inherits from AsyncController:

public class PrintController : AsyncController
{
    private readonly IReportService _reportService;
        
    public PrintController(IReportService reportService)
    {
        _reportService = reportService;
    }
}


I add a method that returns the Task I want to execute and and the Action Controller method that will be called by the View(in this case through /Print/Pdf) . In this Action Controller method I call the RegisterTask<T> extension method and pass 2 properties:

  • The method that needs to be executed 
  • An expression that takes the output of the task and maps it to the parameters of the Completed method(based on the parameter name).
public void PdfAsync(string reportName)
{
 AsyncManager.RegisterTask<byte[]>(RenderReport(reportName)), renderReportResult=> new { data = renderReportResult, reportName = reportName });
}

private Task<byte[]> RenderReport(string reportName)
{
 return  Task.Factory.StartNew(()=>_reportService.RenderReport(reportName));
}

public ActionResult PdfCompleted(byte[] data, string reportName)
{
 var fileName = reportName + ".pdf";
 var fileContentResult = File(data, "application/pdf", fileName);
 Response.AppendHeader("Content-Disposition", string.Format("inline; filename={0}", fileName));
 return fileContentResult;
}

Popular posts from this blog

Podman– Command execution failed with exit code 125

After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...

Cache stampede: when our cache turned against us

While investigating some performance issues, we ran into an ASP.NET Core API that cached a fairly expensive aggregation query for 60 seconds. Under normal load, that was fine: one request rebuilds the cache, everyone else reads from it. Under peak load, dozens of requests would arrive in that same expiry window, all see a cache miss, and all fire the same expensive query in parallel. The database didn't like that. That was the moment when our caching layer stopped helping and started hurting. A burst of requests comes in at the same time, all miss the cache, and all go hammer the database or the downstream API at once. That's a cache stampede . The cache was supposed to protect our backend, and for a few hundred milliseconds it did the opposite. Why this happens IMemoryCache.GetOrCreate (and its async sibling) looks like it protects you, but it doesn't add any locking on its own. Look at the naive version: public async Task<Report> GetReportAsync(string key) ...

A complex system designed from scratch never works

A few years ago, I worked as an architect on a big mainframe rewrite. I still count it as one of my failures. Not because the technology was wrong, but because I couldn't convince the management team to simplify the approach. Years later, the organization is still struggling to get the new system up and running. I left the project at the time, because I couldn't put my name behind an approach that would take very long and cost a lot of money without a working system to show for it along the way. Gall’s Law That memory keeps coming back to me, because it's a textbook case of Gall's Law playing out in real life. Gall's Law , from John Gall's Systemantics , states it plainly: A complex system that works is invariably found to have evolved from a simple system that worked. A complex system designed from scratch never works, and it cannot be patched to make it work. You have to start over with a simple system that works. What does that mean in practice,...