Upgrade request handling to Symfony 5

frankbv · Dec 1, 2021 · 70d2add · 70d2add
1 parent 4aa8564
commit 70d2add
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 14 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -21,8 +21,8 @@ class Configuration implements ConfigurationInterface
      */
     public function getConfigTreeBuilder()
     {
-        $treeBuilder = new TreeBuilder();
-        $rootNode = $treeBuilder->root('vipx_bot_detect');
+        $treeBuilder = new TreeBuilder('vipx_bot_detect');
+        $rootNode = $treeBuilder->getRootNode();
 
         $rootNode->children()
             ->scalarNode('metadata_file')->defaultValue('basic_bot.yml')->end()

diff --git a/Security/BotAuthenticationListener.php b/Security/BotAuthenticationListener.php
@@ -11,7 +11,7 @@
 
 namespace Vipx\BotDetectBundle\Security;
 
-use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Symfony\Component\Security\Core\Authentication\Token\AnonymousToken;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
@@ -39,9 +39,9 @@ public function __construct(TokenStorageInterface $tokenStorage, BotDetectorInte
     /**
      * Listens to the kernel.request events and sets a bot token if the visitor is a spider or crawler
      *
-     * @param GetResponseEvent $event
+     * @param ResponseEvent $event
      */
-    public function onKernelRequest(GetResponseEvent $event)
+    public function onKernelRequest(ResponseEvent $event)
     {
         if (HttpKernelInterface::MASTER_REQUEST !== $event->getRequestType()) {
             return;

diff --git a/Security/BotToken.php b/Security/BotToken.php
@@ -52,7 +52,7 @@ public function getMetadata()
      */
     public static function fromAnonymousToken(MetadataInterface $metadata, AnonymousToken $token)
     {
-        return new self($token->getSecret(), $metadata, $token->getRoles());
+        return new self($token->getSecret(), $metadata, $token->getRoleNames());
     }
 
 }
diff --git a/Tests/Security/BotAuthenticationListenerTest.php b/Tests/Security/BotAuthenticationListenerTest.php
@@ -13,13 +13,14 @@
 
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\Security\Core\Authentication\Token\AnonymousToken;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Vipx\BotDetect\BotDetectorInterface;
 use Vipx\BotDetect\Metadata\MetadataInterface;
 use Vipx\BotDetectBundle\Security\BotAuthenticationListener;
-use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Vipx\BotDetectBundle\Security\BotToken;
@@ -61,7 +62,12 @@ public function testSettingToken()
 
         /** @var HttpKernelInterface $kernel */
         $kernel = $this->getMockBuilder(HttpKernelInterface::class)->getMock();
-        $event = new GetResponseEvent($kernel, new Request(), HttpKernelInterface::MASTER_REQUEST);
+        $event = new ResponseEvent(
+            $kernel,
+            new Request(),
+            HttpKernelInterface::MASTER_REQUEST,
+            new Response()
+        );
 
         $listener->onKernelRequest($event);
     }

diff --git a/Tests/Security/BotTokenTest.php b/Tests/Security/BotTokenTest.php
@@ -14,7 +14,6 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Security\Core\Authentication\Token\AnonymousToken;
-use Symfony\Component\Security\Core\Role\Role;
 use Vipx\BotDetect\Metadata\MetadataInterface;
 use Vipx\BotDetectBundle\Security\BotToken;
 
@@ -29,13 +28,12 @@ public function testBotRole()
 
         $this->assertEquals($metadata, $token->getMetadata());
 
-        /** @var Role[] $roles */
-        $roles = $token->getRoles();
+        $roles = $token->getRoleNames();
 
         $contains = false;
 
         foreach ($roles as $role) {
-            if ('ROLE_BOT' === $role->getRole()) {
+            if ('ROLE_BOT' === $role) {
                 $contains = true;
             }
         }
@@ -54,7 +52,7 @@ public function testCanCreateBotTokenFromAnonymousToken()
             ->getMock();
 
         $anonymousToken->method('getSecret')->willReturn('theSecretKey');
-        $anonymousToken->method('getRoles')->willReturn([]);
+        $anonymousToken->method('getRoleNames')->willReturn([]);
 
         $botToken = BotToken::fromAnonymousToken($metadata, $anonymousToken);
 

diff --git a/composer.json b/composer.json
@@ -15,7 +15,8 @@
         "php": "^5.6|^7.0",
         "symfony/framework-bundle": "^2.8|^3.0|^4.0||^5.0",
         "symfony/security-bundle": "^2.8|^3.0|^4.0||^5.0",
-        "vipx/bot-detect": "~2.0"
+        "vipx/bot-detect": "~2.0",
+        "symfony/runtime": "^5.4"
     },
     "require-dev": {
         "phpunit/phpunit": "^5.7|^6.5",