Introduce a draft for a generic reusable HTTP client builder

Author: veewee

build.php

@@ -0,0 +1,43 @@
+<?php
+require __DIR__ . '/vendor/autoload.php';
+
+use Http\Message\Authentication\BasicAuth;
+use Http\Message\Formatter;
+use Phpro\HttpTools\Client\ClientBuilder;
+use Phpro\HttpTools\Client\Factory\SymfonyClientFactory;
+use Phpro\HttpTools\Formatter\FormatterBuilder;
+use Phpro\HttpTools\Formatter\RemoveSensitiveHeadersFormatter;
+use Phpro\HttpTools\Request\Request;
+use Phpro\HttpTools\Transport\Presets\RawPreset;
+use Phpro\HttpTools\Uri\RawUriBuilder;
+use Symfony\Component\Console\Logger\ConsoleLogger;
+use Symfony\Component\Console\Output\OutputInterface;
+
+$client = ClientBuilder::default(SymfonyClientFactory::create([]))
+    ->addBaseUri('https://www.google.com')
+    ->addHeaders([
+        'x-Foo' => 'bar',
+    ])
+    ->addAuthentication(new BasicAuth('user', 'pass'))
+    ->addLogger(
+        new ConsoleLogger(new Symfony\Component\Console\Output\ConsoleOutput(OutputInterface::VERBOSITY_DEBUG)),
+        FormatterBuilder::default()
+            ->withDebug(true)
+            ->withMaxBodyLength(1000)
+            ->addDecorator(static fn (Formatter $formatter) => new RemoveSensitiveHeadersFormatter($formatter, [
+                'X-SENSITIVE-HEADER',
+            ]))
+            ->build()
+    )
+
+    ->build();
+
+
+$transport = RawPreset::create($client, RawUriBuilder::createWithAutodiscoveredPsrFactories());
+$request = new Request('GET', '/', [], '');
+$response = $transport($request);
+
+echo $response;
+
+
+

src/Client/ClientBuilder.php

@@ -0,0 +1,120 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phpro\HttpTools\Client;
+
+use Http\Client\Common\Plugin;
+use Http\Client\Common\PluginClient;
+use Http\Client\Plugin\Vcr\NamingStrategy\NamingStrategyInterface;
+use Http\Client\Plugin\Vcr\Recorder\PlayerInterface;
+use Http\Client\Plugin\Vcr\Recorder\RecorderInterface;
+use Http\Client\Plugin\Vcr\RecordPlugin;
+use Http\Client\Plugin\Vcr\ReplayPlugin;
+use Http\Discovery\Psr17FactoryDiscovery;
+use Http\Discovery\Psr18ClientDiscovery;
+use Http\Message\Authentication;
+use Http\Message\Formatter;
+use Phpro\HttpTools\Client\Configurator\PluginsConfigurator;
+use Psr\Http\Client\ClientInterface;
+use Psr\Http\Message\UriInterface;
+use Psr\Log\LoggerInterface;
+use SplPriorityQueue;
+
+final readonly class ClientBuilder
+{
+    public const int PRIORITY_LEVEL_DEFAULT = 0;
+    public const int PRIORITY_LEVEL_SECURITY = 1000;
+    public const int PRIORITY_LEVEL_LOGGING = 2000;
+
+    private ClientInterface $client;
+
+    /**
+     * @var SplPriorityQueue<Plugin>
+     */
+    private SplPriorityQueue $plugins;
+
+    public function __construct(
+        ?ClientInterface $client = null,
+        iterable $middlewares = [],
+    ) {
+        $this->client = $client ?? Psr18ClientDiscovery::find();
+        $this->plugins = new SplPriorityQueue();
+
+        foreach ($middlewares as $middleware) {
+            $this->plugins->insert($middleware, self::PRIORITY_LEVEL_DEFAULT);
+        }
+    }
+
+    public static function default(
+        ?ClientInterface $client = null,
+    ): self {
+        return new self($client, [
+            new Plugin\ErrorPlugin(),
+        ]);
+    }
+
+    public function addPlugin(
+        Plugin $plugin,
+        int $priority = self::PRIORITY_LEVEL_DEFAULT,
+    ): self {
+        $this->plugins->insert($plugin, $priority);
+
+        return $this;
+    }
+
+    public function addAuthentication(
+        Authentication $authentication,
+        int $priority = self::PRIORITY_LEVEL_SECURITY,
+    ): self {
+        return $this->addPlugin(new Plugin\AuthenticationPlugin($authentication), $priority);
+    }
+
+    public function addLogger(
+        LoggerInterface $logger,
+        ?Formatter $formatter = null,
+        int $priority = self::PRIORITY_LEVEL_LOGGING,
+    ): self {
+        return $this->addPlugin(new Plugin\LoggerPlugin($logger, $formatter), $priority);
+    }
+
+    /**
+     * @param array<string, string | string[]> $headers
+     *
+     * @return $this
+     */
+    public function addHeaders(
+        array $headers,
+        int $priority = self::PRIORITY_LEVEL_DEFAULT,
+    ): self {
+        return $this->addPlugin(new Plugin\HeaderSetPlugin($headers), $priority);
+    }
+
+    public function addBaseUri(
+        UriInterface|string $baseUri,
+        bool $replaceHost = true,
+        int $priority = self::PRIORITY_LEVEL_DEFAULT,
+    ): self {
+        $baseUri = match (true) {
+            is_string($baseUri) => Psr17FactoryDiscovery::findUriFactory()->createUri($baseUri),
+            default => $baseUri,
+        };
+
+        return $this->addPlugin(new Plugin\BaseUriPlugin($baseUri, ['replace' => $replaceHost]), $priority);
+    }
+
+    public function addRecording(
+        NamingStrategyInterface $namingStrategy,
+        RecorderInterface&PlayerInterface $recorder,
+        int $priority = self::PRIORITY_LEVEL_LOGGING,
+    ): self {
+        return $this
+            ->addPlugin(new RecordPlugin($namingStrategy, $recorder), $priority)
+            ->addPlugin(new ReplayPlugin($namingStrategy, $recorder, false), $priority);
+    }
+
+    public function build(): PluginClient
+    {
+        return PluginsConfigurator::configure($this->client, [...$this->plugins]);
+    }
+}

src/Formatter/FormatterBuilder.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phpro\HttpTools\Formatter;
+
+use Closure;
+use Http\Message\Formatter;
+use Phpro\HttpTools\Formatter\Factory\BasicFormatterFactory;
+
+use function Psl\Fun\pipe;
+
+/**
+ * @psalm-type Decorator = \Closure(Formatter): Formatter
+ */
+final class FormatterBuilder
+{
+    private bool $debug = false;
+    private int $maxBodyLength = 1000;
+
+    /**
+     * @var list<Decorator>
+     */
+    private array $decorators = [];
+
+    public static function default(
+    ): FormatterBuilder {
+        return new self();
+    }
+
+    public function withDebug(bool $debug = true): self
+    {
+        $this->debug = $debug;
+
+        return $this;
+    }
+
+    public function withMaxBodyLength(int $maxBodyLength): self
+    {
+        $this->maxBodyLength = $maxBodyLength;
+
+        return $this;
+    }
+
+    /**
+     * @param Decorator $decorator
+     */
+    public function addDecorator(Closure $decorator): self
+    {
+        $this->decorators[] = $decorator;
+
+        return $this;
+    }
+
+    public function build(): Formatter
+    {
+        return pipe(...$this->decorators)(
+            BasicFormatterFactory::create($this->debug, $this->maxBodyLength)
+        );
+    }
+}