[RateLimiter] Document the RateLimit object#14461

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Merged

javiereguiluz merged 1 commit intosymfony:5.xfromjaviereguiluz:fix_14447

Oct 22, 2020

Merged

[RateLimiter] Document the RateLimit object#14461

javiereguiluz merged 1 commit intosymfony:5.xfromjaviereguiluz:fix_14447

Oct 22, 2020

Conversation

Copy link

Member

javiereguiluz commentedOct 22, 2020

Fixes#14447.

javiereguiluz added the RateLimiter label

Oct 22, 2020

javiereguiluz added this to the5.2 milestone

Oct 22, 2020

carsonbot added the Status: Needs Review label

Oct 22, 2020

wouterj reviewed

Oct 22, 2020

View reviewed changes

rate_limiter.rst Outdated

		headers in the response to expose the limit status (e.g. remaining tokens, when
		new tokens will be available, etc.)

		That's why the ``consume()`` object returns a:class:`Symfony\\Component\\RateLimiter\\RateLimit`

Copy link

Member

wouterjOct 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thereserve() method returns aReservation object that also has agetRateLimit() method.

rate_limiter.rst Outdated

Comment on lines 246 to 250

		$response->headers->add([
		'X-RateLimit-Remaining' => $limit->getRemainingTokens(),
		'X-RateLimit-Reset' => $limit->getRetryAfter()->getTimestamp(),
		'X-RateLimit-Limit' => $limit->getLimit(),
		]);

Copy link

Member

wouterjOct 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

These headers should be present in all responses, also the rejected ones. So what about changing this controller to:

$limiter =$anonymousApiLimiter->create($request->getClientIp());$rateLimit =$limiter->consume();$headers = ['X-RateLimit-Remaining' =>$limit->getRemainingTokens(),'X-RateLimit-Retry-After' =>$limit->getRetryAfter()->getTimestamp(),'X-RateLimit-Limit' =>$limit->getLimit(),];if (false ===$limit->isAccepted()) {returnnewResponse(null, Response::HTTP_TOO_MANY_REQUESTS,$headers);}// ...$response =newResponse(...);$response->headers->add($headers);return$response;