tx2-link 0.1.1

Binary protocol for syncing ECS worlds with field-level delta compression
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
use crate::error::Result;
use crate::protocol::*;
use crate::debug;
use serde::{Deserialize, Serialize};
use bytes::{Bytes, BytesMut, BufMut};
use std::time::Instant;

pub use crate::protocol::{SerializedComponent, SerializedEntity};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WorldSnapshot {
    pub entities: Vec<SerializedEntity>,
    pub timestamp: f64,
    pub version: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Delta {
    pub changes: Vec<DeltaChange>,
    pub timestamp: f64,
    pub base_timestamp: f64,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum BinaryFormat {
    Json,
    MessagePack,
    Bincode,
}

pub struct BinarySerializer {
    format: BinaryFormat,
}

impl BinarySerializer {
    pub fn new(format: BinaryFormat) -> Self {
        Self { format }
    }

    pub fn json() -> Self {
        Self::new(BinaryFormat::Json)
    }

    pub fn messagepack() -> Self {
        Self::new(BinaryFormat::MessagePack)
    }

    pub fn bincode() -> Self {
        Self::new(BinaryFormat::Bincode)
    }

    pub fn serialize_message(&self, message: &Message) -> Result<Bytes> {
        let start = Instant::now();

        let result = match self.format {
            BinaryFormat::Json => {
                let json = serde_json::to_vec(message)?;
                Ok(Bytes::from(json))
            }
            BinaryFormat::MessagePack => {
                let msgpack = rmp_serde::to_vec(message)?;
                Ok(Bytes::from(msgpack))
            }
            BinaryFormat::Bincode => {
                let bincode_data = bincode::serialize(message)?;
                Ok(Bytes::from(bincode_data))
            }
        };

        if let Ok(ref bytes) = result {
            if debug::is_debug_enabled() {
                debug::log_message("Serialized", message);
            }

            if debug::is_trace_enabled() {
                let format_name = match self.format {
                    BinaryFormat::Json => "JSON",
                    BinaryFormat::MessagePack => "MessagePack",
                    BinaryFormat::Bincode => "Bincode",
                };
                debug::trace_serialization(format_name, bytes.len(), start.elapsed().as_micros());
            }
        }

        result
    }

    pub fn deserialize_message(&self, data: &[u8]) -> Result<Message> {
        let start = Instant::now();

        let result = match self.format {
            BinaryFormat::Json => {
                let message = serde_json::from_slice(data)?;
                Ok(message)
            }
            BinaryFormat::MessagePack => {
                let message = rmp_serde::from_slice(data)?;
                Ok(message)
            }
            BinaryFormat::Bincode => {
                let message = bincode::deserialize(data)?;
                Ok(message)
            }
        };

        if let Ok(ref message) = result {
            if debug::is_debug_enabled() {
                debug::log_message("Deserialized", message);
            }

            if debug::is_trace_enabled() {
                let format_name = match self.format {
                    BinaryFormat::Json => "JSON",
                    BinaryFormat::MessagePack => "MessagePack",
                    BinaryFormat::Bincode => "Bincode",
                };
                debug::trace_deserialization(format_name, data.len(), start.elapsed().as_micros());
            }
        }

        result
    }

    pub fn serialize_snapshot(&self, snapshot: &WorldSnapshot) -> Result<Bytes> {
        match self.format {
            BinaryFormat::Json => {
                let json = serde_json::to_vec(snapshot)?;
                Ok(Bytes::from(json))
            }
            BinaryFormat::MessagePack => {
                let msgpack = rmp_serde::to_vec(snapshot)?;
                Ok(Bytes::from(msgpack))
            }
            BinaryFormat::Bincode => {
                let bincode_data = bincode::serialize(snapshot)?;
                Ok(Bytes::from(bincode_data))
            }
        }
    }

    pub fn deserialize_snapshot(&self, data: &[u8]) -> Result<WorldSnapshot> {
        match self.format {
            BinaryFormat::Json => {
                let snapshot = serde_json::from_slice(data)?;
                Ok(snapshot)
            }
            BinaryFormat::MessagePack => {
                let snapshot = rmp_serde::from_slice(data)?;
                Ok(snapshot)
            }
            BinaryFormat::Bincode => {
                let snapshot = bincode::deserialize(data)?;
                Ok(snapshot)
            }
        }
    }

    pub fn serialize_delta(&self, delta: &Delta) -> Result<Bytes> {
        match self.format {
            BinaryFormat::Json => {
                let json = serde_json::to_vec(delta)?;
                Ok(Bytes::from(json))
            }
            BinaryFormat::MessagePack => {
                let msgpack = rmp_serde::to_vec(delta)?;
                Ok(Bytes::from(msgpack))
            }
            BinaryFormat::Bincode => {
                let bincode_data = bincode::serialize(delta)?;
                Ok(Bytes::from(bincode_data))
            }
        }
    }

    pub fn deserialize_delta(&self, data: &[u8]) -> Result<Delta> {
        match self.format {
            BinaryFormat::Json => {
                let delta = serde_json::from_slice(data)?;
                Ok(delta)
            }
            BinaryFormat::MessagePack => {
                let delta = rmp_serde::from_slice(data)?;
                Ok(delta)
            }
            BinaryFormat::Bincode => {
                let delta = bincode::deserialize(data)?;
                Ok(delta)
            }
        }
    }

    pub fn serialize_component(&self, component: &SerializedComponent) -> Result<Bytes> {
        match self.format {
            BinaryFormat::Json => {
                let json = serde_json::to_vec(component)?;
                Ok(Bytes::from(json))
            }
            BinaryFormat::MessagePack => {
                let msgpack = rmp_serde::to_vec(component)?;
                Ok(Bytes::from(msgpack))
            }
            BinaryFormat::Bincode => {
                let bincode_data = bincode::serialize(component)?;
                Ok(Bytes::from(bincode_data))
            }
        }
    }

    pub fn deserialize_component(&self, data: &[u8]) -> Result<SerializedComponent> {
        match self.format {
            BinaryFormat::Json => {
                let component = serde_json::from_slice(data)?;
                Ok(component)
            }
            BinaryFormat::MessagePack => {
                let component = rmp_serde::from_slice(data)?;
                Ok(component)
            }
            BinaryFormat::Bincode => {
                let component = bincode::deserialize(data)?;
                Ok(component)
            }
        }
    }

    pub fn get_format(&self) -> BinaryFormat {
        self.format
    }
}

pub struct StreamingSerializer {
    format: BinaryFormat,
    buffer: BytesMut,
}

impl StreamingSerializer {
    pub fn new(format: BinaryFormat) -> Self {
        Self {
            format,
            buffer: BytesMut::with_capacity(8192),
        }
    }

    pub fn write_message(&mut self, message: &Message) -> Result<()> {
        let serializer = BinarySerializer::new(self.format);
        let data = serializer.serialize_message(message)?;

        let len = data.len() as u32;
        self.buffer.put_u32_le(len);
        self.buffer.put(data);

        Ok(())
    }

    pub fn flush(&mut self) -> Bytes {
        self.buffer.split().freeze()
    }

    pub fn clear(&mut self) {
        self.buffer.clear();
    }
}

pub struct StreamingDeserializer {
    format: BinaryFormat,
    buffer: BytesMut,
}

impl StreamingDeserializer {
    pub fn new(format: BinaryFormat) -> Self {
        Self {
            format,
            buffer: BytesMut::with_capacity(8192),
        }
    }

    pub fn feed(&mut self, data: &[u8]) {
        self.buffer.extend_from_slice(data);
    }

    pub fn try_read_message(&mut self) -> Result<Option<Message>> {
        if self.buffer.len() < 4 {
            return Ok(None);
        }

        let len = u32::from_le_bytes([
            self.buffer[0],
            self.buffer[1],
            self.buffer[2],
            self.buffer[3],
        ]) as usize;

        if self.buffer.len() < 4 + len {
            return Ok(None);
        }

        self.buffer.advance(4);

        let message_data = self.buffer.split_to(len);

        let serializer = BinarySerializer::new(self.format);
        let message = serializer.deserialize_message(&message_data)?;

        Ok(Some(message))
    }

    pub fn clear(&mut self) {
        self.buffer.clear();
    }
}

trait Advance {
    fn advance(&mut self, cnt: usize);
}

impl Advance for BytesMut {
    fn advance(&mut self, cnt: usize) {
        let _ = self.split_to(cnt);
    }
}

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

    #[test]
    fn test_json_serialization() {
        let serializer = BinarySerializer::json();
        let message = Message::ping(1);

        let serialized = serializer.serialize_message(&message).unwrap();
        let deserialized = serializer.deserialize_message(&serialized).unwrap();

        assert_eq!(message.header.msg_type, deserialized.header.msg_type);
    }

    #[test]
    fn test_messagepack_serialization() {
        let serializer = BinarySerializer::messagepack();
        let message = Message::ping(1);

        let serialized = serializer.serialize_message(&message).unwrap();
        let deserialized = serializer.deserialize_message(&serialized).unwrap();

        assert_eq!(message.header.msg_type, deserialized.header.msg_type);
    }

    #[test]
    fn test_bincode_serialization() {
        let serializer = BinarySerializer::bincode();

        let snapshot = WorldSnapshot {
            entities: vec![],
            timestamp: 100.0,
            version: "1.0.0".to_string(),
        };

        let serialized = serializer.serialize_snapshot(&snapshot).unwrap();
        let deserialized = serializer.deserialize_snapshot(&serialized).unwrap();

        assert_eq!(snapshot.timestamp, deserialized.timestamp);
    }

    #[test]
    fn test_streaming_serialization() {
        let mut stream_serializer = StreamingSerializer::new(BinaryFormat::MessagePack);
        let mut stream_deserializer = StreamingDeserializer::new(BinaryFormat::MessagePack);

        let msg1 = Message::ping(1);
        let msg2 = Message::pong(1);

        stream_serializer.write_message(&msg1).unwrap();
        stream_serializer.write_message(&msg2).unwrap();

        let data = stream_serializer.flush();
        stream_deserializer.feed(&data);

        let decoded1 = stream_deserializer.try_read_message().unwrap().unwrap();
        let decoded2 = stream_deserializer.try_read_message().unwrap().unwrap();

        assert_eq!(msg1.header.msg_type, decoded1.header.msg_type);
        assert_eq!(msg2.header.msg_type, decoded2.header.msg_type);
    }

    #[test]
    fn test_snapshot_serialization() {
        let snapshot = WorldSnapshot {
            entities: vec![
                SerializedEntity {
                    id: 1,
                    components: vec![
                        SerializedComponent {
                            id: "Position".to_string(),
                            data: ComponentData::from_json_value(serde_json::json!({"x": 10.0, "y": 20.0})),
                        }
                    ],
                }
            ],
            timestamp: 123.456,
            version: "1.0.0".to_string(),
        };

        let serializer = BinarySerializer::messagepack();
        let serialized = serializer.serialize_snapshot(&snapshot).unwrap();
        let deserialized = serializer.deserialize_snapshot(&serialized).unwrap();

        assert_eq!(snapshot.entities.len(), deserialized.entities.len());
        assert_eq!(snapshot.timestamp, deserialized.timestamp);
        assert_eq!(snapshot.version, deserialized.version);
    }
}