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

fabpot · fabpot · commit 54a70d740fba · 2025-04-27T15:18:59.000+02:00
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
diff --git a/DependencyInjection/MessengerPass.php b/DependencyInjection/MessengerPass.php
@@ -337,7 +337,7 @@ private function registerBusToCollector(ContainerBuilder $container, string $bus
     {
         $container->setDefinition(
             $tracedBusId = 'debug.traced.'.$busId,
-            (new Definition(TraceableMessageBus::class, [new Reference($tracedBusId.'.inner')]))->setDecoratedService($busId)
+            (new Definition(TraceableMessageBus::class, [new Reference($tracedBusId.'.inner'), new Reference('profiler.is_disabled_state_checker', ContainerBuilder::IGNORE_ON_INVALID_REFERENCE)]))->setDecoratedService($busId)
         );
 
         $container->getDefinition('data_collector.messenger')->addMethodCall('registerBus', [$busId, new Reference($tracedBusId)]);
diff --git a/TraceableMessageBus.php b/TraceableMessageBus.php
@@ -20,11 +20,16 @@ class TraceableMessageBus implements MessageBusInterface
 
     public function __construct(
         private MessageBusInterface $decoratedBus,
+        protected readonly ?\Closure $disabled = null,
     ) {
     }
 
     public function dispatch(object $message, array $stamps = []): Envelope
     {
+        if ($this->disabled?->__invoke()) {
+            return $this->decoratedBus->dispatch($message, $stamps);
+        }
+
         $envelope = Envelope::wrap($message, $stamps);
         $context = [
             'stamps' => array_merge([], ...array_values($envelope->all())),

Original file line number	Diff line number	Diff line change
`@@ -337,7 +337,7 @@ private function registerBusToCollector(ContainerBuilder $container, string $bus`
`337`	`337`	`{`
`338`	`338`	`$container->setDefinition(`
`339`	`339`	`$tracedBusId = 'debug.traced.'.$busId,`
`340`		`- (new Definition(TraceableMessageBus::class, [new Reference($tracedBusId.'.inner')]))->setDecoratedService($busId)`
	`340`	`+ (new Definition(TraceableMessageBus::class, [new Reference($tracedBusId.'.inner'), new Reference('profiler.is_disabled_state_checker', ContainerBuilder::IGNORE_ON_INVALID_REFERENCE)]))->setDecoratedService($busId)`
`341`	`341`	`);`
`342`	`342`
`343`	`343`	`$container->getDefinition('data_collector.messenger')->addMethodCall('registerBus', [$busId, new Reference($tracedBusId)]);`