Merge pull request #38 from UFOMelkor/feature/data-collector

Automatically register DataCollectorPlugin

Author: codeliner

src/DependencyInjection/ProophServiceBusExtension.php

@@ -83,11 +83,26 @@ private function busLoad(
         foreach (array_keys($config) as $name) {
             $serviceBuses[$name] = 'prooph_service_bus.' . $name;
         }
-        $container->setParameter('prooph_service_bus.' . $type . '_buses', $serviceBuses);
+        $container->setParameter("prooph_service_bus.{$type}_buses", $serviceBuses);
 
         foreach ($config as $name => $options) {
             $this->loadBus($type, $name, $options, $container);
         }
+
+        // Add DataCollector
+        if ($type !== 'query' && $container->getParameter('kernel.debug')) {
+            $container
+                ->setDefinition(
+                    "prooph_service_bus.plugin.data_collector.${type}_bus",
+                    new ChildDefinition('prooph_service_bus.plugin.data_collector')
+                )
+                ->addArgument($type)
+                ->addTag("prooph_service_bus.{$type}_bus.plugin")
+                ->addTag('data_collector', [
+                    'id' => "prooph.{$type}_bus",
+                    'template' => '@ProophServiceBus/Collector/debug_view.html.twig',
+                ]);
+        }
     }
 
     /**

src/Plugin/DataCollectorPlugin.php

@@ -23,41 +23,41 @@ class DataCollectorPlugin extends DataCollector implements Plugin
      */
     protected $listenerHandlers = [];
 
+    /**
+     * @var array
+     */
+    private $buses = [];
+
     /**
      * @var Stopwatch
      */
     private $stopwatch;
 
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
     public function __construct(ContainerInterface $container, string $busType)
     {
         $this->stopwatch = new Stopwatch();
-        $this->data['bus_type'] = $busType;
         $this->container = $container;
+        $this->data['bus_type'] = $busType;
         $this->data['messages'] = [];
         $this->data['duration'] = [];
-        $this->buses = [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function collect(Request $request, Response $response, \Exception $exception = null)
     {
         foreach ($this->buses as $bus) {
             $busName = $bus->busName();
 
-            $reflClass = new \ReflectionClass($bus);
-            $reflProperty = $reflClass->getProperty('events');
-            $reflProperty->setAccessible(true);
-            // todo maybe put as default value in config tree builder to also make it configurable?
-//            $this->data['config'][$busName]['action_event_emitter'] = get_class($reflProperty->getValue($bus));
-            $this->data['config'][$busName] = $this->container->getParameter(sprintf('prooph_service_bus.%s.configuration', $busName));
+            $this->data['config'][$busName] = $this->container->getParameter(
+                sprintf('prooph_service_bus.%s.configuration', $busName)
+            );
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getName(): string
     {
         return sprintf('prooph.%s_bus', $this->data['bus_type']);
@@ -105,9 +105,14 @@ public function attachToMessageBus(MessageBus $messageBus): void
         if ($messageBus instanceof QueryBus) {
             return;
         }
+
         $this->buses[] = $messageBus;
         if (! $messageBus instanceof NamedMessageBus) {
-            throw new RuntimeException(sprinf('To use the Symfony Datacollector, the Bus "%s" needs to implement "%s"', $messageBus, NamedMessageBus::class));
+            throw new RuntimeException(sprinf(
+                'To use the Symfony Datacollector, the Bus "%s" needs to implement "%s"',
+                $messageBus,
+                NamedMessageBus::class
+            ));
         }
 
         $this->listenerHandlers[] = $messageBus->attach(MessageBus::EVENT_DISPATCH, function (ActionEvent $actionEvent) {
@@ -142,11 +147,11 @@ public function attachToMessageBus(MessageBus $messageBus): void
                 $this->data['message_callstack'][$actionEvent->getTarget()->busName()][] = [
                     'id' => $actionEvent->getParam('message')->uuid(),
                     'message' => $actionEvent->getParam('message-name'),
-                    'handler' => \is_object($actionEvent->getParam('message-handler')) ? get_class($actionEvent->getParam('message-handler')) : (string) $actionEvent->getParam('message-handler'),
+                    'handler' => is_object($actionEvent->getParam('message-handler'))
+                        ? get_class($actionEvent->getParam('message-handler'))
+                        : (string) $actionEvent->getParam('message-handler'),
                 ];
             }
-
-            $context = $this->createContextFromActionEvent($actionEvent);
         }, MessageBus::PRIORITY_ROUTE - 50000);
     }
 
@@ -166,7 +171,9 @@ protected function createContextFromActionEvent(ActionEvent $event): array
             'message-data' => $event->getParam('message')->toArray(),
             'message-name' => $event->getParam('message-name'),
             'message-handled' => $event->getParam('message-handled'),
-            'message-handler' => \is_object($event->getParam('message-handler')) ? get_class($event->getParam('message-handler')) : $event->getParam('message-handler'),
+            'message-handler' => is_object($event->getParam('message-handler'))
+                ? get_class($event->getParam('message-handler'))
+                : $event->getParam('message-handler'),
         ];
     }
 

src/Resources/config/service_bus.xml

@@ -16,6 +16,9 @@
         </service>
 
         <service id="prooph_service_bus.plugin.psr_logger" class="Prooph\Bundle\ServiceBus\Plugin\PsrLoggerPlugin" abstract="true" public="false"/>
+        <service id="prooph_service_bus.plugin.data_collector" class="Prooph\Bundle\ServiceBus\Plugin\DataCollectorPlugin" abstract="true" public="false">
+            <argument type="service" id="service_container"/>
+        </service>
 
         <service id="prooph_service_bus.async_switch_message_router" class="Prooph\ServiceBus\Plugin\Router\AsyncSwitchMessageRouter" />
     </services>