muse-code-sdk 1.4.13

Async Rust client for Muse Code over MSP
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
use std::future::{Future, poll_fn};
use std::io;
use std::pin::Pin;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::{Arc, Mutex as StdMutex};
use std::task::Poll;

use serde_json::{Value, json};
use tokio::sync::mpsc;

use super::*;
use crate::DuplexTransport;
use crate::client::{MuseClient, StartSessionOptions};
use crate::connection::{Connection, NOTIFICATION_HANDLER_CAPACITY};
use crate::msp::{SessionDurability, TurnTerminal};
use crate::session::{SendUserTurnOptions, Session};
use crate::turn::{Turn, TurnOutcome};

mod first_failure;
mod late_register;
mod marker_cap;
mod overflow_next_step;
mod router;
mod terminal_cleanup;
mod truncated_eof;

struct TestTransport {
    inbound: mpsc::UnboundedReceiver<String>,
    outbound: mpsc::UnboundedSender<String>,
    eof_observed: mpsc::UnboundedSender<()>,
}

pub(super) struct TestPeer {
    inbound: Option<mpsc::UnboundedSender<String>>,
    outbound: mpsc::UnboundedReceiver<String>,
    eof_observed: mpsc::UnboundedReceiver<()>,
}

impl DuplexTransport for TestTransport {
    fn read_chunk(
        &mut self,
    ) -> Pin<Box<dyn Future<Output = io::Result<Option<String>>> + Send + '_>> {
        Box::pin(async move {
            let chunk = self.inbound.recv().await;
            if chunk.is_none() {
                let _ = self.eof_observed.send(());
            }
            Ok(chunk)
        })
    }

    fn write(&mut self, frame: &str) -> Pin<Box<dyn Future<Output = io::Result<()>> + Send + '_>> {
        let result = self
            .outbound
            .send(frame.to_owned())
            .map_err(|_| io::Error::new(io::ErrorKind::BrokenPipe, "test peer closed"));
        Box::pin(async move { result })
    }
}

impl TestPeer {
    pub(super) async fn request(&mut self, method: &str) -> Result<Value, String> {
        let frame = self
            .outbound
            .recv()
            .await
            .ok_or_else(|| format!("driver closed before {method} was submitted"))?;
        let request = serde_json::from_str::<Value>(&frame)
            .map_err(|error| format!("submitted {method} frame is not JSON: {error}"))?;
        if request.get("method").and_then(Value::as_str) != Some(method) {
            return Err(format!("expected {method}, received {request}"));
        }
        Ok(request)
    }

    pub(super) fn send(&self, frame: Value) -> Result<(), String> {
        let inbound = self
            .inbound
            .as_ref()
            .ok_or_else(|| "test peer input is closed".to_owned())?;
        inbound
            .send(format!("{frame}\n"))
            .map_err(|_| "driver closed before receiving test frame".to_owned())
    }

    fn send_raw(&self, chunk: String) -> Result<(), String> {
        let inbound = self
            .inbound
            .as_ref()
            .ok_or_else(|| "test peer input is closed".to_owned())?;
        inbound
            .send(chunk)
            .map_err(|_| "driver closed before receiving test chunk".to_owned())
    }

    async fn close_input(&mut self) -> Result<(), String> {
        self.inbound.take();
        self.eof_observed
            .recv()
            .await
            .ok_or_else(|| "transport dropped without observing EOF".to_owned())
    }
}

pub(super) fn paused_client(
    pause_count: usize,
) -> (
    MuseClient,
    TestPeer,
    mpsc::UnboundedReceiver<usize>,
    std::sync::mpsc::Sender<()>,
    mpsc::UnboundedReceiver<usize>,
) {
    paused_client_with(pause_count, SessionDurability::Durable)
}

