feat(lang): add debug adapter plugin for go #1115

fredrikaverpil · 2023-07-13T12:31:15Z

Why this change?

I'm getting an error with <leader>td, when I want to debug a go test. See #1107 for details.

It seems there is no debug adapter defined in the Go extras. I can work around this locally like so:

return {
  -- extend Go extras setup from lazy.lua, with DAP capability
  {
    "leoluz/nvim-dap-go",
    dependencies = {
      { "mfussenegger/nvim-dap" },
    },
    ft = { "go" },
    config = true,
    keys = {
      -- workaround, as nvim-dap-go does not have a DAP strategy set up for neotest
      -- see https://github.com/nvim-neotest/neotest-go/issues/12
      { "<leader>tg", "<cmd>lua require('dap-go').debug_test()<CR>", desc = "Debug Nearest (Go)" },
    },
  },
}

...but I figured it might be better to extend the go extras with this capability, hence this PR.

What was changed?

Add nvim-dap-go plugin.
Add keymap override for <leader>td in gopls lspconfig.

I can now successfully debug go tests with <leader>td.

Concerns, side-effects, notes etc

Even with the addition of nvim-dap-go, you cannot use <leader>td or require("neotest").run.run({strategy = "dap"}) to debug a test, as neotest-go apparently does not implement a DAP strategy. Instead you have to invoke require('dap-go').debug_test(). It might be good to mention this in the extras docs. Or can we reliably override the command executed by <leader>td but only for go buffers, perhaps?

jyuan0 · 2023-07-13T18:20:27Z

I thought mason-nvim-dap should have added a Go DAP adapter and configurations automatically without the need for this plugin. Is that not working or are the adapters/configs not working correctly?

fredrikaverpil · 2023-07-13T18:37:38Z

@jyuan0 Hm, not sure. You can see the error I get when I just enable the go extras here:#1107

I haven't looked into whether mason-nvim-dap is supposed set both a DAP adapter and a configuration up. Here's the go extras implementation in case you want to take a look: https://github.com/LazyVim/LazyVim/blob/main/lua/lazyvim/plugins/extras/lang/go.lua

dpetka2001 · 2023-07-13T18:37:44Z

mason-nvim-dap provides configuration for the adapters that are configured in nvim-dap. However, this is a case where neotest-go does not provide dap configuration support, so that one can use the strategy=dap provided by neotest. neotest-go is a neotest adapter not a nvim-dap adapter.

neotest-go does not provide a DAP strategy, and thus you cannot invoke the debugger with require('neotest').run.run({strategy=dap}). There have been efforts to implement this in nvim-neotest/neotest-go#12 but this seems to have stalled. You can find the background to this change discussed here: #1107

dpetka2001 · 2023-07-13T18:47:52Z

Or are you talking about dap-go and I misunderstood? In this case mason-nvim-dap uses the handlers field to automatically set up adapters. But the default handlers is empty in the extras, so nothing gets configured automatically in LazyVim as far as I understood from the mason-nvim-dap README.

jyuan0 · 2023-07-13T18:58:44Z

From my understanding of mason-nvim-dap, it should automatically setup a DAP adapter and configs without specifying anything in handlers (handlers is for customization).

I'm not saying this solves the issue with neotest, I just wanted to point out that I think there should already be a Go DAP adapter and config setup (although it might not be working correctly, and the adapter/config provided by nvim-dap-go might be better).

dpetka2001 · 2023-07-13T19:11:07Z

@jyuan0 Pls see this issue. I think it has to be done via handlers.

jyuan0 · 2023-07-13T19:13:53Z

@jyuan0 Pls see this jay-babu/mason-nvim-dap.nvim#68. I think it has to be done via handlers.

~~Ah ok, I guess delve is special.~~ Correction: that issue seems to be about delve not getting installed automatically, but with the current LazyVim setup, delve is automatically installed, and setup with an adapter and configurations.

jyuan0 · 2023-07-13T22:02:16Z

So, from my testing, if I just add the Go extra, delve is automatically installed and mason-nvim-dap adds an DAP adapter and configurations without needing to specify anything in handlers. I guess adding nvim-dap-go is just about getting the require('dap-go').debug_test() functionality.

On another note, the null-ls sources (gomodifytags, impl, etc.) should probably be added to mason so they get installed automatically.

dpetka2001 · 2023-07-14T09:21:53Z

@jyuan0 Thanks for letting us know. I hadn't experimented myself since I don't use Go.

Jomik · 2023-07-14T10:13:52Z

lua/lazyvim/plugins/extras/lang/go.lua

