Add extensibility for easy integration of Apollo Federation PHP (v2)

.gitignore

@@ -1,3 +1,4 @@
+.idea
 phpunit.xml
 /build
 /vendor

README.md

@@ -90,6 +90,7 @@ Documentation
 - [Errors handling](docs/error-handling/index.md)
 - [Events](docs/events/index.md)
 - [Profiler](docs/profiler/index.md)
+- [Tune configuration](docs/tune_configuration.md)
 
 Talks and slides to help you start
 ----------------------------------

UPGRADE.md

@@ -56,7 +56,7 @@ public function __construct(
 )
 ```
 `TypeBuilder` here is a new service `Overblog\GraphQLBundle\Generator\TypeBuilder`, which is also used internally.
-The rest of the arguments were moved into the separate class `Overblog\GraphQLBundle\Generator\TypeGeneratorOptions` 
+The rest of the arguments were moved into the separate class `Overblog\GraphQLBundle\Generator\Model\TypeGeneratorOptions` 
 with the following constructor signature:
 
 ```php

composer.json

@@ -21,6 +21,9 @@
         }
     },
     "config": {
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        },
         "bin-dir": "bin",
         "sort-packages": true
     },

docs/tune_configuration.md

@@ -0,0 +1,22 @@
+Tune configuration
+==================
+
+Custom GraphQl configuration parsers
+------------------------------------
+
+You can configure custom GraphQl configuration parsers.
+Your parsers MUST implement at least `\Overblog\GraphQLBundle\Config\Parser\ParserInterface`
+and optionally `\Overblog\GraphQLBundle\Config\Parser\PreParserInterface` when required.
+
+Default values will be applied when omitted.
+
+```yaml
+overblog_graphql:
+    # ...
+    parsers:
+        yaml: 'Overblog\GraphQLBundle\Config\Parser\YamlParser'
+        graphql: 'Overblog\GraphQLBundle\Config\Parser\GraphQLParser'
+        annotation: 'Overblog\GraphQLBundle\Config\Parser\AnnotationParser'
+        attribute: 'Overblog\GraphQLBundle\Config\Parser\AttributeParser'
+    # ...
+```

src/Config/CustomScalarTypeDefinition.php

