mq-dap 0.8.3

Debug Adapter Protocol implementation for mq
Documentation
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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
use std::{
    fmt::Debug,
    sync::{
        Arc,
        atomic::{AtomicBool, Ordering::SeqCst},
    },
};

use crossbeam_channel::{Receiver, Sender};
use mq_lang::DebuggerAction;
use tracing::{debug, error};

use crate::protocol::{DapCommand, DebuggerMessage};

/// DAP debugger handler that communicates with the DAP server
pub struct DapDebuggerHandler {
    message_tx: Sender<DebuggerMessage>,
    thread_id: i64,
}

impl std::fmt::Debug for DapDebuggerHandler {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("DapDebuggerHandler")
            .field("thread_id", &self.thread_id)
            .finish()
    }
}

impl DapDebuggerHandler {
    pub fn new(message_tx: Sender<DebuggerMessage>) -> Self {
        Self {
            message_tx,
            thread_id: 1, // Main thread ID
        }
    }
}

impl mq_lang::DebuggerHandler for DapDebuggerHandler {}

/// Wrapper to implement DebuggerHandler trait
#[derive(Debug)]
pub struct DapHandlerWrapper {
    handler: DapDebuggerHandler,
    command_rx: Receiver<DapCommand>,
    pause_requested: Arc<AtomicBool>,
    exception_breakpoints_enabled: Arc<AtomicBool>,
}

impl DapHandlerWrapper {
    pub fn new(
        handler: DapDebuggerHandler,
        command_rx: Receiver<DapCommand>,
        exception_breakpoints_enabled: Arc<AtomicBool>,
    ) -> Self {
        Self {
            handler,
            command_rx,
            pause_requested: Arc::new(AtomicBool::new(false)),
            exception_breakpoints_enabled,
        }
    }

    fn next_action(&self, command: DapCommand) -> DebuggerAction {
        match command {
            DapCommand::Continue => mq_lang::DebuggerAction::Continue,
            DapCommand::Next => mq_lang::DebuggerAction::Next,
            DapCommand::StepIn => mq_lang::DebuggerAction::StepInto,
            DapCommand::StepOut => mq_lang::DebuggerAction::FunctionExit,
            DapCommand::Pause => {
                // Set pause flag and step into next statement
                self.pause_requested.store(true, SeqCst);
                mq_lang::DebuggerAction::StepInto
            }
            DapCommand::Terminate => mq_lang::DebuggerAction::Quit,
        }
    }
}

impl mq_lang::DebuggerHandler for DapHandlerWrapper {
    fn on_breakpoint_hit(
        &self,
        breakpoint: &mq_lang::Breakpoint,
        context: &mq_lang::DebugContext,
    ) -> mq_lang::DebuggerAction {
        debug!(line = breakpoint.line, "Breakpoint hit");

        // Send breakpoint hit message to DAP server
        let message = DebuggerMessage::BreakpointHit {
            thread_id: self.handler.thread_id,
            line: breakpoint.line,
            breakpoint: breakpoint.clone(),
            context: context.clone(),
        };

        if let Err(e) = self.handler.message_tx.send(message) {
            error!(error = %e, "Failed to send breakpoint message to DAP server");
            return mq_lang::DebuggerAction::Continue;
        }

        // Wait for command from DAP server
        match self.command_rx.recv() {
            Ok(command) => self.next_action(command),
            Err(e) => {
                error!(error = %e, "Failed to receive command from DAP server");
                mq_lang::DebuggerAction::Continue
            }
        }
    }

    fn on_log_point(&self, breakpoint: &mq_lang::Breakpoint, message: &str, _context: &mq_lang::DebugContext) {
        debug!(line = breakpoint.line, message = %message, "Logpoint hit");

        if let Err(e) = self.handler.message_tx.send(DebuggerMessage::LogPoint {
            message: message.to_string(),
        }) {
            error!(error = %e, "Failed to send logpoint message to DAP server");
        }
    }

