Merge pull request #947 from sforward/feat/register-directives

Author: mfn

CHANGELOG.md

@@ -3,6 +3,8 @@ CHANGELOG
 
 [Next release](https://github.com/rebing/graphql-laravel/compare/8.3.0...master)
 --------------
+### Added
+- Register directives via schema config [\#947 / sforward](https://github.com/rebing/graphql-laravel/pull/947)
 
 2022-06-11, 8.3.0
 -----------------

src/GraphQL.php

@@ -10,6 +10,7 @@
 use GraphQL\Error\FormattedError;
 use GraphQL\Executor\ExecutionResult;
 use GraphQL\Server\OperationParams as BaseOperationParams;
+use GraphQL\Type\Definition\Directive;
 use GraphQL\Type\Definition\ObjectType;
 use GraphQL\Type\Definition\Type;
 use GraphQL\Type\Schema;
@@ -363,6 +364,7 @@ public function buildSchemaFromConfig(array $schemaConfig): Schema
         $schemaMutation = $schemaConfig['mutation'] ?? [];
         $schemaSubscription = $schemaConfig['subscription'] ?? [];
         $schemaTypes = $schemaConfig['types'] ?? [];
+        $schemaDirectives = $schemaConfig['directives'] ?? [];
 
         $this->addTypes($schemaTypes);
 
@@ -378,10 +380,18 @@ public function buildSchemaFromConfig(array $schemaConfig): Schema
             ? $this->objectType($schemaSubscription, ['name' => 'Subscription'])
             : null;
 
+        $directives = Directive::getInternalDirectives();
+
+        foreach ($schemaDirectives as $class) {
+            $directive = $this->app->make($class);
+            $directives[$directive->name] = $directive;
+        }
+
         return new Schema([
             'query' => $query,
             'mutation' => $mutation,
             'subscription' => $subscription,
+            'directives' => $directives,
             'types' => function () {
                 $types = [];
 

tests/Support/Directives/ExampleDirective.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types = 1);
+namespace Rebing\GraphQL\Tests\Support\Directives;
+
+use GraphQL\Language\DirectiveLocation;
+use GraphQL\Type\Definition\Directive;
+use GraphQL\Type\Definition\FieldArgument;
+use GraphQL\Type\Definition\Type;
+
+class ExampleDirective extends Directive
+{
+    public function __construct()
+    {
+        parent::__construct([
+            'name' => 'exampleDirective',
+            'description' => 'This is an example directive',
+            'locations' => [
+                // See DirectiveLocation constants for all available locations
+                DirectiveLocation::QUERY,
+            ],
+            'args' => [
+                new FieldArgument([
+                    'name' => 'first',
+                    'description' => 'Description of this argument',
+                    'type' => Type::string(),
+                ]),
+            ],
+        ]);
+    }
+}

tests/Unit/GraphQLTest.php

@@ -15,6 +15,7 @@
 use Rebing\GraphQL\Exception\SchemaNotFound;
 use Rebing\GraphQL\Exception\TypeNotFound;
 use Rebing\GraphQL\Support\Facades\GraphQL;
+use Rebing\GraphQL\Tests\Support\Directives\ExampleDirective;
 use Rebing\GraphQL\Tests\Support\Objects\CustomExampleType;
 use Rebing\GraphQL\Tests\Support\Objects\ExamplesQuery;
 use Rebing\GraphQL\Tests\Support\Objects\ExampleType;
@@ -454,6 +455,25 @@ public function testAddSchemaObjectAndExecuteQueryWithRootValue(): void
         self::assertSame($expectedResult, $result);
     }
 
+    public function testBuildSchemaWithDirectives(): void
+    {
+        $schema = GraphQL::buildSchemaFromConfig([
+            'query' => [
+                'examplesCustom' => ExamplesQuery::class,
+            ],
+            'directives' => [
+                ExampleDirective::class,
+            ],
+        ]);
+
+        self::assertSame([
+            'include',
+            'skip',
+            'deprecated',
+            'exampleDirective',
+        ], array_keys($schema->getDirectives()));
+    }
+
     public function testIsMacroable(): void
     {
         self::assertContains(Macroable::class, class_uses_recursive(GraphQL::getFacadeRoot()));