summaryrefslogtreecommitdiffstats
path: root/crates/common/json_writer/src/lib.rs
blob: df92765ba37dac86624a0d33be1783101100d634 (plain)
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
use std::num::FpCategory;

#[derive(Debug, Clone)]
pub struct JsonWriter {
    buffer: Vec<u8>,
    needs_separator: bool,
}

#[derive(thiserror::Error, Debug)]
pub enum JsonWriterError {
    #[error("JsonWriter produced invalid UTF8 string")]
    InvalidUtf8Conversion(#[from] std::string::FromUtf8Error),

    #[error("IoError")]
    FromIo(#[from] std::io::Error),

    #[error("Serde Json error")]
    FromSerdeJson(#[from] serde_json::Error),

    #[error("Invalid f64 value {value:?}")]
    InvalidF64Value { value: f64 },
}

#[cfg(test)]
impl Default for JsonWriter {
    fn default() -> Self {
        Self {
            buffer: Vec::new(),
            needs_separator: false,
        }
    }
}

impl JsonWriter {
    pub fn with_capacity(capacity: usize) -> Self {
        Self {
            buffer: Vec::with_capacity(capacity),
            needs_separator: false,
        }
    }

    pub fn write_key(&mut self, key: &str) -> Result<(), JsonWriterError> {
        self.maybe_separate();
        let () = serde_json::to_writer(&mut self.buffer, key)?;
        self.buffer.push(b':');
        self.needs_separator = false;
        Ok(())
    }

    pub fn write_str(&mut self, s: &str) -> Result<(), JsonWriterError> {
        self.maybe_separate();
        let () = serde_json::to_writer(&mut self.buffer, s)?;
        self.needs_separator = true;
        Ok(())
    }

    pub fn write_f64(&mut self, value: f64) -> Result<(), JsonWriterError> {
        self.maybe_separate();
        match value.classify() {
            FpCategory::Normal | FpCategory::Zero | FpCategory::Subnormal => {
                let () = serde_json::to_writer(&mut self.buffer, &value)?;
                self.needs_separator = true;
                Ok(())
            }
            FpCategory::Infinite | FpCategory::Nan => {
                Err(JsonWriterError::InvalidF64Value { value })
            }
        }
    }

    pub fn write_open_obj(&mut self) {
        self.maybe_separate();
        self.buffer.push(b'{');
    }

    pub fn write_close_obj(&mut self) {
        self.buffer.push(b'}');
        self.needs_separator = true;
    }

    pub fn into_string(self) -> Result<String, JsonWriterError> {
        Ok(String::from_utf8(self.buffer)?)
    }

    fn maybe_separate(&mut self) {
        if self.needs_separator {
            self.buffer.push(b',');
            self.needs_separator = false;
        }
    }
}

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

    #[test]
    fn write_empty_message() -> anyhow::Result<()> {
        let mut jw = JsonWriter::default();
        jw.write_open_obj();
        jw.write_close_obj();
        assert_eq!(jw.into_string()?, "{}");
        Ok(())
    }

    #[test]
    fn write_invalid_f64_message() -> anyhow::Result<()> {
        let mut jw = JsonWriter::default();
        let value = 1.0 / 0.0;
        let error = jw.write_f64(value).unwrap_err();
        assert_eq!(error.to_string(), "Invalid f64 value inf");
        Ok(())
    }

    #[test]
    fn write_key_with_quote() -> anyhow::Result<()> {
        let mut jw = JsonWriter::with_capacity(128);
        jw.write_key("va\"lue")?;
        assert_eq!(jw.into_string()?, "\"va\\\"lue\":");
        Ok(())
    }

    #[test]
    fn write_timestamp_message() -> anyhow::Result<()> {
        let mut jw = JsonWriter::with_capacity(128);
        jw.write_open_obj();
        jw.write_key("time")?;
        jw.write_str("2013-06-22T17:03:14.123+02:00")?;
        jw.write_close_obj();
        assert_eq!(
            jw.into_string()?,
            r#"{"time":"2013-06-22T17:03:14.123+02:00"}"#
        );
        Ok(())
    }

    #[test]
    fn write_single_value_message() -> anyhow::Result<()> {
        let mut jw = JsonWriter::with_capacity(128);
        jw.write_open_obj();
        jw.write_key("time")?;
        jw.write_str("2013-06-22T17:03:14.123+02:00")?;
        jw.write_key("temperature")?;
        jw.write_f64(128.0)?;
        jw.write_close_obj();
        assert_eq!(
            jw.into_string()?,
            r#"{"time":"2013-06-22T17:03:14.123+02:00","temperature":128.0}"#
        );
        Ok(())
    }

    #[test]
    fn write_multivalue_message() -> anyhow::Result<()> {
        let mut jw = JsonWriter::with_capacity(128);
        jw.write_open_obj();
        jw.write_key("time")?;
        jw.write_str("2013-06-22T17:03:14.123+02:00")?;
        jw.write_key("temperature")?;
        jw.write_f64(128.0)?;
        jw.write_key("location")?;
        jw.write_open_obj();
        jw.write_key("altitude")?;
        jw.write_f64(1028.0)?;
        jw.write_key("longitude")?;
        jw.write_f64(1288.0)?;
        jw.write_key("longitude")?;
        jw.write_f64(1280.0)?;
        jw.write_close_obj();
        jw.write_close_obj();

        assert_eq!(
            jw.into_string()?,
            r#"{"time":"2013-06-22T17:03:14.123+02:00","temperature":128.0,"location":{"altitude":1028.0,"longitude":1288.0,"longitude":1280.0}}"#
        );

        Ok(())
    }
}