feat(sf6): compatibility with sf6 and php8 (#9)

lpinsembert · Louis Pinsembert · MilletMorgan · web-flow · commit 10dd19527e67 · 2022-08-18T14:12:55.000+02:00
* feat(sf6): update to sf6 and php8

* feat(review): added missing var declarations

* fix(composer): change php and sf version

* feat(gha): add strategy for version in workflows

* fix(composer): change version of var-dumper

Co-authored-by: Louis Pinsembert &lt;lpinsembert.external@bedrockstreaming.com&gt;
Co-authored-by: Millet Morgan &lt;millet.morgan5@gmail.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -5,10 +5,14 @@ jobs:
     ci:
         name: Tests & Quality
         runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                version: [ '8.0', '8.1' ]
+            fail-fast: false
         steps:
             - uses: actions/checkout@master
             - uses: shivammathur/setup-php@v2
               with:
-                  php-version: 7.4
+                  php-version: ${{ matrix.version }}
             - run: make install
             - run: make ci
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,4 @@
 /bin/
 composer.lock
 .phpunit.result.cache
-.php_cs.cache
+.php-cs-fixer.cache
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
diff --git a/composer.json b/composer.json
@@ -16,22 +16,22 @@
         "sort-packages": true
     },
     "require": {
-        "php": "7.4.*",
+        "php": ">=8.0",
         "ext-json": "*",
         "doctrine/annotations": "^1.10.0",
-        "symfony/config": "4.4.*|^5.0",
-        "symfony/dependency-injection": "4.4.*|^5.0",
-        "symfony/event-dispatcher": "4.4.*|^5.0",
-        "symfony/http-foundation": "4.4.*|^5.0",
-        "symfony/http-kernel": "4.4.*|^5.0",
-        "symfony/options-resolver": "^5.0"
+        "symfony/config": "^6.0",
+        "symfony/dependency-injection": "^6.0",
+        "symfony/event-dispatcher": "^6.0",
+        "symfony/http-foundation": "^6.0",
+        "symfony/http-kernel": "^6.0",
+        "symfony/options-resolver": "^6.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "9.4.*",
-        "m6web/php-cs-fixer-config": "1.3.*",
-        "phpstan/phpstan": "0.12.*",
-        "phpstan/phpstan-phpunit": "0.12.*",
-        "symfony/var-dumper": "4.4.*"
+        "phpunit/phpunit": "9.5.*",
+        "m6web/php-cs-fixer-config": "^2.1",
+        "phpstan/phpstan": "^1.5",
+        "phpstan/phpstan-phpunit": "^1.1",
+        "symfony/var-dumper": "^6.0"
     },
     "suggest": {
         "webonyx/graphql-php": "Needed to support @GraphQLRateLimit annotation"
diff --git a/src/EventListener/AddRateLimitHeadersListener.php b/src/EventListener/AddRateLimitHeadersListener.php
@@ -23,7 +23,7 @@ public function onKernelResponse(ResponseEvent $event): void
             return;
         }
 
