trusty-analyze 0.2.1

Sidecar code-analysis daemon for trusty-search: complexity, smells, quality, facts
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

//! `CodeChunk`: the unit of work passed between trusty-search and trusty-analyzer.
//!
//! Why: the analyzer fetches chunks from the search daemon's
//! `GET /indexes/:id/chunks` endpoint and runs analysis on them. Keeping the
//! struct here (separate from trusty-search-core) means trusty-analyzer can
//! deserialize without depending on trusty-search at all.
//!
//! Compatibility: serde tolerates unknown fields by default, so the search
//! daemon can add structural metadata (chunk_type, calls, inherits_from, …)
//! without breaking analyzer deserialization. We only declare the fields the
//! analyzer needs to do its job.
//!
//! Note: complexity and blame are NOT carried on `CodeChunk`. trusty-analyzer
//! computes those independently via `compute_complexity_for()` and the blame
//! module — trusty-search never populated them in practice, so removing them
//! drops dead carrier fields.

use serde::{Deserialize, Serialize};

/// One chunk of code, anchored to a file + line range.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CodeChunk {
    /// Collision-safe id: `{path}:{start}:{end}`.
    pub id: String,
    pub file: String,
    pub start_line: usize,
    pub end_line: usize,
    pub content: String,
    #[serde(default)]
    pub function_name: Option<String>,
    #[serde(default)]
    pub score: f32,
    #[serde(default)]
    pub compact_snippet: Option<String>,
    #[serde(default)]
    pub match_reason: String,
}

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

    #[test]
    fn chunk_minimal_json_round_trips() {
        // The smallest legal payload: only the required fields.
        let s = r#"{
            "id": "f:1:5",
            "file": "f.rs",
            "start_line": 1,
            "end_line": 5,
            "content": "fn f() {}"
        }"#;
        let c: CodeChunk = serde_json::from_str(s).unwrap();
        assert_eq!(c.id, "f:1:5");
        assert_eq!(c.content, "fn f() {}");
    }

    #[test]
    fn chunk_tolerates_extra_fields_from_search_daemon() {
        // trusty-search emits extra structural metadata (chunk_type, calls,
        // …); the analyzer must accept and ignore them gracefully.
        let s = r#"{
            "id": "f:1:5",
            "file": "f.rs",
            "start_line": 1,
            "end_line": 5,
            "content": "fn f() {}",
            "chunk_type": "Function",
            "calls": ["other"],
            "inherits_from": [],
            "complexity_score": 3,
            "chunk_depth": 0
        }"#;
        let c: CodeChunk = serde_json::from_str(s).unwrap();
        assert_eq!(c.id, "f:1:5");
    }
}