Using vscDebugger as debugger #166

PMassicotte · 2024-06-30T12:39:08Z

PMassicotte
Jun 30, 2024
Maintainer

I am trying to install and use vscDebugger (https://manuelhentschel.github.io/vscDebugger/). I am feeling that I am close to use it with a real DAP client.

What I have so far.

In debug.lua

-- debug.lua
--
-- Shows how to use the DAP plugin to debug your code.
--
-- Primarily focused on configuring the debugger for Go, but can
-- be extended to other languages as well. That's why it's called
-- kickstart.nvim and not kitchen-sink.nvim ;)

return {
    -- NOTE: Yes, you can install new plugins here!
    "mfussenegger/nvim-dap",
    -- NOTE: And you can specify dependencies as well
    dependencies = {
        -- Creates a beautiful debugger UI
        "rcarriga/nvim-dap-ui",

        -- Installs the debug adapters for you
        "williamboman/mason.nvim",
        "jay-babu/mason-nvim-dap.nvim",
        "nvim-neotest/nvim-nio",

        -- Add your own debuggers here
        "leoluz/nvim-dap-go",
    },
    config = function()
        local dap = require("dap")
        local dapui = require("dapui")
        dap.listeners.before.attach.dapui_config = function()
            dapui.open()
        end
        dap.listeners.before.launch.dapui_config = function()
            dapui.open()
        end
        dap.listeners.before.event_terminated.dapui_config = function()
            dapui.close()
        end
        dap.listeners.before.event_exited.dapui_config = function()
            dapui.close()
        end

        dap.set_log_level("DEBUG")

        require("mason-nvim-dap").setup({
            -- Makes a best effort to setup the various debuggers with
            -- reasonable debug configurations
            automatic_setup = true,

            -- You can provide additional configuration to the handlers,
            -- see mason-nvim-dap README for more information
            handlers = {},

            -- You'll need to check that you have the required things installed
            -- online, please don't ask me how to install them :)
            ensure_installed = {
                -- Update this to ensure that you have the debuggers for the langs you want
                -- 'delve',
                "codelldb",
                "debugpy",
            },
        })

        dap.adapters.r = {
            type = "server",
            port = "18721",
            name = "R",
            executable = {
                command = "R",
                args = { "--slave", "-e", "vscDebugger::.vsc.listenForDAP()" },
            },
        }

        dap.configurations.r = {
            {
                type = "r",
                name = "Debug R-File",
                request = "attach",
                debugMode = "file",
                stopOnEntry = false,
            },
        }
        -- Basic debugging keymaps, feel free to change to your liking!
        vim.keymap.set("n", "<F5>", dap.continue)
        vim.keymap.set("n", "<F1>", dap.step_into)
        vim.keymap.set("n", "<F2>", dap.step_over)
        vim.keymap.set("n", "<F3>", dap.step_out)
        vim.keymap.set("n", "<leader>b", dap.toggle_breakpoint, { desc = "Toggle breakpoint" })
        vim.keymap.set("n", "<leader>B", function()
            dap.set_breakpoint(vim.fn.input("Breakpoint condition: "))
        end, { desc = "Breakpoint condition" })

        -- Dap UI setup
        -- For more information, see |:help nvim-dap-ui|
        dapui.setup({
            icons = { expanded = "▾", collapsed = "▸", current_frame = "*" },
            controls = {
                icons = {
                    pause = "⏸",
                    play = "▶",
                    step_into = "⏎",
                    step_over = "⏭",
                    step_out = "⏮",
                    step_back = "b",
                    run_last = "▶▶",
                    terminate = "⏹",
                    disconnect = "⏏",
                },
            },
        })
        -- toggle to see last session result. Without this ,you can't see session output in case of unhandled exception.
        vim.keymap.set("n", "<F7>", dapui.toggle)

        dap.listeners.after.event_initialized["dapui_config"] = dapui.open
        dap.listeners.before.event_terminated["dapui_config"] = dapui.close
        dap.listeners.before.event_exited["dapui_config"] = dapui.close

        -- Install golang specific config
        require("dap-go").setup()
    end,
}

Then, in nvim, place a breakpoint wherever you want and press F7:

Start to debug (play button at the bottom). There is an error popping:

It says there is something at line 51:

https://github.com/rcarriga/nvim-dap-ui/blob/b7267003ba4dd860350be86f75b9d9ea287cedca/lua/dapui/components/variables.lua#L51

I checked the dap log (/home/filoche/.cache/nvim/dap.log) and we have this:

[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1182 ]	"Starting debug adapter server executable"	{
  args = { "--slave", "-e", "vscDebugger::.vsc.listenForDAP()" },
  command = "R"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1315 ]	"Debug adapter server executable started, listening on 18721"
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1319 ]	"Connecting to debug adapter"	{
  executable = {
    args = { "--slave", "-e", "vscDebugger::.vsc.listenForDAP()" },
    command = "R"
  },
  name = "R",
  port = "18721",
  type = "server"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1711 ]	"request"	{
  arguments = {
    adapterID = "nvim-dap",
    clientID = "neovim",
    clientName = "neovim",
    columnsStartAt1 = true,
    linesStartAt1 = true,
    locale = "en_CA.UTF-8",
    pathFormat = "path",
    supportsProgressReporting = true,
    supportsRunInTerminalRequest = true,
    supportsStartDebuggingRequest = true,
    supportsVariableType = true
  },
  command = "initialize",
  seq = 1,
  type = "request"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  body = {
    completionTriggerCharacters = { "[", "$", ":", "@", "(", ")" },
    exceptionBreakpointFilters = { {
        default = true,
        filter = "fromFile",
        label = "Errors from R Files"
      }, {
        default = false,
        filter = "fromEval",
        label = "Errors from the Debug Console"
      } },
    supportsBreakpointLocationsRequest = false,
    supportsCancelRequest = false,
    supportsClipboardContext = true,
    supportsCompletionsRequest = true,
    supportsConfigurationDoneRequest = true,
    supportsDataBreakpoints = false,
    supportsDelayedStackTraceLoading = false,
    supportsEvaluateForHovers = false,
    supportsExceptionInfoRequest = false,
    supportsExceptionOptions = true,
    supportsRestartRequest = false,
    supportsSetVariable = true,
    supportsStepBack = false,
    supportsTerminateRequest = false
  },
  command = "initialize",
  packageInfo = {
    Author = "Manuel Hentschel [aut, cre],\n  Kun Ren [ctb],\n  Denes Toth [ctb] (<https://orcid.org/0000-0003-4262-3217>)",
    ["Authors@R"] = 'c(\n    person(\n        given = "Manuel",\n        family = "Hentschel",\n        role = c("aut", "cre"),\n        email = "[email protected]"\n    ),\n    person(\n        given = "Kun",\n        family = "Ren",\n        role = "ctb",\n        email = "[email protected]"\n    ),\n    person(\n        given = "Denes", \n        family = "Toth", \n        role = "ctb",\n        email = "[email protected]", \n        comment = c(ORCID = "0000-0003-4262-3217")\n    ))',
    BugReports = "https://github.com/ManuelHentschel/vscDebugger/issues",
    Built = "R 4.4.1; x86_64-pc-linux-gnu; 2024-06-30 11:37:30 UTC; unix",
    Description = "Provides support for a visual studio code\n    debugger",
    Encoding = "UTF-8",
    Imports = "jsonlite, R6, tcltk",
    License = "MIT",
    Maintainer = "Manuel Hentschel <[email protected]>",
    NeedsCompilation = "yes",
    Package = "vscDebugger",
    Packaged = "2024-06-30 11:37:29 UTC; filoche",
    Roxygen = "list(markdown = TRUE)",
    RoxygenNote = "7.2.2",
    Suggests = "pkgload, knitr, rmarkdown, markdown",
    Title = "Support for Visual Studio Code Debugger",
    URL = "https://ManuelHentschel.github.io/vscDebugger/,\nhttps://github.com/ManuelHentschel/vscDebugger",
    Version = "0.5.3",
    VignetteBuilder = "knitr"
  },
  request_seq = 1,
  seq = 0,
  success = true,
  type = "response"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1711 ]	"request"	{
  arguments = {
    debugMode = "file",
    name = "Debug R-File",
    request = "attach",
    stopOnEntry = false,
    type = "r"
  },
  command = "attach",
  seq = 2,
  type = "request"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  event = "initialized",
  seq = 0,
  type = "event"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1711 ]	"request"	{
  arguments = {
    breakpoints = { {
        line = 3
      } },
    lines = { 3 },
    source = {
      name = "test.R",
      path = "/home/filoche/Desktop/test.R"
    },
    sourceModified = false
  },
  command = "setBreakpoints",
  seq = 3,
  type = "request"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  command = "attach",
  request_seq = 2,
  seq = 0,
  success = true,
  type = "response"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  body = {
    breakpoints = { {
        attempted = true,
        id = 2,
        line = 3,
        requestedLine = 3,
        source = {
          name = "test.R",
          path = "/home/filoche/Desktop/test.R"
        },
        verified = false
      } }
  },
  command = "setBreakpoints",
  request_seq = 3,
  seq = 0,
  success = true,
  type = "response"
}
[ INFO ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:904 ]	"Breakpoint unverified"	{
  attempted = true,
  id = 2,
  line = 3,
  requestedLine = 3,
  source = {
    name = "test.R",
    path = "/home/filoche/Desktop/test.R"
  },
  verified = false
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1711 ]	"request"	{
  arguments = {
    filters = { "fromFile" }
  },
  command = "setExceptionBreakpoints",
  seq = 4,
  type = "request"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  command = "setExceptionBreakpoints",
  request_seq = 4,
  seq = 0,
  success = true,
  type = "response"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1711 ]	"request"	{
  command = "configurationDone",
  seq = 5,
  type = "request"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  body = {
    capabilities = {
      supportsSetVariable = true,
      supportsStepBack = false,
      supportsTerminateRequest = false
    }
  },
  event = "capabilities",
  seq = 0,
  type = "event"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  command = "configurationDone",
  request_seq = 5,
  seq = 0,
  success = true,
  type = "response"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  body = {
    allThreadsStopped = true,
    preserveFocusHint = false,
    reason = "entry",
    threadId = 1
  },
  event = "stopped",
  seq = 0,
  type = "event"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1711 ]	"request"	{
  command = "threads",
  seq = 6,
  type = "request"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  body = {
    threads = { {
        id = 1,
        name = "Thread 1"
      } }
  },
  command = "threads",
  request_seq = 6,
  seq = 0,
  success = true,
  type = "response"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1711 ]	"request"	{
  arguments = {
    threadId = 1
  },
  command = "stackTrace",
  seq = 7,
  type = "request"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  body = {
    stackFrames = { {
        id = 0,
        name = "Global Workspace",
        presentationHint = "label"
      } },
    totalFrames = 1
  },
  command = "stackTrace",
  request_seq = 7,
  seq = 0,
  success = true,
  type = "response"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1711 ]	"request"	{
  arguments = {
    frameId = 0
  },
  command = "scopes",
  seq = 8,
  type = "request"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  body = {
    scopes = { {
        evaluateName = "<environment>",
        indexedVariables = 0,
        name = "<environment: R_GlobalEnv>",
        namedVariables = 0,
        type = "environment",
        value = "<environment: R_GlobalEnv>",
        variablesReference = 0
      } }
  },
  command = "scopes",
  request_seq = 8,
  seq = 0,
  success = true,
  type = "response"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1711 ]	"request"	{
  arguments = {
    variablesReference = 0
  },
  command = "variables",
  seq = 9,
  type = "request"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:1711 ]	"request"	{
  arguments = {
    variablesReference = 0
  },
  command = "variables",
  seq = 10,
  type = "request"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  body = {
    variables = {
      stackNode = {
        stackFrames = { {
            id = 0,
            name = "Global Workspace",
            presentationHint = "label"
          } },
        totalFrames = 1
      }
    }
  },
  command = "variables",
  request_seq = 9,
  seq = 0,
  success = true,
  type = "response"
}
[ DEBUG ] 2024-06-30T08:35:47Z-0400 ] ...oche/.local/share/nvim/lazy/nvim-dap/lua/dap/session.lua:966 ]	1	{
  body = {
    variables = {
      stackNode = {
        stackFrames = { {
            id = 0,
            name = "Global Workspace",
            presentationHint = "label"
          } },
        totalFrames = 1
      }
    }
  },
  command = "variables",
  request_seq = 10,
  seq = 0,
  success = true,
  type = "response"
}

