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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
use libdeflater::{CompressionLvl, Compressor};
use std::iter;
use std::collections::HashMap;
use std::cell::RefCell;

use crate::{WireMessage, Error};
use crate::errors::Result;

thread_local!(static COMPRESSORS: RefCell<DeflaterCompressor> = RefCell::new(DeflaterCompressor::new()));

/// MessageCompression represents all possible compression algorithms in GELF.
#[derive(PartialEq, Clone, Copy)]
pub enum MessageCompression {
    None,
    Gzip {
        level: i32
    },
    Zlib {
        level: i32
    },
}

impl MessageCompression {
    /// Return the default compression algorithm.
    pub fn default() -> MessageCompression {
        MessageCompression::Gzip {level: 1}
    }

    /// Compress a serialized message with the defined algorithm.
    pub fn compress(self, message: &WireMessage) -> Result<Vec<u8>> {
        let json = message.to_gelf()?;

        Ok(match self {
            MessageCompression::None => json.into_bytes(),
            MessageCompression::Gzip {level} => {
                COMPRESSORS.with(|compressor| {
                    compressor.borrow_mut().with(level, |compressor| {
                        let bound = compressor.gzip_compress_bound(json.as_bytes().len());

                        let mut buffer: Vec<u8> = iter::repeat(0 ).take(bound).collect();

                        compressor.gzip_compress(json.as_bytes(), buffer.as_mut_slice())
                            .map_err(|err| {
                                Error::CompressMessageFailed {
                                    compression_method: "gzip",
                                    compression_error: err.into()
                                }
                            })
                            .map(|size|buffer.truncate(size))
                            .map(move |_| buffer)
                    })
                })?
            }

            MessageCompression::Zlib {level} => {
                COMPRESSORS.with(|compressor| {
                    compressor.borrow_mut().with(level, |compressor| {
                        let bound = compressor.zlib_compress_bound(json.as_bytes().len());

                        let mut buffer: Vec<u8> = iter::repeat(0 ).take(bound).collect();

                        compressor.zlib_compress(json.as_bytes(), buffer.as_mut_slice())
                            .map_err(|err| {
                                Error::CompressMessageFailed {
                                    compression_method: "zlib",
                                    compression_error: err.into()
                                }
                            })
                            .map(|size|buffer.truncate(size))
                            .map(move |_| buffer)
                    })
                })?
            }
        })
    }
}

#[derive(Default)]
struct DeflaterCompressor {
    compressors: HashMap<i32, Compressor>
}

impl DeflaterCompressor {
    pub fn new() -> Self {
        Self::default()
    }

    fn with<F,R>(&mut self, level: i32, fa: F) -> R
        where F: Fn(&mut Compressor) -> R {

        let compressor = self.compressors.get_mut(&level);

        match compressor {
            None => {
                self.compressors.insert(level, Self::create_compression(level));

                fa(self.compressors.get_mut(&level).expect("Should be present"))
            },
            Some(c) => fa(c),
        }
    }

    fn create_compression(level: i32) -> Compressor {
        let compression_lvl = CompressionLvl::new(level).expect("Should be a valid level");

        Compressor::new(compression_lvl)
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use serde_json::Value;
    use crate::{Logger, NullBackend, Message};

    #[test]
    fn test_compression_none() {
        let logger = Logger::new(Box::new(NullBackend::new())).expect("Should not be an error");

        let message = WireMessage::new(Message::new("Testing"), &logger);

        let compressor = MessageCompression::None;

        let actual = compressor.compress(&message).expect("Should success");

        let actual: Value = serde_json::from_slice(actual.as_slice()).expect("Should success to parse");
        let expected = serde_json::to_value(message).expect("Should success to encode");

        assert_eq!(actual, expected, "Should not compress any data and be equal");
    }

    #[test]
    fn test_compression_gzip() {
        let logger = Logger::new(Box::new(NullBackend::new())).expect("Should not be an error");

        let message = WireMessage::new(Message::new("Testing"), &logger);

        for level in 1..=12 {

            let compressor = MessageCompression::Gzip {level};

            let mut decompressor = libdeflater::Decompressor::new();

            let actual = compressor.compress(&message).expect("Should success");

            let mut buffer: Vec<u8> = iter::repeat(0).take(serde_json::to_vec(&message).unwrap().len()).collect();

            let decoded = decompressor.gzip_decompress(actual.as_slice(), buffer.as_mut_slice()).expect("Should not throw an error");

            buffer.truncate(decoded);

            let actual = buffer;

            let actual: Value = serde_json::from_slice(actual.as_slice()).expect("Should success to parse");

            let expected = serde_json::to_value(&message).expect("Should success to encode");

            assert_eq!(actual, expected, "Decoded data should be equal input");
        }
    }

    #[test]
    fn test_compression_zlib() {
        let logger = Logger::new(Box::new(NullBackend::new())).expect("Should not be an error");

        let message = WireMessage::new(Message::new("Testing"), &logger);

        for level in 1..=12 {

            let compressor = MessageCompression::Zlib {level};

            let mut decompressor = libdeflater::Decompressor::new();

            let actual = compressor.compress(&message).expect("Should success");

            let mut buffer: Vec<u8> = iter::repeat(0).take(serde_json::to_vec(&message).unwrap().len()).collect();

            let decoded = decompressor.zlib_decompress(actual.as_slice(), buffer.as_mut_slice()).expect("Should not throw an error");

            buffer.truncate(decoded);

            let actual = buffer;

            let actual: Value = serde_json::from_slice(actual.as_slice()).expect("Should success to parse");

            let expected = serde_json::to_value(&message).expect("Should success to encode");

            assert_eq!(actual, expected, "Decoded data should be equal input");
        }
    }

    #[test]
    fn test_concurrency_zlib() {

        for level in 1..=12 {

            let compressor = MessageCompression::Zlib {level};

            loom::model(move || {
                let logger = loom::sync::Arc::new(Logger::new(Box::new(NullBackend::new())).expect("Should not be an error"));

                for _ in 0..3 {
                    let logger = logger.clone();

                    loom::thread::spawn( move || {
                        let message = WireMessage::new(Message::new("Testing"), &logger);

                        let mut decompressor = libdeflater::Decompressor::new();

                        let actual = compressor.clone().compress(&message).expect("Should success");

                        let mut buffer: Vec<u8> = iter::repeat(0).take(serde_json::to_vec(&message).unwrap().len()).collect();

                        let decoded = decompressor.zlib_decompress(actual.as_slice(), buffer.as_mut_slice()).expect("Should not throw an error");

                        buffer.truncate(decoded);

                        let actual = buffer;

                        let actual: Value = serde_json::from_slice(actual.as_slice()).expect("Should success to parse");

                        let expected = serde_json::to_value(&message).expect("Should success to encode");

                        assert_eq!(actual, expected, "Decoded data should be equal input");
                    });
                }
            })

        }
    }

    #[test]
    fn test_concurrency_gzip() {

        for level in 1..=12 {
            let compressor = MessageCompression::Gzip { level };

            loom::model(move || {
                let logger = loom::sync::Arc::new(Logger::new(Box::new(NullBackend::new())).expect("Should not be an error"));

                for _ in 0..3 {
                    let logger = logger.clone();

                    loom::thread::spawn( move || {
                        let message = WireMessage::new(Message::new("Testing"), &logger);

                        let mut decompressor = libdeflater::Decompressor::new();

                        let actual = compressor.clone().compress(&message).expect("Should success");

                        let mut buffer: Vec<u8> = iter::repeat(0).take(serde_json::to_vec(&message).unwrap().len()).collect();

                        let decoded = decompressor.gzip_decompress(actual.as_slice(), buffer.as_mut_slice()).expect("Should not throw an error");

                        buffer.truncate(decoded);

                        let actual = buffer;

                        let actual: Value = serde_json::from_slice(actual.as_slice()).expect("Should success to parse");

                        let expected = serde_json::to_value(&message).expect("Should success to encode");

                        assert_eq!(actual, expected, "Decoded data should be equal input");
                    });
                }
            })

        }
    }

}