rmux-sdk 0.2.0

Public, daemon-backed Rust SDK for the RMUX terminal multiplexer (facade, ensure-session, snapshots, events, detach helpers).
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
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
#![cfg(unix)]

use std::error::Error;
use std::fmt::{Debug, Write as _};
use std::io;
use std::path::{Path, PathBuf};
use std::pin::Pin;
use std::process::{Child, Command, Stdio};
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::OnceLock;
use std::time::Duration;

use rmux_proto::{
    encode_frame, CancelSdkWaitResponse, ErrorResponse, FrameDecoder, HasSessionRequest,
    PaneOutputSubscriptionStart, Request, Response, SdkWaitForOutputRequest,
    SdkWaitForOutputResponse, SdkWaitOutcome,
};
use rmux_sdk::{ArmedWait, EnsureSession, Pane, PaneRef, RmuxBuilder, RmuxError, SessionName};
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::{UnixListener, UnixStream};
use tokio::sync::{oneshot, Mutex};
use tokio::time::Instant;

type TestResult<T = ()> = Result<T, Box<dyn Error + Send + Sync>>;

static LIVE_DAEMON_LOCK: Mutex<()> = Mutex::const_new(());
static UNIQUE_ID: AtomicUsize = AtomicUsize::new(0);

fn assert_send<T: Send>() {}
fn assert_static<T: 'static>() {}
fn assert_debug<T: Debug>() {}

#[test]
fn armed_wait_public_type_is_send_static_and_debuggable() {
    assert_send::<ArmedWait>();
    assert_static::<ArmedWait>();
    assert_debug::<ArmedWait>();
}

#[tokio::test]
async fn wait_for_next_arms_before_returned_handle_completes() -> TestResult {
    let socket = TestSocket::new("armed-byte")?;
    let listener = UnixListener::bind(socket.path())?;
    let (seen_sender, seen) = oneshot::channel();
    let (release, released) = oneshot::channel();
    let server = tokio::spawn(async move {
        let _handle = accept_peer(&listener).await?;
        let mut wait = accept_peer(&listener).await?;
        let mut cancel = accept_peer(&listener).await?;

        let request = expect_sdk_wait(&mut wait, b"needle").await?;
        seen_sender
            .send(())
            .map_err(|_| "test dropped request observer")?;
        released.await.map_err(|_| "test dropped release sender")?;

        wait.write_response(Response::SdkWaitForOutput(SdkWaitForOutputResponse {
            wait_id: request.wait_id,
            outcome: SdkWaitOutcome::Matched,
        }))
        .await?;
        assert_no_cancel_request(&mut cancel).await?;
        TestResult::Ok(())
    });

    let pane = pane_for(socket.path(), Duration::from_secs(1)).await?;
    let mut armed = Box::pin(pane.wait_for_next(b"needle").await?);
    seen.await?;
    assert_armed_wait_pending(&mut armed, "byte wait completed before daemon response").await?;

    release
        .send(())
        .map_err(|_| "server dropped release receiver")?;
    armed.await?;
    drop(pane);
    server.await??;
    Ok(())
}

#[tokio::test]
async fn wait_for_text_next_arms_daemon_byte_wait_for_text_bytes() -> TestResult {
    let socket = TestSocket::new("armed-text")?;
    let listener = UnixListener::bind(socket.path())?;
    let server = tokio::spawn(async move {
        let _handle = accept_peer(&listener).await?;
        let mut wait = accept_peer(&listener).await?;
        let mut cancel = accept_peer(&listener).await?;

        let request = expect_sdk_wait(&mut wait, b"hello text").await?;
        wait.write_response(Response::SdkWaitForOutput(SdkWaitForOutputResponse {
            wait_id: request.wait_id,
            outcome: SdkWaitOutcome::Matched,
        }))
        .await?;
        assert_no_cancel_request(&mut cancel).await?;
        TestResult::Ok(())
    });

    let pane = pane_for(socket.path(), Duration::from_secs(1)).await?;
    pane.wait_for_text_next("hello text").await?.await?;
    drop(pane);
    server.await??;
    Ok(())
}

