signcolumn includes symbols where no diagnostic exists (signcolumn/gutter is stale)

[everett1992]

• Did you upgrade to latest plugin version? Yes
• Did you upgrade to/compile latest binary? Run shell command
  bin/languageclient --version to get its version number. Yes, 0.1.156
• (Neovim users only) Did you check output of :checkhealth LanguageClient?

                                                                                                                                                                        
  health#LanguageClient#check                                                                                                                                           
  ========================================================================                                                                                              
    - OK: binary found: <...>/.vim/plugged/LanguageClient-neovim/bin/languageclient                                       
    - OK: languageclient 0.1.156 fb02afed15363c8879277b413b89e6ca51589e6a                                                                                               
    - OK: Floating window is supported and will be used for hover

• Did you check troubleshooting? Yes I haven't analysed the log file yet.

Describe the bug

Some symbols in the gutter / signcolumn remain after the diagnostic is cleared.

• The quickfix window does not display a diagnostic on the line with the symbol.
• The status line does not display any diagnostics when the cursor is on the line with the symbol.
• Toggling the signcolumn does not fix the issue.
• Redrawing the screen with ctrl-l does not fix the issue.
• Stopping and Starting the language client does not fix the issue.
• Restarting neovim does fix the issue.
• I've seen it with every language server I've used (typescript-language-server, javascript-typescript-langserver, eclipse jdtl)

Environment

• neovim/vim version (nvim --version or vim --version):

nvim --version
NVIM v0.4.3
Build type: RelWithDebInfo
LuaJIT 2.0.5
Compilation: <removed>

Features: +acl +iconv +tui
See ":help feature-compile"

   system vimrc file: "$VIM/sysinit.vim"
  fall-back for $VIM: "/usr/local/share/nvim"

Run :checkhealth for more info

• This plugin version (git rev-parse --short HEAD):

fb02afe

• This plugin's binary version (bin/languageclient --version):

languageclient 0.1.156 fb02afed15363c8879277b413b89e6ca51589e6a

To Reproduce

call plug#begin('~/.local/share/nvim/plugged')

Plug 'autozimu/LanguageClient-neovim', {
    \ 'branch': 'next',
    \ 'do': 'bash install.sh',
    \ }

call plug#end()

set signcolumn=yes

let g:LanguageClient_serverCommands = {
    \ 'rust': ['npx', 'typescript-language-server', '--stdio'],
    \ }
let g:LanguageClient_loggingLevel = 'INFO'
let g:LanguageClient_virtualTextPrefix = ''
let g:LanguageClient_loggingFile =  expand('~/.local/share/nvim/LanguageClient.log')
let g:LanguageClient_serverStderr = expand('~/.local/share/nvim/LanguageServer.log')

[everett1992]

The :sign place list includes the phantom signs.
:sign unplace * will clear all signs, including signs with corresponding diagnostics. Then signs are not replaced even when I edit lines with diagnostics or cause different diagnostics on the same lines.

[everett1992]

Here's the cleaned up log after a session

$ cat /tmp/lc.vim.log | grep 'set_sign' | sed 's|.* INFO writer-None src/rpcclient.rs:215 => None ||' | jq -c '.params | {added: .[1] | map(.id), removed: .[2] | map(.id)}'

{"added":[75001,75002,75003,75004,75005,75006],"removed":[]}
{"added":[75007,75008,75009,75010,75011],"removed":[]}
{"added":[75012],"removed":[75009,75004,75005,75006]}
{"added":[75013],"removed":[75007,75008,75010,75011,75012]}

:sign place shows [75013, 75001, 75002, 75003] which matches the state when I run the log back.

[everett1992]

group_by Return an iterable that can group iterator elements. Consecutive elements that map to the same key (“runs”), are assigned to the same group.

The diagnostics aren't sorted by line number, if they appear out of order (Line 0, Line 1, Line 0) signs_next will include multiple symbols for the same line.

https://github.com/autozimu/LanguageClient-neovim/blob/next/src/language_server_protocol.rs#L2539
https://docs.rs/itertools/0.8.0/itertools/trait.Itertools.html#method.group_by

[donotnoot]

I'm experiencing the exact same thing.

