update built-in directive's descriptions and and locations

made directives visible to introspection queries
joonlabs · Jun 28, 2021 · 5d50f54 · 5d50f54
1 parent af55b0f
commit 5d50f54
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 9 deletions.
diff --git a/src/Directives/GraphQLIncludeDirective.php b/src/Directives/GraphQLIncludeDirective.php
@@ -4,6 +4,7 @@
 
 use GraphQL\Arguments\GraphQLDirectiveArgument;
 use GraphQL\Types\GraphQLBoolean;
+use GraphQL\Types\GraphQLNonNull;
 
 /**
  * Class GraphQLIncludeDirective
@@ -19,7 +20,15 @@ class GraphQLIncludeDirective extends GraphQLDirective
     public function __construct()
     {
         $this->arguments = [
-            new GraphQLDirectiveArgument("if", new GraphQLBoolean(), "Determines whether to include the target field or not", true)
+            new GraphQLDirectiveArgument("if", new GraphQLNonNull(new GraphQLBoolean()), "Included when true.")
+        ];
+
+        $this->description = "Directs the executor to include this field or fragment only when the `if` argument is true.";
+
+        $this->locations = [
+            "FIELD",
+            "FRAGMENT_SPREAD",
+            "INLINE_FRAGMENT"
         ];
     }
 }

diff --git a/src/Directives/GraphQLSkipDirective.php b/src/Directives/GraphQLSkipDirective.php
@@ -4,6 +4,7 @@
 
 use GraphQL\Arguments\GraphQLDirectiveArgument;
 use GraphQL\Types\GraphQLBoolean;
+use GraphQL\Types\GraphQLNonNull;
 
 /**
  * Class GraphQLSkipDirective
@@ -19,7 +20,15 @@ class GraphQLSkipDirective extends GraphQLDirective
     public function __construct()
     {
         $this->arguments = [
-            new GraphQLDirectiveArgument("if", new GraphQLBoolean(), "Determines whether to skip the target field or not", false)
+            new GraphQLDirectiveArgument("if", new GraphQLNonNull(new GraphQLBoolean()), "Skipped when true.")
+        ];
+
+        $this->description = "Directs the executor to skip this field or fragment when the `if` argument is true.";
+
+        $this->locations = [
+            "FIELD",
+            "FRAGMENT_SPREAD",
+            "INLINE_FRAGMENT"
         ];
     }
 }

diff --git a/src/Schemas/Schema.php b/src/Schemas/Schema.php
@@ -2,6 +2,9 @@
 
 namespace GraphQL\Schemas;
 
+use GraphQL\Directives\GraphQLDirective;
+use GraphQL\Directives\GraphQLIncludeDirective;
+use GraphQL\Directives\GraphQLSkipDirective;
 use GraphQL\Errors\GraphQLError;
 use GraphQL\Types\GraphQLAbstractType;
 use GraphQL\Types\GraphQLObjectType;
@@ -31,7 +34,10 @@ public function __construct(?GraphQLObjectType $queryType, ?GraphQLObjectType $m
     {
         $this->queryType = $queryType;
         $this->mutationType = $mutationType ?? null;
-        $this->directives = $directives ?? [];
+        $this->directives = array_merge([
+            new GraphQLSkipDirective(),
+            new GraphQLIncludeDirective()
+        ], $directives ?? []);
 
         $allReferencedTypes = [];
         $this->typeMap = [];
@@ -45,7 +51,14 @@ public function __construct(?GraphQLObjectType $queryType, ?GraphQLObjectType $m
             $this->collectReferencedTypes($this->mutationType, $allReferencedTypes);
         }
 
-        //TODO: check for custom directives (see: https://github.com/graphql/graphql-js/blob/5ed55b89d526c637eeb9c440715367eec8a2adec/src/type/schema.js#L190)
+        // collect types from directives
+        foreach ($this->directives as $directive) {
+            if ($directive instanceof GraphQLDirective) {
+                foreach ($directive->getArguments() as $argument) {
+                    $this->collectReferencedTypes($argument->getType(), $allReferencedTypes);
+                }
+            }
+        }
 
         $__Schema = Introspection::buildIntrospectionSchemaParts()["__Schema"];
         $this->collectReferencedTypes($__Schema, $allReferencedTypes);

diff --git a/src/Validation/Rules/DirectivesAreDefined.php b/src/Validation/Rules/DirectivesAreDefined.php
@@ -21,13 +21,9 @@ public function validate(ValidationContext $validationContext): void
         $directives = $schema->getDirectives();
 
         $directives = array_map(function ($directive) {
-            return $directive["name"]["value"];
+            return $directive->getName();
         }, $directives);
 
-        // include "skip" and "include" by default
-        $directives[] = "skip";
-        $directives[] = "include";
-
         $wantedDirectives = DocumentUtils::getAllNodesOfKey($document, "directives");
 
         foreach ($wantedDirectives as $wantedDirectiveList) {