Merge pull request #11 from kevbite/cachebug

kevbite · web-flow · commit 3d7e1b9a235f · 2017-12-09T15:09:16.000Z
Fixing caching bug on multiple sources
diff --git a/appveyor.yml b/appveyor.yml
@@ -3,7 +3,7 @@
     only:
       - master
   skip_tags: true
-  version: 4.0.0
+  version: 4.0.1
   
   assembly_info:
     assembly_version: '{version}'
@@ -59,7 +59,7 @@
 
 -
   skip_tags: true
-  version: 4.0.0-{branch}{build}
+  version: 4.0.1-{branch}{build}
   
   assembly_info:
     assembly_version: '{version}'
diff --git a/src/HumbleConfig.Caching.Tests/CachingConfigurationSourceDecoratorTests/CachingConfigurationSourceDecoratorForNoneExistingAppSettingKey.cs b/src/HumbleConfig.Caching.Tests/CachingConfigurationSourceDecoratorTests/CachingConfigurationSourceDecoratorForNoneExistingAppSettingKey.cs
@@ -17,7 +17,7 @@ protected override IConfigurationSource CreateConfigurationSource()
             innerSource.Setup(x => x.GetAppSettingAsync<TValue>(It.IsAny<string>(), It.IsAny<CancellationToken>()))
                 .ReturnsAsync(ConfigurationSourceResult<TValue>.FailedResult());
             
-            var source = new CachingConfigurationSourceDecorator(innerSource.Object, MemoryCache.Default, () => new CacheItemPolicy());
+            var source = new CachingConfigurationSourceDecorator(innerSource.Object, new CacheKeyCreator(Guid.NewGuid().ToString()),  MemoryCache.Default, () => new CacheItemPolicy());
 
             return source;
         }
diff --git a/src/HumbleConfig.Caching.Tests/CachingConfigurationSourceDecoratorTests/CachingConfigurationSourceDecoratorForNoneExistingAppSettingKeyWithValueCached.cs b/src/HumbleConfig.Caching.Tests/CachingConfigurationSourceDecoratorTests/CachingConfigurationSourceDecoratorForNoneExistingAppSettingKeyWithValueCached.cs
@@ -21,7 +21,7 @@ protected override IConfigurationSource CreateConfigurationSource()
             innerSource.Setup(x => x.GetAppSettingAsync<TValue>(It.IsAny<string>(), It.IsAny<CancellationToken>()))
                 .Throws(new Exception("Should never get here"));
 
-            var source = new CachingConfigurationSourceDecorator(innerSource.Object, objectCache.Object, () => new CacheItemPolicy());
+            var source = new CachingConfigurationSourceDecorator(innerSource.Object, new CacheKeyCreator(Guid.NewGuid().ToString()), objectCache.Object, () => new CacheItemPolicy());
             
             return source;
         }
diff --git a/src/HumbleConfig.Caching.Tests/CachingConfigurationSourceDecoratorTests/CachingConfigurationSourceDecoratorTestsForExistingKey.cs b/src/HumbleConfig.Caching.Tests/CachingConfigurationSourceDecoratorTests/CachingConfigurationSourceDecoratorTestsForExistingKey.cs
@@ -18,7 +18,7 @@ protected override IConfigurationSource GivenConfigurationSourceWithExistingRKey
             innerSource.Setup(x => x.GetAppSettingAsync<TValue>(key, cancellationToken))
                 .ReturnsAsync(ConfigurationSourceResult<TValue>.SuccessResult(expectedValue));
             
-            var source = new CachingConfigurationSourceDecorator(innerSource.Object, MemoryCache.Default, () => new CacheItemPolicy());
+            var source = new CachingConfigurationSourceDecorator(innerSource.Object, new CacheKeyCreator(Guid.NewGuid().ToString()), MemoryCache.Default, () => new CacheItemPolicy());
 
             return source;
         }
