Merge pull request filipw#144 from filipw/feature/cache-ignore

Added ability to opt out from caching

Author: filipw

README.md

@@ -126,6 +126,29 @@ So you either should use unique method names inside a single controller, or (if
         }
 
 
+Ignoring caching
+--------------------
+You can set up caching globally (add the caching filter to `HttpConfiguration`) or on controller level (decorate the controller with the cahcing attribute). This means that caching settings will cascade down to all the actions in your entire application (in the first case) or in the controller (in the second case).
+
+You can still instruct a specific action to opt out from caching by using `[IgnoreCacheOutput]` attribute.
+
+        [CacheOutput(ClientTimeSpan = 50, ServerTimeSpan = 50)]
+        public class IgnoreController : ApiController
+        {
+            [Route("cached")]
+            public string GetCached()
+            {
+                return DateTime.Now.ToString();
+            }
+
+            [IgnoreCacheOutput]
+            [Route("uncached")]
+            public string GetUnCached()
+            {
+                return DateTime.Now.ToString();
+            }
+        }
+
 Server side caching
 --------------------
 By default **CacheOutput** will use *System.Runtime.Caching.MemoryCache* to cache on the server side. However, you are free to swap this with anything else

sample/WebApi.OutputCache.V2.Demo/IgnoreController.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Web.Http;
+
+namespace WebApi.OutputCache.V2.Demo
+{
+    [CacheOutput(ClientTimeSpan = 50, ServerTimeSpan = 50)]
+    [RoutePrefix("ignore")]
+    public class IgnoreController : ApiController
+    {
+        [Route("cached")]
+        public string GetCached()
+        {
+            return DateTime.Now.ToString();
+        }
+
+        [IgnoreCacheOutput]
+        [Route("uncached")]
+        public string GetUnCached()
+        {
+            return DateTime.Now.ToString();
+        }
+    }
+}

sample/WebApi.OutputCache.V2.Demo/Program.cs

