Allow disabling batched requests

Author: mfn

CHANGELOG.md

@@ -4,6 +4,9 @@ CHANGELOG
 [Next release](https://github.com/rebing/graphql-laravel/compare/7.1.0...master)
 --------------
 
+### Added
+- Allow disabling batched requests [\#738 / mfn](https://github.com/rebing/graphql-laravel/pull/738)
+
 2021-04-08, 7.1.0
 -----------------
 ### Added

README.md

@@ -1820,6 +1820,8 @@ There are tools that help with this and can handle the batching for you, e.g. [A
 > - No limitations on the number of queries/mutations  
 >   Currently there's no way to limit this.
 
+Support for batching can be disabled by setting the config `batching` to `false`.
+
 ### Scalar types
 
 GraphQL comes with built-in scalar types for string, int, boolean, etc. It's possible to create custom scalar types to special purpose fields.

config/config.php

@@ -54,6 +54,11 @@
     // parameter.
     'default_schema' => 'default',
 
+    // Whether to support GraphQL batching or not.
+    // See e.g. https://www.apollographql.com/blog/batching-client-graphql-queries-a685f5bcd41b/
+    // for pro and con
+    'batching' => true,
+
     // The schemas for query and/or mutation. It expects an array of schemas to provide
     // both the 'query' fields and the 'mutation' fields.
     //

src/GraphQLController.php

@@ -40,8 +40,20 @@ public function query(Request $request, string $schema = null): JsonResponse
             $schema = config('graphql.default_schema');
         }
 
+        $headers = config('graphql.headers', []);
+        $jsonOptions = config('graphql.json_encoding_options', 0);
+
         // check if is batch (check if the array is associative)
         $isBatch = !Arr::isAssoc($request->input());
+
+        $supportsBatching = config('graphql.batching', true);
+
+        if ($isBatch && !$supportsBatching) {
+            $data = $this->createBatchingNotSupportedResponse($request->input());
+
+            return response()->json($data, 200, $headers, $jsonOptions);
+        }
+
         $inputs = $isBatch ? $request->input() : [$request->input()];
 
         $completedQueries = [];
@@ -53,9 +65,6 @@ public function query(Request $request, string $schema = null): JsonResponse
 
         $data = $isBatch ? $completedQueries : $completedQueries[0];
 
-        $headers = config('graphql.headers', []);
-        $jsonOptions = config('graphql.json_encoding_options', 0);
-
         return response()->json($data, 200, $headers, $jsonOptions);
     }
 
@@ -185,4 +194,32 @@ protected function getRouteParameters(Request $request): array
 
         return $request->route()->parameters;
     }
+
+    /**
+     * In case batching is not supported, send an error back for each batch
+     * (with a hardcoded limit of 100).
+     *
+     * The returned format still matches the GraphQL specs
+     *
+     * @param array<string,mixed> $input
+     * @return array<array{errors:array<array{message:string}>}>
+     */
+    protected function createBatchingNotSupportedResponse(array $input): array
+    {
+        $count = min(count($input), 100);
+
+        $data = [];
+
+        for ($i = 0; $i < $count; $i++) {
+            $data[] = [
+                'errors' => [
+                    [
+                        'message' => 'Batch request received but batching is not supported',
+                    ],
+                ],
+            ];
+        }
+
+        return $data;
+    }
 }

tests/Unit/EndpointTest.php

@@ -157,6 +157,48 @@ public function testBatchedQueries(): void
         ]);
     }
 
+    public function testBatchedQueriesButBatchingDisabled(): void
+    {
+        config(['graphql.batching' => false]);
+
+        $response = $this->call('GET', '/graphql', [
+            [
+                'query' => $this->queries['examplesWithVariables'],
+                'variables' => [
+                    'index' => 0,
+                ],
+            ],
+            [
+                'query' => $this->queries['examplesWithVariables'],
+                'variables' => [
+                    'index' => 0,
+                ],
+            ],
+        ]);
+
+        self::assertEquals(200, $response->getStatusCode());
+
+        $actual = $response->getData(true);
+
+        $expected = [
+            [
+                'errors' => [
+                    [
+                        'message' => 'Batch request received but batching is not supported',
+                    ],
+                ],
+            ],
+            [
+                'errors' => [
+                    [
+                        'message' => 'Batch request received but batching is not supported',
+                    ],
+                ],
+            ],
+        ];
+        self::assertEquals($expected, $actual);
+    }
+
     public function testGetGraphqiQL(): void
     {
         $response = $this->call('GET', '/graphiql');