SCALAR support.

Author: LastDragon-ru

src/Utils/SchemaPrinter.php

@@ -4,7 +4,10 @@
 
 namespace GraphQL\Utils;
 
+use Closure;
 use GraphQL\Error\Error;
+use GraphQL\Language\AST\DirectiveNode;
+use GraphQL\Language\AST\ScalarTypeDefinitionNode;
 use GraphQL\Language\BlockString;
 use GraphQL\Language\Printer;
 use GraphQL\Type\Definition\Directive;
@@ -30,23 +33,29 @@
 use function count;
 use function explode;
 use function implode;
+use function is_callable;
 use function ksort;
 use function mb_strlen;
+use function self;
 use function sprintf;
 use function str_replace;
 use function strlen;
 
 /**
  * Prints the contents of a Schema in schema definition language.
  *
- * @phpstan-type Options array{commentDescriptions?: bool}
+ * @phpstan-type Options array{commentDescriptions?: bool, printDirectives?: callable(DirectiveNode): bool}
  *
  *  - commentDescriptions:
  *      Provide true to use preceding comments as the description.
  *      This option is provided to ease adoption and will be removed in v16.
+ *  - printDirectives
+ *      Callable used to determine should be directive printed or not.
  */
 class SchemaPrinter
 {
+    protected const LINE_LENGTH = 80;
+
     /**
      * @param array<string, bool> $options
      * @phpstan-param Options $options
@@ -308,7 +317,9 @@ protected static function printInputValue($arg): string
      */
     protected static function printScalar(ScalarType $type, array $options): string
     {
-        return sprintf('%sscalar %s', static::printDescription($options, $type), $type->name);
+        return static::printDescription($options, $type) .
+            sprintf('scalar %s', $type->name) .
+            static::printTypeDirectives($type, $options);
     }
 
     /**
@@ -459,4 +470,53 @@ protected static function printBlock(array $items): string
             ? " {\n" . implode("\n", $items) . "\n}"
             : '';
     }
+
+    /**
+     * @param array<string, bool> $options
+     * @phpstan-param Options $options
+     */
+    protected static function printTypeDirectives(Type $type, array $options, string $indentation = ''): string {
+        // Enabled?
+        $filter = $options['printDirectives'] ?? null;
+
+        if (!$filter || !is_callable($filter)) {
+            return '';
+        }
+
+        // AST Node available and has directives?
+        $node = $type->astNode;
+
+        if (!($node instanceof ScalarTypeDefinitionNode)) {
+            return '';
+        }
+
+        // Print
+        /** @var array<string> $directives */
+        $length = 0;
+        $directives = [];
+
+        foreach ($node->directives as $directive) {
+            if ($filter($directive)) {
+                $string = static::printTypeDirective($directive, $options, $indentation);
+                $length = $length + mb_strlen($string);
+                $directives[] = $string;
+            }
+        }
+
+        // Multiline?
+        $delimiter = $length > static::LINE_LENGTH ? "\n{$indentation}" : ' ';
+        $serialized = $delimiter.implode($delimiter, $directives);
+
+        // Return
+        return $serialized;
+    }
+
+    /**
+     * @param array<string, bool> $options
+     * @phpstan-param Options $options
+     */
+    protected static function printTypeDirective(DirectiveNode $directive, array $options, string $indentation): string
+    {
+        return Printer::doPrint($directive);
+    }
 }

tests/Utils/SchemaPrinterTest.php

@@ -6,6 +6,7 @@
 
 use Generator;
 use GraphQL\Language\DirectiveLocation;
+use GraphQL\Language\Parser;
 use GraphQL\Type\Definition\CustomScalarType;
 use GraphQL\Type\Definition\Directive;
 use GraphQL\Type\Definition\EnumType;
@@ -19,6 +20,8 @@
 use GraphQL\Utils\SchemaPrinter;
 use PHPUnit\Framework\TestCase;
 
+use function str_pad;
+
 class SchemaPrinterTest extends TestCase
 {
     private static function assertPrintedSchemaEquals(string $expected, Schema $schema): void
@@ -1273,4 +1276,42 @@ enum __TypeKind {
             GRAPHQL;
         self::assertEquals($expected, $output);
     }
+
+    public function testPrintDirectives(): void {
+        $text   = str_pad('a', 80, 'a');
+        $schema = /** @lang GraphQL */ <<<GRAPHQL
+        directive @test(
+          value: String
+        ) on SCHEMA |
+            SCALAR |
+            OBJECT |
+            FIELD_DEFINITION |
+            ARGUMENT_DEFINITION |
+            INTERFACE |
+            UNION |
+            ENUM |
+            ENUM_VALUE |
+            INPUT_OBJECT |
+            INPUT_FIELD_DEFINITION
+
+        scalar ScalarA @test
+        scalar ScalarB @test(value: "{$text}")
+        GRAPHQL;
+        $expected = <<<'GRAPHQL'
+        directive @test(value: String) on SCHEMA | SCALAR | OBJECT | FIELD_DEFINITION | ARGUMENT_DEFINITION | INTERFACE | UNION | ENUM | ENUM_VALUE | INPUT_OBJECT | INPUT_FIELD_DEFINITION
+
+        scalar ScalarA @test
+
+        scalar ScalarB
+        @test(value: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
+
+        GRAPHQL;
+        $actual = SchemaPrinter::doPrint(BuildSchema::build($schema), [
+            'printDirectives' => static function(): bool {
+                return true;
+            },
+        ]);
+
+        self::assertEquals($expected, $actual);
+    }
 }