Debugger implementation #13433

RemcoSmitsDev · 2024-06-23T22:12:44Z

Closes #5307
Closes #5065

The current state of the debugger implementation:

Screen.Recording.2024-08-12.at.22.25.49.mov

Screen.Recording.2024-10-03.at.22.34.34.mov

All the todo's are in the following channel, so it's easier to work on this together:
https://zed.dev/channel/zed-debugger-11370

If you are on Linux, and you want to join the debugger channel, you can message me on discord and I will invite you.
https://discord.com/channels/869392257814519848/1255246362220691456

Current Features

Breakpoints
- Log breakpoints
- line breakpoints
- Persistent between zed sessions (configurable)
- Multi buffer support
Stack frames
- Click on stack frame
  - View variables that belong to the stack frame
  - Visit the source file
Loaded Sources
- View all used loaded sources if supported by adapter.
Modules
- View all used modules if supported by adapter.
Variables
- Copy value
- Copy name
- Copy memory reference
- Set value (if adapter supports this)
Debug Console
- See logs
- Evaluate code
  - Updates the variable list
  - Auto completion
    - If not supported by adapter, we will show auto-completion for existing variables
Debug Output
- View output that was sent from debug adapter
Controls
- Continue
- Step into
  - Stepping granularity (configurable)
- Step over
  - Stepping granularity (configurable)
- Step out
  - Stepping granularity (configurable)
- Disconnect
- Restart
- Stop
Warning when a debug session exited without hitting any breakpoint

Release Notes:

Added debugger implementation.

davidbuzz · 2024-06-24T05:05:28Z

Add documententation and/or an example on how to configure and/enable this for a specific debugger... if not as part of this PR then to the todo list ?

osiewicz · 2024-06-24T16:49:53Z

Change client id to be language id because you should only run one client per language at the same time

What if you have e.g. a monorepo with multiple services written in the same language?

RemcoSmitsDev · 2024-06-24T19:04:04Z

Uhm, I think most of the debug adapters support multiple threads, but need to look more in to that. Not sure how VS Code handles this, if they allow you to run the same debugger adapter twice or more.

davidbuzz · 2024-07-03T02:29:13Z

I'd love to see another more up-to-date video of the current status of this, if u can find time. :-)

jonahcui · 2024-07-04T09:22:30Z

HI, I have started a dlv(go dap server) to debug go program, but i need bring env to the dlv commend. I read the code DebugAdapterClient, i think when create_tcp_client or create_stdio_client, we should bring env configuration to command.

RemcoSmitsDev · 2024-07-04T10:28:17Z

HI, I have started a dlv(go dap server) to debug go program, but i need bring env to the dlv commend. I read the code DebugAdapterClient, i think when create_tcp_client or create_stdio_client, we should bring env configuration to command.

Hey, I think most debug adapters support this already by passing in an env prop through the launch or attach request. See the JS debugger config options. We already support passing in your own config values, so I don't think we need to add more configuration for this. Because it's on the debug adapter for getting this data and handling it how they want.

jonahcui · 2024-07-04T11:04:06Z

HI, I have started a dlv(go dap server) to debug go program, but i need bring env to the dlv commend. I read the code DebugAdapterClient, i think when create_tcp_client or create_stdio_client, we should bring env configuration to command.

Hey, I think most debug adapters support this already by passing in an env prop through the launch or attach request. See the JS debugger config options. We already support passing in your own config values, so I don't think we need to add more configuration for this. Because it's on the debug adapter for getting this data and handling it how they want.

Ok, understand.... I will test it on js debugger and go delve and study your code.

Clean up debugger Inventory code

Start showing all the threads as tabs so you can debug multiple threads at the same time.

Because we don't use the result of the find so any would be better in this case

* WIP Move stack frame list to own module * Add missing notify * Remove some more duplicated state for the current stack frame * Clear highlights when stack frame has changed * Fix go to stack frame again

* Pass http client to dap store * Set up DapAdapterDelegate to use for DAP binary fetches * WIP to get debug adapters to use zed directory for installs * Get debugpy automatic download working * Change DapAdapter fetch_or_install to return a Result * Add node_runtime to dap delegate Co-authored-by: Remco Smits <[email protected]> * Create dap_adapter crate & move language dap adapter code to that crate This is the first phase of dap::client refactor to organize debug adapters with zed lsp adapters. Eventually dap::client will have a TransportParams pass to it instead of an adapter, and adapters will handle custom debug events. Co-authored-by: Remco Smits <[email protected]> * Move language specific dap adapter code to their own files * Move DebugAdapter member out of ClientDebugAdapter struct This change was done to make dap::client more in line with zed's lsp::client, it might be reverted depending on if this solution is cleaner or not. * Get php debug adapter to auto download when needed * Get adapter_path argument to work with auto download dap adapters --------- Co-authored-by: Remco Smits <[email protected]>

This fixes a display issue, for javascript expression values.

This also fixes an issue that you could not add your own initialize_args for non custom adapters

* Clean up how adapters install and fetch their binary Before this was in one method, which was hard to read and doing to many things. * Add javascript debug adapter * Get node binary from node_runtime * Undo remove request args for lldb * Remove initialize value for now * Remove default values * Fix did not compile javascript * Fix php did not build

