LuaLS / LuaLS/lua-language-server

The "workspace/didChangeConfiguration" handler ignores message params

Aperta
#2,899 2 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Lua
Stelle
4.4k
Fork
442
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

When a client sends a workspace/didChangeConfiguration notification to the server, the server discards the message parameters entirely.

The LSP specification defines the type of the params property for this notification as:

interface didChangeConfigurationParams {
	/**
	 * The actual changed settings
	 */
	settings: LSPAny
}

LSPAny leaves the door open for a server to handle this data arbitrarily, so I suppose it isn't a bug per se to handle it by discarding the settings . Nevertheless, the comment creates an expectation that the client can send the altered settings in the settings property, and the server will use them to update its configuration.

As near as I can tell, this is how most LSP servers behave, and what most LSP clients are expecting. For instance, this is the behavior of both neovim's built-in LSP client and the ALE plugin for (neo)vim.

Currently, unless --configPath is specified (in which case the notification is ignored), the handler for this notification patches the server configuration from these sources, in this order:

  1. The folder-scoped configuration(s), pulled from the client via a workspace.configuration request
  2. The .luarc.json(c) file in each folder
  3. The global / unscoped configuration (scope.fallback in the source) pulled from the client via a workspace.configuration request

Notably, 1 and 3 only occur if the client advertised the workspace.configuration capability. If it did not, lua-language-server becomes completely unconfigurable via LSP alone. This is specifically a problem for ALE per this issue.

I would propose that between steps 2 and 3, the server should patch scope.fallback with any settings provided in params.settings, using the same sections polled by the workspace.configuration message. In other words, identical to what is returned from loadClientConfig() in the config loader. Ex:

{
  "method": "workspace/didChangeConfiguration",
  "jsonrpc": "2.0",
  "params": {
    "settings": {
      "Lua": {
        "diagnostics": {
          "enable": true,
          "globals": ["vim"]
        }
        // etc.
      },
      "files.associations" = { /* ... */ },
      "editor.semanticHighlighting.enabled" = true
    }
  }
}

This is consistent with how neovim and ALE -- and probably others -- already try to use the notification, and it won't affect anything for existing clients that don't send params.settings or that send then in some other unexpected format (their params.settings were ignored before and will continue to be ignored after).

I've made a fork with this proposed workflow here, and I'd be happy to make a PR if this proposal sounds reasonable.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Individua l'handler di workspace/didChangeConfiguration e il punto di ingresso del loader di configurazione denominato loadClientConfig(), quindi traccia come viene popolato scope.fallback. Il lavoro è completato quando params.settings viene applicato tra i passaggi di configurazione con ambito di cartella e globali, preservando il comportamento esistente per settings mancanti o imprevisti e --configPath.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
lua
Ambito
api, backend
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.