alec 1.3.7

Adaptive Lazy Evolving Compression - Smart codec for IoT sensor data with 90% compression ratio
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

//! Regression tests for protocol header v2 changes:
//! - Timestamp stored as seconds (÷1000) instead of truncated milliseconds
//! - Sequence field u16 instead of u32
//! - context_version serialized as u24 (3 bytes)
//! - encode_raw() uses context.version() instead of hardcoded 0
//! - name_id serialized as u8 instead of u16 in multi-channel frame

use alec::protocol::{ChannelInput, EncodingType};
use alec::{Classifier, Context, Encoder, MessageHeader, MessageType, Priority, RawData};

#[test]
fn test_timestamp_seconds_not_ms() {
    let mut encoder = Encoder::new();
    let classifier = Classifier::default();
    let context = Context::new();

    // March 2025 in milliseconds
    let timestamp_ms: u64 = 1_741_234_567_000;
    let data = RawData::new(22.5, timestamp_ms);
    let classification = classifier.classify(&data, &context);
    let message = encoder.encode(&data, &classification, &context);

    // Should be seconds, not truncated ms
    assert_eq!(message.header.timestamp, 1_741_234_567u32);
    assert_ne!(
        message.header.timestamp,
        (1_741_234_567_000u64 & 0xFFFFFFFF) as u32
    );
}

#[test]
fn test_timestamp_no_49day_wrap() {
    let mut encoder = Encoder::new();
    let classifier = Classifier::default();
    let context = Context::new();

    // 50 days in milliseconds
    let timestamp_ms: u64 = 50 * 24 * 3600 * 1000; // 4_320_000_000
    let data = RawData::new(22.5, timestamp_ms);
    let classification = classifier.classify(&data, &context);
    let message = encoder.encode(&data, &classification, &context);

    // 50 days in seconds = 4_320_000
    assert_eq!(message.header.timestamp, 4_320_000u32);
}

#[test]
fn test_sequence_u16_rollover() {
    let mut encoder = Encoder::new();
    let classifier = Classifier::default();
    let context = Context::new();

    let data = RawData::new(22.5, 0);
    let classification = classifier.classify(&data, &context);

    // Burn through 65,535 calls (sequences 0..65535)
    for _ in 0..65_535 {
        encoder.encode(&data, &classification, &context);
    }

    // The 65,536th call should have sequence 65535
    let msg = encoder.encode(&data, &classification, &context);
    assert_eq!(msg.header.sequence, 65_535);

    // The 65,537th call wraps to 0
    let msg = encoder.encode(&data, &classification, &context);
    assert_eq!(msg.header.sequence, 0);

    // The 65,538th call is 1
    let msg = encoder.encode(&data, &classification, &context);
    assert_eq!(msg.header.sequence, 1);
}

#[test]
fn test_sequence_2_bytes_in_header() {
    let header = MessageHeader {
        version: 1,
        message_type: MessageType::Data,
        priority: Priority::P3Normal,
        sequence: 0x1234,
        timestamp: 0,
        context_version: 0,
    };

    let bytes = header.to_bytes();
    assert_eq!(bytes.len(), MessageHeader::SIZE);
    assert_eq!(MessageHeader::SIZE, 10);

    // Sequence occupies bytes[1..3] (2 bytes, big-endian)
    assert_eq!(bytes[1], 0x12);
    assert_eq!(bytes[2], 0x34);
}

#[test]
fn test_context_version_u24_range() {
    let header = MessageHeader {
        version: 1,
        message_type: MessageType::Data,
        priority: Priority::P3Normal,
        sequence: 0,
        timestamp: 0,
        context_version: 0x00ABCDEF,
    };

    let bytes = header.to_bytes();
    let restored = MessageHeader::from_bytes(&bytes).unwrap();
    assert_eq!(restored.context_version, 0x00ABCDEF);
}

#[test]
fn test_context_version_3_bytes_in_header() {
    let header = MessageHeader {
        version: 1,
        message_type: MessageType::Data,
        priority: Priority::P3Normal,
        sequence: 0,
        timestamp: 0,
        context_version: 255,
    };

    let bytes = header.to_bytes();
    // context_version at bytes[7..10] as u24 big-endian
    assert_eq!(&bytes[7..10], &[0x00, 0x00, 0xFF]);
    assert_eq!(MessageHeader::SIZE, 10);
}

#[test]
fn test_header_roundtrip_all_fields() {
    let header = MessageHeader {
        version: 1,
        message_type: MessageType::Sync,
        priority: Priority::P2Important,
        sequence: 60_000,
        timestamp: 1_741_234_567,
        context_version: 0x00AABBCC,
    };

    let bytes = header.to_bytes();
    let restored = MessageHeader::from_bytes(&bytes).unwrap();

    assert_eq!(restored.version, 1);
    assert_eq!(restored.message_type, MessageType::Sync);
    assert_eq!(restored.priority, Priority::P2Important);
    assert_eq!(restored.sequence, 60_000);
    assert_eq!(restored.timestamp, 1_741_234_567);
    assert_eq!(restored.context_version, 0x00AABBCC);
}

#[test]
fn test_encode_raw_context_version_not_zero() {
    let mut encoder = Encoder::new();
    let classifier = Classifier::default();
    let mut context = Context::new();

    // Warm up context so version > 0
    for i in 0..5 {
        let d = RawData::new(20.0 + i as f64, 1000 * i as u64);
        context.observe(&d);
    }
    assert!(context.version() > 0);

    // Encode a NaN → triggers encode_raw()
    let data = RawData::new(f64::NAN, 5000);
    let classification = classifier.classify(&data, &context);
    let message = encoder.encode(&data, &classification, &context);

    // encode_raw should use context.version(), not 0
    assert_ne!(message.header.context_version, 0);
    assert_eq!(message.header.context_version, context.version());
}

// ─── name_id u8 regression tests ───────────────────────────────────

/// Helper: warm up context for multi-channel tests
fn warmup_multi(ctx: &mut Context, values: &[f64], rounds: usize) {
    for r in 0..rounds {
        for (i, &val) in values.iter().enumerate() {
            let rd = RawData::with_source(i as u32, val, r as u64);
            ctx.observe(&rd);
        }
    }
}

#[test]
fn test_name_id_1_byte_in_frame() {
    let mut encoder = Encoder::new();
    let classifier = Classifier::default();
    let mut context = Context::new();

    let base = [22.5, 65.0, 1013.25];
    warmup_multi(&mut context, &base, 20);

    let channels: Vec<ChannelInput> = (0..3)
        .map(|i| ChannelInput {
            name_id: i as u8,
            source_id: i as u32,
            value: base[i] + 0.5, // slight drift → P3
        })
        .collect();

    let (message, _) = encoder.encode_multi_adaptive(&channels, 1000, &context, &classifier);

    let payload = &message.payload;

    // Skip varint source_id + Multi tag + count byte
    let mut pos = 0;
    while pos < payload.len() && payload[pos] & 0x80 != 0 {
        pos += 1;
    }
    pos += 1; // end of varint
    assert_eq!(payload[pos], EncodingType::Multi as u8);
    pos += 1; // Multi tag
    let count = payload[pos] as usize;
    pos += 1; // count

    // Parse each channel: name_id should be exactly 1 byte
    for _ in 0..count {
        let name_id = payload[pos];
        assert!(name_id <= 2, "name_id should be 0, 1, or 2");
        pos += 1; // name_id (1 byte!)

        let enc_byte = payload[pos];
        pos += 1;
        let enc_type = EncodingType::from_u8(enc_byte).unwrap();
        pos += enc_type.typical_size();
    }

    // We should have consumed exactly the whole payload
    assert_eq!(
        pos,
        payload.len(),
        "Payload not fully consumed — name_id is not 1 byte"
    );
}

#[test]
fn test_name_id_max_u8() {
    let mut encoder = Encoder::new();
    let mut decoder = alec::Decoder::new();
    let classifier = Classifier::default();
    let context = Context::new();

    let channels = vec![ChannelInput {
        name_id: 255,
        source_id: 255,
        value: 42.0,
    }];

    let (message, _) = encoder.encode_multi_adaptive(&channels, 1000, &context, &classifier);
    let decoded = decoder.decode_multi(&message, &context).unwrap();

    assert_eq!(decoded.len(), 1);
    assert_eq!(decoded[0].0, 255u8);
}

#[test]
fn test_name_id_roundtrip() {
    let mut encoder = Encoder::new();
    let mut decoder = alec::Decoder::new();
    let classifier = Classifier::default();
    let mut context = Context::new();

    let ids: [u8; 5] = [10, 42, 100, 200, 255];
    let values: [f64; 5] = [22.5, 65.0, 1013.25, 3.3, 48.0];

    // Warm up context keyed by name_id
    for r in 0..20 {
        for (i, &val) in values.iter().enumerate() {
            let rd = RawData::with_source(ids[i] as u32, val, r as u64);
            context.observe(&rd);
        }
    }

    // Use large drift (>2% relative) so no channel is classified P5
    let drifts: [f64; 5] = [1.0, 3.0, 30.0, 0.2, 2.0];
    let channels: Vec<ChannelInput> = ids
        .iter()
        .zip(values.iter().zip(drifts.iter()))
        .map(|(&id, (&val, &drift))| ChannelInput {
            name_id: id,
            source_id: id as u32,
            value: val + drift,
        })
        .collect();

    let (message, _) = encoder.encode_multi_adaptive(&channels, 2000, &context, &classifier);
    let decoded = decoder.decode_multi(&message, &context).unwrap();

    assert_eq!(decoded.len(), 5);
    for (i, (name_id, _value)) in decoded.iter().enumerate() {
        assert_eq!(*name_id, ids[i], "name_id mismatch at channel {}", i);
    }
}