Perform Async operation asp.net mvc outside of the action

Question

I want to be able to load a user from a cloud database on each request and have that available on the request in a controller using asp.net mvc. The problem is the current framework does not support doing async operations from action filters. So OnActionExecuting, OnAuthorization methods do not allow me to do this.. for example I have the following code which DOES NOT work (so don't try it).. You get an exception : "An asynchronous module or handler completed while an asynchronous operation was still pending."

protected async override void OnAuthorization(AuthorizationContext filterContext)
{
  var user = filterContext.HttpContext.User;
  if (!user.Identity.IsAuthenticated)
  {
    HandleUnauthorizedRequest(filterContext);
    return;
  }

  using (var session = MvcApplication.DocumentStore.OpenAsyncSession())
  {
    User currentUser = await session.LoadAsync<User>(user.Identity.Name);
    if (currentUser == null)
    {
      HandleUnauthorizedRequest(filterContext);
      return;
    }

    filterContext.HttpContext.Items["User"] = currentUser;
  }
}

So is there any other way of being able to do this? I notice there is a begin execute method in the base Controller:

protected override IAsyncResult BeginExecute(RequestContext requestContext, AsyncCallback callback, object state)
{
  return base.BeginExecute(requestContext, callback, state);
}

Could I do it there possibly?

I've recently published a library that adds proper support for async filters (heavily based on code in from ASP.NET MVC Core). Source is also available here: github.com/jdaigle/Hydrogen.Extensions.Mvc5. — Joseph Daigle
– Joseph Daigle, Commented Mar 21, 2017 at 2:05

Johann · Accepted Answer · 2021-09-24 17:34:43Z

10

The question is three months old so I guess you've managed to work around this. Anyway, I'll add my solution here, as I had to do something similar.

I used the ToAsync method from the ParallelExtensionsExtras library. This is my class:

public class AsyncControllerBase : Controller
{
    protected override IAsyncResult BeginExecute(System.Web.Routing.RequestContext requestContext, AsyncCallback callback, object state)
    {
        return ExecuteCoreAsync(requestContext, state).ToAsync(callback, state);
    }

    protected override void EndExecute(IAsyncResult asyncResult)
    {
        IAsyncResult baseAsyncResult = ((Task<IAsyncResult>)asyncResult).Result;
        base.EndExecute(baseAsyncResult);
    }

    protected virtual async Task<IAsyncResult> ExecuteCoreAsync(System.Web.Routing.RequestContext requestContext, object state)
    {
        await DoStuffHereOrInDerivedClassAsync();

        var baseBeginExecuteCompletion = new TaskCompletionSource<IAsyncResult>();

        AsyncCallback callback = ar =>
        {
            baseBeginExecuteCompletion.SetResult(ar);
        };

        // OnActionExecuting will be called at this point
        var baseAsyncResult = base.BeginExecute(requestContext, callback, state);

        await baseBeginExecuteCompletion.Task;

        return baseAsyncResult;
    }

    protected override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        base.OnActionExecuting(filterContext);
    }
}

See also this documentation from Microsoft on converting between Task and IAsyncResult.

edited Sep 24, 2021 at 17:34

Johann

4,4023 gold badges43 silver badges41 bronze badges

answered Jan 26, 2013 at 13:37

Csaba Fabian

8869 silver badges20 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

deerchao Over a year ago

Note that Controller.Request and many other properties are null inside DoStuffHereOrInDerivedClassAsync(), better be passing RequestContext as an argument to access certain features.

Dirk Boer Over a year ago

Why the 'empty' override of OnActionExecuting?

Csaba Fabian Over a year ago

Hi Dirk, it's been two-and-a-half years since I wrote this, so I honestly can't remember :) Maybe may original intention was to seal the override to avoid confusion in the derived classes - but forgot to actually do it?!

deerchao Over a year ago

Still have to do this in mvc 5.2.3. Found an improvement: override (Begin|End)ExecuteCore instead of (Begin|End')Execute, then you can use Controller.Request.

Collectives™ on Stack Overflow

Perform Async operation asp.net mvc outside of the action

1 Answer 1

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related