qslib 0.15.1

QSlib QuantStudio qPCR machine library
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
463
464
465
466
467
468
469
470
471
use log;
use regex::bytes::Regex;
use std::sync::LazyLock;
use std::time::{Duration, Instant};
use thiserror::Error;

#[cfg(feature = "simd")]
use memchr::memchr3;

static TAG_REGEX: LazyLock<Regex> = LazyLock::new(|| {
    Regex::new(r"^<(/?)([A-Za-z0-9_.-]*)(>|$)").expect("Invalid TAG_REGEX pattern")
});

/*
This isn't quite right: the quote mismatchees for InstrumentServer appear to be at a line level.
*/

#[derive(Error, Debug)]
pub enum MsgReceiveError {
    #[error("Unexpected close tag: </{1}> at {0}.")]
    UnexpectedCloseTag(usize, String),
    #[error("Mismatched close tag: </{2}> at {1} closes <{3}> at {0}.")]
    MismatchedCloseTag(usize, usize, String, String),
}

pub struct MsgRecv {
    buf: Vec<u8>,
    tagstack: Vec<(Vec<u8>, usize)>,
    parttag: Option<usize>,
    msg_end: Option<usize>,
    msg_error: Option<MsgReceiveError>,
    tag_opened_at: Option<Instant>,
    tag_timeout: Duration,
}

#[cfg_attr(coverage_nightly, coverage(off))]
impl std::fmt::Debug for MsgRecv {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "MsgRecv {{ buf: {:?}, tagstack: {:?}, parttag: {:?}, msg_end: {:?}, msg_error: {:?}, tag_opened_at: {:?} }}", String::from_utf8_lossy(&self.buf), self.tagstack.iter().map(|(tag, _)| String::from_utf8_lossy(tag)).collect::<Vec<_>>(), self.parttag, self.msg_end, self.msg_error, self.tag_opened_at)
    }
}

impl Default for MsgRecv {
    fn default() -> Self {
        Self::new()
    }
}

impl MsgRecv {
    pub fn new() -> Self {
        Self {
            buf: Vec::with_capacity(1024),
            tagstack: Vec::new(),
            parttag: None,
            msg_end: None,
            msg_error: None,
            tag_opened_at: None,
            tag_timeout: Duration::from_secs(30),
        }
    }

    pub fn try_get_msg(&mut self) -> Result<Option<Vec<u8>>, MsgReceiveError> {
        match self.msg_end {
            Some(msg_end) => {
                let msg = Vec::from_iter(self.buf.drain(0..msg_end));
                self.msg_end = None;
                let cur_error = self.msg_error.take();
                self.tagstack.clear();
                self.parttag = None;
                self.tag_opened_at = None;
                let _another = self.check_from_pos(0); // We know no message is waiting now.
                if let Some(err) = cur_error {
                    return Err(err);
                }
                Ok(Some(msg))
            }
            None => Ok(None),
        }
    }

    fn check_from_pos(&mut self, start_pos: usize) -> bool {
        if self.msg_error.is_some() || self.msg_end.is_some() {
            return true;
        }
        self.parttag = None;
        let mut pos = start_pos;

        #[cfg(feature = "simd")]
        while let Some(offset) = memchr3(b'<', b'\n', b'>', &self.buf[pos..]) {
            // Defensive check: ensure we don't index out of bounds
            let idx = pos + offset;
            if idx >= self.buf.len() {
                break;
            }
            let c = self.buf[idx];
            if c == b'\n' {
                if self.tagstack.is_empty() {
                    self.msg_end = Some(idx + 1);
                    self.tag_opened_at = None;
                    return true;
                }
            } else if c == b'<' {
                match TAG_REGEX.captures(&self.buf[idx..]) {
                    Some(captures) => {
                        let (_a, [close, tag, end]) = captures.extract();
                        match (end, close) {
                            (b"", _) => {
                                self.parttag = Some(idx);
                                return false;
                            }
                            (_, b"/") => match self.tagstack.pop() {
                                Some(old_tag) => {
                                    if old_tag.0 != tag {
                                        self.msg_error = Some(MsgReceiveError::MismatchedCloseTag(
                                            old_tag.1,
                                            idx,
                                            String::from_utf8_lossy(tag).to_string(),
                                            String::from_utf8_lossy(&old_tag.0).to_string(),
                                        ));
                                        self.tagstack.clear();
                                        self.tag_opened_at = None;
                                    }
                                    if self.tagstack.is_empty() {
                                        self.tag_opened_at = None;
                                    }
                                }
                                None => {
                                    self.msg_error = Some(MsgReceiveError::UnexpectedCloseTag(
                                        idx,
                                        String::from_utf8_lossy(&tag).to_string(),
                                    ));
                                    self.tagstack.clear();
                                    self.tag_opened_at = None;
                                }
                            },
                            (_, _) => {
                                if self.tagstack.is_empty() {
                                    self.tag_opened_at = Some(Instant::now());
                                }
                                self.tagstack.push((tag.to_vec(), idx));
                            }
                        }
                    }
                    None => {}
                }
            }
            pos += offset + 1;
        }

        #[cfg(not(feature = "simd"))]
        while let Some(offset) = self.buf[pos..]
            .iter()
            .position(|&c| c == b'<' || c == b'\n' || c == b'>')
        {
            // Defensive check: ensure we don't index out of bounds
            let idx = pos + offset;
            if idx >= self.buf.len() {
                break;
            }
            let c = self.buf[idx];
            if c == b'\n' {
                if self.tagstack.is_empty() {
                    self.msg_end = Some(idx + 1);
                    self.tag_opened_at = None;
                    return true;
                }
            } else if c == b'<' {
                if let Some(captures) = TAG_REGEX.captures(&self.buf[idx..]) {
                    let (_a, [close, tag, end]) = captures.extract();
                    match (end, close) {
                        (b"", _) => {
                            self.parttag = Some(idx);
                            return false;
                        }
                        (_, b"/") => match self.tagstack.pop() {
                            Some(old_tag) => {
                                if old_tag.0 != tag {
                                    self.msg_error = Some(MsgReceiveError::MismatchedCloseTag(
                                        old_tag.1,
                                        idx,
                                        String::from_utf8_lossy(tag).to_string(),
                                        String::from_utf8_lossy(&old_tag.0).to_string(),
                                    ));
                                    self.tagstack.clear();
                                    self.tag_opened_at = None;
                                }
                                if self.tagstack.is_empty() {
                                    self.tag_opened_at = None;
                                }
                            }
                            None => {
                                self.msg_error = Some(MsgReceiveError::UnexpectedCloseTag(
                                    idx,
                                    String::from_utf8_lossy(tag).to_string(),
                                ));
                                self.tagstack.clear();
                                self.tag_opened_at = None;
                            }
                        },
                        (_, _) => {
                            if self.tagstack.is_empty() {
                                self.tag_opened_at = Some(Instant::now());
                            }
                            self.tagstack.push((tag.to_vec(), idx));
                        }
                    }
                }
            }
            pos += offset + 1;
        }

        false
    }

    /// Push data into the message receiver buffer.
    ///
    /// This function appends the provided data to the internal buffer and checks
    /// if a complete message is available. A complete message is determined by
    /// finding a newline character when the XML tag stack is empty.
    ///
    /// # Arguments
    ///
    /// * `data` - The byte slice to append to the buffer
    ///
    /// # Returns
    ///
    /// Returns `true` if a complete message is ready to be retrieved (via `try_get_msg`),
    /// or if there's a message error. Returns `false` if more data is needed or if
    /// parsing encountered a partial XML-like tag.
    ///
    /// # Examples
    ///
    /// ```
    /// use qslib::message_receiver::MsgRecv;
    ///
    /// let mut receiver = MsgRecv::new();
    /// let ready = receiver.push_data(b"OK 1 success\n");
    /// assert!(ready);
    /// ```
    pub fn push_data(&mut self, data: &[u8]) -> bool {
        // Check for tag timeout: if tags have been open too long, force-close them
        if !self.tagstack.is_empty() {
            if let Some(opened_at) = self.tag_opened_at {
                if opened_at.elapsed() > self.tag_timeout {
                    log::warn!(
                        "Tag stack timeout after {:?}: force-closing {} unclosed tag(s)",
                        self.tag_timeout,
                        self.tagstack.len()
                    );
                    self.tagstack.clear();
                    self.tag_opened_at = None;
                    // Re-scan from start to find message boundaries
                    let result = self.check_from_pos(0);
                    if result {
                        return true;
                    }
                }
            }
        }
        let last_pos = self.parttag.unwrap_or(self.buf.len());
        self.buf.extend_from_slice(data);
        self.check_from_pos(last_pos)
    }
}

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

    #[test]
    fn test_push_while_message_waiting() {
        let mut receiver = MsgRecv::new();

        // Push first complete message
        receiver.push_data(b"OK 1 success\n");

        // Push second message while first is still waiting
        receiver.push_data(b"OK 2 also success\n");

        // Now retrieve both messages
        let msg1 = receiver.try_get_msg().unwrap().unwrap();
        assert_eq!(&msg1, b"OK 1 success\n");

        let msg2 = receiver.try_get_msg().unwrap().unwrap();
        assert_eq!(&msg2, b"OK 2 also success\n");

        // Verify no more messages
        assert!(receiver.try_get_msg().unwrap().is_none());
    }

    #[test]
    fn test_push_partial_while_message_waiting() {
        let mut receiver = MsgRecv::new();
        receiver.push_data(b"OK 1 success\n");
        receiver.push_data(b"OK 2 ");
        receiver.push_data(b"also success\n");
        let msg1 = receiver.try_get_msg().unwrap().unwrap();
        assert_eq!(&msg1, b"OK 1 success\n");
        let msg2 = receiver.try_get_msg().unwrap().unwrap();
        assert_eq!(&msg2, b"OK 2 also success\n");
    }

    #[test]
    fn test_push_partial_xml_tag() {
        let mut receiver = MsgRecv::new();
        receiver.push_data(b"<test");
        receiver.push_data(b">OK 2 \n");
        receiver.push_data(b"also <another>\n\n\r\n</another> success</te");

        // Push the closing tag
        receiver.push_data(b"st>\n");

        let msg = receiver.try_get_msg();

        assert_eq!(
            String::from_utf8_lossy(&msg.unwrap().unwrap()),
            "<test>OK 2 \nalso <another>\n\n\r\n</another> success</test>\n"
        );
    }

    // =====================================================================
    // Additional message receiver tests
    // =====================================================================

    #[test]
    fn test_simple_message() {
        let mut receiver = MsgRecv::new();
        let ready = receiver.push_data(b"OK 1 success\n");
        assert!(ready, "Should signal message ready");

        let msg = receiver.try_get_msg().unwrap().unwrap();
        assert_eq!(&msg, b"OK 1 success\n");
    }

    #[test]
    fn test_no_message_without_newline() {
        let mut receiver = MsgRecv::new();
        let ready = receiver.push_data(b"OK 1 success");
        assert!(!ready, "Should not signal ready without newline");

        let msg = receiver.try_get_msg().unwrap();
        assert!(msg.is_none(), "Should not have a message yet");
    }

    #[test]
    fn test_empty_message() {
        let mut receiver = MsgRecv::new();
        let ready = receiver.push_data(b"\n");
        assert!(ready, "Empty line is still a complete message");

        let msg = receiver.try_get_msg().unwrap().unwrap();
        assert_eq!(&msg, b"\n");
    }

    #[test]
    fn test_xml_preserves_internal_newlines() {
        let mut receiver = MsgRecv::new();
        receiver.push_data(b"OK 1 <quote>line1\nline2\nline3</quote>\n");

        let msg = receiver.try_get_msg().unwrap().unwrap();
        assert!(String::from_utf8_lossy(&msg).contains("line1\nline2\nline3"));
    }

    #[test]
    fn test_nested_xml_tags() {
        let mut receiver = MsgRecv::new();
        receiver.push_data(b"OK 1 <outer><inner>content\nwith\nnewlines</inner></outer>\n");

        let msg = receiver.try_get_msg().unwrap().unwrap();
        assert!(String::from_utf8_lossy(&msg)
            .contains("<outer><inner>content\nwith\nnewlines</inner></outer>"));
    }

    #[test]
    fn test_mismatched_close_tag_error() {
        let mut receiver = MsgRecv::new();
        receiver.push_data(b"<tag1>content</tag2>\n");

        let result = receiver.try_get_msg();
        assert!(result.is_err(), "Mismatched tags should produce an error");
    }

    #[test]
    fn test_unexpected_close_tag_error() {
        let mut receiver = MsgRecv::new();
        receiver.push_data(b"</unexpected>content\n");

        let result = receiver.try_get_msg();
        assert!(
            result.is_err(),
            "Unexpected close tag should produce an error"
        );
    }

    #[test]
    fn test_multiple_messages_in_one_push() {
        let mut receiver = MsgRecv::new();
        receiver.push_data(b"msg1\nmsg2\nmsg3\n");

        let msg1 = receiver.try_get_msg().unwrap().unwrap();
        assert_eq!(&msg1, b"msg1\n");

        let msg2 = receiver.try_get_msg().unwrap().unwrap();
        assert_eq!(&msg2, b"msg2\n");

        let msg3 = receiver.try_get_msg().unwrap().unwrap();
        assert_eq!(&msg3, b"msg3\n");

        assert!(receiver.try_get_msg().unwrap().is_none());
    }

    #[test]
    fn test_very_long_xml_content() {
        let mut receiver = MsgRecv::new();
        let long_content = "x".repeat(10000);
        let input = format!("OK 1 <data>{}</data>\n", long_content);
        receiver.push_data(input.as_bytes());

        let msg = receiver.try_get_msg().unwrap().unwrap();
        assert!(msg.len() > 10000);
    }

    #[test]
    fn test_receiver_reset_after_error() {
        let mut receiver = MsgRecv::new();

        // First, cause an error
        receiver.push_data(b"</unexpected>error\n");
        let _ = receiver.try_get_msg(); // Consume the error

        // Should work normally after
        receiver.push_data(b"OK 1 success\n");
        let msg = receiver.try_get_msg().unwrap().unwrap();
        assert_eq!(&msg, b"OK 1 success\n");
    }

    #[test]
    fn test_special_xml_tag_names() {
        let mut receiver = MsgRecv::new();
        receiver.push_data(b"OK 1 <multiline.protocol>content</multiline.protocol>\n");

        let msg = receiver.try_get_msg().unwrap().unwrap();
        assert!(String::from_utf8_lossy(&msg).contains("multiline.protocol"));
    }

    #[test]
    fn test_default_impl() {
        let mut receiver: MsgRecv = Default::default();
        assert!(receiver.try_get_msg().is_ok());
    }

    #[test]
    fn test_angle_brackets_in_content_not_tags() {
        // This tests the case where angle brackets appear in content but are NOT
        // valid XML-style tags (e.g., from `ip addr` output like <LOOPBACK,UP,LOWER_UP>)
        let mut receiver = MsgRecv::new();
        let ip_addr_output = b"OK 123 <quote.reply>1: lo: <LOOPBACK,UP,LOWER_UP> mtu 16436\n2: eth0: <BROADCAST,MULTICAST,UP> mtu 1500\n</quote.reply>\n";
        receiver.push_data(ip_addr_output);

        let msg = receiver.try_get_msg().unwrap().unwrap();
        let msg_str = String::from_utf8_lossy(&msg);
        assert!(
            msg_str.contains("<LOOPBACK,UP,LOWER_UP>"),
            "Should preserve angle brackets in content"
        );
        assert!(
            msg_str.contains("<BROADCAST,MULTICAST,UP>"),
            "Should preserve angle brackets in content"
        );
    }
}