LSP: New settings option to Disable server and Better Goto Definition for property and file paths (1/2)

extension/package.json

@@ -548,6 +548,12 @@
           "type": "boolean",
           "default": null
         },
+        "dvc.disableLanguageServer": {
+          "title": "%config.disableLanguageServer.title%",
+          "description": "%config.disableLanguageServer.description%",
+          "type": "boolean",
+          "default": null
+        },
         "dvc.dvcPath": {
           "title": "%config.dvcPath.title%",
           "description": "%config.dvcPath.description%",

extension/package.nls.json

@@ -82,6 +82,8 @@
   "config.doNotShowWalkthroughAfterInstall.title": "Do not show the Get Started page.",
   "config.doNotShowUnableToFilter.description": "Do not warn before disabling auto-apply filters when these would result in too many experiments being selected.",
   "config.doNotShowUnableToFilter.title": "Do not warn before disabling auto-apply filters to experiment selection.",
+  "config.disableLanguageServer.description": "Disable the language server for dvc.yaml files.",
+  "config.disableLanguageServer.title": "Disable language server",
   "config.dvcPath.description": "Path or shell command to the DVC binary. Required unless Microsoft's Python extension is installed and the `dvc` package found in its environment.",
   "config.dvcPath.title": "DVC Path (or shell command)",
   "config.expTableHeadMaxLayers.title": "Maximum depth of Experiment table head rows",

extension/src/extension.ts

@@ -51,6 +51,7 @@ import { collectWorkspaceScale } from './telemetry/collect'
 import { createFileSystemWatcher } from './fileSystem/watcher'
 import { GitExecutor } from './cli/git/executor'
 import { GitReader } from './cli/git/reader'
+import { LanguageClientWrapper } from './lspClient/languageClient'
 
 export class Extension extends Disposable implements IExtension {
   protected readonly internalCommands: InternalCommands
@@ -92,6 +93,8 @@ export class Extension extends Disposable implements IExtension {
     this.setCommandsAvailability(false)
     this.setProjectAvailability()
 
+    this.dispose.track(new LanguageClientWrapper())
+
     this.resourceLocator = this.dispose.track(
       new ResourceLocator(context.extensionUri)
     )

extension/src/lspClient/languageClient.ts

@@ -1,14 +1,13 @@
-import { Uri, workspace } from 'vscode'
 import {
   LanguageClient,
   LanguageClientOptions,
   ServerOptions,
   TransportKind
 } from 'vscode-languageclient/node'
 import { documentSelector, serverModule } from 'dvc-vscode-lsp'
-import { readFileSync } from 'fs-extra'
+import { ConfigurationChangeEvent, workspace } from 'vscode'
 import { Disposable } from '../class/dispose'
-import { findFiles } from '../fileSystem/workspace'
+import { ConfigKey, getConfigValue } from '../vscode/config'
 
 export class LanguageClientWrapper extends Disposable {
   private client: LanguageClient
@@ -17,13 +16,7 @@ export class LanguageClientWrapper extends Disposable {
     super()
 
     const clientOptions: LanguageClientOptions = {
-      documentSelector,
-
-      synchronize: {
-        fileEvents: workspace.createFileSystemWatcher(
-          '**/*.{yaml,dvc,dvc.lock,json,toml}'
-        )
-      }
+      documentSelector
     }
 
     this.client = this.dispose.track(
@@ -35,31 +28,24 @@ export class LanguageClientWrapper extends Disposable {
       )
     )
 
-    // Start the client. This will also launch the server
     this.start()
   }
 
   async start() {
-    await this.client.start()
-
-    const files = await findFiles('**/*.{yaml,json,py,toml}', '.??*')
-
-    const textDocuments = files.map(filePath => {
-      const uri = Uri.file(filePath).toString()
-      const languageId = filePath.endsWith('yaml') ? 'yaml' : 'json'
-      const text = readFileSync(filePath, 'utf8')
+    if (!this.languageServerDisabled()) {
+      // This will also start the server process
+      await this.client.start()
 
-      return {
-        languageId,
-        text,
-        uri,
-        version: 0
-      }
-    })
-
-    await this.client.sendRequest('initialTextDocuments', {
-      textDocuments
-    })
+      workspace.onDidChangeConfiguration((event: ConfigurationChangeEvent) => {
+        if (
+          event.affectsConfiguration(ConfigKey.DISABLE_LANGUAGE_SERVER) &&
+          this.isRunning() &&
+          this.languageServerDisabled()
+        ) {
+          this.stop()
+        }
+      })
+    }
 
     return this
   }
@@ -68,6 +54,14 @@ export class LanguageClientWrapper extends Disposable {
     this.client.stop()
   }
 
+  private isRunning() {
+    return this.client.isRunning()
+  }
+
+  private languageServerDisabled() {
+    return getConfigValue<boolean>(ConfigKey.DISABLE_LANGUAGE_SERVER)
+  }
+
   private getServerOptions(): ServerOptions {
     const debugOptions = { execArgv: ['--nolazy', '--inspect=6009'] }
 

extension/src/vscode/config.ts

@@ -5,6 +5,7 @@ export enum ConfigKey {
   DO_NOT_SHOW_CLI_UNAVAILABLE = 'dvc.doNotShowCliUnavailable',
   DO_NOT_SHOW_WALKTHROUGH_AFTER_INSTALL = 'dvc.doNotShowWalkthroughAfterInstall',
   DO_NOT_SHOW_UNABLE_TO_FILTER = 'dvc.doNotShowUnableToFilter',
+  DISABLE_LANGUAGE_SERVER = 'dvc.disableLanguageServer',
   EXP_TABLE_HEAD_MAX_LAYERS = 'dvc.expTableHeadMaxLayers',
   DVC_PATH = 'dvc.dvcPath',
   PYTHON_PATH = 'dvc.pythonPath'

languageServer/src/LanguageServer.ts

@@ -10,16 +10,14 @@ import {
   Location,
   Position,
   Range,
-  DocumentSymbol,
-  TextDocumentItem
+  DocumentSymbol
 } from 'vscode-languageserver/node'
 import { TextDocument } from 'vscode-languageserver-textdocument'
 import { URI } from 'vscode-uri'
 import { TextDocumentWrapper } from './TextDocumentWrapper'
 
 export class LanguageServer {
   private documentsKnownToEditor!: TextDocuments<TextDocument>
-  private documentsFromDvcClient: TextDocumentWrapper[] = []
 
   public listen(connection: _Connection) {
     this.documentsKnownToEditor = new TextDocuments(TextDocument)
@@ -34,24 +32,6 @@ export class LanguageServer {
       return this.onDefinition(params)
     })
 
-    connection.onRequest(
-      'initialTextDocuments',
-      (params: { textDocuments: TextDocumentItem[] }) => {
-        this.documentsFromDvcClient = params.textDocuments.map(
-          ({ uri, languageId, version, text: content }) => {
-            const textDocument = TextDocument.create(
-              uri,
-              languageId,
-              version,
-              content
-            )
-
-            return this.wrap(textDocument)
-          }
-        )
-      }
-    )
-
     this.documentsKnownToEditor.listen(connection)
 
     connection.listen()
@@ -61,16 +41,6 @@ export class LanguageServer {
     const openDocuments = this.documentsKnownToEditor.all()
     const acc: TextDocumentWrapper[] = openDocuments.map(doc => this.wrap(doc))
 
-    for (const textDocument of this.documentsFromDvcClient) {
-      const userAlreadyOpenedIt = this.documentsKnownToEditor.get(
-        textDocument.uri
-      )
-
-      if (!userAlreadyOpenedIt) {
-        acc.push(textDocument)
-      }
-    }
-
     return acc
   }
 
@@ -81,10 +51,7 @@ export class LanguageServer {
     const doc = this.documentsKnownToEditor.get(uri)
 
     if (!doc) {
-      const alternative = this.documentsFromDvcClient.find(
-        txtDoc => txtDoc.uri === uri
-      )
-      return alternative ?? null
+      return null
     }
 
     return this.wrap(doc)
@@ -94,18 +61,33 @@ export class LanguageServer {
     return new TextDocumentWrapper(doc)
   }
 
+  private isPossibleFilePath(symbol: DocumentSymbol) {
+    const isFile = symbol.kind === SymbolKind.File
+    const isProperty = symbol.kind === SymbolKind.Property
+
+    return isFile || (symbol.detail && isProperty)
+  }
+
+  private getFilePathFromSymbol(symbol: DocumentSymbol) {
+    if (symbol.kind === SymbolKind.File) {
+      return symbol.name
+    }
+
+    return symbol.detail ?? ''
+  }
+
   private getFilePathLocations(
     symbolUnderCursor: DocumentSymbol,
     allDocs: TextDocumentWrapper[]
   ) {
-    if (symbolUnderCursor.kind !== SymbolKind.File) {
+    if (!this.isPossibleFilePath(symbolUnderCursor)) {
       return []
     }
 
-    const filePath = symbolUnderCursor.name
+    const filePath = this.getFilePathFromSymbol(symbolUnderCursor)
 
     const matchingFiles = allDocs.filter(doc =>
-      URI.file(doc.uri).fsPath.endsWith(filePath)
+      URI.file(doc.uri).path.endsWith(filePath)
     )
 
     return matchingFiles.map(doc => {