Fix class based schemas within routes

CHANGELOG.md

@@ -4,6 +4,10 @@ CHANGELOG
 [Next release](https://github.com/rebing/graphql-laravel/compare/6.4.0...master)
 --------------
 
+### Fixed
+- Middleware and methods can be used in class based schemas. [\#724 / jasonvarga](https://github.com/rebing/graphql-laravel/pull/724)\
+  This is a follow-up fix for [Support for class based schemas](https://github.com/rebing/graphql-laravel/pull/706)
+
 2021-03-31, 6.4.0
 -----------------
 ### Added

phpstan.neon.dist

@@ -58,6 +58,7 @@ parameters:
         - '/Parameter #1 \$name of method Rebing\\GraphQL\\Support\\Type\:\:getFieldResolver\(\) expects string, int\|string given/'
         # tests/Unit/EndpointTest.php
         - '/Parameter #1 \$wrappedType of static method GraphQL\\Type\\Definition\\Type::nonNull\(\) expects \(callable\(\): mixed\)\|GraphQL\\Type\\Definition\\NullableType, GraphQL\\Type\\Definition\\Type given/'
+        - '/Parameter #1 \$array of static method Illuminate\\Support\\Arr::get\(\) expects array\|ArrayAccess/'
         # Mass ignore the raw array property access used in many tests for now
         # See also https://github.com/nunomaduro/larastan/issues/611
         -

src/GraphQL.php

@@ -503,10 +503,41 @@ protected function getSchemaConfiguration($schema)
 
         $schema = is_array($schema) ? $schema : $this->schemas[$schemaName];
 
-        if (! is_string($schema)) {
+        return static::getNormalizedSchemaConfiguration($schema);
+    }
+
+    /**
+     * @return array<string, array|Schema>
+     */
+    public static function getNormalizedSchemasConfiguration(): array
+    {
+        return array_filter(array_map(function ($schema) {
+            try {
+                return static::getNormalizedSchemaConfiguration($schema);
+            } catch (SchemaNotFound $e) {
+                return null;
+            }
+        }, config('graphql.schemas')));
+    }
+
+    /**
+     * @param  Schema|array<array>|string|null  $schema
+     * @return Schema|array<array>
+     */
+    public static function getNormalizedSchemaConfiguration($schema)
+    {
+        if (is_array($schema) || $schema instanceof Schema) {
             return $schema;
         }
 
+        if (is_null($schema)) {
+            return [];
+        }
+
+        if (! class_exists($schema)) {
+            throw new SchemaNotFound('Schema class '.$schema.' not found.');
+        }
+
         /** @var ConfigConvertible $instance */
         $instance = app()->make($schema);
 

src/routes.php

@@ -46,8 +46,11 @@
     }, ARRAY_FILTER_USE_BOTH);
 
     if ($queryTypesMapWithRoutes) {
-        $defaultMiddleware = config('graphql.schemas.'.config('graphql.default_schema').'.middleware', []);
-        $defaultMethod = config('graphql.schemas.'.config('graphql.default_schema').'.method', ['get', 'post']);
+        $schemaConfig = Rebing\GraphQL\GraphQL::getNormalizedSchemasConfiguration();
+
+        $defaultConfig = Arr::get($schemaConfig, config('graphql.default_schema'), []);
+        $defaultMiddleware = $defaultConfig['middleware'] ?? [];
+        $defaultMethod = $defaultConfig['method'] ?? ['get', 'post'];
 
         foreach ($queryTypesMapWithRoutes as $type => $info) {
             if (preg_match($schemaParameterPattern, $info['route'])) {
@@ -66,7 +69,7 @@
                     );
                 }
 
-                foreach (config('graphql.schemas') as $name => $schema) {
+                foreach ($schemaConfig as $name => $schema) {
                     foreach (Arr::get($schema, 'method', ['get', 'post']) as $method) {
                         $routeName = "graphql.$name";
                         if ($method !== 'get') {

tests/Support/Objects/ExampleSchema.php

@@ -17,6 +17,9 @@ public function toConfig(): array
             'mutation' => [
                 'updateExampleCustom' => UpdateExampleMutation::class,
             ],
+            'middleware' => [
+                ExampleMiddleware::class,
+            ]
         ];
     }
 }

tests/Support/Objects/ExampleSchemaWithMethod.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rebing\GraphQL\Tests\Support\Objects;
+
+class ExampleSchemaWithMethod extends ExampleSchema
+{
+    public function toConfig(): array
+    {
+        return array_merge(parent::toConfig(), ['method' => ['post']]);
+    }
+}

tests/Unit/GraphQLTest.php

@@ -120,8 +120,8 @@ public function testSchemaWithWrongName(): void
      */
     public function testSchemaWithInvalidClassName(): void
     {
-        $this->expectException(BindingResolutionException::class);
-        $this->expectExceptionMessage('Target class [ThisClassDoesntExist] does not exist.');
+        $this->expectException(SchemaNotFound::class);
+        $this->expectExceptionMessage('Schema class ThisClassDoesntExist not found.');
         GraphQL::schema('invalid_class_based');
     }
 

tests/Unit/RoutesTest.php

@@ -0,0 +1,129 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rebing\GraphQL\Tests\Unit;
+
+use GraphQL\Utils\BuildSchema;
+use Illuminate\Routing\Route;
+use Illuminate\Support\Collection;
+use Rebing\GraphQL\Tests\Support\Objects\ExampleMiddleware;
+use Rebing\GraphQL\Tests\Support\Objects\ExampleSchema;
+use Rebing\GraphQL\Tests\Support\Objects\ExampleSchemaWithMethod;
+use Rebing\GraphQL\Tests\TestCase;
+
+class RoutesTest extends TestCase
+{
+    protected function getEnvironmentSetUp($app)
+    {
+        $app['config']->set('graphql', [
+
+            'prefix' => 'graphql_test',
+
+            'graphiql' => [
+                'display' => false,
+            ],
+
+            'schemas' => [
+                'default' => [
+                    'middleware' => [ExampleMiddleware::class]
+                ],
+                'custom' => [
+                    'middleware' => [ExampleMiddleware::class]
+                ],
+                'with_methods' => [
+                    'method' => ['post'],
+                    'middleware' => [ExampleMiddleware::class]
+                ],
+                'class_based' => ExampleSchema::class,
+                'class_based_with_methods' => ExampleSchemaWithMethod::class,
+                'shorthand' => BuildSchema::build('
+                    schema {
+                        query: ShorthandExample
+                    }
+
+                    type ShorthandExample {
+                        echo(message: String!): String!
+                    }
+                '),
+            ]
+
+        ]);
+    }
+
+    public function testRoutes(): void
+    {
+        $expected = [
+            'graphql.query' => [
+                'methods' => ['GET', 'HEAD'],
+                'uri' => 'graphql_test',
+                'middleware' => [ExampleMiddleware::class],
+            ],
+            'graphql.query.post' => [
+                'methods' => ['POST'],
+                'uri' => 'graphql_test',
+                'middleware' => [ExampleMiddleware::class],
+            ],
+            'graphql.default' => [
+                'methods' => ['GET', 'HEAD'],
+                'uri' => 'graphql_test/{default}',
+                'middleware' => [ExampleMiddleware::class],
+            ],
+            'graphql.default.post' => [
+                'methods' => ['POST'],
+                'uri' => 'graphql_test/{default}',
+                'middleware' => [ExampleMiddleware::class],
+            ],
+            'graphql.custom' => [
+                'methods' => ['GET', 'HEAD'],
+                'uri' => 'graphql_test/{custom}',
+                'middleware' => [ExampleMiddleware::class],
+            ],
+            'graphql.custom.post' => [
+                'methods' => ['POST'],
+                'uri' => 'graphql_test/{custom}',
+                'middleware' => [ExampleMiddleware::class],
+            ],
+            'graphql.with_methods.post' => [
+                'methods' => ['POST'],
+                'uri' => 'graphql_test/{with_methods}',
+                'middleware' => [ExampleMiddleware::class],
+            ],
+            'graphql.class_based' => [
+                'methods' => ['GET', 'HEAD'],
+                'uri' => 'graphql_test/{class_based}',
+                'middleware' => [ExampleMiddleware::class],
+            ],
+            'graphql.class_based.post' => [
+                'methods' => ['POST'],
+                'uri' => 'graphql_test/{class_based}',
+                'middleware' => [ExampleMiddleware::class],
+            ],
+            'graphql.class_based_with_methods.post' => [
+                'methods' => ['POST'],
+                'uri' => 'graphql_test/{class_based_with_methods}',
+                'middleware' => [ExampleMiddleware::class],
+            ],
+            'graphql.shorthand' => [
+                'methods' => ['GET', 'HEAD'],
+                'uri' => 'graphql_test/{shorthand}',
+                'middleware' => [],
+            ],
+            'graphql.shorthand.post' => [
+                'methods' => ['POST'],
+                'uri' => 'graphql_test/{shorthand}',
+                'middleware' => [],
+            ],
+        ];
+
+        $this->assertEquals($expected, Collection::make(
+            app('router')->getRoutes()->getRoutesByName()
+        )->map(function (Route $route) {
+            return [
+                'methods' => $route->methods(),
+                'uri' => $route->uri(),
+                'middleware' => $route->middleware(),
+            ];
+        })->all());
+    }
+}