-
Notifications
You must be signed in to change notification settings - Fork 6
Add a safety catch for max restarts #31
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.
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,9 @@ | ||
<?php | ||
|
||
namespace Http\Client\Plugin\Exception; | ||
|
||
use Http\Client\Exception\RequestException; | ||
|
||
class LoopException extends RequestException | ||
{ | ||
} |
This file contains hidden or 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 |
---|---|---|
|
@@ -4,7 +4,9 @@ | |
|
||
use Http\Client\HttpAsyncClient; | ||
use Http\Client\HttpClient; | ||
use Http\Client\Plugin\Exception\LoopException; | ||
use Psr\Http\Message\RequestInterface; | ||
use Symfony\Component\OptionsResolver\OptionsResolver; | ||
|
||
/** | ||
* The client managing plugins and providing a decorator around HTTP Clients. | ||
|
@@ -27,13 +29,21 @@ class PluginClient implements HttpClient, HttpAsyncClient | |
*/ | ||
protected $plugins; | ||
|
||
/** | ||
* A list of options. | ||
* | ||
* @var array | ||
*/ | ||
protected $options; | ||
|
||
/** | ||
* @param HttpClient|HttpAsyncClient $client | ||
* @param Plugin[] $plugins | ||
* @param array $options | ||
* | ||
* @throws \RuntimeException if client is not an instance of HttpClient or HttpAsyncClient | ||
*/ | ||
public function __construct($client, array $plugins = []) | ||
public function __construct($client, array $plugins = [], array $options = []) | ||
{ | ||
if ($client instanceof HttpAsyncClient) { | ||
$this->client = $client; | ||
|
@@ -44,6 +54,7 @@ public function __construct($client, array $plugins = []) | |
} | ||
|
||
$this->plugins = $plugins; | ||
$this->options = $this->configure($options); | ||
} | ||
|
||
/** | ||
|
@@ -66,6 +77,23 @@ public function sendAsyncRequest(RequestInterface $request) | |
return $pluginChain($request); | ||
} | ||
|
||
/** | ||
* Configure the plugin client. | ||
* | ||
* @param array $options | ||
* | ||
* @return array | ||
*/ | ||
protected function configure(array $options = []) | ||
{ | ||
$resolver = new OptionsResolver(); | ||
$resolver->setDefaults([ | ||
'max_restarts' => 10, | ||
]); | ||
|
||
return $resolver->resolve($options); | ||
} | ||
|
||
/** | ||
* @param Plugin[] $pluginList | ||
* | ||
|
@@ -74,6 +102,8 @@ public function sendAsyncRequest(RequestInterface $request) | |
private function createPluginChain($pluginList) | ||
{ | ||
$client = $this->client; | ||
$options = $this->options; | ||
|
||
$lastCallable = function (RequestInterface $request) use ($client) { | ||
return $client->sendAsyncRequest($request); | ||
}; | ||
|
@@ -87,6 +117,17 @@ private function createPluginChain($pluginList) | |
$firstCallable = $lastCallable; | ||
} | ||
|
||
$firstCalls = 0; | ||
$firstCallable = function (RequestInterface $request) use ($options, $lastCallable, &$firstCalls) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. do we need the local $options? i thought since php 5.4 you can use $this inside the anonymous function. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
if ($firstCalls > $options['max_restarts']) { | ||
throw new LoopException('Too many restarts in plugin client', $request); | ||
} | ||
|
||
++$firstCalls; | ||
|
||
return $lastCallable($request); | ||
}; | ||
|
||
return $firstCallable; | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should list and explain the options (in the main docblock text of the constructor, not in the argument)