exeContext = $context; $this->subFieldCache = new SplObjectStorage(); } /** * @param mixed $rootValue * @param mixed $contextValue * @param array|Traversable $variableValues */ public static function create( PromiseAdapter $promiseAdapter, Schema $schema, DocumentNode $documentNode, $rootValue, $contextValue, $variableValues, ?string $operationName, callable $fieldResolver ) : ExecutorImplementation { $exeContext = static::buildExecutionContext( $schema, $documentNode, $rootValue, $contextValue, $variableValues, $operationName, $fieldResolver, $promiseAdapter ); if (is_array($exeContext)) { return new class($promiseAdapter->createFulfilled(new ExecutionResult(null, $exeContext))) implements ExecutorImplementation { /** @var Promise */ private $result; public function __construct(Promise $result) { $this->result = $result; } public function doExecute() : Promise { return $this->result; } }; } return new static($exeContext); } /** * Constructs an ExecutionContext object from the arguments passed to * execute, which we will pass throughout the other execution methods. * * @param mixed $rootValue * @param mixed $contextValue * @param array|Traversable $rawVariableValues * * @return ExecutionContext|array */ protected static function buildExecutionContext( Schema $schema, DocumentNode $documentNode, $rootValue, $contextValue, $rawVariableValues, ?string $operationName = null, ?callable $fieldResolver = null, ?PromiseAdapter $promiseAdapter = null ) { $errors = []; $fragments = []; /** @var OperationDefinitionNode|null $operation */ $operation = null; $hasMultipleAssumedOperations = false; foreach ($documentNode->definitions as $definition) { switch (true) { case $definition instanceof OperationDefinitionNode: if ($operationName === null && $operation !== null) { $hasMultipleAssumedOperations = true; } if ($operationName === null || (isset($definition->name) && $definition->name->value === $operationName)) { $operation = $definition; } break; case $definition instanceof FragmentDefinitionNode: $fragments[$definition->name->value] = $definition; break; } } if ($operation === null) { if ($operationName === null) { $errors[] = new Error('Must provide an operation.'); } else { $errors[] = new Error(sprintf('Unknown operation named "%s".', $operationName)); } } elseif ($hasMultipleAssumedOperations) { $errors[] = new Error( 'Must provide operation name if query contains multiple operations.' ); } $variableValues = null; if ($operation !== null) { [$coercionErrors, $coercedVariableValues] = Values::getVariableValues( $schema, $operation->variableDefinitions ?? [], $rawVariableValues ?? [] ); if (count($coercionErrors ?? []) === 0) { $variableValues = $coercedVariableValues; } else { $errors = array_merge($errors, $coercionErrors); } } if (count($errors) > 0) { return $errors; } Utils::invariant($operation, 'Has operation if no errors.'); Utils::invariant($variableValues !== null, 'Has variables if no errors.'); return new ExecutionContext( $schema, $fragments, $rootValue, $contextValue, $operation, $variableValues, $errors, $fieldResolver, $promiseAdapter ); } public function doExecute() : Promise { // Return a Promise that will eventually resolve to the data described by // the "Response" section of the GraphQL specification. // // If errors are encountered while executing a GraphQL field, only that // field and its descendants will be omitted, and sibling fields will still // be executed. An execution which encounters errors will still result in a // resolved Promise. $data = $this->executeOperation($this->exeContext->operation, $this->exeContext->rootValue); $result = $this->buildResponse($data); // Note: we deviate here from the reference implementation a bit by always returning promise // But for the "sync" case it is always fulfilled return $this->isPromise($result) ? $result : $this->exeContext->promiseAdapter->createFulfilled($result); } /** * @param mixed|Promise|null $data * * @return ExecutionResult|Promise */ protected function buildResponse($data) { if ($this->isPromise($data)) { return $data->then(function ($resolved) { return $this->buildResponse($resolved); }); } if ($data !== null) { $data = (array) $data; } return new ExecutionResult($data, $this->exeContext->errors); } /** * Implements the "Evaluating operations" section of the spec. * * @param mixed $rootValue * * @return array|Promise|stdClass|null */ protected function executeOperation(OperationDefinitionNode $operation, $rootValue) { $type = $this->getOperationRootType($this->exeContext->schema, $operation); $fields = $this->collectFields($type, $operation->selectionSet, new ArrayObject(), new ArrayObject()); $path = []; // Errors from sub-fields of a NonNull type may propagate to the top level, // at which point we still log the error and null the parent field, which // in this case is the entire response. // // Similar to completeValueCatchingError. try { $result = $operation->operation === 'mutation' ? $this->executeFieldsSerially($type, $rootValue, $path, $fields) : $this->executeFields($type, $rootValue, $path, $fields); if ($this->isPromise($result)) { return $result->then( null, function ($error) : ?Promise { if ($error instanceof Error) { $this->exeContext->addError($error); return $this->exeContext->promiseAdapter->createFulfilled(null); } return null; } ); } return $result; } catch (Error $error) { $this->exeContext->addError($error); return null; } } /** * Extracts the root type of the operation from the schema. * * @throws Error */ protected function getOperationRootType(Schema $schema, OperationDefinitionNode $operation) : ObjectType { switch ($operation->operation) { case 'query': $queryType = $schema->getQueryType(); if ($queryType === null) { throw new Error( 'Schema does not define the required query root type.', [$operation] ); } return $queryType; case 'mutation': $mutationType = $schema->getMutationType(); if ($mutationType === null) { throw new Error( 'Schema is not configured for mutations.', [$operation] ); } return $mutationType; case 'subscription': $subscriptionType = $schema->getSubscriptionType(); if ($subscriptionType === null) { throw new Error( 'Schema is not configured for subscriptions.', [$operation] ); } return $subscriptionType; default: throw new Error( 'Can only execute queries, mutations and subscriptions.', [$operation] ); } } /** * Given a selectionSet, adds all of the fields in that selection to * the passed in map of fields, and returns it at the end. * * CollectFields requires the "runtime type" of an object. For a field which * returns an Interface or Union type, the "runtime type" will be the actual * Object type returned by that field. */ protected function collectFields( ObjectType $runtimeType, SelectionSetNode $selectionSet, ArrayObject $fields, ArrayObject $visitedFragmentNames ) : ArrayObject { $exeContext = $this->exeContext; foreach ($selectionSet->selections as $selection) { switch (true) { case $selection instanceof FieldNode: if (! $this->shouldIncludeNode($selection)) { break; } $name = static::getFieldEntryKey($selection); if (! isset($fields[$name])) { $fields[$name] = new ArrayObject(); } $fields[$name][] = $selection; break; case $selection instanceof InlineFragmentNode: if (! $this->shouldIncludeNode($selection) || ! $this->doesFragmentConditionMatch($selection, $runtimeType) ) { break; } $this->collectFields( $runtimeType, $selection->selectionSet, $fields, $visitedFragmentNames ); break; case $selection instanceof FragmentSpreadNode: $fragName = $selection->name->value; if (($visitedFragmentNames[$fragName] ?? false) === true || ! $this->shouldIncludeNode($selection)) { break; } $visitedFragmentNames[$fragName] = true; /** @var FragmentDefinitionNode|null $fragment */ $fragment = $exeContext->fragments[$fragName] ?? null; if ($fragment === null || ! $this->doesFragmentConditionMatch($fragment, $runtimeType)) { break; } $this->collectFields( $runtimeType, $fragment->selectionSet, $fields, $visitedFragmentNames ); break; } } return $fields; } /** * Determines if a field should be included based on the @include and @skip * directives, where @skip has higher precedence than @include. * * @param FragmentSpreadNode|FieldNode|InlineFragmentNode $node */ protected function shouldIncludeNode(SelectionNode $node) : bool { $variableValues = $this->exeContext->variableValues; $skipDirective = Directive::skipDirective(); $skip = Values::getDirectiveValues( $skipDirective, $node, $variableValues ); if (isset($skip['if']) && $skip['if'] === true) { return false; } $includeDirective = Directive::includeDirective(); $include = Values::getDirectiveValues( $includeDirective, $node, $variableValues ); return ! isset($include['if']) || $include['if'] !== false; } /** * Implements the logic to compute the key of a given fields entry */ protected static function getFieldEntryKey(FieldNode $node) : string { return $node->alias === null ? $node->name->value : $node->alias->value; } /** * Determines if a fragment is applicable to the given type. * * @param FragmentDefinitionNode|InlineFragmentNode $fragment */ protected function doesFragmentConditionMatch(Node $fragment, ObjectType $type) : bool { $typeConditionNode = $fragment->typeCondition; if ($typeConditionNode === null) { return true; } $conditionalType = TypeInfo::typeFromAST($this->exeContext->schema, $typeConditionNode); if ($conditionalType === $type) { return true; } if ($conditionalType instanceof AbstractType) { return $this->exeContext->schema->isSubType($conditionalType, $type); } return false; } /** * Implements the "Evaluating selection sets" section of the spec * for "write" mode. * * @param mixed $rootValue * @param array $path * * @return array|Promise|stdClass */ protected function executeFieldsSerially(ObjectType $parentType, $rootValue, array $path, ArrayObject $fields) { $result = $this->promiseReduce( array_keys($fields->getArrayCopy()), function ($results, $responseName) use ($path, $parentType, $rootValue, $fields) { $fieldNodes = $fields[$responseName]; $fieldPath = $path; $fieldPath[] = $responseName; $result = $this->resolveField($parentType, $rootValue, $fieldNodes, $fieldPath); if ($result === static::$UNDEFINED) { return $results; } $promise = $this->getPromise($result); if ($promise !== null) { return $promise->then(static function ($resolvedResult) use ($responseName, $results) { $results[$responseName] = $resolvedResult; return $results; }); } $results[$responseName] = $result; return $results; }, [] ); if ($this->isPromise($result)) { return $result->then(static function ($resolvedResults) { return static::fixResultsIfEmptyArray($resolvedResults); }); } return static::fixResultsIfEmptyArray($result); } /** * Resolves the field on the given root value. * * In particular, this figures out the value that the field returns * by calling its resolve function, then calls completeValue to complete promises, * serialize scalars, or execute the sub-selection-set for objects. * * @param mixed $rootValue * @param array $path * * @return array|Throwable|mixed|null */ protected function resolveField(ObjectType $parentType, $rootValue, ArrayObject $fieldNodes, array $path) { $exeContext = $this->exeContext; $fieldNode = $fieldNodes[0]; $fieldName = $fieldNode->name->value; $fieldDef = $this->getFieldDef($exeContext->schema, $parentType, $fieldName); if ($fieldDef === null) { return static::$UNDEFINED; } $returnType = $fieldDef->getType(); // The resolve function's optional 3rd argument is a context value that // is provided to every resolve function within an execution. It is commonly // used to represent an authenticated user, or request-specific caches. // The resolve function's optional 4th argument is a collection of // information about the current execution state. $info = new ResolveInfo( $fieldDef, $fieldNodes, $parentType, $path, $exeContext->schema, $exeContext->fragments, $exeContext->rootValue, $exeContext->operation, $exeContext->variableValues ); if ($fieldDef->resolveFn !== null) { $resolveFn = $fieldDef->resolveFn; } elseif ($parentType->resolveFieldFn !== null) { $resolveFn = $parentType->resolveFieldFn; } else { $resolveFn = $this->exeContext->fieldResolver; } // Get the resolve function, regardless of if its result is normal // or abrupt (error). $result = $this->resolveFieldValueOrError( $fieldDef, $fieldNode, $resolveFn, $rootValue, $info ); $result = $this->completeValueCatchingError( $returnType, $fieldNodes, $info, $path, $result ); return $result; } /** * This method looks up the field on the given type definition. * * It has special casing for the two introspection fields, __schema * and __typename. __typename is special because it can always be * queried as a field, even in situations where no other fields * are allowed, like on a Union. __schema could get automatically * added to the query type, but that would require mutating type * definitions, which would cause issues. */ protected function getFieldDef(Schema $schema, ObjectType $parentType, string $fieldName) : ?FieldDefinition { static $schemaMetaFieldDef, $typeMetaFieldDef, $typeNameMetaFieldDef; $schemaMetaFieldDef = $schemaMetaFieldDef ?? Introspection::schemaMetaFieldDef(); $typeMetaFieldDef = $typeMetaFieldDef ?? Introspection::typeMetaFieldDef(); $typeNameMetaFieldDef = $typeNameMetaFieldDef ?? Introspection::typeNameMetaFieldDef(); if ($fieldName === $schemaMetaFieldDef->name && $schema->getQueryType() === $parentType) { return $schemaMetaFieldDef; } if ($fieldName === $typeMetaFieldDef->name && $schema->getQueryType() === $parentType) { return $typeMetaFieldDef; } if ($fieldName === $typeNameMetaFieldDef->name) { return $typeNameMetaFieldDef; } return $parentType->findField($fieldName); } /** * Isolates the "ReturnOrAbrupt" behavior to not de-opt the `resolveField` function. * Returns the result of resolveFn or the abrupt-return Error object. * * @param mixed $rootValue * * @return Throwable|Promise|mixed */ protected function resolveFieldValueOrError( FieldDefinition $fieldDef, FieldNode $fieldNode, callable $resolveFn, $rootValue, ResolveInfo $info ) { try { // Build a map of arguments from the field.arguments AST, using the // variables scope to fulfill any variable references. $args = Values::getArgumentValues( $fieldDef, $fieldNode, $this->exeContext->variableValues ); $contextValue = $this->exeContext->contextValue; return $resolveFn($rootValue, $args, $contextValue, $info); } catch (Throwable $error) { return $error; } } /** * This is a small wrapper around completeValue which detects and logs errors * in the execution context. * * @param array $path * @param mixed $result * * @return array|Promise|stdClass|null */ protected function completeValueCatchingError( Type $returnType, ArrayObject $fieldNodes, ResolveInfo $info, array $path, $result ) { // Otherwise, error protection is applied, logging the error and resolving // a null value for this field if one is encountered. try { $promise = $this->getPromise($result); if ($promise !== null) { $completed = $promise->then(function (&$resolved) use ($returnType, $fieldNodes, $info, $path) { return $this->completeValue($returnType, $fieldNodes, $info, $path, $resolved); }); } else { $completed = $this->completeValue($returnType, $fieldNodes, $info, $path, $result); } $promise = $this->getPromise($completed); if ($promise !== null) { return $promise->then(null, function ($error) use ($fieldNodes, $path, $returnType) : void { $this->handleFieldError($error, $fieldNodes, $path, $returnType); }); } return $completed; } catch (Throwable $err) { $this->handleFieldError($err, $fieldNodes, $path, $returnType); return null; } } /** * @param mixed $rawError * @param array $path * * @throws Error */ protected function handleFieldError($rawError, ArrayObject $fieldNodes, array $path, Type $returnType) : void { $error = Error::createLocatedError( $rawError, $fieldNodes, $path ); // If the field type is non-nullable, then it is resolved without any // protection from errors, however it still properly locates the error. if ($returnType instanceof NonNull) { throw $error; } // Otherwise, error protection is applied, logging the error and resolving // a null value for this field if one is encountered. $this->exeContext->addError($error); } /** * Implements the instructions for completeValue as defined in the * "Field entries" section of the spec. * * If the field type is Non-Null, then this recursively completes the value * for the inner type. It throws a field error if that completion returns null, * as per the "Nullability" section of the spec. * * If the field type is a List, then this recursively completes the value * for the inner type on each item in the list. * * If the field type is a Scalar or Enum, ensures the completed value is a legal * value of the type by calling the `serialize` method of GraphQL type * definition. * * If the field is an abstract type, determine the runtime type of the value * and then complete based on that type * * Otherwise, the field type expects a sub-selection set, and will complete the * value by evaluating all sub-selections. * * @param array $path * @param mixed $result * * @return array|mixed|Promise|null * * @throws Error * @throws Throwable */ protected function completeValue( Type $returnType, ArrayObject $fieldNodes, ResolveInfo $info, array $path, &$result ) { // If result is an Error, throw a located error. if ($result instanceof Throwable) { throw $result; } // If field type is NonNull, complete for inner type, and throw field error // if result is null. if ($returnType instanceof NonNull) { $completed = $this->completeValue( $returnType->getWrappedType(), $fieldNodes, $info, $path, $result ); if ($completed === null) { throw new InvariantViolation( sprintf('Cannot return null for non-nullable field "%s.%s".', $info->parentType, $info->fieldName) ); } return $completed; } // If result is null-like, return null. if ($result === null) { return null; } // If field type is List, complete each item in the list with the inner type if ($returnType instanceof ListOfType) { return $this->completeListValue($returnType, $fieldNodes, $info, $path, $result); } // Account for invalid schema definition when typeLoader returns different // instance than `resolveType` or $field->getType() or $arg->getType() if ($returnType !== $this->exeContext->schema->getType($returnType->name)) { $hint = ''; if ($this->exeContext->schema->getConfig()->typeLoader !== null) { $hint = sprintf( 'Make sure that type loader returns the same instance as defined in %s.%s', $info->parentType, $info->fieldName ); } throw new InvariantViolation( sprintf( 'Schema must contain unique named types but contains multiple types named "%s". %s ' . '(see http://webonyx.github.io/graphql-php/type-system/#type-registry).', $returnType, $hint ) ); } // If field type is Scalar or Enum, serialize to a valid value, returning // null if serialization is not possible. if ($returnType instanceof LeafType) { return $this->completeLeafValue($returnType, $result); } if ($returnType instanceof AbstractType) { return $this->completeAbstractValue($returnType, $fieldNodes, $info, $path, $result); } // Field type must be Object, Interface or Union and expect sub-selections. if ($returnType instanceof ObjectType) { return $this->completeObjectValue($returnType, $fieldNodes, $info, $path, $result); } throw new RuntimeException(sprintf('Cannot complete value of unexpected type "%s".', $returnType)); } /** * @param mixed $value */ protected function isPromise($value) : bool { return $value instanceof Promise || $this->exeContext->promiseAdapter->isThenable($value); } /** * Only returns the value if it acts like a Promise, i.e. has a "then" function, * otherwise returns null. * * @param mixed $value */ protected function getPromise($value) : ?Promise { if ($value === null || $value instanceof Promise) { return $value; } if ($this->exeContext->promiseAdapter->isThenable($value)) { $promise = $this->exeContext->promiseAdapter->convertThenable($value); if (! $promise instanceof Promise) { throw new InvariantViolation(sprintf( '%s::convertThenable is expected to return instance of GraphQL\Executor\Promise\Promise, got: %s', get_class($this->exeContext->promiseAdapter), Utils::printSafe($promise) )); } return $promise; } return null; } /** * Similar to array_reduce(), however the reducing callback may return * a Promise, in which case reduction will continue after each promise resolves. * * If the callback does not return a Promise, then this function will also not * return a Promise. * * @param array $values * @param Promise|mixed|null $initialValue * * @return Promise|mixed|null */ protected function promiseReduce(array $values, callable $callback, $initialValue) { return array_reduce( $values, function ($previous, $value) use ($callback) { $promise = $this->getPromise($previous); if ($promise !== null) { return $promise->then(static function ($resolved) use ($callback, $value) { return $callback($resolved, $value); }); } return $callback($previous, $value); }, $initialValue ); } /** * Complete a list value by completing each item in the list with the inner type. * * @param array $path * @param array|Traversable $results * * @return array|Promise|stdClass * * @throws Exception */ protected function completeListValue(ListOfType $returnType, ArrayObject $fieldNodes, ResolveInfo $info, array $path, &$results) { $itemType = $returnType->getWrappedType(); Utils::invariant( is_array($results) || $results instanceof Traversable, 'User Error: expected iterable, but did not find one for field ' . $info->parentType . '.' . $info->fieldName . '.' ); $containsPromise = false; $i = 0; $completedItems = []; foreach ($results as $item) { $fieldPath = $path; $fieldPath[] = $i++; $info->path = $fieldPath; $completedItem = $this->completeValueCatchingError($itemType, $fieldNodes, $info, $fieldPath, $item); if (! $containsPromise && $this->getPromise($completedItem) !== null) { $containsPromise = true; } $completedItems[] = $completedItem; } return $containsPromise ? $this->exeContext->promiseAdapter->all($completedItems) : $completedItems; } /** * Complete a Scalar or Enum by serializing to a valid value, throwing if serialization is not possible. * * @param mixed $result * * @return mixed * * @throws Exception */ protected function completeLeafValue(LeafType $returnType, &$result) { try { return $returnType->serialize($result); } catch (Throwable $error) { throw new InvariantViolation( 'Expected a value of type "' . Utils::printSafe($returnType) . '" but received: ' . Utils::printSafe($result), 0, $error ); } } /** * Complete a value of an abstract type by determining the runtime object type * of that value, then complete the value for that type. * * @param array $path * @param array $result * * @return array|Promise|stdClass * * @throws Error */ protected function completeAbstractValue( AbstractType $returnType, ArrayObject $fieldNodes, ResolveInfo $info, array $path, &$result ) { $exeContext = $this->exeContext; $typeCandidate = $returnType->resolveType($result, $exeContext->contextValue, $info); if ($typeCandidate === null) { $runtimeType = static::defaultTypeResolver($result, $exeContext->contextValue, $info, $returnType); } elseif (is_callable($typeCandidate)) { $runtimeType = Schema::resolveType($typeCandidate); } else { $runtimeType = $typeCandidate; } $promise = $this->getPromise($runtimeType); if ($promise !== null) { return $promise->then(function ($resolvedRuntimeType) use ( $returnType, $fieldNodes, $info, $path, &$result ) { return $this->completeObjectValue( $this->ensureValidRuntimeType( $resolvedRuntimeType, $returnType, $info, $result ), $fieldNodes, $info, $path, $result ); }); } return $this->completeObjectValue( $this->ensureValidRuntimeType( $runtimeType, $returnType, $info, $result ), $fieldNodes, $info, $path, $result ); } /** * If a resolveType function is not given, then a default resolve behavior is * used which attempts two strategies: * * First, See if the provided value has a `__typename` field defined, if so, use * that value as name of the resolved type. * * Otherwise, test each possible type for the abstract type by calling * isTypeOf for the object being coerced, returning the first type that matches. * * @param mixed|null $value * @param mixed|null $contextValue * @param InterfaceType|UnionType $abstractType * * @return Promise|Type|string|null */ protected function defaultTypeResolver($value, $contextValue, ResolveInfo $info, AbstractType $abstractType) { // First, look for `__typename`. if ($value !== null && (is_array($value) || $value instanceof ArrayAccess) && isset($value['__typename']) && is_string($value['__typename']) ) { return $value['__typename']; } if ($abstractType instanceof InterfaceType && $info->schema->getConfig()->typeLoader !== null) { Warning::warnOnce( sprintf( 'GraphQL Interface Type `%s` returned `null` from its `resolveType` function ' . 'for value: %s. Switching to slow resolution method using `isTypeOf` ' . 'of all possible implementations. It requires full schema scan and degrades query performance significantly. ' . ' Make sure your `resolveType` always returns valid implementation or throws.', $abstractType->name, Utils::printSafe($value) ), Warning::WARNING_FULL_SCHEMA_SCAN ); } // Otherwise, test each possible type. $possibleTypes = $info->schema->getPossibleTypes($abstractType); $promisedIsTypeOfResults = []; foreach ($possibleTypes as $index => $type) { $isTypeOfResult = $type->isTypeOf($value, $contextValue, $info); if ($isTypeOfResult === null) { continue; } $promise = $this->getPromise($isTypeOfResult); if ($promise !== null) { $promisedIsTypeOfResults[$index] = $promise; } elseif ($isTypeOfResult) { return $type; } } if (count($promisedIsTypeOfResults) > 0) { return $this->exeContext->promiseAdapter->all($promisedIsTypeOfResults) ->then(static function ($isTypeOfResults) use ($possibleTypes) : ?ObjectType { foreach ($isTypeOfResults as $index => $result) { if ($result) { return $possibleTypes[$index]; } } return null; }); } return null; } /** * Complete an Object value by executing all sub-selections. * * @param array $path * @param mixed $result * * @return array|Promise|stdClass * * @throws Error */ protected function completeObjectValue( ObjectType $returnType, ArrayObject $fieldNodes, ResolveInfo $info, array $path, &$result ) { // If there is an isTypeOf predicate function, call it with the // current result. If isTypeOf returns false, then raise an error rather // than continuing execution. $isTypeOf = $returnType->isTypeOf($result, $this->exeContext->contextValue, $info); if ($isTypeOf !== null) { $promise = $this->getPromise($isTypeOf); if ($promise !== null) { return $promise->then(function ($isTypeOfResult) use ( $returnType, $fieldNodes, $path, &$result ) { if (! $isTypeOfResult) { throw $this->invalidReturnTypeError($returnType, $result, $fieldNodes); } return $this->collectAndExecuteSubfields( $returnType, $fieldNodes, $path, $result ); }); } if (! $isTypeOf) { throw $this->invalidReturnTypeError($returnType, $result, $fieldNodes); } } return $this->collectAndExecuteSubfields( $returnType, $fieldNodes, $path, $result ); } /** * @param array $result * * @return Error */ protected function invalidReturnTypeError( ObjectType $returnType, $result, ArrayObject $fieldNodes ) { return new Error( 'Expected value of type "' . $returnType->name . '" but got: ' . Utils::printSafe($result) . '.', $fieldNodes ); } /** * @param array $path * @param mixed $result * * @return array|Promise|stdClass * * @throws Error */ protected function collectAndExecuteSubfields( ObjectType $returnType, ArrayObject $fieldNodes, array $path, &$result ) { $subFieldNodes = $this->collectSubFields($returnType, $fieldNodes); return $this->executeFields($returnType, $result, $path, $subFieldNodes); } /** * A memoized collection of relevant subfields with regard to the return * type. Memoizing ensures the subfields are not repeatedly calculated, which * saves overhead when resolving lists of values. */ protected function collectSubFields(ObjectType $returnType, ArrayObject $fieldNodes) : ArrayObject { if (! isset($this->subFieldCache[$returnType])) { $this->subFieldCache[$returnType] = new SplObjectStorage(); } if (! isset($this->subFieldCache[$returnType][$fieldNodes])) { // Collect sub-fields to execute to complete this value. $subFieldNodes = new ArrayObject(); $visitedFragmentNames = new ArrayObject(); foreach ($fieldNodes as $fieldNode) { if (! isset($fieldNode->selectionSet)) { continue; } $subFieldNodes = $this->collectFields( $returnType, $fieldNode->selectionSet, $subFieldNodes, $visitedFragmentNames ); } $this->subFieldCache[$returnType][$fieldNodes] = $subFieldNodes; } return $this->subFieldCache[$returnType][$fieldNodes]; } /** * Implements the "Evaluating selection sets" section of the spec * for "read" mode. * * @param mixed $rootValue * @param array $path * * @return Promise|stdClass|array */ protected function executeFields(ObjectType $parentType, $rootValue, array $path, ArrayObject $fields) { $containsPromise = false; $results = []; foreach ($fields as $responseName => $fieldNodes) { $fieldPath = $path; $fieldPath[] = $responseName; $result = $this->resolveField($parentType, $rootValue, $fieldNodes, $fieldPath); if ($result === static::$UNDEFINED) { continue; } if (! $containsPromise && $this->isPromise($result)) { $containsPromise = true; } $results[$responseName] = $result; } // If there are no promises, we can just return the object if (! $containsPromise) { return static::fixResultsIfEmptyArray($results); } // Otherwise, results is a map from field name to the result of resolving that // field, which is possibly a promise. Return a promise that will return this // same map, but with any promises replaced with the values they resolved to. return $this->promiseForAssocArray($results); } /** * Differentiate empty objects from empty lists. * * @see https://github.com/webonyx/graphql-php/issues/59 * * @param array|mixed $results * * @return array|stdClass|mixed */ protected static function fixResultsIfEmptyArray($results) { if ($results === []) { return new stdClass(); } return $results; } /** * Transform an associative array with Promises to a Promise which resolves to an * associative array where all Promises were resolved. * * @param array $assoc */ protected function promiseForAssocArray(array $assoc) : Promise { $keys = array_keys($assoc); $valuesAndPromises = array_values($assoc); $promise = $this->exeContext->promiseAdapter->all($valuesAndPromises); return $promise->then(static function ($values) use ($keys) { $resolvedResults = []; foreach ($values as $i => $value) { $resolvedResults[$keys[$i]] = $value; } return static::fixResultsIfEmptyArray($resolvedResults); }); } /** * @param string|ObjectType|null $runtimeTypeOrName * @param InterfaceType|UnionType $returnType * @param mixed $result */ protected function ensureValidRuntimeType( $runtimeTypeOrName, AbstractType $returnType, ResolveInfo $info, &$result ) : ObjectType { $runtimeType = is_string($runtimeTypeOrName) ? $this->exeContext->schema->getType($runtimeTypeOrName) : $runtimeTypeOrName; if (! $runtimeType instanceof ObjectType) { throw new InvariantViolation( sprintf( 'Abstract type %s must resolve to an Object type at ' . 'runtime for field %s.%s with value "%s", received "%s". ' . 'Either the %s type should provide a "resolveType" ' . 'function or each possible type should provide an "isTypeOf" function.', $returnType, $info->parentType, $info->fieldName, Utils::printSafe($result), Utils::printSafe($runtimeType), $returnType ) ); } if (! $this->exeContext->schema->isSubType($returnType, $runtimeType)) { throw new InvariantViolation( sprintf('Runtime Object type "%s" is not a possible type for "%s".', $runtimeType, $returnType) ); } if ($runtimeType !== $this->exeContext->schema->getType($runtimeType->name)) { throw new InvariantViolation( sprintf( 'Schema must contain unique named types but contains multiple types named "%s". ' . 'Make sure that `resolveType` function of abstract type "%s" returns the same ' . 'type instance as referenced anywhere else within the schema ' . '(see http://webonyx.github.io/graphql-php/type-system/#type-registry).', $runtimeType, $returnType ) ); } return $runtimeType; } }