source-mesh-core 1.2.0

Rust dependency graph analysis, diagrams, and cycle reports
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
use std::fmt::Write as _;
use std::num::NonZeroUsize;

use anyhow::Context as _;
use anyhow::Result;

use super::markdown::inline_code;
use crate::cycle_presentation::group_color;
use crate::cycles::CycleAnalysis;
use crate::model::FileNode;
use crate::model::FolderNode;

pub const NO_CYCLES_FOUND: &str = "No cycles found.";

pub fn folder_report(analysis: &CycleAnalysis<FolderNode>, limit: NonZeroUsize) -> Result<String> {
    Ok(format!(
        "# Folder dependency cycles\n\n\
        These cycles belong to the final folder graph, after root filtering and depth folding. \
        Folder aggregation can introduce cycles even when the file graph is acyclic.\n\n{}",
        render_cycles(analysis, limit, |node| Ok(node.label().as_str()))?
    ))
}

pub fn file_report(analysis: &CycleAnalysis<FileNode>, limit: NonZeroUsize) -> Result<String> {
    Ok(format!(
        "# File dependency cycles\n\n\
        These cycles belong to the file graph before folder aggregation; folder depth does not apply. \
        Paths are relative to the indexed project, including their complete folder hierarchy.\n\n{}",
        render_cycles(analysis, limit, |node| node.path().to_str().context("Cycle file path is not UTF-8"))?
    ))
}

fn render_cycles<Node: Clone + Ord>(
    analysis: &CycleAnalysis<Node>,
    limit: NonZeroUsize,
    label: impl Fn(&Node) -> Result<&str>,
) -> Result<String> {
    let cycles = analysis.cycles(limit)?;
    if cycles.is_empty() {
        return Ok(format!("{NO_CYCLES_FOUND}\n"));
    }
    let mut output = String::new();
    let mut previous_group = None;
    for cycle in &cycles {
        let group = cycle.group();
        if previous_group != Some(group) {
            if previous_group.is_some() {
                output.push('\n');
            }
            let color = group_color(group, analysis.group_count());
            write!(output, "## C{} ({color})\n\n", group.number())
                .unwrap_or_else(|_| unreachable!("Formatting a cycle heading into a String cannot fail"));
            previous_group = Some(group);
        }
        output.push_str("- ");
        for (index, node) in cycle.nodes().iter().enumerate() {
            if index != 0 {
                output.push_str(" -> ");
            }
            output.push_str(&inline_code(label(node)?));
        }
        output.push('\n');
    }
    Ok(output)
}

#[cfg(test)]
mod tests {
    use std::collections::BTreeMap;
    use std::collections::BTreeSet;
    use std::num::NonZeroUsize;
    use std::path::Path;

    use anyhow::Context as _;
    use anyhow::Result;
    use claims::assert_ok;
    use claims::assert_some;
    use pretty_assertions::assert_eq;
    use rstest::rstest;

    use super::NO_CYCLES_FOUND;
    use super::file_report;
    use super::folder_report;
    use crate::SourcePath;
    use crate::cycle_presentation::group_color;
    use crate::cycles::analyze_files;
    use crate::cycles::analyze_folders;
    use crate::model::DependencyCount;
    use crate::model::DependencyKind;
    use crate::model::FileEdge;
    use crate::model::FileGraph;
    use crate::model::FileNode;
    use crate::model::FolderEdge;
    use crate::model::FolderGraph;
    use crate::model::FolderNode;

    #[test]
    fn test_cycle_group_diagram_colors() {
        let nodes = BTreeSet::from([FolderNode::new("api".into()), FolderNode::new("storage".into())]);
        let dependencies: BTreeMap<_, _> = nodes.iter().map(|node| {
            let edge = FolderEdge::new(node.clone(), node.clone(), DependencyKind::Production);
            (edge, DependencyCount::new(1))
        }).collect();
        let fixture = FolderGraph::new(nodes, dependencies);
        let fixture = assert_ok!(fixture, "Independent self-loop folders must form a valid graph");
        let analysis = analyze_folders(&fixture);
        let analysis = assert_ok!(analysis, "Independent self-loop folders must support cycle analysis");
        let system_under_test = folder_report;

        let output = system_under_test(&analysis, NonZeroUsize::MAX);
        let output = assert_ok!(output, "Cycle report must render independent self-loop groups");

        let cycles = analysis.cycles(NonZeroUsize::MAX);
        let cycles = assert_ok!(cycles, "Both independent self-loop cycles must be enumerable");
        for cycle in cycles {
            let group = cycle.group();
            let color = group_color(group, analysis.group_count()).to_string();
            let heading = format!("## C{} ({color})", group.number());
            assert!(output.contains(&heading), "Cycle report color differs from the diagram palette");
            assert!(color.starts_with('#') && color.len() == 7, "Cycle report color must use six-digit hexadecimal RGB");
        }
    }

