Merge pull request #3291 from alanpoulain/merge-2.5

Merge 2.5
api-platform · Nov 30, 2019 · 5fa9b56 · 5fa9b56
2 parents f56f21d + 6179699
commit 5fa9b56
Show file tree

Hide file tree

Showing 14 changed files with 35 additions and 48 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -183,8 +183,6 @@ executors:
         type: string
     docker:
       - image: circleci/php:<< parameters.php_version >>-node
-        environment:
-          SYMFONY_REQUIRE: ^3.4 || ^4.0 || ^5.0
 
 jobs:
   php-cs-fixer:

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,7 +11,6 @@ env:
   EXT_MONGODB_VERSION: '1.6.0'
   EXT_PCOV_VERSION: '1.0.6'
   LEGACY: '0'
-  SYMFONY_REQUIRE: ^3.4 || ^4.0 || ^5.0
 
 jobs:
   phpunit:

diff --git a/.travis.yml b/.travis.yml
@@ -1,9 +1,5 @@
 language: php
 
-env:
-  global:
-    - SYMFONY_REQUIRE='^3.4 || ^4.0 || ^5.0'
-
 cache:
   directories:
     - $HOME/.composer/cache

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,12 @@
 * MongoDB: Possibility to add execute options (aggregate command fields) for a resource, like `allowDiskUse` (#3144)
 * GraphQL: Allow to format GraphQL errors based on exceptions (#3063)
 * GraphQL: Add page-based pagination (#3175)
-* OpenAPI: Add PHP default values to the documentation (#2386) 
+* OpenAPI: Add PHP default values to the documentation (#2386)
+
+## 2.5.3
+
+* Compatibility with Symfony 5
+* GraphQL: Fix `hasNextPage` when `offset > itemsPerPage`
 
 ## 2.5.2
 

diff --git a/composer.json b/composer.json
@@ -51,9 +51,9 @@
         "phpdocumentor/type-resolver": "^0.3 || ^0.4",
         "phpspec/prophecy": "^1.8",
         "phpstan/extension-installer": "^1.0",
-        "phpstan/phpstan": "^0.11.10",
         "phpstan/phpstan-doctrine": "^0.11.5",
         "phpstan/phpstan-phpunit": "^0.11.2",
+        "phpstan/phpstan-shim": "^0.11.10",
         "phpstan/phpstan-symfony": "^0.11.6",
         "phpunit/phpunit": "^7.5.2 || ^8.0",
         "psr/log": "^1.0",
@@ -128,6 +128,9 @@
     "extra": {
         "branch-alias": {
             "dev-master": "2.6.x-dev"
+        },
+        "symfony": {
+            "require": "^3.4 || ^4.0 || ^5.0"
         }
     }
 }
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -107,28 +107,14 @@ parameters:
 		- '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Filter\\(AbstractFilter|FilterInterface)::apply\(\) invoked with 5 parameters, 3-4 required\.#'
 		- '#Method ApiPlatform\\Core\\PathResolver\\OperationPathResolverInterface::resolveOperationPath\(\) invoked with 4 parameters, 3 required\.#'
 
-		# Expected, due to forward compatibility
-		-
-			message: '#Class Symfony\\Component\\ErrorHandler\\ErrorRenderer\\ErrorRendererInterface not found\.#'
-			path: %currentWorkingDirectory%/tests/Fixtures/app/AppKernel.php
-		- '#Class Symfony\\Component\\ErrorHandler\\Exception\\FlattenException not found\.#'
-		-
-			message: '#Class Symfony\\Component\\HttpKernel\\EventListener\\ErrorListener not found\.#'
-			path: %currentWorkingDirectory%/src/EventListener/ExceptionListener.php
-		-
-			message: '#Instantiated class Symfony\\Component\\HttpKernel\\EventListener\\ErrorListener not found\.#'
-			path: %currentWorkingDirectory%/src/EventListener/ExceptionListener.php
+		# Expected, due to backward compatibility
 		-
-			message: '#Parameter \$exception of method ApiPlatform\\Core\\Action\\ExceptionAction::__invoke\(\) has invalid typehint type Symfony\\Component\\ErrorHandler\\Exception\\FlattenException\.#'
-			path: %currentWorkingDirectory%/src/Action/ExceptionAction.php
-		- '#Call to method get(Class|Headers|StatusCode)\(\) on an unknown class Symfony\\Component\\ErrorHandler\\Exception\\FlattenException\.#'
+			message: "#Call to function method_exists\\(\\) with ApiPlatform\\\\Core\\\\JsonApi\\\\Serializer\\\\ItemNormalizer and 'setCircularReferenc…' will always evaluate to false\\.#"
+			path: %currentWorkingDirectory%/tests/JsonApi/Serializer/ItemNormalizerTest.php
+
+		# Expected, due to forward compatibility
 		-
 			message: "#Call to function method_exists\\(\\) with 'Symfony\\\\\\\\Component.+' and 'getThrowable' will always evaluate to false\\.#"
 			paths:
 				- %currentWorkingDirectory%/tests/Bridge/Symfony/Validator/EventListener/ValidationExceptionListenerTest.php
 				- %currentWorkingDirectory%/tests/EventListener/ExceptionListenerTest.php
-		-
-			message: '#Instanceof between bool\|float\|int|null and ArrayObject will always evaluate to false\.#'
-			paths:
-				- %currentWorkingDirectory%/src/JsonApi/Serializer/ItemNormalizer.php
-				- %currentWorkingDirectory%/src/Serializer/AbstractItemNormalizer.php
diff --git a/src/Bridge/Symfony/Bundle/Resources/config/api.xml b/src/Bridge/Symfony/Bundle/Resources/config/api.xml
@@ -214,6 +214,8 @@
         <service id="api_platform.listener.exception" class="ApiPlatform\Core\EventListener\ExceptionListener">
             <argument>api_platform.action.exception</argument>
             <argument type="service" id="logger" on-invalid="null" />
+            <argument>false</argument>
+            <argument type="service" id="exception_listener" on-invalid="null" />
 
             <tag name="kernel.event_listener" event="kernel.exception" method="onKernelException" priority="-96" />
             <tag name="monolog.logger" channel="request" />

diff --git a/src/EventListener/ExceptionListener.php b/src/EventListener/ExceptionListener.php
@@ -17,7 +17,7 @@
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 use Symfony\Component\HttpKernel\EventListener\ErrorListener;
-use Symfony\Component\HttpKernel\EventListener\ExceptionListener as BaseExceptionListener;
+use Symfony\Component\HttpKernel\EventListener\ExceptionListener as LegacyExceptionListener;
 
 /**
  * Handles requests errors.
@@ -29,13 +29,9 @@ final class ExceptionListener
 {
     private $exceptionListener;
 
-    public function __construct($controller, LoggerInterface $logger = null, $debug = false)
+    public function __construct($controller, LoggerInterface $logger = null, $debug = false, ErrorListener $errorListener = null)
     {
-        if (class_exists(ErrorListener::class)) {
-            $this->exceptionListener = new ErrorListener($controller, $logger, $debug);
-        } else {
-            $this->exceptionListener = new BaseExceptionListener($controller, $logger, $debug);
-        }
+        $this->exceptionListener = $errorListener ? new ErrorListener($controller, $logger, $debug) : new LegacyExceptionListener($controller, $logger, $debug);
     }
 
     public function onKernelException(ExceptionEvent $event): void

diff --git a/src/GraphQl/Resolver/Stage/SerializeStage.php b/src/GraphQl/Resolver/Stage/SerializeStage.php
@@ -149,7 +149,8 @@ private function serializeCursorBasedPaginatedCollection(iterable $collection, a
             $data['pageInfo']['startCursor'] = base64_encode((string) $offset);
             $end = $offset + $nbPageItems - 1;
             $data['pageInfo']['endCursor'] = base64_encode((string) ($end >= 0 ? $end : 0));
-            $data['pageInfo']['hasNextPage'] = (float) $offset + $collection->getItemsPerPage() * $collection->getCurrentPage() < $totalItems;
+            $itemsPerPage = $collection->getItemsPerPage();
+            $data['pageInfo']['hasNextPage'] = (float) ($itemsPerPage > 0 ? $offset % $itemsPerPage : $offset) + $itemsPerPage * $collection->getCurrentPage() < $totalItems;
             $data['pageInfo']['hasPreviousPage'] = $offset > 0;
         }
 

diff --git a/src/Serializer/AbstractItemNormalizer.php b/src/Serializer/AbstractItemNormalizer.php
@@ -68,7 +68,7 @@ public function __construct(PropertyNameCollectionFactoryInterface $propertyName
                 return $this->iriConverter->getIriFromItem($object);
             };
         }
-        if (!interface_exists(AdvancedNameConverterInterface::class)) {
+        if (!interface_exists(AdvancedNameConverterInterface::class) && method_exists($this, 'setCircularReferenceHandler')) {
             $this->setCircularReferenceHandler($defaultContext['circular_reference_handler']);
         }
 

diff --git a/tests/EventListener/ExceptionListenerTest.php b/tests/EventListener/ExceptionListenerTest.php
@@ -19,6 +19,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
+use Symfony\Component\HttpKernel\EventListener\ErrorListener;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 
 /**
@@ -44,7 +45,7 @@ public function testOnKernelException(Request $request)
         $eventProphecy->getKernel()->willReturn($kernel);
         $eventProphecy->setResponse(Argument::type(Response::class))->shouldBeCalled();
 
-        $listener = new ExceptionListener('foo:bar');
+        $listener = new ExceptionListener('foo:bar', null, false, class_exists(ErrorListener::class) ? $this->prophesize(ErrorListener::class)->reveal() : null);
         $listener->onKernelException($eventProphecy->reveal());
     }
 
@@ -62,7 +63,7 @@ public function testDoNothingWhenNotAnApiCall()
         $eventProphecy->getRequest()->willReturn(new Request());
         $eventProphecy->setResponse(Argument::type(Response::class))->shouldNotBeCalled();
 
-        $listener = new ExceptionListener('foo:bar');
+        $listener = new ExceptionListener('foo:bar', null, false, class_exists(ErrorListener::class) ? $this->prophesize(ErrorListener::class)->reveal() : null);
         $listener->onKernelException($eventProphecy->reveal());
     }
 
@@ -75,7 +76,7 @@ public function testDoNothingWhenHtmlRequested()
         $eventProphecy->getRequest()->willReturn($request);
         $eventProphecy->setResponse(Argument::type(Response::class))->shouldNotBeCalled();
 
-        $listener = new ExceptionListener('foo:bar');
+        $listener = new ExceptionListener('foo:bar', null, false, class_exists(ErrorListener::class) ? $this->prophesize(ErrorListener::class)->reveal() : null);
         $listener->onKernelException($eventProphecy->reveal());
     }
 }
diff --git a/tests/GraphQl/Resolver/Stage/SerializeStageTest.php b/tests/GraphQl/Resolver/Stage/SerializeStageTest.php
@@ -144,7 +144,7 @@ public function applyCollectionWithPaginationProvider(): array
             'paginator' => [new ArrayPaginator([new \stdClass(), new \stdClass(), new \stdClass()], 0, 2), [], ['totalCount' => 3., 'edges' => [['node' => ['normalized_item'], 'cursor' => 'MA=='], ['node' => ['normalized_item'], 'cursor' => 'MQ==']], 'pageInfo' => ['startCursor' => 'MA==', 'endCursor' => 'MQ==', 'hasNextPage' => true, 'hasPreviousPage' => false]]],
             'paginator with after cursor' => [new ArrayPaginator([new \stdClass(), new \stdClass(), new \stdClass()], 1, 2), ['after' => 'MA=='], ['totalCount' => 3., 'edges' => [['node' => ['normalized_item'], 'cursor' => 'MQ=='], ['node' => ['normalized_item'], 'cursor' => 'Mg==']], 'pageInfo' => ['startCursor' => 'MQ==', 'endCursor' => 'Mg==', 'hasNextPage' => false, 'hasPreviousPage' => true]]],
             'paginator with bad after cursor' => [new ArrayPaginator([], 0, 0), ['after' => '-'], null, \UnexpectedValueException::class, 'Cursor - is invalid'],
-            'paginator with before cursor' => [new ArrayPaginator([new \stdClass(), new \stdClass(), new \stdClass()], 1, 1), ['before' => 'Mg=='], ['totalCount' => 3., 'edges' => [['node' => ['normalized_item'], 'cursor' => 'MQ==']], 'pageInfo' => ['startCursor' => 'MQ==', 'endCursor' => 'MQ==', 'hasNextPage' => false, 'hasPreviousPage' => true]]],
+            'paginator with before cursor' => [new ArrayPaginator([new \stdClass(), new \stdClass(), new \stdClass()], 1, 1), ['before' => 'Mg=='], ['totalCount' => 3., 'edges' => [['node' => ['normalized_item'], 'cursor' => 'MQ==']], 'pageInfo' => ['startCursor' => 'MQ==', 'endCursor' => 'MQ==', 'hasNextPage' => true, 'hasPreviousPage' => true]]],
             'paginator with bad before cursor' => [new ArrayPaginator([], 0, 0), ['before' => '-'], null, \UnexpectedValueException::class, 'Cursor - is invalid'],
             'paginator with last' => [new ArrayPaginator([new \stdClass(), new \stdClass(), new \stdClass()], 1, 2), ['last' => 2], ['totalCount' => 3., 'edges' => [['node' => ['normalized_item'], 'cursor' => 'MQ=='], ['node' => ['normalized_item'], 'cursor' => 'Mg==']], 'pageInfo' => ['startCursor' => 'MQ==', 'endCursor' => 'Mg==', 'hasNextPage' => false, 'hasPreviousPage' => true]]],
         ];

diff --git a/tests/JsonApi/Serializer/ItemNormalizerTest.php b/tests/JsonApi/Serializer/ItemNormalizerTest.php
@@ -256,17 +256,17 @@ public function testNormalizeCircularReference()
         $normalizer->setSerializer($this->prophesize(SerializerInterface::class)->reveal());
 
         $circularReferenceLimit = 2;
-        if (interface_exists(AdvancedNameConverterInterface::class)) {
+        if (!interface_exists(AdvancedNameConverterInterface::class) && method_exists($normalizer, 'setCircularReferenceLimit')) {
+            $normalizer->setCircularReferenceLimit($circularReferenceLimit);
+
             $context = [
-                'circular_reference_limit' => $circularReferenceLimit,
-                'circular_reference_limit_counters' => [spl_object_hash($circularReferenceEntity) => 2],
+                'circular_reference_limit' => [spl_object_hash($circularReferenceEntity) => 2],
                 'cache_error' => function () {},
             ];
         } else {
-            $normalizer->setCircularReferenceLimit($circularReferenceLimit);
-
             $context = [
-                'circular_reference_limit' => [spl_object_hash($circularReferenceEntity) => 2],
+                'circular_reference_limit' => $circularReferenceLimit,
+                'circular_reference_limit_counters' => [spl_object_hash($circularReferenceEntity) => 2],
                 'cache_error' => function () {},
             ];
         }

diff --git a/tests/Serializer/AbstractItemNormalizerTest.php b/tests/Serializer/AbstractItemNormalizerTest.php
@@ -181,7 +181,7 @@ public function testNormalize()
         ]);
         $normalizer->setSerializer($serializerProphecy->reveal());
 
-        if (!interface_exists(AdvancedNameConverterInterface::class)) {
+        if (!interface_exists(AdvancedNameConverterInterface::class) && method_exists($normalizer, 'setIgnoredAttributes')) {
             $normalizer->setIgnoredAttributes(['alias']);
         }