vendor/sentry/sentry-symfony/src/EventListener/RequestListener.php line 43

  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry\SentryBundle\EventListener;
  7. use Sentry\State\HubInterface;
  8. use Sentry\State\Scope;
  9. use Sentry\UserDataBag;
  10. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  11. use Symfony\Component\HttpKernel\Event\RequestEvent;
  13. /**
  14.  * This listener ensures that a new {@see Scope} is created for
  15.  * each request and that it is filled with useful information, e.g. the IP
  16.  * address of the client.
  17.  */
  18. final class RequestListener
  19. {
  20.     use KernelEventForwardCompatibilityTrait;
  22.     /**
  23.      * @var HubInterface The current hub
  24.      */
  25.     private $hub;
  27.     /**
  28.      * Constructor.
  29.      *
  30.      * @param HubInterface $hub The current hub
  31.      */
  32.     public function __construct(HubInterface $hub/* , ?TokenStorageInterface $tokenStorage */)
  33.     {
  34.         $this->hub = $hub;
  35.     }
  37.     /**
  38.      * This method is called for each request handled by the framework and
  39.      * fills the Sentry scope with information about the current user.
  40.      *
  41.      * @param RequestEvent $event The event
  42.      */
  43.     public function handleKernelRequestEvent(RequestEvent $event): void
  44.     {
  45.         if (!$this->isMainRequest($event)) {
  46.             return;
  47.         }
  49.         $client = $this->hub->getClient();
  51.         if (null === $client || !$client->getOptions()->shouldSendDefaultPii()) {
  52.             return;
  53.         }
  55.         $this->hub->configureScope(static function (Scope $scope) use ($event): void {
  56.             $user = $scope->getUser() ?? new UserDataBag();
  58.             if (null === $user->getIpAddress()) {
  59.                 $user->setIpAddress($event->getRequest()->getClientIp());
  60.             }
  62.             $scope->setUser($user);
  63.         });
  64.     }
  66.     /**
  67.      * This method is called for each request handled by the framework and
  68.      * sets the route on the current Sentry scope.
  69.      *
  70.      * @param ControllerEvent $event The event
  71.      */
  72.     public function handleKernelControllerEvent(ControllerEvent $event): void
  73.     {
  74.         if (!$this->isMainRequest($event)) {
  75.             return;
  76.         }
  78.         $route = $event->getRequest()->attributes->get('_route');
  80.         if (!\is_string($route)) {
  81.             return;
  82.         }
  84.         $this->hub->configureScope(static function (Scope $scope) use ($route): void {
  85.             $scope->setTag('route', $route);
  86.         });
  87.     }
  88. }