RFC: Directive location: schema definition (#382)

This allows directives to be defined on schema definitions.

Author: leebyron

src/language/ast.js

@@ -268,6 +268,7 @@ export type TypeSystemDefinition = SchemaDefinition
 export type SchemaDefinition = {
   kind: 'SchemaDefinition';
   loc?: ?Location;
+  directives: Array<Directive>;
   operationTypes: Array<OperationTypeDefinition>;
 }
 

src/language/parser.js

@@ -701,13 +701,14 @@ function parseTypeSystemDefinition(parser: Parser): TypeSystemDefinition {
 }
 
 /**
- * SchemaDefinition : schema { OperationTypeDefinition+ }
+ * SchemaDefinition : schema Directives? { OperationTypeDefinition+ }
  *
  * OperationTypeDefinition : OperationType : NamedType
  */
 function parseSchemaDefinition(parser: Parser): SchemaDefinition {
   const start = parser.token.start;
   expectKeyword(parser, 'schema');
+  const directives = parseDirectives(parser);
   const operationTypes = many(
     parser,
     TokenKind.BRACE_L,
@@ -716,6 +717,7 @@ function parseSchemaDefinition(parser: Parser): SchemaDefinition {
   );
   return {
     kind: SCHEMA_DEFINITION,
+    directives,
     operationTypes,
     loc: loc(parser, start),
   };

src/language/printer.js

@@ -94,8 +94,12 @@ const printDocASTReducer = {
 
   // Type System Definitions
 
-  SchemaDefinition: ({ operationTypes }) =>
-    'schema ' + block(operationTypes),
+  SchemaDefinition: ({ directives, operationTypes }) =>
+    join([
+      'schema',
+      join(directives, ' '),
+      block(operationTypes),
+    ], ' '),
 
   OperationTypeDefinition: ({ operation, type }) =>
     operation + ': ' + type,

src/language/visitor.js

@@ -38,7 +38,7 @@ export const QueryDocumentKeys = {
   ListType: [ 'type' ],
   NonNullType: [ 'type' ],
 
-  SchemaDefinition: [ 'operationTypes' ],
+  SchemaDefinition: [ 'directives', 'operationTypes' ],
   OperationTypeDefinition: [ 'type' ],
 
   ScalarTypeDefinition: [ 'name', 'directives' ],

src/type/directives.js

@@ -28,6 +28,7 @@ export const DirectiveLocation = {
   FRAGMENT_SPREAD: 'FRAGMENT_SPREAD',
   INLINE_FRAGMENT: 'INLINE_FRAGMENT',
   // Schema Definitions
+  SCHEMA: 'SCHEMA',
   SCALAR: 'SCALAR',
   OBJECT: 'OBJECT',
   FIELD_DEFINITION: 'FIELD_DEFINITION',

src/type/introspection.js

@@ -149,6 +149,10 @@ export const __DirectiveLocation = new GraphQLEnumType({
       value: DirectiveLocation.INLINE_FRAGMENT,
       description: 'Location adjacent to an inline fragment.'
     },
+    SCHEMA: {
+      value: DirectiveLocation.SCHEMA,
+      description: 'Location adjacent to a schema definition.'
+    },
     SCALAR: {
       value: DirectiveLocation.SCALAR,
       description: 'Location adjacent to a scalar definition.'

src/utilities/__tests__/schemaPrinter-test.js

@@ -620,6 +620,7 @@ enum __DirectiveLocation {
   FRAGMENT_DEFINITION
   FRAGMENT_SPREAD
   INLINE_FRAGMENT
+  SCHEMA
   SCALAR
   OBJECT
   FIELD_DEFINITION

src/validation/__tests__/KnownDirectives-test.js

@@ -149,6 +149,10 @@ describe('Validate: Known directives', () => {
         input MyInput @onInputObject {
           myField: Int @onInputFieldDefinition
         }
+
+        schema @onSchema {
+          query: MyQuery
+        }
       `);
     });
 
@@ -173,6 +177,10 @@ describe('Validate: Known directives', () => {
         input MyInput @onEnum {
           myField: Int @onArgumentDefinition
         }
+
+        schema @onObject {
+          query: MyQuery
+        }
       `, [
         misplacedDirective('onInterface', 'OBJECT', 2, 43),
         misplacedDirective('onInputFieldDefinition', 'ARGUMENT_DEFINITION', 3, 30),
@@ -186,6 +194,7 @@ describe('Validate: Known directives', () => {
         misplacedDirective('onUnion', 'ENUM_VALUE', 15, 20),
         misplacedDirective('onEnum', 'INPUT_OBJECT', 18, 23),
         misplacedDirective('onArgumentDefinition', 'INPUT_FIELD_DEFINITION', 19, 24),
+        misplacedDirective('onObject', 'SCHEMA', 22, 16),
       ]);
     });
 

src/validation/__tests__/harness.js

@@ -336,6 +336,10 @@ export const testSchema = new GraphQLSchema({
       name: 'onInlineFragment',
       locations: [ 'INLINE_FRAGMENT' ],
     }),
+    new GraphQLDirective({
+      name: 'onSchema',
+      locations: [ 'SCHEMA' ],
+    }),
     new GraphQLDirective({
       name: 'onScalar',
       locations: [ 'SCALAR' ],

src/validation/rules/KnownDirectives.js

@@ -17,15 +17,16 @@ import {
   FRAGMENT_SPREAD,
   INLINE_FRAGMENT,
   OPERATION_DEFINITION,
-  ENUM_TYPE_DEFINITION,
-  ENUM_VALUE_DEFINITION,
+  SCHEMA_DEFINITION,
+  SCALAR_TYPE_DEFINITION,
+  OBJECT_TYPE_DEFINITION,
   FIELD_DEFINITION,
-  INPUT_OBJECT_TYPE_DEFINITION,
   INPUT_VALUE_DEFINITION,
   INTERFACE_TYPE_DEFINITION,
-  OBJECT_TYPE_DEFINITION,
-  SCALAR_TYPE_DEFINITION,
   UNION_TYPE_DEFINITION,
+  ENUM_TYPE_DEFINITION,
+  ENUM_VALUE_DEFINITION,
+  INPUT_OBJECT_TYPE_DEFINITION,
 } from '../../language/kinds';
 import { DirectiveLocation } from '../../type/directives';
 
@@ -91,6 +92,7 @@ function getDirectiveLocationForASTPath(ancestors) {
     case FRAGMENT_SPREAD: return DirectiveLocation.FRAGMENT_SPREAD;
     case INLINE_FRAGMENT: return DirectiveLocation.INLINE_FRAGMENT;
     case FRAGMENT_DEFINITION: return DirectiveLocation.FRAGMENT_DEFINITION;
+    case SCHEMA_DEFINITION: return DirectiveLocation.SCHEMA;
     case SCALAR_TYPE_DEFINITION: return DirectiveLocation.SCALAR;
     case OBJECT_TYPE_DEFINITION: return DirectiveLocation.OBJECT;
     case FIELD_DEFINITION: return DirectiveLocation.FIELD_DEFINITION;