diff --git a/src/HumbleConfig.Caching.Tests/CachingConfigurationSourceDecoratorTests/CachingConfigurationSourceDecoratorTestsForExistingKeyWithValueCached.cs b/src/HumbleConfig.Caching.Tests/CachingConfigurationSourceDecoratorTests/CachingConfigurationSourceDecoratorTestsForExistingKeyWithValueCached.cs
@@ -19,7 +19,7 @@ protected override IConfigurationSource GivenConfigurationSourceWithExistingRKey
                 .ReturnsAsync(ConfigurationSourceResult<TValue>.SuccessResult(expectedValue))
                 .Throws(new Exception("Should never get here"));
             
-            var source = new CachingConfigurationSourceDecorator(innerSource.Object, MemoryCache.Default, () => new CacheItemPolicy());
+            var source = new CachingConfigurationSourceDecorator(innerSource.Object, new CacheKeyCreator(Guid.NewGuid().ToString()), MemoryCache.Default, () => new CacheItemPolicy());
             source.GetAppSettingAsync<TValue>(key, cancellationToken).Wait();
 
             return source;
diff --git a/src/HumbleConfig.Caching/CacheKeyCreator.cs b/src/HumbleConfig.Caching/CacheKeyCreator.cs
@@ -0,0 +1,17 @@
+﻿namespace HumbleConfig.Caching
+{
+    public class CacheKeyCreator : ICacheKeyCreator
+    {
+        private readonly string _keyPrefix;
+
+        public CacheKeyCreator(string keyPrefix)
+        {
+            _keyPrefix = keyPrefix;
+        }
+
+        public string CreateCacheKey(string key)
+        {
+            return $"{_keyPrefix}-{key}";
+        }
+    }
+}
diff --git a/src/HumbleConfig.Caching/CachingConfigurationSourceDecorator.cs b/src/HumbleConfig.Caching/CachingConfigurationSourceDecorator.cs
@@ -8,19 +8,21 @@ namespace HumbleConfig.Caching
     public class CachingConfigurationSourceDecorator : IConfigurationSource
     {
         private readonly IConfigurationSource _innerSource;
+        private readonly ICacheKeyCreator _cacheKeyCreator;
         private readonly ObjectCache _objectCache;
         private readonly Func<CacheItemPolicy> _cacheItemPolicyFactory;
 
-        public CachingConfigurationSourceDecorator(IConfigurationSource innerSource, ObjectCache objectCache, Func<CacheItemPolicy> cacheItemPolicyFactoryFactory)
+        public CachingConfigurationSourceDecorator(IConfigurationSource innerSource, ICacheKeyCreator cacheKeyCreator, ObjectCache objectCache, Func<CacheItemPolicy> cacheItemPolicyFactoryFactory)
         {
             _innerSource = innerSource;
+            _cacheKeyCreator = cacheKeyCreator;
             _objectCache = objectCache;
             _cacheItemPolicyFactory = cacheItemPolicyFactoryFactory;
         }
 
         public async Task<ConfigurationSourceResult<TValue>> GetAppSettingAsync<TValue>(string key, CancellationToken cancellationToken = default(CancellationToken))
         {
-            var appsetting = (ConfigurationSourceResult<TValue>)_objectCache.Get(CreateCacheKey(key));
+            var appsetting = (ConfigurationSourceResult<TValue>)_objectCache.Get(_cacheKeyCreator.CreateCacheKey(key));
 
             if (appsetting == null)
             {
@@ -32,15 +34,11 @@ public CachingConfigurationSourceDecorator(IConfigurationSource innerSource, Obj
 
             return appsetting;
         }
-
-        private static string CreateCacheKey(string key)
-        {
-            return $"HumbleConfig-{key}";
-        }
+        
 
         private CacheItem CreateCacheItem<TValue>(string key, ConfigurationSourceResult<TValue> value)
         {
-            return new CacheItem(CreateCacheKey(key), value);
+            return new CacheItem(_cacheKeyCreator.CreateCacheKey(key), value);
         }
     }
 }
diff --git a/src/HumbleConfig.Caching/CachingExtentions.cs b/src/HumbleConfig.Caching/CachingExtentions.cs
@@ -6,22 +6,29 @@ namespace HumbleConfig.Caching
 {
     public static class CachingExtentions
     {
-        public static IConfigurationSourceConfigurator WithCache(this IConfigurationSourceConfigurator a, ObjectCache objectCache, Func<CacheItemPolicy> cacheItemPolicyFactory)
+        public static IConfigurationSourceConfigurator WithCache(this IConfigurationSourceConfigurator configurationSourceConfigurator, ICacheKeyCreator cacheKeyCreator, ObjectCache objectCache, Func<CacheItemPolicy> cacheItemPolicyFactory)
         {
-            return a.WrapSource(x => new CachingConfigurationSourceDecorator(x, objectCache, cacheItemPolicyFactory));
+            return configurationSourceConfigurator.WrapSource(x => new CachingConfigurationSourceDecorator(x, cacheKeyCreator, objectCache, cacheItemPolicyFactory));
         }
 
-        public static IConfigurationSourceConfigurator WithDefaultMemoryCache(this IConfigurationSourceConfigurator a, Func<CacheItemPolicy> cacheItemPolicyFactory)
+        public static IConfigurationSourceConfigurator WithCache(this IConfigurationSourceConfigurator configurationSourceConfigurator, ObjectCache objectCache, Func<CacheItemPolicy> cacheItemPolicyFactory)
         {
-            return a.WrapSource(x => new CachingConfigurationSourceDecorator(x, MemoryCache.Default, cacheItemPolicyFactory));
+            var cacheKeyCreator = new CacheKeyCreator(Guid.NewGuid().ToString());
+
+            return WithCache(configurationSourceConfigurator, cacheKeyCreator, objectCache, cacheItemPolicyFactory);
+        }
+
+        public static IConfigurationSourceConfigurator WithDefaultMemoryCache(this IConfigurationSourceConfigurator configurationSourceConfigurator, Func<CacheItemPolicy> cacheItemPolicyFactory)
+        {
+            return WithCache(configurationSourceConfigurator, MemoryCache.Default, cacheItemPolicyFactory);
         }
 
-        public static IConfigurationSourceConfigurator WithDefaultMemoryCache(this IConfigurationSourceConfigurator a, TimeSpan expiresAfter)
+        public static IConfigurationSourceConfigurator WithDefaultMemoryCache(this IConfigurationSourceConfigurator configurationSourceConfigurator, TimeSpan expiresAfter)
         {
-            return a.WrapSource(x => new CachingConfigurationSourceDecorator(x, MemoryCache.Default, () => new CacheItemPolicy()
+            return WithDefaultMemoryCache(configurationSourceConfigurator, () => new CacheItemPolicy()
             {
                 AbsoluteExpiration = DateTimeOffset.UtcNow.Add(expiresAfter)
-            }));
+            });
         }
     }
 }
