Small changes

Author: alanpoulain

CHANGELOG.md

@@ -9,6 +9,7 @@
 * GraphQL: Add page-based pagination (#3175, #3517)
 * GraphQL: Possibility to add a custom description for queries, mutations and subscriptions (#3477, #3514)
 * GraphQL: Support for field name conversion (serialized name) (#3455, #3516)
+* GraphQL: **BC** `operation` is now `operationName` to follow the standard (#3568)
 * OpenAPI: Add PHP default values to the documentation (#2386)
 * Deprecate using a validation groups generator service not implementing `ApiPlatform\Core\Bridge\Symfony\Validator\ValidationGroupsGeneratorInterface` (#3346)
 
@@ -34,7 +35,6 @@
 * HTTP: Location header is only set on POST with a 201 or between 300 and 400 #3497
 * GraphQL: Do not allow empty cursor values on `before` or `after` #3360
 * Bump versions of Swagger UI, GraphiQL and GraphQL Playground #3510
->>>>>>> 2.5
 
 ## 2.5.4
 

features/bootstrap/GraphqlContext.php

@@ -90,11 +90,11 @@ public function ISendTheGraphqlRequestWithVariables(PyStringNode $variables)
     }
 
     /**
-     * @When I send the GraphQL request with operation :operation
+     * @When I send the GraphQL request with operationName :operationName
      */
-    public function ISendTheGraphqlRequestWithOperation(string $operation)
+    public function ISendTheGraphqlRequestWithOperation(string $operationName)
     {
-        $this->graphqlRequest['operation'] = $operation;
+        $this->graphqlRequest['operationName'] = $operationName;
         $this->sendGraphqlRequest();
     }
 

src/GraphQl/Action/EntrypointAction.php

@@ -69,13 +69,13 @@ public function __invoke(Request $request): Response
                 }
             }
 
-            [$query, $operation, $variables] = $this->parseRequest($request);
+            [$query, $operationName, $variables] = $this->parseRequest($request);
             if (null === $query) {
                 throw new BadRequestHttpException('GraphQL query is not valid.');
             }
 
             $executionResult = $this->executor
-                ->executeQuery($this->schemaBuilder->getSchema(), $query, null, null, $variables, $operation)
+                ->executeQuery($this->schemaBuilder->getSchema(), $query, null, null, $variables, $operationName)
                 ->setErrorFormatter([$this->normalizer, 'normalize']);
         } catch (\Exception $exception) {
             $executionResult = (new ExecutionResult(null, [new Error($exception->getMessage(), null, null, null, null, $exception)]))
@@ -91,34 +91,34 @@ public function __invoke(Request $request): Response
     private function parseRequest(Request $request): array
     {
         $query = $request->query->get('query');
-        $operation = $request->query->get('operationName');
+        $operationName = $request->query->get('operationName');
         if ($variables = $request->query->get('variables', [])) {
             $variables = $this->decodeVariables($variables);
         }
 
         if (!$request->isMethod('POST')) {
-            return [$query, $operation, $variables];
+            return [$query, $operationName, $variables];
         }
 
         if ('json' === $request->getContentType()) {
-            return $this->parseData($query, $operation, $variables, $request->getContent());
+            return $this->parseData($query, $operationName, $variables, $request->getContent());
         }
 
         if ('graphql' === $request->getContentType()) {
             $query = $request->getContent();
         }
 
         if ('multipart' === $request->getContentType()) {
-            return $this->parseMultipartRequest($query, $operation, $variables, $request->request->all(), $request->files->all());
+            return $this->parseMultipartRequest($query, $operationName, $variables, $request->request->all(), $request->files->all());
         }
 
-        return [$query, $operation, $variables];
+        return [$query, $operationName, $variables];
     }
 
     /**
      * @throws BadRequestHttpException
      */
-    private function parseData(?string $query, ?string $operation, array $variables, string $jsonContent): array
+    private function parseData(?string $query, ?string $operationName, array $variables, string $jsonContent): array
     {
         if (!\is_array($data = json_decode($jsonContent, true))) {
             throw new BadRequestHttpException('GraphQL data is not valid JSON.');
@@ -133,23 +133,23 @@ private function parseData(?string $query, ?string $operation, array $variables,
         }
 
         if (isset($data['operationName'])) {
-            $operation = $data['operationName'];
+            $operationName = $data['operationName'];
         }
 
-        return [$query, $operation, $variables];
+        return [$query, $operationName, $variables];
     }
 
     /**
      * @throws BadRequestHttpException
      */
-    private function parseMultipartRequest(?string $query, ?string $operation, array $variables, array $bodyParameters, array $files): array
+    private function parseMultipartRequest(?string $query, ?string $operationName, array $variables, array $bodyParameters, array $files): array
     {
         if ((null === $operations = $bodyParameters['operations'] ?? null) || (null === $map = $bodyParameters['map'] ?? null)) {
             throw new BadRequestHttpException('GraphQL multipart request does not respect the specification.');
         }
 
         /** @var string $operations */
-        [$query, $operation, $variables] = $this->parseData($query, $operation, $variables, $operations);
+        [$query, $operationName, $variables] = $this->parseData($query, $operationName, $variables, $operations);
 
         /** @var string $map */
         if (!\is_array($decodedMap = json_decode($map, true))) {
@@ -158,7 +158,7 @@ private function parseMultipartRequest(?string $query, ?string $operation, array
 
         $variables = $this->applyMapToVariables($decodedMap, $variables, $files);
 
-        return [$query, $operation, $variables];
+        return [$query, $operationName, $variables];
     }
 
     /**