Add @stream directive to schema

Author: robrichard

src/index.ts

@@ -61,6 +61,7 @@ export {
   GraphQLIncludeDirective,
   GraphQLSkipDirective,
   GraphQLDeferDirective,
+  GraphQLStreamDirective,
   GraphQLDeprecatedDirective,
   GraphQLSpecifiedByDirective,
   /** "Enum" of Type Kinds */

src/type/directives.ts

@@ -13,7 +13,7 @@ import type {
   GraphQLFieldConfigArgumentMap,
 } from './definition';
 import { assertName } from './assertName';
-import { GraphQLString, GraphQLBoolean } from './scalars';
+import { GraphQLString, GraphQLBoolean, GraphQLInt } from './scalars';
 import {
   defineArguments,
   argsToArgsConfig,
@@ -188,6 +188,31 @@ export const GraphQLDeferDirective = new GraphQLDirective({
   },
 });
 
+/**
+ * Used to conditionally stream list fields.
+ */
+export const GraphQLStreamDirective = new GraphQLDirective({
+  name: 'stream',
+  description:
+    'Directs the executor to stream plural fields when the `if` argument is true or undefined.',
+  locations: [DirectiveLocation.FIELD],
+  args: {
+    if: {
+      type: GraphQLBoolean,
+      description: 'Stream when true or undefined.',
+    },
+    label: {
+      type: GraphQLString,
+      description: 'Unique name',
+    },
+    initialCount: {
+      defaultValue: 0,
+      type: GraphQLInt,
+      description: 'Number of items to return immediately',
+    },
+  },
+});
+
 /**
  * Constant string used for default reason for a deprecation.
  */

src/type/index.ts

@@ -132,6 +132,7 @@ export {
   GraphQLIncludeDirective,
   GraphQLSkipDirective,
   GraphQLDeferDirective,
+  GraphQLStreamDirective,
   GraphQLDeprecatedDirective,
   GraphQLSpecifiedByDirective,
   /** Constant Deprecation Reason */

src/type/schema.ts

@@ -25,6 +25,7 @@ import type { GraphQLDirective } from './directives';
 import { __Schema } from './introspection';
 import {
   GraphQLDeferDirective,
+  GraphQLStreamDirective,
   isDirective,
   specifiedDirectives,
 } from './directives';
@@ -187,6 +188,9 @@ export class GraphQLSchema {
       if (!this._directives.some((directive) => directive.name === 'defer')) {
         this._directives = [...this._directives, GraphQLDeferDirective];
       }
+      if (!this._directives.some((directive) => directive.name === 'stream')) {
+        this._directives = [...this._directives, GraphQLStreamDirective];
+      }
     }
 
     // To preserve order of user-provided types, we add first to add them to

src/utilities/__tests__/buildASTSchema-test.ts

@@ -20,6 +20,7 @@ import {
   GraphQLDeprecatedDirective,
   GraphQLSpecifiedByDirective,
   GraphQLDeferDirective,
+  GraphQLStreamDirective,
 } from '../../type/directives';
 import {
   GraphQLID,
@@ -156,8 +157,7 @@ describe('Schema Builder', () => {
   it('include standard type only if it is used', () => {
     const schema = buildSchema('type Query');
 
-    // String and Boolean are always included through introspection types
-    expect(schema.getType('Int')).to.equal(undefined);
+    // String, Boolean, and Int are always included through introspection types
     expect(schema.getType('Float')).to.equal(undefined);
     expect(schema.getType('ID')).to.equal(undefined);
   });
@@ -242,13 +242,14 @@ describe('Schema Builder', () => {
       directive @deprecated on FIELD_DEFINITION
       directive @specifiedBy on FIELD_DEFINITION
       directive @defer on FRAGMENT_SPREAD
+      directive @stream on FIELD
       `,
       {
         enableDeferStream: true,
       },
     );
 
-    expect(schema.getDirectives()).to.have.lengthOf(5);
+    expect(schema.getDirectives()).to.have.lengthOf(6);
     expect(schema.getDirective('skip')).to.not.equal(GraphQLSkipDirective);
     expect(schema.getDirective('include')).to.not.equal(
       GraphQLIncludeDirective,
@@ -260,6 +261,7 @@ describe('Schema Builder', () => {
       GraphQLSpecifiedByDirective,
     );
     expect(schema.getDirective('defer')).to.not.equal(GraphQLDeferDirective);
+    expect(schema.getDirective('stream')).to.not.equal(GraphQLStreamDirective);
   });
 
   it('Adding directives maintains @include, @skip & @specifiedBy', () => {
@@ -274,13 +276,14 @@ describe('Schema Builder', () => {
     expect(schema.getDirective('specifiedBy')).to.not.equal(undefined);
   });
 
-  it('Adds @defer when enableDeferStream flag is passed to schema', () => {
+  it('Adds @defer and stream when enableDeferStream flag is passed to schema', () => {
     const schema = buildSchema('type Query', {
       enableDeferStream: true,
     });
 
-    expect(schema.getDirectives()).to.have.lengthOf(5);
+    expect(schema.getDirectives()).to.have.lengthOf(6);
     expect(schema.getDirective('defer')).to.equal(GraphQLDeferDirective);
+    expect(schema.getDirective('stream')).to.equal(GraphQLStreamDirective);
     expect(schema.getDirective('skip')).to.equal(GraphQLSkipDirective);
     expect(schema.getDirective('include')).to.equal(GraphQLIncludeDirective);
     expect(schema.getDirective('deprecated')).to.equal(

src/utilities/__tests__/buildClientSchema-test.ts

@@ -153,7 +153,6 @@ describe('Type System: build schema from introspection', () => {
     const introspection = introspectionFromSchema(schema);
     const clientSchema = buildClientSchema(introspection);
 
-    expect(clientSchema.getType('Int')).to.equal(undefined);
     expect(clientSchema.getType('Float')).to.equal(undefined);
     expect(clientSchema.getType('ID')).to.equal(undefined);
   });

src/utilities/__tests__/extendSchema-test.ts

@@ -131,8 +131,7 @@ describe('extendSchema', () => {
   it('extends objects with standard type fields', () => {
     const schema = buildSchema('type Query');
 
-    // String and Boolean are always included through introspection types
-    expect(schema.getType('Int')).to.equal(undefined);
+    // String, Boolean, and Int are always included through introspection types
     expect(schema.getType('Float')).to.equal(undefined);
     expect(schema.getType('String')).to.equal(GraphQLString);
     expect(schema.getType('Boolean')).to.equal(GraphQLBoolean);
@@ -146,7 +145,6 @@ describe('extendSchema', () => {
     const extendedSchema = extendSchema(schema, extendAST);
 
     expect(validateSchema(extendedSchema)).to.deep.equal([]);
-    expect(extendedSchema.getType('Int')).to.equal(undefined);
     expect(extendedSchema.getType('Float')).to.equal(undefined);
     expect(extendedSchema.getType('String')).to.equal(GraphQLString);
     expect(extendedSchema.getType('Boolean')).to.equal(GraphQLBoolean);

src/utilities/__tests__/findBreakingChanges-test.ts

@@ -5,6 +5,7 @@ import { GraphQLSchema } from '../../type/schema';
 import {
   GraphQLSkipDirective,
   GraphQLDeferDirective,
+  GraphQLStreamDirective,
   GraphQLIncludeDirective,
   GraphQLSpecifiedByDirective,
   GraphQLDeprecatedDirective,
@@ -804,6 +805,7 @@ describe('findBreakingChanges', () => {
         GraphQLIncludeDirective,
         GraphQLSpecifiedByDirective,
         GraphQLDeferDirective,
+        GraphQLStreamDirective,
       ],
     });
 

src/validation/__tests__/KnownTypeNamesRule-test.ts

@@ -81,7 +81,7 @@ describe('Validate: Known type names', () => {
   it('references to standard scalars that are missing in schema', () => {
     const schema = buildSchema('type Query { foo: String }');
     const query = `
-      query ($id: ID, $float: Float, $int: Int) {
+      query ($id: ID, $float: Float) {
         __typename
       }
     `;
@@ -94,10 +94,6 @@ describe('Validate: Known type names', () => {
         message: 'Unknown type "Float".',
         locations: [{ line: 2, column: 31 }],
       },
-      {
-        message: 'Unknown type "Int".',
-        locations: [{ line: 2, column: 44 }],
-      },
     ]);
   });