fix(middleware): set rate limit headers on memory store#2985
Open
leno23 wants to merge 1 commit into
Open
Conversation
Add optional rateLimiterStoreContext interface so stores can set X-RateLimit-Limit, X-RateLimit-Remaining, and Retry-After headers. RateLimiterMemoryStore implements it using golang.org/x/time/rate. Fixes labstack#2961 Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #2961
Rate limit middleware now sets standard rate limit response headers when using the built-in
RateLimiterMemoryStore:X-RateLimit-Limit— configured burstX-RateLimit-Remaining— tokens remaining after the requestRetry-After— seconds until the next token is available (on 429 only)Implementation follows the maintainer suggestion from the issue: an optional unexported
rateLimiterStoreContextinterface withAllowContext(c echo.Context, identifier string) (bool, error). When the configured store implements it, the middleware calls it instead ofAllow. Custom stores can opt in without breaking the existingRateLimiterStoreAPI.Retry-Afteris computed viarate.Limiter.ReserveN(...).Delay()as suggested in the issue discussion.Test plan
go test ./middleware -run TestRateLimitergo test -race ./middleware -run TestRateLimiterMemoryStoreTestRateLimiterMemoryStore_AllowContext_SetsHeadersverifies headers on allowed and denied requests