Fix deprecations triggered by Symfony 5.3

Author: derrabus

src/EventListener/EventForwardCompatibilityTrait.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\EventListener;
+
+use Symfony\Component\HttpKernel\Event\KernelEvent;
+
+/**
+ * Provides forward compatibility with newer Symfony versions.
+ *
+ * @internal
+ */
+trait EventForwardCompatibilityTrait
+{
+    private function isMainRequest(KernelEvent $event): bool
+    {
+        return method_exists($event, 'isMainRequest')
+            ? $event->isMainRequest()
+            : $event->isMasterRequest()
+        ;
+    }
+}

src/EventListener/RequestListener.php

@@ -17,6 +17,8 @@
  */
 final class RequestListener
 {
+    use EventForwardCompatibilityTrait;
+
     /**
      * @var HubInterface The current hub
      */
@@ -47,7 +49,7 @@ public function __construct(HubInterface $hub, ?TokenStorageInterface $tokenStor
      */
     public function handleKernelRequestEvent(RequestListenerRequestEvent $event): void
     {
-        if (!$event->isMasterRequest()) {
+        if (!$this->isMainRequest($event)) {
             return;
         }
 
@@ -81,7 +83,7 @@ public function handleKernelRequestEvent(RequestListenerRequestEvent $event): vo
      */
     public function handleKernelControllerEvent(RequestListenerControllerEvent $event): void
     {
-        if (!$event->isMasterRequest()) {
+        if (!$this->isMainRequest($event)) {
             return;
         }
 

src/EventListener/SubRequestListener.php

@@ -13,6 +13,8 @@
  */
 final class SubRequestListener
 {
+    use EventForwardCompatibilityTrait;
+
     /**
      * @var HubInterface The current hub
      */
@@ -36,7 +38,7 @@ public function __construct(HubInterface $hub)
      */
     public function handleKernelRequestEvent(SubRequestListenerRequestEvent $event): void
     {
-        if ($event->isMasterRequest()) {
+        if ($this->isMainRequest($event)) {
             return;
         }
 
@@ -51,7 +53,7 @@ public function handleKernelRequestEvent(SubRequestListenerRequestEvent $event):
      */
     public function handleKernelFinishRequestEvent(FinishRequestEvent $event): void
     {
-        if ($event->isMasterRequest()) {
+        if ($this->isMainRequest($event)) {
             return;
         }
 

src/EventListener/TracingRequestListener.php

@@ -16,6 +16,8 @@
  */
 final class TracingRequestListener extends AbstractTracingRequestListener
 {
+    use EventForwardCompatibilityTrait;
+
     /**
      * This method is called for each subrequest handled by the framework and
      * starts a new {@see Transaction}.
@@ -24,7 +26,7 @@ final class TracingRequestListener extends AbstractTracingRequestListener
      */
     public function handleKernelRequestEvent(RequestListenerRequestEvent $event): void
     {
-        if (!$event->isMasterRequest()) {
+        if (!$this->isMainRequest($event)) {
             return;
         }
 

src/EventListener/TracingSubRequestListener.php

@@ -14,6 +14,8 @@
  */
 final class TracingSubRequestListener extends AbstractTracingRequestListener
 {
+    use EventForwardCompatibilityTrait;
+
     /**
      * This method is called for each subrequest handled by the framework and
      * traces each by starting a new {@see Span}.
@@ -22,7 +24,7 @@ final class TracingSubRequestListener extends AbstractTracingRequestListener
      */
     public function handleKernelRequestEvent(SubRequestListenerRequestEvent $event): void
     {
-        if ($event->isMasterRequest()) {
+        if ($this->isMainRequest($event)) {
             return;
         }
 
@@ -53,7 +55,7 @@ public function handleKernelRequestEvent(SubRequestListenerRequestEvent $event):
      */
     public function handleKernelFinishRequestEvent(FinishRequestEvent $event): void
     {
-        if ($event->isMasterRequest()) {
+        if ($this->isMainRequest($event)) {
             return;
         }
 

tests/EventListener/RequestListenerTest.php

@@ -222,6 +222,11 @@ public function getSalt()
                         }
 
                         public function getUsername()
+                        {
+                            return $this->getUserIdentifier();
+                        }
+
+                        public function getUserIdentifier(): string
                         {
                             return 'foo_user';
                         }
@@ -412,6 +417,11 @@ public function getSalt()
                         }
 
                         public function getUsername()
+                        {
+                            return $this->getUserIdentifier();
+                        }
+
+                        public function getUserIdentifier(): string
                         {
                             return 'foo_user';
                         }

tests/EventListener/SubRequestListenerTest.php

@@ -6,6 +6,7 @@
 
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Sentry\SentryBundle\EventListener\EventForwardCompatibilityTrait;
 use Sentry\SentryBundle\EventListener\SubRequestListener;
 use Sentry\State\HubInterface;
 use Sentry\State\Scope;
@@ -18,6 +19,8 @@
 
 class SubRequestListenerTest extends TestCase
 {
+    use EventForwardCompatibilityTrait;
+
     /**
      * @var MockObject&HubInterface
      */
@@ -42,7 +45,7 @@ protected function setUp(): void
      */
     public function testHandleKernelRequestEvent($event): void
     {
-        $this->hub->expects($event->isMasterRequest() ? $this->never() : $this->once())
+        $this->hub->expects($this->isMainRequest($event) ? $this->never() : $this->once())
             ->method('pushScope')
             ->willReturn(new Scope());
 
@@ -92,7 +95,7 @@ public function handleKernelRequestEventWithSymfonyVersionLowerThan43DataProvide
      */
     public function testHandleKernelFinishRequestEvent($event): void
     {
-        $this->hub->expects($event->isMasterRequest() ? $this->never() : $this->once())
+        $this->hub->expects($this->isMainRequest($event) ? $this->never() : $this->once())
             ->method('popScope');
 
         $this->listener->handleKernelFinishRequestEvent($event);