Merge pull request #9 from PandaTechAM/development

Total redesign by implementing hybrid cache.

Author: HaikAsatryan

Readme.md

@@ -8,13 +8,13 @@
         <PackageReadmeFile>Readme.md</PackageReadmeFile>
         <Authors>Pandatech</Authors>
         <Copyright>MIT</Copyright>
-        <Version>3.0.1</Version>
+        <Version>4.0.0</Version>
         <PackageId>Pandatech.DistributedCache</PackageId>
         <Title>Pandatech Distributed Cache</Title>
-        <PackageTags>Pandatech, library, redis, distributed locks, cache</PackageTags>
-        <Description>Pandatech.DistributedCache is a comprehensive caching library designed for .NET applications, leveraging the power of Redis. It provides easy-to-use and highly configurable caching mechanisms, including support for tagged cache entries, customizable expiration policies, and robust health check services. The library also features built-in distributed lock mechanisms to ensure data consistency and prevent cache stampedes. This ensures high performance, scalability, and reliability, making it an ideal choice for enterprise-level distributed caching needs.</Description>
+        <PackageTags>pandatech;cache;hybrid-cache;distributed-cahce;message-pack;rate-limiting;redis-lock;redis;fusion-cache</PackageTags>
+        <Description>Pandatech.DistributedCache is a lightweight .NET library that extends the new HybridCache abstraction for seamless distributed caching on top of Redis. It provides strongly typed caching with MessagePack serialization, distributed locking, rate limiting, and stampede protection. With fewer than 500 lines of code, it is both easy to understand and simple to adopt, while still offering robust features for production environments.</Description>
         <RepositoryUrl>https://github.com/PandaTechAM/be-lib-distributed-cache</RepositoryUrl>
-        <PackageReleaseNotes>Added healthcheck</PackageReleaseNotes>
+        <PackageReleaseNotes>Changed ICacheService with HybridCache interface. Not backward compatible with previous version</PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>
@@ -23,11 +23,12 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="AspNetCore.HealthChecks.Redis" Version="8.0.1" />
-        <PackageReference Include="MessagePack" Version="2.5.192" />
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0" />
-        <PackageReference Include="StackExchange.Redis.Extensions.AspNetCore" Version="10.2.0"/>
-        <PackageReference Include="StackExchange.Redis.Extensions.MsgPack" Version="10.2.0"/>
+        <PackageReference Include="AspNetCore.HealthChecks.Redis" Version="9.0.0"/>
+        <PackageReference Include="MessagePack" Version="3.1.2"/>
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.1"/>
+        <PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="9.0.1"/>
+        <PackageReference Include="StackExchange.Redis.Extensions.AspNetCore" Version="11.0.0"/>
+        <PackageReference Include="StackExchange.Redis.Extensions.MsgPack" Version="11.0.0"/>
     </ItemGroup>
 
 </Project>

src/DistributedCache/DistributedCache.csproj

