biors 0.33.0

Command-line tools for bio-rs biological AI model input workflows.
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

use crate::errors::{CliError, ErrorLocationValue};
use serde::Serialize;
use std::io::{self, Write};

const VERSION: &str = env!("CARGO_PKG_VERSION");

#[derive(Debug, Serialize)]
struct CliSuccess<T: Serialize> {
    ok: bool,
    biors_version: &'static str,
    #[serde(skip_serializing_if = "Option::is_none")]
    input_hash: Option<String>,
    data: T,
}

#[derive(Debug, Serialize)]
struct CliFailure {
    ok: bool,
    error: CliErrorBody,
}

#[derive(Debug, Serialize)]
struct CliErrorBody {
    code: &'static str,
    message: String,
    location: Option<ErrorLocationValue>,
}

pub(crate) fn print_success<T: Serialize>(
    input_hash: Option<String>,
    data: T,
) -> Result<(), CliError> {
    let stdout = io::stdout();
    let mut handle = stdout.lock();
    write_success_to(&mut handle, input_hash, data)?;
    Ok(())
}

fn write_success_to<W: Write, T: Serialize>(
    writer: &mut W,
    input_hash: Option<String>,
    data: T,
) -> Result<(), CliError> {
    let payload = CliSuccess {
        ok: true,
        biors_version: VERSION,
        input_hash,
        data,
    };
    serde_json::to_writer_pretty(&mut *writer, &payload).map_err(CliError::Serialization)?;
    writeln!(writer).map_err(CliError::Write)?;
    Ok(())
}

pub(crate) fn print_json_error(error: CliError) {
    let payload = CliFailure {
        ok: false,
        error: CliErrorBody {
            code: error.code(),
            message: error.to_string(),
            location: error.location(),
        },
    };
    match to_json(&payload) {
        Ok(json) => println!("{json}"),
        Err(_) => println!(
            r#"{{"ok":false,"error":{{"code":"cli.internal_error","message":"failed to serialize error","location":null}}}}"#
        ),
    }
}

fn to_json<T: Serialize>(value: &T) -> Result<String, serde_json::Error> {
    serde_json::to_string_pretty(value)
}

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

    #[test]
    fn write_success_to_serializes_envelope_to_writer() {
        let mut output = Vec::new();

        assert!(
            write_success_to(&mut output, Some("fnv1a64:test".to_string()), vec![1, 2]).is_ok(),
            "write success envelope failed"
        );

        assert!(output.ends_with(b"\n"));
        let value: Value = match serde_json::from_slice(&output) {
            Ok(v) => v,
            Err(e) => panic!("invalid JSON: {e}"),
        };
        assert_eq!(value["ok"], true);
        assert_eq!(value["biors_version"], env!("CARGO_PKG_VERSION"));
        assert_eq!(value["input_hash"], "fnv1a64:test");
        assert_eq!(value["data"], serde_json::json!([1, 2]));
    }
}