Also simplify the DebugAdapterBInary struct

Before this change the debug panel was still in the running state, which is/was wrong. So updating the status to Ended, will update the UI to an correct state.

* Remove not needed notify * Add loaded sources list * Remove not needed double nested div.child() * Remove not needed block * Fix todo for updating loaded source

cla-bot bot added the cla-signed The user has signed the Contributor License Agreement label Jun 23, 2024

ConradIrwin assigned osiewicz Jun 25, 2024

RemcoSmitsDev force-pushed the debugger branch 2 times, most recently from c71eb06 to 47a5f0c Compare June 29, 2024 14:47

RemcoSmitsDev force-pushed the debugger branch 3 times, most recently from ac95fbd to 515122c Compare July 3, 2024 21:20

RemcoSmitsDev force-pushed the debugger branch 4 times, most recently from 7eacd30 to 3f8581a Compare July 5, 2024 14:54

someone13574 mentioned this pull request Jul 6, 2024

add run, debug and crash, troubleshooting support #13896

Closed

1 task

RemcoSmitsDev force-pushed the debugger branch from 78b3fa1 to 13e5601 Compare July 7, 2024 15:27

RemcoSmitsDev and others added 10 commits July 7, 2024 20:52

Remove unneeded clone

cce5857

Merge with remco-debugger branch

5a9b279

Merge pull request #4 from Anthony-Eid/debugger

33e127d

Clean up debugger Inventory code

WIP start adding support for debugging multiple threads at the same time

648daa3

Start showing all the threads as tabs so you can debug multiple threads at the same time.

Don't spawn task for empty tasks vec

d15ff2d

Remove commented out code

f287c89

Make goto stack trace frame work again after stopped event

49da08f

Remove unused method

5ab95f1

Replace find method with any

f108d4c

Because we don't use the result of the find so any would be better in this case

Remove editor highlights when debugger terminated event was received

4a6f615

RemcoSmitsDev and others added 10 commits October 4, 2024 20:23

Remove unused crates

f9b045b

Add copy memory reference menu item to variable list

c2ed56a

Module list (#46)

8c0a7b1

Implement handle Capabilities event

f76b7c9

Move stack frame list to its own view (#47)

3b545a7

* WIP Move stack frame list to own module * Add missing notify * Remove some more duplicated state for the current stack frame * Clear highlights when stack frame has changed * Fix go to stack frame again

Merge main

984cb68

Merge main

ac0ba07

Make ci pass

00b6fdc

Remove unused dep

eedd865

RemcoSmitsDev force-pushed the debugger branch from a4387d3 to eedd865 Compare October 8, 2024 05:47

RemcoSmitsDev added 2 commits October 8, 2024 23:14

Remove new lines from variable list value

08935b2

This fixes a display issue, for javascript expression values.

Fix correctly install and build php adapter

91926cd

RemcoSmitsDev force-pushed the debugger branch from aa32b4a to 91926cd Compare October 8, 2024 21:46

RemcoSmitsDev added 16 commits October 8, 2024 23:54

Add missing license

5f1de1a

Make start debugging request work again

171c742

This also fixes an issue that you could not add your own initialize_args for non custom adapters

Remove not needed clone

a728f9e

Merge branch 'main' into debugger

8a4f677

Fix wrong symlink for license

554a402

Add support for custom adapters

177ae28

Also simplify the DebugAdapterBInary struct

Flatten custom adapter connection config

b1d24a0

Update dap types to fix invalid value for PresentationHint enums

5bb7f24

Fix missing thread_state status update when client was terminated

222cd4b

Before this change the debug panel was still in the running state, which is/was wrong. So updating the status to Ended, will update the UI to an correct state.

Fix clippy

b46b8aa

Add loaded sources (#49)

5758f66

* Remove not needed notify * Add loaded sources list * Remove not needed double nested div.child() * Remove not needed block * Fix todo for updating loaded source

Merge branch 'main' into debugger

f5dc117

Remove type duplication for debug settings JSON schema

c65ed1c

Fix flicker the variable list less when clicking fast step over control

13afc37

Merge branch 'main' into debugger

3a6f2ad

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Debugger implementation #13433

Debugger implementation #13433

RemcoSmitsDev commented Jun 23, 2024 •

edited

Loading

davidbuzz commented Jun 24, 2024

osiewicz commented Jun 24, 2024

RemcoSmitsDev commented Jun 24, 2024

davidbuzz commented Jul 3, 2024

jonahcui commented Jul 4, 2024

RemcoSmitsDev commented Jul 4, 2024 •

edited

Loading

jonahcui commented Jul 4, 2024

Debugger implementation #13433

Are you sure you want to change the base?

Debugger implementation #13433

Conversation

RemcoSmitsDev commented Jun 23, 2024 • edited Loading

Current Features

davidbuzz commented Jun 24, 2024

osiewicz commented Jun 24, 2024

RemcoSmitsDev commented Jun 24, 2024

davidbuzz commented Jul 3, 2024

jonahcui commented Jul 4, 2024

RemcoSmitsDev commented Jul 4, 2024 • edited Loading

jonahcui commented Jul 4, 2024

RemcoSmitsDev commented Jun 23, 2024 •

edited

Loading

RemcoSmitsDev commented Jul 4, 2024 •

edited

Loading