haskell-language-server sends lots of "dummy" progress messages with default haskell-tools config

[z-campbell]

Neovim version (nvim -v)

v0.9.2

Operating system/version

Windows 11

Output of :checkhealth haskell-tools

OK

How to reproduce the issue

Editing any Haskell file triggers a cascade of "In progress...WARN" log entries in the bottom right hand corner of the nvim window. Nothing appears broken but its inconvenient.

Expected behaviour

I expect it not to show this or to be able to hide it.

Actual behaviour

see above

Log files

No response

The minimal config used to reproduce this issue.

{
'mrcjkb/haskell-tools.nvim',
version = '^3', -- Recommended
ft = { 'haskell', 'lhaskell', 'cabal', 'cabalproject' },
},

[mrcjkb]

Hey 👋

Those messages are shown by fidget.nvim, which recently got an update.

You can refer to its documentation for how to limit the number of LSP messages to show.

[j-hui]

Hi there! Fidget maintainer here; I'm actually also encountering this bug myself: j-hui/fidget.nvim#171

I've been doing some logging and I found that haskell-tools seems to be sending some "dummy" progress messages. For instance, here's are three messages I received after making a small change and writing my buffer:

[INFO  Tue Nov 28 12:25:23 2023] /lua/fidget/poll.lua:113: Poller ( progress ) polling once at 38.376s
[INFO  Tue Nov 28 12:25:23 2023] /lua/fidget/progress/lsp.lua:134: Polling messages from 1 ( haskell-tools.nvim )
[INFO  Tue Nov 28 12:25:23 2023] /lua/fidget/progress.lua:175: Notifying LSP progress message: {
  cancellable = false,
  done = false,
  lsp_id = 1,
  lsp_name = "haskell-tools.nvim",
  title = "Processing",
  token = "144"
}
[INFO  Tue Nov 28 12:25:23 2023] /lua/fidget/progress.lua:175: Notifying LSP progress message: {
  cancellable = false,
  done = false,
  lsp_id = 1,
  lsp_name = "haskell-tools.nvim",
  token = "126"
}
[INFO  Tue Nov 28 12:25:23 2023] /lua/fidget/poll.lua:113: Poller ( progress ) polling once at 38.377s
[INFO  Tue Nov 28 12:25:23 2023] /lua/fidget/progress/lsp.lua:134: Polling messages from 1 ( haskell-tools.nvim )
[INFO  Tue Nov 28 12:25:23 2023] /lua/fidget/progress.lua:175: Notifying LSP progress message: {
  cancellable = false,
  done = true,
  lsp_id = 1,
  lsp_name = "haskell-tools.nvim",
  title = "Processing",
  token = "144"
}

Note that haskell-tools completes the task with token "144", but doesn't follow up on the task with token "126". Each buffer write leads to another one of these stale tasks.

I also tested this HLS alone (i.e., configuring it without haskell-tools.nvim), and I don't get these stale messages.

Update: it also doesn't seem to happen on Neovim nightly (i.e., 0.10.0). It only happens with 0.9.4 for me.

[j-hui]

I wasn't able to track down where that empty message was coming from (and gave up), but I added an option to Fidget that mitigates it in j-hui/fidget.nvim@fe60ce7

[mrcjkb]

@j-hui 🤔 interesting.
It almost certainly has to be haskell-language-server sending those messages. My guess would be that it's something to do with the default settings set by haskell-tools, and it probably needs to be fixed upstream.

I'll reopen this issue and bisect on the config on Friday.

Thanks for the fix on your end 🙏

[mrcjkb]

@j-hui I have set progress.ignore_empty_message = false in my fidget config, but I can't seem to reproduce the issue in any of my projects (I'm using NixOS and haskell-language-server version: 2.4.0.0 (GHC: 9.4.8)).

Which OS and haskell-language-server version are you using? Do you have a project I can try to reproduce this with?

I found this hls issue, which seems to be related.