Http\Client\Common\Plugin\RetryPlugin

Complexity

Total Complexity

11

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

78.72%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	defaultDelay()	0	4	1
A	__construct()	0	36	5
A	handleRequest()	0	35	5

<?php

namespace Http\Client\Common\Plugin;

use Http\Client\Common\Plugin;
use Http\Client\Exception;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * Retry the request if an exception is thrown.
 *
 * By default will retry only one time.
 *
 * @author Joel Wurtz <joel.wurtz@gmail.com>
 */
final class RetryPlugin implements Plugin
{
    /**
     * Number of retry before sending an exception.
     *
     * @var int
     */
    private $retry;

    /**
     * @var callable
     */
    private $exceptionDelay;

    /**
     * @var callable
     */
    private $exceptionDecider;

    /**
     * Store the retry counter for each request.
     *
     * @var array
     */
    private $retryStorage = [];

    /**
     * @param array $config {
     *
     *     @var int $retries Number of retries to attempt if an exception occurs before letting the exception bubble up.
     *     @var callable $exception_decider A callback that gets a request and an exception to decide after a failure whether the request should be retried.
     *     @var callable $exception_delay A callback that gets a request, an exception and the number of retries and returns how many microseconds we should wait before trying again.
     * }
     */
    public function __construct(array $config = [])
    {
        if (array_key_exists('decider', $config)) {
            if (array_key_exists('exception_decider', $config)) {
                throw new \InvalidArgumentException('Do not set both the old "decider" and new "exception_decider" options');
            }
            trigger_error('The "decider" option has been deprecated in favour of "exception_decider"', E_USER_DEPRECATED);
            $config['exception_decider'] = $config['decider'];
            unset($config['decider']);
        }
        if (array_key_exists('delay', $config)) {
            if (array_key_exists('exception_delay', $config)) {
                throw new \InvalidArgumentException('Do not set both the old "delay" and new "exception_delay" options');
            }
            trigger_error('The "delay" option has been deprecated in favour of "exception_delay"', E_USER_DEPRECATED);
            $config['exception_delay'] = $config['delay'];
            unset($config['delay']);
        }

        $resolver = new OptionsResolver();
        $resolver->setDefaults([
            'retries' => 1,
            'exception_decider' => function (RequestInterface $request, Exception $e) {

The parameter $request is not used and could be removed.

The parameter $e is not used and could be removed.

                return true;
            },
            'exception_delay' => __CLASS__.'::defaultDelay',
        ]);
        $resolver->setAllowedTypes('retries', 'int');
        $resolver->setAllowedTypes('exception_decider', 'callable');
        $resolver->setAllowedTypes('exception_delay', 'callable');
        $options = $resolver->resolve($config);

        $this->retry = $options['retries'];
        $this->exceptionDecider = $options['exception_decider'];
        $this->exceptionDelay = $options['exception_delay'];
    }

    /**
     * {@inheritdoc}
     */
    public function handleRequest(RequestInterface $request, callable $next, callable $first)
    {
        $chainIdentifier = spl_object_hash((object) $first);

        return $next($request)->then(function (ResponseInterface $response) use ($request, $chainIdentifier) {
            if (array_key_exists($chainIdentifier, $this->retryStorage)) {
                unset($this->retryStorage[$chainIdentifier]);
            }

            return $response;
        }, function (Exception $exception) use ($request, $next, $first, $chainIdentifier) {
            if (!array_key_exists($chainIdentifier, $this->retryStorage)) {
                $this->retryStorage[$chainIdentifier] = 0;
            }

            if ($this->retryStorage[$chainIdentifier] >= $this->retry) {
                unset($this->retryStorage[$chainIdentifier]);

                throw $exception;
            }

            if (!call_user_func($this->exceptionDecider, $request, $exception)) {
                throw $exception;
            }

            $time = call_user_func($this->exceptionDelay, $request, $exception, $this->retryStorage[$chainIdentifier]);
            usleep($time);

            // Retry in synchrone
            ++$this->retryStorage[$chainIdentifier];
            $promise = $this->handleRequest($request, $next, $first);

            return $promise->wait();
        });
    }

    /**
     * @param RequestInterface $request
     * @param Exception        $e
     * @param int              $retries The number of retries we made before. First time this get called it will be 0.
     *
     * @return int
     */
    public static function defaultDelay(RequestInterface $request, Exception $e, $retries)

The parameter $request is not used and could be removed.

The parameter $e is not used and could be removed.

    {
        return pow(2, $retries) * 500000;
    }
}