Merge pull request #442 from glaubinix/client-interface

Use ClientInterface instead of HttpClient

Author: dbu

CHANGELOG.md

@@ -12,6 +12,9 @@ The change log describes what is "Added", "Removed", "Changed" or "Fixed" betwee
 - Removed `message_factory`, `uri_factory`, and `stream_factory` classes config option. You can configure your own factories via psr17_*_factory classes config
 - Removed support for guzzle5-adapter
 - Removed support for Symfony versions <5.4
+- Changed the return type of `ClientFactory` to return a `ClientInterface` instead of `ClientInterface|HttpClient`
+- Changed the type of `httplug.client.default` to `ClientInterface` instead of `HttpClient`
+- Removed the `DummyClient` interface
 
 # Version 1
 

src/ClientFactory/AutoDiscoveryFactory.php

@@ -4,7 +4,7 @@
 
 namespace Http\HttplugBundle\ClientFactory;
 
-use Http\Discovery\HttpClientDiscovery;
+use Http\Discovery\Psr18ClientDiscovery;
 
 /**
  * Use auto discovery to find a HTTP client.
@@ -18,6 +18,6 @@ class AutoDiscoveryFactory implements ClientFactory
      */
     public function createClient(array $config = [])
     {
-        return HttpClientDiscovery::find();
+        return Psr18ClientDiscovery::find();
     }
 }

src/ClientFactory/ClientFactory.php

@@ -4,7 +4,6 @@
 
 namespace Http\HttplugBundle\ClientFactory;
 
-use Http\Client\HttpClient;
 use Psr\Http\Client\ClientInterface;
 
 /**
@@ -13,9 +12,9 @@
 interface ClientFactory
 {
     /**
-     * Input an array of configuration to be able to create a HttpClient.
+     * Input an array of configuration to be able to create a ClientInterface.
      *
-     * @return HttpClient|ClientInterface
+     * @return ClientInterface
      */
     public function createClient(array $config = []);
 }

src/ClientFactory/DummyClient.php

@@ -7,7 +7,6 @@
 use Http\Client\Common\Plugin;
 use Http\Client\Common\PluginClient;
 use Http\Client\HttpAsyncClient;
-use Http\Client\HttpClient;
 use Psr\Http\Client\ClientInterface;
 use Symfony\Component\Stopwatch\Stopwatch;
 
@@ -44,9 +43,9 @@ public function __construct(Collector $collector, Formatter $formatter, Stopwatc
     }
 
     /**
-     * @param HttpClient|ClientInterface|HttpAsyncClient $client
-     * @param Plugin[]                                   $plugins
-     * @param array                                      $options {
+     * @param ClientInterface|HttpAsyncClient $client
+     * @param Plugin[]                        $plugins
+     * @param array                           $options {
      *
      *     @var string $client_name to give client a name which may be used when displaying client information like in
      *         the HTTPlugBundle profiler.

src/Collector/PluginClientFactory.php

@@ -8,27 +8,26 @@
 use Http\Client\Common\VersionBridgeClient;
 use Http\Client\Exception\HttpException;
 use Http\Client\HttpAsyncClient;
-use Http\Client\HttpClient;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Symfony\Component\Stopwatch\Stopwatch;
 use Symfony\Component\Stopwatch\StopwatchEvent;
 
 /**
- * The ProfileClient decorates any client that implement both HttpClient and HttpAsyncClient interfaces to gather target
+ * The ProfileClient decorates any client that implement both ClientInterface and HttpAsyncClient interfaces to gather target
  * url and response status code.
  *
  * @author Fabien Bourigault <bourigaultfabien@gmail.com>
  *
  * @internal
  */
