8000 [HttpClient] Add `max_retries` option to `RetryableHttpClient` by danielburger1337 · Pull Request #50240 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[HttpClient] Add max_retries option to RetryableHttpClient#50240

Merged
nicolas-grekas merged 1 commit intosymfony:6.4from Jun 9, 2023
Merged

[HttpClient] Add max_retries option to RetryableHttpClient#50240
nicolas-grekas merged 1 commit intosymfony:6.4from
danielburger1337:httpclient-no-retry

Conversation

@danielburger1337
Copy link
Contributor
@danielburger1337 danielburger1337 commented May 4, 2023 •
edited by nicolas-grekas
Loading
Q A
Branch? 6.4
Bug fix? no
New feature? yes
Deprecations? no
Tickets N/A
License MIT
Doc PR symfony/symfony-docs#18288

Added a max_retries option to RetryableHttpClient that allows the user to configure the RetryableHttpClient on a per request level, which is especially useful when retry_failed was configured for the global http_client service.

<?php

use Symfony\Component\HttpClient\HttpClient;
use Symfony\Component\HttpClient\RetryableHttpClient;

$client = HttpClient::create();
$client = new RetryableHttpClient($client, null, 3);

$client->request('GET', '/foo-bar', [
    'max_retries' => 1 // 0 disables retrying
]);

// $client = $client->withOptions(['max_retries' => 1]);

@carsonbot carsonbot added this to the 6.3 milestone May 4, 2023
@nicolas-grekas
Copy link
Member
nicolas-grekas commented May 5, 2023 •
edited
Loading

What about adding max_retries instead? this would be more flexible.
Note that this doesn't need to be an "extra" option - it shouldn't actually.
This will need to override the withOptions method also.
You might want to take some inspiration from UriTemplateHttpClient, which also manages its own option.

@danielburger1337
Copy link
Contributor Author
danielburger1337 commented May 5, 2023

What about adding max_retries instead? this would be more flexible. Not that this doesn't need to be an "extra" option - it shouldn't actually. This will need to override the withOptions method also. You might want to take some inspiration from UriTemplateHttpClient, which also manages its own option.

Yes, this would be much more flexible approach and I like it!

To be extra clear, would this option overide the maxRetries property of the RetryableHttpClient when cloned?
Because otherwise I'm not quite sure what you mean.

@nicolas-grekas
Copy link
Member
nicolas-grekas commented May 5, 2023

Yes, it would override it indeed.

@danielburger1337 danielburger1337 changed the title [HttpClient] Add "no_retry" option to RetryableHttpClient [HttpClient] Add "max_retries" option to RetryableHttpClient May 5, 2023
@danielburger1337 danielburger1337 mentioned this pull request May 5, 2023
Merged
Copy link
Contributor
OskarStark commented May 6, 2023 •
edited
Loading

Can you please update the pr header? You still mention no_retry. Thanks

@danielburger1337
Copy link
Contributor Author
danielburger1337 commented May 6, 2023

Can you please update the pr header? You still mention no_retry. Thanks

What do you mean by PR header? Do you mean my original PR description?

Sorry, I never heard that term before.

@OskarStark
Copy link
Contributor
OskarStark commented May 6, 2023

Yes the PR description and the code example. Thanks

@danielburger1337
Copy link
Contributor Author
danielburger1337 commented May 6, 2023

Yes the PR description and the code example. Thanks

Done

nicolas-grekas
nicolas-grekas approved these changes May 16, 2023
View reviewed changes
Copy link
Member
@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

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

Look good to me thanks. I just have a minor comment.

@OskarStark OskarStark changed the title [HttpClient] Add "max_retries" option to RetryableHttpClient [HttpClient] Add max_retries option to RetryableHttpClient May 16, 2023
@danielburger1337 danielburger1337 mentioned this pull request May 17, 2023
Closed
@nicolas-grekas nicolas-grekas modified the milestones: 6.3, 6.4 May 23, 2023
@nicolas-grekas
Copy link
Member
nicolas-grekas commented Jun 9, 2023

Thank you @danielburger1337.

@nicolas-grekas nicolas-grekas merged commit 52a9292 into symfony:6.4 Jun 9, 2023
OskarStark added a commit to symfony/symfony-docs that referenced this pull request Jun 9, 2023
@OskarStark
feature #18288 [HttpClient] Add max_retries setting docs on the `Re…
8d59ced 
…tryableHttpClient` (danielburger1337)

This PR was submitted for the 6.3 branch but it was merged into the 6.4 branch instead.

Discussion
----------

[HttpClient] Add `max_retries` setting docs on the `RetryableHttpClient`

References [#50240](symfony/symfony#50240)

Commits
-------

bf57a3e Add 'max_retries' setting docs on the RetryableHttpClient
This was referenced Oct 21, 2023
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nicolas-grekas nicolas-grekas nicolas-grekas approved these changes

+1 more reviewer

@fancyweb fancyweb fancyweb approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Feature HttpClient Status: Reviewed

Projects

None yet

Milestone

6.4

Development

Successfully merging this pull request may close these issues.

5 participants

@danielburger1337 @nicolas-grekas @OskarStark @fancyweb @carsonbot
0