Why is my ASP.NET Web API ActionFilterAttribute OnActionExecuting not firing?

Question

I'm trying to implement what's seen here: http://www.piotrwalat.net/nhibernate-session-management-in-asp-net-web-api/ but I'm having an issue with my NhSessionManagementAttribute.

I've set breakpoints on my OnActionExecuting(HttpActionContext actionContext) to see whether the function was ever being called -- it wasn't.

I double-checked my global.asax.cs file & found I am in fact registering the ActionFilter with:

GlobalConfiguration.Configuration.Filters.Add(new NhSessionManagementAttribute());

I have also decorated both my controller class itself, as well as its actions with the attribute to no avail:

public class ClientsController : ApiController {
    static readonly ClientRepository repository = new ClientRepository();

    [NhSessionManagement]
    public IEnumerable<Client> GetAllClients() {
        return repository.GetAll();
    }

    [NhSessionManagement]
    public Client GetClient(int id) {
        Client client = repository.Get(id);
        if (client == null) {
            throw new HttpResponseException(
                new HttpResponseMessage(HttpStatusCode.NotFound)
            );
        }
        return client;
    }
}

Why would this action filter not be firing any of the events within?

david.barkhuizen · Accepted Answer · 2016-08-15 14:02:36Z

186

If you're working in a project contains both MVC and WebAPI assembilies, could you check what's the namespace your ActionFilterAttribute's namespace. It's fairly confusing cause there are two ActionFilterAttributes under both:

WebAPI: System.Web.Http.Filters
MVC: System.Web.Http.Mvc

edited Aug 15, 2016 at 14:02

david.barkhuizen

5,7544 gold badges40 silver badges41 bronze badges

answered Oct 21, 2012 at 6:12

Troy Dai

2,1211 gold badge13 silver badges7 bronze badges

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

7 Comments

neontapir Over a year ago

For WebAPI, the System.Web.Http.Mvc filter attribute should be used, correct?

divyanshm Over a year ago

I've been trying to figure out why my ActionFilter doesn't work for the last couple of hours. Thanks Troy! :)

Frode Lillerud Over a year ago

The ActionFilterAttribute for WebApi is in the System.Web.Http.dll assembly.

boj Over a year ago

MVC: System.Web.Http.Mvc --> System.Web.Mvc in some ASP.NET MVC versions

AaronLS Over a year ago

I'm still confused. For WebAPI why is System.Web.Http.Filters.ActionFilterAttribute not the appropriate choice? The answer just says to check the namespace and states that there are two. It doesn't explain why you would not use the WebAPI one.

|

Matt · Accepted Answer · 2013-08-19 19:00:07Z

39

The answer above definitely helped me - to save others some time... here is explicitly the difference.

Standard MVC Controllers use:

// System.Web.Mvc
public override void OnActionExecuting(ActionExecutingContext filterContext)
{
    base.OnActionExecuting(filterContext);
}

OData HTTP Controllers use:

// System.Web.Http.Filters;
public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
{
    base.OnActionExecuted(actionExecutedContext);
}

edited Aug 19, 2013 at 19:00

Matt

1,19616 silver badges44 bronze badges

answered Mar 26, 2013 at 3:35

ProVega

5,9242 gold badges38 silver badges34 bronze badges

2 Comments

Kent Fehribach Over a year ago

And the System.Web.Http.Filters is for WebApi as well. If using Ninject it is important to note that the Filter bindings are in different libraries for Mvc versus Http as well. Mvc - Ninject.Web.Mvc WebApi/Http - Ninject.Web.WebApi

GarDavis Over a year ago

Actually, the HTTP Controllers use should show OnActionExecuting(HttpActionContext httpActionContext) then call base.OnActionExecuting(httpActionContext). OnActionExecuted() is also available.

Johnie Karr · Accepted Answer · 2015-06-25 18:02:39Z

7

For anyone else who comes across this, ActionFilterAttribute will not fire when calling YourController.YourAction from your UnitTest.

[TestMethod]
public void RevokeSiteAdmin_SessionOver()
{
    FakeDbContext db = new FakeDbContext();

    YourController controller = new YourController(db);
    var result = controller.YourAction();

    //Some Assertions
}

In the TestMethod above, any ActionFilterAttributes on YourController.YourAction will not be called. However; if you call YourController.YourAction from a browser, your ActionFilterAttribute will be called.

This is true for at least WebApi, but I don't know if it applies to MVC.

answered Jun 25, 2015 at 18:02

Johnie Karr

2,8203 gold badges36 silver badges44 bronze badges

1 Comment

Brain2000 Over a year ago

You should use the HttpClient and HttpServer to set up an internal webserver for unit testing, so it will utilize the entire pipeline.

AjitChahal · Accepted Answer · 2016-02-04 12:02:13Z

Here is the complete Implementation:

public class AllowCrossSiteJsonAttribute : System.Web.Mvc.ActionFilterAttribute
{
    public override void OnActionExecuted(System.Web.Mvc.ActionExecutedContext filterContext)
    {
        if (filterContext.HttpContext != null && filterContext.HttpContext.Response != null && filterContext.HttpContext.Request != null && filterContext.HttpContext.Request.UrlReferrer != null)
        {
            var allowedCrossDomains = TypeSafeConfigurationManager.GetValueString("allowedCrossDomains", "none");
            var allowedHosts = allowedCrossDomains.Split(',');

            var requestHost =  filterContext.HttpContext.Request.UrlReferrer.GetLeftPart(UriPartial.Authority);
            if (allowedHosts.Contains(requestHost.ToLower()))
            {
                filterContext.HttpContext.Response.Headers.Add("Access-Control-Allow-Origin", requestHost);
            }
        }

        base.OnActionExecuted(filterContext);
    }
}
public class AllowCrossSiteJsonForWebApiAttribute : ActionFilterAttribute
{
    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
        if (actionExecutedContext.Response != null && actionExecutedContext.Request != null &&
            actionExecutedContext.Request.Headers.Referrer != null)
        {
            var allowedCrossDomains = TypeSafeConfigurationManager.GetValueString("allowedCrossDomains", "none");
            var allowedHosts = allowedCrossDomains.Split(',').ToList();

            var requestHost = actionExecutedContext.Request.Headers.Referrer.GetLeftPart(UriPartial.Authority);

            if (allowedHosts.Contains(requestHost.ToLower()))
            {
                actionExecutedContext.Response.Headers.Add("Access-Control-Allow-Origin", requestHost);
            }

            base.OnActionExecuted(actionExecutedContext);
        }
    }
}

Baran · Accepted Answer · 2016-03-07 22:33:38Z

0

For WebApi, you should install Microsoft.AspNet.WebApi.Core from nuget. For MVC you can use System.Web.MVC.

answered Mar 7, 2016 at 22:33

Baran

1,4086 gold badges17 silver badges33 bronze badges

Comments

bendecko · Accepted Answer · 2017-06-22 09:02:20Z

0

My problem was much more simple:

Check your Controller is decorated with <actionPreProcessActivitiesAttribute()> _

answered Jun 22, 2017 at 9:02

bendecko

2,7931 gold badge25 silver badges35 bronze badges

Collectives™ on Stack Overflow

Why is my ASP.NET Web API ActionFilterAttribute OnActionExecuting not firing?

6 Answers 6

7 Comments

2 Comments

1 Comment

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

7 Comments

2 Comments

1 Comment

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related