refactor(graphql)!: Type registration (#161)

LastDragon-ru · May 2, 2024 · 73d3a0e · 73d3a0e
2 parents 7d7bf1d + 104eff5
commit 73d3a0e
Show file tree

Hide file tree

Showing 26 changed files with 216 additions and 357 deletions.
diff --git a/packages/graphql/README.md b/packages/graphql/README.md
@@ -91,7 +91,7 @@ Converts scalar into GraphQL Type. Similar to Lighthouse's `@scalar` directive,
 >
 > ```graphql
 > scalar JsonString
-> @scalar(
+> @type(
 >     class: "LastDragon_ru\\LaraASP\\GraphQL\\Scalars\\JsonStringType"
 > )
 > ```

diff --git a/packages/graphql/UPGRADE.md b/packages/graphql/UPGRADE.md
@@ -33,6 +33,12 @@ Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases)
 >
 > Maybe a good idea to add test (at least) with `LastDragon_ru\LaraASP\GraphQL\Testing\GraphQLAssertions::assertGraphQLSchemaEquals()` assertion before the upgrade 🤗
 
+# Upgrade from v6
+
+* [ ] The `\LastDragon_ru\LaraASP\GraphQL\Scalars\JsonStringType` is not implement `\LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeDefinition` anymore. To add the scalar into the Schema, you can use `@type`/`@scalar` directive, or create a custom implementation of `TypeDefinition` contract to use with `Builder`/`Manipulator`.
+
+* [ ] `\LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeDefinition::getTypeDefinition()` return type changed.
+
 # Upgrade from v5
 
 ## General

diff --git a/packages/graphql/src/Builder/Contracts/TypeDefinition.php b/packages/graphql/src/Builder/Contracts/TypeDefinition.php
@@ -7,7 +7,7 @@
 use GraphQL\Type\Definition\NamedType;
 use GraphQL\Type\Definition\Type;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Manipulator;
-use LastDragon_ru\LaraASP\GraphQL\Utils\TypeReference;
+use UnitEnum;
 
 interface TypeDefinition {
     /**
@@ -18,15 +18,12 @@ public function getTypeName(TypeSource $source, Context $context): string;
     /**
      * Returns the type definition for given Source if possible. The name must be equal to `$name`.
      *
-     * @see TypeReference
-     *
-     * @return (TypeDefinitionNode&Node)|(Type&NamedType)|null Returning {@see Type} is deprecated, please use
-     *      {@see TypeReference} instead.
+     * @return (TypeDefinitionNode&Node)|class-string<(Type&NamedType)|UnitEnum>|null
      */
     public function getTypeDefinition(
         Manipulator $manipulator,
         TypeSource $source,
         Context $context,
         string $name,
-    ): TypeDefinitionNode|Type|null;
+    ): TypeDefinitionNode|string|null;
 }
diff --git a/packages/graphql/src/Builder/Manipulator.php b/packages/graphql/src/Builder/Manipulator.php
@@ -23,7 +23,6 @@
 use LastDragon_ru\LaraASP\GraphQL\Builder\Context\HandlerContextOperators;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Operator;
-use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeDefinition;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeProvider;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeSource;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Exceptions\FakeTypeDefinitionIsNotFake;
@@ -35,7 +34,6 @@
 use LastDragon_ru\LaraASP\GraphQL\Builder\Sources\InterfaceSource;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Sources\ObjectSource;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Sources\Source;
-use LastDragon_ru\LaraASP\GraphQL\Package;
 use LastDragon_ru\LaraASP\GraphQL\Utils\AstManipulator;
 use LastDragon_ru\LaraASP\GraphQL\Utils\TypeReference;
 use Nuwave\Lighthouse\Schema\DirectiveLocator;
@@ -46,7 +44,7 @@
 use function array_unshift;
 use function count;
 use function implode;
