How can I use the vsdbg adapter?

[arkaragian]

I am trying to implement a plugin for C# support in neovim. One feature that I would really like to implement would be to be able to
execute a single unit test that contains a breakpoint. I cannot figure how to make this with the netcoredbg project and I was experimenting with https://github.com/OmniSharp/omnisharp-vscode. If you download the release and unzip the file you get access
to the vsdbg executable that seems to have the same interface with the netcoredbg executable. So I made an adapter:

dap.adapters.vsdbg= {
  type = 'executable',
  command = 'vsdbg',
  args = {'--interpreter=vscode', '--engineLogging='..home..'/vsdbg.log'},
}

and in my cs configuration:

dap.configurations.cs = {
    {
        --type = "netcoredbg",
        type = "vsdbg",
        name = "Launch CS Debugger",
        request = "launch",
        program = vim.fn.input('Path to dll: ', vim.fn.getcwd() .. '/bin/', 'file')
        end
    }
}

and tried to execute a test.dll and got the following error:

E5108: Error executing lua ...kar\AppData\Local\nvim-data\plugged\nvim-dap/lua/dap.lua:484: ...ata\Local\nvim-data\plugged\nvim-dap/lua/dap/session.lua:1217: Error running vsdbg: ENOENT: no such file or directory

Bellow are the logs I feel that there must be a mismatch on the sequences or the vscode debuger refuses to speak to non vscode dap clients. Has anyone tried this before?
Command Seq 0:

{
  "type": "request",
  "command": "initialize",
  "seq": 0,
  "arguments": {
    "clientId": "neovim",
    "clientname": "neovim",
    "adapterID": "nvim-dap",
    "pathFormat": "path",
    "columnsStartAt1": true,
    "linesStartAt1": true,
    "supportsRunInTerminalRequest": true,
    "supportsVariableType": true,
    "supportsProgressReporting": true,
    "locale": "en_US"
  }
}

Response Seq 1:

{
  "seq": 1,
  "type": "response",
  "request_seq": 0,
  "success": false,
  "command": "initialize",
  "message": "",
  "body": {
    "supportsConfigurationDoneRequest": true,
    "supportsFunctionBreakpoints": true,
    "supportsConditionalBreakpoints": true,
    "supportsHitConditionalBreakpoints": true,
    "supportsEvaluateForHovers": true,
    "exceptionBreakpointFilters": [
      {
        "filter": "all",
        "label": "All Exceptions",
        "description": "Break when an exception is thrown. ",
        "default": false,
        "supportsCondition": true
      }
    ],
    "supportsSetVariable": true,
    "supportsGotoTargetsRequest": true,
    "supportsModulesRequest": true,
    "additionalModuleColumns": [
      {
        "attributeName": "vsLoadAddress",
        "label": "Load Address",
        "type": "string"
      },
      {
        "attributeName": "vsPreferredLoadAddress",
        "label": "Preferred Load Address",
        "type": "string"
      },
      {
        "attributeName": "vsModuleSize",
        "label": "Module Size",
        "type": "number"
      },
      {
        "attributeName": "vsLoadOrder",
        "label": "Order",
        "type": "number"
      },
      {
        "attributeName": "vsTimestampUTC",
        "label": "Timestamp",
        "type": "unixTimestampUTC"
      },
      {
        "attributeName": "vsIs64Bit",
        "label": "64-bit",
        "type": "boolean"
      }
    ],
    "supportedChecksumAlgorithms": [
      "MD5",
      "SHA1",
      "SHA256"
    ],
    "supportsExceptionOptions": true,
    "supportsValueFormattingOptions": true,
    "supportsExceptionInfoRequest": true,
    "supportTerminateDebuggee": true,
    "supportsSetExpression": true,
    "supportsReadMemoryRequest": true,
    "supportsCancelRequest": true,
    "supportsExceptionFilterOptions": true,
    "supportsExceptionConditions": true,
    "supportsLoadSymbolsRequest": true,
    "supportsModuleSymbolSearchLog": true,
    "supportsDebuggerProperties": true,
    "supportsSetSymbolOptions": true,
    "supportsHitBreakpointIds": true,
    "supportsVsIndividualBreakpointOperations": true,
    "supportsVsBreakpointLanguage": true,
    "supportsSetHitCount": true,
    "supportsVsCustomMessages": true,
    "supportsEvaluationOptions": true,
    "supportsExceptionStackTrace": true,
    "memoryReferencesAreAddresses": true,
    "supportsObjectFavorites": true,
    "supportsObjectId": true,
    "supportsVariableEnumerators": false
  }
}

Command Seq 1:

{
  "type": "request",
  "command": "disconnect",
  "seq": 1,
  "arguments": {
    "terminateDebuggee": true,
    "restart": false
  }
}

Event Seq 2:

