LSP: Unable to "hover" when a local definition or type definition's file path contains url encoded characters

[Per48edjes]

Question

I was just practicing Haskell with Exercism and exploring property testing (here is the source code if that's helpful), and I'm noticing whenever I try to "hover" on some of the imports from Tests.QuickCheck (e.g., Gen, elements, forAll, value), I get the following error:

Error executing vim.schedule lua callback: .../lazy/haskell-tools.nvim/lua/haskell-tools/lsp/hover.lua:212: inv
alid option '%20R' to 'format'
stack traceback:
        [C]: in function 'format'
        .../lazy/haskell-tools.nvim/lua/haskell-tools/lsp/hover.lua:212: in function 'handler'
        ...l/Cellar/neovim/0.9.0/share/nvim/runtime/lua/vim/lsp.lua:1394: in function ''
        vim/_editor.lua: in function <vim/_editor.lua:0>

Is this to be expected for any particular reason (vs. other packages)? Any pointers are well received -- looking to understand why this issue might arise!

[mrcjkb]

Hey. Thanks for reporting. This looks like a bug in the plugin.
I'm out right now, but will look into it later today.

[Per48edjes]

I'm out right now, but will look into it later today.

Only if you're not on vacation!! 😆

[mrcjkb]

My vacation ended a while ago :(

So I've just had a look, and cannot reproduce the issue with this file.

The error message says the following call is failing:

table.insert(actions, 1, string.format('%d. Go to definition at ' .. location_suffix, #actions + 1))

I can reproduce the error message if I replace that line with

table.insert(actions, 1, string.format('%20R. Go to definition at ' .. location_suffix, #actions + 1))

My guess is that somehow the encoding of the file got messed up in your checkout.
Try uninstalling and re-installing the plugin to fix it.

Which OS are you using?

[Per48edjes]

Which OS are you using?

I'm on a Mac (Ventura 13.1).

I've tried uninstalling and installing but the issue persists, though I think it may because I'm pinned to release 1.x.x? (I'm using AstroNvim and this is the config for haskell-tools.nvim). Can PR a change to use 2.0.0 if that's what's needed here.

[mrcjkb]

I doubt it has anything to do with the version you're pinned to, but it might be worth a try.
Updating to 2.x.x will require a small change to how you configure the plugin.

It definitely looks like an encoding issue though.

What does it look like when you open the file .../lazy/haskell-tools.nvim/lua/haskell-tools/lsp/hover.lua at line 212?
(You'll have to find out where lazy.nvim (your plugin manager) checks out plugins.

I've uploaded a test.lua file here
Can you run it with nvim -l test.lua?

It should output:

> nvim -l test.lua
String.format encoding Test: 0

[mrcjkb]

I just remembered lazy.nvim (the plugin manager AstroNvim uses) byte-compiles all Lua files used before VimEnter or BufReadPre. So this might be caused by a bug in lazy.nvim.

If you update to the 2.x.x branch, the affected module should not be loaded before VimEnter or BufReadPre, so it shouldn't be byte-compiled.

[Per48edjes]

Hey @mrcjkb , will follow your suggestions later today and get back to you!

---

In the meantime, here's the (visual) result of running nvim -l test.lua with the provided test file: String.format encoding Test: 0%.

---

This is what L212 from hover.lua looks like:

...
            table.insert(actions, 1, string.format('%d. Go to type definition at ' .. type_def_suffix, #actions + 1))
...

[mrcjkb]

Hmm, it looks like it's encoded properly - which makes me think it's probably a bug in the bytecode caching.
I'll see if I can come up with a test plugin to reproduce it.

[mrcjkb]

@Per48edjes I've created this plugin that uses the same format string that is causing the error for you.

If you get a chance, could you please install it and see if the error occurs (see the readme for steps to reproduce)?

I've created a workflow that runs a test on macos with a minimal config, but it seems to run just fine.

If you can still reproduce the error with the test plugin, then it's most likely either a bug in AstroNVim or lazy.nvim.

[Per48edjes]

Ok! Will attempt to install and follow the README steps to reproduce now...stay tuned.

[Per48edjes]

Ok, so the only notification I see on reload (after installing the test plugin you provided) is this one:

INFO format inserting integer 5 should not fail

Not sure if this is related, but nvim-notify is complaining about some background color config:

WARN Highlight group 'NotifyBackground' has no background highlight
Please provide an RGB hex value or highlight group with a background value for 'background_colour' option.
This is the colour that will be used for 100% transparency.

require("notify").setup({
  background_colour = "#000000",
})
Defaulting to #000000

(Both of the above notifications occur are consistent on multiple (close + open)s of Neovim.)