spring-cloud/spring-cloud-gateway

Make RedisRateLimiter extensible?

Open

#393 opened on Jun 26, 2018

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Java (3,204 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (4,284 stars)
PR merge metrics
 (Avg merge 1d 21h) (18 merged PRs in 30d)

Description

Hey guys!

In order to be able to rate limit per user API key (versus basing the limit on the route) I had to extend RedisRateLimiter to make isAllowed(String routeId, String apiKey) calculate the limits based up on the route and the apiKey. Please see the full thing here: https://stackoverflow.com/questions/50988095/rate-limiting-based-on-user-plan-in-spring-cloud-gateway

As you see it is somewhat hackish there because there's no good way to extend RedisRateLimiter - see I had to decorate it, copy some private/default scoped methods over as well as hack the @Primary annotation so it gets into the bean factory well.

Do you think RedisRateLimiter would be re-architected to be easier to extend? Thanks!

Contributor guide

Research direction
Study the current RedisRateLimiter class structure, understand its private methods and default scoped methods, and identify which parts need to be made protected or public to allow extension. Also review the Spring Cloud Gateway rate limiting configuration to see how the bean is created and how a custom implementation can replace it.
Tech stack
java
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaSpringRedisGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50