    enum ReportKind {
        Folder,
        File,
    }

    fn folder_fixture(dependencies: &[(&str, &str)]) -> Result<FolderGraph> {
        let nodes = dependencies.iter().flat_map(|&(source, target)| {
            [FolderNode::new(source.into()), FolderNode::new(target.into())]
        }).collect();
        let edges = dependencies.iter().map(|&(source, target)| {
            let source = FolderNode::new(source.into());
            let edge = FolderEdge::new(source, FolderNode::new(target.into()), DependencyKind::Production);
            (edge, DependencyCount::new(1))
        }).collect();
        FolderGraph::new(nodes, edges)
    }

    fn file_fixture(dependencies: &[(&FileNode, &FileNode)]) -> Result<FileGraph> {
        let nodes = dependencies.iter().flat_map(|&(source, target)| [source.clone(), target.clone()]).collect();
        let edges = dependencies.iter().map(|&(source, target)| {
            FileEdge::new(source.clone(), target.clone(), DependencyKind::Production)
        }).collect();
        FileGraph::new(nodes, edges)
    }

    fn overlapping_folder_fixture() -> Result<FolderGraph> {
        folder_fixture(&[("api", "domain"), ("domain", "api"), ("domain", "storage"), ("storage", "api")])
    }

    fn report_chains(report: &str) -> Result<Vec<Vec<String>>> {
        let cycle_lines = report.lines().filter(|line| line.starts_with("- "));
        cycle_lines.map(|line| {
            let cycle_markup = format!("<cycle>{line}</cycle>");
            let cycle = roxmltree::Document::parse(&cycle_markup)?;
            let nodes = cycle.descendants().filter(|node| node.has_tag_name("code"));
            nodes.map(|node| Ok(node.text().context("Cycle node label is missing")?.to_owned())).collect()
        }).collect()
    }

    #[rstest]
    #[case::self_loop(
        &[("api", "api")],
        "- <code>api</code> -> <code>api</code>",
    )]
    #[case::two_nodes(
        &[("api", "domain"), ("domain", "api")],
        "- <code>api</code> -> <code>domain</code> -> <code>api</code>",
    )]
    #[case::three_nodes(
        &[("api", "domain"), ("domain", "storage"), ("storage", "api")],
        "- <code>api</code> -> <code>domain</code> -> <code>storage</code> -> <code>api</code>",
    )]
    fn test_cycle_chain_separators(#[case] dependencies: &[(&str, &str)], #[case] expected: &str) {
        let fixture = folder_fixture(dependencies);
        let fixture = assert_ok!(fixture, "Cycle-chain dependencies must form a valid folder graph");
        let analysis = analyze_folders(&fixture);
        let analysis = assert_ok!(analysis, "Cycle-chain graph must support analysis");
        let system_under_test = folder_report;

        let output = system_under_test(&analysis, NonZeroUsize::MAX);
        let output = assert_ok!(output, "Cycle-chain report must render every node and separator");
        let chains: Vec<_> = output.lines().filter(|line| line.starts_with("- ")).collect();

        assert_eq!(chains, vec![expected], "Arrows must separate every adjacent node, including the cycle closure");
    }

    #[test]
    fn test_folder_closed_chains_on_separate_lines() {
        let fixture = overlapping_folder_fixture();
        let fixture = assert_ok!(fixture, "Overlapping folder cycles must form a valid graph");
        let analysis = analyze_folders(&fixture);
        let analysis = assert_ok!(analysis, "Overlapping folder cycles must support analysis");
        let system_under_test = folder_report;

        let output = system_under_test(&analysis, NonZeroUsize::MAX);
        let output = assert_ok!(output, "Report must render every overlapping folder cycle");
        let chains = report_chains(&output);
        let chains = assert_ok!(chains, "Overlapping-cycle report must contain parseable node labels");

        assert_eq!(
            vec![
                vec![String::from("api"), String::from("domain"), String::from("api")],
                vec![String::from("api"), String::from("domain"), String::from("storage"), String::from("api")],
            ],
            chains,
            "Report did not preserve both complete closed chains: {chains:?}"
        );
        assert_eq!(1, output.lines().filter(|line| line.starts_with("## ")).count(), "Connected cycles must share one group");
    }

    #[test]
    fn test_cycle_group_sections() {
        let fixture = folder_fixture(&[("api", "domain"), ("domain", "api"), ("queue", "storage"), ("storage", "queue")]);
        let fixture = assert_ok!(fixture, "Two independent cycle groups must form a valid folder graph");
        let analysis = analyze_folders(&fixture);
        let analysis = assert_ok!(analysis, "Independent folder cycles must support analysis");
        let system_under_test = folder_report;

        let output = system_under_test(&analysis, NonZeroUsize::MAX);
        let output = assert_ok!(output, "Report must render both independent cycle groups");
        let sections = output.split_once("## C2 (");
        let (first_section, last_section) = assert_some!(sections, "Report must contain a second cycle group");
        let first_chains = report_chains(first_section);
        let first_chains = assert_ok!(first_chains, "First cycle-group section must contain parseable labels");
        let last_chains = report_chains(last_section);
        let last_chains = assert_ok!(last_chains, "Second cycle-group section must contain parseable labels");

        assert!(first_section.contains("## C1 ("), "First cycle group is missing");
        let first_expected = vec![vec![String::from("api"), String::from("domain"), String::from("api")]];
        assert_eq!(first_expected, first_chains, "First group contains incorrect chains");
        let last_expected = vec![vec![String::from("queue"), String::from("storage"), String::from("queue")]];
        assert_eq!(last_expected, last_chains, "Second group contains incorrect chains");
    }

    #[rstest]
    #[case(
        "unsafe`<>&\n\r\t",
        "unsafe&#96;&lt;&gt;&amp;&#92;n&#92;r&#92;t",
    )]
    #[case(
        "unsafe*[link]_\\~|",
        "unsafe&#42;&#91;link&#93;&#95;&#92;&#126;&#124;",
    )]
    #[case(
        "unsafe\n## injected\n<script>alert(1)</script>",
        "unsafe&#92;n## injected&#92;n&lt;script&gt;alert(1)&lt;/script&gt;",
    )]
    fn test_folder_label_markdown_escaping(#[case] label: &str, #[case] escaped: &str) {
        let fixture = folder_fixture(&[(label, "safe"), ("safe", label)]);
        let fixture = assert_ok!(fixture, "Folder labels containing Markdown must be valid graph labels");
        let analysis = analyze_folders(&fixture);
        let analysis = assert_ok!(analysis, "Markdown in folder labels must not prevent cycle analysis");
        let system_under_test = folder_report;

        let output = system_under_test(&analysis, NonZeroUsize::MAX);
        let output = assert_ok!(output, "Report must render escaped folder labels");
        let chains = report_chains(&output);
        let chains = assert_ok!(chains, "Escaped folder labels must remain parseable report markup");

        assert!(output.contains(&format!("<code>{escaped}</code>")), "Folder label escaped incorrectly: {output}");
        assert_eq!(1, chains.len(), "A label changed the number of cycle lines");
        assert_eq!(1, output.lines().filter(|line| line.starts_with("## ")).count(), "A label injected a group heading");
        assert!(!output.contains("<script>"), "A label injected HTML markup");
    }

    #[rstest]
    #[case(ReportKind::Folder)]
    #[case(ReportKind::File)]
    fn test_empty_cycle_report(#[case] kind: ReportKind) {
        let folder_analysis = analyze_folders(&FolderGraph::default());
        let folder_analysis = assert_ok!(folder_analysis, "Empty folder graph must support cycle analysis");
        let file_graph = FileGraph::new(BTreeSet::new(), BTreeSet::new());
        let file_graph = assert_ok!(file_graph, "Empty file graph must be valid");
        let file_analysis = analyze_files(&file_graph);
        let file_analysis = assert_ok!(file_analysis, "Empty file graph must support cycle analysis");

        let output = match kind {
            ReportKind::Folder => folder_report(&folder_analysis, NonZeroUsize::MAX),
            ReportKind::File => file_report(&file_analysis, NonZeroUsize::MAX),
        };
        let output = assert_ok!(output, "An empty graph must produce a cycle report");
        let chains = report_chains(&output);
        let chains = assert_ok!(chains, "Empty cycle report must be parseable");

        assert_eq!(Some(NO_CYCLES_FOUND), output.lines().last(), "Empty report must explicitly describe the absence of cycles");
        assert!(chains.is_empty(), "Empty report contains a cycle chain");
        assert!(!output.lines().any(|line| line.starts_with("## ")), "Empty report contains a cycle group");
    }

    #[test]
    fn test_file_cycle_complete_project_paths() {
        let service_path = SourcePath::new(Path::new("src").join("api").join("deep").join("service.rs"));
        let service_path = assert_ok!(service_path, "Nested service path must be a valid source path");
        let service = FileNode::new(service_path);
        let database_path = SourcePath::new(Path::new("src").join("storage").join("database.rs"));
        let database_path = assert_ok!(database_path, "Database path must be a valid source path");
        let database = FileNode::new(database_path);
        let fixture = file_fixture(&[(&service, &database), (&database, &service)]);
        let fixture = assert_ok!(fixture, "Service/database cycle must form a valid file graph");
        let analysis = analyze_files(&fixture);
        let analysis = assert_ok!(analysis, "Service/database graph must support cycle analysis");
        let service_path_text = service.path().to_str();
        let service_path_text = assert_some!(service_path_text, "Service fixture path must be UTF-8");
        let database_path_text = database.path().to_str();
        let database_path_text = assert_some!(database_path_text, "Database fixture path must be UTF-8");
        let expected_chain = vec![service_path_text.to_owned(), database_path_text.to_owned(), service_path_text.to_owned()];
        let system_under_test = file_report;

        let output = system_under_test(&analysis, NonZeroUsize::MAX);
        let output = assert_ok!(output, "File cycle report must render complete project-relative paths");
        let chains = report_chains(&output);
        let chains = assert_ok!(chains, "File cycle report must contain parseable paths");

        assert_eq!(vec![expected_chain], chains, "File report changed project-relative source paths or omitted cycle closure");
    }

    #[test]
    fn test_file_path_markdown_escaping() {
        let service_path = SourcePath::new(Path::new("src").join("unsafe`<>&\n.rs"));
        let service_path = assert_ok!(service_path, "Markdown characters must be allowed in a lexical source path");
        let service = FileNode::new(service_path);
        let database_path = SourcePath::new(Path::new("src").join("database.rs"));
        let database_path = assert_ok!(database_path, "Database fixture path must be valid");
        let database = FileNode::new(database_path);
        let fixture = file_fixture(&[(&service, &database), (&database, &service)]);
        let fixture = assert_ok!(fixture, "Files with Markdown characters must form a valid graph");
        let analysis = analyze_files(&fixture);
        let analysis = assert_ok!(analysis, "Markdown in file paths must not prevent cycle analysis");
        let system_under_test = file_report;

        let output = system_under_test(&analysis, NonZeroUsize::MAX);
        let output = assert_ok!(output, "File report must render escaped Markdown characters");
        let chains = report_chains(&output);
        let chains = assert_ok!(chains, "Escaped file paths must remain parseable report markup");

        assert!(output.contains("unsafe&#96;&lt;&gt;&amp;&#92;n.rs</code>"), "File path markup or newline was not escaped");
        assert_eq!(1, chains.len(), "File path introduced another report line");
    }

    #[rstest]
    #[case(None, vec![])]
    #[case(Some(1), vec![vec!["api", "domain", "api"]])]
    fn test_folder_aggregation_cycle_without_file_cycle(#[case] depth: Option<usize>, #[case] expected_chains: Vec<Vec<&str>>) {
        let service_path = SourcePath::new(Path::new("src").join("api").join("service.rs"));
        let service_path = assert_ok!(service_path, "Service fixture path must be valid");
        let service = FileNode::new(service_path);
        let request_path = SourcePath::new(Path::new("src").join("domain").join("deep").join("request.rs"));
        let request_path = assert_ok!(request_path, "Nested request fixture path must be valid");
        let request = FileNode::new(request_path);
        let rules_path = SourcePath::new(Path::new("src").join("domain").join("rules.rs"));
        let rules_path = assert_ok!(rules_path, "Rules fixture path must be valid");
        let rules = FileNode::new(rules_path);
        let response_path = SourcePath::new(Path::new("src").join("api").join("response.rs"));
        let response_path = assert_ok!(response_path, "Response fixture path must be valid");
        let response = FileNode::new(response_path);
        let fixture = file_fixture(&[(&service, &request), (&rules, &response)]);
        let fixture = assert_ok!(fixture, "Acyclic file dependencies must form a valid graph");
        let folders = fixture.folders(Path::new("src"), depth, false);
        let folders = assert_ok!(folders, "Folder aggregation must succeed at depth {depth:?}");
        let folder_analysis = analyze_folders(&folders);
        let folder_analysis = assert_ok!(folder_analysis, "Aggregated folders must support cycle analysis");
        let file_analysis = analyze_files(&fixture);
        let file_analysis = assert_ok!(file_analysis, "Original file graph must support cycle analysis");
        let system_under_test = folder_report;

        let folder_output = system_under_test(&folder_analysis, NonZeroUsize::MAX);
        let folder_output = assert_ok!(folder_output, "Aggregated folder cycle report must render");
        let file_output = file_report(&file_analysis, NonZeroUsize::MAX);
        let file_output = assert_ok!(file_output, "Original file cycle report must render");
        let folder_chains = report_chains(&folder_output);
        let folder_chains = assert_ok!(folder_chains, "Aggregated folder report must contain parseable labels");
        let expected_chains = expected_chains.into_iter().map(|chain| chain.into_iter().map(str::to_owned).collect());
        let expected_chains: Vec<Vec<String>> = expected_chains.collect();

        assert_eq!(expected_chains, folder_chains, "Folder report did not reflect the aggregation depth");
        assert_eq!(Some(NO_CYCLES_FOUND), file_output.lines().last(), "File report inherited a folder-aggregation cycle");
    }

    #[rstest]
    #[case(ReportKind::Folder)]
    #[case(ReportKind::File)]
    fn test_cycle_limit_error_propagation(#[case] kind: ReportKind) {
        let folder_fixture = overlapping_folder_fixture();
        let folder_fixture = assert_ok!(folder_fixture, "Overlapping folder cycles must form a valid graph");
        let folder_analysis = analyze_folders(&folder_fixture);
        let folder_analysis = assert_ok!(folder_analysis, "Overlapping folder cycles must support analysis");
        let first_path = SourcePath::new("first.rs".into());
        let first_path = assert_ok!(first_path, "First self-loop file path must be valid");
        let first_file = FileNode::new(first_path);
        let second_path = SourcePath::new("second.rs".into());
        let second_path = assert_ok!(second_path, "Second self-loop file path must be valid");
        let second_file = FileNode::new(second_path);
        let file_fixture = file_fixture(&[(&first_file, &first_file), (&second_file, &second_file)]);
        let file_fixture = assert_ok!(file_fixture, "Two file self-loops must form a valid graph");
        let file_analysis = analyze_files(&file_fixture);
        let file_analysis = assert_ok!(file_analysis, "Two file self-loops must support cycle analysis");

        let result = match kind {
            ReportKind::Folder => folder_report(&folder_analysis, NonZeroUsize::MIN),
            ReportKind::File => file_report(&file_analysis, NonZeroUsize::MIN),
        };

        assert!(result.is_err(), "Report silently truncated cycles above the requested limit");
    }

    #[cfg(any(unix, windows))]
    #[test]
    fn test_file_path_encoding_error() {
        use std::ffi::OsString;

        #[cfg(unix)]
        let file_name = {
            use std::os::unix::ffi::OsStringExt as _;
            OsString::from_vec(vec![0xff])
        };
        #[cfg(windows)]
        let file_name = {
            use std::os::windows::ffi::OsStringExt as _;
            OsString::from_wide(&[0xd800])
        };
        let source_path = SourcePath::new(file_name.into());
        let source_path = assert_ok!(source_path, "A non-UTF-8 filename must still be a valid lexical source path");
        let file = FileNode::new(source_path);
        let fixture = file_fixture(&[(&file, &file)]);
        let fixture = assert_ok!(fixture, "A non-UTF-8 file self-loop must form a valid graph");
        let analysis = analyze_files(&fixture);
        let analysis = assert_ok!(analysis, "A non-UTF-8 file path must not prevent cycle analysis");
        let system_under_test = file_report;

        let result = system_under_test(&analysis, NonZeroUsize::MIN);

        assert!(result.is_err(), "A non-UTF-8 cycle path must remain a report encoding error");
    }
}