-class ProfileClient implements HttpClient, HttpAsyncClient
+class ProfileClient implements ClientInterface, HttpAsyncClient
 {
     use VersionBridgeClient;
 
     /**
-     * @var HttpClient|HttpAsyncClient
+     * @var ClientInterface|HttpAsyncClient
      */
     private $client;
 
@@ -55,12 +54,12 @@ class ProfileClient implements HttpClient, HttpAsyncClient
     private const STOPWATCH_CATEGORY = 'httplug';
 
     /**
-     * @param HttpClient|HttpAsyncClient $client The client to profile. Client must implement HttpClient or
-     *                                           HttpAsyncClient interface.
+     * @param ClientInterface|HttpAsyncClient $client The client to profile. Client must implement HttpClient or
+     *                                                HttpAsyncClient interface.
      */
     public function __construct($client, Collector $collector, Formatter $formatter, Stopwatch $stopwatch)
     {
-        if (!(($client instanceof ClientInterface || $client instanceof HttpClient) && $client instanceof HttpAsyncClient)) {
+        if (!($client instanceof ClientInterface && $client instanceof HttpAsyncClient)) {
             $client = new FlexibleHttpClient($client);
         }
 

src/Collector/ProfileClient.php

@@ -6,7 +6,6 @@
 
 use Http\Client\Common\FlexibleHttpClient;
 use Http\Client\HttpAsyncClient;
-use Http\Client\HttpClient;
 use Http\HttplugBundle\ClientFactory\ClientFactory;
 use Psr\Http\Client\ClientInterface;
 use Symfony\Component\Stopwatch\Stopwatch;
@@ -61,7 +60,7 @@ public function createClient(array $config = [])
     {
         $client = is_callable($this->factory) ? call_user_func($this->factory, $config) : $this->factory->createClient($config);
 
-        if (!(($client instanceof HttpClient || $client instanceof ClientInterface) && $client instanceof HttpAsyncClient)) {
+        if (!($client instanceof ClientInterface && $client instanceof HttpAsyncClient)) {
             $client = new FlexibleHttpClient($client);
         }
 

src/Collector/ProfileClientFactory.php

@@ -112,7 +112,7 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->children()
                 ->booleanNode('default_client_autowiring')
                     ->defaultTrue()
-                    ->info('Set to false to not autowire HttpClient and HttpAsyncClient.')
+                    ->info('Set to false to not autowire ClientInterface and HttpAsyncClient.')
                 ->end()
                 ->arrayNode('main_alias')
                     ->addDefaultsIfNotSet()

src/DependencyInjection/Configuration.php

@@ -13,7 +13,6 @@
 use Http\Client\Common\PluginClient;
 use Http\Client\Common\PluginClientFactory;
 use Http\Client\HttpAsyncClient;
-use Http\Client\HttpClient;
 use Http\Client\Plugin\Vcr\RecordPlugin;
 use Http\Client\Plugin\Vcr\ReplayPlugin;
 use Http\Message\Authentication\BasicAuth;
@@ -116,7 +115,7 @@ public function load(array $configs, ContainerBuilder $container): void
 
         if (!$config['default_client_autowiring']) {
             $container->removeAlias(HttpAsyncClient::class);
-            $container->removeAlias(HttpClient::class);
+            $container->removeAlias(ClientInterface::class);
         }
 
         if ($this->useVcrPlugin) {
@@ -413,7 +412,6 @@ private function configureClient(ContainerBuilder $container, $clientName, array
     {
         $serviceId = 'httplug.client.'.$clientName;
 
-        $container->registerAliasForArgument($serviceId, HttpClient::class, $clientName);
         $container->registerAliasForArgument($serviceId, ClientInterface::class, $clientName);
         $container->registerAliasForArgument($serviceId, HttpAsyncClient::class, $clientName);
 
@@ -440,7 +438,7 @@ private function configureClient(ContainerBuilder $container, $clientName, array
 
         if (empty($arguments['service'])) {
             $container
-                ->register($serviceId.'.client', HttpClient::class)
+                ->register($serviceId.'.client', ClientInterface::class)
                 ->setFactory([new Reference($arguments['factory']), 'createClient'])
                 ->addArgument($arguments['config'])
                 ->setPublic(false);

src/DependencyInjection/HttplugExtension.php

@@ -5,9 +5,9 @@
 namespace Http\HttplugBundle\Discovery;
 
 use Http\Client\HttpAsyncClient;
-use Http\Client\HttpClient;
-use Http\Discovery\HttpClientDiscovery;
+use Http\Discovery\Psr18ClientDiscovery;
 use Http\Discovery\Strategy\DiscoveryStrategy;
+use Psr\Http\Client\ClientInterface;
 
 /**
  * A strategy that provide clients configured with HTTPlug bundle. With help from this strategy
@@ -18,7 +18,7 @@
 class ConfiguredClientsStrategy implements DiscoveryStrategy
 {
     /**
-     * @var HttpClient
+     * @var ClientInterface
      */
     private static $client;
 
@@ -28,22 +28,22 @@ class ConfiguredClientsStrategy implements DiscoveryStrategy
     private static $asyncClient;
 
     /**
-     * @param HttpClient      $httpClient
+     * @param ClientInterface $httpClient
      * @param HttpAsyncClient $asyncClient
      */
-    public function __construct(HttpClient $httpClient = null, HttpAsyncClient $asyncClient = null)
+    public function __construct(ClientInterface $httpClient = null, HttpAsyncClient $asyncClient = null)
     {
         self::$client = $httpClient;
         self::$asyncClient = $asyncClient;
-        HttpClientDiscovery::clearCache();
+        Psr18ClientDiscovery::clearCache();
     }
 
     /**
      * {@inheritdoc}
      */
     public static function getCandidates($type)
     {
-        if (HttpClient::class === $type && null !== self::$client) {
+        if (ClientInterface::class === $type && null !== self::$client) {
             return [['class' => function () {
                 return self::$client;
             }]];

src/Discovery/ConfiguredClientsStrategy.php

@@ -4,7 +4,7 @@
 
 namespace Http\HttplugBundle\Discovery;
 
-use Http\Discovery\HttpClientDiscovery;
+use Http\Discovery\Psr18ClientDiscovery;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 /**
@@ -17,7 +17,7 @@ class ConfiguredClientsStrategyListener implements EventSubscriberInterface
      */
     public function onEvent()
     {
-        HttpClientDiscovery::prependStrategy(ConfiguredClientsStrategy::class);
+        Psr18ClientDiscovery::prependStrategy(ConfiguredClientsStrategy::class);
     }
 
     /**

src/Discovery/ConfiguredClientsStrategyListener.php

@@ -13,8 +13,8 @@
             <tag name="kernel.event_subscriber"/>
         </service>
 
-        <service id="httplug.auto_discovery.auto_discovered_client" class="Http\Client\HttpClient">
-            <factory class="Http\Discovery\HttpClientDiscovery" method="find" />
+        <service id="httplug.auto_discovery.auto_discovered_client" class="Psr\Http\Client\ClientInterface">
+            <factory class="Http\Discovery\Psr18ClientDiscovery" method="find" />
         </service>
 
         <service id="httplug.auto_discovery.auto_discovered_async" class="Http\Client\HttpAsyncClient">
@@ -27,8 +27,8 @@
         </service>
         <service id="Http\Client\HttpAsyncClient" alias="httplug.async_client.default" public="false" />
 
-        <service id="httplug.client.default" class="Http\Client\HttpClient">
-            <factory class="Http\Discovery\HttpClientDiscovery" method="find" />
+        <service id="httplug.client.default" class="Psr\Http\Client\ClientInterface">
+            <factory class="Http\Discovery\Psr18ClientDiscovery" method="find" />
         </service>
         <service id="Psr\Http\Client\ClientInterface" alias="httplug.client" public="false" />
 

src/Resources/config/services.xml

@@ -4,7 +4,7 @@
            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <services>
-        <service id="Http\Client\HttpClient" alias="httplug.client" public="false">
+        <service id="Psr\Http\Client\ClientInterface" alias="httplug.client" public="false">
             <deprecated package="php-http/httplug-bundle" version="1.28">The "%alias_id%" service is deprecated in favor of using PSR-7 Psr\Http\Client\ClientInterface</deprecated>
         </service>
     </services>

src/Resources/config/services_legacy.xml

@@ -6,14 +6,14 @@
 
 use Http\Adapter\Guzzle7\Client;
 use Http\Client\HttpAsyncClient;
-use Http\Client\HttpClient;
 use Http\Discovery\HttpAsyncClientDiscovery;
-use Http\Discovery\HttpClientDiscovery;
+use Http\Discovery\Psr18ClientDiscovery;
 use Http\Discovery\Strategy\CommonClassesStrategy;
 use Http\Discovery\Strategy\CommonPsr17ClassesStrategy;
 use Http\HttplugBundle\Collector\ProfileClient;
 use Http\HttplugBundle\Discovery\ConfiguredClientsStrategyListener;
 use Nyholm\NSA;
+use Psr\Http\Client\ClientInterface;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 
 class DiscoveredClientsTest extends WebTestCase
@@ -26,7 +26,7 @@ public function testDiscoveredClient(): void
 
         $service = $container->get('httplug.auto_discovery.auto_discovered_client');
 
-        $this->assertInstanceOf(HttpClient::class, $service);
+        $this->assertInstanceOf(ClientInterface::class, $service);
     }
 
     public function testDiscoveredAsyncClient(): void
@@ -49,7 +49,7 @@ public function testDiscoveredClientWithProfilingEnabled(): void
         $service = $container->get('httplug.auto_discovery.auto_discovered_client');
 
         $this->assertInstanceOf(ProfileClient::class, $service);
-        $this->assertInstanceOf(HttpClient::class, NSA::getProperty($service, 'client'));
+        $this->assertInstanceOf(ClientInterface::class, NSA::getProperty($service, 'client'));
     }
 
     public function testDiscoveredAsyncClientWithProfilingEnabled(): void
@@ -81,7 +81,7 @@ public function testDiscovery(): void
         $httpAsyncClient = $container->get('httplug.auto_discovery.auto_discovered_async');
 
         $this->assertInstanceOf(ProfileClient::class, $httpClient);
-        $this->assertSame(HttpClientDiscovery::find(), $httpClient);
+        $this->assertSame(Psr18ClientDiscovery::find(), $httpClient);
         $this->assertInstanceOf(ProfileClient::class, $httpAsyncClient);
         $this->assertSame(HttpAsyncClientDiscovery::find(), $httpAsyncClient);
     }
@@ -115,7 +115,7 @@ public function testForcedDiscovery(): void
 
         $container->get('httplug.strategy');
 
-        $this->assertEquals($container->get('httplug.client.acme'), HttpClientDiscovery::find());
+        $this->assertEquals($container->get('httplug.client.acme'), Psr18ClientDiscovery::find());
         $this->assertEquals($container->get('httplug.client.acme'), HttpAsyncClientDiscovery::find());
     }
 
@@ -132,7 +132,7 @@ protected function setUp(): void
 
         // Reset values
         $strategy = new ConfiguredClientsStrategyListener(null, null);
-        HttpClientDiscovery::setStrategies([CommonClassesStrategy::class, CommonPsr17ClassesStrategy::class]);
+        Psr18ClientDiscovery::setStrategies([CommonClassesStrategy::class, CommonPsr17ClassesStrategy::class]);
         $strategy->onEvent();
     }
 }