API Add Directive types

Directives are part of the GraphQL specification, this PR adds the Directive type. Follow up PRs would be needed to fully utilise the spec.
silverstripe · Apr 14, 2024 · d9d2f62 · d9d2f62
1 parent 6b22696
commit d9d2f62
Show file tree

Hide file tree

Showing 10 changed files with 338 additions and 10 deletions.
diff --git a/src/Schema/Schema.php b/src/Schema/Schema.php
@@ -37,6 +37,7 @@
 use SilverStripe\ORM\ArrayLib;
 use Exception;
 use SilverStripe\Core\Injector\Injector;
+use SilverStripe\GraphQL\Schema\Type\Directive;
 use TypeError;
 
 /**
@@ -62,6 +63,7 @@ class Schema implements ConfigurationApplier
     const UNIONS = 'unions';
     const ENUMS = 'enums';
     const SCALARS = 'scalars';
+    const DIRECTIVES = 'directives';
     const QUERY_TYPE = 'Query';
     const MUTATION_TYPE = 'Mutation';
     const ALL = '*';
@@ -108,6 +110,11 @@ class Schema implements ConfigurationApplier
      */
     private array $scalars = [];
 
+    /**
+     * @var Directive[]
+     */
+    private array $directives = [];
+
     private Type $queryType;
 
     private Type $mutationType;
@@ -151,6 +158,7 @@ public function applyConfig(array $schemaConfig): Schema
             self::MODELS,
             self::ENUMS,
             self::SCALARS,
+            self::DIRECTIVES,
             self::SCHEMA_CONFIG,
             'execute',
             self::SOURCE,
@@ -166,6 +174,7 @@ public function applyConfig(array $schemaConfig): Schema
         $models = $schemaConfig[self::MODELS] ?? [];
         $enums = $schemaConfig[self::ENUMS] ?? [];
         $scalars = $schemaConfig[self::SCALARS] ?? [];
+        $directives = $schemaConfig[self::DIRECTIVES] ?? [];
         $config = $schemaConfig[self::SCHEMA_CONFIG] ?? [];
 
 
@@ -249,6 +258,13 @@ public function applyConfig(array $schemaConfig): Schema
             $this->addScalar($scalar);
         }
 
+        static::assertValidConfig($directives);
+        foreach ($directives as $directiveName => $directiveConfig) {
+            static::assertValidConfig($directiveConfig, ['name', 'description', 'args', 'locations']);
+            $directive = Directive::create($directiveName, $directiveConfig);
+            $this->addDirective($directive);
+        }
+
         $this->applyProceduralUpdates($config['execute'] ?? []);
 
         return $this;
@@ -569,7 +585,8 @@ public function createStoreableSchema(): StorableSchema
                 self::ENUMS => $this->getEnums(),
                 self::INTERFACES => $this->getInterfaces(),
                 self::UNIONS => $this->getUnions(),
-                self::SCALARS => $this->getScalars()
+                self::SCALARS => $this->getScalars(),
+                self::DIRECTIVES => $this->getDirectives()
             ],
             $this->getConfig()
         );
@@ -757,6 +774,22 @@ public function removeScalar(string $name): self
         return $this;
     }
 
+    public function getDirectives(): array
+    {
+        return $this->directives;
+    }
+
+    public function getDirective(string $name): ?Directive
+    {
+        return $this->directives[$name] ?? null;
+    }
+
+    public function addDirective(Directive $directive): self
+    {
+        $this->directives[$directive->getName()] = $directive;
+        return $this;
+    }
+
     /**
      * @throws SchemaBuilderException
      */

diff --git a/src/Schema/SchemaBuilder.php b/src/Schema/SchemaBuilder.php
@@ -219,6 +219,7 @@ private static function getSchemaConfigFromSource(string $schemaKey, string $dir
             Schema::INTERFACES => [],
             Schema::UNIONS => [],
             Schema::SCALARS => [],
+            Schema::DIRECTIVES => [],
         ];
 
         $finder = new Finder();