NVIM v0.4.3
Build type: Release
LuaJIT 2.0.5
Compilation: /usr/bin/cc -O2 -DNDEBUG -DMIN_LOG_LEVEL=3 -Wall -Wextra -pedantic -Wno-unused-parameter -Wstrict-prototypes -std=gnu99 -Wshadow -Wconversion -Wmissing-prototypes -Wimplicit-fallthrough -Wvla -fstack-protector-strong -fdiagnostics-color=always -DINCLUDE_GENERATED_DECLARATIONS -D_GNU_SOURCE -DNVIM_MSGPACK_HAS_FLOAT32 -DNVIM_UNIBI_HAS_VAR_FROM -I/home/me/repos/oss/neovim/build/config -I/home/me/repos/oss/neovim/src -I/home/me/repos/oss/neovim/.deps/usr/include -I/usr/include -I/home/me/repos/oss/neovim/build/src/nvim/auto -I/home/me/repos/oss/neovim/build/include
Compiled by me@host

Features: +acl +iconv +tui
See ":help feature-compile"

   system vimrc file: "$VIM/sysinit.vim"
  fall-back for $VIM: "/usr/local/share/nvim"

Run :checkhealth for more info

~/.local/share/nvim/plugged/LanguageClient-neovim next I $ git rev-parse --short HEAD
4ef68cb

languageclient 0.1.156 

I'm using Go with gopls however:

" Deoplete
let g:deoplete#enable_at_startup = 1
call deoplete#custom#option('smart_case', v:true)

" LanguageClient
let g:LanguageClient_serverCommands = {
    \ 'rust': ['~/.cargo/bin/rustup', 'run', 'stable', 'rls'],
    \ 'go': ['~/go/bin/gopls'],
    \ 'javascript': ['/usr/local/bin/javascript-typescript-stdio'],
    \ 'javascript.jsx': ['tcp://127.0.0.1:2089'],
    \ 'python': ['/usr/local/bin/pyls'],
    \ 'ruby': ['~/.rbenv/shims/solargraph', 'stdio'],
    \ }

let g:LanguageClient_diagnosticsDisplay = {
\    1: {
\        "name": "Error",
\        "texthl": "ALEError",
\        "signText": "E",
\        "signTexthl": "ALEErrorSign",
\        "virtualTexthl": "Error",
\    },
\    2: {
\        "name": "Warning",
\        "texthl": "ALEWarning",
\        "signText": "W",
\        "signTexthl": "ALEWarningSign",
\        "virtualTexthl": "Todo",
\    },
\    3: {
\        "name": "Information",
\        "texthl": "ALEInfo",
\        "signText": "I",
\        "signTexthl": "ALEInfoSign",
\        "virtualTexthl": "Todo",
\    },
\    4: {
\        "name": "Hint",
\        "texthl": "ALEInfo",
\        "signText": "H",
\        "signTexthl": "ALEInfoSign",
\        "virtualTexthl": "Todo",
\    },
\}

let g:LanguageClient_rootMarkers = {
	\ 'rust': ['.git', 'Cargo.toml'],
	\ 'go': ['.git', 'go.mod'],
	\}

let g:LanguageClient_useFloatingHover = 1
let g:LanguageClient_usePopupHover = 1
let g:LanguageClient_hoverPreview = "Never"

nnoremap <F5> :call LanguageClient_contextMenu()<CR>

function SetLSPShortcuts()
  nmap gd :call LanguageClient#textDocument_definition()<CR>
  nmap gr :call LanguageClient#textDocument_rename()<CR>
  nmap gf :call LanguageClient#textDocument_formatting()<CR>
  nmap gy :call LanguageClient#textDocument_typeDefinition()<CR>
  nmap gR :call LanguageClient#textDocument_references()<CR>
  nmap <leader>la :call LanguageClient_workspace_applyEdit()<CR>
  nmap gc :call LanguageClient#textDocument_completion()<CR>
  nmap gh :call LanguageClient#textDocument_hover()<CR>
  nmap <leader>ls :call LanguageClient_textDocument_documentSymbol()<CR>
  nmap <F5> :call LanguageClient_contextMenu()<CR>
endfunction()

augroup LSP
  autocmd!
  autocmd FileType cpp,c,rust,go call SetLSPShortcuts()
augroup END

[b1zantine]

I observe the same issue as well.