feature #39276 [FrameworkBundle] Added option to specify the event dispatcher in debug:event-dispatcher (TimoBakx)

derrabus · derrabus · commit 86842ac7fbba · 2020-12-05T20:54:31.000+01:00
This PR was squashed before being merged into the 5.3-dev branch. Discussion ---------- [FrameworkBundle] Added option to specify the event dispatcher in debug:event-dispatcher | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | symfony/symfony-docs#14650 | Tags | #SymfonyHackday ### Description: In the recent security improvements, new event dispatchers were added (one for each firewall). These were not visible in the `debug:event-dispatcher` command. This PR adds an option to define a event dispatcher to show the events (and listeners) for that specific event dispatcher. Without any options, the default dispatcher is shown (identical to previous working) In order to be able to fetch specific event dispatchers, I tagged all event dispatchers with a new `kernel.event-dispatcher` tag. ### Usage: `bin/console debug:event-dispatcher --dispatcher=[servicename] [other options] [event]` ### Subtasks: - [x] Add `dispatcher` option - [x] Add `kernel.event_dispatcher` tag to all event dispatchers - [x] Add autoconfigure tag for services implementing `EventDispatcherInterface` - [x] Update Descriptor classes to specify the chosen dispatcher - [x] Update changelog - [x] Add documentation Commits ------- 62398b5 [FrameworkBundle] Added option to specify the event dispatcher in debug:event-dispatcher
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -5,6 +5,8 @@ CHANGELOG
 -----
 
  * Added support for configuring PHP error level to log levels
+* Added the `dispatcher` option to `debug:event-dispatcher`
+* Added the `event_dispatcher.dispatcher` tag
 
 5.2.0
 -----
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/EventDispatcherDebugCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/EventDispatcherDebugCommand.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Command;
 
