93 lines
3.1 KiB
PHP
Executable File
93 lines
3.1 KiB
PHP
Executable File
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Http\Client\Common\Plugin;
|
|
|
|
use Http\Client\Common\Exception\ClientErrorException;
|
|
use Http\Client\Common\Exception\ServerErrorException;
|
|
use Http\Client\Common\Plugin;
|
|
use Http\Promise\Promise;
|
|
use Psr\Http\Message\RequestInterface;
|
|
use Psr\Http\Message\ResponseInterface;
|
|
use Symfony\Component\OptionsResolver\OptionsResolver;
|
|
|
|
/**
|
|
* Throw exception when the response of a request is not acceptable.
|
|
*
|
|
* Status codes 400-499 lead to a ClientErrorException, status 500-599 to a ServerErrorException.
|
|
*
|
|
* Warning
|
|
* =======
|
|
*
|
|
* Throwing an exception on a valid response violates the PSR-18 specification.
|
|
* This plugin is provided as a convenience when writing a small application.
|
|
* When providing a client to a third party library, this plugin must not be
|
|
* included, or the third party library will have problems with error handling.
|
|
*
|
|
* @author Joel Wurtz <joel.wurtz@gmail.com>
|
|
*/
|
|
final class ErrorPlugin implements Plugin
|
|
{
|
|
/**
|
|
* @var bool Whether this plugin should only throw 5XX Exceptions (default to false).
|
|
*
|
|
* If set to true 4XX Responses code will never throw an exception
|
|
*/
|
|
private $onlyServerException;
|
|
|
|
/**
|
|
* @param array{'only_server_exception'?: bool} $config
|
|
*
|
|
* Configuration options:
|
|
* - only_server_exception: Whether this plugin should only throw 5XX Exceptions (default to false)
|
|
*/
|
|
public function __construct(array $config = [])
|
|
{
|
|
$resolver = new OptionsResolver();
|
|
$resolver->setDefaults([
|
|
'only_server_exception' => false,
|
|
]);
|
|
$resolver->setAllowedTypes('only_server_exception', 'bool');
|
|
$options = $resolver->resolve($config);
|
|
|
|
$this->onlyServerException = $options['only_server_exception'];
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
|
|
{
|
|
$promise = $next($request);
|
|
|
|
return $promise->then(function (ResponseInterface $response) use ($request) {
|
|
return $this->transformResponseToException($request, $response);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Transform response to an error if possible.
|
|
*
|
|
* @param RequestInterface $request Request of the call
|
|
* @param ResponseInterface $response Response of the call
|
|
*
|
|
* @return ResponseInterface If status code is not in 4xx or 5xx return response
|
|
*
|
|
* @throws ClientErrorException If response status code is a 4xx
|
|
* @throws ServerErrorException If response status code is a 5xx
|
|
*/
|
|
private function transformResponseToException(RequestInterface $request, ResponseInterface $response): ResponseInterface
|
|
{
|
|
if (!$this->onlyServerException && $response->getStatusCode() >= 400 && $response->getStatusCode() < 500) {
|
|
throw new ClientErrorException($response->getReasonPhrase(), $request, $response);
|
|
}
|
|
|
|
if ($response->getStatusCode() >= 500 && $response->getStatusCode() < 600) {
|
|
throw new ServerErrorException($response->getReasonPhrase(), $request, $response);
|
|
}
|
|
|
|
return $response;
|
|
}
|
|
}
|