debugger: Use DAP schema to configure daps (#30833)
This PR allows DAPs to define their own schema so users can see completion items when editing their debug.json files. Users facing this aren’t the biggest chance, but behind the scenes, this affected a lot of code because we manually translated common fields from Zed's config format to be adapter-specific. Now we store the raw JSON from a user's configuration file and just send that. I'm ignoring the Protobuf CICD error because the DebugTaskDefinition message is not yet user facing and we need to deprecate some fields in it. Release Notes: - debugger beta: Show completion items when editing debug.json - debugger beta: Breaking change, debug.json schema now relays on what DAP you have selected instead of always having the same based values. --------- Co-authored-by: Remco Smits <djsmits12@gmail.com> Co-authored-by: Cole Miller <m@cole-miller.net> Co-authored-by: Cole Miller <cole@zed.dev>
This commit is contained in:
Anthony Eid
GitHub
parent
0d7f4842f3
commit
1c9b818342
43 changed files with 2357 additions and 740 deletions
|
|
@ -1,6 +1,9 @@
|
|||
use crate::*;
|
||||
use anyhow::Context as _;
|
||||
use dap::{DebugRequest, StartDebuggingRequestArguments, adapters::DebugTaskDefinition};
|
||||
use anyhow::{Context as _, anyhow};
|
||||
use dap::{
|
||||
DebugRequest, StartDebuggingRequestArguments, StartDebuggingRequestArgumentsRequest,
|
||||
adapters::DebugTaskDefinition,
|
||||
};
|
||||
use gpui::{AsyncApp, SharedString};
|
||||
use language::LanguageName;
|
||||
use std::{collections::HashMap, ffi::OsStr, path::PathBuf, sync::OnceLock};
|
||||
|
|
@ -17,39 +20,16 @@ impl PythonDebugAdapter {
|
|||
const ADAPTER_PATH: &'static str = "src/debugpy/adapter";
|
||||
const LANGUAGE_NAME: &'static str = "Python";
|
||||
|
||||
fn request_args(&self, config: &DebugTaskDefinition) -> StartDebuggingRequestArguments {
|
||||
let mut args = json!({
|
||||
"request": match config.request {
|
||||
DebugRequest::Launch(_) => "launch",
|
||||
DebugRequest::Attach(_) => "attach",
|
||||
},
|
||||
"subProcess": true,
|
||||
"redirectOutput": true,
|
||||
});
|
||||
let map = args.as_object_mut().unwrap();
|
||||
match &config.request {
|
||||
DebugRequest::Attach(attach) => {
|
||||
map.insert("processId".into(), attach.process_id.into());
|
||||
}
|
||||
DebugRequest::Launch(launch) => {
|
||||
map.insert("program".into(), launch.program.clone().into());
|
||||
map.insert("args".into(), launch.args.clone().into());
|
||||
if !launch.env.is_empty() {
|
||||
map.insert("env".into(), launch.env_json());
|
||||
}
|
||||
fn request_args(
|
||||
&self,
|
||||
task_definition: &DebugTaskDefinition,
|
||||
) -> Result<StartDebuggingRequestArguments> {
|
||||
let request = self.validate_config(&task_definition.config)?;
|
||||
|
||||
if let Some(stop_on_entry) = config.stop_on_entry {
|
||||
map.insert("stopOnEntry".into(), stop_on_entry.into());
|
||||
}
|
||||
if let Some(cwd) = launch.cwd.as_ref() {
|
||||
map.insert("cwd".into(), cwd.to_string_lossy().into_owned().into());
|
||||
}
|
||||
}
|
||||
}
|
||||
StartDebuggingRequestArguments {
|
||||
configuration: args,
|
||||
request: config.request.to_dap(),
|
||||
}
|
||||
Ok(StartDebuggingRequestArguments {
|
||||
configuration: task_definition.config.clone(),
|
||||
request,
|
||||
})
|
||||
}
|
||||
async fn fetch_latest_adapter_version(
|
||||
&self,
|
||||
|
|
@ -160,7 +140,7 @@ impl PythonDebugAdapter {
|
|||
}),
|
||||
cwd: None,
|
||||
envs: HashMap::default(),
|
||||
request_args: self.request_args(config),
|
||||
request_args: self.request_args(config)?,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
@ -175,6 +155,394 @@ impl DebugAdapter for PythonDebugAdapter {
|
|||
Some(SharedString::new_static("Python").into())
|
||||
}
|
||||
|
||||
fn config_from_zed_format(&self, zed_scenario: ZedDebugConfig) -> Result<DebugScenario> {
|
||||
let mut args = json!({
|
||||
"request": match zed_scenario.request {
|
||||
DebugRequest::Launch(_) => "launch",
|
||||
DebugRequest::Attach(_) => "attach",
|
||||
},
|
||||
"subProcess": true,
|
||||
"redirectOutput": true,
|
||||
});
|
||||
|
||||
let map = args.as_object_mut().unwrap();
|
||||
match &zed_scenario.request {
|
||||
DebugRequest::Attach(attach) => {
|
||||
map.insert("processId".into(), attach.process_id.into());
|
||||
}
|
||||
DebugRequest::Launch(launch) => {
|
||||
map.insert("program".into(), launch.program.clone().into());
|
||||
map.insert("args".into(), launch.args.clone().into());
|
||||
if !launch.env.is_empty() {
|
||||
map.insert("env".into(), launch.env_json());
|
||||
}
|
||||
|
||||
if let Some(stop_on_entry) = zed_scenario.stop_on_entry {
|
||||
map.insert("stopOnEntry".into(), stop_on_entry.into());
|
||||
}
|
||||
if let Some(cwd) = launch.cwd.as_ref() {
|
||||
map.insert("cwd".into(), cwd.to_string_lossy().into_owned().into());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Ok(DebugScenario {
|
||||
adapter: zed_scenario.adapter,
|
||||
label: zed_scenario.label,
|
||||
config: args,
|
||||
build: None,
|
||||
tcp_connection: None,
|
||||
})
|
||||
}
|
||||
|
||||
fn validate_config(
|
||||
&self,
|
||||
config: &serde_json::Value,
|
||||
) -> Result<StartDebuggingRequestArgumentsRequest> {
|
||||
let map = config.as_object().context("Config isn't an object")?;
|
||||
|
||||
let request_variant = map["request"].as_str().context("request is not valid")?;
|
||||
|
||||
match request_variant {
|
||||
"launch" => Ok(StartDebuggingRequestArgumentsRequest::Launch),
|
||||
"attach" => Ok(StartDebuggingRequestArgumentsRequest::Attach),
|
||||
_ => Err(anyhow!("request must be either 'launch' or 'attach'")),
|
||||
}
|
||||
}
|
||||
|
||||
fn dap_schema(&self) -> serde_json::Value {
|
||||
json!({
|
||||
"properties": {
|
||||
"request": {
|
||||
"type": "string",
|
||||
"enum": ["attach", "launch"],
|
||||
"description": "Debug adapter request type"
|
||||
},
|
||||
"autoReload": {
|
||||
"default": {},
|
||||
"description": "Configures automatic reload of code on edit.",
|
||||
"properties": {
|
||||
"enable": {
|
||||
"default": false,
|
||||
"description": "Automatically reload code on edit.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"exclude": {
|
||||
"default": [
|
||||
"**/.git/**",
|
||||
"**/.metadata/**",
|
||||
"**/__pycache__/**",
|
||||
"**/node_modules/**",
|
||||
"**/site-packages/**"
|
||||
],
|
||||
"description": "Glob patterns of paths to exclude from auto reload.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"include": {
|
||||
"default": [
|
||||
"**/*.py",
|
||||
"**/*.pyw"
|
||||
],
|
||||
"description": "Glob patterns of paths to include in auto reload.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"debugAdapterPath": {
|
||||
"description": "Path (fully qualified) to the python debug adapter executable.",
|
||||
"type": "string"
|
||||
},
|
||||
"django": {
|
||||
"default": false,
|
||||
"description": "Django debugging.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"jinja": {
|
||||
"default": null,
|
||||
"description": "Jinja template debugging (e.g. Flask).",
|
||||
"enum": [
|
||||
false,
|
||||
null,
|
||||
true
|
||||
]
|
||||
},
|
||||
"justMyCode": {
|
||||
"default": true,
|
||||
"description": "If true, show and debug only user-written code. If false, show and debug all code, including library calls.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"logToFile": {
|
||||
"default": false,
|
||||
"description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"pathMappings": {
|
||||
"default": [],
|
||||
"items": {
|
||||
"label": "Path mapping",
|
||||
"properties": {
|
||||
"localRoot": {
|
||||
"default": "${ZED_WORKTREE_ROOT}",
|
||||
"label": "Local source root.",
|
||||
"type": "string"
|
||||
},
|
||||
"remoteRoot": {
|
||||
"default": "",
|
||||
"label": "Remote source root.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"localRoot",
|
||||
"remoteRoot"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"label": "Path mappings.",
|
||||
"type": "array"
|
||||
},
|
||||
"redirectOutput": {
|
||||
"default": true,
|
||||
"description": "Redirect output.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"showReturnValue": {
|
||||
"default": true,
|
||||
"description": "Show return value of functions when stepping.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"subProcess": {
|
||||
"default": false,
|
||||
"description": "Whether to enable Sub Process debugging",
|
||||
"type": "boolean"
|
||||
},
|
||||
"consoleName": {
|
||||
"default": "Python Debug Console",
|
||||
"description": "Display name of the debug console or terminal",
|
||||
"type": "string"
|
||||
},
|
||||
"clientOS": {
|
||||
"default": null,
|
||||
"description": "OS that VS code is using.",
|
||||
"enum": [
|
||||
"windows",
|
||||
null,
|
||||
"unix"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": ["request"],
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"properties": {
|
||||
"request": {
|
||||
"enum": ["attach"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"properties": {
|
||||
"connect": {
|
||||
"label": "Attach by connecting to debugpy over a socket.",
|
||||
"properties": {
|
||||
"host": {
|
||||
"default": "127.0.0.1",
|
||||
"description": "Hostname or IP address to connect to.",
|
||||
"type": "string"
|
||||
},
|
||||
"port": {
|
||||
"description": "Port to connect to.",
|
||||
"type": [
|
||||
"number",
|
||||
"string"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"port"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"listen": {
|
||||
"label": "Attach by listening for incoming socket connection from debugpy",
|
||||
"properties": {
|
||||
"host": {
|
||||
"default": "127.0.0.1",
|
||||
"description": "Hostname or IP address of the interface to listen on.",
|
||||
"type": "string"
|
||||
},
|
||||
"port": {
|
||||
"description": "Port to listen on.",
|
||||
"type": [
|
||||
"number",
|
||||
"string"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"port"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"processId": {
|
||||
"anyOf": [
|
||||
{
|
||||
"default": "${command:pickProcess}",
|
||||
"description": "Use process picker to select a process to attach, or Process ID as integer.",
|
||||
"enum": [
|
||||
"${command:pickProcess}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"description": "ID of the local process to attach to.",
|
||||
"type": "integer"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"properties": {
|
||||
"request": {
|
||||
"enum": ["launch"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"properties": {
|
||||
"args": {
|
||||
"default": [],
|
||||
"description": "Command line arguments passed to the program. For string type arguments, it will pass through the shell as is, and therefore all shell variable expansions will apply. But for the array type, the values will be shell-escaped.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"anyOf": [
|
||||
{
|
||||
"default": "${command:pickArgs}",
|
||||
"enum": [
|
||||
"${command:pickArgs}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": [
|
||||
"array",
|
||||
"string"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"console": {
|
||||
"default": "integratedTerminal",
|
||||
"description": "Where to launch the debug target: internal console, integrated terminal, or external terminal.",
|
||||
"enum": [
|
||||
"externalTerminal",
|
||||
"integratedTerminal",
|
||||
"internalConsole"
|
||||
]
|
||||
},
|
||||
"cwd": {
|
||||
"default": "${ZED_WORKTREE_ROOT}",
|
||||
"description": "Absolute path to the working directory of the program being debugged. Default is the root directory of the file (leave empty).",
|
||||
"type": "string"
|
||||
},
|
||||
"autoStartBrowser": {
|
||||
"default": false,
|
||||
"description": "Open external browser to launch the application",
|
||||
"type": "boolean"
|
||||
},
|
||||
"env": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"default": {},
|
||||
"description": "Environment variables defined as a key value pair. Property ends up being the Environment Variable and the value of the property ends up being the value of the Env Variable.",
|
||||
"type": "object"
|
||||
},
|
||||
"envFile": {
|
||||
"default": "${ZED_WORKTREE_ROOT}/.env",
|
||||
"description": "Absolute path to a file containing environment variable definitions.",
|
||||
"type": "string"
|
||||
},
|
||||
"gevent": {
|
||||
"default": false,
|
||||
"description": "Enable debugging of gevent monkey-patched code.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"module": {
|
||||
"default": "",
|
||||
"description": "Name of the module to be debugged.",
|
||||
"type": "string"
|
||||
},
|
||||
"program": {
|
||||
"default": "${ZED_FILE}",
|
||||
"description": "Absolute path to the program.",
|
||||
"type": "string"
|
||||
},
|
||||
"purpose": {
|
||||
"default": [],
|
||||
"description": "Tells extension to use this configuration for test debugging, or when using debug-in-terminal command.",
|
||||
"items": {
|
||||
"enum": [
|
||||
"debug-test",
|
||||
"debug-in-terminal"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Use this configuration while debugging tests using test view or test debug commands.",
|
||||
"Use this configuration while debugging a file using debug in terminal button in the editor."
|
||||
]
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"pyramid": {
|
||||
"default": false,
|
||||
"description": "Whether debugging Pyramid applications.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"python": {
|
||||
"default": "${command:python.interpreterPath}",
|
||||
"description": "Absolute path to the Python interpreter executable; overrides workspace configuration if set.",
|
||||
"type": "string"
|
||||
},
|
||||
"pythonArgs": {
|
||||
"default": [],
|
||||
"description": "Command-line arguments passed to the Python interpreter. To pass arguments to the debug target, use \"args\".",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"stopOnEntry": {
|
||||
"default": false,
|
||||
"description": "Automatically stop after launch.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"sudo": {
|
||||
"default": false,
|
||||
"description": "Running debug program under elevated permissions (on Unix).",
|
||||
"type": "boolean"
|
||||
},
|
||||
"guiEventLoop": {
|
||||
"default": "matplotlib",
|
||||
"description": "The GUI event loop that's going to run. Possible values: \"matplotlib\", \"wx\", \"qt\", \"none\", or a custom function that'll be imported and run.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
async fn get_binary(
|
||||
&self,
|
||||
delegate: &Arc<dyn DapDelegate>,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue