Enable pagination per resource (#3035)

Author: alanpoulain

CHANGELOG.md

@@ -6,6 +6,7 @@
 * GraphQL: Add support for custom queries and mutations
 * GraphQL: Add support for custom types
 * GraphQL: Better pagination support (backwards pagination)
+* GraphQL: Support the pagination per resource
 * GraphQL: Add the concept of *stages* in the workflow of the resolvers and add the possibility to disable them with operation attributes
 * GraphQL: Add GraphQL Playground besides GraphiQL and add the possibility to change the default IDE (or to disable it) for the GraphQL endpoint
 * GraphQL: Add a command to print the schema in SDL

features/graphql/collection.feature

@@ -482,6 +482,26 @@ Feature: GraphQL collection support
     And the header "Content-Type" should be equal to "application/json"
     And the JSON node "data.dummies.edges" should have 0 element
 
+  @createSchema
+  Scenario: Retrieve a collection with pagination disabled
+    Given there are 4 foo objects with fake names
+    When I send the following GraphQL request:
+    """
+    {
+      foos {
+        id
+        name
+        bar
+      }
+    }
+    """
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/json"
+    And the JSON node "data.foos[3].id" should be equal to "/foos/4"
+    And the JSON node "data.foos[3].name" should be equal to "Separativeness"
+    And the JSON node "data.foos[3].bar" should be equal to "Sit"
+
   Scenario: Custom collection query
     Given there are 2 dummyCustomQuery objects
     When I send the following GraphQL request:

src/Bridge/Doctrine/MongoDbOdm/Extension/PaginationExtension.php

@@ -52,6 +52,10 @@ public function applyToCollection(Builder $aggregationBuilder, string $resourceC
             return;
         }
 
+        if (($context['graphql_operation_name'] ?? false) && !$this->pagination->isGraphQlEnabled($resourceClass, $operationName, $context)) {
+            return;
+        }
+
         $context = $this->addCountToContext(clone $aggregationBuilder, $context);
 
         [, $offset, $limit] = $this->pagination->getPagination($resourceClass, $operationName, $context);
@@ -90,6 +94,10 @@ public function applyToCollection(Builder $aggregationBuilder, string $resourceC
      */
     public function supportsResult(string $resourceClass, string $operationName = null, array $context = []): bool
     {
+        if ($context['graphql_operation_name'] ?? false) {
+            return $this->pagination->isGraphQlEnabled($resourceClass, $operationName, $context);
+        }
+
         return $this->pagination->isEnabled($resourceClass, $operationName, $context);
     }
 

src/Bridge/Doctrine/Orm/Extension/PaginationExtension.php

@@ -134,6 +134,10 @@ public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGenerator
      */
     public function supportsResult(string $resourceClass, string $operationName = null, array $context = []): bool
     {
+        if ($context['graphql_operation_name'] ?? false) {
+            return $this->pagination->isGraphQlEnabled($resourceClass, $operationName, $context);
+        }
+
         if (null === $this->requestStack) {
             return $this->pagination->isEnabled($resourceClass, $operationName, $context);
         }
@@ -193,6 +197,10 @@ private function getPagination(QueryBuilder $queryBuilder, string $resourceClass
                 return null;
             }
 
+            if (($context['graphql_operation_name'] ?? false) && !$this->pagination->isGraphQlEnabled($resourceClass, $operationName, $context)) {
+                return null;
+            }
+
             $context = $this->addCountToContext($queryBuilder, $context);
 
             return \array_slice($this->pagination->getPagination($resourceClass, $operationName, $context), 1);

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -378,6 +378,7 @@ private function registerGraphQlConfiguration(ContainerBuilder $container, array
         }
 
         $container->setParameter('api_platform.graphql.default_ide', $config['graphql']['default_ide']);
+        $container->setParameter('api_platform.graphql.collection.pagination', $config['graphql']['collection']['pagination']);
 
         $loader->load('graphql.xml');
 

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -239,6 +239,14 @@ private function addGraphQlSection(ArrayNodeDefinition $rootNode): void
                         ->arrayNode('graphql_playground')
                             ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
                         ->end()
+                        ->arrayNode('collection')
+                            ->addDefaultsIfNotSet()
+                            ->children()
+                                ->arrayNode('pagination')
+                                    ->canBeDisabled()
+                                ->end()
+                            ->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end();

src/Bridge/Symfony/Bundle/Resources/config/data_provider.xml

@@ -30,6 +30,7 @@
         <service id="api_platform.pagination" class="ApiPlatform\Core\DataProvider\Pagination">
             <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
             <argument>%api_platform.collection.pagination%</argument>
+            <argument>%api_platform.graphql.collection.pagination%</argument>
         </service>
     </services>
 

src/Bridge/Symfony/Bundle/Resources/config/graphql.xml

@@ -64,7 +64,7 @@
             <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
             <argument type="service" id="serializer" />
             <argument type="service" id="api_platform.graphql.serializer.context_builder" />
-            <argument>%api_platform.collection.pagination.enabled%</argument>
+            <argument type="service" id="api_platform.pagination" />
         </service>
 
         <service id="api_platform.graphql.resolver.stage.deserialize" class="ApiPlatform\Core\GraphQl\Resolver\Stage\DeserializeStage" public="false">
@@ -135,7 +135,7 @@
             <argument type="service" id="api_platform.graphql.resolver.factory.collection" />
             <argument type="service" id="api_platform.graphql.resolver.factory.item_mutation" />
             <argument type="service" id="api_platform.filter_locator" />
-            <argument>%api_platform.collection.pagination.enabled%</argument>
+            <argument type="service" id="api_platform.pagination" />
         </service>
 
         <service id="api_platform.graphql.fields_builder_locator" class="Symfony\Component\DependencyInjection\ServiceLocator" public="false">

src/DataProvider/Pagination.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Core\DataProvider;
 
 use ApiPlatform\Core\Exception\InvalidArgumentException;
+use ApiPlatform\Core\Exception\ResourceClassNotFoundException;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 
 /**
@@ -24,9 +25,10 @@
 final class Pagination
 {
     private $options;
+    private $graphQlOptions;
     private $resourceMetadataFactory;
 
-    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, array $options = [])
+    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, array $options = [], array $graphQlOptions = [])
     {
         $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->options = array_merge([
@@ -43,6 +45,9 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa
             'client_partial' => false,
             'partial_parameter_name' => 'partial',
         ], $options);
+        $this->graphQlOptions = array_merge([
+            'enabled' => true,
+        ], $graphQlOptions);
     }
 
     /**
@@ -171,6 +176,14 @@ public function isEnabled(string $resourceClass = null, string $operationName =
         return $this->getEnabled($context, $resourceClass, $operationName);
     }
 
+    /**
+     * Is the pagination enabled for GraphQL?
+     */
+    public function isGraphQlEnabled(?string $resourceClass = null, ?string $operationName = null, array $context = []): bool
+    {
+        return $this->getGraphQlEnabled($resourceClass, $operationName);
+    }
+
     /**
      * Is the partial pagination enabled?
      */
@@ -198,6 +211,23 @@ private function getEnabled(array $context, string $resourceClass = null, string
             return filter_var($this->getParameterFromContext($context, $this->options[$partial ? 'partial_parameter_name' : 'enabled_parameter_name'], $enabled), FILTER_VALIDATE_BOOLEAN);
         }
 
+        return (bool) $enabled;
+    }
+
+    private function getGraphQlEnabled(?string $resourceClass, ?string $operationName): bool
+    {
+        $enabled = $this->graphQlOptions['enabled'];
+
+        if (null !== $resourceClass) {
+            try {
+                $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
+            } catch (ResourceClassNotFoundException $e) {
+                return $enabled;
+            }
+
+            return (bool) $resourceMetadata->getGraphqlAttribute($operationName, 'pagination_enabled', $enabled, true);
+        }
+
         return $enabled;
     }
 

src/GraphQl/Resolver/Factory/ItemResolverFactory.php

@@ -79,7 +79,7 @@ public function __invoke(?string $resourceClass = null, ?string $rootClass = nul
             if (null !== $queryResolverId) {
                 /** @var QueryItemResolverInterface $queryResolver */
                 $queryResolver = $this->queryResolverLocator->get($queryResolverId);
-                $item = $queryResolver($item, ['source' => $source, 'args' => $args, 'info' => $info]);
+                $item = $queryResolver($item, $resolverContext);
                 $resourceClass = $this->getResourceClass($item, $resourceClass, $info, sprintf('Custom query resolver "%s"', $queryResolverId).' has to return an item of class %s but returned an item of class %s.');
             }