[Validation] Performance improvements

Fairly dramatic improvement of some validation rules by short-circuiting branches which do not need to be checked and memoizing the process of collecting fragment spreads from a given context - which is necessary by multiple rules.

Author: leebyron

src/validation/rules/ArgumentsOfCorrectType.js

@@ -38,6 +38,7 @@ export function ArgumentsOfCorrectType(context: ValidationContext): any {
           [ argAST.value ]
         );
       }
+      return false;
     }
   };
 }

src/validation/rules/DefaultValuesOfCorrectType.js

@@ -57,6 +57,9 @@ export function DefaultValuesOfCorrectType(context: ValidationContext): any {
           [ defaultValue ]
         );
       }
-    }
+      return false;
+    },
+    SelectionSet: () => false,
+    FragmentDefinition: () => false,
   };
 }

src/validation/rules/NoFragmentCycles.js

@@ -10,12 +10,7 @@
 
 import type { ValidationContext } from '../index';
 import { GraphQLError } from '../../error';
-import { FRAGMENT_SPREAD } from '../../language/kinds';
-import type {
-  SelectionSet,
-  FragmentSpread,
-  FragmentDefinition
-} from '../../language/ast';
+import type { FragmentDefinition } from '../../language/ast';
 
 
 export function cycleErrorMessage(
@@ -63,8 +58,7 @@ export function NoFragmentCycles(context: ValidationContext): any {
     const fragmentName = fragment.name.value;
     visitedFrags[fragmentName] = true;
 
-    const spreadNodes = [];
-    gatherSpreads(spreadNodes, fragment.selectionSet);
+    const spreadNodes = context.getFragmentSpreads(fragment);
     if (spreadNodes.length === 0) {
       return;
     }
@@ -100,19 +94,3 @@ export function NoFragmentCycles(context: ValidationContext): any {
     spreadPathIndexByName[fragmentName] = undefined;
   }
 }
-
-/**
- * Given an operation or fragment AST node, gather all the
- * named spreads defined within the scope of the fragment
- * or operation
- */
-function gatherSpreads(spreads: Array<FragmentSpread>, node: SelectionSet) {
-  for (let i = 0; i < node.selections.length; i++) {
-    const selection = node.selections[i];
-    if (selection.kind === FRAGMENT_SPREAD) {
-      spreads.push(selection);
-    } else if (selection.selectionSet) {
-      gatherSpreads(spreads, selection.selectionSet);
-    }
-  }
-}

src/validation/rules/NoUnusedFragments.js

@@ -8,6 +8,7 @@
  *  of patent rights can be found in the PATENTS file in the same directory.
  */
 
+import type { ValidationContext } from '../index';
 import { GraphQLError } from '../../error';
 
 
@@ -21,36 +22,30 @@ export function unusedFragMessage(fragName: any): string {
  * A GraphQL document is only valid if all fragment definitions are spread
  * within operations, or spread within other fragments spread within operations.
  */
-export function NoUnusedFragments(): any {
-  var fragmentDefs = [];
+export function NoUnusedFragments(context: ValidationContext): any {
   var spreadsWithinOperation = [];
-  var fragAdjacencies = {};
-  var spreadNames = {};
+  var fragmentDefs = [];
 
   return {
-    OperationDefinition() {
-      spreadNames = {};
-      spreadsWithinOperation.push(spreadNames);
+    OperationDefinition(node) {
+      spreadsWithinOperation.push(context.getFragmentSpreads(node));
+      return false;
     },
     FragmentDefinition(def) {
       fragmentDefs.push(def);
-      spreadNames = {};
-      fragAdjacencies[def.name.value] = spreadNames;
-    },
-    FragmentSpread(spread) {
-      spreadNames[spread.name.value] = true;
+      return false;
     },
     Document: {
       leave() {
         var fragmentNameUsed = {};
         var reduceSpreadFragments = function (spreads) {
-          var keys = Object.keys(spreads);
-          keys.forEach(fragName => {
+          spreads.forEach(spread => {
+            const fragName = spread.name.value;
             if (fragmentNameUsed[fragName] !== true) {
               fragmentNameUsed[fragName] = true;
-              var adjacencies = fragAdjacencies[fragName];
-              if (adjacencies) {
-                reduceSpreadFragments(adjacencies);
+              const fragment = context.getFragment(fragName);
+              if (fragment) {
+                reduceSpreadFragments(context.getFragmentSpreads(fragment));
               }
             }
           });

src/validation/rules/UniqueArgumentNames.js

@@ -39,6 +39,7 @@ export function UniqueArgumentNames(): any {
         );
       }
       knownArgNames[argName] = node.name;
+      return false;
     }
   };
 }

src/validation/rules/UniqueFragmentNames.js

@@ -23,6 +23,7 @@ export function duplicateFragmentNameMessage(fragName: any): string {
 export function UniqueFragmentNames(): any {
   var knownFragmentNames = Object.create(null);
   return {
+    OperationDefinition: () => false,
     FragmentDefinition(node) {
       var fragmentName = node.name.value;
       if (knownFragmentNames[fragmentName]) {
@@ -32,6 +33,7 @@ export function UniqueFragmentNames(): any {
         );
       }
       knownFragmentNames[fragmentName] = node.name;
+      return false;
     }
   };
 }

src/validation/rules/UniqueInputFieldNames.js

@@ -44,6 +44,7 @@ export function UniqueInputFieldNames(): any {
         );
       }
       knownNames[fieldName] = node.name;
+      return false;
     }
   };
 }

src/validation/rules/UniqueOperationNames.js

@@ -34,6 +34,8 @@ export function UniqueOperationNames(): any {
         }
         knownOperationNames[operationName.value] = operationName;
       }
-    }
+      return false;
+    },
+    FragmentDefinition: () => false,
   };
 }

