feat(language-service): offset outline results for embedded gql

Author: forivall

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

@@ -7,6 +7,7 @@
  *
  */
 
+import * as path from 'node:path';
 import {
   DocumentNode,
   FragmentSpreadNode,
@@ -22,6 +23,7 @@ import {
   isTypeDefinitionNode,
   ArgumentNode,
   typeFromAST,
+  Source as GraphQLSource,
 } from 'graphql';
 
 import {
@@ -47,6 +49,7 @@ import {
   getTypeInfo,
   DefinitionQueryResponse,
   getDefinitionQueryResultForArgument,
+  IRange,
 } from 'graphql-language-service';
 
 import type { GraphQLCache } from './GraphQLCache';
@@ -359,8 +362,13 @@ export class GraphQLLanguageService {
   public async getDocumentSymbols(
     document: string,
     filePath: Uri,
+    fileDocumentRange?: IRange | null,
   ): Promise<SymbolInformation[]> {
-    const outline = await this.getOutline(document);
+    const outline = await this.getOutline(
+      document,
+      path.basename(filePath),
+      fileDocumentRange?.start,
+    );
     if (!outline) {
       return [];
     }
@@ -537,7 +545,20 @@ export class GraphQLLanguageService {
     );
   }
 
-  async getOutline(documentText: string): Promise<Outline | null> {
-    return getOutline(documentText);
+  async getOutline(
+    documentText: string,
+    documentName: string,
+    documentOffset?: IPosition,
+  ): Promise<Outline | null> {
+    return getOutline(
+      new GraphQLSource(
+        documentText,
+        documentName,
+        documentOffset && {
+          column: documentOffset.character + 1,
+          line: documentOffset.line + 1,
+        },
+      ),
+    );
   }
 }

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

@@ -13,6 +13,7 @@ import {
   TokenKind,
   IPosition,
   OutlineTree,
+  IRange,
 } from '../types';
 
 import {
@@ -38,6 +39,7 @@ import {
   FieldDefinitionNode,
   EnumValueDefinitionNode,
   InputObjectTypeDefinitionNode,
+  Source as GraphQLSource,
 } from 'graphql';
 import type { ASTReducer } from 'graphql/language/visitor';
 
@@ -105,16 +107,16 @@ type OutlineTreeConverterType = {
   ) => OutlineTreeResult;
 };
 
-export function getOutline(documentText: string): Outline | null {
+export function getOutline(document: string | GraphQLSource): Outline | null {
   let ast;
   try {
-    ast = parse(documentText);
+    ast = parse(document);
   } catch {
     return null;
   }
 
   type VisitorFns = Record<Kind, (node: ASTNode) => OutlineTreeResult>;
-  const visitorFns = outlineTreeConverter(documentText) as VisitorFns;
+  const visitorFns = outlineTreeConverter(document) as VisitorFns;
   const outlineTrees = visit(ast, {
     leave(node: ASTNode) {
       if (node.kind in visitorFns) {
@@ -127,13 +129,19 @@ export function getOutline(documentText: string): Outline | null {
   return { outlineTrees };
 }
 
-function outlineTreeConverter(docText: string): OutlineTreeConverterType {
+function outlineTreeConverter(
+  document: string | GraphQLSource,
+): OutlineTreeConverterType {
+  const docText = typeof document === 'string' ? document : document.body;
+  const { locationOffset }: Partial<GraphQLSource> =
+    typeof document === 'string' ? {} : document;
   type MetaNode = Exclude<
     OutlineableNode,
     DocumentNode | SelectionSetNode | NameNode | InlineFragmentNode
   >;
   const meta = (node: ExclusiveUnion<MetaNode>): OutlineTreeResultMeta => {
     const range = locToRange(docText, node.loc!);
+    applyOffsetToRange(range, locationOffset);
     return {
       representativeName: node.name,
       startPosition: range.start,
@@ -250,3 +258,24 @@ function concatMap<V>(arr: Readonly<V[]>, fn: Function): Readonly<V[]> {
   }
   return res;
 }
+
+function applyOffsetToRange(
+  range: IRange,
+  locationOffset?: GraphQLSource['locationOffset'],
+) {
+  if (!locationOffset) {
+    return;
+  }
+  applyOffsetToPosition(range.start, locationOffset);
+  applyOffsetToPosition(range.end, locationOffset);
+}
+
+function applyOffsetToPosition(
+  position: IPosition,
+  locationOffset: GraphQLSource['locationOffset'],
+) {
+  if (position.line === 1) {
+    position.character += locationOffset.column - 1;
+  }
+  position.line += locationOffset.line - 1;
+}