perf-sentinel-core 0.8.13

Core library for perf-sentinel: polyglot performance anti-pattern detector
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

//! JSON report sink: serializes the report as structured JSON to stdout.

use crate::report::{Report, ReportSink};

/// Outputs reports as JSON to stdout.
pub struct JsonReportSink;

impl ReportSink for JsonReportSink {
    type Error = JsonReportError;

    fn emit(&self, report: &Report) -> Result<(), Self::Error> {
        use std::io::Write as _;
        let stdout = std::io::stdout();
        let mut lock = stdout.lock();
        serde_json::to_writer_pretty(&mut lock, report)
            .map_err(|e| JsonReportError(e.to_string()))?;
        lock.write_all(b"\n")
            .map_err(|e| JsonReportError(e.to_string()))?;
        Ok(())
    }
}

/// Errors that can occur during JSON report output.
#[derive(Debug, thiserror::Error)]
#[error("JSON report error: {0}")]
pub struct JsonReportError(String);

#[cfg(test)]
mod tests {
    use super::*;
    use crate::report::{Analysis, QualityGate, Report};
    use crate::test_helpers::empty_report;

    #[test]
    fn emit_empty_report() {
        let sink = JsonReportSink;
        let report = empty_report();
        assert!(sink.emit(&report).is_ok());
    }

    #[test]
    fn error_display() {
        let err = JsonReportError("test".to_string());
        assert_eq!(format!("{err}"), "JSON report error: test");
    }

    #[test]
    fn emit_report_with_findings() {
        use crate::detect::{Finding, FindingType, Pattern, Severity};

        let report = Report {
            analysis: Analysis {
                duration_ms: 42,
                events_processed: 10,
                traces_analyzed: 1,
            },
            findings: vec![Finding {
                finding_type: FindingType::NPlusOneSql,
                severity: Severity::Warning,
                trace_id: "trace-1".to_string(),
                service: "order-svc".to_string(),
                source_endpoint: "POST /api/orders/42/submit".to_string(),
                pattern: Pattern {
                    template: "SELECT * FROM order_item WHERE order_id = ?".to_string(),
                    occurrences: 6,
                    window_ms: 250,
                    distinct_params: 6,
                    ..Default::default()
                },
                suggestion: "Use WHERE ... IN (?) to batch 6 queries into one".to_string(),
                first_timestamp: "2025-07-10T14:32:01.000Z".to_string(),
                last_timestamp: "2025-07-10T14:32:01.250Z".to_string(),
                green_impact: None,
                confidence: crate::detect::Confidence::default(),
                classification_method: None,
                code_location: None,
                instrumentation_scopes: Vec::new(),
                suggested_fix: None,
                signature: String::new(),
            }],
            green_summary: crate::test_helpers::make_test_green_summary(10, 5, 0.5),
            quality_gate: QualityGate {
                passed: true,
                rules: vec![],
            },
            per_endpoint_io_ops: vec![],
            correlations: vec![],
            warnings: vec![],
            warning_details: vec![],
            acknowledged_findings: vec![],
            binary_version: String::new(),
            disclosure_waste: None,
        };

        let json = serde_json::to_string_pretty(&report).unwrap();
        assert!(json.contains("n_plus_one_sql"));
        assert!(json.contains("trace-1"));
        assert!(json.contains("order_id"));
        assert!(json.contains("\"occurrences\": 6"));
        assert!(json.contains("\"io_waste_ratio\": 0.5"));
        assert!(json.contains("\"first_timestamp\""));
        assert!(json.contains("\"last_timestamp\""));

        // Interpretation band fields are part of the stable JSON schema
        // (see `crates/sentinel-core/src/report/interpret.rs` stability
        // contract). Asserting their presence here guards against an
        // accidental `#[serde(skip)]` or a rename that would silently
        // break downstream consumers (SARIF, Grafana, perf-lint).
        //
        // With `io_waste_ratio = 0.5`, the band MUST be "critical"
        // (>= WASTE_RATIO_CRITICAL = 0.50).
        assert!(
            json.contains("\"io_waste_ratio_band\": \"critical\""),
            "io_waste_ratio_band missing or not `critical` for 0.5 waste: {json}"
        );
    }
}