fn paused_client_with(
    pause_count: usize,
    durability: SessionDurability,
) -> (
    MuseClient,
    TestPeer,
    mpsc::UnboundedReceiver<usize>,
    std::sync::mpsc::Sender<()>,
    mpsc::UnboundedReceiver<usize>,
) {
    let (inbound, read) = mpsc::unbounded_channel();
    let (write, outbound) = mpsc::unbounded_channel();
    let (eof_seen, eof_observed) = mpsc::unbounded_channel();
    let transport = TestTransport {
        inbound: read,
        outbound: write,
        eof_observed: eof_seen,
    };
    let peer = TestPeer {
        inbound: Some(inbound),
        outbound,
        eof_observed,
    };
    let router = Arc::new(NotificationRouter::default());
    let route = Arc::clone(&router);
    let overflow = Arc::clone(&router);
    let entries = Arc::new(AtomicUsize::new(0));
    let handler_entries = Arc::clone(&entries);
    let applied = Arc::new(AtomicUsize::new(0));
    let handler_applied = Arc::clone(&applied);
    let overflow_applied = Arc::clone(&applied);
    let (started, application_started) = mpsc::unbounded_channel();
    let (overflow_started, overflow_observed) = mpsc::unbounded_channel();
    let (release, released) = std::sync::mpsc::channel();
    let released = Arc::new(StdMutex::new(released));
    let handler_released = Arc::clone(&released);
    let (connection, driver, dispatcher) = Connection::with_notification_handler(
        transport,
        move |notification| {
            let entry = handler_entries.fetch_add(1, Ordering::Relaxed);
            if entry < pause_count {
                let _ = started.send(entry);
                let receiver = match handler_released.lock() {
                    Ok(receiver) => receiver,
                    Err(poisoned) => poisoned.into_inner(),
                };
                let _ = receiver.recv();
            }
            route.route(notification);
            handler_applied.fetch_add(1, Ordering::Relaxed);
        },
        move |notification| {
            let _ = overflow_started.send(overflow_applied.load(Ordering::Relaxed));
            overflow.overflow(notification);
        },
    );
    tokio::spawn(dispatcher.run());
    tokio::spawn(driver.run());
    let sequence = Arc::new(AtomicUsize::new(0));
    let minter_sequence = Arc::clone(&sequence);
    let client = MuseClient::from_connection(
        connection,
        Arc::clone(&router),
        durability,
        move || {
            let value = minter_sequence.fetch_add(1, Ordering::Relaxed);
            format!("command-{value}")
        },
        None,
        None,
    );
    (
        client,
        peer,
        application_started,
        release,
        overflow_observed,
    )
}

pub(super) async fn poll_once<F: Future>(mut future: Pin<&mut F>) -> Option<F::Output> {
    poll_fn(|context| {
        Poll::Ready(match future.as_mut().poll(context) {
            Poll::Ready(output) => Some(output),
            Poll::Pending => None,
        })
    })
    .await
}

async fn start_session(
    client: &MuseClient,
    peer: &mut TestPeer,
    session_id: &str,
) -> Result<Session, String> {
    let mut opening = Box::pin(client.start_session(StartSessionOptions::default()));
    if poll_once(opening.as_mut()).await.is_some() {
        return Err("session/start settled before submission".to_owned());
    }
    let request = peer.request("session/start").await?;
    let id = request
        .get("id")
        .cloned()
        .ok_or_else(|| "session/start request has no id".to_owned())?;
    peer.send(json!({
        "jsonrpc": "2.0",
        "id": id,
        "result": {
            "session": session_value(session_id),
            "viewCursor": "cursor-1"
        }
    }))?;
    opening
        .await
        .map_err(|error| format!("session/start failed: {error}"))
}

async fn start_turn(session: &Session, peer: &mut TestPeer, turn_id: &str) -> Result<Turn, String> {
    let mut submission = Box::pin(session.send_user_turn(SendUserTurnOptions::default()));
    if poll_once(submission.as_mut()).await.is_some() {
        return Err("turn/start settled before submission".to_owned());
    }
    let request = peer.request("turn/start").await?;
    peer.send(turn_started_reply(&request, turn_id)?)?;
    submission
        .await
        .map_err(|error| format!("turn/start failed: {error}"))
}

/// The server's `started` reply to `request`, a submitted `turn/start`.
pub(super) fn turn_started_reply(request: &Value, turn_id: &str) -> Result<Value, String> {
    let id = request
        .get("id")
        .cloned()
        .ok_or_else(|| "turn/start request has no id".to_owned())?;
    let command_id = request
        .pointer("/params/commandId")
        .cloned()
        .ok_or_else(|| "turn/start request has no command id".to_owned())?;
    Ok(json!({
        "jsonrpc": "2.0",
        "id": id,
        "result": {
            "commandId": command_id,
            "status": "accepted",
            "turnId": turn_id,
            "startedNewTurn": true,
            "disposition": "started"
        }
    }))
}

