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,11 +1,15 @@
|
|||
use std::{collections::HashMap, path::PathBuf, sync::OnceLock};
|
||||
|
||||
use anyhow::{Context as _, Result};
|
||||
use anyhow::{Context as _, Result, anyhow};
|
||||
use async_trait::async_trait;
|
||||
use dap::adapters::{DebugTaskDefinition, latest_github_release};
|
||||
use dap::{
|
||||
StartDebuggingRequestArgumentsRequest,
|
||||
adapters::{DebugTaskDefinition, latest_github_release},
|
||||
};
|
||||
use futures::StreamExt;
|
||||
use gpui::AsyncApp;
|
||||
use task::DebugRequest;
|
||||
use serde_json::Value;
|
||||
use task::{DebugRequest, DebugScenario, ZedDebugConfig};
|
||||
use util::fs::remove_matching;
|
||||
|
||||
use crate::*;
|
||||
|
|
@ -18,45 +22,27 @@ pub(crate) struct CodeLldbDebugAdapter {
|
|||
impl CodeLldbDebugAdapter {
|
||||
const ADAPTER_NAME: &'static str = "CodeLLDB";
|
||||
|
||||
fn request_args(&self, config: &DebugTaskDefinition) -> dap::StartDebuggingRequestArguments {
|
||||
let mut configuration = json!({
|
||||
"request": match config.request {
|
||||
DebugRequest::Launch(_) => "launch",
|
||||
DebugRequest::Attach(_) => "attach",
|
||||
},
|
||||
});
|
||||
let map = configuration.as_object_mut().unwrap();
|
||||
fn request_args(
|
||||
&self,
|
||||
task_definition: &DebugTaskDefinition,
|
||||
) -> Result<dap::StartDebuggingRequestArguments> {
|
||||
// CodeLLDB uses `name` for a terminal label.
|
||||
map.insert(
|
||||
"name".into(),
|
||||
Value::String(String::from(config.label.as_ref())),
|
||||
);
|
||||
let request = config.request.to_dap();
|
||||
match &config.request {
|
||||
DebugRequest::Attach(attach) => {
|
||||
map.insert("pid".into(), attach.process_id.into());
|
||||
}
|
||||
DebugRequest::Launch(launch) => {
|
||||
map.insert("program".into(), launch.program.clone().into());
|
||||
let mut configuration = task_definition.config.clone();
|
||||
|
||||
if !launch.args.is_empty() {
|
||||
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) = 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());
|
||||
}
|
||||
}
|
||||
}
|
||||
dap::StartDebuggingRequestArguments {
|
||||
configuration
|
||||
.as_object_mut()
|
||||
.context("CodeLLDB is not a valid json object")?
|
||||
.insert(
|
||||
"name".into(),
|
||||
Value::String(String::from(task_definition.label.as_ref())),
|
||||
);
|
||||
|
||||
let request = self.validate_config(&configuration)?;
|
||||
|
||||
Ok(dap::StartDebuggingRequestArguments {
|
||||
request,
|
||||
configuration,
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
async fn fetch_latest_adapter_version(
|
||||
|
|
@ -103,6 +89,286 @@ impl DebugAdapter for CodeLldbDebugAdapter {
|
|||
DebugAdapterName(Self::ADAPTER_NAME.into())
|
||||
}
|
||||
|
||||
fn validate_config(
|
||||
&self,
|
||||
config: &serde_json::Value,
|
||||
) -> Result<StartDebuggingRequestArgumentsRequest> {
|
||||
let map = config
|
||||
.as_object()
|
||||
.ok_or_else(|| anyhow!("Config isn't an object"))?;
|
||||
|
||||
let request_variant = map
|
||||
.get("request")
|
||||
.and_then(|r| r.as_str())
|
||||
.ok_or_else(|| anyhow!("request field is required and must be a string"))?;
|
||||
|
||||
match request_variant {
|
||||
"launch" => {
|
||||
// For launch, verify that one of the required configs exists
|
||||
if !(map.contains_key("program")
|
||||
|| map.contains_key("targetCreateCommands")
|
||||
|| map.contains_key("cargo"))
|
||||
{
|
||||
return Err(anyhow!(
|
||||
"launch request requires either 'program', 'targetCreateCommands', or 'cargo' field"
|
||||
));
|
||||
}
|
||||
Ok(StartDebuggingRequestArgumentsRequest::Launch)
|
||||
}
|
||||
"attach" => {
|
||||
// For attach, verify that either pid or program exists
|
||||
if !(map.contains_key("pid") || map.contains_key("program")) {
|
||||
return Err(anyhow!(
|
||||
"attach request requires either 'pid' or 'program' field"
|
||||
));
|
||||
}
|
||||
Ok(StartDebuggingRequestArgumentsRequest::Attach)
|
||||
}
|
||||
_ => Err(anyhow!(
|
||||
"request must be either 'launch' or 'attach', got '{}'",
|
||||
request_variant
|
||||
)),
|
||||
}
|
||||
}
|
||||
|
||||
fn config_from_zed_format(&self, zed_scenario: ZedDebugConfig) -> Result<DebugScenario> {
|
||||
let mut configuration = json!({
|
||||
"request": match zed_scenario.request {
|
||||
DebugRequest::Launch(_) => "launch",
|
||||
DebugRequest::Attach(_) => "attach",
|
||||
},
|
||||
});
|
||||
let map = configuration.as_object_mut().unwrap();
|
||||
// CodeLLDB uses `name` for a terminal label.
|
||||
map.insert(
|
||||
"name".into(),
|
||||
Value::String(String::from(zed_scenario.label.as_ref())),
|
||||
);
|
||||
match &zed_scenario.request {
|
||||
DebugRequest::Attach(attach) => {
|
||||
map.insert("pid".into(), attach.process_id.into());
|
||||
}
|
||||
DebugRequest::Launch(launch) => {
|
||||
map.insert("program".into(), launch.program.clone().into());
|
||||
|
||||
if !launch.args.is_empty() {
|
||||
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: configuration,
|
||||
build: None,
|
||||
tcp_connection: None,
|
||||
})
|
||||
}
|
||||
|
||||
fn dap_schema(&self) -> serde_json::Value {
|
||||
json!({
|
||||
"properties": {
|
||||
"request": {
|
||||
"type": "string",
|
||||
"enum": ["attach", "launch"],
|
||||
"description": "Debug adapter request type"
|
||||
},
|
||||
"program": {
|
||||
"type": "string",
|
||||
"description": "Path to the program to debug or attach to"
|
||||
},
|
||||
"args": {
|
||||
"type": ["array", "string"],
|
||||
"description": "Program arguments"
|
||||
},
|
||||
"cwd": {
|
||||
"type": "string",
|
||||
"description": "Program working directory"
|
||||
},
|
||||
"env": {
|
||||
"type": "object",
|
||||
"description": "Additional environment variables",
|
||||
"patternProperties": {
|
||||
".*": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"envFile": {
|
||||
"type": "string",
|
||||
"description": "File to read the environment variables from"
|
||||
},
|
||||
"stdio": {
|
||||
"type": ["null", "string", "array", "object"],
|
||||
"description": "Destination for stdio streams: null = send to debugger console or a terminal, \"<path>\" = attach to a file/tty/fifo"
|
||||
},
|
||||
"terminal": {
|
||||
"type": "string",
|
||||
"enum": ["integrated", "console"],
|
||||
"description": "Terminal type to use",
|
||||
"default": "integrated"
|
||||
},
|
||||
"console": {
|
||||
"type": "string",
|
||||
"enum": ["integratedTerminal", "internalConsole"],
|
||||
"description": "Terminal type to use (compatibility alias of 'terminal')"
|
||||
},
|
||||
"stopOnEntry": {
|
||||
"type": "boolean",
|
||||
"description": "Automatically stop debuggee after launch",
|
||||
"default": false
|
||||
},
|
||||
"initCommands": {
|
||||
"type": "array",
|
||||
"description": "Initialization commands executed upon debugger startup",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"targetCreateCommands": {
|
||||
"type": "array",
|
||||
"description": "Commands that create the debug target",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"preRunCommands": {
|
||||
"type": "array",
|
||||
"description": "Commands executed just before the program is launched",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"processCreateCommands": {
|
||||
"type": "array",
|
||||
"description": "Commands that create the debuggee process",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"postRunCommands": {
|
||||
"type": "array",
|
||||
"description": "Commands executed just after the program has been launched",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"preTerminateCommands": {
|
||||
"type": "array",
|
||||
"description": "Commands executed just before the debuggee is terminated or disconnected from",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"exitCommands": {
|
||||
"type": "array",
|
||||
"description": "Commands executed at the end of debugging session",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"expressions": {
|
||||
"type": "string",
|
||||
"enum": ["simple", "python", "native"],
|
||||
"description": "The default evaluator type used for expressions"
|
||||
},
|
||||
"sourceMap": {
|
||||
"type": "object",
|
||||
"description": "Source path remapping between the build machine and the local machine",
|
||||
"patternProperties": {
|
||||
".*": {
|
||||
"type": ["string", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"relativePathBase": {
|
||||
"type": "string",
|
||||
"description": "Base directory used for resolution of relative source paths. Defaults to the workspace folder"
|
||||
},
|
||||
"sourceLanguages": {
|
||||
"type": "array",
|
||||
"description": "A list of source languages to enable language-specific features for",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"reverseDebugging": {
|
||||
"type": "boolean",
|
||||
"description": "Enable reverse debugging",
|
||||
"default": false
|
||||
},
|
||||
"breakpointMode": {
|
||||
"type": "string",
|
||||
"enum": ["path", "file"],
|
||||
"description": "Specifies how source breakpoints should be set"
|
||||
},
|
||||
"pid": {
|
||||
"type": ["integer", "string"],
|
||||
"description": "Process id to attach to"
|
||||
},
|
||||
"waitFor": {
|
||||
"type": "boolean",
|
||||
"description": "Wait for the process to launch (MacOS only)",
|
||||
"default": false
|
||||
}
|
||||
},
|
||||
"required": ["request"],
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"properties": {
|
||||
"request": {
|
||||
"enum": ["launch"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"oneOf": [
|
||||
{
|
||||
"required": ["program"]
|
||||
},
|
||||
{
|
||||
"required": ["targetCreateCommands"]
|
||||
},
|
||||
{
|
||||
"required": ["cargo"]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"properties": {
|
||||
"request": {
|
||||
"enum": ["attach"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"oneOf": [
|
||||
{
|
||||
"required": ["pid"]
|
||||
},
|
||||
{
|
||||
"required": ["program"]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
async fn get_binary(
|
||||
&self,
|
||||
delegate: &Arc<dyn DapDelegate>,
|
||||
|
|
@ -175,7 +441,7 @@ impl DebugAdapter for CodeLldbDebugAdapter {
|
|||
"--settings".into(),
|
||||
json!({"sourceLanguages": ["cpp", "rust"]}).to_string(),
|
||||
],
|
||||
request_args: self.request_args(config),
|
||||
request_args: self.request_args(&config)?,
|
||||
envs: HashMap::default(),
|
||||
connection: None,
|
||||
})
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue