Skip to content

[HttpClient] fix RetryableHttpClient when a response is canceled #43537

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 16, 2021
Merged

[HttpClient] fix RetryableHttpClient when a response is canceled #43537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Symfony/Component/HttpClient/EventSourceHttpClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public function request(string $method, string $url, array $options = []): Respo
try {
$isTimeout = $chunk->isTimeout();

if (null !== $chunk->getInformationalStatus()) {
if (null !== $chunk->getInformationalStatus() || $context->getInfo('canceled')) {
yield $chunk;

return;
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/HttpClient/Response/AsyncResponse.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ public static function stream(iterable $responses, float $timeout = null, string
}
}

if (!$client) {
if (!$client || !$wrappedResponses) {
return;
}

Expand Down
6 changes: 5 additions & 1 deletion src/Symfony/Component/HttpClient/Response/MockResponse.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,11 @@ public function cancel(): void
{
$this->info['canceled'] = true;
$this->info['error'] = 'Response has been canceled.';
$this->body = null;
try {
$this->body = null;
} catch (TransportException $e) {
// ignore errors when canceling
}
}

/**
Expand Down
42 changes: 24 additions & 18 deletions src/Symfony/Component/HttpClient/RetryableHttpClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public function request(string $method, string $url, array $options = []): Respo
return new AsyncResponse($this->client, $method, $url, $options, function (ChunkInterface $chunk, AsyncContext $context) use ($method, $url, $options, &$retryCount, &$content, &$firstChunk) {
$exception = null;
try {
if ($chunk->isTimeout() || null !== $chunk->getInformationalStatus()) {
if ($chunk->isTimeout() || null !== $chunk->getInformationalStatus() || $context->getInfo('canceled')) {
yield $chunk;

return;
Expand All @@ -76,23 +76,14 @@ public function request(string $method, string $url, array $options = []): Respo
}

if (false === $shouldRetry) {
$context->passthru();
if (null !== $firstChunk) {
yield $firstChunk;
yield $context->createChunk($content);
yield $chunk;
} else {
yield $chunk;
}
$content = '';
yield from $this->passthru($context, $firstChunk, $content, $chunk);

return;
}
}
} elseif ($chunk->isFirst()) {
if (false === $shouldRetry = $this->strategy->shouldRetry($context, null, null)) {
$context->passthru();
yield $chunk;
yield from $this->passthru($context, $firstChunk, $content, $chunk);

return;
}
Expand All @@ -105,9 +96,9 @@ public function request(string $method, string $url, array $options = []): Respo
return;
}
} else {
$content .= $chunk->getContent();

if (!$chunk->isLast()) {
$content .= $chunk->getContent();

return;
}

Expand All @@ -116,10 +107,7 @@ public function request(string $method, string $url, array $options = []): Respo
}

if (false === $shouldRetry) {
$context->passthru();
yield $firstChunk;
yield $context->createChunk($content);
$content = '';
yield from $this->passthru($context, $firstChunk, $content, $chunk);

return;
}
Expand Down Expand Up @@ -159,4 +147,22 @@ private function getDelayFromHeader(array $headers): ?int

return null;
}

private function passthru(AsyncContext $context, ?ChunkInterface $firstChunk, string &$content, ChunkInterface $lastChunk): \Generator
{
$context->passthru();

if (null !== $firstChunk) {
yield $firstChunk;
}

if ('' !== $content) {
$chunk = $context->createChunk($content);
$content = '';

yield $chunk;
}

yield $lastChunk;
}
}
19 changes: 19 additions & 0 deletions src/Symfony/Component/HttpClient/Tests/RetryableHttpClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpClient\Exception\ServerException;
use Symfony\Component\HttpClient\HttpClient;
use Symfony\Component\HttpClient\MockHttpClient;
use Symfony\Component\HttpClient\NativeHttpClient;
use Symfony\Component\HttpClient\Response\AsyncContext;
Expand Down Expand Up @@ -159,4 +160,22 @@ public function shouldRetry(AsyncContext $context, ?string $responseContent, ?Tr
$this->assertCount(2, $logger->logs);
$this->assertSame('Try #{count} after {delay}ms: Could not resolve host "does.not.exists".', $logger->logs[0]);
}

public function testCancelOnTimeout()
{
$client = HttpClient::create();

if ($client instanceof NativeHttpClient) {
$this->markTestSkipped('NativeHttpClient cannot timeout before receiving headers');
}

$client = new RetryableHttpClient($client);

$response = $client->request('GET', 'https://example.com/');

foreach ($client->stream($response, 0) as $chunk) {
$this->assertTrue($chunk->isTimeout());
$response->cancel();
}
}
}