[language server] Allow configuration of validation rules. (#1288)

* [language server] Allow configuration of validation rules.

* [language server] Allow filtering of default validation rules

Closes #1056

Author: alloy

CHANGELOG.md

@@ -20,6 +20,7 @@
   - <First `apollo-graphql` related entry goes here>
 - `apollo-language-server`
   - update stats window types [#1292](https://github.com/apollographql/apollo-tooling/pull/1292)
+  - Allow configuration of validation rules [#1288](https://github.com/apollographql/apollo-tooling/pull/1288)
 - `apollo-tools`
   - <First `apollo-tools` related entry goes here>
 - `vscode-apollo`

packages/apollo-codegen-core/src/loading.ts

@@ -87,7 +87,7 @@ function extractDocumentsWithAST(
         // This currently ignores the anti-pattern of including an interpolated
         // string as anything other than a fragment definition, for example a
         // literal(these cases could be covered during the replacement of
-        // literals in the signature calcluation)
+        // literals in the signature calculation)
         finished.push(
           (path.value.quasi.quasis as Array<{
             value: { cooked: string; raw: string };

packages/apollo-language-server/src/config/config.ts

@@ -4,6 +4,7 @@ import { ServiceID, ServiceSpecifier, ClientID } from "../engine";
 import URI from "vscode-uri";
 import { WithRequired } from "apollo-env";
 import { getServiceName, parseServiceSpecifier } from "./utils";
+import { ValidationRule } from "graphql/validation/ValidationContext";
 
 export interface EngineStatsWindow {
   to: number;
@@ -67,6 +68,32 @@ export interface ClientConfigFormat extends ConfigBase {
   tagName?: string;
   // stats window config
   statsWindow?: EngineStatsWindow;
+
+  /**
+   * Rules that will be applied when validating GraphQL documents.
+   *
+   * If you wish to modify the default list of validation rules, import them from the apollo package and
+   * assign your custom list:
+   *
+   * ```js
+   * const { defaultValidationRules } = require("apollo/lib/defaultValidationRules");
+   *
+   * module.exports = {
+   *   // ...
+   *   validationRules: [...defaultValidationRules, ...customRules]
+   * }
+   * ```
+   *
+   * Or, if you simply wish to filter out some rules from the default list, you can specify a filter function:
+   *
+   * ```js
+   * module.exports = {
+   *   // ...
+   *   validationRules: rule => rule.name !== "NoAnonymousQueries"
+   * }
+   * ```
+   */
+  validationRules?: ValidationRule[] | ((rule: ValidationRule) => boolean);
 }
 
 export const DefaultClientConfig = {

packages/apollo-language-server/src/config/loadConfig.ts

@@ -184,7 +184,7 @@ export async function loadConfig({
 
   let { config, filepath } = loadedConfig;
 
-  // selectivly apply defaults when loading the config
+  // selectively apply defaults when loading the config
   // this is just the includes/excludes defaults.
   // These need to go on _all_ configs. That's why this is last.
   if (config.client) config = merge({ client: DefaultClientConfig }, config);

packages/apollo-language-server/src/diagnostics.ts

@@ -14,14 +14,16 @@ import { rangeForASTNode } from "./utilities/source";
 
 import { getValidationErrors } from "./errors/validation";
 import { DocumentUri } from "./project/base";
+import { ValidationRule } from "graphql/validation/ValidationContext";
 
 /**
  * Build an array of code diagnostics for all executable definitions in a document.
  */
 export function collectExecutableDefinitionDiagnositics(
   schema: GraphQLSchema,
   queryDocument: GraphQLDocument,
-  fragments: { [fragmentName: string]: FragmentDefinitionNode } = {}
+  fragments: { [fragmentName: string]: FragmentDefinitionNode } = {},
+  rules?: ValidationRule[]
 ): Diagnostic[] {
   const ast = queryDocument.ast;
   if (!ast) return queryDocument.syntaxErrors;
@@ -36,7 +38,8 @@ export function collectExecutableDefinitionDiagnositics(
   for (const error of getValidationErrors(
     schema,
     astWithExecutableDefinitions,
-    fragments
+    fragments,
+    rules
   )) {
     diagnostics.push(
       ...diagnosticsFromError(error, DiagnosticSeverity.Error, "Validation")

packages/apollo-language-server/src/errors/validation.ts

@@ -16,23 +16,22 @@ import {
 } from "graphql";
 
 import { ToolError, logError } from "./logger";
+import { ValidationRule } from "graphql/validation/ValidationContext";
+
+const specifiedRulesToBeRemoved = [NoUnusedFragmentsRule, KnownDirectivesRule];
+
+export const defaultValidationRules: ValidationRule[] = [
+  NoAnonymousQueries,
+  NoTypenameAlias,
+  ...specifiedRules.filter(rule => !specifiedRulesToBeRemoved.includes(rule))
+];
 
 export function getValidationErrors(
   schema: GraphQLSchema,
   document: DocumentNode,
-  fragments?: { [fragmentName: string]: FragmentDefinitionNode }
+  fragments?: { [fragmentName: string]: FragmentDefinitionNode },
+  rules: ValidationRule[] = defaultValidationRules
 ) {
-  const specifiedRulesToBeRemoved = [
-    NoUnusedFragmentsRule,
-    KnownDirectivesRule
-  ];
-
-  const rules = [
-    NoAnonymousQueries,
-    NoTypenameAlias,
-    ...specifiedRules.filter(rule => !specifiedRulesToBeRemoved.includes(rule))
-  ];
-
   const typeInfo = new TypeInfo(schema);
   const context = new ValidationContext(schema, document, typeInfo);
 

packages/apollo-language-server/src/project/client.ts

@@ -18,6 +18,7 @@ import {
   FieldNode,
   ObjectTypeDefinitionNode
 } from "graphql";
+import { ValidationRule } from "graphql/validation/ValidationContext";
 
 import { NotificationHandler, DiagnosticSeverity } from "vscode-languageserver";
 
@@ -33,6 +34,7 @@ import {
   removeDirectiveAnnotatedFields,
   withTypenameFieldAddedWhereNeeded
 } from "../utilities/graphql";
+import { defaultValidationRules } from "../errors/validation";
 
 import {
   collectExecutableDefinitionDiagnositics,
@@ -84,6 +86,8 @@ export class GraphQLClientProject extends GraphQLProject {
 
   private fieldStats?: FieldStats;
 
+  private _validationRules?: ValidationRule[];
+
   constructor({
     config,
     loadingHandler,
@@ -125,6 +129,13 @@ export class GraphQLClientProject extends GraphQLProject {
       );
     }
 
+    const { validationRules } = this.config.client;
+    if (typeof validationRules === "function") {
+      this._validationRules = defaultValidationRules.filter(validationRules);
+    } else {
+      this._validationRules = validationRules;
+    }
+
     this.loadEngineData();
   }
 
@@ -237,7 +248,8 @@ export class GraphQLClientProject extends GraphQLProject {
           collectExecutableDefinitionDiagnositics(
             this.schema,
             document,
-            fragments
+            fragments,
+            this._validationRules
           )
         );
       }

packages/apollo/src/defaultValidationRules.ts

@@ -0,0 +1,3 @@
+export {
+  defaultValidationRules
+} from "apollo-language-server/lib/errors/validation";