    fn on_step(&self, context: &mq_lang::DebugContext) -> mq_lang::DebuggerAction {
        debug!(line = context.token.range.start.line + 1, "Step event");

        // Check if pause was requested
        let is_pause = self.pause_requested.swap(false, SeqCst);

        // Send appropriate message to DAP server
        let message = if is_pause {
            DebuggerMessage::Paused {
                thread_id: self.handler.thread_id,
                line: context.token.range.start.line as usize + 1,
                context: context.clone(),
            }
        } else {
            DebuggerMessage::StepCompleted {
                thread_id: self.handler.thread_id,
                line: context.token.range.start.line as usize + 1,
                context: context.clone(),
            }
        };

        if let Err(e) = self.handler.message_tx.send(message) {
            error!(error = %e, "Failed to send step message to DAP server");
            return mq_lang::DebuggerAction::Continue;
        }

        // Wait for command from DAP server
        match self.command_rx.recv() {
            Ok(command) => self.next_action(command),
            Err(e) => {
                error!(error = %e, "Failed to receive command from DAP server");
                mq_lang::DebuggerAction::Continue
            }
        }
    }

    fn on_error(&self, message: &str, context: &mq_lang::DebugContext) {
        if !self.exception_breakpoints_enabled.load(SeqCst) {
            return;
        }

        debug!(message = %message, "Uncaught error, exception breakpoints enabled");

        let dap_message = DebuggerMessage::ExceptionPaused {
            thread_id: self.handler.thread_id,
            message: message.to_string(),
            context: context.clone(),
        };

        if let Err(e) = self.handler.message_tx.send(dap_message) {
            error!(error = %e, "Failed to send exception message to DAP server");
            return;
        }

        // Block until the client resumes (e.g. via continue/next), mirroring on_breakpoint_hit.
        // The error propagates regardless of which command is received; this wait only gives
        // the client a chance to inspect state before that happens.
        if let Err(e) = self.command_rx.recv() {
            error!(error = %e, "Failed to receive command from DAP server");
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crossbeam_channel::unbounded;
    use mq_lang::DebuggerHandler;

    #[test]
    fn test_dap_debugger_handler_new() {
        let (tx, _rx) = unbounded::<DebuggerMessage>();
        let handler = DapDebuggerHandler::new(tx);

        assert_eq!(handler.thread_id, 1);
    }

    #[test]
    fn test_dap_debugger_handler_debug_format() {
        let (tx, _rx) = unbounded::<DebuggerMessage>();
        let handler = DapDebuggerHandler::new(tx);

        let debug_str = format!("{:?}", handler);
        assert!(debug_str.contains("DapDebuggerHandler"));
        assert!(debug_str.contains("thread_id"));
    }

    #[test]
    fn test_dap_handler_wrapper_new() {
        let (message_tx, _message_rx) = unbounded::<DebuggerMessage>();
        let (_command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(false)));

        let debug_str = format!("{:?}", wrapper);
        assert!(debug_str.contains("DapHandlerWrapper"));
    }

    #[test]
    fn test_on_log_point_sends_message_without_blocking() {
        let (message_tx, message_rx) = unbounded::<DebuggerMessage>();
        let (_command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(false)));

        let breakpoint = mq_lang::Breakpoint {
            id: 1,
            line: 10,
            column: Some(5),
            enabled: true,
            source: None,
            ..Default::default()
        };
        let context = mq_lang::DebugContext::default();

        // Should return immediately without waiting on command_rx (nothing was sent to it).
        wrapper.on_log_point(&breakpoint, "x is 3", &context);

        let received_message = message_rx.try_recv().unwrap();
        match received_message {
            DebuggerMessage::LogPoint { message } => assert_eq!(message, "x is 3"),
            _ => panic!("Expected LogPoint message"),
        }
    }

    #[test]
    fn test_on_breakpoint_hit_continue() {
        let (message_tx, message_rx) = unbounded::<DebuggerMessage>();
        let (command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(false)));

        let breakpoint = mq_lang::Breakpoint {
            id: 1,
            line: 10,
            column: Some(5),
            enabled: true,
            source: None,
            ..Default::default()
        };
        let context = mq_lang::DebugContext::default();

