Symfony Profiler

<?php
declare(strict_types=1);
namespace GraphQL\Type;
use Generator;
use GraphQL\Error\Error;
use GraphQL\Error\InvariantViolation;
use GraphQL\GraphQL;
use GraphQL\Language\AST\SchemaDefinitionNode;
use GraphQL\Language\AST\SchemaTypeExtensionNode;
use GraphQL\Type\Definition\AbstractType;
use GraphQL\Type\Definition\Directive;
use GraphQL\Type\Definition\ImplementingType;
use GraphQL\Type\Definition\InterfaceType;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
use GraphQL\Type\Definition\UnionType;
use GraphQL\Utils\InterfaceImplementations;
use GraphQL\Utils\TypeInfo;
use GraphQL\Utils\Utils;
use InvalidArgumentException;
use Traversable;
use function array_map;
use function get_class;
use function implode;
use function is_array;
use function is_callable;
use function sprintf;
/**
* Schema Definition (see [related docs](type-system/schema.md))
*
* A Schema is created by supplying the root types of each type of operation:
* query, mutation (optional) and subscription (optional). A schema definition is
* then supplied to the validator and executor. Usage Example:
*
* $schema = new GraphQL\Type\Schema([
* 'query' => $MyAppQueryRootType,
* 'mutation' => $MyAppMutationRootType,
* ]);
*
* Or using Schema Config instance:
*
* $config = GraphQL\Type\SchemaConfig::create()
* ->setQuery($MyAppQueryRootType)
* ->setMutation($MyAppMutationRootType);
*
* $schema = new GraphQL\Type\Schema($config);
*/
class Schema
{
/** @var SchemaConfig */
private $config;
/**
* Contains currently resolved schema types
*
* @var Type[]
*/
private $resolvedTypes = [];
/**
* Lazily initialised.
*
* @var array<string, InterfaceImplementations>
*/
private $implementationsMap;
/**
* True when $resolvedTypes contain all possible schema types
*
* @var bool
*/
private $fullyLoaded = false;
/** @var Error[] */
private $validationErrors;
/** @var SchemaTypeExtensionNode[] */
public $extensionASTNodes = [];
/**
* @param mixed[]|SchemaConfig $config
*
* @api
*/
public function __construct($config)
{
if (is_array($config)) {
$config = SchemaConfig::create($config);
}
// If this schema was built from a source known to be valid, then it may be
// marked with assumeValid to avoid an additional type system validation.
if ($config->getAssumeValid()) {
$this->validationErrors = [];
} else {
// Otherwise check for common mistakes during construction to produce
// clear and early error messages.
Utils::invariant(
$config instanceof SchemaConfig,
'Schema constructor expects instance of GraphQL\Type\SchemaConfig or an array with keys: %s; but got: %s',
implode(
', ',
[
'query',
'mutation',
'subscription',
'types',
'directives',
'typeLoader',
]
),
Utils::getVariableType($config)
);
Utils::invariant(
! $config->types || is_array($config->types) || is_callable($config->types),
'"types" must be array or callable if provided but got: ' . Utils::getVariableType($config->types)
);
Utils::invariant(
$config->directives === null || is_array($config->directives),
'"directives" must be Array if provided but got: ' . Utils::getVariableType($config->directives)
);
}
$this->config = $config;
$this->extensionASTNodes = $config->extensionASTNodes;
if ($config->query !== null) {
$this->resolvedTypes[$config->query->name] = $config->query;
}
if ($config->mutation !== null) {
$this->resolvedTypes[$config->mutation->name] = $config->mutation;
}
if ($config->subscription !== null) {
$this->resolvedTypes[$config->subscription->name] = $config->subscription;
}
if (is_array($this->config->types)) {
foreach ($this->resolveAdditionalTypes() as $type) {
if (isset($this->resolvedTypes[$type->name])) {
Utils::invariant(
$type === $this->resolvedTypes[$type->name],
sprintf(
'Schema must contain unique named types but contains multiple types named "%s" (see http://webonyx.github.io/graphql-php/type-system/#type-registry).',
$type
)
);
}
$this->resolvedTypes[$type->name] = $type;
}
}
$this->resolvedTypes += Type::getStandardTypes() + Introspection::getTypes();
if ($this->config->typeLoader) {
return;
}
// Perform full scan of the schema
$this->getTypeMap();
}
/**
* @return Generator
*/
private function resolveAdditionalTypes()
{
$types = $this->config->types ?? [];
if (is_callable($types)) {
$types = $types();
}
if (! is_array($types) && ! $types instanceof Traversable) {
throw new InvariantViolation(sprintf(
'Schema types callable must return array or instance of Traversable but got: %s',
Utils::getVariableType($types)
));
}
foreach ($types as $index => $type) {
$type = self::resolveType($type);
if (! $type instanceof Type) {
throw new InvariantViolation(sprintf(
'Each entry of schema types must be instance of GraphQL\Type\Definition\Type but entry at %s is %s',
$index,
Utils::printSafe($type)
));
}
yield $type;
}
}
/**
* Returns array of all types in this schema. Keys of this array represent type names, values are instances
* of corresponding type definitions
*
* This operation requires full schema scan. Do not use in production environment.
*
* @return array<string, Type>
*
* @api
*/
public function getTypeMap() : array
{
if (! $this->fullyLoaded) {
$this->resolvedTypes = $this->collectAllTypes();
$this->fullyLoaded = true;
}
return $this->resolvedTypes;
}
/**
* @return Type[]
*/
private function collectAllTypes()
{
$typeMap = [];
foreach ($this->resolvedTypes as $type) {
$typeMap = TypeInfo::extractTypes($type, $typeMap);
}
foreach ($this->getDirectives() as $directive) {
if (! ($directive instanceof Directive)) {
continue;
}
$typeMap = TypeInfo::extractTypesFromDirectives($directive, $typeMap);
}
// When types are set as array they are resolved in constructor
if (is_callable($this->config->types)) {
foreach ($this->resolveAdditionalTypes() as $type) {
$typeMap = TypeInfo::extractTypes($type, $typeMap);
}
}
return $typeMap;
}
/**
* Returns a list of directives supported by this schema
*
* @return Directive[]
*
* @api
*/
public function getDirectives()
{
return $this->config->directives ?? GraphQL::getStandardDirectives();
}
/**
* @param string $operation
*
* @return ObjectType|null
*/
public function getOperationType($operation)
{
switch ($operation) {
case 'query':
return $this->getQueryType();
case 'mutation':
return $this->getMutationType();
case 'subscription':
return $this->getSubscriptionType();
default:
return null;
}
}
/**
* Returns schema query type
*
* @return ObjectType
*
* @api
*/
public function getQueryType() : ?Type
{
return $this->config->query;
}
/**
* Returns schema mutation type
*
* @return ObjectType|null
*
* @api
*/
public function getMutationType() : ?Type
{
return $this->config->mutation;
}
/**
* Returns schema subscription
*
* @return ObjectType|null
*
* @api
*/
public function getSubscriptionType() : ?Type
{
return $this->config->subscription;
}
/**
* @return SchemaConfig
*
* @api
*/
public function getConfig()
{
return $this->config;
}
/**
* Returns type by its name
*
* @api
*/
public function getType(string $name) : ?Type
{
if (! isset($this->resolvedTypes[$name])) {
$type = $this->loadType($name);
if (! $type) {
return null;
}
$this->resolvedTypes[$name] = self::resolveType($type);
}
return $this->resolvedTypes[$name];
}
public function hasType(string $name) : bool
{
return $this->getType($name) !== null;
}
private function loadType(string $typeName) : ?Type
{
$typeLoader = $this->config->typeLoader;
if (! isset($typeLoader)) {
return $this->defaultTypeLoader($typeName);
}
$type = $typeLoader($typeName);
if (! $type instanceof Type) {
// Unless you know what you're doing, kindly resist the temptation to refactor or simplify this block. The
// twisty logic here is tuned for performance, and meant to prioritize the "happy path" (the result returned
// from the type loader is already a Type), and only checks for callable if that fails. If the result is
// neither a Type nor a callable, then we throw an exception.
if (is_callable($type)) {
$type = $type();
if (! $type instanceof Type) {
$this->throwNotAType($type, $typeName);
}
} else {
$this->throwNotAType($type, $typeName);
}
}
if ($type->name !== $typeName) {
throw new InvariantViolation(
sprintf('Type loader is expected to return type "%s", but it returned "%s"', $typeName, $type->name)
);
}
return $type;
}
protected function throwNotAType($type, string $typeName)
{
throw new InvariantViolation(
sprintf(
'Type loader is expected to return a callable or valid type "%s", but it returned %s',
$typeName,
Utils::printSafe($type)
)
);
}
private function defaultTypeLoader(string $typeName) : ?Type
{
// Default type loader simply falls back to collecting all types
$typeMap = $this->getTypeMap();
return $typeMap[$typeName] ?? null;
}
/**
* @param Type|callable():Type $type
*/
public static function resolveType($type) : Type
{
if ($type instanceof Type) {
return $type;
}
return $type();
}
/**
* Returns all possible concrete types for given abstract type
* (implementations for interfaces and members of union type for unions)
*
* This operation requires full schema scan. Do not use in production environment.
*
* @param InterfaceType|UnionType $abstractType
*
* @return array<Type&ObjectType>
*
* @api
*/
public function getPossibleTypes(Type $abstractType) : array
{
return $abstractType instanceof UnionType
? $abstractType->getTypes()
: $this->getImplementations($abstractType)->objects();
}
/**
* Returns all types that implement a given interface type.
*
* This operations requires full schema scan. Do not use in production environment.
*
* @api
*/
public function getImplementations(InterfaceType $abstractType) : InterfaceImplementations
{
return $this->collectImplementations()[$abstractType->name];
}
/**
* @return array<string, InterfaceImplementations>
*/
private function collectImplementations() : array
{
if (! isset($this->implementationsMap)) {
/** @var array<string, array<string, Type>> $foundImplementations */
$foundImplementations = [];
foreach ($this->getTypeMap() as $type) {
if ($type instanceof InterfaceType) {
if (! isset($foundImplementations[$type->name])) {
$foundImplementations[$type->name] = ['objects' => [], 'interfaces' => []];
}
foreach ($type->getInterfaces() as $iface) {
if (! isset($foundImplementations[$iface->name])) {
$foundImplementations[$iface->name] = ['objects' => [], 'interfaces' => []];
}
$foundImplementations[$iface->name]['interfaces'][] = $type;
}
} elseif ($type instanceof ObjectType) {
foreach ($type->getInterfaces() as $iface) {
if (! isset($foundImplementations[$iface->name])) {
$foundImplementations[$iface->name] = ['objects' => [], 'interfaces' => []];
}
$foundImplementations[$iface->name]['objects'][] = $type;
}
}
}
$this->implementationsMap = array_map(
static function (array $implementations) : InterfaceImplementations {
return new InterfaceImplementations($implementations['objects'], $implementations['interfaces']);
},
$foundImplementations
);
}
return $this->implementationsMap;
}
/**
* @deprecated as of 14.4.0 use isSubType instead, will be removed in 15.0.0.
*
* Returns true if object type is concrete type of given abstract type
* (implementation for interfaces and members of union type for unions)
*
* @api
* @codeCoverageIgnore
*/
public function isPossibleType(AbstractType $abstractType, ObjectType $possibleType) : bool
{
return $this->isSubType($abstractType, $possibleType);
}
/**
* Returns true if the given type is a sub type of the given abstract type.
*
* @param UnionType|InterfaceType $abstractType
* @param ObjectType|InterfaceType $maybeSubType
*
* @api
*/
public function isSubType(AbstractType $abstractType, ImplementingType $maybeSubType) : bool
{
if ($abstractType instanceof InterfaceType) {
return $maybeSubType->implementsInterface($abstractType);
}
if ($abstractType instanceof UnionType) {
return $abstractType->isPossibleType($maybeSubType);
}
throw new InvalidArgumentException(sprintf('$abstractType must be of type UnionType|InterfaceType got: %s.', get_class($abstractType)));
}
/**
* Returns instance of directive by name
*
* @api
*/
public function getDirective(string $name) : ?Directive
{
foreach ($this->getDirectives() as $directive) {
if ($directive->name === $name) {
return $directive;
}
}
return null;
}
public function getAstNode() : ?SchemaDefinitionNode
{
return $this->config->getAstNode();
}
/**
* Validates schema.
*
* This operation requires full schema scan. Do not use in production environment.
*
* @throws InvariantViolation
*
* @api
*/
public function assertValid()
{
$errors = $this->validate();
if ($errors) {
throw new InvariantViolation(implode("\n\n", $this->validationErrors));
}
$internalTypes = Type::getStandardTypes() + Introspection::getTypes();
foreach ($this->getTypeMap() as $name => $type) {
if (isset($internalTypes[$name])) {
continue;
}
$type->assertValid();
// Make sure type loader returns the same instance as registered in other places of schema
if (! $this->config->typeLoader) {
continue;
}
Utils::invariant(
$this->loadType($name) === $type,
sprintf(
'Type loader returns different instance for %s than field/argument definitions. Make sure you always return the same instance for the same type name.',
$name
)
);
}
}
/**
* Validates schema.
*
* This operation requires full schema scan. Do not use in production environment.
*
* @return InvariantViolation[]|Error[]
*
* @api
*/
public function validate()
{
// If this Schema has already been validated, return the previous results.
if ($this->validationErrors !== null) {
return $this->validationErrors;
}
// Validate the schema, producing a list of errors.
$context = new SchemaValidationContext($this);
$context->validateRootTypes();
$context->validateDirectives();
$context->validateTypes();
// Persist the results of validation before returning to ensure validation
// does not run multiple times for this schema.
$this->validationErrors = $context->getErrors();
return $this->validationErrors;
}
}

vendor/webonyx/graphql-php/src/Type/Schema.php line 594