123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195 |
- // @flow strict
- import objectValues from '../polyfills/objectValues';
- import type { Path } from '../jsutils/Path';
- import inspect from '../jsutils/inspect';
- import invariant from '../jsutils/invariant';
- import didYouMean from '../jsutils/didYouMean';
- import isObjectLike from '../jsutils/isObjectLike';
- import safeArrayFrom from '../jsutils/safeArrayFrom';
- import suggestionList from '../jsutils/suggestionList';
- import printPathArray from '../jsutils/printPathArray';
- import { addPath, pathToArray } from '../jsutils/Path';
- import { GraphQLError } from '../error/GraphQLError';
- import type { GraphQLInputType } from '../type/definition';
- import {
- isLeafType,
- isInputObjectType,
- isListType,
- isNonNullType,
- } from '../type/definition';
- type OnErrorCB = (
- path: $ReadOnlyArray<string | number>,
- invalidValue: mixed,
- error: GraphQLError,
- ) => void;
- /**
- * Coerces a JavaScript value given a GraphQL Input Type.
- */
- export function coerceInputValue(
- inputValue: mixed,
- type: GraphQLInputType,
- onError: OnErrorCB = defaultOnError,
- ): mixed {
- return coerceInputValueImpl(inputValue, type, onError);
- }
- function defaultOnError(
- path: $ReadOnlyArray<string | number>,
- invalidValue: mixed,
- error: GraphQLError,
- ): void {
- let errorPrefix = 'Invalid value ' + inspect(invalidValue);
- if (path.length > 0) {
- errorPrefix += ` at "value${printPathArray(path)}"`;
- }
- error.message = errorPrefix + ': ' + error.message;
- throw error;
- }
- function coerceInputValueImpl(
- inputValue: mixed,
- type: GraphQLInputType,
- onError: OnErrorCB,
- path: Path | void,
- ): mixed {
- if (isNonNullType(type)) {
- if (inputValue != null) {
- return coerceInputValueImpl(inputValue, type.ofType, onError, path);
- }
- onError(
- pathToArray(path),
- inputValue,
- new GraphQLError(
- `Expected non-nullable type "${inspect(type)}" not to be null.`,
- ),
- );
- return;
- }
- if (inputValue == null) {
- // Explicitly return the value null.
- return null;
- }
- if (isListType(type)) {
- const itemType = type.ofType;
- const coercedList = safeArrayFrom(inputValue, (itemValue, index) => {
- const itemPath = addPath(path, index, undefined);
- return coerceInputValueImpl(itemValue, itemType, onError, itemPath);
- });
- if (coercedList != null) {
- return coercedList;
- }
- // Lists accept a non-list value as a list of one.
- return [coerceInputValueImpl(inputValue, itemType, onError, path)];
- }
- if (isInputObjectType(type)) {
- if (!isObjectLike(inputValue)) {
- onError(
- pathToArray(path),
- inputValue,
- new GraphQLError(`Expected type "${type.name}" to be an object.`),
- );
- return;
- }
- const coercedValue = {};
- const fieldDefs = type.getFields();
- for (const field of objectValues(fieldDefs)) {
- const fieldValue = inputValue[field.name];
- if (fieldValue === undefined) {
- if (field.defaultValue !== undefined) {
- coercedValue[field.name] = field.defaultValue;
- } else if (isNonNullType(field.type)) {
- const typeStr = inspect(field.type);
- onError(
- pathToArray(path),
- inputValue,
- new GraphQLError(
- `Field "${field.name}" of required type "${typeStr}" was not provided.`,
- ),
- );
- }
- continue;
- }
- coercedValue[field.name] = coerceInputValueImpl(
- fieldValue,
- field.type,
- onError,
- addPath(path, field.name, type.name),
- );
- }
- // Ensure every provided field is defined.
- for (const fieldName of Object.keys(inputValue)) {
- if (!fieldDefs[fieldName]) {
- const suggestions = suggestionList(
- fieldName,
- Object.keys(type.getFields()),
- );
- onError(
- pathToArray(path),
- inputValue,
- new GraphQLError(
- `Field "${fieldName}" is not defined by type "${type.name}".` +
- didYouMean(suggestions),
- ),
- );
- }
- }
- return coercedValue;
- }
- // istanbul ignore else (See: 'https://github.com/graphql/graphql-js/issues/2618')
- if (isLeafType(type)) {
- let parseResult;
- // Scalars and Enums determine if a input value is valid via parseValue(),
- // which can throw to indicate failure. If it throws, maintain a reference
- // to the original error.
- try {
- parseResult = type.parseValue(inputValue);
- } catch (error) {
- if (error instanceof GraphQLError) {
- onError(pathToArray(path), inputValue, error);
- } else {
- onError(
- pathToArray(path),
- inputValue,
- new GraphQLError(
- `Expected type "${type.name}". ` + error.message,
- undefined,
- undefined,
- undefined,
- undefined,
- error,
- ),
- );
- }
- return;
- }
- if (parseResult === undefined) {
- onError(
- pathToArray(path),
- inputValue,
- new GraphQLError(`Expected type "${type.name}".`),
- );
- }
- return parseResult;
- }
- // istanbul ignore next (Not reachable. All possible input types have been considered)
- invariant(false, 'Unexpected input type: ' + inspect((type: empty)));
- }
|