pub(super) fn session_value(session_id: &str) -> Value {
    json!({
        "sessionId": session_id,
        "path": "/tmp/session.jsonl",
        "status": "idle",
        "activeTurnId": null,
        "createdAt": "2026-09-29T00:00:00Z",
        "updatedAt": "2026-09-29T00:00:00Z",
        "workspaceRoot": null,
        "providerId": null,
        "modelId": null,
        "turnCount": 0,
        "forkedFrom": null
    })
}

fn notification(method: &str, params: Value) -> Value {
    json!({"jsonrpc": "2.0", "method": method, "params": params})
}

pub(super) fn terminal(session_id: &str, turn_id: &str) -> Value {
    notification(
        "turn/completed",
        json!({
            "sessionId": session_id,
            "viewCursor": "cursor-terminal",
            "sourceRange": {
                "stream": {"kind": "run", "id": turn_id},
                "first": {"id": "event-terminal", "sequence": 1},
                "last": {"id": "event-terminal", "sequence": 1}
            },
            "turnId": turn_id,
            "terminal": "completed",
            "reason": null,
            "durationMs": null,
            "timeToFirstTokenMs": null,
            "usage": null,
            "error": null
        }),
    )
}

fn overflow_refusal_burst() -> String {
    let mut burst = String::new();
    for stage in ["live", "queued", "saturated"] {
        for sequence in 0..NOTIFICATION_HANDLER_CAPACITY {
            burst.push_str(
                &notification(
                    "item/completed",
                    json!({"sessionId": format!("{stage}-{sequence}")}),
                )
                .to_string(),
            );
            burst.push('\n');
        }
    }
    burst.push_str("not-json\n");
    burst.push_str(
        &notification("item/completed", json!({"sessionId": "one-too-many"})).to_string(),
    );
    burst.push('\n');
    burst
}

fn routed_notification(value: Value) -> Result<crate::msp::Notification, String> {
    serde_json::from_value(value)
        .map_err(|error| format!("test notification did not decode: {error}"))
}

async fn expect_overflow_failure(
    completed: impl Future<Output = Result<TurnOutcome, FacadeError>>,
    label: &str,
) -> Result<(), String> {
    expect_event_source_failure(
        completed,
        "notification backlog exceeded for this session; close this client, then resume the session on a new client to continue",
        label,
    )
    .await
}

async fn expect_event_source_failure(
    completed: impl Future<Output = Result<TurnOutcome, FacadeError>>,
    message: &str,
    label: &str,
) -> Result<(), String> {
    let mut completed = Box::pin(completed);
    match poll_once(completed.as_mut()).await {
        Some(Err(FacadeError::Protocol(error))) if error.message() == message => Ok(()),
        Some(Err(error)) => Err(format!("{label} settled with the wrong error: {error}")),
        Some(Ok(outcome)) => Err(format!("{label} unexpectedly completed: {outcome:?}")),
        None => Err(format!("{label} did not settle from its overflow marker")),
    }
}

#[tokio::test(flavor = "current_thread")]
async fn eof_drains_accepted_terminal_before_settling_pending_request() -> Result<(), String> {
    let (client, mut peer, mut application_started, release, _overflow_observed) = paused_client(1);
    let session = start_session(&client, &mut peer, "session-1").await?;
    let turn = start_turn(&session, &mut peer, "turn-1").await?;

    let mut pending = Box::pin(client.start_session(StartSessionOptions::default()));
    if poll_once(pending.as_mut()).await.is_some() {
        return Err("second session/start settled before submission".to_owned());
    }
    let _request = peer.request("session/start").await?;
    peer.send(terminal("session-1", "turn-1"))?;
    if application_started.recv().await != Some(0) {
        return Err("terminal did not enter the paused notification handler".to_owned());
    }

    peer.close_input().await?;
    if poll_once(pending.as_mut()).await.is_some() {
        return Err("EOF settled the request before the accepted terminal applied".to_owned());
    }
    release
        .send(())
        .map_err(|_| "paused terminal handler closed".to_owned())?;

    match turn.completed().await {
        Ok(TurnOutcome::Completed { params, .. }) if params.terminal == TurnTerminal::Completed => {
        }
        Ok(outcome) => return Err(format!("queued terminal settled unexpectedly: {outcome:?}")),
        Err(error) => return Err(format!("queued terminal was displaced by EOF: {error}")),
    }
    let request_result = pending.as_mut().await;
    match request_result {
        Err(FacadeError::TransportEnded) => {}
        Err(error) => return Err(format!("EOF request settled with the wrong error: {error}")),
        Ok(_) => return Err("EOF request unexpectedly succeeded".to_owned()),
    }
    Ok(())
}

#[tokio::test(flavor = "current_thread")]
async fn overflow_refusal_drains_terminal_before_settling_pending_request() -> Result<(), String> {
    let (client, mut peer, mut application_started, release, _overflow_observed) = paused_client(1);
    let mut protocol_errors = client.shared.connection.subscribe_protocol_errors();
    let session = start_session(&client, &mut peer, "session-1").await?;
    let turn = start_turn(&session, &mut peer, "turn-1").await?;

    let mut pending = Box::pin(client.start_session(StartSessionOptions::default()));
    if poll_once(pending.as_mut()).await.is_some() {
        return Err("second session/start settled before submission".to_owned());
    }
    let _request = peer.request("session/start").await?;
    peer.send(terminal("session-1", "turn-1"))?;
    if application_started.recv().await != Some(0) {
        return Err("terminal did not enter the paused notification handler".to_owned());
    }

    peer.send_raw(overflow_refusal_burst())?;
    protocol_errors
        .recv()
        .await
        .map_err(|error| format!("refusal trigger receipt was not observed: {error}"))?;
    if poll_once(pending.as_mut()).await.is_some() {
        return Err(
            "overflow refusal settled the request before the accepted terminal applied".to_owned(),
        );
    }
    release
        .send(())
        .map_err(|_| "paused terminal handler closed".to_owned())?;

    let receipts = async { (turn.completed().await, pending.as_mut().await) };
    // antipattern-ok(timeout-wrapper): failure-only cap; success ends on terminal and request receipts
    let settled = tokio::time::timeout(std::time::Duration::from_secs(30), receipts)
        .await
        .map_err(|_| {
            "overflow refusal did not settle the accepted terminal and request".to_owned()
        })?;
    let (turn_result, request_result) = settled;

    match turn_result {
        Ok(TurnOutcome::Completed { params, .. }) if params.terminal == TurnTerminal::Completed => {
        }
        Ok(outcome) => return Err(format!("queued terminal settled unexpectedly: {outcome:?}")),
        Err(error) => {
            return Err(format!(
                "queued terminal was displaced by overflow refusal: {error}"
            ));
        }
    }
    match request_result {
        Err(FacadeError::TransportEnded) => Ok(()),
        Err(error) => Err(format!(
            "overflow-refused request settled with the wrong error: {error}"
        )),
        Ok(_) => Err("overflow-refused request unexpectedly succeeded".to_owned()),
    }
}

#[tokio::test(flavor = "current_thread")]
async fn overflow_failure_stays_scoped_to_affected_session() -> Result<(), String> {
    let (client, mut peer, _application_started, _release, _overflow_observed) = paused_client(0);
    let router = Arc::clone(&client.shared.router);
    let affected = start_session(&client, &mut peer, "affected").await?;
    let affected_turn = start_turn(&affected, &mut peer, "turn-affected").await?;
    let independent = start_session(&client, &mut peer, "independent").await?;
    let independent_turn = start_turn(&independent, &mut peer, "turn-independent").await?;

    router.overflow(routed_notification(notification(
        "test/overflow",
        json!({"sessionId": "affected"}),
    ))?);
    expect_overflow_failure(affected_turn.completed(), "affected session").await?;

    router.route(routed_notification(terminal(
        "independent",
        "turn-independent",
    ))?);
    let mut independent_completed = Box::pin(independent_turn.completed());
    match poll_once(independent_completed.as_mut()).await {
        Some(Ok(TurnOutcome::Completed { params, .. }))
            if params.terminal == TurnTerminal::Completed => {}
        Some(Ok(outcome)) => {
            return Err(format!(
                "independent session completed unexpectedly: {outcome:?}"
            ));
        }
        Some(Err(error)) => {
            return Err(format!("independent session inherited overflow: {error}"));
        }
        None => return Err("independent session did not apply its terminal".to_owned()),
    }

    client.close().await;
    Ok(())
}

mod replacement_health_tests;