-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature #38532 [HttpClient] simplify retry mechanism around RetryStra…
…tegyInterface (nicolas-grekas) This PR was merged into the 5.x branch. Discussion ---------- [HttpClient] simplify retry mechanism around RetryStrategyInterface | Q | A | ------------- | --- | Branch? | 5.2 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Replaces #38466 I feel like the mechanism behind RetryableHttpClient is too bloated for no pragmatic reasons. I propose to merge RetryDeciderInterface and RetryBackoffInterface into one single RetryStrategyInterface. Having two separate interfaces supports no real-world use case. The only implementations we provide are trivial, and they can be reused by extending the provided GenericRetryStrategy implementation if one really doesn't want to duplicate that. The methods are also simplified by accepting an AsyncContext as argument. This makes the signatures shorter and allows accessing the "info" of the request (allowing to decide based on the IP of the host, etc). /cc @jderusse Commits ------- 544c3e8 [HttpClient] simplify retry mechanism around RetryStrategyInterface
- Loading branch information
Showing
17 changed files
with
198 additions
and
281 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
81 changes: 0 additions & 81 deletions
81
src/Symfony/Component/HttpClient/Retry/ExponentialBackOff.php
This file was deleted.
Oops, something went wrong.
84 changes: 84 additions & 0 deletions
84
src/Symfony/Component/HttpClient/Retry/GenericRetryStrategy.php
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\HttpClient\Retry; | ||
|
|
||
| use Symfony\Component\HttpClient\Response\AsyncContext; | ||
| use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface; | ||
|
|
||
| /** | ||
| * Decides to retry the request when HTTP status codes belong to the given list of codes. | ||
| * | ||
| * @author Jérémy Derussé <jeremy@derusse.com> | ||
| */ | ||
| class GenericRetryStrategy implements RetryStrategyInterface | ||
| { | ||
| public const DEFAULT_RETRY_STATUS_CODES = [423, 425, 429, 500, 502, 503, 504, 507, 510]; | ||
|
|
||
| private $statusCodes; | ||
| private $delayMs; | ||
| private $multiplier; | ||
| private $maxDelayMs; | ||
| private $jitter; | ||
|
|
||
| /** | ||
| * @param array $statusCodes List of HTTP status codes that trigger a retry | ||
| * @param int $delayMs Amount of time to delay (or the initial value when multiplier is used) | ||
| * @param float $multiplier Multiplier to apply to the delay each time a retry occurs | ||
| * @param int $maxDelayMs Maximum delay to allow (0 means no maximum) | ||
| * @param float $jitter Probability of randomness int delay (0 = none, 1 = 100% random) | ||
| */ | ||
| public function __construct(array $statusCodes = self::DEFAULT_RETRY_STATUS_CODES, int $delayMs = 1000, float $multiplier = 2.0, int $maxDelayMs = 0, float $jitter = 0.1) | ||
| { | ||
| $this->statusCodes = $statusCodes; | ||
|
|
||
| if ($delayMs < 0) { | ||
| throw new InvalidArgumentException(sprintf('Delay must be greater than or equal to zero: "%s" given.', $delayMs)); | ||
| } | ||
| $this->delayMs = $delayMs; | ||
|
|
||
| if ($multiplier < 1) { | ||
| throw new InvalidArgumentException(sprintf('Multiplier must be greater than or equal to one: "%s" given.', $multiplier)); | ||
| } | ||
| $this->multiplier = $multiplier; | ||
|
|
||
| if ($maxDelayMs < 0) { | ||
| throw new InvalidArgumentException(sprintf('Max delay must be greater than or equal to zero: "%s" given.', $maxDelayMs)); | ||
| } | ||
| $this->maxDelayMs = $maxDelayMs; | ||
|
|
||
| if ($jitter < 0 || $jitter > 1) { | ||
| throw new InvalidArgumentException(sprintf('Jitter must be between 0 and 1: "%s" given.', $jitter)); | ||
| } | ||
| $this->jitter = $jitter; | ||
| } | ||
|
|
||
| public function shouldRetry(AsyncContext $context, ?string $responseContent, ?TransportExceptionInterface $exception): ?bool | ||
| { | ||
| return \in_array($context->getStatusCode(), $this->statusCodes, true); | ||
| } | ||
|
|
||
| public function getDelay(AsyncContext $context, ?string $responseContent, ?TransportExceptionInterface $exception): int | ||
| { | ||
| $delay = $this->delayMs * $this->multiplier ** $context->getInfo('retry_count'); | ||
|
|
||
| if ($this->jitter > 0) { | ||
| $randomness = $delay * $this->jitter; | ||
| $delay = $delay + random_int(-$randomness, +$randomness); | ||
| } | ||
|
|
||
| if ($delay > $this->maxDelayMs && 0 !== $this->maxDelayMs) { | ||
| return $this->maxDelayMs; | ||
| } | ||
|
|
||
| return (int) $delay; | ||
| } | ||
| } |
Oops, something went wrong.