509 lines
16 KiB
PHP
509 lines
16 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace GraphQL\Utils;
|
|
|
|
use GraphQL\Error\Error;
|
|
use GraphQL\Language\Printer;
|
|
use GraphQL\Type\Definition\Directive;
|
|
use GraphQL\Type\Definition\EnumType;
|
|
use GraphQL\Type\Definition\InputObjectType;
|
|
use GraphQL\Type\Definition\InterfaceType;
|
|
use GraphQL\Type\Definition\ObjectType;
|
|
use GraphQL\Type\Definition\ScalarType;
|
|
use GraphQL\Type\Definition\Type;
|
|
use GraphQL\Type\Definition\UnionType;
|
|
use GraphQL\Type\Introspection;
|
|
use GraphQL\Type\Schema;
|
|
use function array_filter;
|
|
use function array_keys;
|
|
use function array_map;
|
|
use function array_merge;
|
|
use function array_values;
|
|
use function count;
|
|
use function explode;
|
|
use function implode;
|
|
use function ksort;
|
|
use function mb_strlen;
|
|
use function preg_match_all;
|
|
use function sprintf;
|
|
use function str_replace;
|
|
use function strlen;
|
|
use function substr;
|
|
|
|
/**
|
|
* Given an instance of Schema, prints it in GraphQL type language.
|
|
*/
|
|
class SchemaPrinter
|
|
{
|
|
/**
|
|
* @param array<string, bool> $options
|
|
* Available options:
|
|
* - commentDescriptions:
|
|
* Provide true to use preceding comments as the description.
|
|
* This option is provided to ease adoption and will be removed in v16.
|
|
*
|
|
* @api
|
|
*/
|
|
public static function doPrint(Schema $schema, array $options = []) : string
|
|
{
|
|
return static::printFilteredSchema(
|
|
$schema,
|
|
static function ($type) : bool {
|
|
return ! Directive::isSpecifiedDirective($type);
|
|
},
|
|
static function ($type) : bool {
|
|
return ! Type::isBuiltInType($type);
|
|
},
|
|
$options
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
protected static function printFilteredSchema(Schema $schema, callable $directiveFilter, callable $typeFilter, array $options) : string
|
|
{
|
|
$directives = array_filter($schema->getDirectives(), $directiveFilter);
|
|
|
|
$types = $schema->getTypeMap();
|
|
ksort($types);
|
|
$types = array_filter($types, $typeFilter);
|
|
|
|
return sprintf(
|
|
"%s\n",
|
|
implode(
|
|
"\n\n",
|
|
array_filter(
|
|
array_merge(
|
|
[static::printSchemaDefinition($schema)],
|
|
array_map(
|
|
static function (Directive $directive) use ($options) : string {
|
|
return static::printDirective($directive, $options);
|
|
},
|
|
$directives
|
|
),
|
|
array_map(
|
|
static function ($type) use ($options) : string {
|
|
return static::printType($type, $options);
|
|
},
|
|
$types
|
|
)
|
|
)
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
protected static function printSchemaDefinition(Schema $schema) : string
|
|
{
|
|
if (static::isSchemaOfCommonNames($schema)) {
|
|
return '';
|
|
}
|
|
|
|
$operationTypes = [];
|
|
|
|
$queryType = $schema->getQueryType();
|
|
if ($queryType !== null) {
|
|
$operationTypes[] = sprintf(' query: %s', $queryType->name);
|
|
}
|
|
|
|
$mutationType = $schema->getMutationType();
|
|
if ($mutationType !== null) {
|
|
$operationTypes[] = sprintf(' mutation: %s', $mutationType->name);
|
|
}
|
|
|
|
$subscriptionType = $schema->getSubscriptionType();
|
|
if ($subscriptionType !== null) {
|
|
$operationTypes[] = sprintf(' subscription: %s', $subscriptionType->name);
|
|
}
|
|
|
|
return sprintf("schema {\n%s\n}", implode("\n", $operationTypes));
|
|
}
|
|
|
|
/**
|
|
* GraphQL schema define root types for each type of operation. These types are
|
|
* the same as any other type and can be named in any manner, however there is
|
|
* a common naming convention:
|
|
*
|
|
* schema {
|
|
* query: Query
|
|
* mutation: Mutation
|
|
* }
|
|
*
|
|
* When using this naming convention, the schema description can be omitted.
|
|
*/
|
|
protected static function isSchemaOfCommonNames(Schema $schema) : bool
|
|
{
|
|
$queryType = $schema->getQueryType();
|
|
if ($queryType !== null && $queryType->name !== 'Query') {
|
|
return false;
|
|
}
|
|
|
|
$mutationType = $schema->getMutationType();
|
|
if ($mutationType !== null && $mutationType->name !== 'Mutation') {
|
|
return false;
|
|
}
|
|
|
|
$subscriptionType = $schema->getSubscriptionType();
|
|
|
|
return $subscriptionType === null || $subscriptionType->name === 'Subscription';
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
protected static function printDirective(Directive $directive, array $options) : string
|
|
{
|
|
return static::printDescription($options, $directive)
|
|
. 'directive @' . $directive->name
|
|
. static::printArgs($options, $directive->args)
|
|
. ($directive->isRepeatable ? ' repeatable' : '')
|
|
. ' on ' . implode(' | ', $directive->locations);
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
protected static function printDescription(array $options, $def, $indentation = '', $firstInBlock = true) : string
|
|
{
|
|
if (! $def->description) {
|
|
return '';
|
|
}
|
|
$lines = static::descriptionLines($def->description, 120 - strlen($indentation));
|
|
if (isset($options['commentDescriptions'])) {
|
|
return static::printDescriptionWithComments($lines, $indentation, $firstInBlock);
|
|
}
|
|
|
|
$description = $indentation && ! $firstInBlock
|
|
? "\n" . $indentation . '"""'
|
|
: $indentation . '"""';
|
|
|
|
// In some circumstances, a single line can be used for the description.
|
|
if (count($lines) === 1 &&
|
|
mb_strlen($lines[0]) < 70 &&
|
|
substr($lines[0], -1) !== '"'
|
|
) {
|
|
return $description . static::escapeQuote($lines[0]) . "\"\"\"\n";
|
|
}
|
|
|
|
// Format a multi-line block quote to account for leading space.
|
|
$hasLeadingSpace = isset($lines[0]) &&
|
|
(
|
|
substr($lines[0], 0, 1) === ' ' ||
|
|
substr($lines[0], 0, 1) === '\t'
|
|
);
|
|
if (! $hasLeadingSpace) {
|
|
$description .= "\n";
|
|
}
|
|
|
|
$lineLength = count($lines);
|
|
for ($i = 0; $i < $lineLength; $i++) {
|
|
if ($i !== 0 || ! $hasLeadingSpace) {
|
|
$description .= $indentation;
|
|
}
|
|
$description .= static::escapeQuote($lines[$i]) . "\n";
|
|
}
|
|
$description .= $indentation . "\"\"\"\n";
|
|
|
|
return $description;
|
|
}
|
|
|
|
/**
|
|
* @return string[]
|
|
*/
|
|
protected static function descriptionLines(string $description, int $maxLen) : array
|
|
{
|
|
$lines = [];
|
|
$rawLines = explode("\n", $description);
|
|
foreach ($rawLines as $line) {
|
|
if ($line === '') {
|
|
$lines[] = $line;
|
|
} else {
|
|
// For > 120 character long lines, cut at space boundaries into sublines
|
|
// of ~80 chars.
|
|
$sublines = static::breakLine($line, $maxLen);
|
|
foreach ($sublines as $subline) {
|
|
$lines[] = $subline;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $lines;
|
|
}
|
|
|
|
/**
|
|
* @return string[]
|
|
*/
|
|
protected static function breakLine(string $line, int $maxLen) : array
|
|
{
|
|
if (strlen($line) < $maxLen + 5) {
|
|
return [$line];
|
|
}
|
|
preg_match_all('/((?: |^).{15,' . ($maxLen - 40) . '}(?= |$))/', $line, $parts);
|
|
$parts = $parts[0];
|
|
|
|
return array_map('trim', $parts);
|
|
}
|
|
|
|
protected static function printDescriptionWithComments($lines, $indentation, $firstInBlock) : string
|
|
{
|
|
$description = $indentation && ! $firstInBlock ? "\n" : '';
|
|
foreach ($lines as $line) {
|
|
if ($line === '') {
|
|
$description .= $indentation . "#\n";
|
|
} else {
|
|
$description .= $indentation . '# ' . $line . "\n";
|
|
}
|
|
}
|
|
|
|
return $description;
|
|
}
|
|
|
|
protected static function escapeQuote($line) : string
|
|
{
|
|
return str_replace('"""', '\\"""', $line);
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
protected static function printArgs(array $options, $args, $indentation = '') : string
|
|
{
|
|
if (! $args) {
|
|
return '';
|
|
}
|
|
|
|
// If every arg does not have a description, print them on one line.
|
|
if (Utils::every(
|
|
$args,
|
|
static function ($arg) : bool {
|
|
return strlen($arg->description ?? '') === 0;
|
|
}
|
|
)) {
|
|
return '(' . implode(', ', array_map('static::printInputValue', $args)) . ')';
|
|
}
|
|
|
|
return sprintf(
|
|
"(\n%s\n%s)",
|
|
implode(
|
|
"\n",
|
|
array_map(
|
|
static function ($arg, $i) use ($indentation, $options) : string {
|
|
return static::printDescription($options, $arg, ' ' . $indentation, ! $i) . ' ' . $indentation .
|
|
static::printInputValue($arg);
|
|
},
|
|
$args,
|
|
array_keys($args)
|
|
)
|
|
),
|
|
$indentation
|
|
);
|
|
}
|
|
|
|
protected static function printInputValue($arg) : string
|
|
{
|
|
$argDecl = $arg->name . ': ' . $arg->getType();
|
|
if ($arg->defaultValueExists()) {
|
|
$argDecl .= ' = ' . Printer::doPrint(AST::astFromValue($arg->defaultValue, $arg->getType()));
|
|
}
|
|
|
|
return $argDecl;
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
public static function printType(Type $type, array $options = []) : string
|
|
{
|
|
if ($type instanceof ScalarType) {
|
|
return static::printScalar($type, $options);
|
|
}
|
|
|
|
if ($type instanceof ObjectType) {
|
|
return static::printObject($type, $options);
|
|
}
|
|
|
|
if ($type instanceof InterfaceType) {
|
|
return static::printInterface($type, $options);
|
|
}
|
|
|
|
if ($type instanceof UnionType) {
|
|
return static::printUnion($type, $options);
|
|
}
|
|
|
|
if ($type instanceof EnumType) {
|
|
return static::printEnum($type, $options);
|
|
}
|
|
|
|
if ($type instanceof InputObjectType) {
|
|
return static::printInputObject($type, $options);
|
|
}
|
|
|
|
throw new Error(sprintf('Unknown type: %s.', Utils::printSafe($type)));
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
protected static function printScalar(ScalarType $type, array $options) : string
|
|
{
|
|
return sprintf('%sscalar %s', static::printDescription($options, $type), $type->name);
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
protected static function printObject(ObjectType $type, array $options) : string
|
|
{
|
|
$interfaces = $type->getInterfaces();
|
|
$implementedInterfaces = count($interfaces) > 0
|
|
? ' implements ' . implode(
|
|
' & ',
|
|
array_map(
|
|
static function (InterfaceType $interface) : string {
|
|
return $interface->name;
|
|
},
|
|
$interfaces
|
|
)
|
|
)
|
|
: '';
|
|
|
|
return static::printDescription($options, $type) .
|
|
sprintf("type %s%s {\n%s\n}", $type->name, $implementedInterfaces, static::printFields($options, $type));
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
protected static function printFields(array $options, $type) : string
|
|
{
|
|
$fields = array_values($type->getFields());
|
|
|
|
return implode(
|
|
"\n",
|
|
array_map(
|
|
static function ($f, $i) use ($options) : string {
|
|
return static::printDescription($options, $f, ' ', ! $i) . ' ' .
|
|
$f->name . static::printArgs($options, $f->args, ' ') . ': ' .
|
|
$f->getType() . static::printDeprecated($f);
|
|
},
|
|
$fields,
|
|
array_keys($fields)
|
|
)
|
|
);
|
|
}
|
|
|
|
protected static function printDeprecated($fieldOrEnumVal) : string
|
|
{
|
|
$reason = $fieldOrEnumVal->deprecationReason;
|
|
if ($reason === null) {
|
|
return '';
|
|
}
|
|
if ($reason === '' || $reason === Directive::DEFAULT_DEPRECATION_REASON) {
|
|
return ' @deprecated';
|
|
}
|
|
|
|
return ' @deprecated(reason: ' .
|
|
Printer::doPrint(AST::astFromValue($reason, Type::string())) . ')';
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
protected static function printInterface(InterfaceType $type, array $options) : string
|
|
{
|
|
$interfaces = $type->getInterfaces();
|
|
$implementedInterfaces = count($interfaces) > 0
|
|
? ' implements ' . implode(
|
|
' & ',
|
|
array_map(
|
|
static function (InterfaceType $interface) : string {
|
|
return $interface->name;
|
|
},
|
|
$interfaces
|
|
)
|
|
)
|
|
: '';
|
|
|
|
return static::printDescription($options, $type) .
|
|
sprintf("interface %s%s {\n%s\n}", $type->name, $implementedInterfaces, static::printFields($options, $type));
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
protected static function printUnion(UnionType $type, array $options) : string
|
|
{
|
|
return static::printDescription($options, $type) .
|
|
sprintf('union %s = %s', $type->name, implode(' | ', $type->getTypes()));
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
protected static function printEnum(EnumType $type, array $options) : string
|
|
{
|
|
return static::printDescription($options, $type) .
|
|
sprintf("enum %s {\n%s\n}", $type->name, static::printEnumValues($type->getValues(), $options));
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
protected static function printEnumValues($values, array $options) : string
|
|
{
|
|
return implode(
|
|
"\n",
|
|
array_map(
|
|
static function ($value, $i) use ($options) : string {
|
|
return static::printDescription($options, $value, ' ', ! $i) . ' ' .
|
|
$value->name . static::printDeprecated($value);
|
|
},
|
|
$values,
|
|
array_keys($values)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*/
|
|
protected static function printInputObject(InputObjectType $type, array $options) : string
|
|
{
|
|
$fields = array_values($type->getFields());
|
|
|
|
return static::printDescription($options, $type) .
|
|
sprintf(
|
|
"input %s {\n%s\n}",
|
|
$type->name,
|
|
implode(
|
|
"\n",
|
|
array_map(
|
|
static function ($f, $i) use ($options) : string {
|
|
return static::printDescription($options, $f, ' ', ! $i) . ' ' . static::printInputValue($f);
|
|
},
|
|
$fields,
|
|
array_keys($fields)
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $options
|
|
*
|
|
* @api
|
|
*/
|
|
public static function printIntrospectionSchema(Schema $schema, array $options = []) : string
|
|
{
|
|
return static::printFilteredSchema(
|
|
$schema,
|
|
[Directive::class, 'isSpecifiedDirective'],
|
|
[Introspection::class, 'isIntrospectionType'],
|
|
$options
|
|
);
|
|
}
|
|
}
|