refactor(graphql)!: AstManipulator::getOriginTypeDefinition() => (m…

…ore useful) `AstManipulator::getOriginType()`.
LastDragon-ru · Jan 27, 2024 · 2f29617 · 2f29617
1 parent 342a170
commit 2f29617
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 50 deletions.
diff --git a/packages/graphql/UPGRADE.md b/packages/graphql/UPGRADE.md
@@ -88,7 +88,7 @@ This section is actual only if you are extending the package. Please review and
     $context->get(LastDragon_ru\LaraASP\GraphQL\Builder\Context\HandlerContextBuilderInfo::class)?->value
     ```
 
-  * [ ] Removed `getPlaceholderTypeDefinitionNode()` => `LastDragon_ru\LaraASP\GraphQL\Utils\AstManipulator::getOriginTypeDefinition()`
+  * [ ] Removed `getPlaceholderTypeDefinitionNode()` => `LastDragon_ru\LaraASP\GraphQL\Utils\AstManipulator::getOriginType()`
 
 * [ ] `LastDragon_ru\LaraASP\GraphQL\Builder\Directives\HandlerDirective`
 

diff --git a/packages/graphql/src/Builder/Directives/HandlerDirective.php b/packages/graphql/src/Builder/Directives/HandlerDirective.php
@@ -264,7 +264,7 @@ protected function getArgumentTypeDefinitionNode(
         ContextContract $context,
     ): ListTypeNode|NamedTypeNode|NonNullTypeNode|null {
         $definition = $context->get(HandlerContextImplicit::class)?->value
-            ? $manipulator->getOriginTypeDefinition($argument->getField())
+            ? $manipulator->getTypeDefinition($manipulator->getOriginType($argument->getField()))
             : $argument->getTypeDefinition();
         $operator   = $manipulator->getOperator(static::getScope(), $operator);
         $node       = $manipulator->getTypeSource($definition);

diff --git a/packages/graphql/src/Utils/AstManipulator.php b/packages/graphql/src/Utils/AstManipulator.php
@@ -296,52 +296,49 @@ public function removeTypeDefinition(string $name): void {
     }
 
     /**
-     * @return (TypeDefinitionNode&Node)|Type
+     * @return (TypeNode&Node)|Type
      */
-    public function getOriginTypeDefinition(
+    public function getOriginType(
         FieldDefinitionNode|FieldDefinition|InputValueDefinitionNode|InputObjectField $field,
-    ): TypeDefinitionNode|Type {
-        $node       = $this->getTypeDefinition($field);
-        $name       = $this->getTypeName($node);
-        $directives = $this->getDirectives($field, null, static function (Directive $directive): bool {
+    ): TypeNode|Type {
+        $directive = $this->getDirective($field, Directive::class, static function (Directive $directive): bool {
             return $directive instanceof StreamDirective
                 || $directive instanceof PaginateDirective
                 || $directive instanceof RelationDirective;
         });
-
-        foreach ($directives as $directive) {
-            $type = null;
-
-            if ($directive instanceof StreamDirective) {
-                $type = Str::singular(mb_substr($name, 0, -mb_strlen(StreamDirective::Name)));
-            } elseif ($directive instanceof PaginateDirective || $directive instanceof RelationDirective) {
-                $pagination = $directive instanceof PaginateDirective
-                    ? PaginateDirectiveHelper::getPaginationType($directive)
-                    : RelationDirectiveHelper::getPaginationType($directive);
-
-                if ($pagination) {
-                    if ($pagination->isPaginator()) {
-                        $type = mb_substr($name, 0, -mb_strlen('Paginator'));
-                    } elseif ($pagination->isSimple()) {
-                        $type = mb_substr($name, 0, -mb_strlen('SimplePaginator'));
-                    } elseif ($pagination->isConnection()) {
-                        $type = mb_substr($name, 0, -mb_strlen('Connection'));
-                    } else {
-                        // empty
-                    }
+        $origin    = $field instanceof FieldDefinition || $field instanceof InputObjectField
+            ? $field->getType()
+            : $field->type;
+        $name      = $this->getTypeName($origin);
+        $type      = null;
+
+        if ($directive instanceof StreamDirective) {
+            $type = Str::singular(mb_substr($name, 0, -mb_strlen(StreamDirective::Name)));
+        } elseif ($directive instanceof PaginateDirective || $directive instanceof RelationDirective) {
+            $pagination = $directive instanceof PaginateDirective
+                ? PaginateDirectiveHelper::getPaginationType($directive)
+                : RelationDirectiveHelper::getPaginationType($directive);
+
+            if ($pagination) {
+                if ($pagination->isPaginator()) {
+                    $type = mb_substr($name, 0, -mb_strlen('Paginator'));
+                } elseif ($pagination->isSimple()) {
+                    $type = mb_substr($name, 0, -mb_strlen('SimplePaginator'));
+                } elseif ($pagination->isConnection()) {
+                    $type = mb_substr($name, 0, -mb_strlen('Connection'));
+                } else {
+                    // empty
                 }
-            } else {
-                // empty
             }
+        } else {
+            // empty
+        }
 
-            if ($type) {
-                $node = $this->getTypeDefinition($type);
-
-                break;
-            }
+        if ($type) {
+            $origin = Parser::typeReference("[{$type}!]!");
         }
 
-        return $node;
+        return $origin;
     }
 
     /**

diff --git a/packages/graphql/src/Utils/AstManipulatorTest.php b/packages/graphql/src/Utils/AstManipulatorTest.php
@@ -574,9 +574,9 @@ static function (mixed $field) use ($manipulator): bool {
     }
 
     /**
-     * @dataProvider dataProviderGetOriginTypeDefinition
+     * @dataProvider dataProviderGetOriginType
      */
-    public function testGetOriginTypeDefinition(string $expected, string $graphql): void {
+    public function testGetOriginType(string $expected, string $graphql): void {
         $ast         = Mockery::mock(DocumentAST::class);
         $types       = Container::getInstance()->make(TypeRegistry::class);
         $directives  = Container::getInstance()->make(DirectiveLocator::class);
@@ -590,9 +590,9 @@ public function testGetOriginTypeDefinition(string $expected, string $graphql):
 
         self::assertNotNull($field);
 
-        $type = $manipulator->getOriginTypeDefinition($field);
+        $type = $manipulator->getOriginType($field);
 
-        self::assertEquals($expected, $manipulator->getName($type));
+        self::assertGraphQLPrintableEquals($expected, $type);
     }
     //</editor-fold>
 
@@ -1210,7 +1210,7 @@ interface InterfaceC {
     /**
      * @return array<string, array{string,string}>
      */
-    public static function dataProviderGetOriginTypeDefinition(): array {
+    public static function dataProviderGetOriginType(): array {
         return [
             'field nullable'              => [
                 'Test',
@@ -1225,7 +1225,7 @@ public static function dataProviderGetOriginTypeDefinition(): array {
                 GRAPHQL,
             ],
             'field not null'              => [
-                'Test',
+                'Test!',
                 <<<'GRAPHQL'
                 type Query {
                     field: Test! @mock
@@ -1237,7 +1237,7 @@ public static function dataProviderGetOriginTypeDefinition(): array {
                 GRAPHQL,
             ],
             'list'                        => [
-                'Test',
+                '[Test]',
                 <<<'GRAPHQL'
                 type Query {
                     field: [Test] @mock
@@ -1249,7 +1249,7 @@ public static function dataProviderGetOriginTypeDefinition(): array {
                 GRAPHQL,
             ],
             '@paginate(type: PAGINATOR)'  => [
-                'Test',
+                '[Test!]!',
                 <<<'GRAPHQL'
                 type Query {
                     field: [Test!]
@@ -1265,7 +1265,7 @@ public static function dataProviderGetOriginTypeDefinition(): array {
                 GRAPHQL,
             ],
             '@paginate(type: SIMPLE)'     => [
-                'Test',
+                '[Test!]!',
                 <<<'GRAPHQL'
                 type Query {
                     field: [Test!]
@@ -1281,7 +1281,7 @@ public static function dataProviderGetOriginTypeDefinition(): array {
                 GRAPHQL,
             ],
             '@paginate(type: CONNECTION)' => [
-                'Test',
+                '[Test!]!',
                 <<<'GRAPHQL'
                 type Query {
                     field: [Test!]
@@ -1297,7 +1297,7 @@ public static function dataProviderGetOriginTypeDefinition(): array {
                 GRAPHQL,
             ],
             '@hasOne'                     => [
-                'Test',
+                '[Test!]',
                 <<<'GRAPHQL'
                 type Query {
                     field: [Test!]
@@ -1312,7 +1312,7 @@ public static function dataProviderGetOriginTypeDefinition(): array {
                 GRAPHQL,
             ],
             '@hasMany(type: PAGINATOR)'   => [
-                'Test',
+                '[Test!]!',
                 <<<'GRAPHQL'
                 type Query {
                     field: [Test!]
@@ -1328,12 +1328,14 @@ public static function dataProviderGetOriginTypeDefinition(): array {
                 GRAPHQL,
             ],
             '@stream'                     => [
-                'Test',
+                '[Test!]!',
                 <<<'GRAPHQL'
                 type Query {
                     field: [Test!]
                     @stream(
                         key: "id"
+                        searchable: false
+                        sortable: false
                         builder: {
                             model: "\\LastDragon_ru\\LaraASP\\GraphQL\\Testing\\Package\\Data\\Models\\TestObject"
                         }