plasmite 0.6.1

Persistent JSON message queues backed by plain files for local and remote IPC
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
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
//! Purpose: Safe wrappers around Lite3 encoding/decoding and canonical message validation.
//! Exports: `Lite3Buf`, `Lite3DocRef`, `encode_message`, `validate_bytes`.
//! Role: Canonical JSON <-> Lite3 boundary for payloads stored in pool frames.
//! Invariants: Buffer growth is capped (`MAX_LITE3_BUF`) to avoid unbounded allocation.
//! Invariants: All FFI interaction is confined to this module + `sys`.
use std::ffi::CString;
use std::io;
#[cfg(test)]
use std::sync::atomic::{AtomicUsize, Ordering};

use serde::Serialize;
use serde_json::Value;

use crate::core::error::{Error, ErrorKind};

pub mod sys;

const MAX_LITE3_BUF: usize = 256 * 1024 * 1024;

#[derive(Clone, Debug)]
pub struct Lite3Buf {
    bytes: Vec<u8>,
}

impl Lite3Buf {
    pub fn from_json_str(json: &str) -> Result<Self, Error> {
        let mut buf_len = json.len().saturating_mul(2).max(256);
        let json_cstr = CString::new(json).map_err(|err| {
            Error::new(ErrorKind::Usage)
                .with_message("json contains null")
                .with_source(err)
        })?;

        loop {
            if buf_len > MAX_LITE3_BUF {
                return Err(
                    Error::new(ErrorKind::Usage).with_message("lite3 buffer exceeded max size")
                );
            }

            let mut buf = vec![0u8; buf_len];
            let mut out_len: usize = 0;
            let ret = unsafe {
                sys::plasmite_lite3_json_dec(
                    json_cstr.as_ptr(),
                    json.len(),
                    buf.as_mut_ptr(),
                    &mut out_len as *mut usize,
                    buf.len(),
                )
            };

            if ret == 0 {
                buf.truncate(out_len);
                return Ok(Self { bytes: buf });
            }

            let err_no = unsafe { sys::plasmite_lite3_last_errno() };
            if err_no == libc::ENOBUFS {
                buf_len = buf_len.saturating_mul(2);
                continue;
            }

            let err = if err_no != 0 {
                io::Error::from_raw_os_error(err_no)
            } else {
                io::Error::other("unknown lite3 errno")
            };

            return Err(Error::new(ErrorKind::Usage)
                .with_message("failed to encode json as lite3")
                .with_source(err));
        }
    }

    pub fn as_slice(&self) -> &[u8] {
        &self.bytes
    }

    pub fn len(&self) -> usize {
        self.bytes.len()
    }

    pub fn is_empty(&self) -> bool {
        self.bytes.is_empty()
    }

    pub fn as_doc(&self) -> Lite3DocRef<'_> {
        Lite3DocRef { bytes: &self.bytes }
    }
}

#[derive(Clone, Copy, Debug)]
pub struct Lite3DocRef<'a> {
    bytes: &'a [u8],
}

impl<'a> Lite3DocRef<'a> {
    pub fn new(bytes: &'a [u8]) -> Self {
        Self { bytes }
    }