@@ -5,7 +5,8 @@ namespace DistributedCache.Extensions;
 
 internal static class HealthCheckExtension
 {
-   internal static WebApplicationBuilder AddRedisHealthCheck(this WebApplicationBuilder builder, string connectionString)
+   internal static WebApplicationBuilder AddRedisHealthCheck(this WebApplicationBuilder builder,
+      string connectionString)
    {
       builder.Services
              .AddHealthChecks()

src/DistributedCache/Extensions/HealthCheckExtension.cs

@@ -0,0 +1,51 @@
+using Microsoft.Extensions.Caching.Hybrid;
+
+namespace DistributedCache.Extensions;
+
+public static class HybridCacheExtensions
+{
+   public static async ValueTask<TValue> GetOrDefaultAsync<TValue>(this HybridCache cache,
+      string key,
+      TValue defaultValue,
+      CancellationToken ct = default)
+   {
+      return await cache.GetOrCreateAsync<TValue>(
+         key,
+         _ => new ValueTask<TValue>(defaultValue),
+         new HybridCacheEntryOptions
+         {
+            Flags = HybridCacheEntryFlags.DisableLocalCacheWrite | HybridCacheEntryFlags.DisableDistributedCacheWrite
+         },
+         cancellationToken: ct
+      );
+   }
+
+   public static async ValueTask<(bool Exists, TValue? Value)> TryGetAsync<TValue>(this HybridCache cache,
+      string key,
+      CancellationToken ct = default)
+   {
+      var exists = true;
+      var value = await cache.GetOrCreateAsync<TValue>(
+         key,
+         _ =>
+         {
+            exists = false;
+            return new ValueTask<TValue>(default(TValue)!);
+         },
+         new HybridCacheEntryOptions
+         {
+            Flags = HybridCacheEntryFlags.DisableLocalCacheWrite | HybridCacheEntryFlags.DisableDistributedCacheWrite
+         },
+         cancellationToken: ct
+      );
+      return (exists, value);
+   }
+
+   public static async ValueTask<bool> ExistsAsync<TValue>(this HybridCache cache,
+      string key,
+      CancellationToken ct = default)
+   {
+      var (exists, _) = await cache.TryGetAsync<TValue>(key, ct);
+      return exists;
+   }
+}

src/DistributedCache/Extensions/HybridCacheExtensions.cs

@@ -0,0 +1,16 @@
+using System.Reflection;
+
+namespace DistributedCache.Extensions;
+
+public static class StringExtensions
+{
+   public static string PrefixWith(this string value, string prefix)
+   {
+      return $"{prefix}{value}";
+   }
+
+   public static string PrefixWith(this string value, Assembly assembly)
+   {
+      return $"{assembly.GetName().Name}:{value}";
+   }
+}

src/DistributedCache/Extensions/StringExtensions.cs

@@ -3,6 +3,7 @@
 using DistributedCache.Services.Implementations;
 using DistributedCache.Services.Interfaces;
 using Microsoft.AspNetCore.Builder;
+using Microsoft.Extensions.Caching.Hybrid;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
 using StackExchange.Redis;
@@ -34,9 +35,9 @@ public static WebApplicationBuilder AddDistributedCache(this WebApplicationBuild
 
       builder.Services.AddSingleton<IConnectionMultiplexer>(ConnectionMultiplexer.Connect(redisOptions));
 
-      builder.Services.AddSingleton(typeof(ICacheService<>), typeof(RedisCacheService<>));
-      builder.Services.AddSingleton(typeof(IRateLimitService<>), typeof(RedisRateLimitService<>));
-      builder.Services.AddSingleton<RedisLockService>();
+      builder.Services.AddSingleton<IRateLimitService, RedisRateLimitService>();
+      builder.Services.AddSingleton<IDistributedLockService, RedisLockService>();
+      builder.Services.AddSingleton<HybridCache, RedisDistributedCache>();
 
       var redisConfiguration = new RedisConfiguration
       {
@@ -75,7 +76,7 @@ private static void ValidateOptions(WebApplicationBuilder builder)
             throw new ArgumentException("AddCacheService options: SyncTimeout must be greater than 0.");
          }
 
-         if (options.DistributedLockDuration <= TimeSpan.FromSeconds(1))
+         if (options.DistributedLockMaxDuration <= TimeSpan.FromSeconds(1))
          {
             throw new ArgumentException(
                "AddCacheService options: DistributedLockDuration must be greater or equal 1.");

src/DistributedCache/Extensions/WebApplicationBuilderExtension.cs

@@ -0,0 +1,35 @@
+using DistributedCache.Options;
+
+namespace DistributedCache.Helpers;
+
+internal static class CacheKeyFormatter
+{
+   private const string DefaultCachePrefix = "DistributedCache";
+
+   internal static string BuildPrefixedKey(string key,
+      CacheConfigurationOptions options)
+   {
+      return options.ChannelPrefix is not null
+         ? $"{DefaultCachePrefix}:{options.ChannelPrefix}:{key}"
+         : $"{DefaultCachePrefix}:{key}";
+   }
+
+   internal static IEnumerable<string> BuildPrefixedKeys(IEnumerable<string> keys,
+      CacheConfigurationOptions options)
+   {
+      return keys.Select(k => BuildPrefixedKey(k, options));
+   }
+
+   internal static string BuildTagKey(string tagName,
+      CacheConfigurationOptions options)
+   {
+      return options.ChannelPrefix is not null
+         ? $"{DefaultCachePrefix}:{options.ChannelPrefix}:tag:{tagName}"
+         : $"{DefaultCachePrefix}:tag:{tagName}";
+   }
+
+   internal static string BuildLockKey(string baseKey)
+   {
+      return $"{baseKey}:lock";
+   }
+}

src/DistributedCache/Helpers/CacheKeyFormatter.cs

@@ -0,0 +1,17 @@
+using DistributedCache.Services.Interfaces;
+using MessagePack;
+
+namespace DistributedCache.Models;
+
+[MessagePackObject]
+public class CacheStore<T> : ICacheEntity
+{
+   [Key(0)]
+   public required T Data { get; set; }
+
+   [Key(1)]
+   public DateTime CreatedAt { get; set; } = DateTime.UtcNow;
+
+   [Key(2)]
+   public required List<string> Tags { get; set; }
+}