diff --git a/src/HumbleConfig.Caching/HumbleConfig.Caching.csproj b/src/HumbleConfig.Caching/HumbleConfig.Caching.csproj
@@ -41,8 +41,10 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="CacheKeyCreator.cs" />
     <Compile Include="CachingExtentions.cs" />
     <Compile Include="CachingConfigurationSourceDecorator.cs" />
+    <Compile Include="ICacheKeyCreator.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
   <ItemGroup>
diff --git a/src/HumbleConfig.Caching/ICacheKeyCreator.cs b/src/HumbleConfig.Caching/ICacheKeyCreator.cs
@@ -0,0 +1,7 @@
+﻿namespace HumbleConfig.Caching
+{
+    public interface ICacheKeyCreator
+    {
+        string CreateCacheKey(string key);
+    }
+}
diff --git a/src/HumbleConfig.FunctionalTests/CacheConfigurationTests.cs b/src/HumbleConfig.FunctionalTests/CacheConfigurationTests.cs
@@ -28,8 +28,7 @@ public void GivenConfigurationWithEnvironmentVaribleAndConfigurationManager()
             };
 
             _configuration = new Configuration()
-                .AddInMemory(_inMemory)
-                .WithDefaultMemoryCache(TimeSpan.FromSeconds(1))
+                .AddInMemory(_inMemory).WithDefaultMemoryCache(TimeSpan.FromSeconds(1))
                 .GetConfiguration();
         }
 
