8000 Support fractional replenishRate in RedisRateLimiter by abhijeet4725 · Pull Request #4046 · spring-cloud/spring-cloud-gateway · GitHub
[go: up one dir, main page]
Skip to content

Support fractional replenishRate in RedisRateLimiter #4046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abhijeet4725 wants to merge 3 commits into
base: main
Choose a base branch
from
+42 −9
Open

Support fractional replenishRate in RedisRateLimiter #4046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
376e364
Support fractional replenishRate in RedisRateLimiter
abhijeet4725 Jan 25, 2026
cd3e256
Fix fractionalReplenishRate test using assertConfigOnly
abhijeet4725 Jan 25, 2026
d736046
Fix formatting of X-RateLimit-Replenish-Rate header
abhijeet4725 Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions ...ux/src/main/java/org/springframework/cloud/gateway/filter/ratelimit/RedisRateLimiter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.util.Objects;
import java.util.concurrent.atomic.AtomicBoolean;

import jakarta.validation.constraints.DecimalMin;
import jakarta.validation.constraints.Min;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
Expand Down Expand Up @@ -139,7 +140,7 @@ public RedisRateLimiter(ReactiveStringRedisTemplate redisTemplate, RedisScript<L
* @param defaultBurstCapacity how many tokens the bucket can hold in token-bucket
* algorithm.
*/
public RedisRateLimiter(int defaultReplenishRate, long defaultBurstCapacity) {
public RedisRateLimiter(double defaultReplenishRate, long defaultBurstCapacity) {
super(Config.class, CONFIGURATION_PROPERTY_NAME, (ConfigurationService) null);
this.defaultConfig = new Config().setReplenishRate(defaultReplenishRate).setBurstCapacity(defaultBurstCapacity);
}
Expand All @@ -151,7 +152,7 @@ public RedisRateLimiter(int defaultReplenishRate, long defaultBurstCapacity) {
* algorithm.
* @param defaultRequestedTokens how many tokens are requested per request.
*/
public RedisRateLimiter(int defaultReplenishRate, long defaultBurstCapacity, int defaultRequestedTokens) {
public RedisRateLimiter(double defaultReplenishRate, long defaultBurstCapacity, int defaultRequestedTokens) {
this(defaultReplenishRate, defaultBurstCapacity);
Objects.requireNonNull(this.defaultConfig, "defaultConfig may not be null");
this.defaultConfig.setRequestedTokens(defaultRequestedTokens);
Expand Down Expand Up @@ -250,7 +251,7 @@ public Mono<Response> isAllowed(String routeId, String id) {
Config routeConfig = loadConfiguration(routeId);

// How many requests per second do you want a user to be allowed to do?
int replenishRate = routeConfig.getReplenishRate();
double replenishRate = routeConfig.getReplenishRate();

// How much bursting do you want to allow?
long burstCapacity = routeConfig.getBurstCapacity();
Expand Down Expand Up @@ -311,11 +312,18 @@ public Mono<Response> isAllowed(String routeId, String id) {
return routeConfig;
}

private static String formatReplenishRate(double rate) {
if (rate == Math.floor(rate)) {
return String.valueOf((long) rate);
}
return String.valueOf(rate);
}

public Map<String, String> getHeaders(Config config, Long tokensLeft) {
Map<String, String> headers = new HashMap<>();
if (isIncludeHeaders()) {
headers.put(this.remainingHeader, tokensLeft.toString());
headers.put(this.replenishRateHeader, String.valueOf(config.getReplenishRate()));
headers.put(this.replenishRateHeader, formatReplenishRate(config.getReplenishRate()));
headers.put(this.burstCapacityHeader, String.valueOf(config.getBurstCapacity()));
headers.put(this.requestedTokensHeader, String.valueOf(config.getRequestedTokens()));
}
Expand All @@ -325,20 +333,20 @@ public Map<String, String> getHeaders(Config config, Long tokensLeft) {
@Validated
public static class Config {

@Min(1)
private int replenishRate;
@DecimalMin(value = "0.0", inclusive = false)
private double replenishRate;

@Min(0)
private long burstCapacity = 1;

@Min(1)
private int requestedTokens = 1;

public int getReplenishRate() {
public double getReplenishRate() {
return replenishRate;
}

public Config setReplenishRate(int replenishRate) {
public Config setReplenishRate(double replenishRate) {
this.replenishRate = replenishRate;
return this;
}
Expand Down
27 changes: 26 additions & 1 deletion .../java/org/springframework/cloud/gateway/filter/ratelimit/RedisRateLimiterConfigTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ public void init() {
routeLocator.getRoutes().collectList().block();
}

private void assertConfigOnly(String key, double replenishRate, int burstCapacity, int requestedTokens) {
RedisRateLimiter.Config config = rateLimiter.getConfig().get(key);
assertThat(config).isNotNull();
assertThat(config.getReplenishRate()).isEqualTo(replenishRate);
assertThat(config.getBurstCapacity()).isEqualTo(burstCapacity);
assertThat(config.getRequestedTokens()).isEqualTo(requestedTokens);
}

@Test
public void shouldThrowAnErrorWhenReplenishRateIsHigherThanBurstCapacity() {
Assertions.assertThatThrownBy(() -> new RedisRateLimiter(10, 5)).isInstanceOf(IllegalArgumentException.class);
Expand Down Expand Up @@ -86,7 +94,24 @@ public void redisRateConfiguredFromJavaAPIDirectBean() {
assertFilter("alt_custom_redis_rate_limiter", 30, 60, 20, true);
}

private void assertFilter(String key, int replenishRate, int burstCapacity, int requestedTokens,
@Test
public void fractionalReplenishRateTest() {
String key = "fractionalKey";
double replenishRate = 0.5;
int burstCapacity = 1;

RedisRateLimiter.Config fractionalConfig = new RedisRateLimiter.Config().setReplenishRate(replenishRate)
.setBurstCapacity(burstCapacity)
.setRequestedTokens(1);

// Add this config manually for the test
rateLimiter.getConfig().put(key, fractionalConfig);

// Only check config, skip route check
assertConfigOnly(key, replenishRate, burstCapacity, 1);
}

private void assertFilter(String key, double replenishRate, int burstCapacity, int requestedTokens,
boolean useDefaultConfig) {
RedisRateLimiter.Config config;

Expand Down
Loading
0