LeoCarmo\CircuitBreaker\GuzzleMiddleware

Complexity

Total Complexity

23

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setCustomSuccessCodes()	0	3	1
A	setCustomIgnoreCodes()	0	3	1
A	setCustomIgnoreFamily()	0	5	1
A	isIgnoredStatus()	0	3	2
A	__invoke()	0	21	2
A	validateCodeStatusFamily()	0	6	4
A	isStatusCodeFamilyToSuccess()	0	4	1
A	isStatusCodeSuccess()	0	3	2
A	isStatusCodeRangeValid()	0	3	2
A	executeCircuitBreakerOnResponse()	0	19	4
A	setCustomSuccessFamily()	0	5	1
A	isStatusCodeFamilyToIgnore()	0	4	1

<?php declare(strict_types=1);

namespace LeoCarmo\CircuitBreaker;

use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

class GuzzleMiddleware
{
    private const DEFAULT_SUCCESS_FAMILY = 200;

    private const DEFAULT_IGNORE_FAMILY = 300;

    protected CircuitBreaker $circuitBreaker;

    protected array $customSuccessCodes = [];

    protected array $customIgnoreCodes = [];

    protected array $customSuccessFamily = [];

    protected array $customIgnoreFamily = [];

    public function __construct(CircuitBreaker $circuitBreaker)
    {
        $this->circuitBreaker = $circuitBreaker;
        $this->setCustomSuccessFamily(self::DEFAULT_SUCCESS_FAMILY);
        $this->setCustomIgnoreFamily(self::DEFAULT_IGNORE_FAMILY);
    }

    public function setCustomSuccessCodes(array $codes): void
    {
        $this->customSuccessCodes = $codes;
    }

    private function validateCodeStatusFamily(int $family): void
    {
        $num_length = strlen((string) $family);
        $initial_number = substr((string) $family, 0, 1);
        if (($num_length !== 3) && ($initial_number > 0 && $initial_number < 6)) {
            throw new \InvalidArgumentException('This code status family is not valid.');
        }
    }

    public function setCustomSuccessFamily(int $family): void
    {
        $this->validateCodeStatusFamily($family);
        $initial_number = substr((string) $family, 0, 1);
        $this->customSuccessFamily[] = $initial_number;
    }

    public function setCustomIgnoreFamily(int $family): void
    {
        $this->validateCodeStatusFamily($family);
        $initial_number = substr((string) $family, 0, 1);
        $this->customIgnoreFamily[] = $initial_number;
    }

    public function setCustomIgnoreCodes(array $codes): void
    {
        $this->customIgnoreCodes = $codes;
    }

    public function __invoke(callable $handler): \Closure
    {
        return function (RequestInterface $request, array $options) use ($handler) {

            if (! $this->circuitBreaker->isAvailable()) {
                throw new CircuitBreakerException(
                    sprintf('"%s" is not available', $this->circuitBreaker->getService())
                );
            }

            $promise = $handler($request, $options);

            return $promise->then(
                function (ResponseInterface $response) {
                    $this->executeCircuitBreakerOnResponse($response);

                    return $response;
                },
                function (\Throwable $exception) {
                    $this->circuitBreaker->failure();
                    throw $exception;
                }
            );
        };
    }

    protected function executeCircuitBreakerOnResponse(ResponseInterface $response): void
    {
        $statusCode = $response->getStatusCode();

        if ($this->isIgnoredStatus($statusCode)) {
            return;
        }

        if (! $this->isStatusCodeRangeValid($statusCode)) {
            $this->circuitBreaker->failure();
            return;
        }

        if ($this->isStatusCodeSuccess($statusCode)) {
            $this->circuitBreaker->success();
            return;
        }

        $this->circuitBreaker->failure();
    }

    protected function isStatusCodeFamilyToIgnore(int $statusCode): bool
    {
        $initial_number = substr((string) $statusCode, 0, 1);
        return (in_array($initial_number, $this->customIgnoreFamily));
    }

    protected  function isIgnoredStatus(int $statusCode): bool
    {
        return $this->isStatusCodeFamilyToIgnore($statusCode) || in_array($statusCode, $this->customIgnoreCodes);
    }

    protected function isStatusCodeRangeValid(int $statusCode): bool
    {
        return ($statusCode >= 100 && $statusCode < 600);
    }

    protected function isStatusCodeFamilyToSuccess(int $statusCode): bool
    {
        $initial_number = substr((string) $statusCode, 0, 1);
        return (in_array($initial_number, $this->customSuccessFamily));
    }

    protected function isStatusCodeSuccess(int $statusCode): bool
    {
        return ($this->isStatusCodeFamilyToSuccess($statusCode) || in_array($statusCode, $this->customSuccessCodes));
    }
}