[AT-36] Improve client:check output (#934)

Improve client:check output

* Update language server to replace checkOperations with validateOperations mutation.
* Leverage new mutation from the CLI to provide file specific data for validation errors.
* Display messages grouped by query, with a clickable link to each query
* Update CHANGELOG

Author: trevor-scheer

.vscode/settings.json

@@ -12,5 +12,6 @@
     "node_modules": false,
     "lib": true
   },
-  "typescript.tsdk": "node_modules/typescript/lib"
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "debug.node.autoAttach": "on"
 }

CHANGELOG.md

@@ -4,6 +4,9 @@
 
 - `apollo`
   - Fix configuration loading and schema tag support [#925](https://github.com/apollographql/apollo-tooling/pull/925)
+  - Improve client:check output [#934](https://github.com/apollographql/apollo-tooling/pull/934)
+- `apollo-language-server`
+  - Replace checkOperations mutation with new validateOperations mutation [#934](https://github.com/apollographql/apollo-tooling/pull/934)
 
 ## `apollo@2.3.1`
 

packages/apollo-language-server/src/engine/index.ts

@@ -10,9 +10,10 @@ import {
 } from "./operations/uploadSchema";
 
 import {
-  CHECK_OPERATIONS,
-  CheckOperationsVariables
-} from "./operations/checkOperations";
+  VALIDATE_OPERATIONS,
+  ValidateOperationsVariables,
+  ValidationResult
+} from "./operations/validateOperations";
 
 import {
   REGISTER_OPERATIONS,
@@ -161,8 +162,8 @@ export class ApolloEngineClient extends GraphQLDataSource {
     });
   }
 
-  public async checkOperations(variables: CheckOperationsVariables) {
-    return this.execute({ query: CHECK_OPERATIONS, variables }).then(
+  public async validateOperations(variables: ValidateOperationsVariables) {
+    return this.execute({ query: VALIDATE_OPERATIONS, variables }).then(
       ({ data, errors }) => {
         if (data && !data.service) {
           throw new Error(
@@ -176,7 +177,9 @@ export class ApolloEngineClient extends GraphQLDataSource {
         if (!data) {
           throw new Error("Error in request from Engine");
         }
-        return data.service.checkOperations;
+
+        return data.service.validateOperations
+          .validationResults as ValidationResult[];
       }
     );
   }

packages/apollo-language-server/src/engine/operations/checkOperations.ts

@@ -0,0 +1,59 @@
+import gql from "graphql-tag";
+import { GitContextInput } from "./checkSchema";
+
+export interface OperationDocument {
+  body: string;
+  name: string;
+}
+
+export enum ValidationErrorType {
+  WARNING = "WARNING",
+  FAILURE = "FAILURE",
+  INVALID = "INVALID"
+}
+
+export enum ValidationErrorCode {
+  NON_PARSEABLE_DOCUMENT = "NON_PARSEABLE_DOCUMENT",
+  INVALID_OPERATION = "INVALID_OPERATION",
+  DEPRECATED_FIELD = "DEPRECATED_FIELD"
+}
+
+export interface ValidationResult {
+  type: ValidationErrorType;
+  code: ValidationErrorCode;
+  description: string;
+  operation: OperationDocument;
+}
+
+export interface ValidateOperationsVariables {
+  id: string;
+  tag: string;
+  gitContext: GitContextInput;
+  operations: [OperationDocument];
+}
+
+export const VALIDATE_OPERATIONS = gql`
+  mutation ValidateOperations(
+    $id: ID!
+    $operations: [OperationDocumentInput!]!
+    $tag: String
+    $gitContext: GitContextInput
+  ) {
+    service(id: $id) {
+      validateOperations(
+        tag: $tag
+        operations: $operations
+        gitContext: $gitContext
+      ) {
+        validationResults {
+          type
+          code
+          description
+          operation {
+            name
+          }
+        }
+      }
+    }
+  }
+`;