-use function trigger_deprecation;
+use function is_string;
 
 class Manipulator extends AstManipulator implements TypeProvider {
     // <editor-fold desc="TypeProvider">
@@ -67,21 +65,14 @@ public function getType(string $definition, TypeSource $source, Context $context
         // Create new
         $node = $instance->getTypeDefinition($this, $source, $context, $name);
 
-        if ($node instanceof Type && !($node instanceof TypeReference)) {
-            trigger_deprecation(
-                Package::Name,
-                '6.3.0',
-                'Returning `%s` from `%s` is deprecated, please use `%s` instead.',
-                Type::class,
-                TypeDefinition::class.'::getTypeDefinition()',
-                TypeReference::class,
-            );
-        }
-
         if (!$node) {
             throw new TypeDefinitionImpossibleToCreateType($definition, $source, $context);
         }
 
+        if (is_string($node)) {
+            $node = new TypeReference($name, $node);
+        }
+
         if ($name !== $this->getName($node)) {
             throw new TypeDefinitionInvalidTypeName($definition, $name, $this->getName($node), $context);
         }

diff --git a/packages/graphql/src/Builder/Types/InputObject.php b/packages/graphql/src/Builder/Types/InputObject.php
@@ -53,16 +53,13 @@ abstract protected function getDescription(
         Context $context,
     ): string;
 
-    /**
-     * @inheritDoc
-     */
     #[Override]
     public function getTypeDefinition(
         Manipulator $manipulator,
         TypeSource $source,
         Context $context,
         string $name,
-    ): TypeDefinitionNode|Type|null {
+    ): TypeDefinitionNode|string|null {
         // Source?
         $source = $manipulator->getTypeSource($source->getTypeDefinition());
 

diff --git a/packages/graphql/src/Scalars/JsonStringType.php b/packages/graphql/src/Scalars/JsonStringType.php
@@ -8,22 +8,15 @@
 use GraphQL\Language\AST\Node;
 use GraphQL\Language\AST\NodeKind;
 use GraphQL\Language\AST\StringValueNode;
-use GraphQL\Language\AST\TypeDefinitionNode;
 use GraphQL\Type\Definition\StringType;
-use GraphQL\Type\Definition\Type;
 use GraphQL\Utils\Utils;
-use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context;
-use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeDefinition;
-use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeSource;
-use LastDragon_ru\LaraASP\GraphQL\Builder\Manipulator;
-use LastDragon_ru\LaraASP\GraphQL\Utils\TypeReference;
 use Override;
 
 use function is_string;
 use function json_validate;
 use function sprintf;
 
-class JsonStringType extends StringType implements TypeDefinition {
+class JsonStringType extends StringType {
     public string  $name        = 'JsonString';
     public ?string $description = 'Represents JSON string.';
 
@@ -83,22 +76,4 @@ protected function validate(mixed $value, string $error): string {
         return $value;
     }
     // </editor-fold>
-
-    // <editor-fold desc="TypeDefinition">
-    // =========================================================================
-    #[Override]
-    public function getTypeName(TypeSource $source, Context $context): string {
-        return $this->name();
-    }
-
-    #[Override]
-    public function getTypeDefinition(
-        Manipulator $manipulator,
-        TypeSource $source,
-        Context $context,
-        string $name,
-    ): TypeDefinitionNode|Type|null {
-        return new TypeReference($name, self::class);
-    }
-    // </editor-fold>
 }
diff --git a/packages/graphql/src/SearchBy/Directives/DirectiveTest.php b/packages/graphql/src/SearchBy/Directives/DirectiveTest.php
@@ -4,7 +4,6 @@
 
 use Closure;
 use Exception;
-use GraphQL\Language\AST\Node;
 use GraphQL\Language\AST\TypeDefinitionNode;
 use GraphQL\Language\Parser;
 use GraphQL\Type\Definition\EnumType;
@@ -1622,7 +1621,7 @@ public function getTypeDefinition(
         TypeSource $source,
         Context $context,
         string $name,
-    ): TypeDefinitionNode&Node {
+    ): TypeDefinitionNode|string|null {
         return Parser::inputObjectTypeDefinition(
             <<<GRAPHQL
             """

diff --git a/packages/graphql/src/SearchBy/Directives/DirectiveTest/Implicit.expected.graphql b/packages/graphql/src/SearchBy/Directives/DirectiveTest/Implicit.expected.graphql
@@ -1075,7 +1075,7 @@ pagination).
 """
 scalar StreamOffset
 @type(
-    class: "LastDragon_ru\\LaraASP\\GraphQL\\Stream\\Types\\Offset"
+    class: "LastDragon_ru\\LaraASP\\GraphQL\\Stream\\Scalars\\Offset"
 )
 
 type A {

diff --git a/packages/graphql/src/SearchBy/Operators/Complex/RelationshipType.php b/packages/graphql/src/SearchBy/Operators/Complex/RelationshipType.php
@@ -35,7 +35,7 @@ public function getTypeDefinition(
         TypeSource $source,
         Context $context,
         string $name,
-    ): TypeDefinitionNode|Type|null {
+    ): TypeDefinitionNode|string|null {
         // Object?
         if (!$source->isObject()) {
             return null;

diff --git a/packages/graphql/src/SearchBy/Types/Enumeration.php b/packages/graphql/src/SearchBy/Types/Enumeration.php
@@ -4,7 +4,6 @@
 
 use GraphQL\Language\AST\TypeDefinitionNode;
 use GraphQL\Language\Parser;
-use GraphQL\Type\Definition\Type;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Context\HandlerContextBuilderInfo;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Context\HandlerContextOperators;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context;
@@ -32,16 +31,13 @@ public function getTypeName(TypeSource $source, Context $context): string {
         return "{$directiveName}{$builderName}Enum{$typeName}{$nullable}";
     }
 
-    /**
-     * @inheritDoc
-     */
     #[Override]
     public function getTypeDefinition(
         Manipulator $manipulator,
         TypeSource $source,
         Context $context,
         string $name,
-    ): TypeDefinitionNode|Type|null {
+    ): TypeDefinitionNode|string|null {
         // Enum?
         if (!$source->isEnum()) {
             return null;

diff --git a/packages/graphql/src/SearchBy/Types/Flag.php b/packages/graphql/src/SearchBy/Types/Flag.php
@@ -3,14 +3,12 @@
 namespace LastDragon_ru\LaraASP\GraphQL\SearchBy\Types;
 
 use GraphQL\Language\AST\TypeDefinitionNode;
-use GraphQL\Type\Definition\Type;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeDefinition;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeSource;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Enums\Flag as FlagEnum;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Manipulator;
 use LastDragon_ru\LaraASP\GraphQL\SearchBy\Directives\Directive;
-use LastDragon_ru\LaraASP\GraphQL\Utils\TypeReference;
 use Override;
 
 class Flag implements TypeDefinition {
@@ -29,7 +27,7 @@ public function getTypeDefinition(
         TypeSource $source,
         Context $context,
         string $name,
-    ): TypeDefinitionNode|Type|null {
-        return new TypeReference($name, FlagEnum::class);
+    ): TypeDefinitionNode|string|null {
+        return FlagEnum::class;
     }
 }
diff --git a/packages/graphql/src/SearchBy/Types/Range.php b/packages/graphql/src/SearchBy/Types/Range.php
@@ -4,7 +4,6 @@
 
 use GraphQL\Language\AST\TypeDefinitionNode;
 use GraphQL\Language\Parser;
-use GraphQL\Type\Definition\Type;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeDefinition;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeSource;
@@ -31,7 +30,7 @@ public function getTypeDefinition(
         TypeSource $source,
         Context $context,
         string $name,
-    ): TypeDefinitionNode|Type|null {
+    ): TypeDefinitionNode|string|null {
         return Parser::inputObjectTypeDefinition(
             <<<GRAPHQL
             input {$name} {

diff --git a/packages/graphql/src/SearchBy/Types/Scalar.php b/packages/graphql/src/SearchBy/Types/Scalar.php
@@ -4,7 +4,6 @@
 
 use GraphQL\Language\AST\TypeDefinitionNode;
 use GraphQL\Language\Parser;
-use GraphQL\Type\Definition\Type;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Context\HandlerContextBuilderInfo;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Context\HandlerContextOperators;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context;
@@ -32,16 +31,13 @@ public function getTypeName(TypeSource $source, Context $context): string {
         return "{$directiveName}{$builderName}Scalar{$typeName}{$nullable}";
     }
 
-    /**
-     * @inheritDoc
-     */
     #[Override]
     public function getTypeDefinition(
         Manipulator $manipulator,
         TypeSource $source,
         Context $context,
         string $name,
-    ): TypeDefinitionNode|Type|null {
+    ): TypeDefinitionNode|string|null {
         // Scalar?
         if (!$source->isScalar()) {
             return null;

diff --git a/packages/graphql/src/SortBy/Directives/DirectiveTest/Implicit.expected.graphql b/packages/graphql/src/SortBy/Directives/DirectiveTest/Implicit.expected.graphql
@@ -523,7 +523,7 @@ pagination).
 """
 scalar StreamOffset
 @type(
-    class: "LastDragon_ru\\LaraASP\\GraphQL\\Stream\\Types\\Offset"
+    class: "LastDragon_ru\\LaraASP\\GraphQL\\Stream\\Scalars\\Offset"
 )
 
 type A {

diff --git a/packages/graphql/src/SortBy/Types/Direction.php b/packages/graphql/src/SortBy/Types/Direction.php
@@ -3,14 +3,12 @@
 namespace LastDragon_ru\LaraASP\GraphQL\SortBy\Types;
 
 use GraphQL\Language\AST\TypeDefinitionNode;
-use GraphQL\Type\Definition\Type;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeDefinition;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeSource;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Manipulator;
 use LastDragon_ru\LaraASP\GraphQL\SortBy\Directives\Directive;
 use LastDragon_ru\LaraASP\GraphQL\SortBy\Enums\Direction as DirectionEnum;
-use LastDragon_ru\LaraASP\GraphQL\Utils\TypeReference;
 use Override;
 
 class Direction implements TypeDefinition {
@@ -29,7 +27,7 @@ public function getTypeDefinition(
         TypeSource $source,
         Context $context,
         string $name,
-    ): TypeDefinitionNode|Type|null {
-        return new TypeReference($name, DirectionEnum::class);
+    ): TypeDefinitionNode|string|null {
+        return DirectionEnum::class;
     }
 }
diff --git a/packages/graphql/src/SortBy/Types/Flag.php b/packages/graphql/src/SortBy/Types/Flag.php
@@ -3,14 +3,12 @@
 namespace LastDragon_ru\LaraASP\GraphQL\SortBy\Types;
 
 use GraphQL\Language\AST\TypeDefinitionNode;
-use GraphQL\Type\Definition\Type;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeDefinition;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeSource;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Enums\Flag as FlagEnum;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Manipulator;
 use LastDragon_ru\LaraASP\GraphQL\SortBy\Directives\Directive;
-use LastDragon_ru\LaraASP\GraphQL\Utils\TypeReference;
 use Override;
 
 class Flag implements TypeDefinition {
@@ -29,7 +27,7 @@ public function getTypeDefinition(
         TypeSource $source,
         Context $context,
         string $name,
-    ): TypeDefinitionNode|Type|null {
-        return new TypeReference($name, FlagEnum::class);
+    ): TypeDefinitionNode|string|null {
+        return FlagEnum::class;
     }
 }
diff --git a/packages/graphql/src/Stream/Directives/DirectiveTest~schema-expected.graphql b/packages/graphql/src/Stream/Directives/DirectiveTest~schema-expected.graphql
@@ -303,7 +303,7 @@ pagination).
 """
 scalar StreamOffset
 @type(
-    class: "LastDragon_ru\\LaraASP\\GraphQL\\Stream\\Types\\Offset"
+    class: "LastDragon_ru\\LaraASP\\GraphQL\\Stream\\Scalars\\Offset"
 )
 
 type Query

diff --git a/packages/graphql/src/Stream/Directives/DirectiveTest~scout-expected.graphql b/packages/graphql/src/Stream/Directives/DirectiveTest~scout-expected.graphql
@@ -232,7 +232,7 @@ pagination).
 """
 scalar StreamOffset
 @type(
-    class: "LastDragon_ru\\LaraASP\\GraphQL\\Stream\\Types\\Offset"
+    class: "LastDragon_ru\\LaraASP\\GraphQL\\Stream\\Scalars\\Offset"
 )
 
 type Query