    pub fn bytes(&self) -> &'a [u8] {
        self.bytes
    }

    pub fn to_json(&self, pretty: bool) -> Result<String, Error> {
        #[cfg(test)]
        TO_JSON_CALLS.fetch_add(1, Ordering::Relaxed);
        self.to_json_at(0, pretty)
    }

    pub fn to_json_at(&self, ofs: usize, pretty: bool) -> Result<String, Error> {
        #[cfg(test)]
        TO_JSON_AT_CALLS.fetch_add(1, Ordering::Relaxed);
        let mut out_len: usize = 0;
        let ptr = unsafe {
            if pretty {
                sys::plasmite_lite3_json_enc_pretty(
                    self.bytes.as_ptr(),
                    self.bytes.len(),
                    ofs,
                    &mut out_len as *mut usize,
                )
            } else {
                sys::plasmite_lite3_json_enc(
                    self.bytes.as_ptr(),
                    self.bytes.len(),
                    ofs,
                    &mut out_len as *mut usize,
                )
            }
        };

        if ptr.is_null() {
            return Err(Error::new(ErrorKind::Corrupt).with_message("failed to decode lite3"));
        }

        let slice = unsafe { std::slice::from_raw_parts(ptr as *const u8, out_len) };
        let json = String::from_utf8(slice.to_vec()).map_err(|err| {
            Error::new(ErrorKind::Corrupt)
                .with_message("invalid utf-8")
                .with_source(err)
        });

        unsafe {
            sys::plasmite_lite3_free(ptr as *mut libc::c_void);
        }

        json
    }

    pub fn key_offset(&self, key: &str) -> Result<usize, Error> {
        get_key_offset(self.bytes, key)
    }

    pub fn key_offset_at(&self, ofs: usize, key: &str) -> Result<usize, Error> {
        get_key_offset_at(self.bytes, ofs, key)
    }

    pub fn count_at(&self, ofs: usize) -> Result<u32, Error> {
        array_count(self.bytes, ofs)
    }

    pub fn array_item_type(&self, ofs: usize, index: u32) -> Result<u8, Error> {
        array_item_type(self.bytes, ofs, index)
    }

    pub fn array_string_at(&self, ofs: usize, index: u32) -> Result<String, Error> {
        let mut out_ptr: *const std::os::raw::c_char = std::ptr::null();
        let mut out_len: usize = 0;
        let ret = unsafe {
            sys::plasmite_lite3_arr_get_str(
                self.bytes.as_ptr(),
                self.bytes.len(),
                ofs,
                index,
                &mut out_ptr as *mut *const std::os::raw::c_char,
                &mut out_len as *mut usize,
            )
        };
        if ret < 0 || out_ptr.is_null() {
            return Err(
                Error::new(ErrorKind::Corrupt).with_message("missing or invalid array item")
            );
        }
        let bytes = unsafe { std::slice::from_raw_parts(out_ptr as *const u8, out_len) };
        let text = std::str::from_utf8(bytes).map_err(|err| {
            Error::new(ErrorKind::Corrupt)
                .with_message("invalid utf-8")
                .with_source(err)
        })?;
        Ok(text.to_string())
    }

    pub fn bool_at_key(&self, ofs: usize, key: &str) -> Result<bool, Error> {
        let mut out = false;
        let ret = unsafe {
            sys::plasmite_lite3_get_bool(
                self.bytes.as_ptr(),
                self.bytes.len(),
                ofs,
                c_key(key).as_ptr(),
                &mut out as *mut bool,
            )
        };
        if ret < 0 {
            return Err(Error::new(ErrorKind::Corrupt).with_message("missing or invalid key"));
        }
        Ok(out)
    }

    pub fn i64_at_key(&self, ofs: usize, key: &str) -> Result<i64, Error> {
        let mut out: i64 = 0;
        let ret = unsafe {
            sys::plasmite_lite3_get_i64(
                self.bytes.as_ptr(),
                self.bytes.len(),
                ofs,
                c_key(key).as_ptr(),
                &mut out as *mut i64,
            )
        };
        if ret < 0 {
            return Err(Error::new(ErrorKind::Corrupt).with_message("missing or invalid key"));
        }
        Ok(out)
    }

    pub fn type_at_key(&self, ofs: usize, key: &str) -> Result<u8, Error> {
        let value = unsafe {
            sys::plasmite_lite3_get_type(
                self.bytes.as_ptr(),
                self.bytes.len(),
                ofs,
                c_key(key).as_ptr(),
            )
        };
        if value == sys::LITE3_TYPE_INVALID {
            return Err(Error::new(ErrorKind::Corrupt).with_message("missing key"));
        }
        Ok(value)
    }

    pub fn validate(&self) -> Result<(), Error> {
        let root_type =
            unsafe { sys::plasmite_lite3_get_root_type(self.bytes.as_ptr(), self.bytes.len()) };
        if root_type != sys::LITE3_TYPE_OBJECT {
            return Err(Error::new(ErrorKind::Corrupt).with_message("root is not object"));
        }

        let meta_type = unsafe {
            sys::plasmite_lite3_get_type(
                self.bytes.as_ptr(),
                self.bytes.len(),
                0,
                c_key("meta").as_ptr(),
            )
        };
        if meta_type != sys::LITE3_TYPE_OBJECT {
            return Err(Error::new(ErrorKind::Corrupt).with_message("meta is not object"));
        }

        let data_type = unsafe {
            sys::plasmite_lite3_get_type(
                self.bytes.as_ptr(),
                self.bytes.len(),
                0,
                c_key("data").as_ptr(),
            )
        };
        if data_type != sys::LITE3_TYPE_OBJECT {
            return Err(Error::new(ErrorKind::Corrupt).with_message("data is not object"));
        }

        let meta_ofs = match get_key_offset(self.bytes, "meta") {
            Ok(ofs) => ofs,
            Err(err) => return Err(err.with_message("missing meta")),
        };

        let tags_type = unsafe {
            sys::plasmite_lite3_get_type(
                self.bytes.as_ptr(),
                self.bytes.len(),
                meta_ofs,
                c_key("tags").as_ptr(),
            )
        };
        if tags_type != sys::LITE3_TYPE_ARRAY {
            return Err(Error::new(ErrorKind::Corrupt).with_message("meta.tags must be array"));
        }

        let tags_ofs = get_key_offset_at(self.bytes, meta_ofs, "tags")
            .map_err(|err| err.with_message("missing meta.tags"))?;

        let count = array_count(self.bytes, tags_ofs)?;
        for index in 0..count {
            let item_type = array_item_type(self.bytes, tags_ofs, index)?;
            if item_type != sys::LITE3_TYPE_STRING {
                return Err(
                    Error::new(ErrorKind::Corrupt).with_message("meta.tags must be string array")
                );
            }
        }

        Ok(())
    }
}

