[HttpKernel] Collect data from every event dispatcher

MatTheCat · MatTheCat · commit 2e832b7e3dd6 · 2023-01-30T11:48:12.000+01:00
diff --git a/UPGRADE-6.3.md b/UPGRADE-6.3.md
@@ -47,6 +47,7 @@ HttpKernel
 ----------
 
  * Deprecate parameters `container.dumper.inline_factories` and `container.dumper.inline_class_loader`, use `.container.dumper.inline_factories` and `.container.dumper.inline_class_loader` instead
+ * Deprecate passing `null` or an instance of `Symfony\Contracts\EventDispatcher\EventDispatcherInterface` to `Symfony\Component\HttpKernel\DataCollector\EventDataCollector::__construct`, pass an iterable of `Symfony\Contracts\EventDispatcher\EventDispatcherInterface` instead
 
 Messenger
 ---------
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/collectors.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/collectors.php
@@ -47,7 +47,7 @@
 
         ->set('data_collector.events', EventDataCollector::class)
             ->args([
-                service('debug.event_dispatcher')->ignoreOnInvalid(),
+                tagged_iterator('event_dispatcher.dispatcher'),
                 service('request_stack')->ignoreOnInvalid(),
             ])
             ->tag('data_collector', ['template' => '@WebProfiler/Collector/events.html.twig', 'id' => 'events', 'priority' => 290])
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -9,6 +9,7 @@ CHANGELOG
  * Add `#[WithHttpStatus]` for defining status codes for exceptions
  * Use an instance of `Psr\Clock\ClockInterface` to generate the current date time in `DateTimeValueResolver`
  * Add `#[WithLogLevel]` for defining log levels for exceptions
+ * Collect data from every event dispatcher
 
 6.2
 ---
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/EventDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/EventDataCollector.php
@@ -28,13 +28,21 @@
  */
 class EventDataCollector extends DataCollector implements LateDataCollectorInterface
 {
-    private ?EventDispatcherInterface $dispatcher;
+    private EventDispatcherInterface|iterable|null $dispatchers;
     private ?RequestStack $requestStack;
     private ?Request $currentRequest = null;
 
-    public function __construct(EventDispatcherInterface $dispatcher = null, RequestStack $requestStack = null)
+    /**
+     * @param EventDispatcherInterface|iterable<EventDispatcherInterface>|null $dispatchers
+     */
+    public function __construct(EventDispatcherInterface|iterable $dispatchers = null, RequestStack $requestStack = null)
     {
-        $this->dispatcher = $dispatcher;
+        if (!is_iterable($dispatchers)) {
+            trigger_deprecation('symfony/http-kernel', '6.3', 'Passing "null" or a single "%s" to "%s()" is deprecated, pass an "%1$s" iterable instead.', EventDispatcherInterface::class, __METHOD__);
+
+            $dispatchers = $dispatchers ? [$dispatchers] : [];
+        }
+        $this->dispatchers = $dispatchers;
         $this->requestStack = $requestStack;
     }
 
@@ -52,19 +60,26 @@ public function reset()
     {
         $this->data = [];
 
-        if ($this->dispatcher instanceof ResetInterface) {
-            $this->dispatcher->reset();
+        foreach ($this->dispatchers as $dispatcher) {
+            if ($dispatcher instanceof ResetInterface) {
+                $dispatcher->reset();
+            }
         }
     }
 
     public function lateCollect()
     {
-        if ($this->dispatcher instanceof TraceableEventDispatcher) {
-            $this->setCalledListeners($this->dispatcher->getCalledListeners($this->currentRequest));
-            $this->setNotCalledListeners($this->dispatcher->getNotCalledListeners($this->currentRequest));
-            $this->setOrphanedEvents($this->dispatcher->getOrphanedEvents($this->currentRequest));
+        foreach ($this->dispatchers as $dispatcher) {
+            if ($dispatcher instanceof TraceableEventDispatcher) {
+                array_push($this->data['called_listeners'], ...$dispatcher->getCalledListeners($this->currentRequest));
+                array_push($this->data['not_called_listeners'], ...$dispatcher->getNotCalledListeners($this->currentRequest));
+                array_push($this->data['orphaned_events'], ...$dispatcher->getOrphanedEvents($this->currentRequest));
+            }
         }
 
+        usort($this->data['called_listeners'], $this->sortListeners(...));
+        usort($this->data['not_called_listeners'], $this->sortListeners(...));
+
         $this->data = $this->cloneVar($this->data);
     }
 
@@ -122,4 +137,29 @@ public function getName(): string
     {
         return 'events';
     }
+
+    private function sortListeners(array $a, array $b): int
+    {
+        if (0 !== $cmp = strcmp($a['event'], $b['event'])) {
+            return $cmp;
+        }
+
+        if (\is_int($a['priority']) && !\is_int($b['priority'])) {
+            return 1;
+        }
+
+        if (!\is_int($a['priority']) && \is_int($b['priority'])) {
+            return -1;
+        }
+
+        if ($a['priority'] === $b['priority']) {
+            return 0;
+        }
+
+        if ($a['priority'] > $b['priority']) {
+            return -1;
+        }
+
+        return 1;
+    }
 }