+use Psr\Container\ContainerInterface;
 use Symfony\Bundle\FrameworkBundle\Console\Helper\DescriptorHelper;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -29,14 +30,16 @@
  */
 class EventDispatcherDebugCommand extends Command
 {
+    private const DEFAULT_DISPATCHER = 'event_dispatcher';
+
     protected static $defaultName = 'debug:event-dispatcher';
-    private $dispatcher;
+    private $dispatchers;
 
-    public function __construct(EventDispatcherInterface $dispatcher)
+    public function __construct(ContainerInterface $dispatchers)
     {
         parent::__construct();
 
-        $this->dispatcher = $dispatcher;
+        $this->dispatchers = $dispatchers;
     }
 
     /**
@@ -47,6 +50,7 @@ protected function configure()
         $this
             ->setDefinition([
                 new InputArgument('event', InputArgument::OPTIONAL, 'An event name or a part of the event name'),
+                new InputOption('dispatcher', null, InputOption::VALUE_REQUIRED, 'To view events of a specific event dispatcher', self::DEFAULT_DISPATCHER),
                 new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format  (txt, xml, json, or md)', 'txt'),
                 new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw description'),
             ])
@@ -74,12 +78,21 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $io = new SymfonyStyle($input, $output);
 
         $options = [];
+        $dispatcherServiceName = $input->getOption('dispatcher');
+        if (!$this->dispatchers->has($dispatcherServiceName)) {
+            $io->getErrorStyle()->error(sprintf('Event dispatcher "%s" is not available.', $dispatcherServiceName));
+
+            return 1;
+        }
+
+        $dispatcher = $this->dispatchers->get($dispatcherServiceName);
+
         if ($event = $input->getArgument('event')) {
-            if ($this->dispatcher->hasListeners($event)) {
+            if ($dispatcher->hasListeners($event)) {
                 $options = ['event' => $event];
             } else {
                 // if there is no direct match, try find partial matches
-                $events = $this->searchForEvent($this->dispatcher, $event);
+                $events = $this->searchForEvent($dispatcher, $event);
                 if (0 === \count($events)) {
                     $io->getErrorStyle()->warning(sprintf('The event "%s" does not have any registered listeners.', $event));
 
@@ -93,10 +106,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         $helper = new DescriptorHelper();
+
+        if (self::DEFAULT_DISPATCHER !== $dispatcherServiceName) {
+            $options['dispatcher_service_name'] = $dispatcherServiceName;
+        }
+
         $options['format'] = $input->getOption('format');
         $options['raw_text'] = $input->getOption('raw');
         $options['output'] = $io;
-        $helper->describe($io, $this->dispatcher, $options);
+        $helper->describe($io, $dispatcher, $options);
 
         return 0;
     }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php
@@ -287,8 +287,14 @@ protected function describeContainerEnvVars(array $envs, array $options = [])
     protected function describeEventDispatcherListeners(EventDispatcherInterface $eventDispatcher, array $options = [])
     {
         $event = \array_key_exists('event', $options) ? $options['event'] : null;
+        $dispatcherServiceName = $options['dispatcher_service_name'] ?? null;
 
         $title = 'Registered listeners';
+
+        if (null !== $dispatcherServiceName) {
+            $title .= sprintf(' of event dispatcher "%s"', $dispatcherServiceName);
+        }
+
         if (null !== $event) {
             $title .= sprintf(' for event `%s` ordered by descending priority', $event);
             $registeredListeners = $eventDispatcher->getListeners($event);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php
@@ -474,12 +474,19 @@ protected function describeContainerEnvVars(array $envs, array $options = [])
     protected function describeEventDispatcherListeners(EventDispatcherInterface $eventDispatcher, array $options = [])
     {
         $event = \array_key_exists('event', $options) ? $options['event'] : null;
+        $dispatcherServiceName = $options['dispatcher_service_name'] ?? null;
+
+        $title = 'Registered Listeners';
+
+        if (null !== $dispatcherServiceName) {
+            $title .= sprintf(' of Event Dispatcher "%s"', $dispatcherServiceName);
+        }
 
         if (null !== $event) {
-            $title = sprintf('Registered Listeners for "%s" Event', $event);
+            $title .= sprintf(' for "%s" Event', $event);
             $registeredListeners = $eventDispatcher->getListeners($event);
         } else {
-            $title = 'Registered Listeners Grouped by Event';
+            $title .= ' Grouped by Event';
             // Try to see if "events" exists
             $registeredListeners = \array_key_exists('events', $options) ? array_combine($options['events'], array_map(function ($event) use ($eventDispatcher) { return $eventDispatcher->getListeners($event); }, $options['events'])) : $eventDispatcher->getListeners();
         }
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php
@@ -43,6 +43,7 @@ class UnusedTagsPass implements CompilerPassInterface
         'controller.argument_value_resolver',
         'controller.service_arguments',
         'data_collector',
+        'event_dispatcher.dispatcher',
         'form.type',
         'form.type_extension',
         'form.type_guesser',
@@ -72,9 +73,9 @@ class UnusedTagsPass implements CompilerPassInterface
         'routing.expression_language_provider',
         'routing.loader',
         'routing.route_loader',
+        'security.authenticator.login_linker',
         'security.expression_language_provider',
         'security.remember_me_aware',
-        'security.authenticator.login_linker',
         'security.voter',
         'serializer.encoder',
         'serializer.normalizer',
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -160,6 +160,7 @@
 use Symfony\Contracts\Cache\CacheInterface;
 use Symfony\Contracts\Cache\CallbackInterface;
 use Symfony\Contracts\Cache\TagAwareCacheInterface;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\Service\ResetInterface;
 use Symfony\Contracts\Service\ServiceSubscriberInterface;
@@ -479,6 +480,8 @@ public function load(array $configs, ContainerBuilder $container)
             ->addTag('kernel.cache_clearer');
         $container->registerForAutoconfiguration(CacheWarmerInterface::class)
             ->addTag('kernel.cache_warmer');
+        $container->registerForAutoconfiguration(EventDispatcherInterface::class)
+            ->addTag('event_dispatcher.dispatcher');
         $container->registerForAutoconfiguration(EventSubscriberInterface::class)
             ->addTag('kernel.event_subscriber');
         $container->registerForAutoconfiguration(LocaleAwareInterface::class)
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/console.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/console.php
@@ -129,7 +129,7 @@
 
         ->set('console.command.event_dispatcher_debug', EventDispatcherDebugCommand::class)
             ->args([
-                service('event_dispatcher'),
+                tagged_locator('event_dispatcher.dispatcher'),
             ])
             ->tag('console.command', ['command' => 'debug:event-dispatcher'])
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.php
@@ -65,6 +65,7 @@ class_exists(WorkflowEvents::class) ? WorkflowEvents::ALIASES : []
         ->set('event_dispatcher', EventDispatcher::class)
             ->public()
             ->tag('container.hot_path')
+            ->tag('event_dispatcher.dispatcher')
         ->alias(EventDispatcherInterfaceComponentAlias::class, 'event_dispatcher')
         ->alias(EventDispatcherInterface::class, 'event_dispatcher')
 
diff --git a/src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php b/src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php
@@ -358,7 +358,8 @@ private function createFirewall(ContainerBuilder $container, string $id, array $
 
         // Register Firewall-specific event dispatcher
         $firewallEventDispatcherId = 'security.event_dispatcher.'.$id;
-        $container->register($firewallEventDispatcherId, EventDispatcher::class);
+        $container->register($firewallEventDispatcherId, EventDispatcher::class)
+            ->addTag('event_dispatcher.dispatcher');
 
         // Register listeners
         $listeners = [];
