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,5 +1,9 @@
|
|||
use anyhow::Context as _;
|
||||
use dap::{StartDebuggingRequestArguments, adapters::DebugTaskDefinition};
|
||||
use anyhow::{Context as _, anyhow};
|
||||
use dap::{
|
||||
StartDebuggingRequestArguments, StartDebuggingRequestArgumentsRequest,
|
||||
adapters::DebugTaskDefinition,
|
||||
};
|
||||
|
||||
use gpui::{AsyncApp, SharedString};
|
||||
use language::LanguageName;
|
||||
use std::{collections::HashMap, ffi::OsStr, path::PathBuf};
|
||||
|
|
@ -11,8 +15,291 @@ pub(crate) struct GoDebugAdapter;
|
|||
|
||||
impl GoDebugAdapter {
|
||||
const ADAPTER_NAME: &'static str = "Delve";
|
||||
fn request_args(&self, config: &DebugTaskDefinition) -> StartDebuggingRequestArguments {
|
||||
let mut args = match &config.request {
|
||||
}
|
||||
|
||||
#[async_trait(?Send)]
|
||||
impl DebugAdapter for GoDebugAdapter {
|
||||
fn name(&self) -> DebugAdapterName {
|
||||
DebugAdapterName(Self::ADAPTER_NAME.into())
|
||||
}
|
||||
|
||||
fn adapter_language_name(&self) -> Option<LanguageName> {
|
||||
Some(SharedString::new_static("Go").into())
|
||||
}
|
||||
|
||||
fn dap_schema(&self) -> serde_json::Value {
|
||||
// Create common properties shared between launch and attach
|
||||
let common_properties = json!({
|
||||
"debugAdapter": {
|
||||
"enum": ["legacy", "dlv-dap"],
|
||||
"description": "Select which debug adapter to use with this configuration.",
|
||||
"default": "dlv-dap"
|
||||
},
|
||||
"stopOnEntry": {
|
||||
"type": "boolean",
|
||||
"description": "Automatically stop program after launch or attach.",
|
||||
"default": false
|
||||
},
|
||||
"showLog": {
|
||||
"type": "boolean",
|
||||
"description": "Show log output from the delve debugger. Maps to dlv's `--log` flag.",
|
||||
"default": false
|
||||
},
|
||||
"cwd": {
|
||||
"type": "string",
|
||||
"description": "Workspace relative or absolute path to the working directory of the program being debugged.",
|
||||
"default": "${ZED_WORKTREE_ROOT}"
|
||||
},
|
||||
"dlvFlags": {
|
||||
"type": "array",
|
||||
"description": "Extra flags for `dlv`. See `dlv help` for the full list of supported flags.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"default": []
|
||||
},
|
||||
"port": {
|
||||
"type": "number",
|
||||
"description": "Debug server port. For remote configurations, this is where to connect.",
|
||||
"default": 2345
|
||||
},
|
||||
"host": {
|
||||
"type": "string",
|
||||
"description": "Debug server host. For remote configurations, this is where to connect.",
|
||||
"default": "127.0.0.1"
|
||||
},
|
||||
"substitutePath": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "The absolute local path to be replaced."
|
||||
},
|
||||
"to": {
|
||||
"type": "string",
|
||||
"description": "The absolute remote path to replace with."
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "Mappings from local to remote paths for debugging.",
|
||||
"default": []
|
||||
},
|
||||
"trace": {
|
||||
"type": "string",
|
||||
"enum": ["verbose", "trace", "log", "info", "warn", "error"],
|
||||
"default": "error",
|
||||
"description": "Debug logging level."
|
||||
},
|
||||
"backend": {
|
||||
"type": "string",
|
||||
"enum": ["default", "native", "lldb", "rr"],
|
||||
"description": "Backend used by delve. Maps to `dlv`'s `--backend` flag."
|
||||
},
|
||||
"logOutput": {
|
||||
"type": "string",
|
||||
"enum": ["debugger", "gdbwire", "lldbout", "debuglineerr", "rpc", "dap"],
|
||||
"description": "Components that should produce debug output.",
|
||||
"default": "debugger"
|
||||
},
|
||||
"logDest": {
|
||||
"type": "string",
|
||||
"description": "Log destination for delve."
|
||||
},
|
||||
"stackTraceDepth": {
|
||||
"type": "number",
|
||||
"description": "Maximum depth of stack traces.",
|
||||
"default": 50
|
||||
},
|
||||
"showGlobalVariables": {
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "Show global package variables in variables pane."
|
||||
},
|
||||
"showRegisters": {
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "Show register variables in variables pane."
|
||||
},
|
||||
"hideSystemGoroutines": {
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "Hide system goroutines from call stack view."
|
||||
},
|
||||
"console": {
|
||||
"default": "internalConsole",
|
||||
"description": "Where to launch the debugger.",
|
||||
"enum": ["internalConsole", "integratedTerminal"]
|
||||
},
|
||||
"asRoot": {
|
||||
"default": false,
|
||||
"description": "Debug with elevated permissions (on Unix).",
|
||||
"type": "boolean"
|
||||
}
|
||||
});
|
||||
|
||||
// Create launch-specific properties
|
||||
let launch_properties = json!({
|
||||
"program": {
|
||||
"type": "string",
|
||||
"description": "Path to the program folder or file to debug.",
|
||||
"default": "${ZED_WORKTREE_ROOT}"
|
||||
},
|
||||
"args": {
|
||||
"type": ["array", "string"],
|
||||
"description": "Command line arguments for the program.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"default": []
|
||||
},
|
||||
"env": {
|
||||
"type": "object",
|
||||
"description": "Environment variables for the debugged program.",
|
||||
"default": {}
|
||||
},
|
||||
"envFile": {
|
||||
"type": ["string", "array"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Path(s) to files with environment variables.",
|
||||
"default": ""
|
||||
},
|
||||
"buildFlags": {
|
||||
"type": ["string", "array"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Flags for the Go compiler.",
|
||||
"default": []
|
||||
},
|
||||
"output": {
|
||||
"type": "string",
|
||||
"description": "Output path for the binary.",
|
||||
"default": "debug"
|
||||
},
|
||||
"mode": {
|
||||
"enum": [ "debug", "test", "exec", "replay", "core"],
|
||||
"description": "Debug mode for launch configuration.",
|
||||
},
|
||||
"traceDirPath": {
|
||||
"type": "string",
|
||||
"description": "Directory for record trace (for 'replay' mode).",
|
||||
"default": ""
|
||||
},
|
||||
"coreFilePath": {
|
||||
"type": "string",
|
||||
"description": "Path to core dump file (for 'core' mode).",
|
||||
"default": ""
|
||||
}
|
||||
});
|
||||
|
||||
// Create attach-specific properties
|
||||
let attach_properties = json!({
|
||||
"processId": {
|
||||
"anyOf": [
|
||||
{
|
||||
"enum": ["${command:pickProcess}", "${command:pickGoProcess}"],
|
||||
"description": "Use process picker to select a process."
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "Process name to attach to."
|
||||
},
|
||||
{
|
||||
"type": "number",
|
||||
"description": "Process ID to attach to."
|
||||
}
|
||||
],
|
||||
"default": 0
|
||||
},
|
||||
"mode": {
|
||||
"enum": ["local", "remote"],
|
||||
"description": "Local or remote debugging.",
|
||||
"default": "local"
|
||||
},
|
||||
"remotePath": {
|
||||
"type": "string",
|
||||
"description": "Path to source on remote machine.",
|
||||
"markdownDeprecationMessage": "Use `substitutePath` instead.",
|
||||
"default": ""
|
||||
}
|
||||
});
|
||||
|
||||
// Create the final schema
|
||||
json!({
|
||||
"oneOf": [
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"required": ["request"],
|
||||
"properties": {
|
||||
"request": {
|
||||
"type": "string",
|
||||
"enum": ["launch"],
|
||||
"description": "Request to launch a new process"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": common_properties
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"required": ["program", "mode"],
|
||||
"properties": launch_properties
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"allOf": [
|
||||
{
|
||||
"type": "object",
|
||||
"required": ["request"],
|
||||
"properties": {
|
||||
"request": {
|
||||
"type": "string",
|
||||
"enum": ["attach"],
|
||||
"description": "Request to attach to an existing process"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": common_properties
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"required": ["processId", "mode"],
|
||||
"properties": attach_properties
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
})
|
||||
}
|
||||
|
||||
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 config_from_zed_format(&self, zed_scenario: ZedDebugConfig) -> Result<DebugScenario> {
|
||||
let mut args = match &zed_scenario.request {
|
||||
dap::DebugRequest::Attach(attach_config) => {
|
||||
json!({
|
||||
"processId": attach_config.process_id,
|
||||
|
|
@ -28,31 +315,23 @@ impl GoDebugAdapter {
|
|||
|
||||
let map = args.as_object_mut().unwrap();
|
||||
|
||||
if let Some(stop_on_entry) = config.stop_on_entry {
|
||||
if let Some(stop_on_entry) = zed_scenario.stop_on_entry {
|
||||
map.insert("stopOnEntry".into(), stop_on_entry.into());
|
||||
}
|
||||
|
||||
StartDebuggingRequestArguments {
|
||||
configuration: args,
|
||||
request: config.request.to_dap(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait(?Send)]
|
||||
impl DebugAdapter for GoDebugAdapter {
|
||||
fn name(&self) -> DebugAdapterName {
|
||||
DebugAdapterName(Self::ADAPTER_NAME.into())
|
||||
}
|
||||
|
||||
fn adapter_language_name(&self) -> Option<LanguageName> {
|
||||
Some(SharedString::new_static("Go").into())
|
||||
Ok(DebugScenario {
|
||||
adapter: zed_scenario.adapter,
|
||||
label: zed_scenario.label,
|
||||
build: None,
|
||||
config: args,
|
||||
tcp_connection: None,
|
||||
})
|
||||
}
|
||||
|
||||
async fn get_binary(
|
||||
&self,
|
||||
delegate: &Arc<dyn DapDelegate>,
|
||||
config: &DebugTaskDefinition,
|
||||
task_definition: &DebugTaskDefinition,
|
||||
_user_installed_path: Option<PathBuf>,
|
||||
_cx: &mut AsyncApp,
|
||||
) -> Result<DebugAdapterBinary> {
|
||||
|
|
@ -62,7 +341,7 @@ impl DebugAdapter for GoDebugAdapter {
|
|||
.and_then(|p| p.to_str().map(|p| p.to_string()))
|
||||
.context("Dlv not found in path")?;
|
||||
|
||||
let tcp_connection = config.tcp_connection.clone().unwrap_or_default();
|
||||
let tcp_connection = task_definition.tcp_connection.clone().unwrap_or_default();
|
||||
let (host, port, timeout) = crate::configure_tcp_connection(tcp_connection).await?;
|
||||
|
||||
Ok(DebugAdapterBinary {
|
||||
|
|
@ -75,7 +354,10 @@ impl DebugAdapter for GoDebugAdapter {
|
|||
port,
|
||||
timeout,
|
||||
}),
|
||||
request_args: self.request_args(config),
|
||||
request_args: StartDebuggingRequestArguments {
|
||||
configuration: task_definition.config.clone(),
|
||||
request: self.validate_config(&task_definition.config)?,
|
||||
},
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue