fix(#2519): Diagnostics Not Updated When Tree Not Visible #2597

iusmac · 2023-12-22T19:13:48Z

The diagnostic changed event has been untied from the current tree state to ensure the data availability at any time. Now, the diagnostics will be picked up "on the fly" whenever the tree is about to be (re-)drawn, which makes absolute sense, especially, when incrementally exploring the file system structure or when (re-)opening the tree and the diagnostic changed event has already occurred.

All in all, this effectively solves any inconsistencies (see #2517), and ensures that the tree shows the freshest diagnostics, regardless of the tree's state and when diagnostics change.

iusmac · 2023-12-23T11:57:57Z

I've just noticed that fetching diagnostics with coc is completely broken when setting nvim-tree.diagnostics.severity.max to something else than ERROR (default).

The current implementation will find the highest severity, then discard items that are out of range.
Reversing the order fixes and simplifies everything.

Now, the lsp and coc functions look pretty much the same, which makes sense, as there's no big difference between the two, except that with coc we have to bother about the severity limit of each item.

The commit that introduced this bug: 874b7be.

Signed-off-by: iusmac <iusico.maxim@libero.it>

Also, while we're at it, refactor the lsp function for consistency. There should be no functional change, just cosmetic. Signed-off-by: iusmac <iusico.maxim@libero.it>

alex-courtis

This is looking great - many thanks for dealing with the regressive behaviour.

alex-courtis · 2023-12-24T05:25:57Z

lua/nvim-tree/diagnostics.lua

+
+---@param path string
+---@return string
+local function uniformize_path(path)


alex-courtis · 2023-12-24T05:31:33Z

lua/nvim-tree/renderer/builder.lua

@@ -413,6 +413,8 @@ end
 function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
  local copy_paste = require "nvim-tree.actions.fs.copy-paste"

+  require("nvim-tree.diagnostics").update_node_severity_level(node)


This one is very concerning from a performance perspective; we go out of our way to avoid such calls on drawing each line.

Could we improve via one of:

do this once for all nodes prior to rendering

short-circuit this so that it's only called when there is no diagnostic info

alex-courtis · 2023-12-24T05:31:57Z

lua/nvim-tree/diagnostics.lua

+    log.node("diagnostics", buffer_severity_dict, "update")
+    log.profile_end(profile)
+    if view.is_buf_valid(view.get_bufnr()) then
+      require("nvim-tree.renderer").draw()


/ nit please require once at the start of the file

alex-courtis · 2023-12-24T05:32:54Z

lua/nvim-tree/diagnostics.lua

    if is_using_coc() then
-      buffer_severity = from_coc()
+      buffer_severity_dict = from_coc()


/ nit no dict please - we're not writing python here ;)

Signed-off-by: iusmac <iusico.maxim@libero.it>

Causes circular requires after the previous commit. This reverts commit 7413041.

Signed-off-by: iusmac <iusico.maxim@libero.it>

iusmac · 2023-12-25T18:35:08Z

While we're at it, implement error handling for coc.nvim.

If you're lucky and hit CTRL-C while NvimTree is fetching diagnostics from coc.nvim, it can cause a deadlock state in the utils.debounce() that will never release its debouncer.executing flag due the exception in the callback. All subsequent diagnostic update events will be discarded.

Error executing vim.schedule lua callback: function CocAction[4]..coc#rpc#request[4]..<SNR>38_request, line 31: Error on request: Vim:Interrupt
stack traceback:
        [C]: in function 'CocAction'
        ....vim/plugged/nvim-tree.lua/lua/nvim-tree/diagnostics.lua:69: in function 'from_coc'
        ....vim/plugged/nvim-tree.lua/lua/nvim-tree/diagnostics.lua:123: in function 'callback'
        ...usmac/.vim/plugged/nvim-tree.lua/lua/nvim-tree/utils.lua:400: in function <...usmac/.vim/plugged/nvim-tree.lua/lua/nvim-tree/utils.lua:399>

alex-courtis · 2023-12-26T03:43:22Z

lua/nvim-tree/diagnostics.lua

+
+--- The buffer-severity mappings derived during the last diagnostic list update.
+---@type table
+local BUFFER_SEVERITY = {}


This is looking good; we have a cache similar to git's.

It'll take me a while to properly review and test this one.

Signed-off-by: iusmac <iusico.maxim@libero.it>

alex-courtis

Looks great, works well.

I did not test COC. In the unlikely event of any issues I'll call on you ;)

Added some doc and some minor tidies.

Many thanks for all your work!

alex-courtis · 2023-12-30T03:09:47Z

lua/nvim-tree/diagnostics.lua

 local log = require "nvim-tree.log"

 local M = {}

-local severity_levels = {
+---TODO add "$VIMRUNTIME" to "workspace.library" and use the @enum instead of this integer


That one's a work in progress #2546

iusmac force-pushed the master branch from 952684b to 0051796 Compare December 23, 2023 00:52

iusmac changed the title ~~feat(#2519): diagnostics overhaul~~ fix(#2519): Diagnostics Not Updated When Tree Not Visible Dec 23, 2023

iusmac force-pushed the master branch from 0051796 to 4615e32 Compare December 23, 2023 08:44

iusmac added 2 commits December 23, 2023 19:33

fix(nvim-tree#2519): diagnostics overhaul

7bc3616

Signed-off-by: iusmac <iusico.maxim@libero.it>

fix: Properly filter diagnostics from coc

2baf3da

Also, while we're at it, refactor the lsp function for consistency. There should be no functional change, just cosmetic. Signed-off-by: iusmac <iusico.maxim@libero.it>

iusmac force-pushed the master branch from fa928c3 to 2baf3da Compare December 23, 2023 18:33

alex-courtis requested changes Dec 24, 2023

View reviewed changes

iusmac added 4 commits December 25, 2023 11:21

Assign diagnostic version per node to reduce overhead

f30a8f6

Signed-off-by: iusmac <iusico.maxim@libero.it>

Require renderer once

7413041

Signed-off-by: iusmac <iusico.maxim@libero.it>

Revert "Require renderer once"

e3c90fd

Causes circular requires after the previous commit. This reverts commit 7413041.

Rename buffer_severity_dict to BUFFER_SEVERITY

b8079fb

Signed-off-by: iusmac <iusico.maxim@libero.it>

iusmac force-pushed the master branch from 25095f0 to b8079fb Compare December 25, 2023 11:28

iusmac requested a review from alex-courtis December 25, 2023 11:40

iusmac added 2 commits December 25, 2023 18:10

Log diagnostics update properly

e6f343a

Signed-off-by: iusmac <iusico.maxim@libero.it>

Implement error handling for coc.nvim

a15c8a9

Signed-off-by: iusmac <iusico.maxim@libero.it>

alex-courtis reviewed Dec 26, 2023

View reviewed changes

iusmac and others added 3 commits December 26, 2023 09:18

CI style fixes

b05f7e3

Signed-off-by: iusmac <iusico.maxim@libero.it>

Capture Keyboard interrupt when handling coc exceptions

d7bd359

Signed-off-by: iusmac <iusico.maxim@libero.it>

add more doc

c37c895

alex-courtis approved these changes Dec 30, 2023

View reviewed changes

alex-courtis reviewed Dec 30, 2023

View reviewed changes

alex-courtis merged commit 96a783f into nvim-tree:master Dec 30, 2023

github-actions bot mentioned this pull request Dec 19, 2023

chore(master): release nvim-tree 0.99.0 #2587

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(#2519): Diagnostics Not Updated When Tree Not Visible #2597

fix(#2519): Diagnostics Not Updated When Tree Not Visible #2597

Uh oh!

iusmac commented Dec 22, 2023

Uh oh!

iusmac commented Dec 23, 2023

Uh oh!

alex-courtis left a comment

Uh oh!

alex-courtis Dec 24, 2023

Uh oh!

alex-courtis Dec 24, 2023

Uh oh!

alex-courtis Dec 24, 2023

Uh oh!

alex-courtis Dec 24, 2023

Uh oh!

iusmac commented Dec 25, 2023

Uh oh!

alex-courtis Dec 26, 2023

Uh oh!

alex-courtis left a comment

Uh oh!

alex-courtis Dec 30, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

fix(#2519): Diagnostics Not Updated When Tree Not Visible #2597

fix(#2519): Diagnostics Not Updated When Tree Not Visible #2597

Uh oh!

Conversation

iusmac commented Dec 22, 2023

Uh oh!

iusmac commented Dec 23, 2023

Uh oh!

alex-courtis left a comment

Choose a reason for hiding this comment

Uh oh!

alex-courtis Dec 24, 2023

Choose a reason for hiding this comment

Uh oh!

alex-courtis Dec 24, 2023

Choose a reason for hiding this comment

Uh oh!

alex-courtis Dec 24, 2023

Choose a reason for hiding this comment

Uh oh!

alex-courtis Dec 24, 2023

Choose a reason for hiding this comment

Uh oh!

iusmac commented Dec 25, 2023

Uh oh!

alex-courtis Dec 26, 2023

Choose a reason for hiding this comment

Uh oh!

alex-courtis left a comment

Choose a reason for hiding this comment

Uh oh!

alex-courtis Dec 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alex-courtis Dec 30, 2023 •

edited

Loading