minor #60243 [Cache][EventDispatcher][HttpClient][HttpKernel][Messenger][Validator][Workflow] Don't enable tracing unless the profiler is enabled (nicolas-grekas)

This PR was merged into the 7.3 branch.

Discussion
----------

[Cache][EventDispatcher][HttpClient][HttpKernel][Messenger][Validator][Workflow] Don't enable tracing unless the profiler is enabled

| Q             | A
| ------------- | ---
| Branch?       | 7.3
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Issues        | symfony/symfony#60037
| License       | MIT

This PR ensures traceable decorators are enabled only if the profiler is also enabled.

The way it works is by adding a new argument to all traceable decorators: `?\Closure $disabled`. When a closure is given and when the closure returns true, tracing should be skipped. Calling the closure should be done before every decorated method to cope for dynamically enabled/disabled states.

Then, this argument is wired using dependency injection so that a closure is passed that returns the current state of the profiler. If the profiler is not instantiated yet (eg because we're on the CLI, or because we're before ProfilerListener enabled it), then a default state is used (disabled on the CLI, enabled on the web). This allows collecting data on the web even if the profiler didn't start yet (as happens when a request comes in, before ProfilerListener is triggered).

Note that I didn't change all `Traceable*` decorators: the remaining ones look inoffensive to me. Of course, this could be wrong and fixed in follow up PRs.

Commits
-------

d5a3769bd05 Don't enable tracing unless the profiler is enabled

Author: fabpot

DependencyInjection/HttpClientPass.php

@@ -27,7 +27,7 @@ public function process(ContainerBuilder $container): void
 
         foreach ($container->findTaggedServiceIds('http_client.client') as $id => $tags) {
             $container->register('.debug.'.$id, TraceableHttpClient::class)
-                ->setArguments([new Reference('.debug.'.$id.'.inner'), new Reference('debug.stopwatch', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)])
+                ->setArguments([new Reference('.debug.'.$id.'.inner'), new Reference('debug.stopwatch', ContainerInterface::IGNORE_ON_INVALID_REFERENCE), new Reference('profiler.is_disabled_state_checker', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)])
                 ->addTag('kernel.reset', ['method' => 'reset'])
                 ->setDecoratedService($id, null, 5);
             $container->getDefinition('data_collector.http_client')

Response/TraceableResponse.php

@@ -34,7 +34,7 @@ class TraceableResponse implements ResponseInterface, StreamableInterface
     public function __construct(
         private HttpClientInterface $client,
         private ResponseInterface $response,
-        private mixed &$content,
+        private mixed &$content = false,
         private ?StopwatchEvent $event = null,
     ) {
     }

TraceableHttpClient.php

@@ -31,12 +31,17 @@ final class TraceableHttpClient implements HttpClientInterface, ResetInterface,
     public function __construct(
         private HttpClientInterface $client,
         private ?Stopwatch $stopwatch = null,
+        private ?\Closure $disabled = null,
     ) {
         $this->tracedRequests = new \ArrayObject();
     }
 
     public function request(string $method, string $url, array $options = []): ResponseInterface
     {
+        if ($this->disabled?->__invoke()) {
+            return new TraceableResponse($this->client, $this->client->request($method, $url, $options));
+        }
+
         $content = null;
         $traceInfo = [];
         $tracedRequest = [