fix(graphql): use operation on serializer context builder

Author: soyuka

src/GraphQl/Resolver/Stage/DeserializeStage.php

@@ -44,7 +44,7 @@ public function __invoke($objectToPopulate, string $resourceClass, Operation $op
             return $objectToPopulate;
         }
 
-        $denormalizationContext = $this->serializerContextBuilder->create($resourceClass, $operation->getName(), $context, false);
+        $denormalizationContext = $this->serializerContextBuilder->create($resourceClass, $operation, $context, false);
         if (null !== $objectToPopulate) {
             $denormalizationContext[AbstractNormalizer::OBJECT_TO_POPULATE] = $objectToPopulate;
         }

src/GraphQl/Resolver/Stage/ReadStage.php

@@ -59,7 +59,7 @@ public function __invoke(?string $resourceClass, ?string $rootClass, Operation $
         }
 
         $args = $context['args'];
-        $normalizationContext = $this->serializerContextBuilder->create($resourceClass, $operation->getName(), $context, true);
+        $normalizationContext = $this->serializerContextBuilder->create($resourceClass, $operation, $context, true);
 
         if (!$context['is_collection']) {
             $identifier = $this->getIdentifierFromContext($context);

src/GraphQl/Resolver/Stage/SerializeStage.php

@@ -76,7 +76,7 @@ public function __invoke($itemOrCollection, string $resourceClass, Operation $op
             return null;
         }
 
-        $normalizationContext = $this->serializerContextBuilder->create($resourceClass, $operationName, $context, true);
+        $normalizationContext = $this->serializerContextBuilder->create($resourceClass, $operation, $context, true);
 
         $data = null;
         if (!$isCollection) {

src/GraphQl/Resolver/Stage/WriteStage.php

@@ -42,7 +42,7 @@ public function __invoke($data, string $resourceClass, Operation $operation, arr
             return $data;
         }
 
-        $denormalizationContext = $this->serializerContextBuilder->create($resourceClass, $operation->getName(), $context, false);
+        $denormalizationContext = $this->serializerContextBuilder->create($resourceClass, $operation, $context, false);
 
         return $this->processor->process($data, $operation, [], ['operation' => $operation] + $denormalizationContext);
     }

src/GraphQl/Serializer/SerializerContextBuilder.php

@@ -13,9 +13,7 @@
 
 namespace ApiPlatform\GraphQl\Serializer;
 
-use ApiPlatform\Exception\OperationNotFoundException;
 use ApiPlatform\Metadata\GraphQl\Operation;
-use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use GraphQL\Type\Definition\ResolveInfo;
 use Symfony\Component\Serializer\NameConverter\AdvancedNameConverterInterface;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
@@ -27,45 +25,32 @@
  */
 final class SerializerContextBuilder implements SerializerContextBuilderInterface
 {
-    private $resourceMetadataCollectionFactory;
     private $nameConverter;
 
-    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, ?NameConverterInterface $nameConverter)
+    public function __construct(?NameConverterInterface $nameConverter)
     {
-        $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
         $this->nameConverter = $nameConverter;
     }
 
-    public function create(?string $resourceClass, string $operationName, array $resolverContext, bool $normalization): array
+    public function create(?string $resourceClass, Operation $operation, array $resolverContext, bool $normalization): array
     {
-        $context = ['resource_class' => $resourceClass, 'operation_name' => $operationName, 'graphql_operation_name' => $operationName];
-        $operation = null;
-
-        if ($resourceClass) {
-            $resourceMetadata = $this->resourceMetadataCollectionFactory->create($resourceClass);
-            try {
-                $operation = $resourceMetadata->getOperation($operationName);
-            } catch (OperationNotFoundException $e) {
-                // It's possible that the serialization context may not be tight to an existing operation
-                try {
-                    $context['operation_name'] = $resourceMetadata->getOperation()->getName();
-                } catch (OperationNotFoundException $e) {
-                }
-            }
-        }
+        $context = ['resource_class' => $resourceClass, 'operation_name' => $operation->getName(), 'graphql_operation_name' => $operation->getName()];
 
         if (isset($resolverContext['fields'])) {
             $context['no_resolver_data'] = true;
         }
 
-        if ($operation) {
+        $context['operation'] = $operation;
+        if ($operation->getInput()) {
             $context['input'] = $operation->getInput();
+        }
+        if ($operation->getOutput()) {
             $context['output'] = $operation->getOutput();
-            $context = $normalization ? array_merge($operation->getNormalizationContext() ?? [], $context) : array_merge($operation->getDenormalizationContext() ?? [], $context);
         }
+        $context = $normalization ? array_merge($operation->getNormalizationContext() ?? [], $context) : array_merge($operation->getDenormalizationContext() ?? [], $context);
 
         if ($normalization) {
-            $context['attributes'] = $this->fieldsToAttributes($resourceClass, $operation instanceof Operation ? $operation : null, $resolverContext, $context);
+            $context['attributes'] = $this->fieldsToAttributes($resourceClass, $operation, $resolverContext, $context);
         }
 
         return $context;
@@ -74,7 +59,7 @@ public function create(?string $resourceClass, string $operationName, array $res
     /**
      * Retrieves fields, recursively replaces the "_id" key (the raw id) by "id" (the name of the property expected by the Serializer) and flattens edge and node structures (pagination).
      */
-    private function fieldsToAttributes(?string $resourceClass, ?Operation $operation, array $resolverContext, array $context): array
+    private function fieldsToAttributes(?string $resourceClass, Operation $operation, array $resolverContext, array $context): array
     {
         if (isset($resolverContext['fields'])) {
             $fields = $resolverContext['fields'];
@@ -87,10 +72,6 @@ private function fieldsToAttributes(?string $resourceClass, ?Operation $operatio
         $attributes = $this->replaceIdKeys($fields['edges']['node'] ?? $fields['collection'] ?? $fields, $resourceClass, $context);
 
         if ($resolverContext['is_mutation'] || $resolverContext['is_subscription']) {
-            if (!$operation) {
-                throw new \LogicException('An operation should always exist for a mutation or a subscription.');
-            }
-
             $wrapFieldName = lcfirst($operation->getShortName());
 
             return $attributes[$wrapFieldName] ?? [];

src/GraphQl/Serializer/SerializerContextBuilderInterface.php

@@ -13,12 +13,14 @@
 
 namespace ApiPlatform\GraphQl\Serializer;
 
+use ApiPlatform\Metadata\GraphQl\Operation;
+
 /**
  * Builds the context used by the Symfony Serializer.
  *
  * @author Alan Poulain <[email protected]>
  */
 interface SerializerContextBuilderInterface
 {
-    public function create(string $resourceClass, string $operationName, array $resolverContext, bool $normalization): array;
+    public function create(string $resourceClass, Operation $operation, array $resolverContext, bool $normalization): array;
 }

src/GraphQl/Type/TypeBuilder.php

@@ -115,11 +115,7 @@ public function getResourceObjectType(?string $resourceClass, ResourceMetadataCo
             'resolveField' => $this->defaultFieldResolver,
             'fields' => function () use ($resourceClass, $operation, $operationName, $resourceMetadataCollection, $input, $wrapData, $depth, $ioMetadata) {
                 if ($wrapData) {
-                    try {
-                        $queryNormalizationContext = $operation instanceof Query ? ($resourceMetadataCollection->getOperation($operationName)->getNormalizationContext() ?? []) : [];
-                    } catch (OperationNotFoundException $e) {
-                        $queryNormalizationContext = [];
-                    }
+                    $queryNormalizationContext = $this->getQueryOperation($resourceMetadataCollection)?->getNormalizationContext() ?? [];
 
                     try {
                         $mutationNormalizationContext = $operation instanceof Mutation || $operation instanceof Subscription ? ($resourceMetadataCollection->getOperation($operationName)->getNormalizationContext() ?? []) : [];
@@ -310,4 +306,18 @@ private function getPageBasedPaginationFields(GraphQLType $resourceType): array
             'paginationInfo' => GraphQLType::nonNull($paginationInfoObjectType),
         ];
     }
+
+    private function getQueryOperation(ResourceMetadataCollection $resourceMetadataCollection): ?Operation
+    {
+        foreach ($resourceMetadataCollection as $resourceMetadata) {
+            foreach ($resourceMetadata->getGraphQlOperations() as $operation) {
+                // Filter the custom queries.
+                if ($operation instanceof Query && !$operation->getResolver()) {
+                    return $operation;
+                }
+            }
+        }
+
+        return null;
+    }
 }

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

@@ -56,7 +56,6 @@
         </service>
 
         <service id="api_platform.graphql.serializer.context_builder" class="ApiPlatform\GraphQl\Serializer\SerializerContextBuilder" public="false">
-            <argument type="service" id="api_platform.metadata.resource.metadata_collection_factory" />
             <argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
         </service>
         <service id="ApiPlatform\GraphQl\Serializer\SerializerContextBuilderInterface" alias="api_platform.graphql.serializer.context_builder" />

tests/GraphQl/Resolver/Factory/CollectionResolverFactoryTest.php

@@ -13,13 +13,13 @@
 
 namespace ApiPlatform\Tests\GraphQl\Resolver\Factory;
 
-use ApiPlatform\Core\Tests\ProphecyTrait;
 use ApiPlatform\GraphQl\Resolver\Factory\CollectionResolverFactory;
 use ApiPlatform\GraphQl\Resolver\Stage\ReadStageInterface;
 use ApiPlatform\GraphQl\Resolver\Stage\SecurityPostDenormalizeStageInterface;
 use ApiPlatform\GraphQl\Resolver\Stage\SecurityStageInterface;
 use ApiPlatform\GraphQl\Resolver\Stage\SerializeStageInterface;
 use ApiPlatform\Metadata\GraphQl\QueryCollection;
+use ApiPlatform\Tests\ProphecyTrait;
 use GraphQL\Type\Definition\ResolveInfo;
 use PHPUnit\Framework\TestCase;
 use Psr\Container\ContainerInterface;

tests/GraphQl/Resolver/Factory/ItemMutationResolverFactoryTest.php

@@ -13,7 +13,6 @@
 
 namespace ApiPlatform\Tests\GraphQl\Resolver\Factory;
 
-use ApiPlatform\Core\Tests\ProphecyTrait;
 use ApiPlatform\GraphQl\Resolver\Factory\ItemMutationResolverFactory;
 use ApiPlatform\GraphQl\Resolver\Stage\DeserializeStageInterface;
 use ApiPlatform\GraphQl\Resolver\Stage\ReadStageInterface;
@@ -25,6 +24,7 @@
 use ApiPlatform\GraphQl\Resolver\Stage\WriteStageInterface;
 use ApiPlatform\Metadata\GraphQl\Mutation;
 use ApiPlatform\Tests\Fixtures\TestBundle\Entity\Dummy;
+use ApiPlatform\Tests\ProphecyTrait;
 use GraphQL\Type\Definition\ResolveInfo;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;