| /** @category Validation Rules */ |
| import { GraphQLError } from '../../error/GraphQLError.mjs'; |
| import { Kind } from '../../language/kinds.mjs'; |
| import { |
| isTypeDefinitionNode, |
| isTypeExtensionNode, |
| } from '../../language/predicates.mjs'; |
| import { specifiedDirectives } from '../../type/directives.mjs'; |
| |
| /** |
| * Unique directive names per location |
| * |
| * A GraphQL document is only valid if all non-repeatable directives at |
| * a given location are uniquely named. |
| * |
| * See https://spec.graphql.org/draft/#sec-Directives-Are-Unique-Per-Location |
| * @param context - The validation context used while checking the document. |
| * @returns A visitor that reports validation errors for this rule. |
| * @example |
| * ```ts |
| * import { buildSchema, parse, validate } from 'graphql'; |
| * import { UniqueDirectivesPerLocationRule } from 'graphql/validation'; |
| * |
| * const schema = buildSchema(` |
| * type Query { |
| * name: String |
| * } |
| * `); |
| * |
| * const invalidDocument = parse(` |
| * { name @include(if: true) @include(if: false) } |
| * `); |
| * const invalidErrors = validate(schema, invalidDocument, [UniqueDirectivesPerLocationRule]); |
| * |
| * invalidErrors.length; // => 1 |
| * |
| * const validDocument = parse(` |
| * { name @include(if: true) } |
| * `); |
| * const validErrors = validate(schema, validDocument, [UniqueDirectivesPerLocationRule]); |
| * |
| * validErrors; // => [] |
| * ``` |
| */ |
| export function UniqueDirectivesPerLocationRule(context) { |
| const uniqueDirectiveMap = Object.create(null); |
| const schema = context.getSchema(); |
| const definedDirectives = schema |
| ? schema.getDirectives() |
| : specifiedDirectives; |
| |
| for (const directive of definedDirectives) { |
| uniqueDirectiveMap[directive.name] = !directive.isRepeatable; |
| } |
| |
| const astDefinitions = context.getDocument().definitions; |
| |
| for (const def of astDefinitions) { |
| if (def.kind === Kind.DIRECTIVE_DEFINITION) { |
| uniqueDirectiveMap[def.name.value] = !def.repeatable; |
| } |
| } |
| |
| const schemaDirectives = Object.create(null); |
| const typeDirectivesMap = Object.create(null); |
| const directiveDirectivesMap = Object.create(null); |
| return { |
| // Many different AST nodes may contain directives. Rather than listing |
| // them all, just listen for entering any node, and check to see if it |
| // defines any directives. |
| enter(node) { |
| if (!('directives' in node) || !node.directives) { |
| return; |
| } |
| |
| let seenDirectives; |
| |
| if ( |
| node.kind === Kind.SCHEMA_DEFINITION || |
| node.kind === Kind.SCHEMA_EXTENSION |
| ) { |
| seenDirectives = schemaDirectives; |
| } else if (isTypeDefinitionNode(node) || isTypeExtensionNode(node)) { |
| const typeName = node.name.value; |
| seenDirectives = typeDirectivesMap[typeName]; |
| |
| if (seenDirectives === undefined) { |
| typeDirectivesMap[typeName] = seenDirectives = Object.create(null); |
| } |
| } else if ( |
| node.kind === Kind.DIRECTIVE_DEFINITION || |
| node.kind === Kind.DIRECTIVE_EXTENSION |
| ) { |
| const directiveName = node.name.value; |
| seenDirectives = directiveDirectivesMap[directiveName]; |
| |
| if (seenDirectives === undefined) { |
| directiveDirectivesMap[directiveName] = seenDirectives = |
| Object.create(null); |
| } |
| } else { |
| seenDirectives = Object.create(null); |
| } |
| |
| for (const directive of node.directives) { |
| const directiveName = directive.name.value; |
| |
| if (uniqueDirectiveMap[directiveName]) { |
| if (seenDirectives[directiveName]) { |
| context.reportError( |
| new GraphQLError( |
| `The directive "@${directiveName}" can only be used once at this location.`, |
| { |
| nodes: [seenDirectives[directiveName], directive], |
| }, |
| ), |
| ); |
| } else { |
| seenDirectives[directiveName] = directive; |
| } |
| } |
| } |
| }, |
| }; |
| } |