cpa-exec 0.4.3

Part of cliproxy: upstream provider executors
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
//! Native Claude SSE relay (claude_executor_stream.go).
//!
//! Upstream bytes are read as lines like Go's `bufio.Scanner` (LF split, one
//! trailing CR dropped), MCP aliases are restored per line, and each blank line ends
//! an event. The relay stops after the event carrying `message_stop`, so anything an
//! upstream appends after the terminal event is never forwarded. A transport read
//! failure before `message_stop` becomes Go's `unexpected EOF`.

use std::collections::VecDeque;
use std::sync::Arc;

use bytes::{Bytes, BytesMut};
use cpa_core::exec::{ExecError, ExecStream, FailureScope};
use futures_util::StreamExt;

use super::alias::{self, Reverse};
use crate::rawjson;

/// Go `bufio.Scanner` buffer limit (50 MB).
const MAX_LINE: usize = 52_428_800;

/// `observeClaudeStreamLine`.
fn observe(line: &[u8], message_id: &mut String, completed: &mut bool) {
    let line = line.trim_ascii();
    let Some(payload) = line.strip_prefix(b"data:") else {
        return;
    };
    let Ok(payload) = std::str::from_utf8(payload.trim_ascii()) else {
        return;
    };
    if !rawjson::valid(payload) {
        return;
    }
    match rawjson::get(payload, "type").str() {
        "message_start" => {
            let id = rawjson::string(payload, "message.id");
            if !id.trim().is_empty() {
                *message_id = id.trim().to_owned();
            }
        }
        "message_stop" => *completed = true,
        _ => {}
    }
}

/// `reverseRemapOAuthToolNamesFromStreamLine` on one raw line.
pub(crate) fn restore_line(line: &[u8], reverse: &Reverse) -> Result<Vec<u8>, String> {
    if reverse.is_empty() {
        return Ok(line.to_vec());
    }
    let trimmed = line.trim_ascii();
    if trimmed.is_empty() || trimmed == b"[DONE]" || trimmed.starts_with(b"event:") {
        return Ok(line.to_vec());
    }
    let is_data = trimmed.starts_with(b"data:");
    let payload = if is_data { trimmed[5..].trim_ascii() } else { trimmed };
    let Ok(payload) = std::str::from_utf8(payload) else {
        return Ok(line.to_vec());
    };
    Ok(match alias::restore_event_payload(payload, reverse)? {
        Some(updated) if is_data => [b"data: ".as_slice(), updated.as_bytes()].concat(),
        Some(updated) => updated.into_bytes(),
        None => line.to_vec(),
    })
}

/// Message ID of a completed stream; `None` when `message_stop` was never seen.
pub(crate) type OnComplete = Box<dyn FnOnce(String) + Send>;

struct Relay {
    body: ExecStream,
    reverse: Arc<Reverse>,
    line: BytesMut,
    event: BytesMut,
    ready: VecDeque<Result<Bytes, ExecError>>,
    message_id: String,
    completed: bool,
    finished: bool,
    /// Translated clients: end on the `message_stop` data line itself, as Go's
    /// translated loop does, instead of waiting for the event's blank line.
    eager_terminal: bool,
    done: Option<OnComplete>,
    /// Go's usage reporter: every upstream line, before alias restore.
    usage: cpa_core::exec::UsageSink,
    /// Request logs: every scanner line before restore (`AppendAPIResponseChunk`) and
    /// the error that ends the stream (`RecordAPIResponseError`).
    capture: cpa_core::exec::CaptureSink,
}

impl Relay {
    /// Handles one line; returns false once the relay has finished.
    fn accept(&mut self, line: &[u8]) -> bool {
        if self.finished {
            return false;
        }
        observe(line, &mut self.message_id, &mut self.completed);
        // reporter.ObserveResponseModel and StreamUsageBuffer.ObserveClaudeStream.
        self.usage.response_line(cpa_core::format::Format::Claude, line);
        self.capture.record(cpa_core::exec::CaptureEvent::ResponseChunk(line));
        let restored = match restore_line(line, &self.reverse) {
            Ok(restored) => restored,
            Err(message) => {
                self.fail(super::plain_error(format!(
                    "restore Claude OAuth tool name from streaming response: {message}"
                )));
                return false;
            }
        };
        self.event.extend_from_slice(&restored);
        self.event.extend_from_slice(b"\n");
        if self.eager_terminal && self.completed {
            self.flush();
            self.finish();
            return false;
        }
        if restored.trim_ascii().is_empty() {
            self.flush();
            if self.completed {
                self.finish();
                return false;
            }
        }
        true
    }

    fn take_partial(&mut self) {
        let mut partial = std::mem::take(&mut self.line);
        if partial.is_empty() {
            return;
        }
        if partial.last() == Some(&b'\r') {
            partial.truncate(partial.len() - 1);
        }
        self.accept(&partial);
    }

    fn flush(&mut self) {
        if !self.event.is_empty() {
            let event = std::mem::take(&mut self.event).freeze();
            self.ready.push_back(Ok(event));
        }
    }

    fn fail(&mut self, error: ExecError) {
        self.capture_error(&error);
        self.event.clear();
        self.ready.push_back(Err(error));
        self.finished = true;
        self.done = None;
    }

    fn capture_error(&self, error: &ExecError) {
        if self.capture.enabled() {
            let text = String::from_utf8_lossy(&error.body);
            self.capture.record(cpa_core::exec::CaptureEvent::ResponseError(&text));
        }
    }

    fn finish(&mut self) {
        self.finished = true;
        if self.completed
            && let Some(done) = self.done.take()
        {
            done(std::mem::take(&mut self.message_id));
        }
    }

    fn chunk(&mut self, chunk: &[u8]) {
        self.line.extend_from_slice(chunk);
        while let Some(pos) = self.line.iter().position(|b| *b == b'\n') {
            // bufio.Scanner holds at most MAX_LINE bytes: the line and its newline must fit.
            if pos + 1 > MAX_LINE {
                self.fail(super::plain_error("bufio.Scanner: token too long"));
                return;
            }
            let mut line = self.line.split_to(pos + 1);
            line.truncate(pos);
            if line.last() == Some(&b'\r') {
                line.truncate(line.len() - 1);
            }
            if !self.accept(&line) {
                return;
            }
        }
        if self.line.len() > MAX_LINE {
            self.fail(super::plain_error("bufio.Scanner: token too long"));
        }
    }

    fn end(&mut self, error: Option<ExecError>) {
        // bufio.Scanner hands an unterminated final line to the split function on EOF
        // and on read errors alike (atEOF is true once any error is set).
        self.take_partial();
        if self.finished {
            return;
        }
        self.flush();
        if !self.completed
            && let Some(mut error) = error
        {
            if error.scope == FailureScope::Transport {
                error.body = Bytes::from_static(b"unexpected EOF");
            }
            self.capture_error(&error);
            self.ready.push_back(Err(error));
        }
        self.finish();
    }
}

/// Relays decoded upstream bytes as whole native SSE events. `done` runs once with
/// the message ID when the upstream completed with `message_stop`.
/// Every upstream line is reported to `usage` and `capture` before alias restore.
pub(crate) fn relay(
    body: ExecStream,
    reverse: Arc<Reverse>,
    done: OnComplete,
    usage: cpa_core::exec::UsageSink,
    capture: cpa_core::exec::CaptureSink,
) -> ExecStream {
    relay_with(body, reverse, done, false, usage, capture)
}

/// [`relay`] for a translated client: the stream ends on the `message_stop` data line.
pub(crate) fn relay_translated(
    body: ExecStream,
    reverse: Arc<Reverse>,
    done: OnComplete,
    usage: cpa_core::exec::UsageSink,
    capture: cpa_core::exec::CaptureSink,
) -> ExecStream {
    relay_with(body, reverse, done, true, usage, capture)
}

fn relay_with(
    body: ExecStream,
    reverse: Arc<Reverse>,
    done: OnComplete,
    eager_terminal: bool,
    usage: cpa_core::exec::UsageSink,
    capture: cpa_core::exec::CaptureSink,
) -> ExecStream {
    let relay = Relay {
        usage,
        capture,
        body,
        reverse,
        line: BytesMut::new(),
        event: BytesMut::new(),
        ready: VecDeque::new(),
        message_id: String::new(),
        completed: false,
        finished: false,
        eager_terminal,
        done: Some(done),
    };
    futures_util::stream::unfold(relay, |mut st| async move {
        loop {
            if let Some(item) = st.ready.pop_front() {
                return Some((item, st));
            }
            if st.finished {
                return None;
            }
            match st.body.next().await {
                Some(Ok(chunk)) => st.chunk(&chunk),
                Some(Err(error)) => st.end(Some(error)),
                None => st.end(None),
            }
        }
    })
    .boxed()
}

/// `validateClaudeStreamingResponse` for buffered SSE behind a non-stream client.
pub(crate) fn validate_buffered(data: &[u8]) -> Result<(), ExecError> {
    // statusErr{502}: classified by status like any upstream 502.
    let bad = |m: &str| ExecError::local(502, crate::upstream::scope_for(502), m.to_owned());
    let (mut has_data, mut start, mut delta) = (false, false, false);
    for line in data.split(|b| *b == b'\n') {
        let line = line.trim_ascii();
        let Some(payload) = line.strip_prefix(b"data:") else {
            continue;
        };
        let payload = payload.trim_ascii();
        if payload.is_empty() || payload == b"[DONE]" {
            continue;
        }
        has_data = true;
        let payload = std::str::from_utf8(payload).unwrap_or("");
        if !rawjson::valid(payload) {
            return Err(bad("claude executor: upstream returned malformed stream data"));
        }
        match rawjson::get(payload, "type").str() {
            "error" => {
                let mut message = rawjson::string(payload, "error.message").trim().to_owned();
                if message.is_empty() {
                    message = rawjson::string(payload, "error.type").trim().to_owned();
                }
                if message.is_empty() {
                    message = "unknown upstream error".into();
                }
                return Err(bad(&format!(
                    "claude executor: upstream returned error event: {message}"
                )));
            }
            "message_start" => {
                if rawjson::string(payload, "message.id").trim().is_empty()
                    || rawjson::string(payload, "message.model").trim().is_empty()
                {
                    return Err(bad(
                        "claude executor: upstream stream message_start is missing id or model",
                    ));
                }
                start = true;
            }
            "message_delta" => delta = true,
            _ => {}
        }
    }
    if !has_data {
        return Err(bad("claude executor: upstream returned empty stream response"));
    }
    if !start {
        return Err(bad(
            "claude executor: upstream stream response is missing message_start",
        ));
    }
    if !delta {
        return Err(bad(
            "claude executor: upstream stream response ended before message completion",
        ));
    }
    Ok(())
}

/// `claudeMessageIDFromSSE`: the message ID only when the buffered stream completed.
pub(crate) fn buffered_message_id(data: &[u8]) -> String {
    let (mut id, mut completed) = (String::new(), false);
    for line in data.split(|b| *b == b'\n') {
        observe(line, &mut id, &mut completed);
    }
    if completed { id } else { String::new() }
}

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

    fn chunks(items: Vec<Result<&'static [u8], ExecError>>) -> ExecStream {
        futures_util::stream::iter(items.into_iter().map(|r| r.map(Bytes::from_static))).boxed()
    }

    /// Request logs: every scanner line before restore, then Go's
    /// RecordAPIResponseError for the scanner error (`unexpected EOF`) or the restore
    /// failure that ends the stream.
    #[tokio::test]
    async fn request_logs_record_lines_then_the_ending_error() {
        let run = |body: ExecStream, reverse: Arc<Reverse>| async move {
            let captured = std::sync::Arc::new(crate::claude::tests::Captured::default());
            let _: Vec<_> = relay(
                body,
                reverse,
                Box::new(|_| {}),
                Default::default(),
                cpa_core::exec::CaptureSink::new(captured.clone()),
            )
            .collect()
            .await;
            std::mem::take(&mut *captured.0.lock().unwrap())
        };
        let broken = chunks(vec![
            Ok(b"event: ping\r\ndata: {}\n\npartial"),
            Err(ExecError::local(502, FailureScope::Transport, "connection reset")),
        ]);
        assert_eq!(
            run(broken, Arc::default()).await,
            [
                "chunk event: ping",
                "chunk data: {}",
                "chunk ",
                "chunk partial",
                "error unexpected EOF"
            ]
        );
        // Two declared aliases share the suffix: the restore fails on the alias line.
        let mut reverse = Reverse::new();
        reverse.insert("mcp__srv1__query".into(), "mcp__srv1__query".into());
        reverse.insert("mcp__srv2__query".into(), "mcp__srv2__query".into());
        reverse.insert("mcp__virt__word_other".into(), "other".into());
        let ambiguous = chunks(vec![Ok(
            b"data: {\"type\":\"content_block_start\",\"index\":0,\"content_block\":{\"type\":\"tool_use\",\"id\":\"t\",\"name\":\"mcp__virt__query\",\"input\":{}}}\n\n",
        )]);
        let events = run(ambiguous, Arc::new(reverse)).await;
        assert_eq!(events.len(), 2, "{events:?}");
        assert!(events[0].starts_with("chunk data: "), "{events:?}");
        assert!(
            events[1].starts_with("error restore Claude OAuth tool name from streaming response: "),
            "{events:?}"
        );
    }

    #[tokio::test]
    async fn translated_streams_end_on_the_message_stop_line() {
        // Go's translated loop breaks right after the message_stop data line; the
        // native loop waits for the event's blank line. The upstream stays open.
        let input = b"event: message_start\ndata: {\"type\":\"message_start\",\"message\":{\"id\":\"m\"}}\n\nevent: message_stop\ndata: {\"type\":\"message_stop\"}\n";
        let open = || {
            futures_util::stream::iter([Ok(Bytes::from_static(input))])
                .chain(futures_util::stream::pending())
                .boxed()
        };
        let out: Vec<_> = relay_translated(
            open(),
            Arc::default(),
            Box::new(|_| {}),
            Default::default(),
            Default::default(),
        )
        .map(Result::unwrap)
        .collect()
        .await;
        assert_eq!(
            out[1],
            Bytes::from_static(b"event: message_stop\ndata: {\"type\":\"message_stop\"}\n")
        );
        let mut native = relay(
            open(),
            Arc::default(),
            Box::new(|_| {}),
            Default::default(),
            Default::default(),
        );
        assert!(native.next().await.is_some());
        let waited = tokio::time::timeout(std::time::Duration::from_millis(50), native.next()).await;
        assert!(waited.is_err(), "native output waits for the blank line");
    }

    #[tokio::test]
    async fn crlf_terminal_and_truncation_follow_go() {
        let done = std::sync::Arc::new(std::sync::Mutex::new(None));
        let seen = done.clone();
        let body = chunks(vec![
            Ok(b"event: message_start\r\ndata: {\"type\":\"message_start\",\"message\":{\"id\":\"msg_1\"}}\r\n\r\nevent: message_st"),
            Ok(b"op\r\ndata: {\"type\":\"message_stop\"}\r\n\r\nevent: ping\r\ndata: {}\r\n\r\n"),
        ]);
        let out: Vec<_> = relay(
            body,
            Arc::default(),
            Box::new(move |id| *seen.lock().unwrap() = Some(id)),
            Default::default(),
            Default::default(),
        )
        .map(Result::unwrap)
        .collect()
        .await;
        assert_eq!(
            out,
            [
                Bytes::from_static(
                    b"event: message_start\ndata: {\"type\":\"message_start\",\"message\":{\"id\":\"msg_1\"}}\n\n"
                ),
                Bytes::from_static(b"event: message_stop\ndata: {\"type\":\"message_stop\"}\n\n"),
            ]
        );
        assert_eq!(done.lock().unwrap().as_deref(), Some("msg_1"));

        let body = chunks(vec![
            Ok(b"event: content_block_delta\ndata: {}\n\nevent: x\ndata: {"),
            Err(ExecError::local(
                502,
                FailureScope::Transport,
                "upstream request failed",
            )),
        ]);
        let out: Vec<_> = relay(
            body,
            Arc::default(),
            Box::new(|_| panic!("not completed")),
            Default::default(),
            Default::default(),
        )
        .collect()
        .await;
        assert_eq!(out.len(), 3);
        assert_eq!(out[1].as_ref().unwrap().as_ref(), b"event: x\ndata: {\n");
        assert_eq!(out[2].as_ref().unwrap_err().body.as_ref(), b"unexpected EOF");
    }

    #[tokio::test]
    async fn every_upstream_line_is_reported_before_alias_restore() {
        let usage = std::sync::Arc::new(crate::claude::tests::Usage::default());
        let mut reverse = Reverse::new();
        reverse.insert("mcp__poem_real__leisure_fixture_lookup".into(), "fixture_lookup".into());
        let body = chunks(vec![
            Ok(b"event: content_block_start\r\ndata: {\"type\":\"content_block_start\",\"index\":0,\"content_block\":{\"type\":\"tool_use\",\"id\":\"t\",\"name\":\"mcp__poem_real__leisure_fixture_lookup\",\"input\":{}}}\r\n\r\n"),
            Ok(b"event: message_stop\ndata: {\"type\":\"message_stop\"}\n\nevent: ping\n"),
        ]);
        let out: Vec<_> = relay(
            body,
            Arc::new(reverse),
            Box::new(|_| {}),
            cpa_core::exec::UsageSink::new(usage.clone()),
            Default::default(),
        )
        .map(Result::unwrap)
        .collect()
        .await;
        assert!(String::from_utf8_lossy(&out[0]).contains("\"name\":\"fixture_lookup\""));
        let lines: Vec<String> = usage.0.lock().unwrap().iter().map(|(_, _, l)| l.clone()).collect();
        // Scanner lines (CR dropped), the alias as upstream sent it, up to the terminal
        // event's blank line where the relay stops reading.
        assert_eq!(
            lines,
            [
                "event: content_block_start",
                "data: {\"type\":\"content_block_start\",\"index\":0,\"content_block\":{\"type\":\"tool_use\",\"id\":\"t\",\"name\":\"mcp__poem_real__leisure_fixture_lookup\",\"input\":{}}}",
                "",
                "event: message_stop",
                "data: {\"type\":\"message_stop\"}",
                "",
            ]
        );
    }
}