vendor/symfony/messenger/Middleware/TraceableMiddleware.php line 40

  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\Middleware;
  14. use Symfony\Component\Messenger\Envelope;
  15. use Symfony\Component\Stopwatch\Stopwatch;
  17. /**
  18.  * Collects some data about a middleware.
  19.  *
  20.  * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
  21.  */
  22. class TraceableMiddleware implements MiddlewareInterface
  23. {
  24.     private Stopwatch $stopwatch;
  25.     private string $busName;
  26.     private string $eventCategory;
  28.     public function __construct(Stopwatch $stopwatch, string $busName, string $eventCategory = 'messenger.middleware')
  29.     {
  30.         $this->stopwatch = $stopwatch;
  31.         $this->busName = $busName;
  32.         $this->eventCategory = $eventCategory;
  33.     }
  35.     public function handle(Envelope $envelope, StackInterface $stack): Envelope
  36.     {
  37.         $stack = new TraceableStack($stack, $this->stopwatch, $this->busName, $this->eventCategory);
  39.         try {
  40.             return $stack->next()->handle($envelope, $stack);
  41.         } finally {
  42.             $stack->stop();
  43.         }
  44.     }
  45. }
  47. /**
  48.  * @internal
  49.  */
  50. class TraceableStack implements StackInterface
  51. {
  52.     private StackInterface $stack;
  53.     private Stopwatch $stopwatch;
  54.     private string $busName;
  55.     private string $eventCategory;
  56.     private ?string $currentEvent = null;
  58.     public function __construct(StackInterface $stack, Stopwatch $stopwatch, string $busName, string $eventCategory)
  59.     {
  60.         $this->stack = $stack;
  61.         $this->stopwatch = $stopwatch;
  62.         $this->busName = $busName;
  63.         $this->eventCategory = $eventCategory;
  64.     }
  66.     public function next(): MiddlewareInterface
  67.     {
  68.         if (null !== $this->currentEvent && $this->stopwatch->isStarted($this->currentEvent)) {
  69.             $this->stopwatch->stop($this->currentEvent);
  70.         }
  72.         if ($this->stack === $nextMiddleware = $this->stack->next()) {
  73.             $this->currentEvent = 'Tail';
  74.         } else {
  75.             $this->currentEvent = sprintf('"%s"', get_debug_type($nextMiddleware));
  76.         }
  77.         $this->currentEvent .= sprintf(' on "%s"', $this->busName);
  79.         $this->stopwatch->start($this->currentEvent, $this->eventCategory);
  81.         return $nextMiddleware;
  82.     }
  84.     public function stop(): void
  85.     {
  86.         if (null !== $this->currentEvent && $this->stopwatch->isStarted($this->currentEvent)) {
  87.             $this->stopwatch->stop($this->currentEvent);
  88.         }
  89.         $this->currentEvent = null;
  90.     }
  91. }