fallow-output 3.30.0

Output contract types for fallow 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

//! Trace command output envelopes.

use crate::root_envelopes::{attach_telemetry_meta, serialize_named_json_output};
use serde::Serialize;

/// Serialize the `fallow trace --format json` envelope.
///
/// # Errors
///
/// Returns a serde error when the trace output cannot be converted to JSON.
pub fn serialize_trace_json_output<T: Serialize>(
    output: T,
    analysis_run_id: Option<&str>,
) -> Result<serde_json::Value, serde_json::Error> {
    let mut value = serialize_named_json_output(output, "trace")?;
    attach_telemetry_meta(&mut value, analysis_run_id);
    Ok(value)
}

/// Serialize the `fallow trace-error --format json` envelope.
///
/// Its own root kind, separate from `trace`: the payload answers a different
/// question (which definitions a runtime stack trace's frames name) and
/// versions on its own cadence.
///
/// # Errors
///
/// Returns a serde error when the trace output cannot be converted to JSON.
pub fn serialize_trace_error_json_output<T: Serialize>(
    output: T,
    analysis_run_id: Option<&str>,
) -> Result<serde_json::Value, serde_json::Error> {
    let mut value = serialize_named_json_output(output, "trace-error")?;
    attach_telemetry_meta(&mut value, analysis_run_id);
    Ok(value)
}

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

    #[test]
    fn trace_json_output_uses_output_owned_root_contract() {
        let value = serialize_trace_json_output(
            json!({"file": "src/app.ts", "symbol": "run"}),
            Some("run-trace"),
        )
        .expect("trace output should serialize");

        assert_eq!(value["kind"], "trace");
        assert_eq!(value["_meta"]["telemetry"]["analysis_run_id"], "run-trace");
    }

    #[test]
    fn trace_error_json_output_uses_its_own_root_kind() {
        let value = serialize_trace_error_json_output(
            json!({"source": "stdin", "frames": []}),
            Some("run-trace-error"),
        )
        .expect("trace-error output should serialize");

        assert_eq!(value["kind"], "trace-error");
        assert_eq!(
            value["_meta"]["telemetry"]["analysis_run_id"],
            "run-trace-error"
        );
    }
}