1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
use crate::{
error::{PartialErrorResponse, RequestError},
get_command, Outbox,
};
use async_trait::async_trait;
use debug_adapter_protocol::{
events::Event,
requests::{
ContinueRequestArguments, DisconnectRequestArguments, EvaluateRequestArguments,
InitializeRequestArguments, LaunchRequestArguments, NextRequestArguments,
PauseRequestArguments, Request, ScopesRequestArguments, SetBreakpointsRequestArguments,
StackTraceRequestArguments, StepInRequestArguments, StepOutRequestArguments,
TerminateRequestArguments, VariablesRequestArguments,
},
responses::{
ContinueResponseBody, ErrorResponse, ErrorResponseBody, EvaluateResponseBody,
ScopesResponseBody, SetBreakpointsResponseBody, StackTraceResponseBody, SuccessResponse,
ThreadsResponseBody, VariablesResponseBody,
},
types::Capabilities,
SequenceNumber,
};
use tokio::sync::mpsc::UnboundedReceiver;
use typed_builder::TypedBuilder;
pub trait DebugAdapterContext {
fn fire_event(&mut self, event: impl Into<Event> + Send);
fn start_cancellable_progress(
&mut self,
title: String,
message: Option<String>,
) -> ProgressContext;
fn end_cancellable_progress(&mut self, progress_id: String, message: Option<String>);
fn shutdown(&mut self);
}
pub struct ProgressContext {
pub progress_id: String,
cancel_receiver: UnboundedReceiver<SequenceNumber>,
outbox: Outbox,
}
impl ProgressContext {
pub(super) fn new(
progress_id: String,
cancel_receiver: UnboundedReceiver<SequenceNumber>,
outbox: Outbox,
) -> ProgressContext {
ProgressContext {
progress_id,
cancel_receiver,
outbox,
}
}
pub async fn next_cancel_request(&mut self) -> Option<CancelRequest> {
let request_id = self.cancel_receiver.recv().await?;
Some(CancelRequest {
outbox: self.outbox.clone(),
request_id,
response_sent: false,
})
}
}
impl Drop for ProgressContext {
fn drop(&mut self) {
while let Ok(open_request) = self.cancel_receiver.try_recv() {
self.outbox
.respond_unknown_progress(open_request, self.progress_id.to_string())
}
}
}
pub struct CancelRequest {
outbox: Outbox,
request_id: SequenceNumber,
response_sent: bool,
}
impl CancelRequest {
pub fn respond(mut self, response: Result<(), CancelErrorResponse>) {
self.respond_without_consuming(response)
}
fn respond_without_consuming(&mut self, response: Result<(), CancelErrorResponse>) {
if self.response_sent {
return;
}
self.response_sent = true;
let result = response
.map(|()| SuccessResponse::Cancel)
.map_err(Into::into);
self.outbox.respond(self.request_id, result);
}
}
impl Drop for CancelRequest {
fn drop(&mut self) {
self.respond_without_consuming(Ok(()))
}
}
#[derive(Clone, Debug, Eq, PartialEq, TypedBuilder)]
pub struct CancelErrorResponse {
pub message: String,
#[builder(default)]
pub body: ErrorResponseBody,
#[builder(default, setter(skip))]
private: (),
}
impl From<CancelErrorResponse> for ErrorResponse {
fn from(value: CancelErrorResponse) -> Self {
ErrorResponse::builder()
.command("cancel".to_string())
.message(value.message)
.body(value.body)
.build()
}
}
#[async_trait]
pub trait DebugAdapter {
type Message: Send + 'static;
type CustomError;
fn map_custom_error(e: Self::CustomError) -> RequestError<Self::CustomError> {
RequestError::Terminate(e)
}
async fn handle_other_message(
&mut self,
_message: Self::Message,
_context: impl DebugAdapterContext + Send,
) -> Result<(), Self::CustomError> {
Ok(())
}
async fn handle_client_request(
&mut self,
request: Request,
context: impl DebugAdapterContext + Send,
) -> Result<SuccessResponse, RequestError<Self::CustomError>> {
match request {
Request::ConfigurationDone => self
.configuration_done(context)
.await
.map(|()| SuccessResponse::ConfigurationDone),
Request::Continue(args) => self
.continue_(args, context)
.await
.map(SuccessResponse::Continue),
Request::Disconnect(args) => self
.disconnect(args, context)
.await
.map(|()| SuccessResponse::Disconnect),
Request::Evaluate(args) => self
.evaluate(args, context)
.await
.map(SuccessResponse::Evaluate),
Request::Initialize(args) => self
.initialize(args, context)
.await
.map(SuccessResponse::Initialize),
Request::Launch(args) => self
.launch(args, context)
.await
.map(|()| SuccessResponse::Launch),
Request::Next(args) => self
.next(args, context)
.await
.map(|()| SuccessResponse::Next),
Request::Pause(args) => self
.pause(args, context)
.await
.map(|()| SuccessResponse::Pause),
Request::Scopes(args) => self
.scopes(args, context)
.await
.map(SuccessResponse::Scopes),
Request::SetBreakpoints(args) => self
.set_breakpoints(args, context)
.await
.map(SuccessResponse::SetBreakpoints),
Request::StackTrace(args) => self
.stack_trace(args, context)
.await
.map(SuccessResponse::StackTrace),
Request::StepIn(args) => self
.step_in(args, context)
.await
.map(|()| SuccessResponse::StepIn),
Request::StepOut(args) => self
.step_out(args, context)
.await
.map(|()| SuccessResponse::StepOut),
Request::Terminate(args) => self
.terminate(args, context)
.await
.map(|()| SuccessResponse::Terminate),
Request::Threads => self.threads(context).await.map(SuccessResponse::Threads),
Request::Variables(args) => self
.variables(args, context)
.await
.map(SuccessResponse::Variables),
_ => {
let command = get_command(&request);
Err(RequestError::Respond(PartialErrorResponse::new(format!(
"Unsupported request {}",
command
))))
}
}
}
async fn configuration_done(
&mut self,
_context: impl DebugAdapterContext + Send,
) -> Result<(), RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'configurationDone'".to_string(),
)))
}
async fn continue_(
&mut self,
_args: ContinueRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<ContinueResponseBody, RequestError<Self::CustomError>>;
async fn disconnect(
&mut self,
_args: DisconnectRequestArguments,
mut context: impl DebugAdapterContext + Send,
) -> Result<(), RequestError<Self::CustomError>> {
context.shutdown();
Ok(())
}
async fn evaluate(
&mut self,
_args: EvaluateRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<EvaluateResponseBody, RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'evaluate'".to_string(),
)))
}
async fn initialize(
&mut self,
_args: InitializeRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<Capabilities, RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'initialize'".to_string(),
)))
}
async fn launch(
&mut self,
_args: LaunchRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<(), RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'launch'".to_string(),
)))
}
async fn next(
&mut self,
_args: NextRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<(), RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'next'".to_string(),
)))
}
async fn pause(
&mut self,
_args: PauseRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<(), RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'pause'".to_string(),
)))
}
async fn scopes(
&mut self,
_args: ScopesRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<ScopesResponseBody, RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'scopes'".to_string(),
)))
}
async fn set_breakpoints(
&mut self,
_args: SetBreakpointsRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<SetBreakpointsResponseBody, RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'setBreakpoints'".to_string(),
)))
}
async fn stack_trace(
&mut self,
_args: StackTraceRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<StackTraceResponseBody, RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'stackTrace'".to_string(),
)))
}
async fn step_in(
&mut self,
_args: StepInRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<(), RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'stepIn'".to_string(),
)))
}
async fn step_out(
&mut self,
_args: StepOutRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<(), RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'stepOut'".to_string(),
)))
}
async fn terminate(
&mut self,
_args: TerminateRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<(), RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'terminate'".to_string(),
)))
}
async fn threads(
&mut self,
_context: impl DebugAdapterContext + Send,
) -> Result<ThreadsResponseBody, RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'threads'".to_string(),
)))
}
async fn variables(
&mut self,
_args: VariablesRequestArguments,
_context: impl DebugAdapterContext + Send,
) -> Result<VariablesResponseBody, RequestError<Self::CustomError>> {
Err(RequestError::Respond(PartialErrorResponse::new(
"Unsupported request 'variables'".to_string(),
)))
}
}