serdes-ai-streaming 0.2.6

Streaming support for serdes-ai (SSE, WebSocket, async streams)
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
//! Server-Sent Events (SSE) parsing.
//!
//! This module provides utilities for parsing SSE streams from HTTP responses.

use crate::error::{StreamError, StreamResult};
use crate::partial_response::ResponseDelta;
use bytes::Bytes;
use futures::{Stream, StreamExt};
use pin_project_lite::pin_project;
use serde::de::DeserializeOwned;
use std::collections::VecDeque;
use std::pin::Pin;
use std::task::{Context, Poll};

const MAX_BUFFER_SIZE: usize = 10 * 1024 * 1024;

/// A parsed SSE event.
#[derive(Debug, Clone)]
pub struct SseEvent {
    /// Event type (if specified).
    pub event: Option<String>,
    /// Event data.
    pub data: String,
    /// Event ID (if specified).
    pub id: Option<String>,
    /// Retry timeout (if specified).
    pub retry: Option<u64>,
}

impl SseEvent {
    /// Create a new SSE event with just data.
    pub fn data(data: impl Into<String>) -> Self {
        Self {
            event: None,
            data: data.into(),
            id: None,
            retry: None,
        }
    }

    /// Set the event type.
    pub fn with_event(mut self, event: impl Into<String>) -> Self {
        self.event = Some(event.into());
        self
    }

    /// Set the event ID.
    pub fn with_id(mut self, id: impl Into<String>) -> Self {
        self.id = Some(id.into());
        self
    }

    /// Check if this is a "done" event (e.g., [DONE]).
    pub fn is_done(&self) -> bool {
        self.data.trim() == "[DONE]" || self.event.as_deref() == Some("done")
    }

    /// Parse the data as JSON.
    pub fn parse_data<T: DeserializeOwned>(&self) -> Result<T, serde_json::Error> {
        serde_json::from_str(&self.data)
    }
}

/// Parser for Server-Sent Events streams.
#[derive(Debug, Default)]
pub struct SseParser {
    buffer: String,
    events: VecDeque<SseEvent>,
    last_event_id: Option<String>,
}

impl SseParser {
    /// Create a new SSE parser.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Feed bytes into the parser.
    pub fn feed(&mut self, bytes: &Bytes) -> StreamResult<Vec<SseEvent>> {
        let chunk = String::from_utf8_lossy(bytes);
        self.feed_str(&chunk)
    }

    /// Feed a string into the parser.
    pub fn feed_str(&mut self, s: &str) -> StreamResult<Vec<SseEvent>> {
        self.buffer.push_str(s);

        if self.buffer.len() > MAX_BUFFER_SIZE {
            return Err(StreamError::BufferOverflow);
        }

        self.parse_buffer()
    }

    /// Call when stream ends to flush any remaining event.
    pub fn finish(&mut self) -> StreamResult<Vec<SseEvent>> {
        let mut events = self.parse_buffer()?;

        if !self.buffer.trim().is_empty() {
            if let Some(event) = self.parse_event(self.buffer.trim_end_matches(['\n', '\r'])) {
                if let Some(id) = &event.id {
                    self.last_event_id = Some(id.clone());
                }
                self.events.push_back(event.clone());
                events.push(event);
            }
        }

        self.buffer.clear();

        Ok(events)
    }

    /// Get the next parsed event.
    pub fn next_event(&mut self) -> Option<SseEvent> {
        self.events.pop_front()
    }

    /// Check if there are pending events.
    pub fn has_events(&self) -> bool {
        !self.events.is_empty()
    }

    /// Get the last event ID.
    pub fn last_event_id(&self) -> Option<&str> {
        self.last_event_id.as_deref()
    }

    /// Clear the parser state.
    pub fn clear(&mut self) {
        self.buffer.clear();
        self.events.clear();
    }

    fn parse_buffer(&mut self) -> StreamResult<Vec<SseEvent>> {
        let mut parsed_events = Vec::new();

        // Split by double newlines (event boundaries)
        while let Some((pos, delimiter_len)) = self.find_event_boundary() {
            let event_str = self.buffer[..pos].to_string();
            self.buffer = self.buffer[pos + delimiter_len..].to_string();
            self.buffer = self.buffer.trim_start_matches(['\n', '\r']).to_string();

            if let Some(event) = self.parse_event(&event_str) {
                if let Some(id) = &event.id {
                    self.last_event_id = Some(id.clone());
                }
                self.events.push_back(event.clone());
                parsed_events.push(event);
            }
        }

        Ok(parsed_events)
    }

    fn find_event_boundary(&self) -> Option<(usize, usize)> {
        let newline = self.buffer.find("\n\n").map(|pos| (pos, 2));
        let carriage = self.buffer.find("\r\n\r\n").map(|pos| (pos, 4));

        match (newline, carriage) {
            (Some(nl), Some(cr)) => Some(if cr.0 < nl.0 { cr } else { nl }),
            (Some(nl), None) => Some(nl),
            (None, Some(cr)) => Some(cr),
            (None, None) => None,
        }
    }

    fn parse_event(&self, s: &str) -> Option<SseEvent> {
        let mut event = None;
        let mut data_lines = Vec::new();
        let mut id = None;
        let mut retry = None;

        for line in s.lines() {
            if line.is_empty() || line.starts_with(':') {
                // Comment or empty line
                continue;
            }

            if let Some(value) = line.strip_prefix("event:") {
                event = Some(value.trim().to_string());
            } else if let Some(value) = line.strip_prefix("data:") {
                data_lines.push(value.trim_start().to_string());
            } else if let Some(value) = line.strip_prefix("id:") {
                id = Some(value.trim().to_string());
            } else if let Some(value) = line.strip_prefix("retry:") {
                retry = value.trim().parse().ok();
            } else if line.starts_with("data") {
                // "data" without colon means empty data line
                data_lines.push(String::new());
            }
        }

        if data_lines.is_empty() {
            return None;
        }

        Some(SseEvent {
            event,
            data: data_lines.join("\n"),
            id,
            retry,
        })
    }
}

pin_project! {
    /// Stream adapter that parses SSE from a byte stream.
    pub struct SseStream<S> {
        #[pin]
        inner: S,
        parser: SseParser,
        finished: bool,
    }
}

impl<S> SseStream<S>
where
    S: Stream<Item = Result<Bytes, std::io::Error>>,
{
    /// Create a new SSE stream from a byte stream.
    pub fn new(inner: S) -> Self {
        Self {
            inner,
            parser: SseParser::new(),
            finished: false,
        }
    }
}

impl<S> Stream for SseStream<S>
where
    S: Stream<Item = Result<Bytes, std::io::Error>> + Unpin,
{
    type Item = StreamResult<SseEvent>;

    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        let mut this = self.project();

        // Return buffered events first
        if let Some(event) = this.parser.next_event() {
            return Poll::Ready(Some(Ok(event)));
        }

        if *this.finished {
            return Poll::Ready(None);
        }

        // Poll for more data
        match this.inner.poll_next_unpin(cx) {
            Poll::Ready(Some(Ok(bytes))) => {
                if let Err(error) = this.parser.feed(&bytes) {
                    return Poll::Ready(Some(Err(error)));
                }

                if let Some(event) = this.parser.next_event() {
                    Poll::Ready(Some(Ok(event)))
                } else {
                    cx.waker().wake_by_ref();
                    Poll::Pending
                }
            }
            Poll::Ready(Some(Err(e))) => Poll::Ready(Some(Err(StreamError::Io(e)))),
            Poll::Ready(None) => {
                *this.finished = true;

                if let Err(error) = this.parser.finish() {
                    return Poll::Ready(Some(Err(error)));
                }

                // Return any remaining events
                if let Some(event) = this.parser.next_event() {
                    Poll::Ready(Some(Ok(event)))
                } else {
                    Poll::Ready(None)
                }
            }
            Poll::Pending => Poll::Pending,
        }
    }
}

/// Extension trait for converting SSE events to response deltas.
pub trait SseEventExt {
    /// Convert to a response delta (if possible).
    fn to_response_delta(&self) -> Option<ResponseDelta>;
}

impl SseEventExt for SseEvent {
    fn to_response_delta(&self) -> Option<ResponseDelta> {
        if self.is_done() {
            return Some(ResponseDelta::Finish {
                reason: serdes_ai_core::FinishReason::Stop,
            });
        }

        // Try to parse as JSON and extract delta
        // This is provider-specific, so we attempt common formats
        if let Ok(json) = self.parse_data::<serde_json::Value>() {
            // OpenAI format: choices[0].delta
            if let Some(choices) = json.get("choices").and_then(|c| c.as_array()) {
                if let Some(choice) = choices.first() {
                    if let Some(delta) = choice.get("delta") {
                        if let Some(content) = delta.get("content").and_then(|c| c.as_str()) {
                            return Some(ResponseDelta::Text {
                                index: 0,
                                content: content.to_string(),
                            });
                        }
                    }
                }
            }

            // Anthropic format: type = "content_block_delta"
            if json.get("type").and_then(|t| t.as_str()) == Some("content_block_delta") {
                if let Some(delta) = json.get("delta") {
                    if let Some(text) = delta.get("text").and_then(|t| t.as_str()) {
                        let index =
                            json.get("index").and_then(|i| i.as_u64()).unwrap_or(0) as usize;
                        return Some(ResponseDelta::Text {
                            index,
                            content: text.to_string(),
                        });
                    }
                }
            }
        }

        None
    }
}

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

    #[test]
    fn test_sse_parser_basic() {
        let mut parser = SseParser::new();
        parser.feed_str("data: hello\n\n").unwrap();

        let event = parser.next_event().unwrap();
        assert_eq!(event.data, "hello");
        assert!(event.event.is_none());
    }

    #[test]
    fn test_sse_parser_with_event_type() {
        let mut parser = SseParser::new();
        parser.feed_str("event: message\ndata: hello\n\n").unwrap();

        let event = parser.next_event().unwrap();
        assert_eq!(event.event, Some("message".to_string()));
        assert_eq!(event.data, "hello");
    }

    #[test]
    fn test_sse_parser_multiline_data() {
        let mut parser = SseParser::new();
        parser.feed_str("data: line1\ndata: line2\n\n").unwrap();

        let event = parser.next_event().unwrap();
        assert_eq!(event.data, "line1\nline2");
    }

    #[test]
    fn test_sse_parser_multiple_events() {
        let mut parser = SseParser::new();
        parser.feed_str("data: first\n\ndata: second\n\n").unwrap();

        let event1 = parser.next_event().unwrap();
        let event2 = parser.next_event().unwrap();

        assert_eq!(event1.data, "first");
        assert_eq!(event2.data, "second");
        assert!(parser.next_event().is_none());
    }

    #[test]
    fn test_sse_parser_with_id() {
        let mut parser = SseParser::new();
        parser.feed_str("id: 123\ndata: hello\n\n").unwrap();

        let event = parser.next_event().unwrap();
        assert_eq!(event.id, Some("123".to_string()));
        assert_eq!(parser.last_event_id(), Some("123"));
    }

    #[test]
    fn test_sse_parser_with_retry() {
        let mut parser = SseParser::new();
        parser.feed_str("retry: 5000\ndata: hello\n\n").unwrap();

        let event = parser.next_event().unwrap();
        assert_eq!(event.retry, Some(5000));
    }

    #[test]
    fn test_sse_parser_ignores_comments() {
        let mut parser = SseParser::new();
        parser
            .feed_str(": this is a comment\ndata: hello\n\n")
            .unwrap();

        let event = parser.next_event().unwrap();
        assert_eq!(event.data, "hello");
    }

    #[test]
    fn test_sse_event_is_done() {
        let event = SseEvent::data("[DONE]");
        assert!(event.is_done());

        let event = SseEvent::data("hello");
        assert!(!event.is_done());

        let event = SseEvent::data("something").with_event("done");
        assert!(event.is_done());
    }

    #[test]
    fn test_sse_event_parse_data() {
        let event = SseEvent::data("{\"key\": \"value\"}");
        let parsed: serde_json::Value = event.parse_data().unwrap();
        assert_eq!(parsed["key"], "value");
    }

    #[test]
    fn test_sse_parser_incremental() {
        let mut parser = SseParser::new();

        // Feed partial data
        parser.feed_str("data: hel").unwrap();
        assert!(parser.next_event().is_none());

        parser.feed_str("lo\n\n").unwrap();
        let event = parser.next_event().unwrap();
        assert_eq!(event.data, "hello");
    }

    #[test]
    fn test_sse_to_response_delta() {
        // Test [DONE] event
        let done_event = SseEvent::data("[DONE]");
        let delta = done_event.to_response_delta().unwrap();
        assert!(matches!(delta, ResponseDelta::Finish { .. }));

        // Test OpenAI format
        let openai_event = SseEvent::data(r#"{"choices":[{"delta":{"content":"Hello"}}]}"#);
        let delta = openai_event.to_response_delta().unwrap();
        if let ResponseDelta::Text { content, .. } = delta {
            assert_eq!(content, "Hello");
        } else {
            panic!("Expected text delta");
        }
    }
}