dbg-cli 0.3.1

A universal debugger CLI that lets AI agents observe runtime state instead of guessing from source code
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

//! Go symbol canonicalization.
//!
//! Go emits frames in forms like:
//!   * `main.handleRequest`
//!   * `main.(*Server).handleRequest`              — pointer receiver
//!   * `main.Server.handleRequest`                 — value receiver
//!   * `main.handleRequest.func1`                  — closure inside func
//!   * `github.com/foo/bar.(*Client).Do`           — full import path
//!   * `runtime.goexit`                            — runtime built-ins
//!   * `type:.eq.[...]`                            — auto-generated
//!
//! Canonical form preserves pointer-vs-value receiver distinction
//! (they're different methods in Go). Closures (`.func1`, `.func2`) are
//! flagged synthetic — their numeric suffix isn't stable across edits.

use super::{CanonicalSymbol, Canonicalizer};

pub struct GoCanonicalizer;

impl Canonicalizer for GoCanonicalizer {
    fn lang(&self) -> &'static str {
        "go"
    }

    fn canonicalize(&self, raw: &str) -> CanonicalSymbol {
        let synthetic = is_synthetic(raw);
        CanonicalSymbol {
            lang: "go",
            fqn: raw.to_string(),
            file: None,
            line: None,
            demangled: None,
            raw: raw.to_string(),
            is_synthetic: synthetic,
        }
    }
}

fn is_synthetic(s: &str) -> bool {
    // `.func1`, `.func2`, ... — compiler-generated closure names.
    // They're the only common synthetic form; everything else is the
    // user's symbol verbatim.
    if let Some(tail) = s.rsplit('.').next() {
        if let Some(rest) = tail.strip_prefix("func") {
            if !rest.is_empty() && rest.chars().all(|c| c.is_ascii_digit()) {
                return true;
            }
        }
    }
    // Auto-generated type equality / hash helpers.
    s.starts_with("type:.eq.") || s.starts_with("type:.hash.")
}

#[cfg(test)]
mod tests {
    use super::*;

    fn g() -> GoCanonicalizer { GoCanonicalizer }

    #[test]
    fn plain_function_preserved() {
        let s = g().canonicalize("main.handleRequest");
        assert_eq!(s.fqn, "main.handleRequest");
        assert_eq!(s.lang, "go");
        assert!(!s.is_synthetic);
    }

    #[test]
    fn pointer_and_value_receivers_distinct() {
        let ptr = g().canonicalize("main.(*Server).handleRequest");
        let val = g().canonicalize("main.Server.handleRequest");
        assert_ne!(ptr.fqn, val.fqn);
    }

    #[test]
    fn full_import_path_preserved() {
        let s = g().canonicalize("github.com/foo/bar.(*Client).Do");
        assert_eq!(s.fqn, "github.com/foo/bar.(*Client).Do");
    }

    #[test]
    fn numeric_closure_is_synthetic() {
        let s = g().canonicalize("main.handleRequest.func1");
        assert!(s.is_synthetic, "{s:?}");
    }

    #[test]
    fn multidigit_closure_is_synthetic() {
        let s = g().canonicalize("main.handleRequest.func42");
        assert!(s.is_synthetic);
    }

    #[test]
    fn func_in_name_is_not_synthetic() {
        // `.func` alone (no digit) should NOT be considered synthetic —
        // a user could legitimately name a method `func`.
        let s = g().canonicalize("pkg.Service.func");
        assert!(!s.is_synthetic);
    }

    #[test]
    fn runtime_symbol_not_synthetic() {
        let s = g().canonicalize("runtime.goexit");
        assert!(!s.is_synthetic);
    }

    #[test]
    fn type_eq_synthetic() {
        let s = g().canonicalize("type:.eq.[1024]uint8");
        assert!(s.is_synthetic);
    }

    #[test]
    fn key_is_lang_plus_fqn() {
        let s = g().canonicalize("main.f");
        assert_eq!(s.key(), ("go", "main.f"));
    }
}