1use crate::{
2 adapters::DebugAdapterBinary,
3 transport::{IoKind, LogKind, TransportDelegate},
4};
5use anyhow::Result;
6use dap_types::{
7 messages::{Message, Response},
8 requests::Request,
9};
10use futures::channel::oneshot;
11use gpui::AsyncApp;
12use std::{
13 hash::Hash,
14 sync::atomic::{AtomicU64, Ordering},
15};
16
17#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
18#[repr(transparent)]
19pub struct SessionId(pub u32);
20
21impl SessionId {
22 pub fn from_proto(client_id: u64) -> Self {
23 Self(client_id as u32)
24 }
25
26 pub fn to_proto(self) -> u64 {
27 self.0 as u64
28 }
29}
30
31/// Represents a connection to the debug adapter process, either via stdout/stdin or a socket.
32pub struct DebugAdapterClient {
33 id: SessionId,
34 sequence_count: AtomicU64,
35 binary: DebugAdapterBinary,
36 transport_delegate: TransportDelegate,
37}
38
39pub type DapMessageHandler = Box<dyn FnMut(Message) + 'static + Send + Sync>;
40
41impl DebugAdapterClient {
42 pub async fn start(
43 id: SessionId,
44 binary: DebugAdapterBinary,
45 message_handler: DapMessageHandler,
46 cx: &mut AsyncApp,
47 ) -> Result<Self> {
48 let transport_delegate = TransportDelegate::start(&binary, cx).await?;
49 let this = Self {
50 id,
51 binary,
52 transport_delegate,
53 sequence_count: AtomicU64::new(1),
54 };
55 this.connect(message_handler, cx).await?;
56
57 Ok(this)
58 }
59
60 pub fn should_reconnect_for_ssh(&self) -> bool {
61 self.transport_delegate.tcp_arguments().is_some()
62 && (self.binary.command.as_deref() == Some("ssh")
63 || (cfg!(feature = "test-support")
64 && self.binary.command.as_deref() == Some("mock")))
65 }
66
67 pub async fn connect(
68 &self,
69 message_handler: DapMessageHandler,
70 cx: &mut AsyncApp,
71 ) -> Result<()> {
72 self.transport_delegate.connect(message_handler, cx).await
73 }
74
75 pub async fn create_child_connection(
76 &self,
77 session_id: SessionId,
78 binary: DebugAdapterBinary,
79 message_handler: DapMessageHandler,
80 cx: &mut AsyncApp,
81 ) -> Result<Self> {
82 let binary = if let Some(connection) = self.transport_delegate.tcp_arguments() {
83 DebugAdapterBinary {
84 command: None,
85 arguments: Default::default(),
86 envs: Default::default(),
87 cwd: Default::default(),
88 connection: Some(connection),
89 request_args: binary.request_args,
90 }
91 } else {
92 self.binary.clone()
93 };
94
95 Self::start(session_id, binary, message_handler, cx).await
96 }
97
98 /// Send a request to an adapter and get a response back
99 /// Note: This function will block until a response is sent back from the adapter
100 pub async fn request<R: Request>(&self, arguments: R::Arguments) -> Result<R::Response> {
101 let serialized_arguments = serde_json::to_value(arguments)?;
102
103 let (callback_tx, callback_rx) = oneshot::channel::<Result<Response>>();
104
105 let sequence_id = self.next_sequence_id();
106
107 let request = crate::messages::Request {
108 seq: sequence_id,
109 command: R::COMMAND.to_string(),
110 arguments: Some(serialized_arguments),
111 };
112 self.transport_delegate
113 .pending_requests
114 .lock()
115 .insert(sequence_id, callback_tx)?;
116
117 log::debug!(
118 "Client {} send `{}` request with sequence_id: {}",
119 self.id.0,
120 R::COMMAND,
121 sequence_id
122 );
123 log::debug!(" request: {request:?}");
124
125 self.send_message(Message::Request(request)).await?;
126
127 let command = R::COMMAND.to_string();
128
129 let response = callback_rx.await??;
130 log::debug!(
131 "Client {} received response for: `{}` sequence_id: {}",
132 self.id.0,
133 command,
134 sequence_id
135 );
136 log::debug!(" response: {response:?}");
137
138 match response.success {
139 true => {
140 if let Some(json) = response.body {
141 Ok(serde_json::from_value(json)?)
142 // Note: dap types configure themselves to return `None` when an empty object is received,
143 // which then fails here...
144 } else if let Ok(result) =
145 serde_json::from_value(serde_json::Value::Object(Default::default()))
146 {
147 Ok(result)
148 } else {
149 Ok(serde_json::from_value(Default::default())?)
150 }
151 }
152 false => anyhow::bail!("Request failed: {}", response.message.unwrap_or_default()),
153 }
154 }
155
156 pub async fn send_message(&self, message: Message) -> Result<()> {
157 self.transport_delegate.send_message(message).await
158 }
159
160 pub fn id(&self) -> SessionId {
161 self.id
162 }
163
164 pub fn binary(&self) -> &DebugAdapterBinary {
165 &self.binary
166 }
167
168 /// Get the next sequence id to be used in a request
169 pub fn next_sequence_id(&self) -> u64 {
170 self.sequence_count.fetch_add(1, Ordering::Relaxed)
171 }
172
173 pub fn kill(&self) {
174 log::debug!("Killing DAP process");
175 self.transport_delegate.transport.lock().kill();
176 self.transport_delegate.pending_requests.lock().shutdown();
177 }
178
179 pub fn has_adapter_logs(&self) -> bool {
180 self.transport_delegate.has_adapter_logs()
181 }
182
183 pub fn add_log_handler<F>(&self, f: F, kind: LogKind)
184 where
185 F: 'static + Send + FnMut(IoKind, Option<&str>, &str),
186 {
187 self.transport_delegate.add_log_handler(f, kind);
188 }
189
190 #[cfg(any(test, feature = "test-support"))]
191 pub fn on_request<R: dap_types::requests::Request, F>(&self, mut handler: F)
192 where
193 F: 'static
194 + Send
195 + FnMut(u64, R::Arguments) -> Result<R::Response, dap_types::ErrorResponse>,
196 {
197 use crate::transport::RequestHandling;
198
199 self.transport_delegate
200 .transport
201 .lock()
202 .as_fake()
203 .on_request::<R, _>(move |seq, request| {
204 RequestHandling::Respond(handler(seq, request))
205 });
206 }
207
208 #[cfg(any(test, feature = "test-support"))]
209 pub fn on_request_ext<R: dap_types::requests::Request, F>(&self, handler: F)
210 where
211 F: 'static
212 + Send
213 + FnMut(
214 u64,
215 R::Arguments,
216 ) -> crate::transport::RequestHandling<
217 Result<R::Response, dap_types::ErrorResponse>,
218 >,
219 {
220 self.transport_delegate
221 .transport
222 .lock()
223 .as_fake()
224 .on_request::<R, F>(handler);
225 }
226
227 #[cfg(any(test, feature = "test-support"))]
228 pub async fn fake_reverse_request<R: dap_types::requests::Request>(&self, args: R::Arguments) {
229 self.send_message(Message::Request(dap_types::messages::Request {
230 seq: self.sequence_count.load(Ordering::Relaxed),
231 command: R::COMMAND.into(),
232 arguments: serde_json::to_value(args).ok(),
233 }))
234 .await
235 .unwrap();
236 }
237
238 #[cfg(any(test, feature = "test-support"))]
239 pub async fn on_response<R: dap_types::requests::Request, F>(&self, handler: F)
240 where
241 F: 'static + Send + Fn(Response),
242 {
243 self.transport_delegate
244 .transport
245 .lock()
246 .as_fake()
247 .on_response::<R, F>(handler);
248 }
249
250 #[cfg(any(test, feature = "test-support"))]
251 pub async fn fake_event(&self, event: dap_types::messages::Events) {
252 self.send_message(Message::Event(Box::new(event)))
253 .await
254 .unwrap();
255 }
256}
257
258#[cfg(test)]
259mod tests {
260 use super::*;
261 use crate::client::DebugAdapterClient;
262 use dap_types::{
263 Capabilities, InitializeRequestArguments, InitializeRequestArgumentsPathFormat,
264 RunInTerminalRequestArguments, StartDebuggingRequestArguments,
265 messages::Events,
266 requests::{Initialize, Request, RunInTerminal},
267 };
268 use gpui::TestAppContext;
269 use serde_json::json;
270 use settings::SettingsStore;
271 use std::sync::{
272 Arc,
273 atomic::{AtomicBool, Ordering},
274 };
275
276 pub fn init_test(cx: &mut gpui::TestAppContext) {
277 zlog::init_test();
278
279 cx.update(|cx| {
280 let settings = SettingsStore::test(cx);
281 cx.set_global(settings);
282 });
283 }
284
285 #[gpui::test]
286 pub async fn test_initialize_client(cx: &mut TestAppContext) {
287 init_test(cx);
288
289 let client = DebugAdapterClient::start(
290 crate::client::SessionId(1),
291 DebugAdapterBinary {
292 command: Some("command".into()),
293 arguments: Default::default(),
294 envs: Default::default(),
295 connection: None,
296 cwd: None,
297 request_args: StartDebuggingRequestArguments {
298 configuration: serde_json::Value::Null,
299 request: dap_types::StartDebuggingRequestArgumentsRequest::Launch,
300 },
301 },
302 Box::new(|_| {}),
303 &mut cx.to_async(),
304 )
305 .await
306 .unwrap();
307
308 client.on_request::<Initialize, _>(move |_, _| {
309 Ok(dap_types::Capabilities {
310 supports_configuration_done_request: Some(true),
311 ..Default::default()
312 })
313 });
314
315 cx.run_until_parked();
316
317 let response = client
318 .request::<Initialize>(InitializeRequestArguments {
319 client_id: Some("zed".to_owned()),
320 client_name: Some("Zed".to_owned()),
321 adapter_id: "fake-adapter".to_owned(),
322 locale: Some("en-US".to_owned()),
323 path_format: Some(InitializeRequestArgumentsPathFormat::Path),
324 supports_variable_type: Some(true),
325 supports_variable_paging: Some(false),
326 supports_run_in_terminal_request: Some(true),
327 supports_memory_references: Some(true),
328 supports_progress_reporting: Some(false),
329 supports_invalidated_event: Some(false),
330 lines_start_at1: Some(true),
331 columns_start_at1: Some(true),
332 supports_memory_event: Some(false),
333 supports_args_can_be_interpreted_by_shell: Some(false),
334 supports_start_debugging_request: Some(true),
335 supports_ansistyling: Some(false),
336 })
337 .await
338 .unwrap();
339
340 cx.run_until_parked();
341
342 assert_eq!(
343 dap_types::Capabilities {
344 supports_configuration_done_request: Some(true),
345 ..Default::default()
346 },
347 response
348 );
349 }
350
351 #[gpui::test]
352 pub async fn test_calls_event_handler(cx: &mut TestAppContext) {
353 init_test(cx);
354
355 let called_event_handler = Arc::new(AtomicBool::new(false));
356
357 let client = DebugAdapterClient::start(
358 crate::client::SessionId(1),
359 DebugAdapterBinary {
360 command: Some("command".into()),
361 arguments: Default::default(),
362 envs: Default::default(),
363 connection: None,
364 cwd: None,
365 request_args: StartDebuggingRequestArguments {
366 configuration: serde_json::Value::Null,
367 request: dap_types::StartDebuggingRequestArgumentsRequest::Launch,
368 },
369 },
370 Box::new({
371 let called_event_handler = called_event_handler.clone();
372 move |event| {
373 called_event_handler.store(true, Ordering::SeqCst);
374
375 assert_eq!(
376 Message::Event(Box::new(Events::Initialized(
377 Some(Capabilities::default())
378 ))),
379 event
380 );
381 }
382 }),
383 &mut cx.to_async(),
384 )
385 .await
386 .unwrap();
387
388 cx.run_until_parked();
389
390 client
391 .fake_event(Events::Initialized(Some(Capabilities::default())))
392 .await;
393
394 cx.run_until_parked();
395
396 assert!(
397 called_event_handler.load(std::sync::atomic::Ordering::SeqCst),
398 "Event handler was not called"
399 );
400 }
401
402 #[gpui::test]
403 pub async fn test_calls_event_handler_for_reverse_request(cx: &mut TestAppContext) {
404 init_test(cx);
405
406 let called_event_handler = Arc::new(AtomicBool::new(false));
407
408 let client = DebugAdapterClient::start(
409 crate::client::SessionId(1),
410 DebugAdapterBinary {
411 command: Some("command".into()),
412 arguments: Default::default(),
413 envs: Default::default(),
414 connection: None,
415 cwd: None,
416 request_args: dap_types::StartDebuggingRequestArguments {
417 configuration: serde_json::Value::Null,
418 request: dap_types::StartDebuggingRequestArgumentsRequest::Launch,
419 },
420 },
421 Box::new({
422 let called_event_handler = called_event_handler.clone();
423 move |event| {
424 called_event_handler.store(true, Ordering::SeqCst);
425
426 assert_eq!(
427 Message::Request(dap_types::messages::Request {
428 seq: 1,
429 command: RunInTerminal::COMMAND.into(),
430 arguments: Some(json!({
431 "cwd": "/project/path/src",
432 "args": ["node", "test.js"],
433 }))
434 }),
435 event
436 );
437 }
438 }),
439 &mut cx.to_async(),
440 )
441 .await
442 .unwrap();
443
444 cx.run_until_parked();
445
446 client
447 .fake_reverse_request::<RunInTerminal>(RunInTerminalRequestArguments {
448 kind: None,
449 title: None,
450 cwd: "/project/path/src".into(),
451 args: vec!["node".into(), "test.js".into()],
452 env: None,
453 args_can_be_interpreted_by_shell: None,
454 })
455 .await;
456
457 cx.run_until_parked();
458
459 assert!(
460 called_event_handler.load(std::sync::atomic::Ordering::SeqCst),
461 "Event handler was not called"
462 );
463 }
464}