#[tokio::test]
async fn independent_armed_waits_can_be_stored_and_moved_across_tasks() -> TestResult {
    let socket = TestSocket::new("armed-move")?;
    let listener = UnixListener::bind(socket.path())?;
    let (seen_sender, seen) = oneshot::channel();
    let server = tokio::spawn(async move {
        let _handle = accept_peer(&listener).await?;
        let mut first_wait = accept_peer(&listener).await?;
        let mut first_cancel = accept_peer(&listener).await?;
        let mut second_wait = accept_peer(&listener).await?;
        let mut second_cancel = accept_peer(&listener).await?;

        let first = expect_sdk_wait(&mut first_wait, b"first").await?;
        let second = expect_sdk_wait(&mut second_wait, b"second").await?;
        seen_sender
            .send(())
            .map_err(|_| "test dropped request observer")?;

        first_wait
            .write_response(Response::SdkWaitForOutput(SdkWaitForOutputResponse {
                wait_id: first.wait_id,
                outcome: SdkWaitOutcome::Matched,
            }))
            .await?;
        second_wait
            .write_response(Response::SdkWaitForOutput(SdkWaitForOutputResponse {
                wait_id: second.wait_id,
                outcome: SdkWaitOutcome::Matched,
            }))
            .await?;
        assert_no_cancel_request(&mut first_cancel).await?;
        assert_no_cancel_request(&mut second_cancel).await?;
        TestResult::Ok(())
    });

    let pane = pane_for(socket.path(), Duration::from_secs(1)).await?;
    let waits = vec![
        pane.wait_for_next(b"first").await?,
        pane.wait_for_text_next("second").await?,
    ];
    seen.await?;

    let join = tokio::spawn(async move {
        let mut waits = waits.into_iter();
        let first = waits.next().expect("first armed wait stored");
        let second = waits.next().expect("second armed wait stored");
        let (first_result, second_result) = tokio::join!(first, second);
        first_result?;
        second_result
    });
    join.await??;
    drop(pane);
    server.await??;
    Ok(())
}

#[tokio::test]
async fn dropping_armed_wait_sends_best_effort_cancel() -> TestResult {
    let socket = TestSocket::new("armed-drop")?;
    let listener = UnixListener::bind(socket.path())?;
    let server = tokio::spawn(async move {
        let _handle = accept_peer(&listener).await?;
        let mut wait = accept_peer(&listener).await?;
        let mut cancel = accept_peer(&listener).await?;

        let request = expect_sdk_wait(&mut wait, b"drop").await?;
        expect_cancel(&mut cancel, &request).await?;
        TestResult::Ok(())
    });

    let pane = pane_for(socket.path(), Duration::from_secs(1)).await?;
    let armed = pane.wait_for_next(b"drop").await?;
    drop(armed);
    drop(pane);
    server.await??;
    Ok(())
}

#[tokio::test]
async fn armed_wait_timeout_sends_best_effort_cancel() -> TestResult {
    let socket = TestSocket::new("armed-timeout")?;
    let listener = UnixListener::bind(socket.path())?;
    let server = tokio::spawn(async move {
        let _handle = accept_peer(&listener).await?;
        let mut wait = accept_peer(&listener).await?;
        let mut cancel = accept_peer(&listener).await?;

        let request = expect_sdk_wait(&mut wait, b"never").await?;
        expect_cancel(&mut cancel, &request).await?;
        TestResult::Ok(())
    });

    let pane = pane_for(socket.path(), Duration::from_millis(25)).await?;
    let error = pane
        .wait_for_next(b"never")
        .await?
        .await
        .expect_err("unmatched armed wait must time out");
    assert_timed_out(error, "wait for next pane output bytes");
    drop(pane);
    server.await??;
    Ok(())
}

