call-graph-cli 0.4.0

Interactive call and type hierarchy TUI
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

use crate::{
    config::SymbolFilter,
    fetch::CachePolicy,
    state::{HierarchyDirection, LoadState},
};

use super::{App, HierarchyLoadRequest};

impl App {
    pub fn set_symbol_filter(&mut self, symbol_filter: SymbolFilter) {
        self.symbol_filter = symbol_filter;
    }

    pub fn reload_symbol_filter(
        &mut self,
        symbol_filter: SymbolFilter,
        hierarchy_available: bool,
    ) -> Vec<HierarchyLoadRequest> {
        self.symbol_filter = symbol_filter;
        let mut targets = Vec::new();
        for node_id in self.graph.known_graph().nodes {
            let Some(node) = self.graph.node(node_id) else {
                continue;
            };
            for direction in [HierarchyDirection::Incoming, HierarchyDirection::Outgoing] {
                if matches!(
                    node.branch(direction).load_state,
                    LoadState::Loaded | LoadState::Loading
                ) {
                    targets.push((node_id, node.identity(), direction));
                }
            }
        }

        if !hierarchy_available {
            self.set_canvas_notice(
                "Project config reloaded; graph refresh requires an analysis provider".to_owned(),
            );
            return Vec::new();
        }

        let requests = targets
            .into_iter()
            .filter_map(|(node_id, identity, direction)| {
                self.begin_hierarchy_load(node_id, identity, direction, CachePolicy::Refresh, false)
            })
            .collect::<Vec<_>>();
        self.set_canvas_notice(if requests.is_empty() {
            "Project config reloaded; no loaded graph branches to refresh".to_owned()
        } else {
            format!(
                "Project config reloaded; refreshing {} graph branches",
                requests.len()
            )
        });
        requests
    }
}

#[cfg(test)]
mod tests {
    use clap::Parser;

    use super::super::App;
    use crate::{
        cli::Cli,
        config::SymbolFilter,
        fetch::{FetchSource, HierarchyResponse},
        state::{HierarchyDirection, HierarchyKind, NodeId, SourceLocation, SymbolIdentity},
    };

    #[test]
    fn reloads_filters_across_loaded_branches_and_supersedes_old_requests() {
        let mut app = App::from_cli(Cli::try_parse_from(["cgraph", "call", "root"]).unwrap());
        for direction in [HierarchyDirection::Incoming, HierarchyDirection::Outgoing] {
            let request = app.toggle_selected_branch(direction, true).unwrap();
            assert!(app.finish_hierarchy(&request, Ok(response(&request, Vec::new()))));
        }
        let stale = app.refresh_selected_branches(true);

        let current =
            app.reload_symbol_filter(SymbolFilter::from_patterns(["noise"]).unwrap(), true);

        assert_eq!(current.len(), 2);
        assert!(current.iter().all(|request| {
            stale
                .iter()
                .find(|stale| stale.query.direction == request.query.direction)
                .is_some_and(|stale| stale.request_id != request.request_id)
        }));
        assert!(!app.finish_hierarchy(&stale[0], Ok(response(&stale[0], vec![identity("stale")]))));
        for request in &current {
            assert!(app.finish_hierarchy(
                request,
                Ok(response(request, vec![identity("noise"), identity("keep")]))
            ));
        }
        let root = app.selected.unwrap();
        assert_eq!(
            branch_names(&app, root, HierarchyDirection::Incoming),
            ["keep"]
        );
        assert_eq!(
            branch_names(&app, root, HierarchyDirection::Outgoing),
            ["keep"]
        );
        assert!(app.graph.is_anchor(root));
    }

    fn response(
        request: &super::HierarchyLoadRequest,
        children: Vec<SymbolIdentity>,
    ) -> HierarchyResponse {
        HierarchyResponse {
            query: request.query.clone(),
            children,
            source: FetchSource::Lsp,
        }
    }

    fn identity(symbol: &str) -> SymbolIdentity {
        SymbolIdentity {
            symbol: symbol.to_owned(),
            kind: HierarchyKind::Call,
            location: Some(SourceLocation {
                uri: format!("file:///workspace/{symbol}.rs"),
                line: Some(0),
                character: Some(0),
            }),
        }
    }

    fn branch_names(app: &App, node_id: NodeId, direction: HierarchyDirection) -> Vec<&str> {
        app.graph
            .node(node_id)
            .unwrap()
            .branch(direction)
            .neighbors
            .iter()
            .map(|neighbor| app.graph.node(*neighbor).unwrap().symbol.as_str())
            .collect()
    }
}