{interface,server,types}: support getOutline in lsp server

Author: stephen

packages/interface/src/GraphQLLanguageService.js

@@ -21,6 +21,7 @@ import type {
   GraphQLCache,
   GraphQLConfig,
   GraphQLProjectConfig,
+  Outline,
   Uri,
 } from 'graphql-language-service-types';
 import type {Position} from 'graphql-language-service-utils';
@@ -46,6 +47,7 @@ import {
   getDefinitionQueryResultForFragmentSpread,
   getDefinitionQueryResultForDefinitionNode,
 } from './getDefinition';
+import {getOutline} from './getOutline';
 import {getASTNodeAtPosition} from 'graphql-language-service-utils';
 
 export class GraphQLLanguageService {
@@ -244,4 +246,8 @@ export class GraphQLLanguageService {
 
     return result;
   }
+
+  async getOutline(query: string): Promise<?Outline> {
+    return getOutline(query);
+  }
 }

packages/interface/src/getOutline.js

@@ -56,6 +56,7 @@ function outlineTreeConverter(docText: string): OutlineTreeConverterType {
     representativeName: node.name,
     startPosition: offsetToPosition(docText, node.loc.start),
     endPosition: offsetToPosition(docText, node.loc.end),
+    kind: node.kind,
     children: node.selectionSet || [],
   });
   return {

packages/server/src/MessageProcessor.js

@@ -35,6 +35,9 @@ import {
   InitializeResult,
   Location,
   PublishDiagnosticsParams,
+  DocumentSymbolParams,
+  SymbolInformation,
+  SymbolKind,
 } from 'vscode-languageserver';
 
 import {getGraphQLCache} from './GraphQLCache';
@@ -48,6 +51,13 @@ type CachedDocumentType = {
   contents: Array<CachedContent>,
 };
 
+const KIND_TO_SYMBOL_KIND = {
+  Field: SymbolKind.Field,
+  OperationDefinition: SymbolKind.Class,
+  FragmentDefinition: SymbolKind.Class,
+  FragmentSpread: SymbolKind.Struct,
+};
+
 export class MessageProcessor {
   _graphQLCache: GraphQLCache;
   _languageService: GraphQLLanguageService;
@@ -79,6 +89,7 @@ export class MessageProcessor {
     const serverCapabilities: ServerCapabilities = {
       capabilities: {
         completionProvider: {resolveProvider: true},
+        documentSymbolProvider: true,
         definitionProvider: true,
         textDocumentSync: 1,
       },
@@ -416,6 +427,52 @@ export class MessageProcessor {
     return formatted;
   }
 
+  async handleDocumentSymbolRequest(
+    params: DocumentSymbolParams.type,
+  ): Promise<Array<SymbolInformation>> {
+    if (!this._isInitialized) {
+      return [];
+    }
+
+    if (!params || !params.textDocument) {
+      throw new Error('`textDocument` argument is required.');
+    }
+
+    const textDocument = params.textDocument;
+    const cachedDocument = this._getCachedDocument(textDocument.uri);
+    if (!cachedDocument) {
+      throw new Error('A cached document cannot be found.');
+    }
+
+    const outline = await this._languageService.getOutline(
+      cachedDocument.contents[0].query,
+    );
+    if (!outline) {
+      return [];
+    }
+
+    const output: Array<SymbolInformation> = [];
+    const input = outline.outlineTrees.map(tree => [null, tree]);
+    while (input.length > 0) {
+      const [parent, tree] = input.pop();
+      output.push({
+        name: tree.representativeName,
+        kind: KIND_TO_SYMBOL_KIND[tree.kind],
+        location: {
+          uri: textDocument.uri,
+          range: {
+            start: tree.startPosition,
+            end: tree.endPosition,
+          },
+        },
+        containerName: parent ? parent.representativeName : undefined,
+      });
+      input.push(...tree.children.map(child => [tree, child]));
+    }
+
+    return output;
+  }
+
   _isRelayCompatMode(query: string): boolean {
     return (
       query.indexOf('RelayCompat') !== -1 ||

packages/server/src/startServer.js

@@ -34,6 +34,7 @@ import {
   ExitNotification,
   InitializeRequest,
   PublishDiagnosticsNotification,
+  DocumentSymbolRequest,
   ShutdownRequest,
 } from 'vscode-languageserver';
 
@@ -168,4 +169,7 @@ function addHandlers(
   connection.onRequest(DefinitionRequest.type, params =>
     messageProcessor.handleDefinitionRequest(params),
   );
+  connection.onRequest(DocumentSymbolRequest.type, (params, token) =>
+    messageProcessor.handleDocumentSymbolRequest(params),
+  );
 }

packages/types/src/index.js

@@ -259,6 +259,7 @@ export type OutlineTree = {
   tokenizedText?: TokenizedText,
   representativeName?: string,
 
+  kind: string,
   startPosition: Position,
   endPosition?: Position,
   children: Array<OutlineTree>,