diff --git a/src/Schema/StorableSchema.php b/src/Schema/StorableSchema.php
@@ -6,6 +6,7 @@
 use SilverStripe\Core\Injector\Injectable;
 use SilverStripe\GraphQL\Schema\Exception\SchemaBuilderException;
 use SilverStripe\GraphQL\Schema\Interfaces\SchemaValidator;
+use SilverStripe\GraphQL\Schema\Type\Directive;
 use SilverStripe\GraphQL\Schema\Type\Enum;
 use SilverStripe\GraphQL\Schema\Type\InterfaceType;
 use SilverStripe\GraphQL\Schema\Type\Scalar;
@@ -50,6 +51,11 @@ class StorableSchema implements SchemaValidator
      */
     private array $scalars;
 
+    /**
+     * @var Directive[]
+     */
+    private array $directives;
+
     private SchemaConfig $config;
 
     public function __construct(array $config = [], ?SchemaConfig $context = null)
@@ -59,6 +65,7 @@ public function __construct(array $config = [], ?SchemaConfig $context = null)
         $this->interfaces = $config[Schema::INTERFACES] ?? [];
         $this->unions = $config[Schema::UNIONS] ?? [];
         $this->scalars = $config[Schema::SCALARS] ?? [];
+        $this->directives = $config[Schema::DIRECTIVES] ?? [];
         $this->config = $context ?: SchemaConfig::create();
     }
 
@@ -102,6 +109,14 @@ public function getScalars(): array
         return $this->scalars;
     }
 
+    /**
+     * @return Directive[]
+     */
+    public function getDirectives(): array
+    {
+        return $this->directives;
+    }
+
     public function getConfig(): SchemaConfig
     {
         return $this->config;
@@ -137,7 +152,8 @@ public function validate(): void
             array_keys($this->enums ?? []),
             array_keys($this->interfaces ?? []),
             array_keys($this->unions ?? []),
-            array_keys($this->scalars ?? [])
+            array_keys($this->scalars ?? []),
+            array_keys($this->directives ?? [])
         );
         $dupes = [];
         foreach (array_count_values($allNames ?? []) as $val => $count) {
@@ -170,7 +186,8 @@ public function validate(): void
             $this->enums,
             $this->interfaces,
             $this->unions,
-            $this->scalars
+            $this->scalars,
+            $this->directives
         );
         /* @var SchemaValidator $validator */
         foreach ($validators as $validator) {

diff --git a/src/Schema/Storage/CodeGenerationStore.php b/src/Schema/Storage/CodeGenerationStore.php
@@ -3,6 +3,7 @@
 namespace SilverStripe\GraphQL\Schema\Storage;
 
 use Exception;
+use GraphQL\GraphQL;
 use GraphQL\Type\Schema as GraphQLSchema;
 use GraphQL\Type\SchemaConfig as GraphQLSchemaConfig;
 use Psr\Log\LoggerInterface;
@@ -29,6 +30,7 @@ class CodeGenerationStore implements SchemaStorageInterface
     use Configurable;
 
     const TYPE_CLASS_NAME = 'Types';
+    const DIRECTIVE_CLASS_NAME = 'Directives';
 
     /**
      * @config
@@ -137,6 +139,8 @@ public function persistSchema(StorableSchema $schema): void
             'typeClassName' => self::TYPE_CLASS_NAME,
             'namespace' => $this->getNamespace(),
             'obfuscator' => $obfuscator,
+            'directiveClassName' => self::DIRECTIVE_CLASS_NAME,
+            'directives' => $schema->getDirectives()
         ];
 
         $config = $schema->getConfig()->toArray();
@@ -146,10 +150,10 @@ public function persistSchema(StorableSchema $schema): void
             $fs->dumpFile(
                 $configFile,
                 '<?php ' .
-                PHP_EOL .
-                'return ' .
-                var_export($config, true) .
-                ';'
+                    PHP_EOL .
+                    'return ' .
+                    var_export($config, true) .
+                    ';'
             );
         } catch (IOException $e) {
             throw new RuntimeException(sprintf(
@@ -164,7 +168,8 @@ public function persistSchema(StorableSchema $schema): void
             $schema->getEnums(),
             $schema->getInterfaces(),
             $schema->getUnions(),
-            $schema->getScalars()
+            $schema->getScalars(),
+            $schema->getDirectives(),
         );
         $encoder = Encoder::create(Path::join($templateDir, 'registry.inc.php'), $allComponents, $globals);
         $code = $encoder->encode();
@@ -185,13 +190,14 @@ public function persistSchema(StorableSchema $schema): void
             'Unions' => 'union.inc.php',
             'Enums' => 'enum.inc.php',
             'Scalars' => 'scalar.inc.php',
+            'Directives' => 'directive.inc.php',
         ];
         $touched = [];
         $built = [];
         $total = 0;
         foreach ($fields as $field => $template) {
             $method = 'get' . $field;
-            /* @var Type|InterfaceType|UnionType|Enum $type */
+            /* @var Type|InterfaceType|UnionType|Enum|Directive $type */
             foreach ($schema->$method() as $type) {
                 $total++;
                 $name = $type->getName();
@@ -311,6 +317,11 @@ function (string $name) use ($registryClass) {
 
         $schemaConfig->setTypes($typeObjs);
 
+        $directivesClass = $this->getClassName(self::DIRECTIVE_CLASS_NAME);
+        $directives = call_user_func([$directivesClass, Schema::DIRECTIVES]);
+        $directives = array_merge(GraphQL::getStandardDirectives(), $directives);
+        $schemaConfig->setDirectives($directives);
+
         $this->graphqlSchema = new GraphQLSchema($schemaConfig);
 
         return $this->graphqlSchema;

diff --git a/src/Schema/Storage/templates/directive.inc.php b/src/Schema/Storage/templates/directive.inc.php
@@ -0,0 +1,43 @@
+<?php
+/* @var object $scope */
+/* @var \SilverStripe\GraphQL\Schema\Type\Directive $directive */
+/* @var array $globals */
+?>
+<?php $directive = $scope; ?>
+namespace <?=$globals['namespace']; ?>;
+
+use GraphQL\Type\Definition\Directive;
+
+// @type:<?=$directive->getName(); ?>
+
+class <?=$globals['obfuscator']->obfuscate($directive->getName()) ?> extends Directive
+{
+    public function __construct()
+    {
+        parent::__construct([
+            'name' => '<?=$directive->getName() ?>',
+        <?php if (!empty($directive->getDescription())) : ?>
+            'description' => '<?=addslashes($directive->getDescription()); ?>',
+        <?php endif; ?>
+
+        'locations' => [
+        <?php foreach ($directive->getLocations() as $location) : ?>
+            '<?=$location; ?>',
+        <?php endforeach; ?>
+        ], // locations
+        <?php if (!empty($directive->getArgs())) : ?>
+            'args' => [
+            <?php foreach ($directive->getArgs() as $arg) : ?>
+                [
+                    'name' => '<?=$arg->getName(); ?>',
+                    'type' => <?=$arg->getEncodedType()->encode(); ?>,
+                <?php if ($arg->getDefaultValue() !== null) : ?>
+                    'defaultValue' => <?=var_export($arg->getDefaultValue(), true); ?>,
+                <?php endif; ?>
+                ], // arg
+            <?php endforeach; ?>
+            ], // args
+        <?php endif; ?>
+        ]);
+    }
+}
diff --git a/src/Schema/Storage/templates/registry.inc.php b/src/Schema/Storage/templates/registry.inc.php
@@ -26,3 +26,27 @@ public static function <?=$component->getName(); ?>() { return static::get('<?=$
     <?php endforeach; ?>
 
 }
+
+class <?=$globals['directiveClassName']; ?> extends AbstractTypeRegistry
+{
+    protected static $types = [];
+
+    protected static function getSourceDirectory(): string
+    {
+        return __DIR__;
+    }
+
+    protected static function getSourceNamespace(): string
+    {
+        return __NAMESPACE__;
+    }
+
+    public static function directives() {
+        return [
+        <?php foreach ($globals['directives']  as $directive) : ?>
+            static::get('<?=$directive->getName(); ?>'),
+        <?php endforeach; ?>
+        ];
+    }
+
+}