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

Open in your IDE?
  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.     /**
  36.      * {@inheritdoc}
  37.      */
  38.     public function handle(Envelope $envelope, StackInterface $stack): Envelope
  39.     {
  40.         $stack = new TraceableStack($stack, $this->stopwatch, $this->busName, $this->eventCategory);
  42.         try {
  43.             return $stack->next()->handle($envelope, $stack);
  44.         } finally {
  45.             $stack->stop();
  46.         }
  47.     }
  48. }
  50. /**
  51.  * @internal
  52.  */
  53. class TraceableStack implements StackInterface
  54. {
  55.     private StackInterface $stack;
  56.     private Stopwatch $stopwatch;
  57.     private string $busName;
  58.     private string $eventCategory;
  59.     private ?string $currentEvent = null;
  61.     public function __construct(StackInterface $stack, Stopwatch $stopwatch, string $busName, string $eventCategory)
  62.     {
  63.         $this->stack = $stack;
  64.         $this->stopwatch = $stopwatch;
  65.         $this->busName = $busName;
  66.         $this->eventCategory = $eventCategory;
  67.     }
  69.     /**
  70.      * {@inheritdoc}
  71.      */
  72.     public function next(): MiddlewareInterface
  73.     {
  74.         if (null !== $this->currentEvent && $this->stopwatch->isStarted($this->currentEvent)) {
  75.             $this->stopwatch->stop($this->currentEvent);
  76.         }
  78.         if ($this->stack === $nextMiddleware = $this->stack->next()) {
  79.             $this->currentEvent = 'Tail';
  80.         } else {
  81.             $this->currentEvent = sprintf('"%s"', get_debug_type($nextMiddleware));
  82.         }
  83.         $this->currentEvent .= sprintf(' on "%s"', $this->busName);
  85.         $this->stopwatch->start($this->currentEvent, $this->eventCategory);
  87.         return $nextMiddleware;
  88.     }
  90.     public function stop(): void
  91.     {
  92.         if (null !== $this->currentEvent && $this->stopwatch->isStarted($this->currentEvent)) {
  93.             $this->stopwatch->stop($this->currentEvent);
  94.         }
  95.         $this->currentEvent = null;
  96.     }
  97. }