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,7 @@
|
|||
use adapters::latest_github_release;
|
||||
use anyhow::Context as _;
|
||||
use anyhow::bail;
|
||||
use dap::StartDebuggingRequestArguments;
|
||||
use dap::adapters::{DebugTaskDefinition, TcpArguments};
|
||||
use gpui::{AsyncApp, SharedString};
|
||||
use language::LanguageName;
|
||||
|
|
@ -18,27 +20,6 @@ impl PhpDebugAdapter {
|
|||
const ADAPTER_PACKAGE_NAME: &'static str = "vscode-php-debug";
|
||||
const ADAPTER_PATH: &'static str = "extension/out/phpDebug.js";
|
||||
|
||||
fn request_args(
|
||||
&self,
|
||||
config: &DebugTaskDefinition,
|
||||
) -> Result<dap::StartDebuggingRequestArguments> {
|
||||
match &config.request {
|
||||
dap::DebugRequest::Attach(_) => {
|
||||
anyhow::bail!("php adapter does not support attaching")
|
||||
}
|
||||
dap::DebugRequest::Launch(launch_config) => Ok(dap::StartDebuggingRequestArguments {
|
||||
configuration: json!({
|
||||
"program": launch_config.program,
|
||||
"cwd": launch_config.cwd,
|
||||
"args": launch_config.args,
|
||||
"env": launch_config.env_json(),
|
||||
"stopOnEntry": config.stop_on_entry.unwrap_or_default(),
|
||||
}),
|
||||
request: config.request.to_dap(),
|
||||
}),
|
||||
}
|
||||
}
|
||||
|
||||
async fn fetch_latest_adapter_version(
|
||||
&self,
|
||||
delegate: &Arc<dyn DapDelegate>,
|
||||
|
|
@ -68,7 +49,7 @@ impl PhpDebugAdapter {
|
|||
async fn get_installed_binary(
|
||||
&self,
|
||||
delegate: &Arc<dyn DapDelegate>,
|
||||
config: &DebugTaskDefinition,
|
||||
task_definition: &DebugTaskDefinition,
|
||||
user_installed_path: Option<PathBuf>,
|
||||
_: &mut AsyncApp,
|
||||
) -> Result<DebugAdapterBinary> {
|
||||
|
|
@ -86,7 +67,7 @@ impl PhpDebugAdapter {
|
|||
.context("Couldn't find PHP dap directory")?
|
||||
};
|
||||
|
||||
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 {
|
||||
|
|
@ -110,13 +91,202 @@ impl PhpDebugAdapter {
|
|||
}),
|
||||
cwd: None,
|
||||
envs: HashMap::default(),
|
||||
request_args: self.request_args(config)?,
|
||||
request_args: StartDebuggingRequestArguments {
|
||||
configuration: task_definition.config.clone(),
|
||||
request: dap::StartDebuggingRequestArgumentsRequest::Launch,
|
||||
},
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait(?Send)]
|
||||
impl DebugAdapter for PhpDebugAdapter {
|
||||
fn dap_schema(&self) -> serde_json::Value {
|
||||
json!({
|
||||
"properties": {
|
||||
"request": {
|
||||
"type": "string",
|
||||
"enum": ["launch"],
|
||||
"description": "The request type for the PHP debug adapter, always \"launch\"",
|
||||
"default": "launch"
|
||||
},
|
||||
"hostname": {
|
||||
"type": "string",
|
||||
"description": "The address to bind to when listening for Xdebug (default: all IPv6 connections if available, else all IPv4 connections) or Unix Domain socket (prefix with unix://) or Windows Pipe (\\\\?\\pipe\\name) - cannot be combined with port"
|
||||
},
|
||||
"port": {
|
||||
"type": "integer",
|
||||
"description": "The port on which to listen for Xdebug (default: 9003). If port is set to 0 a random port is chosen by the system and a placeholder ${port} is replaced with the chosen port in env and runtimeArgs.",
|
||||
"default": 9003
|
||||
},
|
||||
"program": {
|
||||
"type": "string",
|
||||
"description": "The PHP script to debug (typically a path to a file)",
|
||||
"default": "${file}"
|
||||
},
|
||||
"cwd": {
|
||||
"type": "string",
|
||||
"description": "Working directory for the debugged program"
|
||||
},
|
||||
"args": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Command line arguments to pass to the program"
|
||||
},
|
||||
"env": {
|
||||
"type": "object",
|
||||
"description": "Environment variables to pass to the program",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"stopOnEntry": {
|
||||
"type": "boolean",
|
||||
"description": "Whether to break at the beginning of the script",
|
||||
"default": false
|
||||
},
|
||||
"pathMappings": {
|
||||
"type": "array",
|
||||
"description": "A list of server paths mapping to the local source paths on your machine for remote host debugging",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"serverPath": {
|
||||
"type": "string",
|
||||
"description": "Path on the server"
|
||||
},
|
||||
"localPath": {
|
||||
"type": "string",
|
||||
"description": "Corresponding path on the local machine"
|
||||
}
|
||||
},
|
||||
"required": ["serverPath", "localPath"]
|
||||
}
|
||||
},
|
||||
"log": {
|
||||
"type": "boolean",
|
||||
"description": "Whether to log all communication between editor and the adapter to the debug console",
|
||||
"default": false
|
||||
},
|
||||
"ignore": {
|
||||
"type": "array",
|
||||
"description": "An array of glob patterns that errors should be ignored from (for example **/vendor/**/*.php)",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ignoreExceptions": {
|
||||
"type": "array",
|
||||
"description": "An array of exception class names that should be ignored (for example BaseException, \\NS1\\Exception, \\*\\Exception or \\**\\Exception*)",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"skipFiles": {
|
||||
"type": "array",
|
||||
"description": "An array of glob patterns to skip when debugging. Star patterns and negations are allowed.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"skipEntryPaths": {
|
||||
"type": "array",
|
||||
"description": "An array of glob patterns to immediately detach from and ignore for debugging if the entry script matches",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"maxConnections": {
|
||||
"type": "integer",
|
||||
"description": "Accept only this number of parallel debugging sessions. Additional connections will be dropped.",
|
||||
"default": 1
|
||||
},
|
||||
"proxy": {
|
||||
"type": "object",
|
||||
"description": "DBGp Proxy settings",
|
||||
"properties": {
|
||||
"enable": {
|
||||
"type": "boolean",
|
||||
"description": "To enable proxy registration",
|
||||
"default": false
|
||||
},
|
||||
"host": {
|
||||
"type": "string",
|
||||
"description": "The address of the proxy. Supports host name, IP address, or Unix domain socket.",
|
||||
"default": "127.0.0.1"
|
||||
},
|
||||
"port": {
|
||||
"type": "integer",
|
||||
"description": "The port where the adapter will register with the proxy",
|
||||
"default": 9001
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "A unique key that allows the proxy to match requests to your editor",
|
||||
"default": "vsc"
|
||||
},
|
||||
"timeout": {
|
||||
"type": "integer",
|
||||
"description": "The number of milliseconds to wait before giving up on the connection to proxy",
|
||||
"default": 3000
|
||||
},
|
||||
"allowMultipleSessions": {
|
||||
"type": "boolean",
|
||||
"description": "If the proxy should forward multiple sessions/connections at the same time or not",
|
||||
"default": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"xdebugSettings": {
|
||||
"type": "object",
|
||||
"description": "Allows you to override Xdebug's remote debugging settings to fine tune Xdebug to your needs",
|
||||
"properties": {
|
||||
"max_children": {
|
||||
"type": "integer",
|
||||
"description": "Max number of array or object children to initially retrieve"
|
||||
},
|
||||
"max_data": {
|
||||
"type": "integer",
|
||||
"description": "Max amount of variable data to initially retrieve"
|
||||
},
|
||||
"max_depth": {
|
||||
"type": "integer",
|
||||
"description": "Maximum depth that the debugger engine may return when sending arrays, hashes or object structures to the IDE"
|
||||
},
|
||||
"show_hidden": {
|
||||
"type": "integer",
|
||||
"description": "Whether to show detailed internal information on properties (e.g. private members of classes). Zero means hidden members are not shown.",
|
||||
"enum": [0, 1]
|
||||
},
|
||||
"breakpoint_include_return_value": {
|
||||
"type": "boolean",
|
||||
"description": "Determines whether to enable an additional \"return from function\" debugging step, allowing inspection of the return value when a function call returns"
|
||||
}
|
||||
}
|
||||
},
|
||||
"xdebugCloudToken": {
|
||||
"type": "string",
|
||||
"description": "Instead of listening locally, open a connection and register with Xdebug Cloud and accept debugging sessions on that connection"
|
||||
},
|
||||
"stream": {
|
||||
"type": "object",
|
||||
"description": "Allows to influence DBGp streams. Xdebug only supports stdout",
|
||||
"properties": {
|
||||
"stdout": {
|
||||
"type": "integer",
|
||||
"description": "Redirect stdout stream: 0 (disable), 1 (copy), 2 (redirect)",
|
||||
"enum": [0, 1, 2],
|
||||
"default": 0
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": ["request", "program"]
|
||||
})
|
||||
}
|
||||
|
||||
fn name(&self) -> DebugAdapterName {
|
||||
DebugAdapterName(Self::ADAPTER_NAME.into())
|
||||
}
|
||||
|
|
@ -125,10 +295,33 @@ impl DebugAdapter for PhpDebugAdapter {
|
|||
Some(SharedString::new_static("PHP").into())
|
||||
}
|
||||
|
||||
fn config_from_zed_format(&self, zed_scenario: ZedDebugConfig) -> Result<DebugScenario> {
|
||||
let obj = match &zed_scenario.request {
|
||||
dap::DebugRequest::Attach(_) => {
|
||||
bail!("Php adapter doesn't support attaching")
|
||||
}
|
||||
dap::DebugRequest::Launch(launch_config) => json!({
|
||||
"program": launch_config.program,
|
||||
"cwd": launch_config.cwd,
|
||||
"args": launch_config.args,
|
||||
"env": launch_config.env_json(),
|
||||
"stopOnEntry": zed_scenario.stop_on_entry.unwrap_or_default(),
|
||||
}),
|
||||
};
|
||||
|
||||
Ok(DebugScenario {
|
||||
adapter: zed_scenario.adapter,
|
||||
label: zed_scenario.label,
|
||||
build: None,
|
||||
config: obj,
|
||||
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> {
|
||||
|
|
@ -145,7 +338,7 @@ impl DebugAdapter for PhpDebugAdapter {
|
|||
}
|
||||
}
|
||||
|
||||
self.get_installed_binary(delegate, &config, user_installed_path, cx)
|
||||
self.get_installed_binary(delegate, &task_definition, user_installed_path, cx)
|
||||
.await
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue