refactor: friendlier to read diagnostic codes (#1497)

Author: acao

packages/graphql-language-service-interface/src/GraphQLLanguageService.ts

@@ -37,7 +37,7 @@ import {
 import { Kind, parse, print } from 'graphql';
 import { getAutocompleteSuggestions } from './getAutocompleteSuggestions';
 import { getHoverInformation } from './getHoverInformation';
-import { validateQuery, getRange, SEVERITY } from './getDiagnostics';
+import { validateQuery, getRange, DIAGNOSTIC_SEVERITY } from './getDiagnostics';
 import {
   getDefinitionQueryResultForFragmentSpread,
   getDefinitionQueryResultForDefinitionNode,
@@ -155,7 +155,7 @@ export class GraphQLLanguageService {
       const range = getRange(error.locations[0], query);
       return [
         {
-          severity: SEVERITY.ERROR,
+          severity: DIAGNOSTIC_SEVERITY.Error,
           message: error.message,
           source: 'GraphQL: Syntax',
           range,

packages/graphql-language-service-interface/src/__tests__/getDiagnostics-test.ts

@@ -12,7 +12,11 @@ import fs from 'fs';
 import { buildSchema, parse, GraphQLSchema } from 'graphql';
 import path from 'path';
 
-import { getDiagnostics, validateQuery, SEVERITY } from '../getDiagnostics';
+import {
+  getDiagnostics,
+  validateQuery,
+  DIAGNOSTIC_SEVERITY,
+} from '../getDiagnostics';
 
 describe('getDiagnostics', () => {
   let schema: GraphQLSchema;
@@ -30,7 +34,7 @@ describe('getDiagnostics', () => {
     expect(error.message).toEqual(
       'Cannot query field "title" on type "Query".',
     );
-    expect(error.severity).toEqual(SEVERITY.ERROR);
+    expect(error.severity).toEqual(DIAGNOSTIC_SEVERITY.Error);
     expect(error.source).toEqual('GraphQL: Validation');
   });
 
@@ -43,7 +47,7 @@ describe('getDiagnostics', () => {
       // eslint-disable-next-line no-useless-escape
       'The field "Query.deprecatedField" is deprecated. Use test instead.',
     );
-    expect(error.severity).toEqual(SEVERITY.WARNING);
+    expect(error.severity).toEqual(DIAGNOSTIC_SEVERITY.Warning);
     expect(error.source).toEqual('GraphQL: Deprecation');
   });
 
@@ -76,7 +80,7 @@ describe('getDiagnostics', () => {
       // eslint-disable-next-line no-useless-escape
       'Syntax Error: Expected ":", found Name "id".',
     );
-    expect(error.severity).toEqual(SEVERITY.ERROR);
+    expect(error.severity).toEqual(DIAGNOSTIC_SEVERITY.Error);
     expect(error.source).toEqual('GraphQL: Syntax');
   });
 

packages/graphql-language-service-interface/src/getDiagnostics.ts

@@ -30,11 +30,24 @@ import {
 
 import { DiagnosticSeverity, Diagnostic } from 'vscode-languageserver-types';
 
+// this doesn't work without the 'as', kinda goofy
+
 export const SEVERITY = {
-  ERROR: 1 as DiagnosticSeverity,
-  WARNING: 2 as DiagnosticSeverity,
-  INFORMATION: 3 as DiagnosticSeverity,
-  HINT: 4 as DiagnosticSeverity,
+  Error: 'Error' as 'Error',
+  Warning: 'Warning' as 'Warning',
+  Information: 'Information' as 'Information',
+  Hint: 'Hint' as 'Hint',
+};
+
+export type Severity = typeof SEVERITY;
+
+export type SeverityEnum = keyof Severity;
+
+export const DIAGNOSTIC_SEVERITY = {
+  [SEVERITY.Error]: 1 as DiagnosticSeverity,
+  [SEVERITY.Warning]: 2 as DiagnosticSeverity,
+  [SEVERITY.Information]: 3 as DiagnosticSeverity,
+  [SEVERITY.Hint]: 4 as DiagnosticSeverity,
 };
 
 export function getDiagnostics(
@@ -50,7 +63,7 @@ export function getDiagnostics(
     const range = getRange(error.locations[0], query);
     return [
       {
-        severity: SEVERITY.ERROR as DiagnosticSeverity,
+        severity: DIAGNOSTIC_SEVERITY.Error as DiagnosticSeverity,
         message: error.message,
         source: 'GraphQL: Syntax',
         range,
@@ -74,15 +87,15 @@ export function validateQuery(
 
   const validationErrorAnnotations = mapCat(
     validateWithCustomRules(schema, ast, customRules, isRelayCompatMode),
-    error => annotations(error, SEVERITY.ERROR, 'Validation'),
+    error => annotations(error, DIAGNOSTIC_SEVERITY.Error, 'Validation'),
   );
 
   // Note: findDeprecatedUsages was added in [email protected], but we want to
   // support older versions of graphql-js.
   const deprecationWarningAnnotations = !findDeprecatedUsages
     ? []
     : mapCat(findDeprecatedUsages(schema, ast), error =>
-        annotations(error, SEVERITY.WARNING, 'Deprecation'),
+        annotations(error, DIAGNOSTIC_SEVERITY.Warning, 'Deprecation'),
       );
 
   return validationErrorAnnotations.concat(deprecationWarningAnnotations);

packages/graphql-language-service-interface/src/index.ts

@@ -28,7 +28,7 @@ export {
   getDefinitionQueryResultForDefinitionNode,
 } from './getDefinition';
 
-export { getDiagnostics, validateQuery } from './getDiagnostics';
+export * from './getDiagnostics';
 export { getOutline } from './getOutline';
 export { getHoverInformation } from './getHoverInformation';
 

packages/graphql-language-service-server/src/Logger.ts

@@ -13,13 +13,11 @@ import * as fs from 'fs';
 import * as os from 'os';
 import { join } from 'path';
 
-const SEVERITY: { [key: string]: string } = {
-  ERROR: 'ERROR',
-  WARNING: 'WARNING',
-  INFO: 'INFO',
-  DEBUG: 'DEBUG',
-};
-
+import {
+  DIAGNOSTIC_SEVERITY,
+  SeverityEnum,
+  SEVERITY,
+} from 'graphql-language-service-interface';
 export class Logger implements VSCodeLogger {
   _logFilePath: string;
   _stream: fs.WriteStream | null;
@@ -46,30 +44,30 @@ export class Logger implements VSCodeLogger {
   }
 
   error(message: string): void {
-    this._log(message, 'ERROR');
+    this._log(message, SEVERITY.Error);
   }
 
   warn(message: string): void {
-    this._log(message, 'WARNING');
+    this._log(message, SEVERITY.Warning);
   }
 
   info(message: string): void {
-    this._log(message, 'INFO');
+    this._log(message, SEVERITY.Information);
   }
 
   log(message: string): void {
-    this._log(message, 'DEBUG');
+    this._log(message, SEVERITY.Hint);
   }
 
-  _log(message: string, severityKey: string = 'DEBUG'): void {
+  _log(message: string, severityKey: SeverityEnum): void {
     const timestamp = new Date().toLocaleString(undefined);
-    const severity = SEVERITY[severityKey];
+    const severity = DIAGNOSTIC_SEVERITY[severityKey];
     const pid = process.pid;
 
     const logMessage = `${timestamp} [${severity}] (pid: ${pid}) graphql-language-service-usage-logs: ${message}\n\n`;
     // write to the file in tmpdir
     fs.appendFile(this._logFilePath, logMessage, _error => {});
-    // const processSt = (severity === SEVERITY.ERROR) ? process.stderr : process.stdout
+    // const processSt = (severity === DIAGNOSTIC_SEVERITY.Error) ? process.stderr : process.stdout
     process.stderr.write(logMessage, _err => {
       // console.error(err);
     });