mentra-provider 0.9.4

Shared provider core for Mentra
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
use std::borrow::Cow;
use std::collections::BTreeMap;
use std::io::Read;
use std::io::Write;
use std::net::SocketAddr;
use std::net::TcpListener;
use std::net::TcpStream;
use std::sync::Arc;
use std::thread;
use std::time::Duration;
use std::time::Instant;

use super::*;
use crate::ProviderRequestOptions;
use crate::Role;
use crate::StaticCredentialSource;
use crate::responses::ResponsesProvider;

#[test]
fn fresh_scope_detaches_session_state_but_keeps_endpoint_knowledge() {
    let provider = ResponsesProvider::with_shared_credential_source(
        super::super::openai_definition(),
        Arc::new(StaticCredentialSource::new("test-key")),
    );
    let old_session = provider.session();
    old_session.set_turn_state("scope-a-turn");
    old_session.state.set_latest_response_id("resp_a");
    old_session.set_connection_reused(true);
    old_session.disable_websockets();
    old_session
        .endpoint_capabilities
        .mark_http_previous_response_id_unsupported("gpt-5");
    let (last_response_tx, last_response_rx) = oneshot::channel();
    old_session
        .state
        .connection
        .websocket_session
        .lock()
        .unwrap_or_else(std::sync::PoisonError::into_inner)
        .last_response_rx = Some(last_response_rx);

    let fresh_provider = provider.fresh_session_scope();
    let fresh_session = fresh_provider.session();
    drop(last_response_tx);

    assert!(!Arc::ptr_eq(&old_session.state, &fresh_session.state));
    assert!(Arc::ptr_eq(
        &old_session.endpoint_capabilities,
        &fresh_session.endpoint_capabilities
    ));
    assert_eq!(fresh_session.turn_state(), None);
    assert_eq!(fresh_session.latest_response_id(), None);
    assert!(!fresh_session.connection_reused());
    assert!(fresh_session.websockets_enabled());
    assert!(!fresh_session.last_response_rx_ready());
    assert!(old_session.last_response_rx_ready());
    assert!(
        fresh_session
            .endpoint_capabilities
            .http_previous_response_id_is_unsupported("gpt-5")
    );
}

#[test]
fn fresh_conversation_scope_splits_the_exchange_and_keeps_the_connection() {
    let provider = ResponsesProvider::with_shared_credential_source(
        super::super::openai_definition(),
        Arc::new(StaticCredentialSource::new("test-key")),
    );
    let old_session = provider.session();
    old_session.set_turn_state("scope-a-turn");
    old_session.state.set_latest_response_id("resp_a");
    old_session.set_connection_reused(true);
    old_session.disable_websockets();
    old_session
        .endpoint_capabilities
        .mark_http_previous_response_id_unsupported("gpt-5");

    let next_session = provider.fresh_conversation_scope().session();

    // The exchange is the new conversation's own.
    assert_eq!(next_session.turn_state(), None);
    assert_eq!(next_session.latest_response_id(), None);
    // The endpoint is not: one socket, one decision to stop dialing it, one
    // body of capability knowledge.
    assert!(
        next_session
            .state
            .shares_connection_with(&old_session.state)
    );
    assert!(next_session.connection_reused());
    assert!(!next_session.websockets_enabled());
    assert!(
        next_session
            .endpoint_capabilities
            .http_previous_response_id_is_unsupported("gpt-5")
    );

    // And the split runs both ways: neither conversation can reach the other's.
    next_session.set_turn_state("scope-b-turn");
    next_session.state.set_latest_response_id("resp_b");
    assert_eq!(old_session.turn_state().as_deref(), Some("scope-a-turn"));
    assert_eq!(old_session.latest_response_id().as_deref(), Some("resp_a"));
}

#[test]
fn fresh_session_scope_still_splits_the_connection_too() {
    let provider = ResponsesProvider::with_shared_credential_source(
        super::super::openai_definition(),
        Arc::new(StaticCredentialSource::new("test-key")),
    );
    let old_session = provider.session();
    let conversation = provider.fresh_conversation_scope().session();
    let full = provider.fresh_session_scope().session();

    assert!(
        conversation
            .state
            .shares_connection_with(&old_session.state)
    );
    assert!(!full.state.shares_connection_with(&old_session.state));
}

#[tokio::test]
async fn late_old_scope_completion_cannot_seed_the_fresh_scope() {
    let provider = ResponsesProvider::with_shared_credential_source(
        super::super::openai_definition(),
        Arc::new(StaticCredentialSource::new("test-key")),
    );
    let old_session = provider.session();
    let fresh_session = provider.fresh_session_scope().session();
    let (tx_event, rx_event) = mpsc::unbounded_channel();
    let mut forwarded = old_session.track_response_state(rx_event, None);

    tx_event
        .send(Ok(ProviderEvent::MessageStarted {
            id: "resp_late_a".to_string(),
            model: "gpt-5".to_string(),
            role: Role::Assistant,
        }))
        .expect("old scope should still accept its in-flight completion");
    drop(tx_event);

    forwarded
        .recv()
        .await
        .expect("tracked event should be forwarded")
        .expect("tracked event should remain successful");

    assert_eq!(
        old_session.latest_response_id().as_deref(),
        Some("resp_late_a")
    );
    assert_eq!(fresh_session.latest_response_id(), None);
}

#[tokio::test]
async fn fresh_http_scopes_reuse_the_client_pool_without_sharing_turn_state() {
    let (base_url, captures) = spawn_scope_http_server(4);
    let mut definition = super::super::openai_definition();
    definition.base_url = Some(base_url);
    let provider = ResponsesProvider::with_shared_credential_source(
        definition,
        Arc::new(StaticCredentialSource::new("test-key")),
    );
    let scope_a = provider.fresh_session_scope().session();
    let scope_b = provider.fresh_session_scope().session();

    for (session, message) in [
        (&scope_a, "scope-a-first"),
        (&scope_b, "scope-b-first"),
        (&scope_a, "scope-a-second"),
        (&scope_b, "scope-b-second"),
    ] {
        consume_stream(
            session
                .stream_response(test_request(message))
                .await
                .expect("scope request should start"),
        )
        .await;
    }

    let captured = captures.join().expect("server should capture all requests");
    assert_eq!(captured.len(), 4);
    let peer_ports = captured
        .iter()
        .map(|capture| capture.peer.port())
        .collect::<std::collections::HashSet<_>>();
    assert_eq!(
        peer_ports.len(),
        1,
        "fresh scopes must retain the cloned reqwest client and its warmed pool"
    );

    let payloads = captured
        .iter()
        .map(|capture| {
            serde_json::from_str::<serde_json::Value>(request_body(&capture.request))
                .expect("request body should be json")
        })
        .collect::<Vec<_>>();
    assert!(payloads[0].get("previous_response_id").is_none());
    assert!(payloads[1].get("previous_response_id").is_none());
    assert_eq!(payloads[2]["previous_response_id"], "resp_1");
    assert_eq!(payloads[3]["previous_response_id"], "resp_2");
    assert!(!captured[0].request.contains("x-codex-turn-state:"));
    assert!(!captured[1].request.contains("x-codex-turn-state:"));
    assert!(
        captured[2]
            .request
            .contains("x-codex-turn-state: state-1\r\n")
    );
    assert!(
        captured[3]
            .request
            .contains("x-codex-turn-state: state-2\r\n")
    );
    assert_eq!(scope_a.latest_response_id().as_deref(), Some("resp_3"));
    assert_eq!(scope_b.latest_response_id().as_deref(), Some("resp_4"));
    assert_eq!(scope_a.turn_state().as_deref(), Some("state-3"));
    assert_eq!(scope_b.turn_state().as_deref(), Some("state-4"));
}

#[cfg(feature = "responses-websocket")]
#[tokio::test]
async fn websocket_prewarm_is_shared_only_inside_the_fresh_scope() {
    use tokio_tungstenite::accept_async;

    let listener = tokio::net::TcpListener::bind("127.0.0.1:0")
        .await
        .expect("bind websocket test server");
    let addr = listener.local_addr().expect("read websocket server addr");
    let (release_tx, release_rx) = oneshot::channel::<()>();
    let server = tokio::spawn(async move {
        let (stream, _) = listener.accept().await.expect("accept websocket");
        let _websocket = accept_async(stream).await.expect("upgrade websocket");
        let _ = release_rx.await;
    });

    let mut definition = super::super::openai_definition();
    definition.base_url = Some(format!("http://{addr}/v1"));
    let provider = ResponsesProvider::with_shared_credential_source(
        definition,
        Arc::new(StaticCredentialSource::new("test-key")),
    );
    let scope = provider.fresh_session_scope();
    let prewarm_session = scope.clone().session();
    prewarm_session
        .connect_websocket(HeaderMap::new(), HeaderMap::new(), None, None)
        .await
        .expect("prewarm should connect the fresh scope");

    assert!(!scope.session().websocket_connection_is_closed().await);
    assert!(provider.session().websocket_connection_is_closed().await);
    assert!(
        provider
            .fresh_session_scope()
            .session()
            .websocket_connection_is_closed()
            .await
    );

    let _ = release_tx.send(());
    server.await.expect("websocket server should finish");
}

/// A request that chains, because what these tests separate is the chain head.
///
/// Stated rather than defaulted: [`ResponsesStateMode::ReplayOnly`] is the
/// default and attaches no `previous_response_id` at all, which would leave
/// every scope here indistinguishable from every other.
fn test_request(message: &'static str) -> Request<'static> {
    Request {
        model: Cow::Borrowed("gpt-5"),
        system: None,
        messages: Cow::Owned(vec![crate::Message::user(crate::ContentBlock::text(
            message,
        ))]),
        tools: Cow::Owned(Vec::new()),
        tool_choice: None,
        temperature: None,
        max_output_tokens: None,
        metadata: Cow::Owned(BTreeMap::new()),
        provider_request_options: ProviderRequestOptions {
            responses: crate::ResponsesRequestOptions {
                state_mode: crate::ResponsesStateMode::Hybrid,
                ..Default::default()
            },
            ..Default::default()
        },
    }
}

async fn consume_stream(mut stream: ProviderEventStream) {
    while let Some(event) = stream.recv().await {
        event.expect("stream event should decode");
    }
}

struct CapturedRequest {
    peer: SocketAddr,
    request: String,
}

struct ScopeConnection {
    stream: TcpStream,
    peer: SocketAddr,
    buffer: Vec<u8>,
}

fn spawn_scope_http_server(
    expected_requests: usize,
) -> (String, thread::JoinHandle<Vec<CapturedRequest>>) {
    let listener = TcpListener::bind("127.0.0.1:0").expect("bind scope test server");
    listener
        .set_nonblocking(true)
        .expect("make scope listener nonblocking");
    let addr = listener.local_addr().expect("read scope listener addr");
    let handle = thread::spawn(move || capture_scope_requests(&listener, expected_requests));

    (format!("http://{addr}/"), handle)
}

fn capture_scope_requests(
    listener: &TcpListener,
    expected_requests: usize,
) -> Vec<CapturedRequest> {
    let mut connections = Vec::<ScopeConnection>::new();
    let mut captured = Vec::with_capacity(expected_requests);
    let deadline = Instant::now() + Duration::from_secs(5);
    while captured.len() < expected_requests {
        assert!(
            Instant::now() < deadline,
            "timed out waiting for scope requests: expected {expected_requests}, captured {}, \
             accepted connections {}",
            captured.len(),
            connections.len()
        );
        accept_scope_connections(listener, &mut connections);
        for connection in &mut connections {
            read_available_scope_bytes(connection);
            if let Some(request_end) = complete_request_end(&connection.buffer) {
                let request = connection.buffer.drain(..request_end).collect::<Vec<_>>();
                let response_index = captured.len() + 1;
                captured.push(CapturedRequest {
                    peer: connection.peer,
                    request: String::from_utf8(request).expect("scope request should be utf8"),
                });
                write_scope_response(&mut connection.stream, response_index);
            }
        }
        thread::sleep(Duration::from_millis(1));
    }
    captured
}

fn accept_scope_connections(listener: &TcpListener, connections: &mut Vec<ScopeConnection>) {
    loop {
        match listener.accept() {
            Ok((stream, peer)) => {
                stream
                    .set_nonblocking(true)
                    .expect("make scope connection nonblocking");
                connections.push(ScopeConnection {
                    stream,
                    peer,
                    buffer: Vec::new(),
                });
            }
            Err(error) if error.kind() == std::io::ErrorKind::WouldBlock => break,
            Err(error) => panic!("accept scope request: {error}"),
        }
    }
}

fn read_available_scope_bytes(connection: &mut ScopeConnection) {
    let mut temp = [0_u8; 1024];
    loop {
        match connection.stream.read(&mut temp) {
            Ok(0) => break,
            Ok(read) => connection.buffer.extend_from_slice(&temp[..read]),
            Err(error) if error.kind() == std::io::ErrorKind::WouldBlock => break,
            Err(error) => panic!("read scope request: {error}"),
        }
    }
}

fn complete_request_end(buffer: &[u8]) -> Option<usize> {
    let header_end = buffer.windows(4).position(|window| window == b"\r\n\r\n")? + 4;
    let headers = String::from_utf8_lossy(&buffer[..header_end]);
    let content_length = headers
        .lines()
        .find_map(|line| {
            let (name, value) = line.split_once(':')?;
            name.eq_ignore_ascii_case("content-length")
                .then(|| value.trim().parse::<usize>().expect("parse content-length"))
        })
        .unwrap_or_default();
    (buffer.len() >= header_end + content_length).then_some(header_end + content_length)
}

fn write_scope_response(stream: &mut TcpStream, response_index: usize) {
    let response_id = format!("resp_{response_index}");
    let turn_state = format!("state-{response_index}");
    let response_body = format!(
        concat!(
            "data: {{\"type\":\"response.created\",\"response\":{{\"id\":\"{}\",\"model\":\"gpt-5\",\"status\":\"in_progress\"}}}}\n\n",
            "data: {{\"type\":\"response.completed\",\"response\":{{\"id\":\"{}\",\"model\":\"gpt-5\",\"status\":\"completed\"}}}}\n\n"
        ),
        response_id, response_id
    );
    let response = format!(
        concat!(
            "HTTP/1.1 200 OK\r\n",
            "content-type: text/event-stream\r\n",
            "x-codex-turn-state: {}\r\n",
            "content-length: {}\r\n\r\n",
            "{}"
        ),
        turn_state,
        response_body.len(),
        response_body
    );
    let mut remaining = response.as_bytes();
    while !remaining.is_empty() {
        match stream.write(remaining) {
            Ok(0) => panic!("scope connection closed while writing response"),
            Ok(written) => remaining = &remaining[written..],
            Err(error) if error.kind() == std::io::ErrorKind::WouldBlock => {
                thread::sleep(Duration::from_millis(1));
            }
            Err(error) => panic!("write scope response: {error}"),
        }
    }
}

fn request_body(captured: &str) -> &str {
    captured.split("\r\n\r\n").nth(1).unwrap_or_default()
}