src/EventSubscriber/Api/CorrelationIdSubscriber.php line 65

Open in your IDE?
  1. <?php
  3. namespace App\EventSubscriber\Api;
  5. use App\Helper\Api\Logging\CorrelationIdService;
  6. use Exception;
  7. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  8. use Symfony\Component\HttpKernel\Event\RequestEvent;
  9. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  10. use Symfony\Component\HttpKernel\KernelEvents;
  12. /**
  13.  * Event subscriber to manage correlation IDs for HTTP requests.
  14.  *
  15.  * Initializes a correlation ID at the start of each request and resets it
  16.  * when the request is complete. Supports propagating correlation IDs from
  17.  * incoming X-Correlation-ID headers.
  18.  *
  19.  * @package API
  20.  * @internal
  21.  */
  22. class CorrelationIdSubscriber implements EventSubscriberInterface
  23. {
  25.     /**
  26.      * Correlation ID service.
  27.      *
  28.      * @var CorrelationIdService
  29.      */
  30.     protected CorrelationIdService $correlationIdService;
  32.     /**
  33.      * Get subscribed events.
  34.      *
  35.      * @return array<string, array<int, string|int>>
  36.      */
  37.     public static function getSubscribedEvents(): array
  38.     {
  39.         return [
  40.             KernelEvents::REQUEST => ['onKernelRequest', 1024],
  41.             KernelEvents::TERMINATE => ['onKernelTerminate', -1024],
  42.         ];
  43.     }
  45.     /**
  46.      * Constructor.
  47.      *
  48.      * @param CorrelationIdService $correlationIdService Correlation ID service
  49.      */
  50.     public function __construct(CorrelationIdService $correlationIdService)
  51.     {
  52.         $this->correlationIdService = $correlationIdService;
  53.     }
  55.     /**
  56.      * Initialize correlation ID on request start.
  57.      *
  58.      * Checks for an existing X-Correlation-ID header and uses it if present,
  59.      * otherwise generates a new correlation ID.
  60.      *
  61.      * @param RequestEvent $event The request event
  62.      * @return void
  63.      * @throws Exception
  64.      */
  65.     public function onKernelRequest(RequestEvent $event): void
  66.     {
  67.         if (!$event->isMainRequest()) {
  68.             return;
  69.         }
  71.         $request = $event->getRequest();
  73.         // Check if correlation ID is provided in request headers
  74.         if ($request->headers->has('X-Correlation-ID')) {
  75.             $correlationId = $request->headers->get('X-Correlation-ID');
  76.             if (!empty($correlationId)) {
  77.                 $this->correlationIdService->setCorrelationId($correlationId);
  79.                 return;
  80.             }
  81.         }
  83.         // Generate a new correlation ID if not provided
  84.         $this->correlationIdService->getCorrelationId();
  85.     }
  87.     /**
  88.      * Reset correlation ID after request is complete.
  89.      *
  90.      * @param TerminateEvent $event The terminate-event
  91.      * @return void
  92.      */
  93.     public function onKernelTerminate(TerminateEvent $event): void
  94.     {
  95.         if (!$event->isMainRequest()) {
  96.             return;
  97.         }
  99.         $this->correlationIdService->reset();
  100.     }
  102. }