#[tokio::test]
async fn armed_wait_preserves_cancelled_outcome() -> TestResult {
    let socket = TestSocket::new("armed-cancelled")?;
    let listener = UnixListener::bind(socket.path())?;
    let server = tokio::spawn(async move {
        let _handle = accept_peer(&listener).await?;
        let mut wait = accept_peer(&listener).await?;
        let mut cancel = accept_peer(&listener).await?;

        let request = expect_sdk_wait(&mut wait, b"cancelled").await?;
        wait.write_response(Response::SdkWaitForOutput(SdkWaitForOutputResponse {
            wait_id: request.wait_id,
            outcome: SdkWaitOutcome::Cancelled,
        }))
        .await?;
        assert_no_cancel_request(&mut cancel).await?;
        TestResult::Ok(())
    });

    let pane = pane_for(socket.path(), Duration::from_secs(1)).await?;
    let error = pane
        .wait_for_next(b"cancelled")
        .await?
        .await
        .expect_err("daemon-cancelled wait must fail");
    match error {
        RmuxError::Protocol {
            source: rmux_proto::RmuxError::Server(message),
            ..
        } => assert!(message.contains("was cancelled")),
        other => panic!("expected typed cancelled protocol error, got {other:?}"),
    }
    drop(pane);
    server.await??;
    Ok(())
}

#[tokio::test]
async fn armed_wait_preserves_mismatched_id_failure_and_cancels_expected_wait() -> TestResult {
    let socket = TestSocket::new("armed-mismatch")?;
    let listener = UnixListener::bind(socket.path())?;
    let server = tokio::spawn(async move {
        let _handle = accept_peer(&listener).await?;
        let mut wait = accept_peer(&listener).await?;
        let mut cancel = accept_peer(&listener).await?;

        let request = expect_sdk_wait(&mut wait, b"mismatch").await?;
        wait.write_response(Response::SdkWaitForOutput(SdkWaitForOutputResponse {
            wait_id: rmux_proto::SdkWaitId::new(request.wait_id.as_u64() + 1),
            outcome: SdkWaitOutcome::Matched,
        }))
        .await?;
        expect_cancel(&mut cancel, &request).await?;
        TestResult::Ok(())
    });

    let pane = pane_for(socket.path(), Duration::from_secs(1)).await?;
    let error = pane
        .wait_for_next(b"mismatch")
        .await?
        .await
        .expect_err("mismatched wait id must fail");
    match error {
        RmuxError::Protocol {
            source: rmux_proto::RmuxError::Server(message),
            ..
        } => assert!(message.contains("did not match request id")),
        other => panic!("expected protocol mismatch, got {other:?}"),
    }
    drop(pane);
    server.await??;
    Ok(())
}

#[tokio::test]
async fn armed_wait_surfaces_stale_pane_failure() -> TestResult {
    let socket = TestSocket::new("armed-stale")?;
    let listener = UnixListener::bind(socket.path())?;
    let server = tokio::spawn(async move {
        let _handle = accept_peer(&listener).await?;
        let mut wait = accept_peer(&listener).await?;
        let mut cancel = accept_peer(&listener).await?;

        let _request = expect_sdk_wait(&mut wait, b"stale").await?;
        wait.write_response(Response::Error(ErrorResponse {
            error: rmux_proto::RmuxError::InvalidTarget {
                value: "wait:0.0".to_owned(),
                reason: "pane index does not exist in session".to_owned(),
            },
        }))
        .await?;
        assert_no_cancel_request(&mut cancel).await?;
        TestResult::Ok(())
    });

    let pane = pane_for(socket.path(), Duration::from_secs(1)).await?;
    let error = pane
        .wait_for_next(b"stale")
        .await?
        .await
        .expect_err("stale pane wait must fail");
    match error {
        RmuxError::Protocol {
            source: rmux_proto::RmuxError::InvalidTarget { reason, .. },
            ..
        } => assert!(reason.contains("pane index does not exist")),
        other => panic!("expected stale-pane protocol error, got {other:?}"),
    }
    drop(pane);
    server.await??;
    Ok(())
}