pub fn encode_message(meta_tags: &[String], data: &Value) -> Result<Lite3Buf, Error> {
    if !matches!(data, Value::Object(_)) {
        return Err(Error::new(ErrorKind::Usage).with_message("data must be object"));
    }

    #[derive(Serialize)]
    struct MetaEnvelope<'a> {
        tags: &'a [String],
    }

    #[derive(Serialize)]
    struct MessageEnvelope<'a> {
        meta: MetaEnvelope<'a>,
        data: &'a Value,
    }

    let json = MessageEnvelope {
        meta: MetaEnvelope { tags: meta_tags },
        data,
    };
    let json_str = serde_json::to_string(&json).map_err(|err| {
        Error::new(ErrorKind::Usage)
            .with_message("failed to serialize json")
            .with_source(err)
    })?;

    Lite3Buf::from_json_str(&json_str)
}

pub fn validate_bytes(buf: &[u8]) -> Result<(), Error> {
    Lite3DocRef::new(buf).validate()
}

fn c_key(key: &str) -> CString {
    CString::new(key).expect("c key")
}

fn get_key_offset(bytes: &[u8], key: &str) -> Result<usize, Error> {
    get_key_offset_at(bytes, 0, key)
}

fn get_key_offset_at(bytes: &[u8], ofs: usize, key: &str) -> Result<usize, Error> {
    let mut out_ofs: usize = 0;
    let ret = unsafe {
        sys::plasmite_lite3_get_val_ofs(
            bytes.as_ptr(),
            bytes.len(),
            ofs,
            c_key(key).as_ptr(),
            &mut out_ofs as *mut usize,
        )
    };
    if ret < 0 {
        return Err(Error::new(ErrorKind::Corrupt).with_message("missing key"));
    }
    Ok(out_ofs)
}

