[HttpClient] Added TraceableHttpClient and WebProfiler panel

Co-authored-by: Jérémy Romey <jeremy@free-agent.fr>
Co-authored-by: Timothée Barray <tim@amicalement-web.net>

Author: 2 people

DependencyInjection/Compiler/UnusedTagsPass.php

@@ -35,6 +35,7 @@ class UnusedTagsPass implements CompilerPassInterface
         'form.type',
         'form.type_extension',
         'form.type_guesser',
+        'http_client.client',
         'kernel.cache_clearer',
         'kernel.cache_warmer',
         'kernel.event_listener',

DependencyInjection/FrameworkExtension.php

@@ -150,6 +150,7 @@ class FrameworkExtension extends Extension
     private $validatorConfigEnabled = false;
     private $messengerConfigEnabled = false;
     private $mailerConfigEnabled = false;
+    private $httpClientConfigEnabled = false;
 
     /**
      * Responds to the app.config configuration parameter.
@@ -311,6 +312,10 @@ public function load(array $configs, ContainerBuilder $container)
             $container->removeDefinition('console.command.messenger_failed_messages_remove');
         }
 
+        if ($this->httpClientConfigEnabled = $this->isConfigEnabled($container, $config['http_client'])) {
+            $this->registerHttpClientConfiguration($config['http_client'], $container, $loader, $config['profiler']);
+        }
+
         $propertyInfoEnabled = $this->isConfigEnabled($container, $config['property_info']);
         $this->registerValidationConfiguration($config['validation'], $container, $loader, $propertyInfoEnabled);
         $this->registerEsiConfiguration($config['esi'], $container, $loader);
@@ -341,10 +346,6 @@ public function load(array $configs, ContainerBuilder $container)
             $this->registerLockConfiguration($config['lock'], $container, $loader);
         }
 
-        if ($this->isConfigEnabled($container, $config['http_client'])) {
-            $this->registerHttpClientConfiguration($config['http_client'], $container, $loader);
-        }
-
         if ($this->mailerConfigEnabled = $this->isConfigEnabled($container, $config['mailer'])) {
             $this->registerMailerConfiguration($config['mailer'], $container, $loader);
         }
@@ -562,6 +563,10 @@ private function registerProfilerConfiguration(array $config, ContainerBuilder $
             $loader->load('mailer_debug.xml');
         }
 
+        if ($this->httpClientConfigEnabled) {
+            $loader->load('http_client_debug.xml');
+        }
+
         $container->setParameter('profiler_listener.only_exceptions', $config['only_exceptions']);
         $container->setParameter('profiler_listener.only_master_requests', $config['only_master_requests']);
 
@@ -1915,7 +1920,7 @@ private function registerCacheConfiguration(array $config, ContainerBuilder $con
         }
     }
 
-    private function registerHttpClientConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader)
+    private function registerHttpClientConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader, array $profilerConfig)
     {
         $loader->load('http_client.xml');
 
@@ -1930,6 +1935,8 @@ private function registerHttpClientConfiguration(array $config, ContainerBuilder
             $container->removeDefinition(HttpClient::class);
         }
 
+        $httpClientId = $this->isConfigEnabled($container, $profilerConfig) ? '.debug.http_client.inner' : 'http_client';
+
         foreach ($config['scoped_clients'] as $name => $scopeConfig) {
             if ('http_client' === $name) {
                 throw new InvalidArgumentException(sprintf('Invalid scope name: "%s" is reserved.', $name));
@@ -1941,10 +1948,14 @@ private function registerHttpClientConfiguration(array $config, ContainerBuilder
             if (null === $scope) {
                 $container->register($name, ScopingHttpClient::class)
                     ->setFactory([ScopingHttpClient::class, 'forBaseUri'])
-                    ->setArguments([new Reference('http_client'), $scopeConfig['base_uri'], $scopeConfig]);
+                    ->setArguments([new Reference($httpClientId), $scopeConfig['base_uri'], $scopeConfig])
+                    ->addTag('http_client.client')
+                ;
             } else {
                 $container->register($name, ScopingHttpClient::class)
-                    ->setArguments([new Reference('http_client'), [$scope => $scopeConfig], $scope]);
+                    ->setArguments([new Reference($httpClientId), [$scope => $scopeConfig], $scope])
+                    ->addTag('http_client.client')
+                ;
             }
 
             $container->registerAliasForArgument($name, HttpClientInterface::class);

FrameworkBundle.php

@@ -36,6 +36,7 @@
 use Symfony\Component\ErrorRenderer\DependencyInjection\ErrorRendererPass;
 use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass;
 use Symfony\Component\Form\DependencyInjection\FormPass;
+use Symfony\Component\HttpClient\DependencyInjection\HttpClientPass;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\HttpKernel\DependencyInjection\ControllerArgumentValueResolverPass;
@@ -129,6 +130,7 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new TestServiceContainerRealRefPass(), PassConfig::TYPE_AFTER_REMOVING);
         $this->addCompilerPassIfExists($container, AddMimeTypeGuesserPass::class);
         $this->addCompilerPassIfExists($container, MessengerPass::class);
+        $this->addCompilerPassIfExists($container, HttpClientPass::class);
         $this->addCompilerPassIfExists($container, AddAutoMappingConfigurationPass::class);
         $container->addCompilerPass(new RegisterReverseContainerPass(true));
         $container->addCompilerPass(new RegisterReverseContainerPass(false), PassConfig::TYPE_AFTER_REMOVING);

Resources/config/http_client.xml

@@ -7,6 +7,7 @@
     <services>
         <service id="http_client" class="Symfony\Contracts\HttpClient\HttpClientInterface">
             <tag name="monolog.logger" channel="http_client" />
+            <tag name="http_client.client" />
             <factory class="Symfony\Component\HttpClient\HttpClient" method="create" />
             <argument type="collection" /> <!-- default options -->
             <argument /> <!-- max host connections -->

Resources/config/http_client_debug.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service id="data_collector.http_client" class="Symfony\Component\HttpClient\DataCollector\HttpClientDataCollector">
+            <tag name="data_collector" template="@WebProfiler/Collector/http_client.html.twig" id="http_client" priority="250" />
+        </service>
+    </services>
+</container>

composer.json

@@ -40,7 +40,7 @@
         "symfony/polyfill-intl-icu": "~1.0",
         "symfony/form": "^4.3.4|^5.0",
         "symfony/expression-language": "^3.4|^4.0|^5.0",
-        "symfony/http-client": "^4.3|^5.0",
+        "symfony/http-client": "^4.4|^5.0",
         "symfony/lock": "^4.4|^5.0",
         "symfony/mailer": "^4.4|^5.0",
         "symfony/messenger": "^4.3|^5.0",
@@ -71,6 +71,7 @@
         "symfony/console": "<4.3",
         "symfony/dotenv": "<4.2",
         "symfony/dom-crawler": "<4.3",
+        "symfony/http-client": "<4.4",
         "symfony/form": "<4.3",
         "symfony/lock": "<4.4",
         "symfony/mailer": "<4.4",