src/validation/validate.js

@@ -14,6 +14,9 @@ import { visit, getVisitFn } from '../language/visitor';
 import * as Kind from '../language/kinds';
 import type {
   Document,
+  OperationDefinition,
+  SelectionSet,
+  FragmentSpread,
   FragmentDefinition,
 } from '../language/ast';
 import { GraphQLSchema } from '../type/schema';
@@ -171,6 +174,8 @@ function append(arr, items) {
   }
 }
 
+type HasSelectionSet = OperationDefinition | FragmentDefinition;
+
 /**
  * An instance of this class is passed as the "this" context to all validators,
  * allowing access to commonly useful contextual information from within a
@@ -181,11 +186,13 @@ export class ValidationContext {
   _ast: Document;
   _typeInfo: TypeInfo;
   _fragments: {[name: string]: FragmentDefinition};
+  _fragmentSpreads: Map<HasSelectionSet, Array<FragmentSpread>>;
 
   constructor(schema: GraphQLSchema, ast: Document, typeInfo: TypeInfo) {
     this._schema = schema;
     this._ast = ast;
     this._typeInfo = typeInfo;
+    this._fragmentSpreads = new Map();
   }
 
   getSchema(): GraphQLSchema {
@@ -210,6 +217,16 @@ export class ValidationContext {
     return fragments[name];
   }
 
+  getFragmentSpreads(node: HasSelectionSet): Array<FragmentSpread> {
+    let spreads = this._fragmentSpreads.get(node);
+    if (!spreads) {
+      spreads = [];
+      gatherSpreads(spreads, node.selectionSet);
+      this._fragmentSpreads.set(node, spreads);
+    }
+    return spreads;
+  }
+
   getType(): ?GraphQLOutputType {
     return this._typeInfo.getType();
   }
@@ -234,3 +251,17 @@ export class ValidationContext {
     return this._typeInfo.getArgument();
   }
 }
+
+/**
+ * Given a selection set, gather all the named spreads defined within.
+ */
+function gatherSpreads(spreads: Array<FragmentSpread>, node: SelectionSet) {
+  for (let i = 0; i < node.selections.length; i++) {
+    const selection = node.selections[i];
+    if (selection.kind === Kind.FRAGMENT_SPREAD) {
+      spreads.push(selection);
+    } else if (selection.selectionSet) {
+      gatherSpreads(spreads, selection.selectionSet);
+    }
+  }
+}