PerUserCacheKeyGenerator implementation

Created a class for generating cache keys considering the current user identity

Author: dmalanij

src/WebApi.OutputCache.V2/PerUserCacheKeyGenerator.cs

@@ -0,0 +1,22 @@
+using System.Net.Http.Headers;
+using System.Web.Http.Controllers;
+
+namespace WebApi.OutputCache.V2
+{
+    public class PerUserCacheKeyGenerator : DefaultCacheKeyGenerator
+    {
+        public override string MakeCacheKey(HttpActionContext context, MediaTypeHeaderValue mediaType, bool excludeQueryString = false)
+        {
+            var baseKey = MakeBaseKey(context);
+            var parameters = FormatParameters(context, excludeQueryString);
+            var userIdentity = FormatUserIdentity(context);
+
+            return string.Format("{0}{1}:{2}:{3}", baseKey, parameters, userIdentity, mediaType);
+        }
+
+        protected virtual string FormatUserIdentity(HttpActionContext context)
+        {
+            return context.RequestContext.Principal.Identity.Name.ToLower();
+        }
+    }
+}

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

@@ -63,6 +63,7 @@
     <Compile Include="ICacheKeyGenerator.cs" />
     <Compile Include="IgnoreCacheOutputAttribute.cs" />
     <Compile Include="InvalidateCacheOutputAttribute.cs" />
+    <Compile Include="PerUserCacheKeyGenerator.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="CacheOutputAttribute.cs" />
     <Compile Include="TimeAttributes\CacheOutputUntilCacheAttribute.cs" />

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

@@ -0,0 +1,71 @@
+using NUnit.Framework;
+using System;
+using System.Security.Principal;
+
+namespace WebApi.OutputCache.V2.Tests
+{
+    [TestFixture]
+    public class PerUserCacheKeyGeneratorTests : CacheKeyGenerationTestsBase<PerUserCacheKeyGenerator>
+    {
+        private const string UserIdentityName = "SomeUserIDon'tMind";
+
+        [SetUp]
+        public override void Setup()
+        {
+            base.Setup();
+            context.RequestContext.Principal = new GenericPrincipal(new GenericIdentity(UserIdentityName), new string[0]);
+        }
+
+        protected override PerUserCacheKeyGenerator BuildCacheKeyGenerator()
+        {
+            return new PerUserCacheKeyGenerator();
+        }
+
+        private string FormatUserIdentityForAssertion() 
+        {
+            return UserIdentityName.ToLower();
+        }
+
+        [Test]
+        public void NoParametersIncludeQueryString_ShouldReturnBaseKeyAndQueryStringAndUserIdentityAndMediaTypeConcatenated()
+        {
+            var cacheKey = cacheKeyGenerator.MakeCacheKey(context, mediaType, false);
+
+            AssertCacheKeysBasicFormat(cacheKey);
+            Assert.AreEqual(String.Format("{0}-{1}:{2}:{3}", BaseCacheKey, requestUri.Query.Substring(1), FormatUserIdentityForAssertion(), mediaType), cacheKey, 
+                "Key does not match expected <BaseKey>-<QueryString>:<UserIdentity>:<MediaType>");
+        }
+
+        [Test]
+        public void NoParametersExcludeQueryString_ShouldReturnBaseKeyAndUserIdentityAndMediaTypeConcatenated()
+        {
+            var cacheKey = cacheKeyGenerator.MakeCacheKey(context, mediaType, true);
+
+            AssertCacheKeysBasicFormat(cacheKey);
+            Assert.AreEqual(String.Format("{0}:{1}:{2}", BaseCacheKey, FormatUserIdentityForAssertion(), mediaType), cacheKey,
+                "Key does not match expected <BaseKey>:<UserIdentity>:<MediaType>");
+        }
+
+        [Test]
+        public void WithParametersIncludeQueryString_ShouldReturnBaseKeyAndArgumentsAndQueryStringAndUserIdentityAndMediaTypeConcatenated()
+        {
+            AddActionArgumentsToContext();
+            var cacheKey = cacheKeyGenerator.MakeCacheKey(context, mediaType, false);
+
+            AssertCacheKeysBasicFormat(cacheKey);
+            Assert.AreEqual(String.Format("{0}-{1}&{2}:{3}:{4}", BaseCacheKey, FormatActionArgumentsForKeyAssertion(), requestUri.Query.Substring(1), FormatUserIdentityForAssertion(), mediaType), cacheKey,
+                "Key does not match expected <BaseKey>-<Arguments>&<QueryString>:<UserIdentity>:<MediaType>");
+        }
+
+        [Test]
+        public void WithParametersExcludeQueryString_ShouldReturnBaseKeyAndArgumentsAndUserIdentityAndMediaTypeConcatenated()
+        {
+            AddActionArgumentsToContext();
+            var cacheKey = cacheKeyGenerator.MakeCacheKey(context, mediaType, true);
+
+            AssertCacheKeysBasicFormat(cacheKey);
+            Assert.AreEqual(String.Format("{0}-{1}:{2}:{3}", BaseCacheKey, FormatActionArgumentsForKeyAssertion(), FormatUserIdentityForAssertion(), mediaType), cacheKey,
+                "Key does not match expected <BaseKey>-<Arguments>:<UserIdentity>:<MediaType>");
+        }
+    }
+}

test/WebApi.OutputCache.V2.Tests/WebApi.OutputCache.V2.Tests.csproj

@@ -84,6 +84,7 @@
     <Compile Include="ConnegTests.cs">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="PerUserCacheKeyGeneratorTests.cs" />
     <Compile Include="DefaultCacheKeyGeneratorTests.cs" />
     <Compile Include="InlineInvalidateTests.cs">
       <SubType>Code</SubType>