Support for VSCode DAP protocol #71

moteus · 2022-02-26T11:08:33Z

I'll try to add comments in the code

Fix. Strip error message for evaluate command Add. Logging configuration.

moteus · 2022-02-26T11:09:08Z

src/mobdebug.lua

 if jit and jit.off then jit.off() end

-local socket = require "socket"
+local state = {


Packed local variables into state table. This is done because of the limitations of some environment. In my case I have limit to 120 local variables and I faced with it.

moteus · 2022-02-26T11:09:59Z

src/mobdebug.lua

+  end
+end
+
+local Socket = {} do


This class incapsulate buffered IO and IO pending detection

moteus · 2022-02-26T11:11:08Z

src/mobdebug.lua

 mobdebug.dump = serpent.dump
 mobdebug.linemap = nil
 mobdebug.loadstring = loadstring
+mobdebug.print = print


This allows to redirect print to e.g. logs inside debuggee application

moteus · 2022-02-26T11:12:13Z

src/mobdebug.lua

+    or string_match(file, [[^.:]])
+end

 local function removebasedir(path, basedir)


Just reformat code and reduce the number if nested levels

moteus · 2022-02-26T11:12:42Z

src/mobdebug.lua

+  return (file:gsub("^(/?)%.%./", "%1"))
+end
+
+local function is_soucer_file_path(file)


Code from debug_hook without changes

moteus · 2022-02-26T11:22:30Z

src/mobdebug.lua

    if not (
-      step_into or step_over or breakpoints[line] or watchescnt > 0
-      or is_pending(server)
-    ) then checkcount = checkcount + 1; return end


The checkcount logic movet to the Socket class

moteus · 2022-02-26T11:28:03Z

src/mobdebug.lua

    end

-    if is_pending(server) then handle_breakpoint(server) end
+    local possible_pending_io = debugger.loop_pending_io()


In case this function returns true that means there exists some pending data and this data have to be processed inside main loop.
E.g. debugger receive only part of message and we do not want to wait too long inside IO. In this case this function can return false, server:is_pending() will be true, but there no reason to yield to the main loop.

moteus · 2022-02-26T11:45:02Z

src/mobdebug.lua

+  state.basedir = "" -- to reset basedir in case the same module/state is reused
+end
+
+local mobdebug_debugger = {} do


Submodule that implements MobDebug protocol.

moteus · 2022-02-26T11:45:55Z

src/mobdebug.lua

-  if not jit then
-    for co, debugged in pairs(coroutines) do
-      if debugged then debug.sethook(co) end
+function mobdebug_debugger.send_response(status, message, data)


I extract all commant parsing and sendig responses to separate functions.

moteus · 2022-02-26T11:49:10Z

src/mobdebug.lua

+-- Handling command from inside debug hook during run state
+function mobdebug_debugger.pending_io()
+  local possible_pending_io = false
+  while server:is_pending() do


The main changes that this loop allows to handle multiple commands.

Fix. Honor the sync flag in the header receiving operation

mavriq-dev · 2022-04-26T20:17:47Z

This is a is very handy to have. Being able to support multiple debuggers is a huge win.

muescha · 2022-11-21T10:53:35Z

whats the protocol used before by mobdebug? i would like to study the specs

muescha · 2022-11-23T18:08:52Z

found answer to my question here:

MobDebug/src/mobdebug.lua

Lines 1541 to 1561 in f27d479

    
           print("setb <file> <line>    -- sets a breakpoint") 
        
           print("delb <file> <line>    -- removes a breakpoint") 
        
           print("delallb               -- removes all breakpoints") 
        
           print("setw <exp>            -- adds a new watch expression") 
        
           print("delw <index>          -- removes the watch expression at index") 
        
           print("delallw               -- removes all watch expressions") 
        
           print("run                   -- runs until next breakpoint") 
        
           print("step                  -- runs until next line, stepping into function calls") 
        
           print("over                  -- runs until next line, stepping over function calls") 
        
           print("out                   -- runs until line after returning from current function") 
        
           print("listb                 -- lists breakpoints") 
        
           print("listw                 -- lists watch expressions") 
        
           print("eval <exp>            -- evaluates expression on the current context and returns its value") 
        
           print("exec <stmt>           -- executes statement on the current context") 
        
           print("load <file>           -- loads a local file for debugging") 
        
           print("reload                -- restarts the current debugging session") 
        
           print("stack                 -- reports stack trace") 
        
           print("output stdout <d|c|r> -- capture and redirect io stream (default|copy|redirect)") 
        
           print("basedir [<path>]      -- sets the base path of the remote application, or shows the current one") 
        
           print("done                  -- stops the debugger and continues application execution") 
        
           print("exit                  -- exits debugger and the application")

and in #32

muescha · 2022-11-23T18:16:44Z

i asked the question because: when the functionality is equal to both debug protocols then i would not mix the implementation into one file. when something changes then it need to implemented in both protocols on 2 places (DRY)

i would like to see some main functionality and then implement the adapter pattern either for mobdebug protocol or for debug adapter protocol.

local mobdebug = require("mobdebug").adapter("dap").start()
local mobdebug = require("mobdebug").start()

moteus · 2022-12-10T07:57:28Z

I thought about it and even tried to do such a split, but I couldn't do this.
The mobdebug.lua file is a self-contained module with a debug server and debug client simultaneously.
It contains code that depends on a file name and a call stack size.
So as a result, I got some unexplainable errors when adding additional layers to this code.
I had code with two classes, DapLoop and MobDebugLoop, but I could not fix or even understood some glitches and ended up with a more straightforward implementation.
If speaking about require("mobdebug").adapter("dap").start() right now, I see no necessity in such because it is pretty easy to detect client protocol by the first message.

PS. Right now, I use my module with ZBS, and several colleagues use it with VSCode without any issues.

KuDeSnik33ra · 2022-12-16T09:52:34Z

Is there some manual on how to use it with vscode? Isn't there any chance to have multiple connections from debugged application to singe vscode server to debug multiple lua VMs simultaneousely without starting multiple debugging sessions in VSCode?

moteus added 5 commits February 23, 2022 21:37

Add. Support VSCode

1e12651

Add. stop on entry parameter

391af3d

Fix. Do not break inside command line code

fb3c065

Fix. Strip error message for evaluate command Add. Logging configuration.

Update mobdebug module

c101e2e

Enforce pending IO checking inside loop

3dffca0

moteus commented Feb 26, 2022

View reviewed changes

moteus added 2 commits March 4, 2022 11:31

Fix. Do not create a global args variable.

82372df

Fix. Honor the sync flag in the header receiving operation

Add. pathMap parameter

75b4645

moteus changed the title ~~[WIP] Support for VSCode DAP protocol~~ Support for VSCode DAP protocol Mar 11, 2022

Support for VSCode DAP protocol #71

Are you sure you want to change the base?

Support for VSCode DAP protocol #71

Uh oh!

Conversation

moteus commented Feb 26, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mavriq-dev commented Apr 26, 2022

Uh oh!

muescha commented Nov 21, 2022

Uh oh!

muescha commented Nov 23, 2022

Uh oh!

muescha commented Nov 23, 2022

Uh oh!

moteus commented Dec 10, 2022

Uh oh!

KuDeSnik33ra commented Dec 16, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants