Beta version of MemoryCacheProvider

reisenberger · reisenberger · commit ee3c52fd52af · 2017-08-29T10:45:34.000+01:00
Beta version of Polly.Caching.MemoryCacheProvider, and specs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,10 @@
-## 0.2-alpha
+# Polly.Caching.MemoryCache change log
 
-- Upgrade to msbuild15 build process
-- Upgrade to Polly v5.3.1
+## 0.2-beta
+
+- Beta implementation
+- Rebase against Polly v5.3.x
+- Upgrade to msbuild15 build process 
 
 ## 0.1-alpha
 
diff --git a/GitVersionConfig.yaml b/GitVersionConfig.yaml
@@ -1 +1 @@
-next-version: 0.2.0-alpha
+next-version: 0.2.0-beta
diff --git a/README.md b/README.md
@@ -20,20 +20,20 @@ You can install the Strongly Named version via:
 
 # Supported targets
 
-Polly.Caching.MemoryCache supports [to come].
+Polly.Caching.MemoryCache supports .NET4.0, .NET4.5 and .NetStandard 1.3.
 
 ## Dependencies
 
-None 
+[To come]
 
-# How to use the MemoryCache plugin
+# How to use the Polly.Caching.MemoryCache plugin
 
 [To come]
 
 
 ## How to use the Polly Cache policy
 
-See the [Polly readme](https://github.com/App-vNext/Polly/wiki/Cache) or [deep doco on the Polly wiki](https://github.com/App-vNext/Polly/wiki/Cache).
+See the [To be expanded] [Polly readme](https://github.com/App-vNext/Polly/wiki/Cache) or [To be expanded] [deep doco on the Polly wiki](https://github.com/App-vNext/Polly/wiki/Cache).
 
 
 # Release notes
diff --git a/src/Polly.Caching.MemoryCache.Net40Async.Specs/Polly.Caching.MemoryCache.Net40Async.Specs.csproj b/src/Polly.Caching.MemoryCache.Net40Async.Specs/Polly.Caching.MemoryCache.Net40Async.Specs.csproj
@@ -19,6 +19,7 @@
     <Reference Include="System.Data.DataSetExtensions" />
     <Reference Include="System.Net" />
     <Reference Include="System.Net.Http" />
+    <Reference Include="System.Runtime.Caching" />
     <Reference Include="System.Xml" />
     <Reference Include="System.Xml.Linq" />
     <Reference Include="Microsoft.CSharp" />
@@ -29,7 +30,7 @@
     <PackageReference Include="Microsoft.Bcl" Version="1.1.10" />
     <PackageReference Include="Microsoft.Bcl.Async" Version="1.0.168" />
     <PackageReference Include="Microsoft.Bcl.Build" Version="1.0.21" />
-    <PackageReference Include="Polly.Net40Async" Version="5.3.1" />
+    <PackageReference Include="Polly.Net40Async" Version="5.3.2-v5-3-x-cachebeta0001" />
     <PackageReference Include="xunit" Version="2.1.0" />
     <PackageReference Include="xunit.extensibility.execution" Version="2.1.0" />
   </ItemGroup>
@@ -39,7 +40,7 @@
     </Compile>
   </ItemGroup>
   <ItemGroup>
-    <ProjectReference Include="..\Polly.Caching.MemoryCache.Net40Async\Polly.Caching.MemoryCache.Net40Async.csproj"/>
+    <ProjectReference Include="..\Polly.Caching.MemoryCache.Net40Async\Polly.Caching.MemoryCache.Net40Async.csproj" />
   </ItemGroup>
   <ItemGroup>
     <Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
diff --git a/src/Polly.Caching.MemoryCache.Net40Async/Polly.Caching.MemoryCache.Net40Async.csproj b/src/Polly.Caching.MemoryCache.Net40Async/Polly.Caching.MemoryCache.Net40Async.csproj
@@ -19,12 +19,22 @@
   <ItemGroup>
     <Reference Include="System" />
     <Reference Include="System.Core" />
+    <Reference Include="System.Runtime.Caching" />
+    <Reference Include="System.IO, Version=2.6.10.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
+      <HintPath>..\packages\Microsoft.Bcl.1.1.10\lib\net40\System.IO.dll</HintPath>
+    </Reference>
+    <Reference Include="System.Runtime, Version=2.6.10.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
+      <HintPath>..\packages\Microsoft.Bcl.1.1.10\lib\net40\System.Runtime.dll</HintPath>
+    </Reference>
+    <Reference Include="System.Threading.Tasks, Version=2.6.10.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
+      <HintPath>..\packages\Microsoft.Bcl.1.1.10\lib\net40\System.Threading.Tasks.dll</HintPath>
+    </Reference>
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.Bcl" Version="1.1.10" />
     <PackageReference Include="Microsoft.Bcl.Build" Version="1.0.21" />
     <PackageReference Include="Nito.AsyncEx" Version="3.0.1" />
-    <PackageReference Include="Polly.Net40Async" Version="5.3.1" />
+    <PackageReference Include="Polly.Net40Async" Version="5.3.2-v5-3-x-cachebeta0001" />
   </ItemGroup>
   <ItemGroup>
     <Compile Include="..\GlobalAssemblyInfo.cs">
diff --git a/src/Polly.Caching.MemoryCache.Net40Async/Properties/AssemblyInfo.cs b/src/Polly.Caching.MemoryCache.Net40Async/Properties/AssemblyInfo.cs
@@ -3,6 +3,7 @@
 using System.Runtime.CompilerServices;
 
 [assembly: AssemblyTitle("Polly.Caching.MemoryCache")]
-[assembly: CLSCompliant(false)] // Because Nito.AsycEx, on which Polly.Caching.MemoryCache.Net40Async depends, is not CLSCompliant.
+[assembly: CLSCompliant(false)] // Because Nito.AsycEx, on which Polly.Net40Async depends, is not CLSCompliant.
+
 
 [assembly: InternalsVisibleTo("Polly.Caching.MemoryCache.Net40Async.Specs")]
diff --git a/src/Polly.Caching.MemoryCache.Net45.Specs/Polly.Caching.MemoryCache.Net45.Specs.csproj b/src/Polly.Caching.MemoryCache.Net45.Specs/Polly.Caching.MemoryCache.Net45.Specs.csproj
@@ -21,12 +21,13 @@
     <Reference Include="System.Data" />
     <Reference Include="System.Data.DataSetExtensions" />
     <Reference Include="System.Net.Http" />
+    <Reference Include="System.Runtime.Caching" />
     <Reference Include="System.Xml" />
     <Reference Include="System.Xml.Linq" />
     <Reference Include="Microsoft.CSharp" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Polly" Version="5.3.1" />
+    <PackageReference Include="Polly" Version="5.3.2-v5-3-x-cachebeta0001" />
     <PackageReference Include="FluentAssertions" Version="4.17.0" />
     <PackageReference Include="GitVersionTask" Version="3.1.2" />
     <PackageReference Include="xunit" Version="2.1.0" />
@@ -38,7 +39,7 @@
     </Compile>
   </ItemGroup>
   <ItemGroup>
-    <ProjectReference Include="..\Polly.Caching.MemoryCache.Net45\Polly.Caching.MemoryCache.Net45.csproj"/>
+    <ProjectReference Include="..\Polly.Caching.MemoryCache.Net45\Polly.Caching.MemoryCache.Net45.csproj" />
   </ItemGroup>
   <ItemGroup>
     <Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
diff --git a/src/Polly.Caching.MemoryCache.Net45/Polly.Caching.MemoryCache.Net45.csproj b/src/Polly.Caching.MemoryCache.Net45/Polly.Caching.MemoryCache.Net45.csproj
@@ -22,8 +22,9 @@
       <Link>Properties\GlobalAssemblyInfo.cs</Link>
     </Compile>
     <PackageReference Include="GitVersionTask" Version="3.1.2" />
-    <PackageReference Include="Polly" Version="5.3.1" />
+    <PackageReference Include="Polly" Version="5.3.2-v5-3-x-cachebeta0001" />
     <Reference Include="System" />
+    <Reference Include="System.Runtime.Caching" />
   </ItemGroup>
   <Import Project="..\Polly.Caching.MemoryCache.Shared\Polly.Caching.MemoryCache.Shared.projitems" Label="Shared" />
 </Project>
diff --git a/src/Polly.Caching.MemoryCache.NetStandard13.Specs/Polly.Caching.MemoryCache.NetStandard13.Specs.csproj b/src/Polly.Caching.MemoryCache.NetStandard13.Specs/Polly.Caching.MemoryCache.NetStandard13.Specs.csproj
@@ -7,19 +7,19 @@
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugType>full</DebugType>
-    <DefineConstants>TRACE;DEBUG;NETCOREAPP1_1</DefineConstants>
+    <DefineConstants>TRACE;DEBUG;NETCOREAPP1_1;NETCOREAPP1_1;PORTABLE</DefineConstants>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
     <Optimize>true</Optimize>
-    <DefineConstants>TRACE;RELEASE;NETCOREAPP1_1</DefineConstants>
+    <DefineConstants>TRACE;RELEASE;NETCOREAPP1_1;RELEASE;NETCOREAPP1_1;PORTABLE</DefineConstants>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="FluentAssertions" Version="4.19.3" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" />
     <PackageReference Include="xunit" Version="2.2.0" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
-    <PackageReference Include="Polly" Version="5.3.1" />
+    <PackageReference Include="Polly" Version="5.3.2-v5-3-x-cachebeta0001" />
 
   </ItemGroup>
   <ItemGroup>
diff --git a/src/Polly.Caching.MemoryCache.NetStandard13/Polly.Caching.MemoryCache.NetStandard13.csproj b/src/Polly.Caching.MemoryCache.NetStandard13/Polly.Caching.MemoryCache.NetStandard13.csproj
@@ -27,5 +27,9 @@
       <Link>Properties\GlobalAssemblyInfo.cs</Link>
     </Compile>
   </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="1.1.2" />
+    <PackageReference Include="Polly" Version="5.3.2-v5-3-x-cachebeta0001" />
+  </ItemGroup>
   <Import Project="..\Polly.Caching.MemoryCache.Shared\Polly.Caching.MemoryCache.Shared.projitems" Label="Shared" />
 </Project>
diff --git a/src/Polly.Caching.MemoryCache.NetStandard13/Properties/AssemblyInfo.cs b/src/Polly.Caching.MemoryCache.NetStandard13/Properties/AssemblyInfo.cs
@@ -4,6 +4,6 @@
 
 [assembly: AssemblyTitle("Polly.Caching.MemoryCache")]
 [assembly: AssemblyVersion("0.2.0.0")]
-[assembly: CLSCompliant(true)]
+[assembly: CLSCompliant(false)] // Because Microsoft.Extensions.Caching.Memory.MemoryCache, on which Polly.Caching.MemoryCache.NetStandard13 depends, is not CLSCompliant.
 
 [assembly: InternalsVisibleTo("Polly.Caching.MemoryCache.NetStandard13.Specs")]
diff --git a/src/Polly.Caching.MemoryCache.Shared/MemoryCacheProvider.cs b/src/Polly.Caching.MemoryCache.Shared/MemoryCacheProvider.cs
@@ -0,0 +1,126 @@
+﻿using System;
+using Polly.Utilities;
+using System.Threading;
+using System.Threading.Tasks;
+
+#if PORTABLE
+using MemoryCacheImplementation = Microsoft.Extensions.Caching.Memory.IMemoryCache;
+#else
+using MemoryCacheImplementation = System.Runtime.Caching.MemoryCache;
+#endif
+
+namespace Polly.Caching.MemoryCache
+{
+#if PORTABLE
+    /// <summary>
+    /// A cache provider for the Polly CachePolicy, using a passed-in instance of <see cref="Microsoft.Extensions.Caching.Memory.MemoryCache"/> as the store.
+    /// </summary>
+#else
+    /// <summary>
+    /// A cache provider for the Polly CachePolicy, using a passed-in instance of <see cref="System.Runtime.Caching.MemoryCache"/> as the store.
+    /// </summary>
+#endif
+    public class MemoryCacheProvider : ISyncCacheProvider, IAsyncCacheProvider
+    {
+        private readonly MemoryCacheImplementation _cache;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MemoryCacheProvider"/> class.
+        /// </summary>
+        /// <param name="memoryCache">The memory cache instance in which to store cached items.</param>
+        public MemoryCacheProvider(MemoryCacheImplementation memoryCache)
+        {
+            if (memoryCache == null) throw new ArgumentNullException(nameof(memoryCache));
+            _cache = memoryCache;
+        }
+
+        /// <summary>
+        /// Gets a value from cache.
+        /// </summary>
+        /// <param name="key">The cache key.</param>
+        /// <returns>The value from cache; or null, if none was found.</returns>
+        public object Get(String key)
+        {
+#if PORTABLE
+            object value;
+            if (_cache.TryGetValue(key, out value))
+            {
+                return value;
+            }
+            return null;
+#else
+            return _cache.Get(key);
+#endif
+
+        }
+        
+        /// <summary>
+        /// Puts the specified value in the cache.
+        /// </summary>
+        /// <param name="key">The cache key.</param>
+        /// <param name="value">The value to put into the cache.</param>
+        /// <param name="ttl">The time-to-live for the cache entry.</param>
+        public void Put(string key, object value, Ttl ttl)
+        {
+#if PORTABLE
+            using (Microsoft.Extensions.Caching.Memory.ICacheEntry entry = _cache.CreateEntry(key)) { 
+                entry.Value = value;
+                if (ttl.SlidingExpiration)
+                {
+                    entry.SlidingExpiration = ttl.Timespan;
+                }
+                else
+                {
+                    entry.AbsoluteExpirationRelativeToNow = ttl.Timespan;
+                }
+            }
+#else
+            System.Runtime.Caching.CacheItemPolicy cacheItemPolicy = new System.Runtime.Caching.CacheItemPolicy();
+            if (ttl.SlidingExpiration)
+            {
+                cacheItemPolicy.SlidingExpiration = ttl.Timespan;
+            }
+            else
+            {
+                cacheItemPolicy.AbsoluteExpiration = SystemClock.DateTimeOffsetUtcNow().Add(ttl.Timespan);
+            }
+            _cache.Set(key, value, cacheItemPolicy);
+#endif
+        }
+
+        /// <summary>
+        /// Gets a value from the memory cache as part of an asynchronous execution.  <para><remarks>The implementation is synchronous as there is no advantage to an asynchronous implementation for an in-memory cache.</remarks></para>
+        /// </summary>
+        /// <param name="key">The cache key.</param>
+        /// <param name="cancellationToken">The cancellation token.  </param>
+        /// <param name="continueOnCapturedContext">Whether async calls should continue on a captured synchronization context. <para><remarks>For <see cref="MemoryCacheProvider"/>, this parameter is irrelevant and is ignored, as the implementation is synchronous.</remarks></para></param>
+        /// <returns>A <see cref="Task{TResult}" /> promising as Result the value from cache; or null, if none was found.</returns>
+        public Task<object> GetAsync(string key, CancellationToken cancellationToken, bool continueOnCapturedContext)
+        {
+            cancellationToken.ThrowIfCancellationRequested();
+            return TaskHelper.FromResult(Get(key));
+            // (With C#7.0, a ValueTask<> approach would be preferred, but some of our tfms do not support that.  TO DO: Implement it, with preprocessor if/endif directives, for NetStandard)
+        }
+
+        /// <summary>
+        /// Puts the specified value in the cache as part of an asynchronous execution.
+        /// <para><remarks>The implementation is synchronous as there is no advantage to an asynchronous implementation for an in-memory cache.</remarks></para>
+        /// </summary>
+        /// <param name="key">The cache key.</param>
+        /// <param name="value">The value to put into the cache.</param>
+        /// <param name="ttl">The time-to-live for the cache entry.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+        /// <param name="continueOnCapturedContext">Whether async calls should continue on a captured synchronization context. <para><remarks>For <see cref="MemoryCacheProvider"/>, this parameter is irrelevant and is ignored, as the implementation is synchronous.</remarks></para></param>
+        /// <returns>A <see cref="Task" /> which completes when the value has been cached.</returns>
+        public Task PutAsync(string key, object value, Ttl ttl, CancellationToken cancellationToken, bool continueOnCapturedContext)
+        {
+            cancellationToken.ThrowIfCancellationRequested();
+            Put(key, value, ttl);
+            return TaskHelper.EmptyTask;
+            // (With C#7.0, a ValueTask<> approach would be preferred, but some of our tfms do not support that. TO DO: Implement it, with preprocessor if/endif directives, for NetStandard)
+        }
+
+
+
+    }
+}
diff --git a/src/Polly.Caching.MemoryCache.Shared/Polly.Caching.MemoryCache.Shared.projitems b/src/Polly.Caching.MemoryCache.Shared/Polly.Caching.MemoryCache.Shared.projitems
@@ -9,6 +9,6 @@
     <Import_RootNamespace>Polly.Caching.MemoryCache</Import_RootNamespace>
   </PropertyGroup>
   <ItemGroup>
-    <Compile Include="$(MSBuildThisFileDirectory)SomeClass.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)MemoryCacheProvider.cs" />
   </ItemGroup>
 </Project>
diff --git a/src/Polly.Caching.MemoryCache.Shared/SomeClass.cs b/src/Polly.Caching.MemoryCache.Shared/SomeClass.cs
diff --git a/src/Polly.Caching.MemoryCache.SharedSpecs/MemoryCacheProviderSpecs.cs b/src/Polly.Caching.MemoryCache.SharedSpecs/MemoryCacheProviderSpecs.cs
diff --git a/src/Polly.Caching.MemoryCache.SharedSpecs/Polly.Caching.MemoryCache.SharedSpecs.projitems b/src/Polly.Caching.MemoryCache.SharedSpecs/Polly.Caching.MemoryCache.SharedSpecs.projitems
diff --git a/src/Polly.Caching.MemoryCache.SharedSpecs/SomeClassSpecs.cs b/src/Polly.Caching.MemoryCache.SharedSpecs/SomeClassSpecs.cs

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-next-version: 0.2.0-alpha`
	`1`	`+next-version: 0.2.0-beta`