modelrelay 6.5.0

Rust SDK for the ModelRelay API
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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
use std::{
    collections::VecDeque,
    pin::Pin,
    sync::{
        atomic::{AtomicBool, Ordering},
        Arc,
    },
    task::{Context, Poll},
    time::Instant,
};

use futures_core::Stream;
use futures_util::{stream, StreamExt};
use reqwest::Response as HttpResponse;

use crate::{
    core::{consume_ndjson_buffer, map_event, RawEvent},
    errors::{
        Error, Result, StreamTimeoutError, StreamTimeoutKind, TransportError, TransportErrorKind,
    },
    http::StreamTimeouts,
    telemetry::StreamTelemetry,
    tools::ToolCallAccumulator,
    types::{
        ContentPart, Model, OutputItem, Response, StopReason, StreamEvent, StreamEventKind, Usage,
    },
};

const MAX_PENDING_EVENTS: usize = 512;

/// State for NDJSON stream processing.
///
/// Extracted from tuple to improve readability and eliminate repeated destructuring.
struct NdjsonStreamState<B, E> {
    body: B,
    buffer: String,
    request_id: Option<String>,
    cancelled: Arc<AtomicBool>,
    pending: VecDeque<E>,
    telemetry: Option<StreamTelemetry>,
    timeouts: StreamTimeouts,
    started_at: Instant,
    last_activity: Instant,
    ttft_satisfied: bool,
}

impl<B, E> NdjsonStreamState<B, E> {
    fn new(
        body: B,
        request_id: Option<String>,
        cancelled: Arc<AtomicBool>,
        telemetry: Option<StreamTelemetry>,
        timeouts: StreamTimeouts,
        started_at: Instant,
    ) -> Self {
        Self {
            body,
            buffer: String::new(),
            request_id,
            cancelled,
            pending: VecDeque::new(),
            telemetry,
            timeouts,
            started_at,
            last_activity: started_at,
            ttft_satisfied: false,
        }
    }

    fn is_cancelled(&self) -> bool {
        self.cancelled.load(Ordering::SeqCst)
    }

    fn set_cancelled(&self) {
        self.cancelled.store(true, Ordering::SeqCst);
    }

    fn on_telemetry_closed(&self) {
        if let Some(t) = self.telemetry.as_ref() {
            t.on_closed();
        }
    }

    fn on_telemetry_error(&self, err: &Error) {
        if let Some(t) = self.telemetry.as_ref() {
            t.on_error(err);
        }
    }
}

impl<B> NdjsonStreamState<B, StreamEvent> {
    fn on_telemetry_event(&self, evt: &StreamEvent) {
        if let Some(t) = self.telemetry.as_ref() {
            t.on_event(evt);
        }
    }
}

/// Checks if any timeout has been exceeded and returns the appropriate error.
fn check_timeout_exceeded(
    timeouts: StreamTimeouts,
    started_at: Instant,
    last_activity: Instant,
    ttft_satisfied: bool,
) -> Option<StreamTimeoutError> {
    if let Some(total) = timeouts.total {
        if started_at.elapsed() >= total {
            return Some(StreamTimeoutError {
                kind: StreamTimeoutKind::Total,
                timeout: total,
            });
        }
    }
    if !ttft_satisfied {
        if let Some(ttft) = timeouts.ttft {
            if started_at.elapsed() >= ttft {
                return Some(StreamTimeoutError {
                    kind: StreamTimeoutKind::Ttft,
                    timeout: ttft,
                });
            }
        }
    }
    if let Some(idle) = timeouts.idle {
        if last_activity.elapsed() >= idle {
            return Some(StreamTimeoutError {
                kind: StreamTimeoutKind::Idle,
                timeout: idle,
            });
        }
    }
    None
}

/// Classifies a reqwest error into a transport error kind.
pub(crate) fn classify_reqwest_error(err: &reqwest::Error) -> TransportErrorKind {
    if err.is_timeout() {
        TransportErrorKind::Timeout
    } else if err.is_connect() {
        TransportErrorKind::Connect
    } else if err.is_request() {
        TransportErrorKind::Request
    } else {
        TransportErrorKind::Other
    }
}

/// Parses a chunk of bytes into UTF-8 text.
fn parse_utf8_chunk(chunk: &[u8]) -> std::result::Result<String, Error> {
    String::from_utf8(chunk.to_vec()).map_err(|e| Error::StreamProtocol {
        message: format!("invalid UTF-8 in stream: {}", e),
        raw_data: None,
    })
}

/// Result of processing NDJSON events from a buffer.
enum ProcessEventsResult {
    /// Successfully parsed events (possibly empty if only keepalives)
    Ok,
    /// Parse error encountered
    Err(Error),
    /// Backpressure limit exceeded
    Backpressure(usize),
}

/// Processes raw NDJSON events into typed events using a parser function.
fn process_ndjson_events<E, F>(
    events: Vec<RawEvent>,
    pending: &mut VecDeque<E>,
    ttft_satisfied: &mut bool,
    mut parser: F,
    ttft_checker: Option<fn(&E) -> bool>,
) -> ProcessEventsResult
where
    F: FnMut(&RawEvent) -> std::result::Result<Option<E>, Error>,
{
    for raw in events {
        match parser(&raw) {
            Ok(Some(evt)) => {
                if !*ttft_satisfied {
                    if let Some(checker) = ttft_checker {
                        if checker(&evt) {
                            *ttft_satisfied = true;
                        }
                    }
                }
                pending.push_back(evt);
                if pending.len() > MAX_PENDING_EVENTS {
                    return ProcessEventsResult::Backpressure(pending.len());
                }
            }
            Ok(None) => {} // keepalive, skip
            Err(err) => return ProcessEventsResult::Err(err),
        }
    }
    ProcessEventsResult::Ok
}

/// Streaming handle over NDJSON response events.
pub struct StreamHandle {
    request_id: Option<String>,
    stream: Pin<Box<dyn Stream<Item = Result<StreamEvent>> + Send>>,
    cancelled: Arc<AtomicBool>,
    telemetry: Option<StreamTelemetry>,
}

impl StreamHandle {
    pub(crate) fn new(
        response: HttpResponse,
        request_id: Option<String>,
        telemetry: Option<StreamTelemetry>,
        timeouts: StreamTimeouts,
        started_at: Instant,
    ) -> Self {
        let cancelled = Arc::new(AtomicBool::new(false));
        let stream = build_ndjson_stream(
            response,
            request_id.clone(),
            cancelled.clone(),
            telemetry.clone(),
            timeouts,
            started_at,
        );
        Self {
            request_id,
            stream: Box::pin(stream),
            cancelled,
            telemetry,
        }
    }

    /// Build a stream handle from a sequence of events (useful for tests/mocks).
    pub fn from_events(events: impl IntoIterator<Item = StreamEvent>) -> Self {
        Self::from_events_with_request_id(events, None)
    }

    /// Build a stream handle from events and an explicit request id.
    pub fn from_events_with_request_id(
        events: impl IntoIterator<Item = StreamEvent>,
        request_id: Option<String>,
    ) -> Self {
        let collected: Vec<StreamEvent> = events.into_iter().collect();
        let req_id = request_id.or_else(|| collected.iter().find_map(|evt| evt.request_id.clone()));
        let stream = stream::iter(collected.into_iter().map(Ok));
        Self::from_stream(stream, req_id, None)
    }

    pub(crate) fn from_stream<S>(
        stream: S,
        request_id: Option<String>,
        telemetry: Option<StreamTelemetry>,
    ) -> Self
    where
        S: Stream<Item = Result<StreamEvent>> + Send + 'static,
    {
        let cancelled = Arc::new(AtomicBool::new(false));
        let stream = build_custom_stream(stream, cancelled.clone(), telemetry.clone());
        Self {
            request_id,
            stream: Box::pin(stream),
            cancelled,
            telemetry,
        }
    }

    /// Request identifier returned by the server (if any).
    pub fn request_id(&self) -> Option<&str> {
        self.request_id.as_deref()
    }

    /// Cancel the in-flight streaming request.
    pub fn cancel(&self) {
        self.cancelled.store(true, Ordering::SeqCst);
    }

    /// Collect the streaming response into a full `Response` (non-streaming aggregate).
    pub async fn collect(mut self) -> Result<Response> {
        use futures_util::StreamExt;

        let mut content = String::new();
        let mut response_id: Option<String> = None;
        let mut model: Option<Model> = None;
        let mut usage: Option<Usage> = None;
        let mut stop_reason: Option<StopReason> = None;
        let mut tool_calls = None;
        let request_id = self.request_id.clone();
        let mut tool_acc = ToolCallAccumulator::default();

        while let Some(item) = self.next().await {
            let evt = item?;
            match evt.kind {
                StreamEventKind::MessageDelta => {
                    if let Some(delta) = evt.text_delta {
                        content.push_str(&delta);
                    }
                    if response_id.is_none() {
                        response_id = evt.response_id.clone();
                    }
                    if model.is_none() {
                        model = evt.model.clone();
                    }
                }
                StreamEventKind::MessageStart => {
                    if response_id.is_none() {
                        response_id = evt.response_id.clone();
                    }
                    if model.is_none() {
                        model = evt.model.clone();
                    }
                }
                StreamEventKind::ToolUseStart | StreamEventKind::ToolUseDelta => {
                    if let Some(delta) = evt.tool_call_delta {
                        tool_acc.process_delta(&delta);
                    }
                }
                StreamEventKind::ToolUseStop => {
                    if evt.tool_calls.is_some() {
                        tool_calls = evt.tool_calls;
                    }
                }
                StreamEventKind::MessageStop => {
                    stop_reason = evt.stop_reason.or(stop_reason);
                    usage = evt.usage.or(usage);
                    response_id = evt.response_id.or(response_id);
                    model = evt.model.or(model);
                    if evt.tool_calls.is_some() {
                        tool_calls = evt.tool_calls;
                    }
                    break;
                }
                _ => {}
            }
        }

        let tool_calls = tool_calls.or_else(|| {
            let calls = tool_acc.get_tool_calls();
            if calls.is_empty() {
                None
            } else {
                Some(calls)
            }
        });

        let output = vec![OutputItem::Message {
            role: crate::types::MessageRole::Assistant,
            content: vec![ContentPart::text(content)],
            tool_calls,
        }];

        // Fail fast if stream completed without identifiers or model info
        let id =
            response_id
                .or_else(|| request_id.clone())
                .ok_or_else(|| Error::StreamProtocol {
                    message: "stream completed without response_id or request_id".to_string(),
                    raw_data: None,
                })?;

        let model = model.ok_or_else(|| Error::StreamProtocol {
            message: "stream completed without model information".to_string(),
            raw_data: None,
        })?;

        Ok(Response {
            id,
            stop_reason,
            model,
            output,
            usage: usage.unwrap_or_default(),
            request_id,
            provider: None,
            citations: None,
            decoding_warnings: None,
        })
    }
}

impl Drop for StreamHandle {
    fn drop(&mut self) {
        self.cancel();
        if let Some(t) = self.telemetry.take() {
            t.on_closed();
        }
    }
}

impl Stream for StreamHandle {
    type Item = Result<StreamEvent>;

    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        let stream = unsafe { self.map_unchecked_mut(|s| &mut s.stream) };
        stream.poll_next(cx)
    }
}

fn build_ndjson_stream(
    response: HttpResponse,
    request_id: Option<String>,
    cancelled: Arc<AtomicBool>,
    telemetry: Option<StreamTelemetry>,
    timeouts: StreamTimeouts,
    started_at: Instant,
) -> impl Stream<Item = Result<StreamEvent>> + Send {
    let body = response.bytes_stream();
    let state =
        NdjsonStreamState::new(body, request_id, cancelled, telemetry, timeouts, started_at);

    stream::unfold(state, |mut state| async move {
        loop {
            // Check cancellation
            if state.is_cancelled() {
                state.on_telemetry_closed();
                return None;
            }

            // Check timeouts (pure function)
            if let Some(timeout_err) = check_timeout_exceeded(
                state.timeouts,
                state.started_at,
                state.last_activity,
                state.ttft_satisfied,
            ) {
                let err = Error::StreamTimeout(timeout_err);
                state.set_cancelled();
                state.on_telemetry_error(&err);
                return Some((Err(err), state));
            }

            // Return pending events
            if let Some(event) = state.pending.pop_front() {
                state.on_telemetry_event(&event);
                return Some((Ok(event), state));
            }

            // Calculate deadline for next read
            let next_deadline = stream_next_deadline(
                state.timeouts,
                state.started_at,
                state.last_activity,
                state.ttft_satisfied,
            );

            // Read next chunk with optional timeout
            let next_item = if let Some((_, remaining, _)) = next_deadline {
                match tokio::time::timeout(remaining, state.body.next()).await {
                    Ok(v) => v,
                    Err(_) => {
                        let (kind, _, configured) = next_deadline.expect("deadline must exist");
                        let err = Error::StreamTimeout(StreamTimeoutError {
                            kind,
                            timeout: configured,
                        });
                        state.set_cancelled();
                        state.on_telemetry_error(&err);
                        return Some((Err(err), state));
                    }
                }
            } else {
                state.body.next().await
            };

            match next_item {
                Some(Ok(chunk)) => {
                    state.last_activity = Instant::now();

                    // Parse UTF-8
                    let text = match parse_utf8_chunk(&chunk) {
                        Ok(s) => s,
                        Err(err) => {
                            state.on_telemetry_error(&err);
                            return Some((Err(err), state));
                        }
                    };

                    // Parse NDJSON lines
                    state.buffer.push_str(&text);
                    let (events, remainder) = consume_ndjson_buffer(&state.buffer);
                    state.buffer = remainder;

                    // Process events
                    let request_id = state.request_id.clone();
                    let result = process_ndjson_events(
                        events,
                        &mut state.pending,
                        &mut state.ttft_satisfied,
                        |raw| map_event(raw.clone(), request_id.clone()),
                        Some(event_counts_for_ttft),
                    );

                    match result {
                        ProcessEventsResult::Ok => {}
                        ProcessEventsResult::Err(err) => {
                            state.on_telemetry_error(&err);
                            return Some((Err(err), state));
                        }
                        ProcessEventsResult::Backpressure(dropped) => {
                            let err = Error::StreamBackpressure { dropped };
                            state.on_telemetry_error(&err);
                            return Some((Err(err), state));
                        }
                    }

                    // Return first pending event if available
                    if let Some(event) = state.pending.pop_front() {
                        state.on_telemetry_event(&event);
                        return Some((Ok(event), state));
                    }
                }
                Some(Err(err)) => {
                    let error = Error::Transport(TransportError {
                        kind: classify_reqwest_error(&err),
                        message: err.to_string(),
                        source: Some(err),
                        retries: None,
                    });
                    state.on_telemetry_error(&error);
                    return Some((Err(error), state));
                }
                None => {
                    // Stream ended, process remaining buffer
                    let (events, _) = consume_ndjson_buffer(&state.buffer);
                    state.buffer.clear();

                    let request_id = state.request_id.clone();
                    let result = process_ndjson_events(
                        events,
                        &mut state.pending,
                        &mut state.ttft_satisfied,
                        |raw| map_event(raw.clone(), request_id.clone()),
                        Some(event_counts_for_ttft),
                    );

                    match result {
                        ProcessEventsResult::Ok => {}
                        ProcessEventsResult::Err(err) => {
                            state.on_telemetry_error(&err);
                            return Some((Err(err), state));
                        }
                        ProcessEventsResult::Backpressure(dropped) => {
                            let err = Error::StreamBackpressure { dropped };
                            state.on_telemetry_error(&err);
                            return Some((Err(err), state));
                        }
                    }

                    if let Some(event) = state.pending.pop_front() {
                        state.on_telemetry_event(&event);
                        return Some((Ok(event), state));
                    }

                    state.on_telemetry_closed();
                    return None;
                }
            }
        }
    })
}

fn event_counts_for_ttft(event: &StreamEvent) -> bool {
    if let Some(text) = &event.text_delta {
        if !text.is_empty() {
            return true;
        }
    }
    if event.tool_call_delta.is_some() {
        return true;
    }
    if event
        .tool_calls
        .as_ref()
        .map(|c| !c.is_empty())
        .unwrap_or(false)
    {
        return true;
    }
    event.event == "error"
}

fn stream_next_deadline(
    timeouts: StreamTimeouts,
    started_at: Instant,
    last_activity: Instant,
    ttft_satisfied: bool,
) -> Option<(StreamTimeoutKind, std::time::Duration, std::time::Duration)> {
    let now_total = started_at.elapsed();
    let mut best: Option<(StreamTimeoutKind, std::time::Duration, std::time::Duration)> = None;

    if let Some(total) = timeouts.total {
        if total > now_total {
            let rem = total - now_total;
            best = Some((StreamTimeoutKind::Total, rem, total));
        } else {
            return Some((
                StreamTimeoutKind::Total,
                std::time::Duration::from_millis(0),
                total,
            ));
        }
    }
    if let Some(idle) = timeouts.idle {
        let elapsed = last_activity.elapsed();
        if idle > elapsed {
            let rem = idle - elapsed;
            best = match best {
                Some((k, brem, bcfg)) if brem <= rem => Some((k, brem, bcfg)),
                _ => Some((StreamTimeoutKind::Idle, rem, idle)),
            };
        } else {
            return Some((
                StreamTimeoutKind::Idle,
                std::time::Duration::from_millis(0),
                idle,
            ));
        }
    }
    if !ttft_satisfied {
        if let Some(ttft) = timeouts.ttft {
            if ttft > now_total {
                let rem = ttft - now_total;
                best = match best {
                    Some((k, brem, bcfg)) if brem <= rem => Some((k, brem, bcfg)),
                    _ => Some((StreamTimeoutKind::Ttft, rem, ttft)),
                };
            } else {
                return Some((
                    StreamTimeoutKind::Ttft,
                    std::time::Duration::from_millis(0),
                    ttft,
                ));
            }
        }
    }

    best
}

fn build_custom_stream<S>(
    stream: S,
    cancelled: Arc<AtomicBool>,
    telemetry: Option<StreamTelemetry>,
) -> impl Stream<Item = Result<StreamEvent>> + Send
where
    S: Stream<Item = Result<StreamEvent>> + Send + 'static,
{
    stream::unfold(
        (Box::pin(stream), cancelled, telemetry),
        |state| async move {
            let (mut stream, cancelled, telemetry) = state;
            if cancelled.load(Ordering::SeqCst) {
                if let Some(t) = telemetry.as_ref() {
                    t.on_closed();
                }
                return None;
            }
            match stream.next().await {
                Some(item) => {
                    if let Some(t) = telemetry.as_ref() {
                        match &item {
                            Ok(evt) => t.on_event(evt),
                            Err(err) => t.on_error(err),
                        }
                    }
                    Some((item, (stream, cancelled, telemetry)))
                }
                None => {
                    if let Some(t) = telemetry.as_ref() {
                        t.on_closed();
                    }
                    None
                }
            }
        },
    )
}

// NDJSON parsing functions are now in core.rs