{
  "seq": 2,
  "type": "event",
  "event": "output",
  "body": {
    "category": "telemetry",
    "output": "VS/Diagnostics/Debugger/vsdbg/DebugCompleted",
    "data": {
      "VS.Diagnostics.Debugger.vsdbg.OSFamily": "Windows",
      "VS.Diagnostics.Debugger.vsdbg.Version": "unknown",
      "VS.Diagnostics.Debugger.vsdbg.WindowsVersion": "10.0.19044",
      "VS.Diagnostics.Debugger.vsdbg.DebugCompleted.BreakCounter": 0,
      "VS.Diagnostics.Debugger.vsdbg.AdapterId": "unknown"
    }
  }
}

Response Seq 3

{
  "seq": 3,
  "type": "response",
  "request_seq": 1,
  "success": true,
  "command": "disconnect"
}

[mfussenegger]

Error running vsdbg: ENOENT: no such file or directory

vsdbg is not in your $PATH. You need to add it or specify the absolute path to it.

[arkaragian]

Hello! Thank you for your reply. I have verified that vsdbg is in by path now I just get a vim notification with the message

ERROR Could not initialize debug adapter

The Dap log displays:

[ INFO ] 2023-02-23T23:17:29Z+0200 ] ...ata\Local\nvim-data\plugged\nvim-dap/lua/dap/session.lua:695 ]	"Telemetry"	"VS/Diagnostics/Debugger/vsdbg/DebugCompleted"
[ INFO ] 2023-02-23T23:17:29Z+0200 ] ...ata\Local\nvim-data\plugged\nvim-dap/lua/dap/session.lua:1584 ]	"Session closed due to disconnect"

at this point I don't know if vsdbg refuses to speak to non vscode adapters or if there is a real issue here.

[mfussenegger]

Is there nothing else in the logs? Can you try changing the log level to trace?

[lawrence-laz]

Have you managed to get this running?

[arkaragian]

Hello. To be honest I have yet to find time to really have a look into the issue. This question relates to my effort to really adopt neovim for everyday development as a replacement for VSCode or VS on a windows machine. @mfussenegger has been very helpful. But I really need to research this more.

[pinbraerts]

Launched vsdbg.exe with

dap.adapters.cppvsdbg = {
    id = 'cppvsdbg',
    type = 'executable',
    command = 'D:\\vscode\\cppdbg\\extension\\debugAdapters\\vsdbg\\bin\\vsdbg.exe',
    args = {
        '--interpreter=vscode',
    },
    options = { detached = false, },
}
dap.set_log_level 'trace' -- for log output

Also tried to mimic vscode in nvim-dap/lua/dap/session.lua (1647)

    clientId = 'vscode';
    clientname = 'Visual Studio Code';

In all cases vsdbg.exe rejects the handshake with a quote from the license:

You may only use the C/C++ Extension for Visual Studio Code
with Visual Studio Code, Visual Studio or Visual Studio for Mac
software to help you develop and test your applications.

dap.log

[ DEBUG ] 2023-07-15T22:32:38Z+0300 ] ...data\site\pack\packer\start\nvim-dap/lua/dap/session.lua:1605 ]	"request"	{
  arguments = {
    clientId = "vscode",
    clientname = "vscode",
    cwd = "C:\\Users\\pinbraerts\\src",
    name = "Launch file",
    program = "main.exe",
    request = "launch",
    stopAtEntry = false,
    type = "cppvsdbg"
  },
  command = "launch",
  seq = 1,
  type = "request"
}
[ DEBUG ] 2023-07-15T22:32:38Z+0300 ] ...data\site\pack\packer\start\nvim-dap/lua/dap/session.lua:936 ]	4	{
  arguments = {
    value = "l5mmDzf3TIVR9Mrc4TdFk6Y/jea4WMQHZ9gRvxesbN8="
  },
  command = "handshake",
  seq = 2,
  type = "request"
}
[ WARN ] 2023-07-15T22:32:38Z+0300 ] ...data\site\pack\packer\start\nvim-dap/lua/dap/session.lua:994 ]	"No handler for reverse request"	{
  arguments = {
    value = "l5mmDzf3TIVR9Mrc4TdFk6Y/jea4WMQHZ9gRvxesbN8="
  },
  command = "handshake",
  seq = 2,
  type = "request"
}
[ DEBUG ] 2023-07-15T22:32:38Z+0300 ] ...data\site\pack\packer\start\nvim-dap/lua/dap/session.lua:936 ]	4	{
  body = {
    category = "console",
    output = "-------------------------------------------------------------------\nYou may only use the C/C++ Extension for Visual Studio Code\nwith Visual Studio Code, Visual Studio or Visual Studio for Mac\nsoftware to help you develop and test your applications.\n-------------------------------------------------------------------\n",
    severity = "ok"
  },
  event = "output",
  seq = 3,
  type = "event"
}

[tsioryhaja]

