Skip to content

Commit 902e029

Browse files
fabpotfabpot
committed
feature #38426 [HttpClient] Parameterize list of retryable methods (jderusse)
This PR was merged into the 5.x branch. Discussion ---------- [HttpClient] Parameterize list of retryable methods | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | / | License | MIT | Doc PR | TODO Retrying non-idempotent methods is not always acceptable for user. This PR adds an easy way to configure this behavior. The `RetryDeciderInterface::shouldRetry()` now take the exception in parameter, in order to let decider not retrying the request when the methods should never by retried. With #38420, this code would belongs to the RetryStrategy implementation, and would return an `NeverRetryDecider` when method is not allowed. Commits ------- 56809d1b91 Parameterize list of retryed Http methods
2 parents 66583f3 + 6ec8e19 commit 902e029

File tree

7 files changed

+63
-11
lines changed

7 files changed

+63
-11
lines changed

‎DependencyInjection/Configuration.php

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1653,13 +1653,43 @@ private function addHttpClientRetrySection()
16531653
->performNoDeepMerging()
16541654
->beforeNormalization()
16551655
->ifArray()
1656-
->then(function ($v) {
1657-
return array_filter(array_values($v));
1656+
->then(static function ($v) {
1657+
$list = [];
1658+
foreach ($v as $key => $val) {
1659+
if (is_numeric($val)) {
1660+
$list[] = ['code' => $val];
1661+
} elseif (\is_array($val)) {
1662+
if (isset($val['code']) || isset($val['methods'])) {
1663+
$list[] = $val;
1664+
} else {
1665+
$list[] = ['code' => $key, 'methods' => $val];
1666+
}
1667+
} elseif (true === $val || null === $val) {
1668+
$list[] = ['code' => $key];
1669+
}
1670+
}
1671+
1672+
return $list;
16581673
})
16591674
->end()
1660-
->prototype('integer')->end()
1675+
->useAttributeAsKey('code')
1676+
->arrayPrototype()
1677+
->fixXmlConfig('method')
1678+
->children()
1679+
->integerNode('code')->end()
1680+
->arrayNode('methods')
1681+
->beforeNormalization()
1682+
->ifArray()
1683+
->then(function ($v) {
1684+
return array_map('strtoupper', $v);
1685+
})
1686+
->end()
1687+
->prototype('scalar')->end()
1688+
->info('A list of HTTP methods that triggers a retry for this status code. When empty, all methods are retried')
1689+
->end()
1690+
->end()
1691+
->end()
16611692
->info('A list of HTTP status code that triggers a retry')
1662-
->defaultValue([423, 425, 429, 500, 502, 503, 504, 507, 510])
16631693
->end()
16641694
->integerNode('max_retries')->defaultValue(3)->min(0)->end()
16651695
->integerNode('delay')->defaultValue(1000)->min(0)->info('Time in ms to delay (or the initial value when multiplier is used)')->end()

‎DependencyInjection/FrameworkExtension.php

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@
6464
use Symfony\Component\Form\FormTypeGuesserInterface;
6565
use Symfony\Component\Form\FormTypeInterface;
6666
use Symfony\Component\HttpClient\MockHttpClient;
67+
use Symfony\Component\HttpClient\Retry\GenericRetryStrategy;
6768
use Symfony\Component\HttpClient\RetryableHttpClient;
6869
use Symfony\Component\HttpClient\ScopingHttpClient;
6970
use Symfony\Component\HttpFoundation\Request;
@@ -2074,8 +2075,17 @@ private function registerRetryableHttpClient(array $options, string $name, Conta
20742075
$retryStrategy = new Reference($options['retry_strategy']);
20752076
} else {
20762077
$retryStrategy = new ChildDefinition('http_client.abstract_retry_strategy');
2078+
$codes = [];
2079+
foreach ($options['http_codes'] as $code => $codeOptions) {
2080+
if ($codeOptions['methods']) {
2081+
$codes[$code] = $codeOptions['methods'];
2082+
} else {
2083+
$codes[] = $code;
2084+
}
2085+
}
2086+
20772087
$retryStrategy
2078-
->replaceArgument(0, $options['http_codes'])
2088+
->replaceArgument(0, $codes ?: GenericRetryStrategy::DEFAULT_RETRY_STATUS_CODES)
20792089
->replaceArgument(1, $options['delay'])
20802090
->replaceArgument(2, $options['multiplier'])
20812091
->replaceArgument(3, $options['max_delay'])

‎Resources/config/schema/symfony-1.0.xsd

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -578,7 +578,7 @@
578578

579579
<xsd:complexType name="http_client_retry_failed">
580580
<xsd:sequence>
581-
<xsd:element name="http-code" type="xsd:integer" minOccurs="0" maxOccurs="unbounded" />
581+
<xsd:element name="http-code" type="http_client_retry_code" minOccurs="0" maxOccurs="unbounded" />
582582
</xsd:sequence>
583583
<xsd:attribute name="enabled" type="xsd:boolean" />
584584
<xsd:attribute name="retry-strategy" type="xsd:string" />
@@ -590,6 +590,13 @@
590590
<xsd:attribute name="response_header" type="xsd:boolean" />
591591
</xsd:complexType>
592592

593+
<xsd:complexType name="http_client_retry_code">
594+
<xsd:sequence>
595+
<xsd:element name="method" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
596+
</xsd:sequence>
597+
<xsd:attribute name="code" type="xsd:integer" />
598+
</xsd:complexType>
599+
593600
<xsd:complexType name="http_query" mixed="true">
594601
<xsd:attribute name="key" type="xsd:string" />
595602
</xsd:complexType>

‎Tests/DependencyInjection/Fixtures/php/http_client_retry.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
'default_options' => [
66
'retry_failed' => [
77
'retry_strategy' => null,
8-
'http_codes' => [429, 500],
8+
'http_codes' => [429, 500 => ['GET', 'HEAD']],
99
'max_retries' => 2,
1010
'delay' => 100,
1111
'multiplier' => 2,

‎Tests/DependencyInjection/Fixtures/xml/http_client_retry.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,11 @@
1414
max-retries="2"
1515
multiplier="2"
1616
jitter="0.3">
17-
<framework:http-code>429</framework:http-code>
18-
<framework:http-code>500</framework:http-code>
17+
<framework:http-code code="429"/>
18+
<framework:http-code code="500">
19+
<framework:method>GET</framework:method>
20+
<framework:method>HEAD</framework:method>
21+
</framework:http-code>
1922
</framework:retry-failed>
2023
</framework:default-options>
2124
<framework:scoped-client name="foo" base-uri="http://example.com">

‎Tests/DependencyInjection/Fixtures/yml/http_client_retry.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ framework:
33
default_options:
44
retry_failed:
55
retry_strategy: null
6-
http_codes: [429, 500]
6+
http_codes:
7+
429: true
8+
500: ['GET', 'HEAD']
79
max_retries: 2
810
delay: 100
911
multiplier: 2

‎Tests/DependencyInjection/FrameworkExtensionTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1500,7 +1500,7 @@ public function testHttpClientRetry()
15001500
}
15011501
$container = $this->createContainerFromFile('http_client_retry');
15021502

1503-
$this->assertSame([429, 500], $container->getDefinition('http_client.retry_strategy')->getArgument(0));
1503+
$this->assertSame([429, 500 => ['GET', 'HEAD']], $container->getDefinition('http_client.retry_strategy')->getArgument(0));
15041504
$this->assertSame(100, $container->getDefinition('http_client.retry_strategy')->getArgument(1));
15051505
$this->assertSame(2, $container->getDefinition('http_client.retry_strategy')->getArgument(2));
15061506
$this->assertSame(0, $container->getDefinition('http_client.retry_strategy')->getArgument(3));

0 commit comments

Comments
 (0)