You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
142 lines
4.4 KiB
142 lines
4.4 KiB
import { inspect } from '../../jsutils/inspect.mjs'; |
|
import { keyMap } from '../../jsutils/keyMap.mjs'; |
|
import { GraphQLError } from '../../error/GraphQLError.mjs'; |
|
import { Kind } from '../../language/kinds.mjs'; |
|
import { print } from '../../language/printer.mjs'; |
|
import { isRequiredArgument, isType } from '../../type/definition.mjs'; |
|
import { specifiedDirectives } from '../../type/directives.mjs'; |
|
|
|
/** |
|
* Provided required arguments |
|
* |
|
* A field or directive is only valid if all required (non-null without a |
|
* default value) field arguments have been provided. |
|
*/ |
|
export function ProvidedRequiredArgumentsRule(context) { |
|
return { |
|
// eslint-disable-next-line new-cap |
|
...ProvidedRequiredArgumentsOnDirectivesRule(context), |
|
Field: { |
|
// Validate on leave to allow for deeper errors to appear first. |
|
leave(fieldNode) { |
|
var _fieldNode$arguments; |
|
|
|
const fieldDef = context.getFieldDef(); |
|
|
|
if (!fieldDef) { |
|
return false; |
|
} |
|
|
|
const providedArgs = new Set( // FIXME: https://github.com/graphql/graphql-js/issues/2203 |
|
/* c8 ignore next */ |
|
(_fieldNode$arguments = fieldNode.arguments) === null || |
|
_fieldNode$arguments === void 0 |
|
? void 0 |
|
: _fieldNode$arguments.map((arg) => arg.name.value), |
|
); |
|
|
|
for (const argDef of fieldDef.args) { |
|
if (!providedArgs.has(argDef.name) && isRequiredArgument(argDef)) { |
|
const argTypeStr = inspect(argDef.type); |
|
context.reportError( |
|
new GraphQLError( |
|
`Field "${fieldDef.name}" argument "${argDef.name}" of type "${argTypeStr}" is required, but it was not provided.`, |
|
{ |
|
nodes: fieldNode, |
|
}, |
|
), |
|
); |
|
} |
|
} |
|
}, |
|
}, |
|
}; |
|
} |
|
/** |
|
* @internal |
|
*/ |
|
|
|
export function ProvidedRequiredArgumentsOnDirectivesRule(context) { |
|
var _schema$getDirectives; |
|
|
|
const requiredArgsMap = Object.create(null); |
|
const schema = context.getSchema(); |
|
const definedDirectives = |
|
(_schema$getDirectives = |
|
schema === null || schema === void 0 |
|
? void 0 |
|
: schema.getDirectives()) !== null && _schema$getDirectives !== void 0 |
|
? _schema$getDirectives |
|
: specifiedDirectives; |
|
|
|
for (const directive of definedDirectives) { |
|
requiredArgsMap[directive.name] = keyMap( |
|
directive.args.filter(isRequiredArgument), |
|
(arg) => arg.name, |
|
); |
|
} |
|
|
|
const astDefinitions = context.getDocument().definitions; |
|
|
|
for (const def of astDefinitions) { |
|
if (def.kind === Kind.DIRECTIVE_DEFINITION) { |
|
var _def$arguments; |
|
|
|
// FIXME: https://github.com/graphql/graphql-js/issues/2203 |
|
|
|
/* c8 ignore next */ |
|
const argNodes = |
|
(_def$arguments = def.arguments) !== null && _def$arguments !== void 0 |
|
? _def$arguments |
|
: []; |
|
requiredArgsMap[def.name.value] = keyMap( |
|
argNodes.filter(isRequiredArgumentNode), |
|
(arg) => arg.name.value, |
|
); |
|
} |
|
} |
|
|
|
return { |
|
Directive: { |
|
// Validate on leave to allow for deeper errors to appear first. |
|
leave(directiveNode) { |
|
const directiveName = directiveNode.name.value; |
|
const requiredArgs = requiredArgsMap[directiveName]; |
|
|
|
if (requiredArgs) { |
|
var _directiveNode$argume; |
|
|
|
// FIXME: https://github.com/graphql/graphql-js/issues/2203 |
|
|
|
/* c8 ignore next */ |
|
const argNodes = |
|
(_directiveNode$argume = directiveNode.arguments) !== null && |
|
_directiveNode$argume !== void 0 |
|
? _directiveNode$argume |
|
: []; |
|
const argNodeMap = new Set(argNodes.map((arg) => arg.name.value)); |
|
|
|
for (const [argName, argDef] of Object.entries(requiredArgs)) { |
|
if (!argNodeMap.has(argName)) { |
|
const argType = isType(argDef.type) |
|
? inspect(argDef.type) |
|
: print(argDef.type); |
|
context.reportError( |
|
new GraphQLError( |
|
`Directive "@${directiveName}" argument "${argName}" of type "${argType}" is required, but it was not provided.`, |
|
{ |
|
nodes: directiveNode, |
|
}, |
|
), |
|
); |
|
} |
|
} |
|
} |
|
}, |
|
}, |
|
}; |
|
} |
|
|
|
function isRequiredArgumentNode(arg) { |
|
return arg.type.kind === Kind.NON_NULL_TYPE && arg.defaultValue == null; |
|
}
|
|
|