@@ -8,10 +8,17 @@
 
 class CustomScalarTypeDefinition extends TypeDefinition
 {
+    public const CONFIG_NAME = '_custom_scalar_config';
+
+    public static function getName(): string
+    {
+        return static::CONFIG_NAME;
+    }
+
     public function getDefinition(): ArrayNodeDefinition
     {
         /** @var ArrayNodeDefinition $node */
-        $node = self::createNode('_custom_scalar_config');
+        $node = self::createNode(static::CONFIG_NAME);
 
         /** @phpstan-ignore-next-line */
         $node

src/Config/EnumTypeDefinition.php

@@ -11,10 +11,17 @@
 
 class EnumTypeDefinition extends TypeDefinition
 {
+    public const CONFIG_NAME = '_enum_config';
+
+    public static function getName(): string
+    {
+        return static::CONFIG_NAME;
+    }
+
     public function getDefinition(): ArrayNodeDefinition
     {
         /** @var ArrayNodeDefinition $node */
-        $node = self::createNode('_enum_config');
+        $node = self::createNode(static::CONFIG_NAME);
 
         /** @phpstan-ignore-next-line */
         $node

src/Config/InputObjectTypeDefinition.php

@@ -9,10 +9,17 @@
 
 class InputObjectTypeDefinition extends TypeDefinition
 {
+    public const CONFIG_NAME = '_input_object_config';
+
+    public static function getName(): string
+    {
+        return static::CONFIG_NAME;
+    }
+
     public function getDefinition(): ArrayNodeDefinition
     {
         /** @var ArrayNodeDefinition $node */
-        $node = self::createNode('_input_object_config');
+        $node = self::createNode(static::CONFIG_NAME);
 
         /** @phpstan-ignore-next-line */
         $node

src/Config/InterfaceTypeDefinition.php

@@ -8,10 +8,17 @@
 
 class InterfaceTypeDefinition extends TypeWithOutputFieldsDefinition
 {
+    public const CONFIG_NAME = '_interface_config';
+
+    public static function getName(): string
+    {
+        return static::CONFIG_NAME;
+    }
+
     public function getDefinition(): ArrayNodeDefinition
     {
         /** @var ArrayNodeDefinition $node */
-        $node = self::createNode('_interface_config');
+        $node = self::createNode(static::CONFIG_NAME);
 
         /** @phpstan-ignore-next-line */
         $node

src/Config/ObjectTypeDefinition.php

@@ -10,17 +10,24 @@
 
 class ObjectTypeDefinition extends TypeWithOutputFieldsDefinition
 {
+    public const CONFIG_NAME = '_object_config';
+
+    public static function getName(): string
+    {
+        return static::CONFIG_NAME;
+    }
+
     public function getDefinition(): ArrayNodeDefinition
     {
-        $builder = new TreeBuilder('_object_config', 'array');
+        $builder = new TreeBuilder(static::CONFIG_NAME, 'array');
 
         /** @var ArrayNodeDefinition $node */
         $node = $builder->getRootNode();
 
         /** @phpstan-ignore-next-line */
         $node
             ->children()
-                ->append($this->validationSection(self::VALIDATION_LEVEL_CLASS))
+                ->append($this->validationSection(static::VALIDATION_LEVEL_CLASS))
                 ->append($this->nameSection())
                 ->append($this->outputFieldsSection())
                 ->append($this->fieldsBuilderSection())

src/Config/Parser/GraphQL/ASTConverter/CustomScalarNode.php

@@ -5,6 +5,7 @@
 namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;
 
 use GraphQL\Language\AST\Node;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 use RuntimeException;
 
 class CustomScalarNode implements NodeInterface
@@ -19,7 +20,7 @@ public static function toConfig(Node $node): array
         ];
 
         return [
-            'type' => 'custom-scalar',
+            'type' => TypeEnum::CUSTOM_SCALAR,
             'config' => $config,
         ];
     }

src/Config/Parser/GraphQL/ASTConverter/DescriptionNode.php

@@ -6,12 +6,17 @@
 
 use GraphQL\Language\AST\Node;
 use GraphQL\Language\AST\StringValueNode;
+use GraphQL\Language\AST\TypeExtensionNode;
 use function trim;
 
 class DescriptionNode implements NodeInterface
 {
     public static function toConfig(Node $node): array
     {
+        if ($node instanceof TypeExtensionNode) {
+            return [];
+        }
+
         return ['description' => self::cleanAstDescription($node->description)];
     }
 
@@ -21,8 +26,6 @@ private static function cleanAstDescription(?StringValueNode $description): ?str
             return null;
         }
 
-        $description = trim($description->value);
-
-        return empty($description) ? null : $description;
+        return trim($description->value) ?: null;
     }
 }

src/Config/Parser/GraphQL/ASTConverter/EnumNode.php

@@ -5,6 +5,7 @@
 namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;
 
 use GraphQL\Language\AST\Node;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 
 class EnumNode implements NodeInterface
 {
@@ -28,7 +29,7 @@ public static function toConfig(Node $node): array
         $config['values'] = $values;
 
         return [
-            'type' => 'enum',
+            'type' => TypeEnum::ENUM,
             'config' => $config,
         ];
     }

src/Config/Parser/GraphQL/ASTConverter/FieldsNode.php

@@ -4,6 +4,8 @@
 
 namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;
 
+use GraphQL\Language\AST\FieldDefinitionNode;
+use GraphQL\Language\AST\InputValueDefinitionNode;
 use GraphQL\Language\AST\Node;
 use GraphQL\Utils\AST;
 
@@ -17,7 +19,7 @@ public static function toConfig(Node $node, string $property = 'fields'): array
                 $fieldConfig = TypeNode::toConfig($definition) + DescriptionNode::toConfig($definition);
 
                 if (!empty($definition->arguments)) {
-                    $fieldConfig['args'] = self::toConfig($definition, 'arguments');
+                    $fieldConfig['args'] = static::toConfig($definition, 'arguments');
                 }
 
                 if (!empty($definition->defaultValue)) {
@@ -29,10 +31,21 @@ public static function toConfig(Node $node, string $property = 'fields'): array
                     $fieldConfig['deprecationReason'] = $directiveConfig['deprecationReason'];
                 }
 
-                $config[$definition->name->value] = $fieldConfig;
+                $config[$definition->name->value] = static::extendFieldConfig($fieldConfig, $definition);
             }
         }
 
         return $config;
     }
+
+    /**
+     * @param array<string,mixed> $fieldConfig
+     * @param FieldDefinitionNode|InputValueDefinitionNode $fieldDefinition
+     *
+     * @return array<string,mixed>
+     */
+    protected static function extendFieldConfig(array $fieldConfig, Node $fieldDefinition): array
+    {
+        return $fieldConfig;
+    }
 }

src/Config/Parser/GraphQL/ASTConverter/InputObjectNode.php

@@ -4,7 +4,9 @@
 
 namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;
 
+use Overblog\GraphQLBundle\Enum\TypeEnum;
+
 class InputObjectNode extends ObjectNode
 {
-    protected const TYPENAME = 'input-object';
+    protected const TYPENAME = TypeEnum::INPUT_OBJECT;
 }

src/Config/Parser/GraphQL/ASTConverter/InterfaceNode.php

@@ -4,7 +4,9 @@
 
 namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;
 
+use Overblog\GraphQLBundle\Enum\TypeEnum;
+
 class InterfaceNode extends ObjectNode
 {
-    protected const TYPENAME = 'interface';
+    protected const TYPENAME = TypeEnum::INTERFACE;
 }

src/Config/Parser/GraphQL/ASTConverter/NodeInterface.php

@@ -8,5 +8,8 @@
 
 interface NodeInterface
 {
+    /**
+     * @return array<string,mixed>
+     */
     public static function toConfig(Node $node): array;
 }

src/Config/Parser/GraphQL/ASTConverter/ObjectNode.php

@@ -5,28 +5,63 @@
 namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;
 
 use GraphQL\Language\AST\Node;
+use GraphQL\Language\AST\ObjectTypeDefinitionNode;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 
 class ObjectNode implements NodeInterface
 {
-    protected const TYPENAME = 'object';
+    protected const TYPENAME = TypeEnum::OBJECT;
 
+    /**
+     * @param ObjectTypeDefinitionNode $node
+     *
+     * @return array<string,mixed>
+     */
     public static function toConfig(Node $node): array
     {
-        $config = DescriptionNode::toConfig($node) + [
+        return [
+            'type' => static::TYPENAME,
+            'config' => static::parseConfig($node),
+        ];
+    }
+
+    /**
+     * @param ObjectTypeDefinitionNode $node
+     *
+     * @return array<string,mixed>
+     */
+    protected static function parseConfig(Node $node): array
+    {
+        $config = DescriptionNode::toConfig($node) + static::parseFields($node);
+        $config += static::parseInterfaces($node);
+
+        return $config;
+    }
+
+    /**
+     * @return array{fields: array<string,mixed> }
+     */
+    protected static function parseFields(Node $node): array
+    {
+        return [
             'fields' => FieldsNode::toConfig($node),
         ];
+    }
 
-        if (!empty($node->interfaces)) {
+    /**
+     * @return array<string,array<string>>
+     */
+    protected static function parseInterfaces(Node $node): array
+    {
+        $config = [];
+        if (isset($node->interfaces) && !empty($node->interfaces)) {
             $interfaces = [];
             foreach ($node->interfaces as $interface) {
                 $interfaces[] = TypeNode::astTypeNodeToString($interface);
             }
             $config['interfaces'] = $interfaces;
         }
 
-        return [
-            'type' => static::TYPENAME,
-            'config' => $config,
-        ];
+        return $config;
     }
 }

src/Config/Parser/GraphQL/ASTConverter/UnionNode.php

@@ -5,6 +5,7 @@
 namespace Overblog\GraphQLBundle\Config\Parser\GraphQL\ASTConverter;
 
 use GraphQL\Language\AST\Node;
+use Overblog\GraphQLBundle\Enum\TypeEnum;
 
 class UnionNode implements NodeInterface
 {
@@ -21,7 +22,7 @@ public static function toConfig(Node $node): array
         }
 
         return [
-            'type' => 'union',
+            'type' => TypeEnum::UNION,
             'config' => $config,
         ];
     }