preroll 0.10.1

Easy boilerplate utilities for Rust http services which use async-std, Tide, Surf, and friends.
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

use std::io::Write;
use std::{io, process};

use log::kv;

use crate::utils::HOSTNAME;

// Modified from the json_env_logger crate
pub fn log_format_json<F>(f: &mut F, record: &log::Record<'_>) -> io::Result<()>
where
    F: Write,
{
    let target = record.target();
    if target.starts_with("tracing::span") {
        // Ignore tracing spans.
        return Ok(());
    }

    write!(f, "{{")?;
    write!(
        f,
        "\"level\":\"{}\"",
        format!("{}", record.level()).to_lowercase()
    )?;
    write!(f, ",\"pid\":{}", process::id())?;
    write!(f, ",\"message\":")?;
    write_json_str(f, &record.args().to_string())?;

    let mut visitor = Visitor { writer: f };
    record
        .key_values()
        .visit(&mut visitor)
        .map_err(|e| io::Error::new(io::ErrorKind::Other, e))?;

    write!(f, ",\"target\":\"{}\"", target)?;
    write!(f, ",\"hostname\":\"{}\"", *HOSTNAME)?;
    write!(
        f,
        ",\"time\":\"{}\"",
        chrono::Utc::now().to_rfc3339_opts(chrono::SecondsFormat::Millis, true)
    )?;

    struct Visitor<'w, W: Write> {
        writer: &'w mut W,
    }

    impl<'kvs, 'w, W: Write> kv::Visitor<'kvs> for Visitor<'w, W> {
        fn visit_pair(
            &mut self,
            key: kv::Key<'kvs>,
            val: kv::Value<'kvs>,
        ) -> Result<(), kv::Error> {
            write!(self.writer, ",\"{}\":\"{}\"", key, val)?;
            Ok(())
        }
    }

    writeln!(f, "}}")
}

// until log kv Value impl serde::Serialize
fn write_json_str<W: Write>(writer: &mut W, raw: &str) -> io::Result<()> {
    serde_json::to_writer(writer, raw)?;
    Ok(())
}

// Modified from the json_env_logger crate
#[cfg(test)]
mod tests {
    use super::*;
    use std::error::Error;

    #[test]
    fn writes_records_as_json() -> Result<(), Box<dyn Error>> {
        let mut kvs = std::collections::HashMap::new();
        kvs.insert("a", "b");
        let record = log::Record::builder()
            .args(format_args!("hello"))
            .key_values(&kvs)
            .level(log::Level::Info)
            .build();
        let mut buf = Vec::new();
        log_format_json(&mut buf, &record)?;
        let output = std::str::from_utf8(&buf)?;
        println!("{}", output);
        assert!(serde_json::from_str::<serde_json::Value>(output).is_ok());
        Ok(())
    }

    #[test]
    fn escapes_json_strings() -> Result<(), Box<dyn Error>> {
        let mut buf = Vec::new();
        write_json_str(
            &mut buf, r#""
	"#,
        )?;
        assert_eq!("\"\\\"\\n\\t\"", std::str::from_utf8(&buf)?);
        Ok(())
    }
}