@graphql-tools/graphql
Version:
Fork of GraphQL.js
86 lines (85 loc) • 4.11 kB
JavaScript
import { inspect } from '../../jsutils/inspect.js';
import { keyMap } from '../../jsutils/keyMap.js';
import { GraphQLError } from '../../error/GraphQLError.js';
import { Kind } from '../../language/kinds.js';
import { print } from '../../language/printer.js';
import { isRequiredArgument, isType } from '../../type/definition.js';
import { specifiedDirectives } from '../../type/directives.js';
/**
* 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 {
...ProvidedRequiredArgumentsOnDirectivesRule(context),
Field: {
// Validate on leave to allow for deeper errors to appear first.
leave(fieldNode) {
var _a;
const fieldDef = context.getFieldDef();
if (!fieldDef) {
return false;
}
const providedArgs = new Set(
// FIXME: https://github.com/graphql/graphql-js/issues/2203
/* c8 ignore next */
(_a = fieldNode.arguments) === null || _a === void 0 ? void 0 : _a.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 }));
}
}
return undefined;
},
},
};
}
/**
* @internal
*/
export function ProvidedRequiredArgumentsOnDirectivesRule(context) {
var _a, _b;
const requiredArgsMap = Object.create(null);
const schema = context.getSchema();
const definedDirectives = (_a = schema === null || schema === void 0 ? void 0 : schema.getDirectives()) !== null && _a !== void 0 ? _a : 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) {
// FIXME: https://github.com/graphql/graphql-js/issues/2203
/* c8 ignore next */
const argNodes = (_b = def.arguments) !== null && _b !== void 0 ? _b : [];
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) {
var _a;
const directiveName = directiveNode.name.value;
const requiredArgs = requiredArgsMap[directiveName];
if (requiredArgs) {
// FIXME: https://github.com/graphql/graphql-js/issues/2203
/* c8 ignore next */
const argNodes = (_a = directiveNode.arguments) !== null && _a !== void 0 ? _a : [];
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;
}