-        if (!$event->isMasterRequest()) {
+        if (!$event->isMainRequest()) {
             return;
         }
 
diff --git a/src/EventListener/LimitRateListener.php b/src/EventListener/LimitRateListener.php
@@ -25,7 +25,7 @@ public function __construct(RateLimitStorageInterface $storage, bool $displayHea
 
     public function onKernelController(ControllerArgumentsEvent $event): void
     {
-        if (!$event->isMasterRequest()) {
+        if (!$event->isMainRequest()) {
             return;
         }
 
diff --git a/src/EventListener/ReadGraphQLRateLmitAnnotationListener.php b/src/EventListener/ReadGraphQLRateLmitAnnotationListener.php
@@ -29,7 +29,7 @@ public function __construct(ContainerInterface $container, Reader $annotationRea
     {
         foreach ($rateLimitModifiers as $rateLimitModifier) {
             if (!($rateLimitModifier instanceof RateLimitModifierInterface)) {
-                throw new \InvalidArgumentException(('$rateLimitModifiers must be instance of '.RateLimitModifierInterface::class));
+                throw new \InvalidArgumentException('$rateLimitModifiers must be instance of '.RateLimitModifierInterface::class);
             }
         }
 
diff --git a/src/EventListener/ReadRateLimitAnnotationListener.php b/src/EventListener/ReadRateLimitAnnotationListener.php
@@ -29,7 +29,7 @@ public function __construct(ContainerInterface $container, Reader $annotationRea
     {
         foreach ($rateLimitModifiers as $rateLimitModifier) {
             if (!($rateLimitModifier instanceof RateLimitModifierInterface)) {
-                throw new \InvalidArgumentException(('$rateLimitModifiers must be instance of '.RateLimitModifierInterface::class));
+                throw new \InvalidArgumentException('$rateLimitModifiers must be instance of '.RateLimitModifierInterface::class);
             }
         }
 
@@ -78,7 +78,9 @@ public function onKernelController(ControllerEvent $event): void
                 $annotation->getPeriod() ?? $this->period
             );
 
-            $rateLimit->varyHashOn('_route', $request->attributes->get('_route'));
+            /** @var string $route */
+            $route = $request->attributes->get('_route');
+            $rateLimit->varyHashOn('_route', $route);
         }
 
         foreach ($this->rateLimitModifiers as $hashKeyVarier) {
diff --git a/src/EventListener/ReadRateLimitConfigurationListener.php b/src/EventListener/ReadRateLimitConfigurationListener.php
@@ -26,7 +26,7 @@ public function __construct(iterable $rateLimitModifiers, int $limit, int $perio
     {
         foreach ($rateLimitModifiers as $rateLimitModifier) {
             if (!($rateLimitModifier instanceof RateLimitModifierInterface)) {
-                throw new \InvalidArgumentException(('$rateLimitModifiers must be instance of '.RateLimitModifierInterface::class));
+                throw new \InvalidArgumentException('$rateLimitModifiers must be instance of '.RateLimitModifierInterface::class);
             }
         }
 
diff --git a/src/RateLimitBundle.php b/src/RateLimitBundle.php
@@ -9,7 +9,7 @@
 
 class RateLimitBundle extends Bundle
 {
-    public function getContainerExtension()
+    public function getContainerExtension(): BedrockRateLimitExtension
     {
         return new BedrockRateLimitExtension();
     }
diff --git a/src/RateLimitModifier/RequestAttributeRateLimitModifier.php b/src/RateLimitModifier/RequestAttributeRateLimitModifier.php
@@ -21,6 +21,8 @@ public function support(Request $request): bool
 
     public function modifyRateLimit(Request $request, RateLimit $rateLimit): void
     {
-        $rateLimit->varyHashOn($this->attributeName, $request->attributes->get($this->attributeName));
+        /** @var string $route */
+        $route = $request->attributes->get($this->attributeName);
+        $rateLimit->varyHashOn($this->attributeName, $route);
     }
 }
diff --git a/tests/EventListener/LimitRateListenerTest.php b/tests/EventListener/LimitRateListenerTest.php
@@ -38,6 +38,7 @@ public function testItDoesNotCheckRateLimitIfItIsNotInRequest(): void
     public function testItStoresRateLimitIfNoneIsStored(): void
     {
         $event = $this->createEventWithRateLimitInRequest();
+        /** @var RateLimit $rateLimit */
         $rateLimit = $event->getRequest()->attributes->get('_rate_limit');
 
         $this->storage->expects($this->once())
@@ -58,6 +59,7 @@ public function testItStoresRateLimitIfNoneIsStored(): void
     public function testItResetsAndStoresNewRateLimitIfCurrentOneIsOutdated(): void
     {
         $event = $this->createEventWithRateLimitInRequest();
+        /** @var RateLimit $rateLimit */
         $rateLimit = $event->getRequest()->attributes->get('_rate_limit');
 
         $this->storage->expects($this->once())
@@ -80,6 +82,7 @@ public function testItResetsAndStoresNewRateLimitIfCurrentOneIsOutdated(): void
     public function testItDecreasesLimitIfRateLimitIsValid(): void
     {
         $event = $this->createEventWithRateLimitInRequest();
+        /** @var RateLimit $rateLimit */
         $rateLimit = $event->getRequest()->attributes->get('_rate_limit');
 
         $this->storage->expects($this->once())
@@ -103,6 +106,7 @@ public function testItDecreasesLimitIfRateLimitIsValid(): void
     public function testItSetsABlockingResponseIfLimitIsReached(): void
     {
         $event = $this->createEventWithRateLimitInRequest();
+        /** @var RateLimit $rateLimit */
         $rateLimit = $event->getRequest()->attributes->get('_rate_limit');
 
         $this->storage
@@ -133,6 +137,7 @@ public function testItSetsABlockingResponseIfLimitIsReached(): void
     public function testItSetsABlockingResponseIfLimitIsExceeded(): void
     {
         $event = $this->createEventWithRateLimitInRequest();
+        /** @var RateLimit $rateLimit */
         $rateLimit = $event->getRequest()->attributes->get('_rate_limit');
 
         $this->storage->expects($this->once())->method('getStoredRateLimit')->willReturn(
diff --git a/tests/EventListener/LimitRateListenerWithManuallyResetableRateLimitStorageInterfaceTest.php b/tests/EventListener/LimitRateListenerWithManuallyResetableRateLimitStorageInterfaceTest.php
@@ -5,6 +5,7 @@
 namespace Bedrock\Bundle\RateLimitBundle\Tests\EventListener;
 
 use Bedrock\Bundle\RateLimitBundle\EventListener\LimitRateListener;
+use Bedrock\Bundle\RateLimitBundle\Model\RateLimit;
 use Bedrock\Bundle\RateLimitBundle\Model\StoredRateLimit;
 use Bedrock\Bundle\RateLimitBundle\Storage\ManuallyResetableRateLimitStorageInterface;
 
@@ -25,6 +26,7 @@ public function setUp(): void
     public function testItResetsAndStoresNewRateLimitIfCurrentOneIsOutdated(): void
     {
         $event = $this->createEventWithRateLimitInRequest();
+        /** @var RateLimit $rateLimit */
         $rateLimit = $event->getRequest()->attributes->get('_rate_limit');
 
         $this->storage->expects($this->once())

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public function onKernelResponse(ResponseEvent $event): void`
`23`	`23`	`return;`
`24`	`24`	`}`
`25`	`25`
`26`		`- if (!$event->isMasterRequest()) {`
	`26`	`+ if (!$event->isMainRequest()) {`
`27`	`27`	`return;`
`28`	`28`	`}`
`29`	`29`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public function __construct(RateLimitStorageInterface $storage, bool $displayHea`
`25`	`25`
`26`	`26`	`public function onKernelController(ControllerArgumentsEvent $event): void`
`27`	`27`	`{`
`28`		`- if (!$event->isMasterRequest()) {`
	`28`	`+ if (!$event->isMainRequest()) {`
`29`	`29`	`return;`
`30`	`30`	`}`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public function __construct(ContainerInterface $container, Reader $annotationRea`
`29`	`29`	`{`
`30`	`30`	`foreach ($rateLimitModifiers as $rateLimitModifier) {`
`31`	`31`	`if (!($rateLimitModifier instanceof RateLimitModifierInterface)) {`
`32`		`- throw new \InvalidArgumentException(('$rateLimitModifiers must be instance of '.RateLimitModifierInterface::class));`
	`32`	`+ throw new \InvalidArgumentException('$rateLimitModifiers must be instance of '.RateLimitModifierInterface::class);`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public function __construct(iterable $rateLimitModifiers, int $limit, int $perio`
`26`	`26`	`{`
`27`	`27`	`foreach ($rateLimitModifiers as $rateLimitModifier) {`
`28`	`28`	`if (!($rateLimitModifier instanceof RateLimitModifierInterface)) {`
`29`		`- throw new \InvalidArgumentException(('$rateLimitModifiers must be instance of '.RateLimitModifierInterface::class));`
	`29`	`+ throw new \InvalidArgumentException('$rateLimitModifiers must be instance of '.RateLimitModifierInterface::class);`
`30`	`30`	`}`
`31`	`31`	`}`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`class RateLimitBundle extends Bundle`
`11`	`11`	`{`
`12`		`- public function getContainerExtension()`
	`12`	`+ public function getContainerExtension(): BedrockRateLimitExtension`
`13`	`13`	`{`
`14`	`14`	`return new BedrockRateLimitExtension();`
`15`	`15`	`}`