@@ -10,6 +10,7 @@ class Program
         static void Main(string[] args)
         {
             var config = new HttpSelfHostConfiguration("http://localhost:999");
+            config.MapHttpAttributeRoutes();
             config.Routes.MapHttpRoute(
                   name: "DefaultApi",
                 routeTemplate: "api/{controller}/{id}",

sample/WebApi.OutputCache.V2.Demo/TeamsController.cs

@@ -21,7 +21,7 @@ public IEnumerable<Team> Get()
             return Teams;
         }
 
-        [CacheOutputUntil(2014, 7, 20)]
+        [CacheOutputUntil(2016, 7, 20)]
         public Team GetById(int id)
         {
             var team = Teams.FirstOrDefault(i => i.Id == id);

sample/WebApi.OutputCache.V2.Demo/WebApi.OutputCache.V2.Demo.csproj

@@ -65,6 +65,7 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="IgnoreController.cs" />
     <Compile Include="Teams2Controller.cs" />
     <Compile Include="Program.cs" />
     <Compile Include="Team.cs" />

src/WebApi.OutputCache.V2/CacheOutputAttribute.cs

@@ -17,7 +17,7 @@
 
 namespace WebApi.OutputCache.V2
 {
-    [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
+    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
     public class CacheOutputAttribute : ActionFilterAttribute
     {
         private const string CurrentRequestMediaType = "CacheOutput:CurrentRequestMediaType";
@@ -73,14 +73,23 @@ protected virtual void EnsureCache(HttpConfiguration config, HttpRequestMessage
 
         internal IModelQuery<DateTime, CacheTime> CacheTimeQuery;
 
-        readonly Func<HttpActionContext, bool, bool> _isCachingAllowed = (ac, anonymous) =>
+        protected virtual bool IsCachingAllowed(HttpActionContext actionContext, bool anonymousOnly)
         {
-            if (anonymous)
+            if (anonymousOnly)
+            {
                 if (Thread.CurrentPrincipal.Identity.IsAuthenticated)
+                {
                     return false;
+                }
+            }
 
-            return ac.Request.Method == HttpMethod.Get;
-        };
+            if (actionContext.ActionDescriptor.GetCustomAttributes<IgnoreCacheOutputAttribute>().Any())
+            {
+                return false;
+            }
+
+            return actionContext.Request.Method == HttpMethod.Get;
+        }
 
         protected virtual void EnsureCacheTimeQuery()
         {
@@ -133,7 +142,7 @@ public override void OnActionExecuting(HttpActionContext actionContext)
         {
             if (actionContext == null) throw new ArgumentNullException("actionContext");
 
-            if (!_isCachingAllowed(actionContext, AnonymousOnly)) return;
+            if (!IsCachingAllowed(actionContext, AnonymousOnly)) return;
 
             var config = actionContext.Request.GetConfiguration();
 
@@ -184,7 +193,7 @@ public override async Task OnActionExecutedAsync(HttpActionExecutedContext actio
         {
             if (actionExecutedContext.ActionContext.Response == null || !actionExecutedContext.ActionContext.Response.IsSuccessStatusCode) return;
 
-            if (!_isCachingAllowed(actionExecutedContext.ActionContext, AnonymousOnly)) return;
+            if (!IsCachingAllowed(actionExecutedContext.ActionContext, AnonymousOnly)) return;
 
             var cacheTime = CacheTimeQuery.Execute(DateTime.Now);
             if (cacheTime.AbsoluteExpiration > DateTime.Now)

src/WebApi.OutputCache.V2/IgnoreCacheOutputAttribute.cs

@@ -0,0 +1,9 @@
+using System;
+
+namespace WebApi.OutputCache.V2
+{
+    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
+    public sealed class IgnoreCacheOutputAttribute : Attribute
+    {
+    }
+}

src/WebApi.OutputCache.V2/WebApi.OutputCache.V2.csproj

@@ -61,6 +61,7 @@
     <Compile Include="DefaultCacheKeyGenerator.cs" />
     <Compile Include="HttpConfigurationExtensions.cs" />
     <Compile Include="ICacheKeyGenerator.cs" />
+    <Compile Include="IgnoreCacheOutputAttribute.cs" />
     <Compile Include="InvalidateCacheOutputAttribute.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="CacheOutputAttribute.cs" />

test/WebApi.OutputCache.V2.Tests/ServerSideTests.cs

@@ -305,6 +305,27 @@ public void can_handle_media_type_when_cache_has_expired_during_request()
             Assert.That(result.IsSuccessStatusCode, Is.True);
         }
 
+        [Test]
+        public void will_cache_if_cacheouput_present_on_controller()
+        {
+            var client = new HttpClient(_server);
+            var result = client.GetAsync("http://www.strathweb.com/api/ignore/cached").Result;
+
+            _cache.Verify(s => s.Contains(It.Is<string>(x => x == "webapi.outputcache.v2.tests.testcontrollers.ignorecontroller-cached:application/json; charset=utf-8")), Times.Exactly(2));
+            _cache.Verify(s => s.Add(It.Is<string>(x => x == "webapi.outputcache.v2.tests.testcontrollers.ignorecontroller-cached"), It.IsAny<object>(), It.Is<DateTimeOffset>(x => x <= DateTime.Now.AddSeconds(100)), null), Times.Once());
+            _cache.Verify(s => s.Add(It.Is<string>(x => x == "webapi.outputcache.v2.tests.testcontrollers.ignorecontroller-cached:application/json; charset=utf-8"), It.IsAny<object>(), It.Is<DateTimeOffset>(x => x <= DateTime.Now.AddSeconds(100)), It.Is<string>(x => x == "webapi.outputcache.v2.tests.testcontrollers.ignorecontroller-cached")), Times.Once());
+        }
+
+        [Test]
+        public void will_not_cache_if_cacheouput_present_on_controller_but_action_has_ignorecacheouputattibute()
+        {
+            var client = new HttpClient(_server);
+            var result = client.GetAsync("http://www.strathweb.com/api/ignore/uncached").Result;
+
+            _cache.Verify(s => s.Contains(It.IsAny<string>()), Times.Never());
+            _cache.Verify(s => s.Add(It.IsAny<string>(), It.IsAny<object>(), It.IsAny<DateTimeOffset>(), It.IsAny<string>()), Times.Never());
+            _cache.Verify(s => s.Add(It.IsAny<string>(), It.IsAny<object>(), It.IsAny<DateTimeOffset>(), It.IsAny<string>()), Times.Never());
+        }
 
         //[Test]
         //public void must_add_querystring_to_cache_params()

test/WebApi.OutputCache.V2.Tests/TestControllers/IgnoreController.cs

@@ -0,0 +1,21 @@
+using System.Web.Http;
+
+namespace WebApi.OutputCache.V2.Tests.TestControllers
+{
+    [CacheOutput(ClientTimeSpan = 100, ServerTimeSpan = 100)]
+    public class IgnoreController : ApiController
+    {
+        [HttpGet]
+        public string Cached()
+        {
+            return "test";
+        }
+
+        [HttpGet]
+        [IgnoreCacheOutput]
+        public string NotCached()
+        {
+            return "test";
+        }
+    }
+}