The log indicates many successful operations. The connection is working, breakpoints are being detected, and so on.

I am leaving it as is; perhaps someone else will have more success than I did. :)

jalvesaq · 2024-07-01T00:27:11Z

jalvesaq
Jul 1, 2024
Maintainer

I installed the vcsDebugger package and made a copy of your debug.lua to my ~/.config/nvim/lua/plugins directory. Nothing happens when I press F7, but I see the same error message (variable.name is nil) after the command DapNew.

0 replies

jrwishart · 2024-07-01T05:59:10Z

jrwishart
Jul 1, 2024

I cant get this to work but I must be missing something fundamental. I get the opposite situation of @jalvesaq. I can get the panes all open with the F7 keymap and set a breakpoint with <leader>b but nothing happens. Checking running processes I can see 8 pids running R. I have installed the vscDebugger package.

Related to this, there is movement here dgkf/debugadapter#15

0 replies

PMassicotte · 2024-07-01T11:20:32Z

PMassicotte
Jul 1, 2024
Maintainer Author

Another possible configuration:

local dap = require('dap')

dap.adapters.r = {
  type = 'server',
  port = 18721,  -- needs to match `debugadapter::run()`'s `port` argument
  executable = {
      command = "R",
      args = { "--slave", "-e", "debugadapter::run()" },
  },
}

dap.configurations.r = {
  {
    type = 'r',
    request = 'attach',
    name = 'Attach session'
  }
}

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Using vscDebugger as debugger #166

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 3 comments

{{title}}

{{title}}

{{title}}

Select a reply

Using vscDebugger as debugger #166

PMassicotte Jun 30, 2024 Maintainer

Replies: 3 comments

jalvesaq Jul 1, 2024 Maintainer

jrwishart Jul 1, 2024

PMassicotte Jul 1, 2024 Maintainer Author

PMassicotte
Jun 30, 2024
Maintainer

jalvesaq
Jul 1, 2024
Maintainer

jrwishart
Jul 1, 2024

PMassicotte
Jul 1, 2024
Maintainer Author