123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227 |
- // @flow strict
- import { forEach, isCollection } from 'iterall';
- import inspect from '../jsutils/inspect';
- import memoize3 from '../jsutils/memoize3';
- import invariant from '../jsutils/invariant';
- import devAssert from '../jsutils/devAssert';
- import isInvalid from '../jsutils/isInvalid';
- import isNullish from '../jsutils/isNullish';
- import isPromise from '../jsutils/isPromise';
- import { type ObjMap } from '../jsutils/ObjMap';
- import isObjectLike from '../jsutils/isObjectLike';
- import promiseReduce from '../jsutils/promiseReduce';
- import promiseForObject from '../jsutils/promiseForObject';
- import { type PromiseOrValue } from '../jsutils/PromiseOrValue';
- import { type Path, addPath, pathToArray } from '../jsutils/Path';
- import { type GraphQLFormattedError } from '../error/formatError';
- import { GraphQLError } from '../error/GraphQLError';
- import { locatedError } from '../error/locatedError';
- import { Kind } from '../language/kinds';
- import {
- type DocumentNode,
- type OperationDefinitionNode,
- type SelectionSetNode,
- type FieldNode,
- type FragmentSpreadNode,
- type InlineFragmentNode,
- type FragmentDefinitionNode,
- } from '../language/ast';
- import { assertValidSchema } from '../type/validate';
- import { type GraphQLSchema } from '../type/schema';
- import {
- SchemaMetaFieldDef,
- TypeMetaFieldDef,
- TypeNameMetaFieldDef,
- } from '../type/introspection';
- import {
- GraphQLIncludeDirective,
- GraphQLSkipDirective,
- } from '../type/directives';
- import {
- type GraphQLObjectType,
- type GraphQLOutputType,
- type GraphQLLeafType,
- type GraphQLAbstractType,
- type GraphQLField,
- type GraphQLFieldResolver,
- type GraphQLResolveInfo,
- type GraphQLTypeResolver,
- type GraphQLList,
- isObjectType,
- isAbstractType,
- isLeafType,
- isListType,
- isNonNullType,
- } from '../type/definition';
- import { typeFromAST } from '../utilities/typeFromAST';
- import { getOperationRootType } from '../utilities/getOperationRootType';
- import {
- getVariableValues,
- getArgumentValues,
- getDirectiveValues,
- } from './values';
- /**
- * Terminology
- *
- * "Definitions" are the generic name for top-level statements in the document.
- * Examples of this include:
- * 1) Operations (such as a query)
- * 2) Fragments
- *
- * "Operations" are a generic name for requests in the document.
- * Examples of this include:
- * 1) query,
- * 2) mutation
- *
- * "Selections" are the definitions that can appear legally and at
- * single level of the query. These include:
- * 1) field references e.g "a"
- * 2) fragment "spreads" e.g. "...c"
- * 3) inline fragment "spreads" e.g. "...on Type { a }"
- */
- /**
- * Data that must be available at all points during query execution.
- *
- * Namely, schema of the type system that is currently executing,
- * and the fragments defined in the query document
- */
- export type ExecutionContext = {|
- schema: GraphQLSchema,
- fragments: ObjMap<FragmentDefinitionNode>,
- rootValue: mixed,
- contextValue: mixed,
- operation: OperationDefinitionNode,
- variableValues: { [variable: string]: mixed, ... },
- fieldResolver: GraphQLFieldResolver<any, any>,
- typeResolver: GraphQLTypeResolver<any, any>,
- errors: Array<GraphQLError>,
- |};
- /**
- * The result of GraphQL execution.
- *
- * - `errors` is included when any errors occurred as a non-empty array.
- * - `data` is the result of a successful execution of the query.
- */
- export type ExecutionResult = {
- errors?: $ReadOnlyArray<GraphQLError>,
- data?: ObjMap<mixed> | null,
- ...
- };
- export type FormattedExecutionResult = {|
- errors?: $ReadOnlyArray<GraphQLFormattedError>,
- data?: ObjMap<mixed> | null,
- extensions?: ObjMap<mixed>,
- |};
- export type ExecutionArgs = {|
- schema: GraphQLSchema,
- document: DocumentNode,
- rootValue?: mixed,
- contextValue?: mixed,
- variableValues?: ?{ +[variable: string]: mixed, ... },
- operationName?: ?string,
- fieldResolver?: ?GraphQLFieldResolver<any, any>,
- typeResolver?: ?GraphQLTypeResolver<any, any>,
- |};
- /**
- * Implements the "Evaluating requests" section of the GraphQL specification.
- *
- * Returns either a synchronous ExecutionResult (if all encountered resolvers
- * are synchronous), or a Promise of an ExecutionResult that will eventually be
- * resolved and never rejected.
- *
- * If the arguments to this function do not result in a legal execution context,
- * a GraphQLError will be thrown immediately explaining the invalid input.
- *
- * Accepts either an object with named arguments, or individual arguments.
- */
- declare function execute(
- ExecutionArgs,
- ..._: []
- ): PromiseOrValue<ExecutionResult>;
- /* eslint-disable no-redeclare */
- declare function execute(
- schema: GraphQLSchema,
- document: DocumentNode,
- rootValue?: mixed,
- contextValue?: mixed,
- variableValues?: ?{ +[variable: string]: mixed, ... },
- operationName?: ?string,
- fieldResolver?: ?GraphQLFieldResolver<any, any>,
- typeResolver?: ?GraphQLTypeResolver<any, any>,
- ): PromiseOrValue<ExecutionResult>;
- export function execute(
- argsOrSchema,
- document,
- rootValue,
- contextValue,
- variableValues,
- operationName,
- fieldResolver,
- typeResolver,
- ) {
- /* eslint-enable no-redeclare */
- // Extract arguments from object args if provided.
- return arguments.length === 1
- ? executeImpl(argsOrSchema)
- : executeImpl({
- schema: argsOrSchema,
- document,
- rootValue,
- contextValue,
- variableValues,
- operationName,
- fieldResolver,
- typeResolver,
- });
- }
- function executeImpl(args: ExecutionArgs): ExecutionResult {
- const {
- schema,
- document,
- rootValue,
- contextValue,
- variableValues,
- operationName,
- fieldResolver,
- typeResolver,
- } = args;
- // If arguments are missing or incorrect, throw an error.
- assertValidExecutionArguments(schema, document, variableValues);
- // If a valid execution context cannot be created due to incorrect arguments,
- // a "Response" with only errors is returned.
- const exeContext = buildExecutionContext(
- schema,
- document,
- rootValue,
- contextValue,
- variableValues,
- operationName,
- fieldResolver,
- typeResolver,
- );
- // Return early errors if execution context failed.
- if (Array.isArray(exeContext)) {
- return { errors: exeContext };
- }
- // 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.
- const data = executeOperation(exeContext, exeContext.operation, rootValue);
- return buildResponse(exeContext, data);
- }
- /**
- * Given a completed execution context and data, build the { errors, data }
- * response defined by the "Response" section of the GraphQL specification.
- */
- function buildResponse(
- exeContext: ExecutionContext,
- data: PromiseOrValue<ObjMap<mixed> | null>,
- ): ExecutionResult {
- if (isPromise(data)) {
- return data.then(resolved => buildResponse(exeContext, resolved));
- }
- return exeContext.errors.length === 0
- ? { data }
- : { errors: exeContext.errors, data };
- }
- /**
- * Essential assertions before executing to provide developer feedback for
- * improper use of the GraphQL library.
- */
- export function assertValidExecutionArguments(
- schema: GraphQLSchema,
- document: DocumentNode,
- rawVariableValues: ?{ +[variable: string]: mixed, ... },
- ): void {
- devAssert(document, 'Must provide document');
- // If the schema used for execution is invalid, throw an error.
- assertValidSchema(schema);
- // Variables, if provided, must be an object.
- devAssert(
- rawVariableValues == null || isObjectLike(rawVariableValues),
- 'Variables must be provided as an Object where each property is a variable value. Perhaps look to see if an unparsed JSON string was provided.',
- );
- }
- /**
- * Constructs a ExecutionContext object from the arguments passed to
- * execute, which we will pass throughout the other execution methods.
- *
- * Throws a GraphQLError if a valid execution context cannot be created.
- */
- export function buildExecutionContext(
- schema: GraphQLSchema,
- document: DocumentNode,
- rootValue: mixed,
- contextValue: mixed,
- rawVariableValues: ?{ +[variable: string]: mixed, ... },
- operationName: ?string,
- fieldResolver: ?GraphQLFieldResolver<mixed, mixed>,
- typeResolver?: ?GraphQLTypeResolver<mixed, mixed>,
- ): $ReadOnlyArray<GraphQLError> | ExecutionContext {
- let operation: OperationDefinitionNode | void;
- let hasMultipleAssumedOperations = false;
- const fragments: ObjMap<FragmentDefinitionNode> = Object.create(null);
- for (const definition of document.definitions) {
- switch (definition.kind) {
- case Kind.OPERATION_DEFINITION:
- if (!operationName && operation) {
- hasMultipleAssumedOperations = true;
- } else if (
- !operationName ||
- (definition.name && definition.name.value === operationName)
- ) {
- operation = definition;
- }
- break;
- case Kind.FRAGMENT_DEFINITION:
- fragments[definition.name.value] = definition;
- break;
- }
- }
- if (!operation) {
- if (operationName) {
- return [new GraphQLError(`Unknown operation named "${operationName}".`)];
- }
- return [new GraphQLError('Must provide an operation.')];
- }
- if (hasMultipleAssumedOperations) {
- return [
- new GraphQLError(
- 'Must provide operation name if query contains multiple operations.',
- ),
- ];
- }
- const coercedVariableValues = getVariableValues(
- schema,
- operation.variableDefinitions || [],
- rawVariableValues || {},
- { maxErrors: 50 },
- );
- if (coercedVariableValues.errors) {
- return coercedVariableValues.errors;
- }
- return {
- schema,
- fragments,
- rootValue,
- contextValue,
- operation,
- variableValues: coercedVariableValues.coerced,
- fieldResolver: fieldResolver || defaultFieldResolver,
- typeResolver: typeResolver || defaultTypeResolver,
- errors: [],
- };
- }
- /**
- * Implements the "Evaluating operations" section of the spec.
- */
- function executeOperation(
- exeContext: ExecutionContext,
- operation: OperationDefinitionNode,
- rootValue: mixed,
- ): PromiseOrValue<ObjMap<mixed> | null> {
- const type = getOperationRootType(exeContext.schema, operation);
- const fields = collectFields(
- exeContext,
- type,
- operation.selectionSet,
- Object.create(null),
- Object.create(null),
- );
- const path = undefined;
- // 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 {
- const result =
- operation.operation === 'mutation'
- ? executeFieldsSerially(exeContext, type, rootValue, path, fields)
- : executeFields(exeContext, type, rootValue, path, fields);
- if (isPromise(result)) {
- return result.then(undefined, error => {
- exeContext.errors.push(error);
- return Promise.resolve(null);
- });
- }
- return result;
- } catch (error) {
- exeContext.errors.push(error);
- return null;
- }
- }
- /**
- * Implements the "Evaluating selection sets" section of the spec
- * for "write" mode.
- */
- function executeFieldsSerially(
- exeContext: ExecutionContext,
- parentType: GraphQLObjectType,
- sourceValue: mixed,
- path: Path | void,
- fields: ObjMap<Array<FieldNode>>,
- ): PromiseOrValue<ObjMap<mixed>> {
- return promiseReduce(
- Object.keys(fields),
- (results, responseName) => {
- const fieldNodes = fields[responseName];
- const fieldPath = addPath(path, responseName);
- const result = resolveField(
- exeContext,
- parentType,
- sourceValue,
- fieldNodes,
- fieldPath,
- );
- if (result === undefined) {
- return results;
- }
- if (isPromise(result)) {
- return result.then(resolvedResult => {
- results[responseName] = resolvedResult;
- return results;
- });
- }
- results[responseName] = result;
- return results;
- },
- Object.create(null),
- );
- }
- /**
- * Implements the "Evaluating selection sets" section of the spec
- * for "read" mode.
- */
- function executeFields(
- exeContext: ExecutionContext,
- parentType: GraphQLObjectType,
- sourceValue: mixed,
- path: Path | void,
- fields: ObjMap<Array<FieldNode>>,
- ): PromiseOrValue<ObjMap<mixed>> {
- const results = Object.create(null);
- let containsPromise = false;
- for (const responseName of Object.keys(fields)) {
- const fieldNodes = fields[responseName];
- const fieldPath = addPath(path, responseName);
- const result = resolveField(
- exeContext,
- parentType,
- sourceValue,
- fieldNodes,
- fieldPath,
- );
- if (result !== undefined) {
- results[responseName] = result;
- if (!containsPromise && isPromise(result)) {
- containsPromise = true;
- }
- }
- }
- // If there are no promises, we can just return the object
- if (!containsPromise) {
- return 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 promiseForObject(results);
- }
- /**
- * 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.
- */
- export function collectFields(
- exeContext: ExecutionContext,
- runtimeType: GraphQLObjectType,
- selectionSet: SelectionSetNode,
- fields: ObjMap<Array<FieldNode>>,
- visitedFragmentNames: ObjMap<boolean>,
- ): ObjMap<Array<FieldNode>> {
- for (const selection of selectionSet.selections) {
- switch (selection.kind) {
- case Kind.FIELD: {
- if (!shouldIncludeNode(exeContext, selection)) {
- continue;
- }
- const name = getFieldEntryKey(selection);
- if (!fields[name]) {
- fields[name] = [];
- }
- fields[name].push(selection);
- break;
- }
- case Kind.INLINE_FRAGMENT: {
- if (
- !shouldIncludeNode(exeContext, selection) ||
- !doesFragmentConditionMatch(exeContext, selection, runtimeType)
- ) {
- continue;
- }
- collectFields(
- exeContext,
- runtimeType,
- selection.selectionSet,
- fields,
- visitedFragmentNames,
- );
- break;
- }
- case Kind.FRAGMENT_SPREAD: {
- const fragName = selection.name.value;
- if (
- visitedFragmentNames[fragName] ||
- !shouldIncludeNode(exeContext, selection)
- ) {
- continue;
- }
- visitedFragmentNames[fragName] = true;
- const fragment = exeContext.fragments[fragName];
- if (
- !fragment ||
- !doesFragmentConditionMatch(exeContext, fragment, runtimeType)
- ) {
- continue;
- }
- collectFields(
- exeContext,
- 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.
- */
- function shouldIncludeNode(
- exeContext: ExecutionContext,
- node: FragmentSpreadNode | FieldNode | InlineFragmentNode,
- ): boolean {
- const skip = getDirectiveValues(
- GraphQLSkipDirective,
- node,
- exeContext.variableValues,
- );
- if (skip && skip.if === true) {
- return false;
- }
- const include = getDirectiveValues(
- GraphQLIncludeDirective,
- node,
- exeContext.variableValues,
- );
- if (include && include.if === false) {
- return false;
- }
- return true;
- }
- /**
- * Determines if a fragment is applicable to the given type.
- */
- function doesFragmentConditionMatch(
- exeContext: ExecutionContext,
- fragment: FragmentDefinitionNode | InlineFragmentNode,
- type: GraphQLObjectType,
- ): boolean {
- const typeConditionNode = fragment.typeCondition;
- if (!typeConditionNode) {
- return true;
- }
- const conditionalType = typeFromAST(exeContext.schema, typeConditionNode);
- if (conditionalType === type) {
- return true;
- }
- if (isAbstractType(conditionalType)) {
- return exeContext.schema.isPossibleType(conditionalType, type);
- }
- return false;
- }
- /**
- * Implements the logic to compute the key of a given field's entry
- */
- function getFieldEntryKey(node: FieldNode): string {
- return node.alias ? node.alias.value : node.name.value;
- }
- /**
- * Resolves the field on the given source object. 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.
- */
- function resolveField(
- exeContext: ExecutionContext,
- parentType: GraphQLObjectType,
- source: mixed,
- fieldNodes: $ReadOnlyArray<FieldNode>,
- path: Path,
- ): PromiseOrValue<mixed> {
- const fieldNode = fieldNodes[0];
- const fieldName = fieldNode.name.value;
- const fieldDef = getFieldDef(exeContext.schema, parentType, fieldName);
- if (!fieldDef) {
- return;
- }
- const resolveFn = fieldDef.resolve || exeContext.fieldResolver;
- const info = buildResolveInfo(
- exeContext,
- fieldDef,
- fieldNodes,
- parentType,
- path,
- );
- // Get the resolve function, regardless of if its result is normal
- // or abrupt (error).
- const result = resolveFieldValueOrError(
- exeContext,
- fieldDef,
- fieldNodes,
- resolveFn,
- source,
- info,
- );
- return completeValueCatchingError(
- exeContext,
- fieldDef.type,
- fieldNodes,
- info,
- path,
- result,
- );
- }
- export function buildResolveInfo(
- exeContext: ExecutionContext,
- fieldDef: GraphQLField<mixed, mixed>,
- fieldNodes: $ReadOnlyArray<FieldNode>,
- parentType: GraphQLObjectType,
- path: Path,
- ): GraphQLResolveInfo {
- // The resolve function's optional fourth argument is a collection of
- // information about the current execution state.
- return {
- fieldName: fieldDef.name,
- fieldNodes,
- returnType: fieldDef.type,
- parentType,
- path,
- schema: exeContext.schema,
- fragments: exeContext.fragments,
- rootValue: exeContext.rootValue,
- operation: exeContext.operation,
- variableValues: exeContext.variableValues,
- };
- }
- // Isolates the "ReturnOrAbrupt" behavior to not de-opt the `resolveField`
- // function. Returns the result of resolveFn or the abrupt-return Error object.
- export function resolveFieldValueOrError(
- exeContext: ExecutionContext,
- fieldDef: GraphQLField<mixed, mixed>,
- fieldNodes: $ReadOnlyArray<FieldNode>,
- resolveFn: GraphQLFieldResolver<mixed, mixed>,
- source: mixed,
- info: GraphQLResolveInfo,
- ): Error | mixed {
- try {
- // Build a JS object of arguments from the field.arguments AST, using the
- // variables scope to fulfill any variable references.
- // TODO: find a way to memoize, in case this field is within a List type.
- const args = getArgumentValues(
- fieldDef,
- fieldNodes[0],
- exeContext.variableValues,
- );
- // The resolve function's optional third 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.
- const contextValue = exeContext.contextValue;
- const result = resolveFn(source, args, contextValue, info);
- return isPromise(result) ? result.then(undefined, asErrorInstance) : result;
- } catch (error) {
- return asErrorInstance(error);
- }
- }
- // Sometimes a non-error is thrown, wrap it as an Error instance to ensure a
- // consistent Error interface.
- function asErrorInstance(error: mixed): Error {
- if (error instanceof Error) {
- return error;
- }
- return new Error('Unexpected error value: ' + inspect(error));
- }
- // This is a small wrapper around completeValue which detects and logs errors
- // in the execution context.
- function completeValueCatchingError(
- exeContext: ExecutionContext,
- returnType: GraphQLOutputType,
- fieldNodes: $ReadOnlyArray<FieldNode>,
- info: GraphQLResolveInfo,
- path: Path,
- result: mixed,
- ): PromiseOrValue<mixed> {
- try {
- let completed;
- if (isPromise(result)) {
- completed = result.then(resolved =>
- completeValue(exeContext, returnType, fieldNodes, info, path, resolved),
- );
- } else {
- completed = completeValue(
- exeContext,
- returnType,
- fieldNodes,
- info,
- path,
- result,
- );
- }
- if (isPromise(completed)) {
- // Note: we don't rely on a `catch` method, but we do expect "thenable"
- // to take a second callback for the error case.
- return completed.then(undefined, error =>
- handleFieldError(error, fieldNodes, path, returnType, exeContext),
- );
- }
- return completed;
- } catch (error) {
- return handleFieldError(error, fieldNodes, path, returnType, exeContext);
- }
- }
- function handleFieldError(rawError, fieldNodes, path, returnType, exeContext) {
- const error = locatedError(
- asErrorInstance(rawError),
- fieldNodes,
- pathToArray(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 (isNonNullType(returnType)) {
- throw error;
- }
- // Otherwise, error protection is applied, logging the error and resolving
- // a null value for this field if one is encountered.
- exeContext.errors.push(error);
- return null;
- }
- /**
- * 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.
- */
- function completeValue(
- exeContext: ExecutionContext,
- returnType: GraphQLOutputType,
- fieldNodes: $ReadOnlyArray<FieldNode>,
- info: GraphQLResolveInfo,
- path: Path,
- result: mixed,
- ): PromiseOrValue<mixed> {
- // If result is an Error, throw a located error.
- if (result instanceof Error) {
- throw result;
- }
- // If field type is NonNull, complete for inner type, and throw field error
- // if result is null.
- if (isNonNullType(returnType)) {
- const completed = completeValue(
- exeContext,
- returnType.ofType,
- fieldNodes,
- info,
- path,
- result,
- );
- if (completed === null) {
- throw new Error(
- `Cannot return null for non-nullable field ${info.parentType.name}.${info.fieldName}.`,
- );
- }
- return completed;
- }
- // If result value is null-ish (null, undefined, or NaN) then return null.
- if (isNullish(result)) {
- return null;
- }
- // If field type is List, complete each item in the list with the inner type
- if (isListType(returnType)) {
- return completeListValue(
- exeContext,
- returnType,
- fieldNodes,
- info,
- path,
- result,
- );
- }
- // If field type is a leaf type, Scalar or Enum, serialize to a valid value,
- // returning null if serialization is not possible.
- if (isLeafType(returnType)) {
- return completeLeafValue(returnType, result);
- }
- // If field type is an abstract type, Interface or Union, determine the
- // runtime Object type and complete for that type.
- if (isAbstractType(returnType)) {
- return completeAbstractValue(
- exeContext,
- returnType,
- fieldNodes,
- info,
- path,
- result,
- );
- }
- // If field type is Object, execute and complete all sub-selections.
- if (isObjectType(returnType)) {
- return completeObjectValue(
- exeContext,
- returnType,
- fieldNodes,
- info,
- path,
- result,
- );
- }
- // Not reachable. All possible output types have been considered.
- invariant(
- false,
- 'Cannot complete value of unexpected output type: ' +
- inspect((returnType: empty)),
- );
- }
- /**
- * Complete a list value by completing each item in the list with the
- * inner type
- */
- function completeListValue(
- exeContext: ExecutionContext,
- returnType: GraphQLList<GraphQLOutputType>,
- fieldNodes: $ReadOnlyArray<FieldNode>,
- info: GraphQLResolveInfo,
- path: Path,
- result: mixed,
- ): PromiseOrValue<$ReadOnlyArray<mixed>> {
- if (!isCollection(result)) {
- throw new GraphQLError(
- `Expected Iterable, but did not find one for field ${info.parentType.name}.${info.fieldName}.`,
- );
- }
- // This is specified as a simple map, however we're optimizing the path
- // where the list contains no Promises by avoiding creating another Promise.
- const itemType = returnType.ofType;
- let containsPromise = false;
- const completedResults = [];
- forEach((result: any), (item, index) => {
- // No need to modify the info object containing the path,
- // since from here on it is not ever accessed by resolver functions.
- const fieldPath = addPath(path, index);
- const completedItem = completeValueCatchingError(
- exeContext,
- itemType,
- fieldNodes,
- info,
- fieldPath,
- item,
- );
- if (!containsPromise && isPromise(completedItem)) {
- containsPromise = true;
- }
- completedResults.push(completedItem);
- });
- return containsPromise ? Promise.all(completedResults) : completedResults;
- }
- /**
- * Complete a Scalar or Enum by serializing to a valid value, returning
- * null if serialization is not possible.
- */
- function completeLeafValue(returnType: GraphQLLeafType, result: mixed): mixed {
- const serializedResult = returnType.serialize(result);
- if (isInvalid(serializedResult)) {
- throw new Error(
- `Expected a value of type "${inspect(returnType)}" but ` +
- `received: ${inspect(result)}`,
- );
- }
- return serializedResult;
- }
- /**
- * Complete a value of an abstract type by determining the runtime object type
- * of that value, then complete the value for that type.
- */
- function completeAbstractValue(
- exeContext: ExecutionContext,
- returnType: GraphQLAbstractType,
- fieldNodes: $ReadOnlyArray<FieldNode>,
- info: GraphQLResolveInfo,
- path: Path,
- result: mixed,
- ): PromiseOrValue<ObjMap<mixed>> {
- const resolveTypeFn = returnType.resolveType || exeContext.typeResolver;
- const contextValue = exeContext.contextValue;
- const runtimeType = resolveTypeFn(result, contextValue, info, returnType);
- if (isPromise(runtimeType)) {
- return runtimeType.then(resolvedRuntimeType =>
- completeObjectValue(
- exeContext,
- ensureValidRuntimeType(
- resolvedRuntimeType,
- exeContext,
- returnType,
- fieldNodes,
- info,
- result,
- ),
- fieldNodes,
- info,
- path,
- result,
- ),
- );
- }
- return completeObjectValue(
- exeContext,
- ensureValidRuntimeType(
- runtimeType,
- exeContext,
- returnType,
- fieldNodes,
- info,
- result,
- ),
- fieldNodes,
- info,
- path,
- result,
- );
- }
- function ensureValidRuntimeType(
- runtimeTypeOrName: ?GraphQLObjectType | string,
- exeContext: ExecutionContext,
- returnType: GraphQLAbstractType,
- fieldNodes: $ReadOnlyArray<FieldNode>,
- info: GraphQLResolveInfo,
- result: mixed,
- ): GraphQLObjectType {
- const runtimeType =
- typeof runtimeTypeOrName === 'string'
- ? exeContext.schema.getType(runtimeTypeOrName)
- : runtimeTypeOrName;
- if (!isObjectType(runtimeType)) {
- throw new GraphQLError(
- `Abstract type ${returnType.name} must resolve to an Object type at runtime for field ${info.parentType.name}.${info.fieldName} with ` +
- `value ${inspect(result)}, received "${inspect(runtimeType)}". ` +
- `Either the ${returnType.name} type should provide a "resolveType" function or each possible type should provide an "isTypeOf" function.`,
- fieldNodes,
- );
- }
- if (!exeContext.schema.isPossibleType(returnType, runtimeType)) {
- throw new GraphQLError(
- `Runtime Object type "${runtimeType.name}" is not a possible type for "${returnType.name}".`,
- fieldNodes,
- );
- }
- return runtimeType;
- }
- /**
- * Complete an Object value by executing all sub-selections.
- */
- function completeObjectValue(
- exeContext: ExecutionContext,
- returnType: GraphQLObjectType,
- fieldNodes: $ReadOnlyArray<FieldNode>,
- info: GraphQLResolveInfo,
- path: Path,
- result: mixed,
- ): PromiseOrValue<ObjMap<mixed>> {
- // 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.
- if (returnType.isTypeOf) {
- const isTypeOf = returnType.isTypeOf(result, exeContext.contextValue, info);
- if (isPromise(isTypeOf)) {
- return isTypeOf.then(resolvedIsTypeOf => {
- if (!resolvedIsTypeOf) {
- throw invalidReturnTypeError(returnType, result, fieldNodes);
- }
- return collectAndExecuteSubfields(
- exeContext,
- returnType,
- fieldNodes,
- path,
- result,
- );
- });
- }
- if (!isTypeOf) {
- throw invalidReturnTypeError(returnType, result, fieldNodes);
- }
- }
- return collectAndExecuteSubfields(
- exeContext,
- returnType,
- fieldNodes,
- path,
- result,
- );
- }
- function invalidReturnTypeError(
- returnType: GraphQLObjectType,
- result: mixed,
- fieldNodes: $ReadOnlyArray<FieldNode>,
- ): GraphQLError {
- return new GraphQLError(
- `Expected value of type "${returnType.name}" but got: ${inspect(result)}.`,
- fieldNodes,
- );
- }
- function collectAndExecuteSubfields(
- exeContext: ExecutionContext,
- returnType: GraphQLObjectType,
- fieldNodes: $ReadOnlyArray<FieldNode>,
- path: Path,
- result: mixed,
- ): PromiseOrValue<ObjMap<mixed>> {
- // Collect sub-fields to execute to complete this value.
- const subFieldNodes = collectSubfields(exeContext, returnType, fieldNodes);
- return executeFields(exeContext, 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.
- */
- const collectSubfields = memoize3(_collectSubfields);
- function _collectSubfields(
- exeContext: ExecutionContext,
- returnType: GraphQLObjectType,
- fieldNodes: $ReadOnlyArray<FieldNode>,
- ): ObjMap<Array<FieldNode>> {
- let subFieldNodes = Object.create(null);
- const visitedFragmentNames = Object.create(null);
- for (const node of fieldNodes) {
- if (node.selectionSet) {
- subFieldNodes = collectFields(
- exeContext,
- returnType,
- node.selectionSet,
- subFieldNodes,
- visitedFragmentNames,
- );
- }
- }
- return subFieldNodes;
- }
- /**
- * 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.
- */
- export const defaultTypeResolver: GraphQLTypeResolver<mixed, mixed> = function(
- value,
- contextValue,
- info,
- abstractType,
- ) {
- // First, look for `__typename`.
- if (isObjectLike(value) && typeof value.__typename === 'string') {
- return value.__typename;
- }
- // Otherwise, test each possible type.
- const possibleTypes = info.schema.getPossibleTypes(abstractType);
- const promisedIsTypeOfResults = [];
- for (let i = 0; i < possibleTypes.length; i++) {
- const type = possibleTypes[i];
- if (type.isTypeOf) {
- const isTypeOfResult = type.isTypeOf(value, contextValue, info);
- if (isPromise(isTypeOfResult)) {
- promisedIsTypeOfResults[i] = isTypeOfResult;
- } else if (isTypeOfResult) {
- return type;
- }
- }
- }
- if (promisedIsTypeOfResults.length) {
- return Promise.all(promisedIsTypeOfResults).then(isTypeOfResults => {
- for (let i = 0; i < isTypeOfResults.length; i++) {
- if (isTypeOfResults[i]) {
- return possibleTypes[i];
- }
- }
- });
- }
- };
- /**
- * If a resolve function is not given, then a default resolve behavior is used
- * which takes the property of the source object of the same name as the field
- * and returns it as the result, or if it's a function, returns the result
- * of calling that function while passing along args and context value.
- */
- export const defaultFieldResolver: GraphQLFieldResolver<
- mixed,
- mixed,
- > = function(source: any, args, contextValue, info) {
- // ensure source is a value for which property access is acceptable.
- if (isObjectLike(source) || typeof source === 'function') {
- const property = source[info.fieldName];
- if (typeof property === 'function') {
- return source[info.fieldName](args, contextValue, info);
- }
- return property;
- }
- };
- /**
- * 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.
- */
- export function getFieldDef(
- schema: GraphQLSchema,
- parentType: GraphQLObjectType,
- fieldName: string,
- ): ?GraphQLField<mixed, mixed> {
- if (
- fieldName === SchemaMetaFieldDef.name &&
- schema.getQueryType() === parentType
- ) {
- return SchemaMetaFieldDef;
- } else if (
- fieldName === TypeMetaFieldDef.name &&
- schema.getQueryType() === parentType
- ) {
- return TypeMetaFieldDef;
- } else if (fieldName === TypeNameMetaFieldDef.name) {
- return TypeNameMetaFieldDef;
- }
- return parentType.getFields()[fieldName];
- }
|