Skip to content
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

[9.x] Fix Http Client throw boolean parameter of retry method #41762

Merged
merged 3 commits into from
Mar 31, 2022
Merged

[9.x] Fix Http Client throw boolean parameter of retry method #41762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53f17bb
Add failing test
gdebrauwer Mar 31, 2022
406a51f
Fix retryThrow behavior
gdebrauwer Mar 31, 2022
228e5bc
Fix code when no retry is necessary
gdebrauwer Mar 31, 2022
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
22 changes: 17 additions & 5 deletions src/Illuminate/Http/Client/PendingRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -707,13 +707,23 @@ public function send(string $method, string $url, array $options = [])
return $this->makePromise($method, $url, $options);
}

return retry($this->tries ?? 1, function () use ($method, $url, $options) {
$shouldRetry = true;

return retry($this->tries ?? 1, function ($attempt) use ($method, $url, $options, &$shouldRetry) {
try {
return tap(new Response($this->sendRequest($method, $url, $options)), function ($response) {
return tap(new Response($this->sendRequest($method, $url, $options)), function ($response) use ($attempt, &$shouldRetry) {
$this->populateResponse($response);

if ($this->tries > 1 && $this->retryThrow && ! $response->successful()) {
$response->throw();
if (! $response->successful()) {
$shouldRetry = $this->retryWhenCallback ? call_user_func($this->retryWhenCallback, $response->toException()) : true;

if ($attempt < $this->tries && $shouldRetry) {
$response->throw();
}

if ($this->tries > 1 && $this->retryThrow) {
$response->throw();
}
}

$this->dispatchResponseReceivedEvent($response);
Expand All @@ -723,7 +733,9 @@ public function send(string $method, string $url, array $options = [])

throw new ConnectionException($e->getMessage(), 0, $e);
}
}, $this->retryDelay ?? 100, $this->retryWhenCallback);
}, $this->retryDelay ?? 100, function () use (&$shouldRetry) {
return $shouldRetry;
});
}

/**
Expand Down
73 changes: 68 additions & 5 deletions tests/Http/HttpClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1184,15 +1184,53 @@ public function testRequestIsMacroable()

public function testRequestExceptionIsThrownWhenRetriesExhausted()
{
$this->expectException(RequestException::class);

$this->factory->fake([
'*' => $this->factory->response(['error'], 403),
]);

$this->factory
->retry(2, 1000, null, true)
->get('http://foo.com/get');
$exception = null;

try {
$this->factory
->retry(2, 1000, null, true)
->get('http://foo.com/get');
} catch (RequestException $e) {
$exception = $e;
}

$this->assertNotNull($exception);
$this->assertInstanceOf(RequestException::class, $exception);

$this->factory->assertSentCount(2);
}

public function testRequestExceptionIsThrownWithoutRetriesIfRetryNotNecessary()
{
$this->factory->fake([
'*' => $this->factory->response(['error'], 500),
]);

$exception = null;
$whenAttempts = 0;

try {
$this->factory
->retry(2, 1000, function ($exception) use (&$whenAttempts) {
$whenAttempts++;

return $exception->response->status() === 403;
}, true)
->get('http://foo.com/get');
} catch (RequestException $e) {
$exception = $e;
}

$this->assertNotNull($exception);
$this->assertInstanceOf(RequestException::class, $exception);

$this->assertSame(1, $whenAttempts);

$this->factory->assertSentCount(1);
}

public function testRequestExceptionIsNotThrownWhenDisabledAndRetriesExhausted()
Expand All @@ -1206,6 +1244,31 @@ public function testRequestExceptionIsNotThrownWhenDisabledAndRetriesExhausted()
->get('http://foo.com/get');

$this->assertTrue($response->failed());

$this->factory->assertSentCount(2);
}

public function testRequestExceptionIsNotThrownWithoutRetriesIfRetryNotNecessary()
{
$this->factory->fake([
'*' => $this->factory->response(['error'], 500),
]);

$whenAttempts = 0;

$response = $this->factory
->retry(2, 1000, function ($exception) use (&$whenAttempts) {
$whenAttempts++;

return $exception->response->status() === 403;
}, false)
->get('http://foo.com/get');

$this->assertTrue($response->failed());

$this->assertSame(1, $whenAttempts);

$this->factory->assertSentCount(1);
}

public function testMiddlewareRunsWhenFaked()
Expand Down