Introduce a draft for a generic reusable HTTP client builder

[veewee]

Q	A
Type	feature
BC Break	no
Fixed issues

Summary

<?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\ConsoleOutput;
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 ConsoleOutput(OutputInterface::VERBOSITY_DEBUG)),
        FormatterBuilder::default()
            ->withDebug(true)
            ->withMaxBodyLength(1000)
            ->addDecorator(RemoveSensitiveHeadersFormatter::createDecorator([
                'X-SENSITIVE-HEADER',
            ]))
            ->build()
    )
    ->addPluginWithCurrentlyConfiguredClient(
        static fn (\Psr\Http\Client\ClientInterface $client) => new class($client) implements \Http\Client\Common\Plugin
        {
            public function __construct(
                private \Psr\Http\Client\ClientInterface $client,
            ) {
            }

            public function handleRequest(\Psr\Http\Message\RequestInterface $request, callable $next, callable $first): \Http\Promise\Promise
            {
                // $token = $this->client->sendRequest('...;');

                return $next($request->withHeader('X-token', '$token'));
            }

        }
    )
    ->build();


$transport = RawPreset::create($client, RawUriBuilder::createWithAutodiscoveredPsrFactories());
$request = new Request('GET', '/', [], '');
$response = $transport($request);

echo $response;

[MetalArend]

Looks very promising 😍

[Copilot]

Pull request overview

This PR introduces reusable builder classes for configuring HTTP clients and formatters, simplifying the setup process for complex HTTP client configurations with plugins, authentication, logging, and sensitive data masking.

Key changes:

• Added ClientBuilder class with fluent API for configuring HTTP clients with plugins, authentication, logging, base URIs, headers, and recording capabilities
• Added FormatterBuilder class with fluent API for configuring message formatters with debugging and decorator support
• Added static factory methods (createDecorator) to sensitive data formatter classes for easier integration with the builder pattern

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/Client/ClientBuilder.php	New builder class providing fluent API for HTTP client configuration with support for plugins, authentication, logging, and more
src/Formatter/FormatterBuilder.php	New builder class for configuring message formatters with debug mode, body length limits, and decorators
src/Formatter/RemoveSensitiveHeadersFormatter.php	Added createDecorator static factory method for builder integration
src/Formatter/RemoveSensitiveJsonKeysFormatter.php	Added createDecorator static factory method for builder integration
src/Formatter/RemoveSensitiveQueryStringsFormatter.php	Added createDecorator static factory method for builder integration
tests/Unit/Client/ClientBuilderTest.php	Comprehensive test coverage for ClientBuilder functionality
tests/Unit/Formatter/FormatterBuilderTest.php	Comprehensive test coverage for FormatterBuilder functionality
tests/Unit/Formatter/RemoveSensitiveHeaderKeysFormatterTest.php	Added test for createDecorator factory method
tests/Unit/Formatter/RemoveSensitiveJsonKeysFormatterTest.php	Added test for createDecorator factory method
tests/Unit/Formatter/RemoveSensitiveQueryStringsFormatterTest.php	Added test for createDecorator factory method
README.md	Added documentation and examples for using the new builder classes
docs/framework/symfony.md	Removed Symfony-specific documentation (moved or consolidated elsewhere)
docs/framework/magento2.md	Removed Magento2-specific documentation (moved or consolidated elsewhere)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.