vendor/symfony/messenger/DataCollector/MessengerDataCollector.php line 35

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Messenger\DataCollector;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\Response;
  16. use Symfony\Component\HttpKernel\DataCollector\DataCollector;
  17. use Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface;
  18. use Symfony\Component\Messenger\TraceableMessageBus;
  19. use Symfony\Component\VarDumper\Caster\ClassStub;
  21. /**
  22.  * @author Samuel Roze <samuel.roze@gmail.com>
  23.  *
  24.  * @final
  25.  */
  26. class MessengerDataCollector extends DataCollector implements LateDataCollectorInterface
  27. {
  28.     private array $traceableBuses = [];
  30.     public function registerBus(string $name, TraceableMessageBus $bus)
  31.     {
  32.         $this->traceableBuses[$name] = $bus;
  33.     }
  35.     public function collect(Request $request, Response $response, \Throwable $exception = null)
  36.     {
  37.         // Noop. Everything is collected live by the traceable buses & cloned as late as possible.
  38.     }
  40.     public function lateCollect()
  41.     {
  42.         $this->data = ['messages' => [], 'buses' => array_keys($this->traceableBuses)];
  44.         $messages = [];
  45.         foreach ($this->traceableBuses as $busName => $bus) {
  46.             foreach ($bus->getDispatchedMessages() as $message) {
  47.                 $debugRepresentation = $this->cloneVar($this->collectMessage($busName, $message));
  48.                 $messages[] = [$debugRepresentation, $message['callTime']];
  49.             }
  50.         }
  52.         // Order by call time
  53.         usort($messages, function ($a, $b) { return $a[1] <=> $b[1]; });
  55.         // Keep the messages clones only
  56.         $this->data['messages'] = array_column($messages, 0);
  57.     }
  59.     public function getName(): string
  60.     {
  61.         return 'messenger';
  62.     }
  64.     public function reset()
  65.     {
  66.         $this->data = [];
  67.         foreach ($this->traceableBuses as $traceableBus) {
  68.             $traceableBus->reset();
  69.         }
  70.     }
  72.     protected function getCasters(): array
  73.     {
  74.         $casters = parent::getCasters();
  76.         // Unset the default caster truncating collectors data.
  77.         unset($casters['*']);
  79.         return $casters;
  80.     }
  82.     private function collectMessage(string $busName, array $tracedMessage)
  83.     {
  84.         $message = $tracedMessage['message'];
  86.         $debugRepresentation = [
  87.             'bus' => $busName,
  88.             'stamps' => $tracedMessage['stamps'] ?? null,
  89.             'stamps_after_dispatch' => $tracedMessage['stamps_after_dispatch'] ?? null,
  90.             'message' => [
  91.                 'type' => new ClassStub($message::class),
  92.                 'value' => $message,
  93.             ],
  94.             'caller' => $tracedMessage['caller'],
  95.         ];
  97.         if (isset($tracedMessage['exception'])) {
  98.             $exception = $tracedMessage['exception'];
  100.             $debugRepresentation['exception'] = [
  101.                 'type' => $exception::class,
  102.                 'value' => $exception,
  103.             ];
  104.         }
  106.         return $debugRepresentation;
  107.     }
  109.     public function getExceptionsCount(string $bus = null): int
  110.     {
  111.         $count = 0;
  112.         foreach ($this->getMessages($bus) as $message) {
  113.             $count += (int) isset($message['exception']);
  114.         }
  116.         return $count;
  117.     }
  119.     public function getMessages(string $bus = null): array
  120.     {
  121.         if (null === $bus) {
  122.             return $this->data['messages'];
  123.         }
  125.         return array_filter($this->data['messages'], function ($message) use ($bus) {
  126.             return $bus === $message['bus'];
  127.         });
  128.     }
  130.     public function getBuses(): array
  131.     {
  132.         return $this->data['buses'];
  133.     }
  134. }