        // Send continue command before calling on_breakpoint_hit
        command_tx.send(DapCommand::Continue).unwrap();

        let action = wrapper.on_breakpoint_hit(&breakpoint, &context);

        // Verify the correct action is returned
        assert!(matches!(action, mq_lang::DebuggerAction::Continue));

        // Verify message was sent
        let received_message = message_rx.try_recv().unwrap();
        match received_message {
            DebuggerMessage::BreakpointHit { thread_id, line, .. } => {
                assert_eq!(thread_id, 1);
                assert_eq!(line, 10);
            }
            _ => panic!("Expected BreakpointHit message"),
        }
    }

    #[test]
    fn test_on_breakpoint_hit_next() {
        let (message_tx, _message_rx) = unbounded::<DebuggerMessage>();
        let (command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(false)));

        let breakpoint = mq_lang::Breakpoint {
            id: 1,
            line: 10,
            column: Some(5),
            enabled: true,
            source: None,
            ..Default::default()
        };
        let context = mq_lang::DebugContext::default();

        command_tx.send(DapCommand::Next).unwrap();

        let action = wrapper.on_breakpoint_hit(&breakpoint, &context);
        assert!(matches!(action, mq_lang::DebuggerAction::Next));
    }

    #[test]
    fn test_on_breakpoint_hit_step_in() {
        let (message_tx, _message_rx) = unbounded::<DebuggerMessage>();
        let (command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(false)));

        let breakpoint = mq_lang::Breakpoint {
            id: 1,
            line: 10,
            column: Some(5),
            enabled: true,
            source: None,
            ..Default::default()
        };
        let context = mq_lang::DebugContext::default();

        command_tx.send(DapCommand::StepIn).unwrap();

        let action = wrapper.on_breakpoint_hit(&breakpoint, &context);
        assert!(matches!(action, mq_lang::DebuggerAction::StepInto));
    }

    #[test]
    fn test_on_breakpoint_hit_step_out() {
        let (message_tx, _message_rx) = unbounded::<DebuggerMessage>();
        let (command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(false)));

        let breakpoint = mq_lang::Breakpoint {
            id: 1,
            line: 10,
            column: Some(5),
            enabled: true,
            source: None,
            ..Default::default()
        };
        let context = mq_lang::DebugContext::default();

        command_tx.send(DapCommand::StepOut).unwrap();

        let action = wrapper.on_breakpoint_hit(&breakpoint, &context);
        assert!(matches!(action, mq_lang::DebuggerAction::FunctionExit));
    }

    #[test]
    fn test_on_breakpoint_hit_terminate() {
        let (message_tx, _message_rx) = unbounded::<DebuggerMessage>();
        let (command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(false)));

        let breakpoint = mq_lang::Breakpoint {
            id: 1,
            line: 10,
            column: Some(5),
            enabled: true,
            source: None,
            ..Default::default()
        };
        let context = mq_lang::DebugContext::default();

        command_tx.send(DapCommand::Terminate).unwrap();

        let action = wrapper.on_breakpoint_hit(&breakpoint, &context);
        assert!(matches!(action, mq_lang::DebuggerAction::Quit));
    }

    #[test]
    fn test_on_breakpoint_hit_recv_error() {
        let (message_tx, _message_rx) = unbounded::<DebuggerMessage>();
        let (_command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(false)));

        let breakpoint = mq_lang::Breakpoint {
            id: 1,
            line: 10,
            column: Some(5),
            enabled: true,
            source: None,
            ..Default::default()
        };
        let context = mq_lang::DebugContext::default();

        // Don't send any command, so recv will fail when command_tx is dropped
        drop(_command_tx);

        let action = wrapper.on_breakpoint_hit(&breakpoint, &context);
        assert!(matches!(action, mq_lang::DebuggerAction::Continue));
    }

    #[test]
    fn test_on_step_continue() {
        let (message_tx, message_rx) = unbounded::<DebuggerMessage>();
        let (command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(false)));

        let context = mq_lang::DebugContext::default();

        command_tx.send(DapCommand::Continue).unwrap();

        let action = wrapper.on_step(&context);
        assert!(matches!(action, mq_lang::DebuggerAction::Continue));

        // Verify message was sent
        let received_message = message_rx.try_recv().unwrap();
        match received_message {
            DebuggerMessage::StepCompleted { thread_id, line, .. } => {
                assert_eq!(thread_id, 1);
                assert_eq!(line, 2); // context.token.range.start.line is 1, so +1 = 2
            }
            _ => panic!("Expected StepCompleted message"),
        }
    }

    #[test]
    fn test_on_step_all_commands() {
        let commands_and_actions = vec![
            (DapCommand::Continue, mq_lang::DebuggerAction::Continue),
            (DapCommand::Next, mq_lang::DebuggerAction::Next),
            (DapCommand::StepIn, mq_lang::DebuggerAction::StepInto),
            (DapCommand::StepOut, mq_lang::DebuggerAction::FunctionExit),
            (DapCommand::Terminate, mq_lang::DebuggerAction::Quit),
        ];

        for (command, expected_action) in commands_and_actions {
            let (message_tx, _message_rx) = unbounded::<DebuggerMessage>();
            let (command_tx, command_rx) = unbounded::<DapCommand>();

            let handler = DapDebuggerHandler::new(message_tx);
            let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(false)));

            let context = mq_lang::DebugContext::default();

            command_tx.send(command).unwrap();

            let action = wrapper.on_step(&context);

            // Compare debug strings since DebuggerAction doesn't implement PartialEq
            assert_eq!(format!("{:?}", action), format!("{:?}", expected_action));
        }
    }

    #[test]
    fn test_on_step_recv_error() {
        let (message_tx, _message_rx) = unbounded::<DebuggerMessage>();
        let (_command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(false)));

        let context = mq_lang::DebugContext::default();

        // Don't send any command, so recv will fail when command_tx is dropped
        drop(_command_tx);

        let action = wrapper.on_step(&context);
        assert!(matches!(action, mq_lang::DebuggerAction::Continue));
    }

    #[test]
    fn test_on_error_does_not_send_or_block_when_exception_breakpoints_disabled() {
        let (message_tx, message_rx) = unbounded::<DebuggerMessage>();
        let (_command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(false)));

        let context = mq_lang::DebugContext::default();

        // Drop the command sender: if on_error tried to block on command_rx.recv(), this call
        // would still return (recv fails), but we additionally assert nothing was sent at all.
        drop(_command_tx);

        wrapper.on_error("boom", &context);

        assert!(message_rx.try_recv().is_err());
    }

    #[test]
    fn test_on_error_sends_exception_paused_and_blocks_when_enabled() {
        let (message_tx, message_rx) = unbounded::<DebuggerMessage>();
        let (command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(true)));

        let context = mq_lang::DebugContext::default();

        // Unblock on_error's wait immediately.
        command_tx.send(DapCommand::Continue).unwrap();

        wrapper.on_error("boom", &context);

        let received_message = message_rx.try_recv().unwrap();
        match received_message {
            DebuggerMessage::ExceptionPaused { thread_id, message, .. } => {
                assert_eq!(thread_id, 1);
                assert_eq!(message, "boom");
            }
            _ => panic!("Expected ExceptionPaused message"),
        }
    }

    #[test]
    fn test_on_error_recv_error_does_not_panic() {
        let (message_tx, _message_rx) = unbounded::<DebuggerMessage>();
        let (command_tx, command_rx) = unbounded::<DapCommand>();

        let handler = DapDebuggerHandler::new(message_tx);
        let wrapper = DapHandlerWrapper::new(handler, command_rx, Arc::new(AtomicBool::new(true)));

        let context = mq_lang::DebugContext::default();

        // Don't send any command, so recv will fail once command_tx is dropped.
        drop(command_tx);

        wrapper.on_error("boom", &context);
    }
}