fn array_count(bytes: &[u8], ofs: usize) -> Result<u32, Error> {
    let mut out: u32 = 0;
    let ret = unsafe {
        sys::plasmite_lite3_count(bytes.as_ptr(), bytes.len(), ofs, &mut out as *mut u32)
    };
    if ret < 0 {
        return Err(Error::new(ErrorKind::Corrupt).with_message("invalid array"));
    }
    Ok(out)
}

fn array_item_type(bytes: &[u8], ofs: usize, index: u32) -> Result<u8, Error> {
    let mut out_type: u8 = 0;
    let ret = unsafe {
        sys::plasmite_lite3_arr_get_type(
            bytes.as_ptr(),
            bytes.len(),
            ofs,
            index,
            &mut out_type as *mut u8,
        )
    };
    if ret < 0 {
        return Err(Error::new(ErrorKind::Corrupt).with_message("invalid array index"));
    }
    Ok(out_type)
}

#[cfg(test)]
static TO_JSON_CALLS: AtomicUsize = AtomicUsize::new(0);
#[cfg(test)]
static TO_JSON_AT_CALLS: AtomicUsize = AtomicUsize::new(0);

#[cfg(test)]
pub(crate) fn reset_json_counters() {
    TO_JSON_CALLS.store(0, Ordering::Relaxed);
    TO_JSON_AT_CALLS.store(0, Ordering::Relaxed);
}

#[cfg(test)]
pub(crate) fn json_counter_snapshot() -> (usize, usize) {
    (
        TO_JSON_CALLS.load(Ordering::Relaxed),
        TO_JSON_AT_CALLS.load(Ordering::Relaxed),
    )
}

#[cfg(test)]
mod tests {
    use super::{Lite3Buf, encode_message, validate_bytes};
    use serde_json::json;

    #[test]
    fn round_trip_json() {
        let data = json!({"hello": "world"});
        let buf = encode_message(&["event".to_string()], &data).expect("encode");
        let doc = buf.as_doc();
        let json = doc.to_json(false).expect("json");
        let value: serde_json::Value = serde_json::from_str(&json).expect("parse");
        assert_eq!(value["data"]["hello"], "world");
        assert_eq!(value["meta"]["tags"][0], "event");
    }

    #[test]
    fn invalid_bytes_are_rejected() {
        let buf = [0u8; 8];
        let err = validate_bytes(&buf).expect_err("should fail");
        assert_eq!(err.kind(), crate::core::error::ErrorKind::Corrupt);
    }

    #[test]
    fn canonical_shape_is_required() {
        let json = r#"{"foo": "bar"}"#;
        let buf = Lite3Buf::from_json_str(json).expect("lite3");
        let err = validate_bytes(buf.as_slice()).expect_err("should fail");
        assert_eq!(err.kind(), crate::core::error::ErrorKind::Corrupt);
    }

    #[test]
    fn typed_key_getters_work() {
        let data = json!({"done": true, "sent_ns": 42});
        let buf = encode_message(&["event".to_string()], &data).expect("encode");
        let doc = buf.as_doc();
        let data_ofs = doc.key_offset("data").expect("data offset");
        let meta_ofs = doc.key_offset("meta").expect("meta offset");
        let tags_ofs = doc.key_offset_at(meta_ofs, "tags").expect("tags offset");
        assert!(doc.bool_at_key(data_ofs, "done").expect("done"));
        assert_eq!(doc.i64_at_key(data_ofs, "sent_ns").expect("sent_ns"), 42);
        assert_eq!(doc.count_at(tags_ofs).expect("tags count"), 1);
        assert_eq!(
            doc.array_string_at(tags_ofs, 0).expect("tag 0"),
            "event".to_string()
        );
    }
}