Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Diagnostics use a stale parse_result when the request is read before its didChange is applied

Ouverte
  • Quelque chose ne va pas ?
#4,247 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@efegokdemir y travaille déjà.

Depuis le 23/10/2026.

  • #4249 par @efegokdemir — ouverte

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
52/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
neovim, ruby
Domaine
backend, devtools

Piste de recherche

Start with BaseServer#start, the worker's push_edits path, and the diagnostic request handling; compare when needs_parsing is set with when document.parse_result is refreshed. Check the RuboCop add-on's RuntimeAdapter#prism_result and Requests::Diagnostics for both reported effects. Done means diagnostics and syntax warnings use a parse result matching the updated document source in the reproduction.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Ruby LSP Information
  • ruby-lsp 0.26.11 (code in question is unchanged on main)
  • rubocop 1.87.0 (also checked 1.88.0 RuntimeAdapter#prism_result, unchanged), prism 1.9.0
  • Ruby 4.0.6 via rbenv, Linux
  • Neovim 0.11.6, built-in LSP client (pull diagnostics)
  • initializationOptions: { linters: ["rubocop"] } (RuboCop's own add-on)
Description

Diagnostics are intermittently computed with a parse_result from the previous document version while document.source is already the new version. With RuboCop's add-on, which reuses document.parse_result as prism_result, this produces wrong offenses that stay until the next edit. Syntax warnings from Requests::Diagnostics read the same stale tree.

Order of events, as I read it:

  1. Client sends didChange and immediately textDocument/diagnostic (Neovim pulls diagnostics on every didChange).
  2. The main thread (BaseServer#start) only calls document.parse! for non-did* messages and queues didChange without applying it. When the diagnostic request arrives, the edit isn't applied yet, needs_parsing is false, so nothing is parsed.
  3. The worker applies the edits (push_edits sets needs_parsing = true), then handles the diagnostic request without parsing.

Server-side log from a stale run (a small workspace add-on that logs at enqueue, worker start and in RuntimeAdapter#run_diagnostic):

reader  enqueue textDocument/didChange doc v0 needs_parsing=false tree=current
worker  start   textDocument/didChange doc v0 needs_parsing=false tree=current
reader  enqueue textDocument/diagnostic doc v0 needs_parsing=false tree=current
worker push_edits v15 start
worker push_edits v15 done src="# frozen_string_literal: true\n\ndef foo\n  y = \"abc\"\n  x = 1\n  x\nend\n"
worker  start   textDocument/diagnostic doc v15 needs_parsing=true tree=STALE
adapter run_diagnostic v15 source==parsed_source? false
  source:        "# frozen_string_literal: true\n\ndef foo\n  y = \"abc\"\n  x = 1\n  x\nend\n"
  parse_result:  "# frozen_string_literal: true\n\ndef foo\n  x = 1\n  x\nend\n"

Resulting diagnostics vs. rubocop --stdin on the same text:

client:  4:3 Style/RedundantAssignment | 4:9 Layout/ExtraSpacing
rubocop: 4:3 Lint/UselessAssignment | 4:7 Style/StringLiterals | 5:3 Style/RedundantAssignment

In a later stale run the parser warning assigned but unused variable - y remained after y had been deleted, so this isn't specific to the RuboCop add-on.

Reproduction steps

Project: Gemfile with gem "rubocop", a .rubocop.yml with AllCops: { NewCops: enable }, and app.rb:

# frozen_string_literal: true

def foo
  x = 1
  x
end

Minimal Neovim config (nvim --clean -u init.lua app.rb):

vim.lsp.config("ruby_lsp", {
  cmd = { "rbenv", "exec", "ruby-lsp" },
  filetypes = { "ruby" },
  root_markers = { "Gemfile" },
  init_options = { linters = { "rubocop" } },
})
vim.lsp.enable("ruby_lsp")
  1. Open app.rb and wait for diagnostics.
  2. Insert a new line y = "abc" after def foo. I typed it via nvim_buf_set_text one character at a time, 40ms apart; the client sends it as a single didChange.
  3. See diagnostics that don't match the buffer.

Results (headless, 6 runs each):

setting stale runs
linters: ["rubocop"] 6/6
linters: ["rubocop_internal"] 0/6
no linters (detects rubocop_internal) 0/6
["rubocop"] in my full config, with a 300ms delay before sending the diagnostic request 0/5 (vs 2/5 without the delay in that batch)

rubocop_internal is unaffected because RuboCopRunner#run doesn't pass prism_result through (the assignment is commented out) and RuboCop parses contents itself.

Possible fix direction: call document.parse! in the worker before handling a request, or parse after push_edits, so a request never sees a tree older than its source. I haven't checked whether VS Code hits this; its pull timing may hide it.

Langage dominant
Ruby
Étoiles
2k
Forks
286
Merge moyen
8 h 37 min
PR mergées (30 j)
12

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de Shopify/ruby-lsp

Toutes les issues de Shopify/ruby-lsp

Issues similaires

Plus d'issues Ruby

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.