perl-dap 0.13.3

Debug Adapter Protocol server for Perl
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
//! Execution control: continue, next, step in, step out, pause, goto, cancel.

use super::*;
use regex::Regex;
use std::sync::LazyLock;

static STEP_IN_TARGET_CALL_RE: LazyLock<Option<Regex>> =
    LazyLock::new(|| Regex::new(r"(\w[\w:]*)\s*\(").ok());

impl DebugAdapter {
    /// Handle continue request
    pub(super) fn handle_continue(
        &self,
        seq: i64,
        request_seq: i64,
        arguments: Option<Value>,
    ) -> DapMessage {
        let _args: Option<ContinueArguments> =
            arguments.and_then(|v| serde_json::from_value(v).ok());

        let mut thread_id = 1;
        if let Some(ref mut session) = *lock_or_recover(&self.session, "debug_adapter.session")
            && let Some(stdin) = session.process.stdin.as_mut()
        {
            let _ = stdin.write_all(b"c\n");
            let _ = stdin.flush();
            session.state = DebugState::Running;
            session.last_resume_mode = ResumeMode::Continue;
            session.variable_cache.clear();
            thread_id = session.thread_id;
        } else if let Some(pid) = *lock_or_recover(&self.attached_pid, "debug_adapter.attached_pid")
        {
            let _ = self.send_continue_signal(pid);
            thread_id = Self::i64_to_i32_saturating(i64::from(pid));
        }

        // AC9.4: Proper DAP event emission: continued
        self.send_event(
            "continued",
            Some(json!({
                "threadId": thread_id,
                "allThreadsContinued": true
            })),
        );

        let continue_body = ContinueResponseBody { all_threads_continued: true };

        DapMessage::Response {
            seq,
            request_seq,
            success: true,
            command: "continue".to_string(),
            body: serde_json::to_value(&continue_body).ok(),
            message: None,
        }
    }

    /// Handle next request
    pub(super) fn handle_next(
        &self,
        seq: i64,
        request_seq: i64,
        arguments: Option<Value>,
    ) -> DapMessage {
        let _args: Option<NextArguments> = arguments.and_then(|v| serde_json::from_value(v).ok());
        if let Some(ref mut session) = *lock_or_recover(&self.session, "debug_adapter.session")
            && let Some(stdin) = session.process.stdin.as_mut()
        {
            let _ = stdin.write_all(b"n\n");
            let _ = stdin.flush();
            session.state = DebugState::Running;
            session.last_resume_mode = ResumeMode::Next;
            session.variable_cache.clear();
            let t_id = session.thread_id;
            self.send_event(
                "continued",
                Some(json!({
                    "threadId": t_id,
                    "allThreadsContinued": true
                })),
            );
        }

        DapMessage::Response {
            seq,
            request_seq,
            success: true,
            command: "next".to_string(),
            body: None,
            message: None,
        }
    }

    /// Handle stepIn request
    pub(super) fn handle_step_in(
        &self,
        seq: i64,
        request_seq: i64,
        arguments: Option<Value>,
    ) -> DapMessage {
        let _args: Option<StepInArguments> = arguments.and_then(|v| serde_json::from_value(v).ok());
        if let Some(ref mut session) = *lock_or_recover(&self.session, "debug_adapter.session")
            && let Some(stdin) = session.process.stdin.as_mut()
        {
            let _ = stdin.write_all(b"s\n");
            let _ = stdin.flush();
            session.state = DebugState::Running;
            session.last_resume_mode = ResumeMode::StepIn;
            session.variable_cache.clear();
            let t_id = session.thread_id;
            self.send_event(
                "continued",
                Some(json!({
                    "threadId": t_id,
                    "allThreadsContinued": true
                })),
            );
        }

        DapMessage::Response {
            seq,
            request_seq,
            success: true,
            command: "stepIn".to_string(),
            body: None,
            message: None,
        }
    }

    /// Handle stepOut request
    pub(super) fn handle_step_out(
        &self,
        seq: i64,
        request_seq: i64,
        arguments: Option<Value>,
    ) -> DapMessage {
        let _args: Option<StepOutArguments> =
            arguments.and_then(|v| serde_json::from_value(v).ok());
        if let Some(ref mut session) = *lock_or_recover(&self.session, "debug_adapter.session")
            && let Some(stdin) = session.process.stdin.as_mut()
        {
            let _ = stdin.write_all(b"r\n");
            let _ = stdin.flush();
            session.state = DebugState::Running;
            session.last_resume_mode = ResumeMode::StepOut;
            session.variable_cache.clear();
            let t_id = session.thread_id;
            self.send_event(
                "continued",
                Some(json!({
                    "threadId": t_id,
                    "allThreadsContinued": true
                })),
            );
        }

        DapMessage::Response {
            seq,
            request_seq,
            success: true,
            command: "stepOut".to_string(),
            body: None,
            message: None,
        }
    }

    /// Handle pause request
    pub(super) fn handle_pause(
        &self,
        seq: i64,
        request_seq: i64,
        arguments: Option<Value>,
    ) -> DapMessage {
        let _args: Option<PauseArguments> = arguments.and_then(|v| serde_json::from_value(v).ok());
        let success = if let Some(ref mut session) =
            *lock_or_recover(&self.session, "debug_adapter.session")
        {
            let pid = session.process.id();
            session.variable_cache.clear();
            self.send_interrupt_signal(pid)
        } else if let Some(pid) = *lock_or_recover(&self.attached_pid, "debug_adapter.attached_pid")
        {
            self.send_interrupt_signal(pid)
        } else {
            tracing::warn!("No active debug session to pause");
            false
        };

        DapMessage::Response {
            seq,
            request_seq,
            success,
            command: "pause".to_string(),
            body: None,
            message: if !success { Some("Failed to pause debugger".to_string()) } else { None },
        }
    }

    pub(super) fn handle_goto_targets(
        &self,
        seq: i64,
        request_seq: i64,
        arguments: Option<Value>,
    ) -> DapMessage {
        let args: GotoTargetsArguments =
            match arguments.and_then(|v| serde_json::from_value(v).ok()) {
                Some(a) => a,
                None => {
                    return DapMessage::Response {
                        seq,
                        request_seq,
                        success: false,
                        command: "gotoTargets".to_string(),
                        body: None,
                        message: Some("Missing or invalid arguments".to_string()),
                    };
                }
            };

        let source_path = match args.source.path {
            Some(ref p) => p.clone(),
            None => {
                let body = GotoTargetsResponseBody { targets: Vec::new() };
                return DapMessage::Response {
                    seq,
                    request_seq,
                    success: true,
                    command: "gotoTargets".to_string(),
                    body: serde_json::to_value(&body).ok(),
                    message: None,
                };
            }
        };

        // Validate path against workspace root to prevent path traversal
        let validated_path = match self.validate_source_path(&source_path) {
            Ok(p) => p,
            Err(e) => {
                return DapMessage::Response {
                    seq,
                    request_seq,
                    success: false,
                    command: "gotoTargets".to_string(),
                    body: None,
                    message: Some(e),
                };
            }
        };

        let content = match std::fs::read_to_string(&validated_path) {
            Ok(c) => c,
            Err(_) => {
                let body = GotoTargetsResponseBody { targets: Vec::new() };
                return DapMessage::Response {
                    seq,
                    request_seq,
                    success: true,
                    command: "gotoTargets".to_string(),
                    body: serde_json::to_value(&body).ok(),
                    message: None,
                };
            }
        };

        // Clear stale goto target mappings and build fresh ones
        let mut goto_map = lock_or_recover(&self.goto_targets, "debug_adapter.goto_targets");
        goto_map.clear();
        let mut id_counter =
            lock_or_recover(&self.next_goto_target_id, "debug_adapter.next_goto_target_id");

        let mut targets = Vec::new();
        let search_start = (args.line - 5).max(1);
        let search_end = args.line + 5;

        if let Ok(validator) = AstBreakpointValidator::new(&content) {
            for line in search_start..=search_end {
                if self.cancel_requested.load(Ordering::Acquire) {
                    self.cancel_requested.store(false, Ordering::Release);
                    break;
                }
                if validator.is_executable_line(line) {
                    let id = *id_counter;
                    *id_counter += 1;
                    goto_map.insert(id, (source_path.clone(), line));
                    targets.push(GotoTarget {
                        id,
                        label: format!("Line {}", line),
                        line,
                        column: None,
                        end_line: None,
                        end_column: None,
                    });
                }
            }
        }
        drop(goto_map);
        drop(id_counter);

        let body = GotoTargetsResponseBody { targets };
        DapMessage::Response {
            seq,
            request_seq,
            success: true,
            command: "gotoTargets".to_string(),
            body: serde_json::to_value(&body).ok(),
            message: None,
        }
    }

