cerbero90 / lazy-json-pages

src/Services/ClientFactory.php

<?php

declare(strict_types=1);

namespace Cerbero\LazyJsonPages\Services;

use Cerbero\LazyJsonPages\Middleware\Tap;
use Closure;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Handler\MockHandler;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use GuzzleHttp\RequestOptions;
use Psr\Http\Message\ResponseInterface;

/**
 * The HTTP client factory.
 */
final class ClientFactory
{
    /**
     * The default client configuration.
     *
     * @var array<string, mixed>
     */
    private static array $defaultConfig = [
        RequestOptions::CONNECT_TIMEOUT => 5,
        RequestOptions::READ_TIMEOUT => 5,
        RequestOptions::TIMEOUT => 5,
        RequestOptions::STREAM => true,
        RequestOptions::HEADERS => [
            'Accept' => 'application/json',
            'Content-Type' => 'application/json',
        ],
    ];

    /**
     * The global middleware.
     *
     * @var array<string, callable>
     */
    private static array $globalMiddleware = [];

    /**
     * Whether HTTP requests are faked.
     */
    private static bool $isFake = false;

    /**
     * The faked rate limits timestamps.
     *
     * @var float[]
     */
    public static array $fakedRateLimits = [];

    /**
     * The tap middleware callbacks.
     */
    private readonly TapCallbacks $tapCallbacks;

    /**
     * The rate limits.
     */
    public readonly RateLimits $rateLimits;

    /**
     * The custom client configuration.
     *
     * @var array<string, mixed>
     */
    private array $config = [];

    /**
     * The local middleware.
     *
     * @var array<string, callable>
     */
    private array $middleware = [];

    /**
     * Add a global middleware.
     */
    public static function globalMiddleware(string $name, callable $middleware): void
    {
        self::$globalMiddleware[$name] = $middleware;
    }

    /**
     * Fake HTTP requests for testing purposes.
     *
     * @param ResponseInterface[]|RequestException[] $responses
     * @return array<int, array<string, mixed>>
     */
    public static function fake(array $responses, Closure $callback): array
    {
        $transactions = [];

        self::$isFake = true;

        $handler = HandlerStack::create(new MockHandler($responses));

        $handler->push(Middleware::history($transactions));

        self::$defaultConfig['handler'] = $handler;

        $callback();

        unset(self::$defaultConfig['handler']);

        self::$fakedRateLimits = [];

        self::$isFake = false;

        return $transactions;
    }

    /**
     * Determine whether the HTTP requests are faked.
     */
    public static function isFake(): bool
    {
        return self::$isFake;
    }

    /**
     * Instantiate the class.
     */
    public function __construct()
    {
        $this->tapCallbacks = new TapCallbacks();

The property tapCallbacks is declared read-only in Cerbero\LazyJsonPages\Services\ClientFactory.

        $this->rateLimits = new RateLimits();

The property rateLimits is declared read-only in Cerbero\LazyJsonPages\Services\ClientFactory.

    }

    /**
     * Add the given option to the Guzzle client configuration.
     *
     * @param RequestOptions::* $name

The doc comment $name at position 0 could not be parsed: Unknown type name '$name' at position 0 in $name.

     */
    public function config(string $name, mixed $value): self
    {
        $this->config[$name] = $value;

        return $this;
    }

    /**
     * Add the given Guzzle client middleware.
     */
    public function middleware(string $name, callable $middleware): self
    {
        $this->middleware[$name] = $middleware;

        return $this;
    }

    /**
     * Add the given callback to handle the sending request.
     */
    public function onRequest(Closure $callback): self
    {
        $this->middleware['lazy_json_pages_tap'] ??= new Tap($this->tapCallbacks);

        $this->tapCallbacks->onRequest($callback);

        return $this;
    }

    /**
     * Add the given callback to handle the received response.
     */
    public function onResponse(Closure $callback): self
    {
        $this->middleware['lazy_json_pages_tap'] ??= new Tap($this->tapCallbacks);

        $this->tapCallbacks->onResponse($callback);

        return $this;
    }

    /**
     * Add the given callback to handle a transaction error.
     */
    public function onError(Closure $callback): self
    {
        $this->middleware['lazy_json_pages_tap'] ??= new Tap($this->tapCallbacks);

        $this->tapCallbacks->onError($callback);

        return $this;
    }

    /**
     * Throttle the requests to respect rate limiting.
     */
    public function throttle(int $requests, int $perSeconds): self
    {
        $this->rateLimits->add($requests, $perSeconds);

        $this->middleware['lazy_json_pages_throttle'] ??= Tap::once(fn() => $this->rateLimits->hit());

        return $this;
    }

    /**
     * Retrieve a configured Guzzle client instance.
     */
    public function make(): Client
    {
        $config = array_replace_recursive(self::$defaultConfig, $this->config);
        $config['handler'] ??= HandlerStack::create();

        foreach ([...self::$globalMiddleware, ...$this->middleware] as $name => $middleware) {
            $config['handler']->push($middleware, $name);
        }

        return new Client($config);
    }
}