#[tokio::test]
async fn wait_for_next_rejects_empty_needles_locally() -> TestResult {
    let socket = TestSocket::new("armed-empty")?;
    let listener = UnixListener::bind(socket.path())?;
    let server = tokio::spawn(async move {
        let mut handle = accept_peer(&listener).await?;
        assert_peer_closed_without_request(&mut handle).await?;
        assert_no_extra_peer(&listener).await?;
        TestResult::Ok(())
    });

    let pane = pane_for(socket.path(), Duration::from_secs(1)).await?;
    let error = pane
        .wait_for_next([])
        .await
        .expect_err("empty armed byte waits must be rejected locally");
    match error {
        RmuxError::Protocol {
            source: rmux_proto::RmuxError::Server(message),
            ..
        } => assert!(message.contains("must not be empty")),
        other => panic!("expected local protocol error, got {other:?}"),
    }
    let error = pane
        .wait_for_text_next("")
        .await
        .expect_err("empty armed text waits must be rejected locally");
    match error {
        RmuxError::Protocol {
            source: rmux_proto::RmuxError::Server(message),
            ..
        } => assert!(message.contains("must not be empty")),
        other => panic!("expected local protocol error, got {other:?}"),
    }
    drop(pane);
    server.await??;
    Ok(())
}

#[tokio::test]
async fn live_wait_for_next_ignores_history_and_matches_split_future_output() -> TestResult {
    let _lock = LIVE_DAEMON_LOCK.lock().await;
    let harness = Harness::start("armed-live").await?;
    let rmux = harness.rmux();
    let session = EnsureSession::named(unique_session_name("armedlive"))
        .create_only()
        .environment(["SHELL=/bin/sh"])
        .ensure(&rmux)
        .await?;
    let pane = session.pane(0, 0);
    let id = UNIQUE_ID.fetch_add(1, Ordering::Relaxed);

    let history_marker = format!("rmux_armed_history_{id}");
    pane.send_text(printf_line_command(&history_marker)).await?;
    pane.send_key("Enter").await?;
    pane.wait_for_text(&history_marker).await?;

    let mut history_wait = Box::pin(pane.wait_for_next(history_marker.as_bytes()).await?);
    assert_armed_wait_pending(
        &mut history_wait,
        "wait_for_next matched output that existed before arming",
    )
    .await?;
    pane.send_text(printf_line_command(&history_marker)).await?;
    pane.send_key("Enter").await?;
    history_wait.await?;

    let text_history_marker = format!("rmux_armed_text_history_{id}");
    pane.send_text(printf_line_command(&text_history_marker))
        .await?;
    pane.send_key("Enter").await?;
    pane.wait_for_text(&text_history_marker).await?;

    let mut text_history_wait = Box::pin(pane.wait_for_text_next(&text_history_marker).await?);
    assert_armed_wait_pending(
        &mut text_history_wait,
        "wait_for_text_next matched text output that existed before arming",
    )
    .await?;
    pane.send_text(printf_line_command(&text_history_marker))
        .await?;
    pane.send_key("Enter").await?;
    text_history_wait.await?;

    let byte_needle = format!("rmux_armed_bytes_{id}");
    let (byte_left, byte_right) = byte_needle.split_at(byte_needle.len() / 2);
    let byte_wait = pane.wait_for_next(byte_needle.as_bytes()).await?;
    pane.send_text(format!(
        "printf '{byte_left}'; sleep 0.05; printf '{byte_right}\\n'"
    ))
    .await?;
    pane.send_key("Enter").await?;
    byte_wait.await?;

    let text_needle = format!("rmux_armed_text_{id}");
    let (text_left, text_right) = text_needle.split_at(text_needle.len() / 2);
    let text_wait = pane.wait_for_text_next(&text_needle).await?;
    pane.send_text(format!(
        "printf '{text_left}'; sleep 0.05; printf '{text_right}\\n'"
    ))
    .await?;
    pane.send_key("Enter").await?;
    text_wait.await?;

    harness.finish().await
}

async fn expect_sdk_wait(peer: &mut Peer, bytes: &[u8]) -> TestResult<SdkWaitForOutputRequest> {
    let request = peer.expect_request().await?;
    let Request::SdkWaitForOutput(request) = request else {
        panic!("armed wait must use server-side SDK byte wait, got {request:?}");
    };
    assert_eq!(request.target, target().to_proto());
    assert_eq!(request.bytes, bytes);
    assert_eq!(request.start, PaneOutputSubscriptionStart::Now);
    Ok(request)
}

async fn expect_cancel(peer: &mut Peer, wait: &SdkWaitForOutputRequest) -> TestResult {
    let request = peer.expect_request().await?;
    let Request::CancelSdkWait(cancel) = request else {
        panic!("armed wait drop/timeout must send SDK cancellation, got {request:?}");
    };
    assert_eq!(cancel.owner_id, wait.owner_id);
    assert_eq!(cancel.wait_id, wait.wait_id);
    peer.write_response(Response::CancelSdkWait(CancelSdkWaitResponse {
        wait_id: wait.wait_id,
        removed: true,
    }))
    .await
}

async fn assert_armed_wait_pending(
    wait: &mut Pin<Box<ArmedWait>>,
    message: &'static str,
) -> TestResult {
    match tokio::time::timeout(Duration::from_millis(75), wait.as_mut()).await {
        Err(_) => Ok(()),
        Ok(result) => Err(format!("{message}: {result:?}").into()),
    }
}

async fn pane_for(socket_path: &Path, timeout: Duration) -> TestResult<Pane> {
    let rmux = RmuxBuilder::new()
        .unix_socket(socket_path)
        .default_timeout(timeout)
        .build();
    Ok(rmux.pane(target()).await?)
}

fn target() -> PaneRef {
    PaneRef::new(session_name(), 0, 0)
}

fn session_name() -> SessionName {
    SessionName::new("wait").expect("valid test session name")
}

fn unique_session_name(prefix: &str) -> SessionName {
    let id = UNIQUE_ID.fetch_add(1, Ordering::Relaxed);
    SessionName::new(format!("{prefix}{id}")).expect("valid generated session name")
}

async fn accept_peer(listener: &UnixListener) -> TestResult<Peer> {
    let (stream, _) = listener.accept().await?;
    Ok(Peer::new(stream))
}

async fn assert_no_cancel_request(peer: &mut Peer) -> TestResult {
    let mut buffer = [0_u8; 1];
    match tokio::time::timeout(Duration::from_millis(50), peer.stream.read(&mut buffer)).await {
        Err(_) | Ok(Ok(0)) => Ok(()),
        Ok(Ok(_)) => Err("completed armed wait unexpectedly wrote a cancel request".into()),
        Ok(Err(error)) => Err(error.into()),
    }
}

async fn assert_peer_closed_without_request(peer: &mut Peer) -> TestResult {
    match peer.read_request().await? {
        None => Ok(()),
        Some(request) => Err(format!("unexpected request before close: {request:?}").into()),
    }
}

async fn assert_no_extra_peer(listener: &UnixListener) -> TestResult {
    match tokio::time::timeout(Duration::from_millis(50), listener.accept()).await {
        Err(_) => Ok(()),
        Ok(Ok(_)) => Err("local validation unexpectedly opened an armed wait connection".into()),
        Ok(Err(error)) => Err(error.into()),
    }
}

fn assert_timed_out(error: RmuxError, expected_operation: &str) {
    match error {
        RmuxError::Transport {
            operation, source, ..
        } => {
            assert_eq!(operation, expected_operation);
            assert_eq!(source.kind(), io::ErrorKind::TimedOut);
        }
        other => panic!("expected typed timeout transport error, got {other:?}"),
    }
}

struct Peer {
    stream: UnixStream,
    decoder: FrameDecoder,
}

impl Peer {
    fn new(stream: UnixStream) -> Self {
        Self {
            stream,
            decoder: FrameDecoder::new(),
        }
    }

    async fn expect_request(&mut self) -> TestResult<Request> {
        self.read_request()
            .await?
            .ok_or_else(|| "peer closed before request".into())
    }

    async fn read_request(&mut self) -> TestResult<Option<Request>> {
        let mut buffer = [0_u8; 4096];
        loop {
            if let Some(request) = self.decoder.next_frame::<Request>()? {
                return Ok(Some(request));
            }

            let read = self.stream.read(&mut buffer).await?;
            if read == 0 {
                return Ok(None);
            }
            self.decoder.push_bytes(&buffer[..read]);
        }
    }

    async fn write_response(&mut self, response: Response) -> TestResult {
        let frame = encode_frame(&response)?;
        self.stream.write_all(&frame).await?;
        self.stream.flush().await?;
        Ok(())
    }
}

struct TestSocket {
    root: PathBuf,
    path: PathBuf,
}

impl TestSocket {
    fn new(label: &str) -> io::Result<Self> {
        let id = UNIQUE_ID.fetch_add(1, Ordering::Relaxed);
        // macOS keeps Unix socket paths under a tight sockaddr_un limit; do
        // not inherit the long /var/folders/... TMPDIR here.
        let root = PathBuf::from("/tmp").join(format!(
            "rmux-aw-{}-{}-{id}",
            compact_label(label),
            std::process::id()
        ));
        std::fs::create_dir_all(&root)?;
        Ok(Self {
            path: root.join("s"),
            root,
        })
    }

    fn path(&self) -> &Path {
        &self.path
    }
}

impl Drop for TestSocket {
    fn drop(&mut self) {
        let _ = std::fs::remove_dir_all(&self.root);
    }
}

struct Harness {
    _root: TestRoot,
    socket_path: PathBuf,
    child: Option<Child>,
}

impl Harness {
    async fn start(label: &str) -> TestResult<Self> {
        let root = TestRoot::new(label);
        let socket_path = root.path().join("daemon.sock");
        let mut child = Command::new(rmux_binary()?)
            .arg("--__internal-daemon")
            .arg(&socket_path)
            .stdin(Stdio::null())
            .stdout(Stdio::null())
            .stderr(Stdio::null())
            .spawn()?;
        wait_for_daemon_ready(&socket_path, &mut child).await?;

        Ok(Self {
            _root: root,
            socket_path,
            child: Some(child),
        })
    }

    fn rmux(&self) -> rmux_sdk::Rmux {
        RmuxBuilder::new()
            .unix_socket(&self.socket_path)
            .default_timeout(Duration::from_secs(2))
            .build()
    }

    async fn finish(self) -> TestResult {
        let shutdown = self.rmux().shutdown().await;
        wait_for_child_exit(self, "server did not exit during cleanup").await?;
        if let Err(error) = shutdown {
            let rendered = error.to_string();
            assert!(
                rendered.contains("connect to rmux daemon")
                    || rendered.contains("rmux daemon closed the transport")
                    || rendered.contains("rmux transport actor is closed")
                    || rendered.contains("Connection reset by peer"),
                "unexpected cleanup shutdown error: {rendered}"
            );
        }
        Ok(())
    }
}

impl Drop for Harness {
    fn drop(&mut self) {
        if let Some(child) = self.child.as_mut() {
            let _ = child.kill();
        }
    }
}

async fn wait_for_child_exit(mut harness: Harness, timeout_message: &'static str) -> TestResult {
    let mut child = harness.child.take().expect("harness owns daemon child");
    let deadline = Instant::now() + Duration::from_secs(5);

    loop {
        if let Some(status) = child.try_wait()? {
            assert!(status.success(), "daemon exited with status {status}");
            return Ok(());
        }

        if Instant::now() >= deadline {
            let _ = child.kill();
            return Err(timeout_message.into());
        }

        tokio::time::sleep(Duration::from_millis(25)).await;
    }
}

async fn wait_for_daemon_ready(socket_path: &Path, child: &mut Child) -> TestResult {
    let deadline = Instant::now() + Duration::from_secs(5);

    loop {
        if let Some(status) = child.try_wait()? {
            return Err(format!("daemon exited before accepting RPC: {status}").into());
        }

        if matches!(
            framed_request(
                socket_path,
                Request::HasSession(HasSessionRequest {
                    target: session_name()
                })
            )
            .await,
            Ok(Response::HasSession(_))
        ) {
            return Ok(());
        }

        if Instant::now() >= deadline {
            return Err(format!(
                "daemon at '{}' did not accept RPC before timeout",
                socket_path.display()
            )
            .into());
        }
        tokio::time::sleep(Duration::from_millis(25)).await;
    }
}

async fn framed_request(socket_path: &Path, request: Request) -> TestResult<Response> {
    let mut stream = UnixStream::connect(socket_path).await?;
    let frame = encode_frame(&request)?;
    stream.write_all(&frame).await?;
    stream.flush().await?;
    read_response(&mut stream).await
}

async fn read_response(stream: &mut UnixStream) -> TestResult<Response> {
    let mut decoder = FrameDecoder::new();
    let mut buffer = [0_u8; 4096];

    loop {
        if let Some(response) = decoder.next_frame::<Response>()? {
            return Ok(response);
        }

        let read = stream.read(&mut buffer).await?;
        if read == 0 {
            return Err("stream closed before response".into());
        }
        decoder.push_bytes(&buffer[..read]);
    }
}

fn rmux_binary() -> TestResult<&'static Path> {
    static RMUX_BINARY: OnceLock<Result<PathBuf, String>> = OnceLock::new();
    match RMUX_BINARY.get_or_init(|| resolve_rmux_binary().map_err(|error| error.to_string())) {
        Ok(path) => Ok(path.as_path()),
        Err(error) => Err(io::Error::other(error.clone()).into()),
    }
}

fn resolve_rmux_binary() -> TestResult<PathBuf> {
    if let Some(path) = option_env!("CARGO_BIN_EXE_rmux") {
        let path = PathBuf::from(path);
        if path.is_file() {
            return Ok(path);
        }
    }

    let target_dir = target_dir()?;
    let candidate = target_dir.join("debug").join("rmux");
    let status = Command::new(std::env::var_os("CARGO").unwrap_or_else(|| "cargo".into()))
        .arg("build")
        .arg("--bin")
        .arg("rmux")
        .arg("--locked")
        .arg("--manifest-path")
        .arg(workspace_root().join("Cargo.toml"))
        .env("CARGO_TARGET_DIR", &target_dir)
        .status()?;
    if !status.success() {
        return Err(format!("failed to build rmux binary for daemon tests: {status}").into());
    }
    if !candidate.is_file() {
        return Err(format!(
            "rmux daemon build succeeded but '{}' was not created",
            candidate.display()
        )
        .into());
    }

    Ok(candidate)
}

fn target_dir() -> TestResult<PathBuf> {
    if let Some(target_dir) = std::env::var_os("CARGO_TARGET_DIR") {
        return Ok(PathBuf::from(target_dir));
    }

    let current = std::env::current_exe()?;
    current
        .parent()
        .and_then(Path::parent)
        .map(Path::to_path_buf)
        .ok_or_else(|| "test executable is not under a target directory".into())
}

fn workspace_root() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .parent()
        .and_then(Path::parent)
        .expect("rmux-sdk manifest lives under crates/rmux-sdk")
        .to_path_buf()
}

struct TestRoot {
    path: PathBuf,
}

impl TestRoot {
    fn new(label: &str) -> Self {
        let unique_id = UNIQUE_ID.fetch_add(1, Ordering::Relaxed);
        let path = PathBuf::from("/tmp").join(format!(
            "rmux-sdk-armed-wait-live-{}-{}-{unique_id}",
            compact_label(label),
            std::process::id()
        ));
        Self { path }
    }

    fn path(&self) -> &Path {
        &self.path
    }
}

impl Drop for TestRoot {
    fn drop(&mut self) {
        let _ = std::fs::remove_dir_all(&self.path);
    }
}

fn compact_label(label: &str) -> String {
    let compact = label
        .chars()
        .filter(|character| character.is_ascii_alphanumeric())
        .take(16)
        .collect::<String>();
    if compact.is_empty() {
        "x".to_owned()
    } else {
        compact
    }
}

fn printf_line_command(text: &str) -> String {
    let mut escaped = String::new();
    for byte in text.bytes().chain([b'\n']) {
        write!(&mut escaped, "\\{byte:03o}").expect("writing to String cannot fail");
    }
    format!("printf '{escaped}'")
}