    pub(super) fn handle_goto(
        &self,
        seq: i64,
        request_seq: i64,
        arguments: Option<Value>,
    ) -> DapMessage {
        let args: GotoArguments = match arguments.and_then(|v| serde_json::from_value(v).ok()) {
            Some(a) => a,
            None => {
                return DapMessage::Response {
                    seq,
                    request_seq,
                    success: false,
                    command: "goto".to_string(),
                    body: None,
                    message: Some("Missing or invalid arguments".to_string()),
                };
            }
        };

        // Look up the goto target from our stored mapping
        let target_info = {
            let mut goto_map = lock_or_recover(&self.goto_targets, "debug_adapter.goto_targets");
            goto_map.remove(&args.target_id)
        };
        let (target_path, target_line) = match target_info {
            Some(info) => info,
            None => {
                return DapMessage::Response {
                    seq,
                    request_seq,
                    success: false,
                    command: "goto".to_string(),
                    body: None,
                    message: Some(format!("Unknown goto target id {}", args.target_id)),
                };
            }
        };

        if let Some(ref mut session) = *lock_or_recover(&self.session, "debug_adapter.session")
            && let Some(stdin) = session.process.stdin.as_mut()
        {
            // Set debugger file context for cross-file goto
            let file_cmd = format!("f {}\n", target_path);
            let _ = stdin.write_all(file_cmd.as_bytes());
            let _ = stdin.flush();
            let goto_cmd = format!("c {}\n", target_line);
            let _ = stdin.write_all(goto_cmd.as_bytes());
            let _ = stdin.flush();
            session.state = DebugState::Running;
            session.last_resume_mode = ResumeMode::Goto;
            session.variable_cache.clear();
            let t_id = session.thread_id;

            self.send_event(
                "continued",
                Some(json!({
                    "threadId": t_id,
                    "allThreadsContinued": true
                })),
            );

            DapMessage::Response {
                seq,
                request_seq,
                success: true,
                command: "goto".to_string(),
                body: None,
                message: None,
            }
        } else {
            DapMessage::Response {
                seq,
                request_seq,
                success: false,
                command: "goto".to_string(),
                body: None,
                message: Some("No active debug session".to_string()),
            }
        }
    }

    pub(super) fn handle_step_in_targets(
        &self,
        seq: i64,
        request_seq: i64,
        arguments: Option<Value>,
    ) -> DapMessage {
        let args: StepInTargetsArguments =
            match arguments.and_then(|v| serde_json::from_value(v).ok()) {
                Some(a) => a,
                None => {
                    return DapMessage::Response {
                        seq,
                        request_seq,
                        success: false,
                        command: "stepInTargets".to_string(),
                        body: None,
                        message: Some("Missing or invalid arguments".to_string()),
                    };
                }
            };

        let mut targets = Vec::new();

        // Extract the frame source path while session lock is held, then release.
        let frame_info = {
            let session_guard = lock_or_recover(&self.session, "debug_adapter.session");
            if let Some(ref session) = *session_guard {
                session
                    .stack_frames
                    .iter()
                    .find(|f| i64::from(f.id) == args.frame_id)
                    .map(|frame| (frame.source.path.clone(), frame.line))
            } else {
                None
            }
        };

        if let Some((source_path, frame_line)) = frame_info {
            // Defense-in-depth: validate even internal session paths
            if let Ok(validated_path) = self.validate_source_path(&source_path) {
                if let Ok(content) = std::fs::read_to_string(&validated_path) {
                    let line_idx = frame_line as usize;
                    if let Some(source_line) = content.lines().nth(line_idx.saturating_sub(1)) {
                        // Find function call patterns
                        if let Some(call_re) = STEP_IN_TARGET_CALL_RE.as_ref() {
                            for (idx, cap) in call_re.captures_iter(source_line).enumerate() {
                                if let Some(name) = cap.get(1) {
                                    targets.push(StepInTarget {
                                        id: idx as i64,
                                        label: name.as_str().to_string(),
                                    });
                                }
                            }
                        }
                    }
                }
            }
        }

        let body = StepInTargetsResponseBody { targets };
        DapMessage::Response {
            seq,
            request_seq,
            success: true,
            command: "stepInTargets".to_string(),
            body: serde_json::to_value(&body).ok(),
            message: None,
        }
    }

    pub(super) fn handle_cancel(
        &self,
        seq: i64,
        request_seq: i64,
        _arguments: Option<Value>,
    ) -> DapMessage {
        // cancel_requested field will be added by the integration task
        self.cancel_requested.store(true, Ordering::Release);
        DapMessage::Response {
            seq,
            request_seq,
            success: true,
            command: "cancel".to_string(),
            body: None,
            message: None,
        }
    }

    pub(super) fn handle_restart_frame(
        &self,
        seq: i64,
        request_seq: i64,
        _arguments: Option<Value>,
    ) -> DapMessage {
        DapMessage::Response {
            seq,
            request_seq,
            success: false,
            command: "restartFrame".to_string(),
            body: None,
            message: Some(
                "Perl does not support restarting execution from a specific stack frame"
                    .to_string(),
            ),
        }
    }

    pub(super) fn handle_terminate_threads(
        &self,
        seq: i64,
        request_seq: i64,
        _arguments: Option<Value>,
    ) -> DapMessage {
        DapMessage::Response {
            seq,
            request_seq,
            success: false,
            command: "terminateThreads".to_string(),
            body: None,
            message: Some(
                "Perl threading model does not support targeted thread termination from the debugger"
                    .to_string(),
            ),
        }
    }
}