RateLimit interface change

Author: HaikAsatryan

Readme.md

@@ -54,6 +54,11 @@ cross ClassLibrary cache access.
 options.KeyPrefixForIsolation = KeyPrefix.AssemblyNamePrefix;
 ```
 
+**Note:** Even if you don't use key prefixing, you still need to provide the class as a generic type (`T`) when using
+`IRateLimitService<T>`. The generic type `T` is used to retrieve the assembly name, which is important for key isolation. If
+you choose not to prefix keys by assembly name, this type is still required but will be ignored in the actual
+implementation.
+
 ### 2. Cached Entity Preparation
 
 Create your cache entity/model in order to inject it in the actual service:
@@ -226,7 +231,7 @@ public static class RateLimitingConfigurations //your shared rate limiting confi
 using DistributedCache.Dtos;
 using DistributedCache.Services.Interfaces;
 
-public class SendSmsService(IRateLimitService rateLimitService)
+public class SendSmsService(IRateLimitService<SendSmsService> rateLimitService)
 {
     public async Task<RateLimitState> SendSms(CancellationToken cancellationToken = default)
     {

src/DistributedCache/DistributedCache.csproj

@@ -8,13 +8,13 @@
         <PackageReadmeFile>Readme.md</PackageReadmeFile>
         <Authors>Pandatech</Authors>
         <Copyright>MIT</Copyright>
-        <Version>1.2.3</Version>
+        <Version>2.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>
         <RepositoryUrl>https://github.com/PandaTechAM/be-lib-distributed-cache</RepositoryUrl>
-        <PackageReleaseNotes>Assembly name fix in rate limit</PackageReleaseNotes>
+        <PackageReleaseNotes>RateLimit interface change</PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>
@@ -23,8 +23,8 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="MessagePack" Version="2.5.140"/>
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.6"/>
+        <PackageReference Include="MessagePack" Version="2.5.172" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.8" />
         <PackageReference Include="StackExchange.Redis.Extensions.AspNetCore" Version="10.2.0"/>
         <PackageReference Include="StackExchange.Redis.Extensions.MsgPack" Version="10.2.0"/>
     </ItemGroup>

src/DistributedCache/Extensions/WebApplicationBuilderExtension.cs

@@ -33,8 +33,8 @@ 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.AddScoped<IRateLimitService, RedisRateLimitService>();
 
         var redisConfiguration = new RedisConfiguration
         {

src/DistributedCache/Services/Implementations/RedisRateLimitService.cs

@@ -10,17 +10,16 @@
 
 namespace DistributedCache.Services.Implementations;
 
-public class RedisRateLimitService(
+public class RedisRateLimitService<T>(
    IRedisClient redisClient,
    IOptions<CacheConfigurationOptions> options,
-   RedisLockService lockService) : IRateLimitService
+   RedisLockService lockService) : IRateLimitService<T>
+   where T : class
 {
    private readonly IRedisDatabase _redisDatabase = redisClient.GetDefaultDatabase();
    private readonly CacheConfigurationOptions _config = options.Value;
-
-   private readonly string _moduleName = Assembly.GetCallingAssembly()
-                                                 .GetName()
-                                                 .Name!;
+   
+   private readonly string _moduleName = typeof(T).Assembly.GetName().Name!;
 
    public async ValueTask<RateLimitState> RateLimitAsync(RateLimitConfiguration rateLimitConfiguration,
       CancellationToken cancellationToken = default)

src/DistributedCache/Services/Interfaces/IRateLimitService.cs

@@ -2,8 +2,26 @@
 
 namespace DistributedCache.Services.Interfaces;
 
-public interface IRateLimitService
+/// <summary>
+/// Defines a service for applying rate limiting to specific operations.
+/// </summary>
+/// <typeparam name="T">
+/// The type of the class that is used to infer the assembly name for key isolation.
+/// Even if the assembly name is not used in key prefixing, this type must still be provided
+/// to comply with the service's requirements.
+/// </typeparam>
+public interface IRateLimitService<T>
+    where T : class
 {
+   /// <summary>
+   /// Applies rate limiting based on the provided configuration.
+   /// </summary>
+   /// <param name="rateLimitConfiguration">The configuration defining rate limit rules, such as maximum attempts and expiration.</param>
+   /// <param name="cancellationToken">A token that can be used to propagate notification that the operation should be canceled.</param>
+   /// <returns>
+   /// A task representing the asynchronous operation, containing the result of the rate limiting operation,
+   /// which indicates whether the rate limit has been exceeded or not.
+   /// </returns>
     ValueTask<RateLimitState> RateLimitAsync(RateLimitConfiguration rateLimitConfiguration,
         CancellationToken cancellationToken = default);
 }

test/DistributedCache.Demo/DistributedCache.Demo.csproj

@@ -9,8 +9,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.6" />
-        <PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.2" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.8" />
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="6.7.3" />
     </ItemGroup>
 
     <ItemGroup>

test/DistributedCache.Demo/TestRateLimiting/SendSmsService.cs

@@ -3,7 +3,7 @@
 
 namespace CacheService.Demo.TestRateLimiting;
 
-public class SendSmsService(IRateLimitService rateLimitService)
+public class SendSmsService(IRateLimitService<SendSmsService> rateLimitService)
 {
     public async Task<RateLimitState> SendSms(CancellationToken cancellationToken = default)
     {

test/DistributedCache.Tests/DistributedCache.Tests.csproj

@@ -10,9 +10,9 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
-        <PackageReference Include="xunit" Version="2.8.1" />
-        <PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+        <PackageReference Include="xunit" Version="2.9.0" />
+        <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>