bug symfony#59515 [FrameworkBundle] Fix wiring ConsoleProfilerListener (nicolas-grekas)

This PR was merged into the 6.4 branch.

Discussion
----------

[FrameworkBundle] Fix wiring ConsoleProfilerListener

| Q             | A
| ------------- | ---
| Branch?       | 6.4
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Issues        | -
| License       | MIT

At the moment, when cache:clear is called, the profiler is instantiated, with all its data collectors.
When one of them needs an env var to be constructed, 💥

But this should not happen in the first place: command profiling is an opt-in feature. Nothing related should be instantiated unless asked to do so.

The issue happens because service registration doesn't take care of not using the profiler unless really needed.

This fixes it by:
1. not using the profiler to "disable" it
2. injecting a lazy profiler service so that it's instantiated only when actually required

Commits
-------

45763bd [FrameworkBundle] Fix wiring ConsoleProfilerListener

Author: fabpot

src/Symfony/Bundle/FrameworkBundle/EventListener/ConsoleProfilerListener.php

@@ -38,6 +38,8 @@ final class ConsoleProfilerListener implements EventSubscriberInterface
     /** @var \SplObjectStorage<Request, ?Request> */
     private \SplObjectStorage $parents;
 
+    private bool $disabled = false;
+
     public function __construct(
         private readonly Profiler $profiler,
         private readonly RequestStack $requestStack,
@@ -66,7 +68,7 @@ public function initialize(ConsoleCommandEvent $event): void
 
         $input = $event->getInput();
         if (!$input->hasOption('profile') || !$input->getOption('profile')) {
-            $this->profiler->disable();
+            $this->disabled = true;
 
             return;
         }
@@ -92,7 +94,12 @@ public function catch(ConsoleErrorEvent $event): void
 
     public function profile(ConsoleTerminateEvent $event): void
     {
-        if (!$this->cliMode || !$this->profiler->isEnabled()) {
+        $error = $this->error;
+        $this->error = null;
+
+        if (!$this->cliMode || $this->disabled) {
+            $this->disabled = false;
+
             return;
         }
 
@@ -114,8 +121,7 @@ public function profile(ConsoleTerminateEvent $event): void
         $request->command->exitCode = $event->getExitCode();
         $request->command->interruptedBySignal = $event->getInterruptingSignal();
 
-        $profile = $this->profiler->collect($request, $request->getResponse(), $this->error);
-        $this->error = null;
+        $profile = $this->profiler->collect($request, $request->getResponse(), $error);
         $this->profiles[$request] = $profile;
 
         if ($this->parents[$request] = $this->requestStack->getParentRequest()) {

src/Symfony/Bundle/FrameworkBundle/Resources/config/profiling.php

@@ -40,14 +40,19 @@
 
         ->set('console_profiler_listener', ConsoleProfilerListener::class)
             ->args([
-                service('profiler'),
+                service('.lazy_profiler'),
                 service('.virtual_request_stack'),
                 service('debug.stopwatch'),
                 param('kernel.runtime_mode.cli'),
                 service('router')->nullOnInvalid(),
             ])
             ->tag('kernel.event_subscriber')
 
+        ->set('.lazy_profiler', Profiler::class)
+            ->factory('current')
+            ->args([[service('profiler')]])
+            ->lazy()
+
         ->set('.virtual_request_stack', VirtualRequestStack::class)
             ->args([service('request_stack')])
             ->public()