aboutsummaryrefslogtreecommitdiff
path: root/helix-dap
diff options
context:
space:
mode:
authorFilip Dutescu2023-02-20 04:00:00 +0000
committerGitHub2023-02-20 04:00:00 +0000
commite3765ac6d20195d2434c8274850247fe0a044da0 (patch)
treef221c9d2413bfc9a1618bb22ea51d5437d0e2eb7 /helix-dap
parent31b0c75832c56179e9fcb2301f1e92ac2fa116ff (diff)
feat(dap): send Disconnect if Terminated event received (#5532)
Send a `Disconnect` DAP request if the `Terminated` event is received. According to the specification, if the debugging session was started by as `launch`, the debuggee should be terminated alongside the session. If instead the session was started as `attach`, it should not be disposed of. This default behaviour can be overriden if the `supportTerminateDebuggee` capability is supported by the adapter, through the `Disconnect` request `terminateDebuggee` argument, as described in [the specification][discon-spec]. This also implies saving the starting command for a debug sessions, in order to decide which behaviour should be used, as well as validating the capabilities of the adapter, in order to decide what the disconnect should do. An additional change made is handling of the `Exited` event, showing a message if the exit code is different than `0`, for the user to be aware off the termination failure. [discon-spec]: https://microsoft.github.io/debug-adapter-protocol/specification#Requests_Disconnect Closes: #4674 Signed-off-by: Filip Dutescu <filip.dutescu@gmail.com>
Diffstat (limited to 'helix-dap')
-rw-r--r--helix-dap/src/client.rs28
-rw-r--r--helix-dap/src/lib.rs2
-rw-r--r--helix-dap/src/types.rs13
3 files changed, 36 insertions, 7 deletions
diff --git a/helix-dap/src/client.rs b/helix-dap/src/client.rs
index 10d93180..f6d8a069 100644
--- a/helix-dap/src/client.rs
+++ b/helix-dap/src/client.rs
@@ -1,4 +1,5 @@
use crate::{
+ requests::DisconnectArguments,
transport::{Payload, Request, Response, Transport},
types::*,
Error, Result, ThreadId,
@@ -31,6 +32,7 @@ pub struct Client {
_process: Option<Child>,
server_tx: UnboundedSender<Payload>,
request_counter: AtomicU64,
+ connection_type: Option<ConnectionType>,
pub caps: Option<DebuggerCapabilities>,
// thread_id -> frames
pub stack_frames: HashMap<ThreadId, Vec<StackFrame>>,
@@ -41,6 +43,12 @@ pub struct Client {
pub quirks: DebuggerQuirks,
}
+#[derive(Clone, Copy, Debug)]
+pub enum ConnectionType {
+ Launch,
+ Attach,
+}
+
impl Client {
// Spawn a process and communicate with it by either TCP or stdio
pub async fn process(
@@ -78,7 +86,7 @@ impl Client {
server_tx,
request_counter: AtomicU64::new(0),
caps: None,
- //
+ connection_type: None,
stack_frames: HashMap::new(),
thread_states: HashMap::new(),
thread_id: None,
@@ -207,6 +215,10 @@ impl Client {
self.id
}
+ pub fn connection_type(&self) -> Option<ConnectionType> {
+ self.connection_type
+ }
+
fn next_request_id(&self) -> u64 {
self.request_counter.fetch_add(1, Ordering::Relaxed)
}
@@ -334,15 +346,21 @@ impl Client {
Ok(())
}
- pub fn disconnect(&self) -> impl Future<Output = Result<Value>> {
- self.call::<requests::Disconnect>(())
+ pub fn disconnect(
+ &mut self,
+ args: Option<DisconnectArguments>,
+ ) -> impl Future<Output = Result<Value>> {
+ self.connection_type = None;
+ self.call::<requests::Disconnect>(args)
}
- pub fn launch(&self, args: serde_json::Value) -> impl Future<Output = Result<Value>> {
+ pub fn launch(&mut self, args: serde_json::Value) -> impl Future<Output = Result<Value>> {
+ self.connection_type = Some(ConnectionType::Launch);
self.call::<requests::Launch>(args)
}
- pub fn attach(&self, args: serde_json::Value) -> impl Future<Output = Result<Value>> {
+ pub fn attach(&mut self, args: serde_json::Value) -> impl Future<Output = Result<Value>> {
+ self.connection_type = Some(ConnectionType::Attach);
self.call::<requests::Attach>(args)
}
diff --git a/helix-dap/src/lib.rs b/helix-dap/src/lib.rs
index 24d7472b..21162cb8 100644
--- a/helix-dap/src/lib.rs
+++ b/helix-dap/src/lib.rs
@@ -2,7 +2,7 @@ mod client;
mod transport;
mod types;
-pub use client::Client;
+pub use client::{Client, ConnectionType};
pub use events::Event;
pub use transport::{Payload, Response, Transport};
pub use types::*;
diff --git a/helix-dap/src/types.rs b/helix-dap/src/types.rs
index 0a9ebe5e..c598790b 100644
--- a/helix-dap/src/types.rs
+++ b/helix-dap/src/types.rs
@@ -391,11 +391,22 @@ pub mod requests {
const COMMAND: &'static str = "attach";
}
+ #[derive(Debug, Default, PartialEq, Eq, Clone, Deserialize, Serialize)]
+ #[serde(rename_all = "camelCase")]
+ pub struct DisconnectArguments {
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub restart: Option<bool>,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub terminate_debuggee: Option<bool>,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub suspend_debuggee: Option<bool>,
+ }
+
#[derive(Debug)]
pub enum Disconnect {}
impl Request for Disconnect {
- type Arguments = ();
+ type Arguments = Option<DisconnectArguments>;
type Result = ();
const COMMAND: &'static str = "disconnect";
}