feat: expose raw cache database

dotnetcore · Sep 20, 2021 · a48832c · a48832c
1 parent 9474dce
commit a48832c
Show file tree

Hide file tree

Showing 18 changed files with 105 additions and 45 deletions.
diff --git a/build/version.props b/build/version.props
@@ -1,24 +1,24 @@
 <Project>
 	<PropertyGroup>
-		<EasyCachingCorePackageVersion>1.4.0</EasyCachingCorePackageVersion>
-		<EasyCachingMemcachedPackageVersion>1.4.0</EasyCachingMemcachedPackageVersion>
-		<EasyCachingRedisPackageVersion>1.4.0</EasyCachingRedisPackageVersion>
-		<EasyCachingSQLitePackageVersion>1.4.0</EasyCachingSQLitePackageVersion>
-		<EasyCachingInMemoryPackageVersion>1.4.0</EasyCachingInMemoryPackageVersion>
-		<EasyCachingHybridPackageVersion>1.4.0</EasyCachingHybridPackageVersion>
-		<EasyCachingAspectCorePackageVersion>1.4.0</EasyCachingAspectCorePackageVersion>
-		<EasyCachingCastlePackageVersion>1.4.0</EasyCachingCastlePackageVersion>
-		<EasyCachingResponseCachingPackageVersion>1.4.0</EasyCachingResponseCachingPackageVersion>
-		<EasyCachingJsonPackageVersion>1.4.0</EasyCachingJsonPackageVersion>
-		<EasyCachingMessagePackPackageVersion>1.4.0</EasyCachingMessagePackPackageVersion>
-		<EasyCachingProtobufPackageVersion>1.4.0</EasyCachingProtobufPackageVersion>
-		<EasyCachingCSRedisPackageVersion>1.4.0</EasyCachingCSRedisPackageVersion>
-		<EasyCachingRedisBusPackageVersion>1.4.0</EasyCachingRedisBusPackageVersion>
-		<EasyCachingCSRedisBusPackageVersion>1.4.0</EasyCachingCSRedisBusPackageVersion>
-		<EasyCachingRabbitBusPackageVersion>1.4.0</EasyCachingRabbitBusPackageVersion>
-		<EasyCachingDiskPackageVersion>1.4.0</EasyCachingDiskPackageVersion>
-		<EasyCachingMsExtPackageVersion>1.4.0</EasyCachingMsExtPackageVersion>
-		<EasyCachingLiteDBPackageVersion>1.4.0</EasyCachingLiteDBPackageVersion>
-		<EasyCachingSTJsonPackageVersion>1.4.0</EasyCachingSTJsonPackageVersion>
+		<EasyCachingCorePackageVersion>1.4.1</EasyCachingCorePackageVersion>
+		<EasyCachingMemcachedPackageVersion>1.4.1</EasyCachingMemcachedPackageVersion>
+		<EasyCachingRedisPackageVersion>1.4.1</EasyCachingRedisPackageVersion>
+		<EasyCachingSQLitePackageVersion>1.4.1</EasyCachingSQLitePackageVersion>
+		<EasyCachingInMemoryPackageVersion>1.4.1</EasyCachingInMemoryPackageVersion>
+		<EasyCachingHybridPackageVersion>1.4.1</EasyCachingHybridPackageVersion>
+		<EasyCachingAspectCorePackageVersion>1.4.1</EasyCachingAspectCorePackageVersion>
+		<EasyCachingCastlePackageVersion>1.4.1</EasyCachingCastlePackageVersion>
+		<EasyCachingResponseCachingPackageVersion>1.4.1</EasyCachingResponseCachingPackageVersion>
+		<EasyCachingJsonPackageVersion>1.4.1</EasyCachingJsonPackageVersion>
+		<EasyCachingMessagePackPackageVersion>1.4.1</EasyCachingMessagePackPackageVersion>
+		<EasyCachingProtobufPackageVersion>1.4.1</EasyCachingProtobufPackageVersion>
+		<EasyCachingCSRedisPackageVersion>1.4.1</EasyCachingCSRedisPackageVersion>
+		<EasyCachingRedisBusPackageVersion>1.4.1</EasyCachingRedisBusPackageVersion>
+		<EasyCachingCSRedisBusPackageVersion>1.4.1</EasyCachingCSRedisBusPackageVersion>
+		<EasyCachingRabbitBusPackageVersion>1.4.1</EasyCachingRabbitBusPackageVersion>
+		<EasyCachingDiskPackageVersion>1.4.1</EasyCachingDiskPackageVersion>
+		<EasyCachingMsExtPackageVersion>1.4.1</EasyCachingMsExtPackageVersion>
+		<EasyCachingLiteDBPackageVersion>1.4.1</EasyCachingLiteDBPackageVersion>
+		<EasyCachingSTJsonPackageVersion>1.4.1</EasyCachingSTJsonPackageVersion>
 	</PropertyGroup>
 </Project>
diff --git a/src/EasyCaching.CSRedis/DefaultCSRedisCachingProvider.cs b/src/EasyCaching.CSRedis/DefaultCSRedisCachingProvider.cs
@@ -3,7 +3,7 @@
     using EasyCaching.Core;
     using EasyCaching.Core.DistributedLock;
     using EasyCaching.Core.Serialization;
-using EasyCaching.CSRedis.DistributedLock;
+    using EasyCaching.CSRedis.DistributedLock;
     using global::CSRedis;
     using Microsoft.Extensions.Logging;
     using System;
@@ -482,9 +482,8 @@ public override TimeSpan BaseGetExpiration(string cacheKey)
         /// Get te information of this provider.
         /// </summary>
         /// <returns></returns>
-        public override ProviderInfo BaseGetProviderInfo()
-        {
-            return _info;
-        }
+        public override ProviderInfo BaseGetProviderInfo() => _info;
+
+        public override object BaseGetDatabse() => _cache;
     }
 }
diff --git a/src/EasyCaching.Core/EasyCachingAbstractProvider.cs b/src/EasyCaching.Core/EasyCachingAbstractProvider.cs
@@ -31,6 +31,8 @@ public abstract class EasyCachingAbstractProvider : IEasyCachingProvider
         public CachingProviderType CachingProviderType => this.ProviderType;
         public CacheStats CacheStats => this.ProviderStats;
 
+        public object Database => BaseGetDatabse();
+
         protected EasyCachingAbstractProvider() { }
 
         protected EasyCachingAbstractProvider(IDistributedLockFactory lockFactory, BaseProviderOptions options)
@@ -39,6 +41,7 @@ protected EasyCachingAbstractProvider(IDistributedLockFactory lockFactory, BaseP
             _options = options;
         }
 
+        public abstract object BaseGetDatabse();
         public abstract bool BaseExists(string cacheKey);
         public abstract Task<bool> BaseExistsAsync(string cacheKey);
         public abstract void BaseFlush();

diff --git a/src/EasyCaching.Core/IEasyCachingProvider.cs b/src/EasyCaching.Core/IEasyCachingProvider.cs
@@ -115,5 +115,10 @@ public interface IEasyCachingProvider : IEasyCachingProviderBase
         /// </summary>
         /// <returns></returns>
         ProviderInfo GetProviderInfo();
+
+        /// <summary>
+        /// Get or sets the provider's database
+        /// </summary>
+        object Database { get; }
     }
 }
diff --git a/src/EasyCaching.Disk/DefaultDiskCachingProvider.cs b/src/EasyCaching.Disk/DefaultDiskCachingProvider.cs
@@ -673,9 +673,8 @@ private void DeleteDirectory(string path)
             }
         }
 
-        public override ProviderInfo BaseGetProviderInfo()
-        {
-            return _info;
-        }
+        public override ProviderInfo BaseGetProviderInfo() => _info;
+
+        public override object BaseGetDatabse() => throw new Exception("Disk provider don't support this ");
     }
 }
diff --git a/src/EasyCaching.InMemory/DefaultInMemoryCachingProvider.cs b/src/EasyCaching.InMemory/DefaultInMemoryCachingProvider.cs
@@ -375,9 +375,8 @@ public override TimeSpan BaseGetExpiration(string cacheKey)
         /// Get te information of this provider.
         /// </summary>
         /// <returns></returns>
-        public override ProviderInfo BaseGetProviderInfo()
-        {
-            return _info;
-        }
+        public override ProviderInfo BaseGetProviderInfo() => _info;
+
+        public override object BaseGetDatabse() => _cache;
     }
 }
diff --git a/src/EasyCaching.LiteDB/DefaultLiteDBCachingProvider.cs b/src/EasyCaching.LiteDB/DefaultLiteDBCachingProvider.cs
@@ -402,9 +402,8 @@ public override TimeSpan BaseGetExpiration(string cacheKey)
         /// Get te information of this provider.
         /// </summary>
         /// <returns></returns>
-        public override ProviderInfo BaseGetProviderInfo()
-        {
-            return _info;
-        }
+        public override ProviderInfo BaseGetProviderInfo() => _info;
+
+        public override object BaseGetDatabse() => _cache;
     }
 }
diff --git a/src/EasyCaching.Memcached/DefaultMemcachedCachingProvider.cs b/src/EasyCaching.Memcached/DefaultMemcachedCachingProvider.cs
@@ -412,6 +412,8 @@ public override ProviderInfo BaseGetProviderInfo()
             return _info;
         }
 
+        public override object BaseGetDatabse() => _memcachedClient;
+
         private void OnCacheHit(string cacheKey)
         {
             CacheStats.OnHit();

diff --git a/src/EasyCaching.Redis/DefaultRedisCachingProvider.cs b/src/EasyCaching.Redis/DefaultRedisCachingProvider.cs
@@ -512,9 +512,8 @@ public override TimeSpan BaseGetExpiration(string cacheKey)
         /// Get te information of this provider.
         /// </summary>
         /// <returns></returns>
-        public override ProviderInfo BaseGetProviderInfo()
-        {
-            return _info;
-        }
+        public override ProviderInfo BaseGetProviderInfo() => _info;
+
+        public override object BaseGetDatabse() => _cache;
     }
 }
diff --git a/src/EasyCaching.SQLite/DefaultSQLiteCachingProvider.cs b/src/EasyCaching.SQLite/DefaultSQLiteCachingProvider.cs
@@ -413,9 +413,8 @@ public override TimeSpan BaseGetExpiration(string cacheKey)
         /// Get te information of this provider.
         /// </summary>
         /// <returns></returns>
-        public override ProviderInfo BaseGetProviderInfo()
-        {
-            return _info;
-        }
+        public override ProviderInfo BaseGetProviderInfo() => _info;
+
+        public override object BaseGetDatabse() => _cache;
     }
 }
diff --git a/test/EasyCaching.UnitTests/CachingTests/CSRedisCachingProviderTest.cs b/test/EasyCaching.UnitTests/CachingTests/CSRedisCachingProviderTest.cs
@@ -38,6 +38,15 @@ protected override IEasyCachingProvider CreateCachingProvider(Action<BaseProvide
             IServiceProvider serviceProvider = services.BuildServiceProvider();
             return serviceProvider.GetService<IEasyCachingProvider>();
         }
+
+        [Fact]
+        public void GetDatabase_Should_Succeed()
+        {
+            var db = _provider.Database;
+
+            Assert.NotNull(db);
+            Assert.IsType<EasyCachingCSRedisClient>(db);
+        }
     }
 
     public class CSRedisCachingProviderWithNamedSerTest

diff --git a/test/EasyCaching.UnitTests/CachingTests/LiteDBCachingTest.cs b/test/EasyCaching.UnitTests/CachingTests/LiteDBCachingTest.cs
@@ -9,6 +9,7 @@
     using System.IO;
     using System.Threading.Tasks;
     using Xunit;
+    using global::LiteDB;
 
     public class LiteDBCachingTest : BaseCachingProviderTest
     {
@@ -45,6 +46,15 @@ protected override Task GetAsync_Parallel_Should_Succeed()
         protected override void Get_Parallel_Should_Succeed()
         {
         }
+
+        [Fact]
+        public void GetDatabase_Should_Succeed()
+        {
+            var db = _provider.Database;
+
+            Assert.NotNull(db);
+            Assert.IsAssignableFrom<ILiteCollection<CacheItem>>(db);
+        }
     }
 
 

diff --git a/test/EasyCaching.UnitTests/CachingTests/MemcachedProviderTest.cs b/test/EasyCaching.UnitTests/CachingTests/MemcachedProviderTest.cs
@@ -186,6 +186,15 @@ private void GetCacheItem(string cacheKey, string prefix)
             var val = _provider.Get<string>(cacheKey);
             Assert.False(val.HasValue);
         }
+
+        [Fact]
+        public void GetDatabase_Should_Succeed()
+        {
+            var db = _provider.Database;
+
+            Assert.NotNull(db);
+            Assert.IsType<EasyCachingMemcachedClient>(db);
+        }
     }
 
 

diff --git a/test/EasyCaching.UnitTests/CachingTests/MemoryCachingProviderTest.cs b/test/EasyCaching.UnitTests/CachingTests/MemoryCachingProviderTest.cs
@@ -109,7 +109,17 @@ public void Issues150_DeepClone_Object_Test()
 
             Assert.Equal("catcherwong", res2.Value.Name);
         }
+
+        [Fact]
+        public void GetDatabase_Should_Succeed()
+        {
+            var db = _provider.Database;
+
+            Assert.NotNull(db);
+            Assert.IsType<InMemoryCaching>(db);
+        }
     }
+
     public class MemoryCachingProviderWithFactoryTest : BaseCachingProviderWithFactoryTest
     {
         public MemoryCachingProviderWithFactoryTest()

diff --git a/test/EasyCaching.UnitTests/CachingTests/RedisCachingProviderTest.cs b/test/EasyCaching.UnitTests/CachingTests/RedisCachingProviderTest.cs
@@ -95,6 +95,15 @@ public void Use_Configuration_String_Should_Succeed()
 
             Assert.Equal(8, dbProvider.GetDatabase().Database);
         }
+
+        [Fact]
+        public void GetDatabase_Should_Succeed()
+        {
+            var db = _provider.Database;
+
+            Assert.NotNull(db);
+            Assert.IsType<StackExchange.Redis.IDatabase>(db);
+        }
     }
 
 

diff --git a/test/EasyCaching.UnitTests/Diagnostics/MyCachingProvider.cs b/test/EasyCaching.UnitTests/Diagnostics/MyCachingProvider.cs
@@ -165,5 +165,10 @@ public override Task<bool> BaseTrySetAsync<T>(string cacheKey, T cacheValue, Tim
         {
             return Task.FromResult(false);
         }
+
+        public override object BaseGetDatabse()
+        {
+            return null;
+        }
     }
 }
diff --git a/test/EasyCaching.UnitTests/Fake/FakeDistributedCachingProvider.cs b/test/EasyCaching.UnitTests/Fake/FakeDistributedCachingProvider.cs
@@ -21,6 +21,8 @@ public class FakeDistributedCachingProvider : IEasyCachingProvider
 
         public CacheStats CacheStats => new CacheStats();
 
+        public object Database => null;
+
         public virtual bool Exists(string cacheKey)
         {
             return true;

diff --git a/test/EasyCaching.UnitTests/Fake/FakeLocalCachingProvider.cs b/test/EasyCaching.UnitTests/Fake/FakeLocalCachingProvider.cs
@@ -21,6 +21,8 @@ public class FakeLocalCachingProvider : IEasyCachingProvider
 
         public CacheStats CacheStats => new CacheStats();
 
+        public object Database => null;
+
         public bool Exists(string cacheKey)
         {
             return true;