KnownDirectivesRule.mjs 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  1. import { inspect } from '../../jsutils/inspect.mjs';
  2. import { invariant } from '../../jsutils/invariant.mjs';
  3. import { GraphQLError } from '../../error/GraphQLError.mjs';
  4. import { OperationTypeNode } from '../../language/ast.mjs';
  5. import { DirectiveLocation } from '../../language/directiveLocation.mjs';
  6. import { Kind } from '../../language/kinds.mjs';
  7. import { specifiedDirectives } from '../../type/directives.mjs';
  8. /**
  9. * Known directives
  10. *
  11. * A GraphQL document is only valid if all `@directives` are known by the
  12. * schema and legally positioned.
  13. *
  14. * See https://spec.graphql.org/draft/#sec-Directives-Are-Defined
  15. */
  16. export function KnownDirectivesRule(context) {
  17. const locationsMap = Object.create(null);
  18. const schema = context.getSchema();
  19. const definedDirectives = schema
  20. ? schema.getDirectives()
  21. : specifiedDirectives;
  22. for (const directive of definedDirectives) {
  23. locationsMap[directive.name] = directive.locations;
  24. }
  25. const astDefinitions = context.getDocument().definitions;
  26. for (const def of astDefinitions) {
  27. if (def.kind === Kind.DIRECTIVE_DEFINITION) {
  28. locationsMap[def.name.value] = def.locations.map((name) => name.value);
  29. }
  30. }
  31. return {
  32. Directive(node, _key, _parent, _path, ancestors) {
  33. const name = node.name.value;
  34. const locations = locationsMap[name];
  35. if (!locations) {
  36. context.reportError(
  37. new GraphQLError(`Unknown directive "@${name}".`, {
  38. nodes: node,
  39. }),
  40. );
  41. return;
  42. }
  43. const candidateLocation = getDirectiveLocationForASTPath(ancestors);
  44. if (candidateLocation && !locations.includes(candidateLocation)) {
  45. context.reportError(
  46. new GraphQLError(
  47. `Directive "@${name}" may not be used on ${candidateLocation}.`,
  48. {
  49. nodes: node,
  50. },
  51. ),
  52. );
  53. }
  54. },
  55. };
  56. }
  57. function getDirectiveLocationForASTPath(ancestors) {
  58. const appliedTo = ancestors[ancestors.length - 1];
  59. 'kind' in appliedTo || invariant(false);
  60. switch (appliedTo.kind) {
  61. case Kind.OPERATION_DEFINITION:
  62. return getDirectiveLocationForOperation(appliedTo.operation);
  63. case Kind.FIELD:
  64. return DirectiveLocation.FIELD;
  65. case Kind.FRAGMENT_SPREAD:
  66. return DirectiveLocation.FRAGMENT_SPREAD;
  67. case Kind.INLINE_FRAGMENT:
  68. return DirectiveLocation.INLINE_FRAGMENT;
  69. case Kind.FRAGMENT_DEFINITION:
  70. return DirectiveLocation.FRAGMENT_DEFINITION;
  71. case Kind.VARIABLE_DEFINITION:
  72. return DirectiveLocation.VARIABLE_DEFINITION;
  73. case Kind.SCHEMA_DEFINITION:
  74. case Kind.SCHEMA_EXTENSION:
  75. return DirectiveLocation.SCHEMA;
  76. case Kind.SCALAR_TYPE_DEFINITION:
  77. case Kind.SCALAR_TYPE_EXTENSION:
  78. return DirectiveLocation.SCALAR;
  79. case Kind.OBJECT_TYPE_DEFINITION:
  80. case Kind.OBJECT_TYPE_EXTENSION:
  81. return DirectiveLocation.OBJECT;
  82. case Kind.FIELD_DEFINITION:
  83. return DirectiveLocation.FIELD_DEFINITION;
  84. case Kind.INTERFACE_TYPE_DEFINITION:
  85. case Kind.INTERFACE_TYPE_EXTENSION:
  86. return DirectiveLocation.INTERFACE;
  87. case Kind.UNION_TYPE_DEFINITION:
  88. case Kind.UNION_TYPE_EXTENSION:
  89. return DirectiveLocation.UNION;
  90. case Kind.ENUM_TYPE_DEFINITION:
  91. case Kind.ENUM_TYPE_EXTENSION:
  92. return DirectiveLocation.ENUM;
  93. case Kind.ENUM_VALUE_DEFINITION:
  94. return DirectiveLocation.ENUM_VALUE;
  95. case Kind.INPUT_OBJECT_TYPE_DEFINITION:
  96. case Kind.INPUT_OBJECT_TYPE_EXTENSION:
  97. return DirectiveLocation.INPUT_OBJECT;
  98. case Kind.INPUT_VALUE_DEFINITION: {
  99. const parentNode = ancestors[ancestors.length - 3];
  100. 'kind' in parentNode || invariant(false);
  101. return parentNode.kind === Kind.INPUT_OBJECT_TYPE_DEFINITION
  102. ? DirectiveLocation.INPUT_FIELD_DEFINITION
  103. : DirectiveLocation.ARGUMENT_DEFINITION;
  104. }
  105. // Not reachable, all possible types have been considered.
  106. /* c8 ignore next */
  107. default:
  108. false || invariant(false, 'Unexpected kind: ' + inspect(appliedTo.kind));
  109. }
  110. }
  111. function getDirectiveLocationForOperation(operation) {
  112. switch (operation) {
  113. case OperationTypeNode.QUERY:
  114. return DirectiveLocation.QUERY;
  115. case OperationTypeNode.MUTATION:
  116. return DirectiveLocation.MUTATION;
  117. case OperationTypeNode.SUBSCRIPTION:
  118. return DirectiveLocation.SUBSCRIPTION;
  119. }
  120. }