Add implementation for definition request

Signed-off-by: Yevhen Vydolob <yvydolob@redhat.com>

Author: evidolob

src/languageserver/handlers/languageHandlers.ts

@@ -17,8 +17,9 @@ import {
   Connection,
   TextDocumentPositionParams,
   CodeLensParams,
+  DefinitionParams,
 } from 'vscode-languageserver';
-import { CodeLens, DocumentSymbol, Hover, SymbolInformation, TextEdit } from 'vscode-languageserver-types';
+import { CodeLens, DefinitionLink, DocumentSymbol, Hover, SymbolInformation, TextEdit } from 'vscode-languageserver-types';
 import { isKubernetesAssociatedDocument } from '../../languageservice/parser/isKubernetes';
 import { LanguageService } from '../../languageservice/yamlLanguageService';
 import { SettingsState } from '../../yamlSettings';
@@ -57,6 +58,7 @@ export class LanguageHandlers {
     this.connection.onDocumentOnTypeFormatting((params) => this.formatOnTypeHandler(params));
     this.connection.onCodeLens((params) => this.codeLensHandler(params));
     this.connection.onCodeLensResolve((params) => this.codeLensResolveHandler(params));
+    this.connection.onDefinition((params) => this.definitionHandler(params));
 
     this.yamlSettings.documents.onDidChangeContent((change) => this.cancelLimitExceededWarnings(change.document.uri));
     this.yamlSettings.documents.onDidClose((event) => this.cancelLimitExceededWarnings(event.document.uri));
@@ -219,6 +221,15 @@ export class LanguageHandlers {
     return this.languageService.resolveCodeLens(param);
   }
 
+  definitionHandler(params: DefinitionParams): DefinitionLink[] {
+    const textDocument = this.yamlSettings.documents.get(params.textDocument.uri);
+    if (!textDocument) {
+      return;
+    }
+
+    return this.languageService.doDefinition(textDocument, params);
+  }
+
   // Adapted from:
   // https://github.com/microsoft/vscode/blob/94c9ea46838a9a619aeafb7e8afd1170c967bb55/extensions/json-language-features/server/src/jsonServer.ts#L172
   private cancelLimitExceededWarnings(uri: string): void {

src/languageservice/services/yamlDefinition.ts

@@ -0,0 +1,35 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Red Hat, Inc. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { DefinitionParams, LocationLink, Range } from 'vscode-languageserver-protocol';
+import { TextDocument } from 'vscode-languageserver-textdocument';
+import { DefinitionLink } from 'vscode-languageserver-types';
+import { isAlias } from 'yaml';
+import { yamlDocumentsCache } from '../parser/yaml-documents';
+import { matchOffsetToDocument } from '../utils/arrUtils';
+import { TextBuffer } from '../utils/textBuffer';
+
+export function getDefinition(document: TextDocument, params: DefinitionParams): DefinitionLink[] | undefined {
+  try {
+    const yamlDocument = yamlDocumentsCache.getYamlDocument(document);
+    const offset = document.offsetAt(params.position);
+    const currentDoc = matchOffsetToDocument(offset, yamlDocument);
+    if (currentDoc) {
+      const [node] = currentDoc.getNodeFromPosition(offset, new TextBuffer(document));
+      if (node && isAlias(node)) {
+        const defNode = node.resolve(currentDoc.internalDocument);
+        if (defNode && defNode.range) {
+          const targetRange = Range.create(document.positionAt(defNode.range[0]), document.positionAt(defNode.range[2]));
+          const selectionRange = Range.create(document.positionAt(defNode.range[0]), document.positionAt(defNode.range[1]));
+          return [LocationLink.create(document.uri, targetRange, selectionRange)];
+        }
+      }
+    }
+  } catch (err) {
+    this.telemetry.sendError('yaml.definition.error', { error: err });
+  }
+
+  return undefined;
+}

src/languageservice/yamlLanguageService.ts

@@ -21,13 +21,14 @@ import {
   TextEdit,
   DocumentLink,
   CodeLens,
+  DefinitionLink,
 } from 'vscode-languageserver-types';
 import { JSONSchema } from './jsonSchema';
 import { YAMLDocumentSymbols } from './services/documentSymbols';
 import { YAMLHover } from './services/yamlHover';
 import { YAMLValidation } from './services/yamlValidation';
 import { YAMLFormatter } from './services/yamlFormatter';
-import { JSONDocument, DefinitionLink, TextDocument, DocumentSymbolsContext } from 'vscode-json-languageservice';
+import { DocumentSymbolsContext } from 'vscode-json-languageservice';
 import { findLinks } from './services/yamlLinks';
 import {
   FoldingRange,
@@ -37,7 +38,9 @@ import {
   Connection,
   DocumentOnTypeFormattingParams,
   CodeLensParams,
+  DefinitionParams,
 } from 'vscode-languageserver/node';
+import { TextDocument } from 'vscode-languageserver-textdocument';
 import { getFoldingRanges } from './services/yamlFolding';
 import { FoldingRangesContext } from './yamlTypes';
 import { YamlCodeActions } from './services/yamlCodeActions';
@@ -49,6 +52,7 @@ import { Telemetry } from '../languageserver/telemetry';
 import { YamlVersion } from './parser/yamlParser07';
 import { YamlCompletion } from './services/yamlCompletion';
 import { yamlDocumentsCache } from './parser/yaml-documents';
+import { getDefinition } from './services/yamlDefinition';
 
 export enum SchemaPriority {
   SchemaStore = 1,
@@ -132,10 +136,10 @@ export interface LanguageService {
   doHover(document: TextDocument, position: Position): Promise<Hover | null>;
   findDocumentSymbols(document: TextDocument, context: DocumentSymbolsContext): SymbolInformation[];
   findDocumentSymbols2(document: TextDocument, context: DocumentSymbolsContext): DocumentSymbol[];
-  findDefinition(document: TextDocument, position: Position, doc: JSONDocument): Promise<DefinitionLink[]>;
   findLinks(document: TextDocument): Promise<DocumentLink[]>;
   resetSchema(uri: string): boolean;
   doFormat(document: TextDocument, options: CustomFormatterOptions): TextEdit[];
+  doDefinition(document: TextDocument, params: DefinitionParams): DefinitionLink[] | undefined;
   doDocumentOnTypeFormatting(document: TextDocument, params: DocumentOnTypeFormattingParams): TextEdit[] | undefined;
   addSchema(schemaID: string, schema: JSONSchema): void;
   deleteSchema(schemaID: string): void;
@@ -185,13 +189,13 @@ export function getLanguageService(
     registerCustomSchemaProvider: (schemaProvider: CustomSchemaProvider) => {
       schemaService.registerCustomSchemaProvider(schemaProvider);
     },
-    findDefinition: () => Promise.resolve([]),
     findLinks,
     doComplete: completer.doComplete.bind(completer),
     doValidation: yamlValidation.doValidation.bind(yamlValidation),
     doHover: hover.doHover.bind(hover),
     findDocumentSymbols: yamlDocumentSymbols.findDocumentSymbols.bind(yamlDocumentSymbols),
     findDocumentSymbols2: yamlDocumentSymbols.findHierarchicalDocumentSymbols.bind(yamlDocumentSymbols),
+    doDefinition: getDefinition.bind(getDefinition),
     resetSchema: (uri: string) => {
       return schemaService.onResourceChange(uri);
     },

src/yamlServerInit.ts

@@ -101,6 +101,7 @@ export class YAMLServerInit {
           firstTriggerCharacter: '\n',
         },
         documentRangeFormattingProvider: false,
+        definitionProvider: true,
         documentLinkProvider: {},
         // disabled until we not get parser which parse comments as separate nodes
         foldingRangeProvider: false,

test/findLinks.test.ts

@@ -9,7 +9,7 @@ import { DocumentLink } from 'vscode-languageserver';
 import { SettingsState, TextDocumentTestManager } from '../src/yamlSettings';
 import { LanguageHandlers } from '../src/languageserver/handlers/languageHandlers';
 
-describe('FindDefintion Tests', () => {
+describe('Find Links Tests', () => {
   let languageHandler: LanguageHandlers;
   let yamlSettings: SettingsState;
 

test/yamlDefinition.test.ts

@@ -0,0 +1,24 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Red Hat, Inc. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { setupTextDocument, TEST_URI } from './utils/testHelper';
+import { expect } from 'chai';
+import { getDefinition } from '../src/languageservice/services/yamlDefinition';
+import { LocationLink, Position, Range } from 'vscode-languageserver-protocol';
+
+describe('YAML Definition', () => {
+  it('should not provide definition for non anchor node', () => {
+    const doc = setupTextDocument('foo: &bar some\naaa: *bar');
+    const result = getDefinition(doc, { position: Position.create(1, 2), textDocument: { uri: TEST_URI } });
+    expect(result).is.undefined;
+  });
+
+  it('should provide definition for anchor', () => {
+    const doc = setupTextDocument('foo: &bar some\naaa: *bar');
+    const result = getDefinition(doc, { position: Position.create(1, 7), textDocument: { uri: TEST_URI } });
+    expect(result).is.not.undefined;
+    expect(result[0]).is.eqls(LocationLink.create(TEST_URI, Range.create(0, 10, 1, 0), Range.create(0, 10, 0, 14)));
+  });
+});