*/ private $typeDefinitionsMap; /** @var callable */ private $typeConfigDecorator; /** @var array */ private $options; /** @var callable */ private $resolveType; /** @var array */ private $cache; /** * code sniffer doesn't understand this syntax. Pr with a fix here: waiting on https://github.com/squizlabs/PHP_CodeSniffer/pull/2919 * phpcs:disable Squiz.Commenting.FunctionComment.SpacingAfterParamType * @param array $typeDefinitionsMap * @param array $options */ public function __construct( array $typeDefinitionsMap, array $options, callable $resolveType, ?callable $typeConfigDecorator = null ) { $this->typeDefinitionsMap = $typeDefinitionsMap; $this->typeConfigDecorator = $typeConfigDecorator; $this->options = $options; $this->resolveType = $resolveType; $this->cache = Type::getAllBuiltInTypes(); } public function buildDirective(DirectiveDefinitionNode $directiveNode) : Directive { return new Directive([ 'name' => $directiveNode->name->value, 'description' => $this->getDescription($directiveNode), 'args' => FieldArgument::createMap($this->makeInputValues($directiveNode->arguments)), 'isRepeatable' => $directiveNode->repeatable, 'locations' => Utils::map( $directiveNode->locations, static function (NameNode $node) : string { return $node->value; } ), 'astNode' => $directiveNode, ]); } /** * Given an ast node, returns its string description. */ private function getDescription(Node $node) : ?string { if (isset($node->description)) { return $node->description->value; } if (isset($this->options['commentDescriptions'])) { $rawValue = $this->getLeadingCommentBlock($node); if ($rawValue !== null) { return BlockString::value("\n" . $rawValue); } } return null; } private function getLeadingCommentBlock(Node $node) : ?string { $loc = $node->loc; if ($loc === null || $loc->startToken === null) { return null; } $comments = []; $token = $loc->startToken->prev; while ($token !== null && $token->kind === Token::COMMENT && $token->next !== null && $token->prev !== null && $token->line + 1 === $token->next->line && $token->line !== $token->prev->line ) { $value = $token->value; $comments[] = $value; $token = $token->prev; } return implode("\n", array_reverse($comments)); } /** * @return array> */ private function makeInputValues(NodeList $values) : array { return Utils::keyValMap( $values, static function (InputValueDefinitionNode $value) : string { return $value->name->value; }, function (InputValueDefinitionNode $value) : array { // Note: While this could make assertions to get the correctly typed // value, that would throw immediately while type system validation // with validateSchema() will produce more actionable results. $type = $this->buildWrappedType($value->type); $config = [ 'name' => $value->name->value, 'type' => $type, 'description' => $this->getDescription($value), 'astNode' => $value, ]; if (isset($value->defaultValue)) { $config['defaultValue'] = AST::valueFromAST($value->defaultValue, $type); } return $config; } ); } private function buildWrappedType(TypeNode $typeNode) : Type { if ($typeNode instanceof ListTypeNode) { return Type::listOf($this->buildWrappedType($typeNode->type)); } if ($typeNode instanceof NonNullTypeNode) { return Type::nonNull($this->buildWrappedType($typeNode->type)); } return $this->buildType($typeNode); } /** * @param string|(Node &NamedTypeNode)|(Node&TypeDefinitionNode) $ref */ public function buildType($ref) : Type { if (is_string($ref)) { return $this->internalBuildType($ref); } return $this->internalBuildType($ref->name->value, $ref); } /** * @param (Node &NamedTypeNode)|(Node&TypeDefinitionNode)|null $typeNode * * @throws Error */ private function internalBuildType(string $typeName, ?Node $typeNode = null) : Type { if (! isset($this->cache[$typeName])) { if (isset($this->typeDefinitionsMap[$typeName])) { $type = $this->makeSchemaDef($this->typeDefinitionsMap[$typeName]); if ($this->typeConfigDecorator) { $fn = $this->typeConfigDecorator; try { $config = $fn($type->config, $this->typeDefinitionsMap[$typeName], $this->typeDefinitionsMap); } catch (Throwable $e) { throw new Error( sprintf('Type config decorator passed to %s threw an error ', static::class) . sprintf('when building %s type: %s', $typeName, $e->getMessage()), null, null, [], null, $e ); } if (! is_array($config) || isset($config[0])) { throw new Error( sprintf( 'Type config decorator passed to %s is expected to return an array, but got %s', static::class, Utils::getVariableType($config) ) ); } $type = $this->makeSchemaDefFromConfig($this->typeDefinitionsMap[$typeName], $config); } $this->cache[$typeName] = $type; } else { $fn = $this->resolveType; $this->cache[$typeName] = $fn($typeName, $typeNode); } } return $this->cache[$typeName]; } /** * @param ObjectTypeDefinitionNode|InterfaceTypeDefinitionNode|EnumTypeDefinitionNode|ScalarTypeDefinitionNode|InputObjectTypeDefinitionNode|UnionTypeDefinitionNode $def * * @return CustomScalarType|EnumType|InputObjectType|InterfaceType|ObjectType|UnionType * * @throws Error */ private function makeSchemaDef(Node $def) : Type { switch (true) { case $def instanceof ObjectTypeDefinitionNode: return $this->makeTypeDef($def); case $def instanceof InterfaceTypeDefinitionNode: return $this->makeInterfaceDef($def); case $def instanceof EnumTypeDefinitionNode: return $this->makeEnumDef($def); case $def instanceof UnionTypeDefinitionNode: return $this->makeUnionDef($def); case $def instanceof ScalarTypeDefinitionNode: return $this->makeScalarDef($def); case $def instanceof InputObjectTypeDefinitionNode: return $this->makeInputObjectDef($def); default: throw new Error(sprintf('Type kind of %s not supported.', $def->kind)); } } private function makeTypeDef(ObjectTypeDefinitionNode $def) : ObjectType { return new ObjectType([ 'name' => $def->name->value, 'description' => $this->getDescription($def), 'fields' => function () use ($def) : array { return $this->makeFieldDefMap($def); }, 'interfaces' => function () use ($def) : array { return $this->makeImplementedInterfaces($def); }, 'astNode' => $def, ]); } /** * @param ObjectTypeDefinitionNode|InterfaceTypeDefinitionNode $def * * @return array> */ private function makeFieldDefMap(Node $def) : array { return Utils::keyValMap( $def->fields, static function (FieldDefinitionNode $field) : string { return $field->name->value; }, function (FieldDefinitionNode $field) : array { return $this->buildField($field); } ); } /** * @return array */ public function buildField(FieldDefinitionNode $field) : array { return [ // Note: While this could make assertions to get the correctly typed // value, that would throw immediately while type system validation // with validateSchema() will produce more actionable results. 'type' => $this->buildWrappedType($field->type), 'description' => $this->getDescription($field), 'args' => $this->makeInputValues($field->arguments), 'deprecationReason' => $this->getDeprecationReason($field), 'astNode' => $field, ]; } /** * Given a collection of directives, returns the string value for the * deprecation reason. * * @param EnumValueDefinitionNode|FieldDefinitionNode $node */ private function getDeprecationReason(Node $node) : ?string { $deprecated = Values::getDirectiveValues( Directive::deprecatedDirective(), $node ); return $deprecated['reason'] ?? null; } /** * @param ObjectTypeDefinitionNode|InterfaceTypeDefinitionNode $def * * @return array */ private function makeImplementedInterfaces($def) : array { // Note: While this could make early assertions to get the correctly // typed values, that would throw immediately while type system // validation with validateSchema() will produce more actionable results. return Utils::map( $def->interfaces, function (NamedTypeNode $iface) : Type { return $this->buildType($iface); } ); } private function makeInterfaceDef(InterfaceTypeDefinitionNode $def) : InterfaceType { return new InterfaceType([ 'name' => $def->name->value, 'description' => $this->getDescription($def), 'fields' => function () use ($def) : array { return $this->makeFieldDefMap($def); }, 'interfaces' => function () use ($def) : array { return $this->makeImplementedInterfaces($def); }, 'astNode' => $def, ]); } private function makeEnumDef(EnumTypeDefinitionNode $def) : EnumType { return new EnumType([ 'name' => $def->name->value, 'description' => $this->getDescription($def), 'values' => Utils::keyValMap( $def->values, static function ($enumValue) { return $enumValue->name->value; }, function ($enumValue) : array { return [ 'description' => $this->getDescription($enumValue), 'deprecationReason' => $this->getDeprecationReason($enumValue), 'astNode' => $enumValue, ]; } ), 'astNode' => $def, ]); } private function makeUnionDef(UnionTypeDefinitionNode $def) : UnionType { return new UnionType([ 'name' => $def->name->value, 'description' => $this->getDescription($def), // Note: While this could make assertions to get the correctly typed // values below, that would throw immediately while type system // validation with validateSchema() will produce more actionable results. 'types' => function () use ($def) : array { return Utils::map( $def->types, function ($typeNode) : Type { return $this->buildType($typeNode); } ); }, 'astNode' => $def, ]); } private function makeScalarDef(ScalarTypeDefinitionNode $def) : CustomScalarType { return new CustomScalarType([ 'name' => $def->name->value, 'description' => $this->getDescription($def), 'astNode' => $def, 'serialize' => static function ($value) { return $value; }, ]); } private function makeInputObjectDef(InputObjectTypeDefinitionNode $def) : InputObjectType { return new InputObjectType([ 'name' => $def->name->value, 'description' => $this->getDescription($def), 'fields' => function () use ($def) : array { return $this->makeInputValues($def->fields); }, 'astNode' => $def, ]); } /** * @param array $config * * @return CustomScalarType|EnumType|InputObjectType|InterfaceType|ObjectType|UnionType * * @throws Error */ private function makeSchemaDefFromConfig(Node $def, array $config) : Type { switch (true) { case $def instanceof ObjectTypeDefinitionNode: return new ObjectType($config); case $def instanceof InterfaceTypeDefinitionNode: return new InterfaceType($config); case $def instanceof EnumTypeDefinitionNode: return new EnumType($config); case $def instanceof UnionTypeDefinitionNode: return new UnionType($config); case $def instanceof ScalarTypeDefinitionNode: return new CustomScalarType($config); case $def instanceof InputObjectTypeDefinitionNode: return new InputObjectType($config); default: throw new Error(sprintf('Type kind of %s not supported.', $def->kind)); } } /** * @return array */ public function buildInputField(InputValueDefinitionNode $value) : array { $type = $this->buildWrappedType($value->type); $config = [ 'name' => $value->name->value, 'type' => $type, 'description' => $this->getDescription($value), 'astNode' => $value, ]; if ($value->defaultValue !== null) { $config['defaultValue'] = $value->defaultValue; } return $config; } /** * @return array */ public function buildEnumValue(EnumValueDefinitionNode $value) : array { return [ 'description' => $this->getDescription($value), 'deprecationReason' => $this->getDeprecationReason($value), 'astNode' => $value, ]; } }