Support Apollo directives (#505)

docs/essentials/validate.md

@@ -21,6 +21,7 @@ Run the following command:
 
 - `-d, --deprecated` - Fail on deprecated usage (default: _false_)
 - `--noStrictFragments` - Do not fail on duplicated fragment names (default: _false_)
+- `--apollo` - Support Apollo directives (@client and @connection) (default: _false_)
 - `--maxDepth <n>` - Fail when operation depth exceeds maximum depth (default: _false_)
 - `-r, --require <s>` - require a module
 - `-t, --token <s>` - an access token

packages/cli/src/commands/validate.ts

@@ -18,6 +18,7 @@ export async function validate(
     require?: string[];
     deprecated: boolean;
     noStrictFragments: boolean;
+    apollo?: boolean;
     maxDepth?: number;
     renderer?: Renderer;
     headers?: Record<string, string>;
@@ -34,6 +35,7 @@ export async function validate(
     const invalidDocuments = validateDocuments(schema, documents, {
       strictFragments: !options.noStrictFragments,
       maxDepth: options.maxDepth || undefined,
+      apollo: options.apollo || false,
     });
 
     if (!invalidDocuments.length) {

packages/cli/src/index.ts

@@ -63,6 +63,7 @@ commander
   .option('--maxDepth <n>', 'Fail on deep operations', (val: string) =>
     parseInt(val, 10),
   )
+  .option('--apollo', 'Support Apollo directives', false)
   .description('Validate documents against a schema')
   .action((documents: string, schema: string, cmd: commander.Command) =>
     validate(documents, schema, normalizeOptions(cmd)),

packages/core/__tests__/validate/apollo.ts

@@ -0,0 +1,64 @@
+import {buildSchema, Source, print, parse} from 'graphql';
+
+import {validate} from '../../src/validate';
+
+describe('apollo', () => {
+  test('should remove a filed with @client', () => {
+    const schema = buildSchema(/* GraphQL */ `
+      type Post {
+        id: ID
+        title: String
+      }
+
+      type Query {
+        post: Post
+      }
+    `);
+
+    const doc = parse(/* GraphQL */ `
+      query getPost {
+        post {
+          id
+          title
+          extra @client
+        }
+      }
+    `);
+
+    const results = validate(schema, [new Source(print(doc))], {
+      apollo: true,
+    });
+
+    expect(results).toHaveLength(0);
+  });
+
+  test('should include @connection', () => {
+    const schema = buildSchema(/* GraphQL */ `
+      type Post {
+        id: ID
+        title: String
+        comments: [String]
+      }
+
+      type Query {
+        post(id: ID!): Post
+      }
+    `);
+
+    const doc = parse(/* GraphQL */ `
+      query getPost {
+        post(id: 1) {
+          id
+          title
+          comments @connection(key: "comments")
+        }
+      }
+    `);
+
+    const results = validate(schema, [new Source(print(doc))], {
+      apollo: true,
+    });
+
+    expect(results).toHaveLength(0);
+  });
+});

packages/core/src/utils/apollo.ts

@@ -0,0 +1,22 @@
+import {DocumentNode, visit, parse, GraphQLSchema, extendSchema} from 'graphql';
+
+import {removeFieldIfDirectives} from './graphql';
+
+export function transformDocumentWithApollo(doc: DocumentNode): DocumentNode {
+  return visit(doc, {
+    Field(node) {
+      return removeFieldIfDirectives(node, ['client']);
+    },
+  });
+}
+
+export function transformSchemaWithApollo(
+  schema: GraphQLSchema,
+): GraphQLSchema {
+  return extendSchema(
+    schema,
+    parse(/* GraphQL */ `
+      directive @connection(key: String!, filter: [String]) on FIELD
+    `),
+  );
+}

packages/core/src/utils/graphql.ts

@@ -14,6 +14,7 @@ import {
   visit,
   visitWithTypeInfo,
   getNamedType,
+  FieldNode,
 } from 'graphql';
 
 export function safeChangeForField(
@@ -154,3 +155,18 @@ export function findDeprecatedUsages(
 
   return errors;
 }
+
+export function removeFieldIfDirectives(
+  node: FieldNode,
+  directiveNames: string[],
+): FieldNode | null {
+  if (node.directives) {
+    if (
+      node.directives.some(d => directiveNames.indexOf(d.name.value) !== -1)
+    ) {
+      return null;
+    }
+  }
+
+  return node;
+}

packages/core/src/validate/index.ts

@@ -13,6 +13,10 @@ import {DepGraph} from 'dependency-graph';
 import {readDocument} from '../ast/document';
 import {findDeprecatedUsages} from '../utils/graphql';
 import {validateQueryDepth} from './query-depth';
+import {
+  transformSchemaWithApollo,
+  transformDocumentWithApollo,
+} from '../utils/apollo';
 
 export interface InvalidDocument {
   source: Source;
@@ -23,6 +27,7 @@ export interface InvalidDocument {
 export interface ValidateOptions {
   strictFragments?: boolean;
   strictDeprecated?: boolean;
+  apollo?: boolean;
   maxDepth?: number;
 }
 
@@ -34,6 +39,7 @@ export function validate(
   const config: ValidateOptions = {
     strictDeprecated: true,
     strictFragments: true,
+    apollo: false,
     ...options,
   };
   const invalidDocuments: InvalidDocument[] = [];
@@ -89,12 +95,23 @@ export function validate(
         definitions: [...docWithOperations.definitions, ...extractedFragments],
       };
 
-      const errors = (validateDocument(schema, merged) as GraphQLError[]) || [];
+      const transformedSchema = config.apollo
+        ? transformSchemaWithApollo(schema)
+        : schema;
+      const transformedDoc = config.apollo
+        ? transformDocumentWithApollo(merged)
+        : merged;
+
+      const errors =
+        (validateDocument(
+          transformedSchema,
+          transformedDoc,
+        ) as GraphQLError[]) || [];
 
       if (config.maxDepth) {
         const depthError = validateQueryDepth({
           source: doc.source,
-          doc: merged,
+          doc: transformedDoc,
           maxDepth: config.maxDepth,
           fragmentGraph: graph,
         });
@@ -105,7 +122,7 @@ export function validate(
       }
 
       const deprecated = config.strictDeprecated
-        ? findDeprecatedUsages(schema, parse(doc.source.body))
+        ? findDeprecatedUsages(transformedSchema, parse(doc.source.body))
         : [];
       const duplicatedFragments = config.strictFragments
         ? findDuplicatedFragments(fragmentNames)