The debug adapter actually use that handshake to verify if you are using it with VSCode or not. so you will need to respond to that handshake request if you want it to work.

I don't know for .Net as I'm not really into it but for C/C++, this is how I do it:
First thing, you will need to have VSCode installed with the cpptools extension.
Next, you need to make a node js code to sign the handshake request value. It uses a custom Native Nodejs plugin so we wont easily make a copy of it in another language. This is a exemple of what I use written in typescript:

declare module vsda {
	export class signer {
		sign(arg: string): string;
	}
	export class validator {
		createNewMessage(arg: string): string;
		validate(arg: string): 'ok' | 'error';
	}
}
const vsda_location = '[VSCODE_INSTALL_DIR]\\resources\\app\\node_modules.asar.unpacked\\vsda\\build\\Release\\vsda.node';
const a: typeof vsda = require(vsda_location);
const signer: vsda.signer = new a.signer();
process.argv.forEach((value, index, array) => {
  if (index >= 2) {
    const r = signer.sign(value);
    console.log(r);
  }
});

And next, you will need to make a handler for the handshake request that use the node js code we just made.
I use something like this with "sign.js" being the transpiled version of the typescript code above:

local utils = require('dap.utils')

local rpc = require('dap.rpc')

local function send_payload(client, payload)
  local msg = rpc.msg_with_content_length(vim.json.encode(payload))
  client.write(msg)
end

function RunHandshake(self, request_payload)
  local signResult = io.popen('node C:\\debugadapter\\vsdbgsignature\\sign.js ' .. request_payload.arguments.value)
  if signResult == nil then
    utils.notify('error while signing handshake', vim.log.levels.ERROR)
    return
  end
  local signature = signResult:read("*a")
  signature = string.gsub(signature, '\n', '')
  local response = {
    type = "response",
    seq = 0,
    command = "handshake",
    request_seq = request_payload.seq,
    success = true,
    body = {
      signature = signature
    }
  }
  send_payload(self.client, response)
end

Next for my debug adapter setup I use this:

dap.adapters.cppvsdbg = {
	id='cppvsdbg',
	type='executable',
  command = '[USER_PROFILE_LOCATION]\\.vscode\\extensions\\ms-vscode.cpptools-1.18.5-win32-x64\\debugAdapters\\vsdbg\\bin\\vsdbg.exe',
  args = { "--interpreter=vscode" },
	options = {
    externalTerminal = true,
    -- logging = {
    --   moduleLoad = false,
    --   trace = true
    -- }
	},
  runInTerminal =  true,
  reverse_request_handlers = {
    handshake = RunHandshake,

  },
}

and for the configuration I use this:

dap.configurations.cpp = {
  {
    name = 'Try vsdbg',
    type = "cppvsdbg",
    request = "launch",
    program = function ()
      return vim.fn.input('Path: ', vim.fn.getcwd() .. '\\Debug\\test.exe', 'file')
    end,
    cwd = vim.fn.getcwd(),
    clientID = 'vscode',
    clientName = 'Visual Studio Code',
    externalTerminal = true,
    columnsStartAt1 = true,
    linesStartAt1 = true,
    locale = "en",
    pathFormat = "path",
    externalConsole = true
    -- console = "externalTerminal"
  },
}

and last thing, it's to be discussed but I noticed that the "stackTrace" request actually result in an error. This is I think to be discussed with the owner of the lib what he think should be done but it actually have some difference with the specification of the DAP.

I the specification, in the "stackTrace" arguments, the field "startFrame" is not required and should be used as a 0 by the debug adapter if not specified. But vsdbg actually require you to specify it. So for the moment, I modified a bit my local copy of nvim-dap to set this field to 0. But I don't know if the lib actually want that too.

[Ryex]

I just want to thank you for this very through walk through. I was able to get vsdbg working in neovim and no longer need to go back to vscode to have a working debugger for MSVC compiled programs

[lawrence-laz]

Has anyone gotten this to work with .NET?

[DasGandlaf]

@tsioryhaja Thank you so much for this walkthrough! With this guide, I could get it to work fairly quickly.

I the specification, in the "stackTrace" arguments, the field "startFrame" is not required and should be used as a 0 by the debug adapter if not specified. But vsdbg actually require you to specify it. So for the moment, I modified a bit my local copy of nvim-dap to set this field to 0. But I don't know if the lib actually want that too.

@mfussenegger Do you think this is something that should be in main?

Specifically it's in lua/dap/session.lua line 706:
local err, response = self:request('stackTrace', { startFrame = 0, threadId = stopped.threadId; })

(Notice that startFrame = 0 was added to the original code)

Without this, the vsdbg.exe debugger does not work. If it does not affect anything else, I assume it should be fine adding this? I do understand if not though, because this really is an edge case.

Possibly as a configuration option?

By the way, thank you for all your awesome plugins!