diff --git a/src/HumbleConfig.FunctionalTests/HumbleConfig.FunctionalTests.csproj b/src/HumbleConfig.FunctionalTests/HumbleConfig.FunctionalTests.csproj
@@ -142,6 +142,7 @@
     <Compile Include="ConfigurationTests.cs" />
     <Compile Include="CredstashConfigurationTests.cs" />
     <Compile Include="ExpiredCacheConfigurationTests.cs" />
+    <Compile Include="MultiCacheConfigurationTests.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
   <ItemGroup>
diff --git a/src/HumbleConfig.FunctionalTests/MultiCacheConfigurationTests.cs b/src/HumbleConfig.FunctionalTests/MultiCacheConfigurationTests.cs
@@ -0,0 +1,46 @@
+﻿using System.Collections.Generic;
+using System.Runtime.Caching;
+using System.Threading.Tasks;
+using HumbleConfig.Caching;
+using HumbleConfig.InMemory;
+using NUnit.Framework;
+using Ploeh.AutoFixture;
+
+namespace HumbleConfig.FunctionalTests
+{
+    [TestFixture]
+    public class MultiCacheConfigurationTests
+    {
+        private IConfiguration _configuration;
+
+        private string _key1;
+        private Dictionary<string, object> _inMemory;
+        private Fixture _fixture;
+
+        [OneTimeSetUp]
+        public void GivenConfigurationWithEnvironmentVaribleAndConfigurationManager()
+        {
+            _fixture = new Fixture();
+            _key1 = _fixture.Create("key1");
+            _inMemory = new Dictionary<string, object>()
+            {
+                { _key1, "InMemory1"},
+            };
+
+            _configuration = new Configuration()
+                .AddInMemory(new Dictionary<string, object>()).WithDefaultMemoryCache(() => new CacheItemPolicy())
+                .AddInMemory(new Dictionary<string, object>{{ _key1, "InMemory1"}}).WithDefaultMemoryCache(() => new CacheItemPolicy())
+                .GetConfiguration();
+        }
+
+        [Test]
+        public async Task WhenChangingValueStillReturnsTheSameValue()
+        {
+            var value1 = await _configuration.GetAppSettingAsync<string>(_key1);
+            var value2 = await _configuration.GetAppSettingAsync<string>(_key1);
+
+            Assert.AreEqual(value1, "InMemory1");
+            Assert.AreEqual(value2, "InMemory1");
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ protected override IConfigurationSource CreateConfigurationSource()`
`17`	`17`	`innerSource.Setup(x => x.GetAppSettingAsync<TValue>(It.IsAny<string>(), It.IsAny<CancellationToken>()))`
`18`	`18`	`.ReturnsAsync(ConfigurationSourceResult<TValue>.FailedResult());`
`19`	`19`
`20`		`- var source = new CachingConfigurationSourceDecorator(innerSource.Object, MemoryCache.Default, () => new CacheItemPolicy());`
	`20`	`+ var source = new CachingConfigurationSourceDecorator(innerSource.Object, new CacheKeyCreator(Guid.NewGuid().ToString()), MemoryCache.Default, () => new CacheItemPolicy());`
`21`	`21`
`22`	`22`	`return source;`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ protected override IConfigurationSource CreateConfigurationSource()`
`21`	`21`	`innerSource.Setup(x => x.GetAppSettingAsync<TValue>(It.IsAny<string>(), It.IsAny<CancellationToken>()))`
`22`	`22`	`.Throws(new Exception("Should never get here"));`
`23`	`23`
`24`		`- var source = new CachingConfigurationSourceDecorator(innerSource.Object, objectCache.Object, () => new CacheItemPolicy());`
	`24`	`+ var source = new CachingConfigurationSourceDecorator(innerSource.Object, new CacheKeyCreator(Guid.NewGuid().ToString()), objectCache.Object, () => new CacheItemPolicy());`
`25`	`25`
`26`	`26`	`return source;`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ protected override IConfigurationSource GivenConfigurationSourceWithExistingRKey`
`18`	`18`	`innerSource.Setup(x => x.GetAppSettingAsync<TValue>(key, cancellationToken))`
`19`	`19`	`.ReturnsAsync(ConfigurationSourceResult<TValue>.SuccessResult(expectedValue));`
`20`	`20`
`21`		`- var source = new CachingConfigurationSourceDecorator(innerSource.Object, MemoryCache.Default, () => new CacheItemPolicy());`
	`21`	`+ var source = new CachingConfigurationSourceDecorator(innerSource.Object, new CacheKeyCreator(Guid.NewGuid().ToString()), MemoryCache.Default, () => new CacheItemPolicy());`
`22`	`22`
`23`	`23`	`return source;`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,19 +8,21 @@ namespace HumbleConfig.Caching`
`8`	`8`	`public class CachingConfigurationSourceDecorator : IConfigurationSource`
`9`	`9`	`{`
`10`	`10`	`private readonly IConfigurationSource _innerSource;`
	`11`	`+ private readonly ICacheKeyCreator _cacheKeyCreator;`
`11`	`12`	`private readonly ObjectCache _objectCache;`
`12`	`13`	`private readonly Func<CacheItemPolicy> _cacheItemPolicyFactory;`
`13`	`14`
`14`		`- public CachingConfigurationSourceDecorator(IConfigurationSource innerSource, ObjectCache objectCache, Func<CacheItemPolicy> cacheItemPolicyFactoryFactory)`
	`15`	`+ public CachingConfigurationSourceDecorator(IConfigurationSource innerSource, ICacheKeyCreator cacheKeyCreator, ObjectCache objectCache, Func<CacheItemPolicy> cacheItemPolicyFactoryFactory)`
`15`	`16`	`{`
`16`	`17`	`_innerSource = innerSource;`
	`18`	`+ _cacheKeyCreator = cacheKeyCreator;`
`17`	`19`	`_objectCache = objectCache;`
`18`	`20`	`_cacheItemPolicyFactory = cacheItemPolicyFactoryFactory;`
`19`	`21`	`}`
`20`	`22`
`21`	`23`	`public async Task<ConfigurationSourceResult<TValue>> GetAppSettingAsync<TValue>(string key, CancellationToken cancellationToken = default(CancellationToken))`
`22`	`24`	`{`
`23`		`- var appsetting = (ConfigurationSourceResult<TValue>)_objectCache.Get(CreateCacheKey(key));`
	`25`	`+ var appsetting = (ConfigurationSourceResult<TValue>)_objectCache.Get(_cacheKeyCreator.CreateCacheKey(key));`
`24`	`26`
`25`	`27`	`if (appsetting == null)`
`26`	`28`	`{`
`@@ -32,15 +34,11 @@ public CachingConfigurationSourceDecorator(IConfigurationSource innerSource, Obj`
`32`	`34`
`33`	`35`	`return appsetting;`
`34`	`36`	`}`
`35`		`-`
`36`		`- private static string CreateCacheKey(string key)`
`37`		`- {`
`38`		`- return $"HumbleConfig-{key}";`
`39`		`- }`
	`37`	`+`
`40`	`38`
`41`	`39`	`private CacheItem CreateCacheItem<TValue>(string key, ConfigurationSourceResult<TValue> value)`
`42`	`40`	`{`
`43`		`- return new CacheItem(CreateCacheKey(key), value);`
	`41`	`+ return new CacheItem(_cacheKeyCreator.CreateCacheKey(key), value);`
`44`	`42`	`}`
`45`	`43`	`}`
`46`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,22 +6,29 @@ namespace HumbleConfig.Caching`
`6`	`6`	`{`
`7`	`7`	`public static class CachingExtentions`
`8`	`8`	`{`
`9`		`- public static IConfigurationSourceConfigurator WithCache(this IConfigurationSourceConfigurator a, ObjectCache objectCache, Func<CacheItemPolicy> cacheItemPolicyFactory)`
	`9`	`+ public static IConfigurationSourceConfigurator WithCache(this IConfigurationSourceConfigurator configurationSourceConfigurator, ICacheKeyCreator cacheKeyCreator, ObjectCache objectCache, Func<CacheItemPolicy> cacheItemPolicyFactory)`
`10`	`10`	`{`
`11`		`- return a.WrapSource(x => new CachingConfigurationSourceDecorator(x, objectCache, cacheItemPolicyFactory));`
	`11`	`+ return configurationSourceConfigurator.WrapSource(x => new CachingConfigurationSourceDecorator(x, cacheKeyCreator, objectCache, cacheItemPolicyFactory));`
`12`	`12`	`}`
`13`	`13`
`14`		`- public static IConfigurationSourceConfigurator WithDefaultMemoryCache(this IConfigurationSourceConfigurator a, Func<CacheItemPolicy> cacheItemPolicyFactory)`
	`14`	`+ public static IConfigurationSourceConfigurator WithCache(this IConfigurationSourceConfigurator configurationSourceConfigurator, ObjectCache objectCache, Func<CacheItemPolicy> cacheItemPolicyFactory)`
`15`	`15`	`{`
`16`		`- return a.WrapSource(x => new CachingConfigurationSourceDecorator(x, MemoryCache.Default, cacheItemPolicyFactory));`
	`16`	`+ var cacheKeyCreator = new CacheKeyCreator(Guid.NewGuid().ToString());`
	`17`	`+`
	`18`	`+ return WithCache(configurationSourceConfigurator, cacheKeyCreator, objectCache, cacheItemPolicyFactory);`
	`19`	`+ }`
	`20`	`+`
	`21`	`+ public static IConfigurationSourceConfigurator WithDefaultMemoryCache(this IConfigurationSourceConfigurator configurationSourceConfigurator, Func<CacheItemPolicy> cacheItemPolicyFactory)`
	`22`	`+ {`
	`23`	`+ return WithCache(configurationSourceConfigurator, MemoryCache.Default, cacheItemPolicyFactory);`
`17`	`24`	`}`
`18`	`25`
`19`		`- public static IConfigurationSourceConfigurator WithDefaultMemoryCache(this IConfigurationSourceConfigurator a, TimeSpan expiresAfter)`
	`26`	`+ public static IConfigurationSourceConfigurator WithDefaultMemoryCache(this IConfigurationSourceConfigurator configurationSourceConfigurator, TimeSpan expiresAfter)`
`20`	`27`	`{`
`21`		`- return a.WrapSource(x => new CachingConfigurationSourceDecorator(x, MemoryCache.Default, () => new CacheItemPolicy()`
	`28`	`+ return WithDefaultMemoryCache(configurationSourceConfigurator, () => new CacheItemPolicy()`
`22`	`29`	`{`
`23`	`30`	`AbsoluteExpiration = DateTimeOffset.UtcNow.Add(expiresAfter)`
`24`		`- }));`
	`31`	`+ });`
`25`	`32`	`}`
`26`	`33`	`}`
`27`	`34`	`}`