@@ -15,6 +15,10 @@ return {
    opts = {
      servers = {
        gopls = {
+          keys = {
+            -- Workaround for the lack of a DAP strategy in neotest-go: https://github.com/nvim-neotest/neotest-go/issues/12
+            { "<leader>td", "<cmd>lua require('dap-go').debug_test()<CR>", desc = "Debug Nearest (Go)" },


Are we sure this will always overwrite the neotest configuration?
I would suspect that it does not, if you load the go lang extra before the neotest extra?

Also, this will unconditionally bind <leader>td even if we do not have the neotest or dap extras.
I think this keybind probably has to be done under an optional neotest dependency, probably under the nvim-dap dependency too 😄

I'm kind of new to Neovim/LazyVim and can't say I know for sure what's the best way to do this, or what caveats/side-effects there may be. Would be great to have @folke pitch in here (but I see he's on vacation so it'll of course have to wait until he's back).

But since I think you had an interesting observation, I just now tried to load the go extras before the neotest/dap extras, just to see if the keymap would still be overridden for go tests. I initially did this:

-- lazy.lua ... require("lazy").setup({ spec = { -- add LazyVim and import its plugins { "LazyVim/LazyVim", import = "lazyvim.plugins" }, -- import any extras modules here { import = "lazyvim.plugins.extras.lang.go" }, { import = "lazyvim.plugins.extras.test.core" }, { import = "lazyvim.plugins.extras.dap.core" }, { import = "plugins" }, }, ...

I also tried switching them around, and in all cases, I were able to debug a go test with <leader>td - which means the keymap seems like it's always overridden regardless of this order.

However, I haven't dug into the LazyVim implementation and I'm not fully understood with how the Lazy.nvim dependencies = declarative works, and perhaps my local config somehow triggers loading of plugins in some order that doesn't show by this rudimental switcharoo test of mine.

yes, should be fine

folke · 2023-07-22T07:14:12Z

Thanks!

neotest-go does not provide a DAP strategy, and thus you cannot invoke the debugger with require('neotest').run.run({strategy=dap}). There have been efforts to implement this in nvim-neotest/neotest-go#12 but this seems to have stalled. You can find the background to this change discussed here: LazyVim#1107

fredrikaverpil changed the title ~~Add debug adapter for go~~ feat(lang): add debug adapter plugin Jul 13, 2023

fredrikaverpil changed the title ~~feat(lang): add debug adapter plugin~~ feat(lang): add debug adapter plugin for go Jul 13, 2023

Jomik suggested changes Jul 14, 2023

View reviewed changes

fredrikaverpil mentioned this pull request Jul 14, 2023

feat(lang): add null-ls tools to mason's ensure_installed #1133

Merged

folke merged commit 02d673d into LazyVim:main Jul 22, 2023

github-actions bot mentioned this pull request Jul 22, 2023

chore(main): release 6.1.0 #1181

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(lang): add debug adapter plugin for go #1115

feat(lang): add debug adapter plugin for go #1115

fredrikaverpil commented Jul 13, 2023 •

edited

jyuan0 commented Jul 13, 2023 •

edited

fredrikaverpil commented Jul 13, 2023

dpetka2001 commented Jul 13, 2023

dpetka2001 commented Jul 13, 2023

jyuan0 commented Jul 13, 2023

dpetka2001 commented Jul 13, 2023

jyuan0 commented Jul 13, 2023 •

edited

jyuan0 commented Jul 13, 2023

dpetka2001 commented Jul 14, 2023

Jomik Jul 14, 2023

fredrikaverpil Jul 14, 2023 •

edited

folke Jul 22, 2023

folke commented Jul 22, 2023

feat(lang): add debug adapter plugin for go #1115

feat(lang): add debug adapter plugin for go #1115

Conversation

fredrikaverpil commented Jul 13, 2023 • edited

Why this change?

What was changed?

Concerns, side-effects, notes etc

jyuan0 commented Jul 13, 2023 • edited

fredrikaverpil commented Jul 13, 2023

dpetka2001 commented Jul 13, 2023

dpetka2001 commented Jul 13, 2023

jyuan0 commented Jul 13, 2023

dpetka2001 commented Jul 13, 2023

jyuan0 commented Jul 13, 2023 • edited

jyuan0 commented Jul 13, 2023

dpetka2001 commented Jul 14, 2023

Jomik Jul 14, 2023

Choose a reason for hiding this comment

fredrikaverpil Jul 14, 2023 • edited

Choose a reason for hiding this comment

folke Jul 22, 2023

Choose a reason for hiding this comment

folke commented Jul 22, 2023

fredrikaverpil commented Jul 13, 2023 •

edited

jyuan0 commented Jul 13, 2023 •

edited

jyuan0 commented Jul 13, 2023 •

edited

fredrikaverpil Jul 14, 2023 •

edited