Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(dap): send Disconnect if Terminated event received #5532

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions helix-dap/src/client.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
use crate::{
requests::DisconnectArguments,
transport::{Payload, Request, Response, Transport},
types::*,
Error, Result, ThreadId,
Expand Down Expand Up @@ -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>>,
Expand All @@ -41,6 +43,12 @@ pub struct Client {
pub quirks: DebuggerQuirks,
}

#[derive(Clone, Copy, Debug)]
pub enum ConnectionType {
Launch,
Attach,
filipdutescu marked this conversation as resolved.
Show resolved Hide resolved
}

impl Client {
// Spawn a process and communicate with it by either TCP or stdio
pub async fn process(
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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)
}
Expand Down Expand Up @@ -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)
}

Expand Down
2 changes: 1 addition & 1 deletion helix-dap/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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::*;
Expand Down
13 changes: 12 additions & 1 deletion helix-dap/src/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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";
}
Expand Down
2 changes: 1 addition & 1 deletion helix-term/src/commands/dap.rs
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ pub fn dap_variables(cx: &mut Context) {
pub fn dap_terminate(cx: &mut Context) {
let debugger = debugger!(cx.editor);

let request = debugger.disconnect();
let request = debugger.disconnect(None);
dap_callback(cx.jobs, request, |editor, _compositor, _response: ()| {
// editor.set_error(format!("Failed to disconnect: {}", e));
editor.debugger = None;
Expand Down
63 changes: 62 additions & 1 deletion helix-view/src/handlers/dap.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
use crate::editor::{Action, Breakpoint};
use crate::{align_view, Align, Editor};
use dap::requests::DisconnectArguments;
use helix_core::Selection;
use helix_dap::{self as dap, Client, Payload, Request, ThreadId};
use helix_dap::{self as dap, Client, ConnectionType, Payload, Request, ThreadId};
use helix_lsp::block_on;
use log::warn;
use std::fmt::Write;
Expand Down Expand Up @@ -274,6 +275,66 @@ impl Editor {
self.set_status("Debugged application started");
}; // TODO: do we need to handle error?
}
Event::Terminated(terminated) => {
let restart_args = if let Some(terminated) = terminated {
terminated.restart
} else {
None
};

let disconnect_args = Some(DisconnectArguments {
restart: Some(restart_args.is_some()),
terminate_debuggee: None,
suspend_debuggee: None,
});

if let Err(err) = debugger.disconnect(disconnect_args).await {
self.set_error(format!(
"Cannot disconnect debugger upon terminated event receival {:?}",
err
));
return false;
}

match restart_args {
Some(restart_args) => {
log::info!("Attempting to restart debug session.");
let connection_type = match debugger.connection_type() {
Some(connection_type) => connection_type,
None => {
filipdutescu marked this conversation as resolved.
Show resolved Hide resolved
self.set_error("No starting request found, to be used in restarting the debugging session.");
return false;
}
};

let relaunch_resp = if let ConnectionType::Launch = connection_type {
debugger.launch(restart_args).await
} else {
debugger.attach(restart_args).await
};

if let Err(err) = relaunch_resp {
self.set_error(format!(
"Failed to restart debugging session: {:?}",
err
));
}
}
None => {
self.set_status(
"Terminated debugging session and disconnected debugger.",
);
}
}
}
Event::Exited(resp) => {
let exit_code = resp.exit_code;
if exit_code != 0 {
self.set_error(format!(
"Debuggee failed to exit successfully (exit code: {exit_code})."
));
}
}
ev => {
log::warn!("Unhandled event {:?}", ev);
return false; // return early to skip render
Expand Down