rmux-client 0.10.0

Blocking local client and attach-mode plumbing for the RMUX terminal multiplexer.
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
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
use std::fs::File;
use std::io::{self, Read, Write};
use std::os::fd::{AsFd, BorrowedFd};
use std::os::unix::fs::PermissionsExt;
use std::os::unix::net::UnixStream;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::mpsc;
use std::sync::{Arc, Mutex};
use std::time::{Duration, Instant, SystemTime, UNIX_EPOCH};

use rmux_core::alternate_screen_exit_sequence;
use rmux_proto::{
    encode_attach_message, AttachFrameDecoder, AttachMessage, AttachShellCommand, TerminalGeometry,
    TerminalPixels,
};
use rmux_pty::{ChildCommand, PtyIo, PtyPair};
use rustix::event::{poll, PollFd, PollFlags, Timespec};
use rustix::termios::{tcsetwinsize, Winsize};

use crate::attach_lock_state::AttachLockState;

use super::{
    attach_with_terminal, drain_resize_events, fallback_attach_stop_sequence, handle_attach_action,
    input_loop, output_loop, terminal_size_from_fd, write_attach_unlock, AttachScreenTracker,
    ClientAttachAction, RawTerminal, ResizeWatcher, SignalMaskGuard, TerminalSize,
};

static RESIZE_WATCHER_SIGNAL_TEST_LOCK: Mutex<()> = Mutex::new(());

const CONTROLLING_TTY_CASE_ENV: &str = "RMUX_CLIENT_CONTROLLING_TTY_CASE";
const LOCK_ACTIONS_TTY_CASE: &str = "lock-actions";
const STRUCTURED_SHELL_TTY_CASE: &str = "structured-shell";

fn run_test_with_controlling_tty(
    test_name: &str,
    case: &str,
) -> Result<(), Box<dyn std::error::Error>> {
    let spawned = ChildCommand::new(std::env::current_exe()?)
        .arg(test_name)
        .args(["--exact", "--nocapture", "--test-threads=1"])
        .env(CONTROLLING_TTY_CASE_ENV, case)
        .size(rmux_pty::TerminalSize::new(80, 24))
        .spawn()?;
    let (master, mut child) = spawned.into_parts();
    let output_io = master.into_io();
    output_io.release_startup_slave_guard();
    let output_thread = std::thread::spawn(move || read_test_pty_output(output_io));

    let status = child.wait()?;
    let output = output_thread
        .join()
        .map_err(|_| io::Error::other("controlling-TTY output reader panicked"))??;
    if !status.success() {
        return Err(io::Error::other(format!(
            "controlling-TTY child {test_name} failed with {status}: {}",
            String::from_utf8_lossy(&output)
        ))
        .into());
    }
    Ok(())
}

fn read_test_pty_output(output: PtyIo) -> io::Result<Vec<u8>> {
    let mut collected = Vec::new();
    let mut buffer = [0_u8; 4096];
    loop {
        match output.read(&mut buffer) {
            Ok(0) => return Ok(collected),
            Ok(bytes_read) => collected.extend_from_slice(&buffer[..bytes_read]),
            Err(error) if error.kind() == io::ErrorKind::Interrupted => continue,
            Err(error) if error.raw_os_error() == Some(libc::EIO) => return Ok(collected),
            Err(error) => return Err(error),
        }
    }
}

fn attach_stop_payload() -> Vec<u8> {
    let mut payload = fallback_attach_stop_sequence("xterm-256color");
    payload.extend_from_slice(b"[detached (from session alpha)]\r\n");
    payload
}

#[test]
fn terminal_size_from_fd_ignores_zero_sized_terminals() -> Result<(), Box<dyn std::error::Error>> {
    let pair = PtyPair::open_with_size(rmux_pty::TerminalSize::new(80, 24))?;
    let (_master, slave) = pair.into_split();
    let terminal = File::from(slave.into_owned_fd());

    tcsetwinsize(
        &terminal,
        Winsize {
            ws_row: 0,
            ws_col: 0,
            ws_xpixel: 0,
            ws_ypixel: 0,
        },
    )?;

    assert_eq!(terminal_size_from_fd(&terminal)?, None);
    Ok(())
}

#[test]
fn resize_watcher_reports_sigwinch_updates() -> Result<(), Box<dyn std::error::Error>> {
    let _signal_test_lock = RESIZE_WATCHER_SIGNAL_TEST_LOCK
        .lock()
        .unwrap_or_else(|poisoned| poisoned.into_inner());
    let pair = PtyPair::open_with_size(rmux_pty::TerminalSize::new(80, 24))?;
    let (_master, slave) = pair.into_split();
    let terminal = File::from(slave.into_owned_fd());
    let resize_target = terminal.try_clone()?;
    let _signal_mask = SignalMaskGuard::block_winch()?;
    let (resize_tx, resize_rx) = mpsc::channel();
    let watcher = ResizeWatcher::spawn(terminal.as_fd().try_clone_to_owned()?, resize_tx)?;

    tcsetwinsize(
        &resize_target,
        Winsize {
            ws_row: 40,
            ws_col: 120,
            ws_xpixel: 0,
            ws_ypixel: 0,
        },
    )?;

    watcher.notify_for_test()?;
    assert_eq!(
        resize_rx.recv_timeout(Duration::from_secs(1))?,
        TerminalGeometry::new(120, 40)
    );

    drop(watcher);
    Ok(())
}

#[test]
fn resize_watcher_reports_pixel_dimensions_when_available() -> Result<(), Box<dyn std::error::Error>>
{
    let _signal_test_lock = RESIZE_WATCHER_SIGNAL_TEST_LOCK
        .lock()
        .unwrap_or_else(|poisoned| poisoned.into_inner());
    let pair = PtyPair::open_with_size(rmux_pty::TerminalSize::new(80, 24))?;
    let (_master, slave) = pair.into_split();
    let terminal = File::from(slave.into_owned_fd());
    let resize_target = terminal.try_clone()?;
    let _signal_mask = SignalMaskGuard::block_winch()?;
    let (resize_tx, resize_rx) = mpsc::channel();
    let watcher = ResizeWatcher::spawn(terminal.as_fd().try_clone_to_owned()?, resize_tx)?;

    tcsetwinsize(
        &resize_target,
        Winsize {
            ws_row: 40,
            ws_col: 120,
            ws_xpixel: 1440,
            ws_ypixel: 960,
        },
    )?;

    watcher.notify_for_test()?;
    assert_eq!(
        resize_rx.recv_timeout(Duration::from_secs(1))?,
        TerminalGeometry::new(120, 40).with_pixels(TerminalPixels::new(1440, 960))
    );

    drop(watcher);
    Ok(())
}

#[test]
fn input_loop_emits_raw_data_frame_for_native_typed_bytes() -> Result<(), Box<dyn std::error::Error>>
{
    let (client_stream, mut server_stream) = UnixStream::pair()?;
    let (mut input_writer, input_reader) = UnixStream::pair()?;
    let (_resize_tx, resize_rx) = mpsc::channel();
    let closed = Arc::new(AtomicBool::new(false));
    let locked = Arc::new(AttachLockState::default());
    let (_wakeup, wakeup_reader) = UnixStream::pair()?;

    let input_thread = std::thread::spawn(move || {
        input_loop(
            client_stream,
            input_reader,
            resize_rx,
            false,
            closed,
            locked,
            wakeup_reader,
        )
    });

    input_writer.write_all(b"a")?;
    input_writer.shutdown(std::net::Shutdown::Write)?;

    let mut frame = [0_u8; 64];
    let bytes_read = server_stream.read(&mut frame)?;
    let mut decoder = AttachFrameDecoder::new();
    decoder.push_bytes(&frame[..bytes_read]);

    assert_eq!(
        decoder.next_message()?,
        Some(AttachMessage::Data(b"a".to_vec()))
    );

    input_thread
        .join()
        .map_err(|_| "input loop thread panicked")??;
    Ok(())
}

#[test]
fn lock_action_waits_for_an_inflight_unix_input_read_and_forward(
) -> Result<(), Box<dyn std::error::Error>> {
    let (client_stream, mut server_stream) = UnixStream::pair()?;
    let (mut readiness_writer, readiness_reader) = UnixStream::pair()?;
    let (entered_tx, entered_rx) = mpsc::channel();
    let (release_tx, release_rx) = mpsc::channel();
    let input = PausedInput {
        readiness: readiness_reader,
        entered: entered_tx,
        release: release_rx,
        pause_next: true,
    };
    let (_resize_tx, resize_rx) = mpsc::channel();
    let closed = Arc::new(AtomicBool::new(false));
    let locked = Arc::new(AttachLockState::default());
    let input_locked = Arc::clone(&locked);
    let (_wakeup, wakeup_reader) = UnixStream::pair()?;
    let input_thread = std::thread::spawn(move || {
        input_loop(
            client_stream,
            input,
            resize_rx,
            false,
            closed,
            input_locked,
            wakeup_reader,
        )
    });

    readiness_writer.write_all(b"a")?;
    entered_rx.recv_timeout(Duration::from_secs(1))?;
    locked.lock();
    let waiter_state = Arc::clone(&locked);
    let (idle_tx, idle_rx) = mpsc::channel();
    let waiter = std::thread::spawn(move || {
        waiter_state.wait_until_input_idle();
        idle_tx.send(()).expect("signal idle input");
    });
    assert!(
        idle_rx.recv_timeout(Duration::from_millis(25)).is_err(),
        "exclusive terminal action must wait while the input read is active"
    );

    release_tx.send(())?;
    let mut frame = [0_u8; 64];
    let bytes_read = server_stream.read(&mut frame)?;
    let mut decoder = AttachFrameDecoder::new();
    decoder.push_bytes(&frame[..bytes_read]);
    assert_eq!(
        decoder.next_message()?,
        Some(AttachMessage::Data(b"a".to_vec()))
    );
    idle_rx.recv_timeout(Duration::from_secs(1))?;
    waiter.join().map_err(|_| "lock waiter panicked")?;

    locked.unlock();
    readiness_writer.shutdown(std::net::Shutdown::Write)?;
    input_thread
        .join()
        .map_err(|_| "input loop thread panicked")??;
    Ok(())
}

#[test]
fn unix_lock_actions_rearm_screen_before_sending_unlock() -> Result<(), Box<dyn std::error::Error>>
{
    if std::env::var(CONTROLLING_TTY_CASE_ENV).as_deref() != Ok(LOCK_ACTIONS_TTY_CASE) {
        return run_test_with_controlling_tty(
            "attach::tests::unix_lock_actions_rearm_screen_before_sending_unlock",
            LOCK_ACTIONS_TTY_CASE,
        );
    }

    let raw_terminal = RawTerminal::from_fd(&io::stdin())?;
    let cwd = std::env::current_dir()?.to_string_lossy().into_owned();

    for structured in [false, true] {
        let (mut client_stream, mut server_stream) = UnixStream::pair()?;
        let locked = Arc::new(AttachLockState::default());
        let screen_tracker = AttachScreenTracker::default();
        locked.lock();
        let stop_generation = screen_tracker.mark_stopped();
        let action = if structured {
            ClientAttachAction::LockShell {
                command: AttachShellCommand::new(
                    "true".to_owned(),
                    "/bin/sh".to_owned(),
                    cwd.clone(),
                ),
                stop_generation: Some(stop_generation),
            }
        } else {
            ClientAttachAction::Lock {
                command: "true".to_owned(),
                stop_generation: Some(stop_generation),
            }
        };

        handle_attach_action(
            Some(&raw_terminal),
            &mut client_stream,
            &locked,
            &screen_tracker,
            action,
        )?;

        assert!(
            !screen_tracker.was_stopped(),
            "successful lock action must rearm attach lifecycle"
        );
        assert!(!locked.is_locked());
        let mut frame = [0_u8; 64];
        let bytes_read = server_stream.read(&mut frame)?;
        let mut decoder = AttachFrameDecoder::new();
        decoder.push_bytes(&frame[..bytes_read]);
        assert_eq!(decoder.next_message()?, Some(AttachMessage::Unlock));
    }

    Ok(())
}

#[test]
fn unix_unlock_write_failure_still_leaves_screen_rearmed() -> Result<(), Box<dyn std::error::Error>>
{
    let (mut client_stream, server_stream) = UnixStream::pair()?;
    let screen_tracker = AttachScreenTracker::default();
    let stop_generation = screen_tracker.mark_stopped();
    drop(server_stream);

    write_attach_unlock(&mut client_stream, &screen_tracker, Some(stop_generation))
        .expect_err("closed peer must reject attach unlock");
    assert!(
        !screen_tracker.was_stopped(),
        "failed unlock transport must trigger outer terminal cleanup"
    );
    Ok(())
}

#[test]
fn unix_lock_completion_preserves_a_later_final_stop() -> Result<(), Box<dyn std::error::Error>> {
    let (mut client_stream, mut server_stream) = UnixStream::pair()?;
    let screen_tracker = AttachScreenTracker::default();
    let lock_prelude = screen_tracker.mark_stopped();
    let final_stop = screen_tracker.mark_stopped();
    server_stream.set_nonblocking(true)?;

    write_attach_unlock(&mut client_stream, &screen_tracker, Some(lock_prelude))?;

    assert_eq!(screen_tracker.current_stop_generation(), Some(final_stop));
    let mut frame = [0_u8; 64];
    let error = server_stream
        .read(&mut frame)
        .expect_err("a stale lock completion must not send unlock");
    assert_eq!(error.kind(), io::ErrorKind::WouldBlock);
    Ok(())
}

#[test]
fn drain_resize_events_uses_legacy_resize_until_geometry_is_enabled(
) -> Result<(), Box<dyn std::error::Error>> {
    let (mut client_stream, mut server_stream) = UnixStream::pair()?;
    let (resize_tx, resize_rx) = mpsc::channel();
    resize_tx.send(TerminalGeometry::new(120, 40).with_pixels(TerminalPixels::new(1440, 960)))?;

    drain_resize_events(&mut client_stream, &resize_rx, false)?;

    let mut frame = [0_u8; 128];
    let bytes_read = server_stream.read(&mut frame)?;
    let mut decoder = AttachFrameDecoder::new();
    decoder.push_bytes(&frame[..bytes_read]);
    assert_eq!(
        decoder.next_message()?,
        Some(AttachMessage::Resize(TerminalSize {
            cols: 120,
            rows: 40
        }))
    );
    Ok(())
}

#[test]
fn drain_resize_events_sends_geometry_after_capability_gate(
) -> Result<(), Box<dyn std::error::Error>> {
    let (mut client_stream, mut server_stream) = UnixStream::pair()?;
    let (resize_tx, resize_rx) = mpsc::channel();
    let geometry = TerminalGeometry::new(120, 40).with_pixels(TerminalPixels::new(1440, 960));
    resize_tx.send(geometry)?;

    drain_resize_events(&mut client_stream, &resize_rx, true)?;

    let mut frame = [0_u8; 128];
    let bytes_read = server_stream.read(&mut frame)?;
    let mut decoder = AttachFrameDecoder::new();
    decoder.push_bytes(&frame[..bytes_read]);
    assert_eq!(
        decoder.next_message()?,
        Some(AttachMessage::ResizeGeometry(geometry))
    );
    Ok(())
}

#[test]
fn output_loop_errors_when_server_hangs_up_before_attach_stop(
) -> Result<(), Box<dyn std::error::Error>> {
    let (client_stream, server_stream) = UnixStream::pair()?;
    let output = Vec::new();
    let closed = Arc::new(AtomicBool::new(false));
    let locked = Arc::new(AttachLockState::default());
    let (action_tx, _action_rx) = mpsc::channel();
    let screen_tracker = AttachScreenTracker::default();

    drop(server_stream);
    let error = output_loop(
        client_stream,
        Vec::new(),
        output,
        closed,
        locked,
        screen_tracker,
        action_tx,
    )
    .expect_err("hangup before attach-stop should be treated as an error");

    assert!(
        error
            .to_string()
            .contains("attach stream closed before attach-stop sequence"),
        "unexpected output-loop error: {error}"
    );
    Ok(())
}

#[test]
fn output_loop_treats_literal_exit_banners_as_pane_data() -> Result<(), Box<dyn std::error::Error>>
{
    let (client_stream, mut server_stream) = UnixStream::pair()?;
    let output = SharedOutput::default();
    let captured = output.clone();
    let closed = Arc::new(AtomicBool::new(false));
    let locked = Arc::new(AttachLockState::default());
    let (action_tx, _action_rx) = mpsc::channel();
    let screen_tracker = AttachScreenTracker::default();
    let output_thread = std::thread::spawn(move || {
        output_loop(
            client_stream,
            Vec::new(),
            output,
            closed,
            locked,
            screen_tracker,
            action_tx,
        )
    });

    for bytes in [
        b"[exited]\r\n".as_slice(),
        b"[detached (from session ordinary-pane-output)]\r\n",
        b"still-attached\n",
    ] {
        server_stream.write_all(&encode_attach_message(&AttachMessage::Data(
            bytes.to_vec(),
        ))?)?;
    }
    std::thread::sleep(Duration::from_millis(50));
    assert!(
        !output_thread.is_finished(),
        "banner-shaped pane output must not terminate attach"
    );

    server_stream.write_all(&encode_attach_message(&AttachMessage::Data(
        attach_stop_payload(),
    ))?)?;
    server_stream.shutdown(std::net::Shutdown::Write)?;
    output_thread
        .join()
        .map_err(|_| "output loop thread panicked")??;

    let rendered = captured.into_bytes()?;
    assert!(rendered
        .windows(b"[exited]\r\n".len())
        .any(|part| part == b"[exited]\r\n"));
    assert!(rendered
        .windows(b"still-attached\n".len())
        .any(|part| part == b"still-attached\n"));
    Ok(())
}

#[test]
fn output_loop_flushes_pending_render_before_accepting_next_frame(
) -> Result<(), Box<dyn std::error::Error>> {
    let (client_stream, mut server_stream) = UnixStream::pair()?;
    let output = SharedOutput::default();
    let captured = output.clone();
    let closed = Arc::new(AtomicBool::new(false));
    let locked = Arc::new(AttachLockState::default());
    let (action_tx, _action_rx) = mpsc::channel();
    let screen_tracker = AttachScreenTracker::default();

    server_stream.write_all(&encode_attach_message(&AttachMessage::Render(
        b"render-one\n".to_vec(),
    ))?)?;
    server_stream.write_all(&encode_attach_message(&AttachMessage::Render(
        b"render-two\n".to_vec(),
    ))?)?;
    server_stream.write_all(&encode_attach_message(&AttachMessage::Data(
        attach_stop_payload(),
    ))?)?;
    server_stream.shutdown(std::net::Shutdown::Write)?;

    output_loop(
        client_stream,
        Vec::new(),
        output,
        closed,
        locked,
        screen_tracker,
        action_tx,
    )?;

    let rendered = String::from_utf8(captured.into_bytes()?)?;
    assert!(
        rendered.contains("render-one\n"),
        "render deltas must be flushed before accepting later render frames: {rendered:?}"
    );
    assert!(
        rendered.contains("render-two\n"),
        "latest render frame was not flushed: {rendered:?}"
    );
    Ok(())
}

#[test]
fn output_loop_replaces_pending_render_after_first_paint() -> Result<(), Box<dyn std::error::Error>>
{
    let (client_stream, mut server_stream) = UnixStream::pair()?;
    let output = SharedOutput::default();
    let captured = output.clone();
    let closed = Arc::new(AtomicBool::new(false));
    let locked = Arc::new(AttachLockState::default());
    let (action_tx, _action_rx) = mpsc::channel();
    let screen_tracker = AttachScreenTracker::default();

    server_stream.write_all(&encode_attach_message(&AttachMessage::Render(
        b"initial\n".to_vec(),
    ))?)?;
    server_stream.write_all(&encode_attach_message(&AttachMessage::Render(
        b"stale\n".to_vec(),
    ))?)?;
    server_stream.write_all(&encode_attach_message(&AttachMessage::Render(
        b"latest\n".to_vec(),
    ))?)?;
    server_stream.write_all(&encode_attach_message(&AttachMessage::Data(
        attach_stop_payload(),
    ))?)?;
    server_stream.shutdown(std::net::Shutdown::Write)?;

    output_loop(
        client_stream,
        Vec::new(),
        output,
        closed,
        locked,
        screen_tracker,
        action_tx,
    )?;

    let rendered = String::from_utf8(captured.into_bytes()?)?;
    assert!(rendered.contains("initial\n"), "{rendered:?}");
    assert!(!rendered.contains("stale\n"), "{rendered:?}");
    assert!(rendered.contains("latest\n"), "{rendered:?}");
    Ok(())
}

#[test]
fn output_loop_waits_briefly_to_coalesce_render_frames() -> Result<(), Box<dyn std::error::Error>> {
    let (client_stream, mut server_stream) = UnixStream::pair()?;
    let output = SharedOutput::default();
    let captured = output.clone();
    let closed = Arc::new(AtomicBool::new(false));
    let locked = Arc::new(AttachLockState::default());
    let (action_tx, _action_rx) = mpsc::channel();
    let screen_tracker = AttachScreenTracker::default();

    let output_thread = std::thread::spawn(move || {
        output_loop(
            client_stream,
            Vec::new(),
            output,
            closed,
            locked,
            screen_tracker,
            action_tx,
        )
    });

    server_stream.write_all(&encode_attach_message(&AttachMessage::Render(
        b"initial\n".to_vec(),
    ))?)?;
    let mut replacement_burst = Vec::new();
    replacement_burst.extend(encode_attach_message(&AttachMessage::Render(
        b"stale\n".to_vec(),
    ))?);
    replacement_burst.extend(encode_attach_message(&AttachMessage::Render(
        b"latest\n".to_vec(),
    ))?);
    server_stream.write_all(&replacement_burst)?;
    server_stream.write_all(&encode_attach_message(&AttachMessage::Data(
        attach_stop_payload(),
    ))?)?;
    server_stream.shutdown(std::net::Shutdown::Write)?;
    output_thread
        .join()
        .map_err(|_| "output loop thread panicked")??;

    let rendered = String::from_utf8(captured.into_bytes()?)?;
    assert!(rendered.contains("initial\n"), "{rendered:?}");
    assert!(!rendered.contains("stale\n"), "{rendered:?}");
    assert!(rendered.contains("latest\n"), "{rendered:?}");
    Ok(())
}

#[test]
fn output_loop_flushes_render_before_idle_gap_when_stream_stays_busy(
) -> Result<(), Box<dyn std::error::Error>> {
    let (client_stream, mut server_stream) = UnixStream::pair()?;
    let output = SharedOutput::default();
    let captured = output.clone();
    let closed = Arc::new(AtomicBool::new(false));
    let locked = Arc::new(AttachLockState::default());
    let (action_tx, _action_rx) = mpsc::channel();
    let screen_tracker = AttachScreenTracker::default();

    let output_thread = std::thread::spawn(move || {
        output_loop(
            client_stream,
            Vec::new(),
            output,
            closed,
            locked,
            screen_tracker,
            action_tx,
        )
    });

    for index in 0..8 {
        server_stream.write_all(&encode_attach_message(&AttachMessage::Render(
            format!("render-{index}\n").into_bytes(),
        ))?)?;
        std::thread::sleep(Duration::from_millis(20));
    }

    let deadline = Instant::now() + Duration::from_secs(1);
    while captured.snapshot()?.is_empty() {
        assert!(
            Instant::now() < deadline,
            "render output was not flushed while the stream stayed busy"
        );
        std::thread::sleep(Duration::from_millis(10));
    }

    server_stream.write_all(&encode_attach_message(&AttachMessage::Data(
        attach_stop_payload(),
    ))?)?;
    server_stream.shutdown(std::net::Shutdown::Write)?;
    output_thread
        .join()
        .map_err(|_| "output loop thread panicked")??;

    let rendered = String::from_utf8(captured.into_bytes()?)?;
    assert!(rendered.contains("render-"), "{rendered:?}");
    Ok(())
}

#[test]
fn output_loop_keeps_original_render_deadline_across_replacements(
) -> Result<(), Box<dyn std::error::Error>> {
    let (client_stream, mut server_stream) = UnixStream::pair()?;
    let output = SharedOutput::default();
    let captured = output.clone();
    let closed = Arc::new(AtomicBool::new(false));
    let locked = Arc::new(AttachLockState::default());
    let (action_tx, _action_rx) = mpsc::channel();
    let screen_tracker = AttachScreenTracker::default();
    let writer_done = Arc::new(AtomicBool::new(false));
    let writer_done_for_thread = Arc::clone(&writer_done);

    let output_thread = std::thread::spawn(move || {
        output_loop(
            client_stream,
            Vec::new(),
            output,
            closed,
            locked,
            screen_tracker,
            action_tx,
        )
    });

    let writer_thread = std::thread::spawn(move || -> Result<(), io::Error> {
        let initial = encode_attach_message(&AttachMessage::Render(b"initial\n".to_vec()))
            .expect("initial render frame should encode");
        server_stream.write_all(&initial)?;
        for index in 0..100 {
            let frame = encode_attach_message(&AttachMessage::Render(
                format!("render-{index}\n").into_bytes(),
            ))
            .expect("render frame should encode");
            server_stream.write_all(&frame)?;
            std::thread::sleep(Duration::from_millis(2));
        }
        writer_done_for_thread.store(true, Ordering::SeqCst);
        let detach = encode_attach_message(&AttachMessage::Data(attach_stop_payload()))
            .expect("detach frame should encode");
        server_stream.write_all(&detach)?;
        server_stream.shutdown(std::net::Shutdown::Write)
    });

    let deadline = Instant::now() + Duration::from_secs(1);
    loop {
        let rendered = String::from_utf8(captured.snapshot()?)?;
        if rendered.contains("render-") {
            break;
        }
        assert!(
            !writer_done.load(Ordering::SeqCst),
            "render output was not flushed before the writer went idle"
        );
        assert!(
            Instant::now() < deadline,
            "render output was not flushed while replacements kept arriving"
        );
        std::thread::sleep(Duration::from_millis(5));
    }

    writer_thread
        .join()
        .map_err(|_| "writer thread panicked")??;
    output_thread
        .join()
        .map_err(|_| "output loop thread panicked")??;
    Ok(())
}

#[derive(Clone, Default)]
struct SharedOutput {
    bytes: Arc<Mutex<Vec<u8>>>,
}

impl SharedOutput {
    fn snapshot(&self) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
        Ok(self
            .bytes
            .lock()
            .map_err(|_| "shared output lock poisoned")?
            .clone())
    }

    fn into_bytes(self) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
        self.snapshot()
    }
}

impl Write for SharedOutput {
    fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
        self.bytes
            .lock()
            .map_err(|_| std::io::Error::other("shared output lock poisoned"))?
            .extend_from_slice(buf);
        Ok(buf.len())
    }

    fn flush(&mut self) -> std::io::Result<()> {
        Ok(())
    }
}

struct PausedInput {
    readiness: UnixStream,
    entered: mpsc::Sender<()>,
    release: mpsc::Receiver<()>,
    pause_next: bool,
}

impl Read for PausedInput {
    fn read(&mut self, buffer: &mut [u8]) -> io::Result<usize> {
        if self.pause_next {
            self.pause_next = false;
            self.entered
                .send(())
                .map_err(|_| io::Error::other("input-read observer closed"))?;
            self.release
                .recv()
                .map_err(|_| io::Error::other("input-read release closed"))?;
        }
        self.readiness.read(buffer)
    }
}

impl AsFd for PausedInput {
    fn as_fd(&self) -> BorrowedFd<'_> {
        self.readiness.as_fd()
    }
}

#[test]
fn raw_terminal_flush_pending_input_discards_mouse_sequence_tails(
) -> Result<(), Box<dyn std::error::Error>> {
    let pair = PtyPair::open_with_size(rmux_pty::TerminalSize::new(80, 24))?;
    let (master, slave) = pair.into_split();
    let mut master = File::from(master.into_owned_fd()?);
    let terminal = File::from(slave.into_owned_fd());
    let raw_terminal = RawTerminal::from_fd(&terminal)?;

    master.write_all(b"\x1b[<0;13;1m")?;
    master.flush()?;

    let timeout = Timespec {
        tv_sec: 0,
        tv_nsec: 0,
    };
    let mut before = [PollFd::new(&terminal, PollFlags::IN)];
    assert_eq!(poll(&mut before, Some(&timeout))?, 1);

    raw_terminal.flush_pending_input()?;

    let mut after = [PollFd::new(&terminal, PollFlags::IN)];
    assert_eq!(poll(&mut after, Some(&timeout))?, 0);
    Ok(())
}

#[test]
fn attach_with_terminal_flushes_stale_mouse_input_before_forwarding_keys(
) -> Result<(), Box<dyn std::error::Error>> {
    let pair = PtyPair::open_with_size(rmux_pty::TerminalSize::new(80, 24))?;
    let (master, slave) = pair.into_split();
    let mut master = File::from(master.into_owned_fd()?);
    let terminal = File::from(slave.into_owned_fd());
    let input = terminal.try_clone()?;
    let output = Vec::new();
    let (client_stream, mut server_stream) = UnixStream::pair()?;
    server_stream.set_read_timeout(Some(Duration::from_secs(2)))?;

    // Simulate stale SGR mouse bytes left behind by a previous attach.
    master.write_all(b"\x1b[<0;13;1m")?;
    master.flush()?;

    let attach_thread =
        std::thread::spawn(move || attach_with_terminal(client_stream, &terminal, input, output));

    std::thread::sleep(Duration::from_millis(100));
    master.write_all(b"a")?;
    master.flush()?;

    let mut decoder = AttachFrameDecoder::new();
    let mut saw_resize = false;
    let mut saw_input = false;
    let mut frame = [0_u8; 128];
    while !saw_input {
        let bytes_read = server_stream.read(&mut frame)?;
        decoder.push_bytes(&frame[..bytes_read]);
        while let Some(message) = decoder.next_message()? {
            match message {
                AttachMessage::Resize(TerminalSize { cols: 80, rows: 24 }) => saw_resize = true,
                AttachMessage::Data(bytes) => {
                    assert_eq!(bytes, b"a");
                    saw_input = true;
                }
                other => panic!("unexpected attach message: {other:?}"),
            }
        }
    }

    assert!(saw_resize, "attach should report the initial terminal size");

    server_stream.write_all(&encode_attach_message(&AttachMessage::Data(
        b"\x1b[?1049l".to_vec(),
    ))?)?;
    server_stream.flush()?;
    drop(server_stream);
    attach_thread
        .join()
        .map_err(|_| "attach thread panicked")??;
    Ok(())
}

#[test]
fn fallback_attach_stop_sequence_disables_mouse_and_exits_alt_screen() {
    let stop = fallback_attach_stop_sequence("xterm-256color");
    let expected_alt_exit = alternate_screen_exit_sequence("xterm-256color");
    assert_contains(&stop, b"\x1b[?1000l");
    assert_contains(&stop, b"\x1b[?1002l");
    assert_contains(&stop, b"\x1b[?1003l");
    assert_contains(&stop, b"\x1b[?1005l");
    assert_contains(&stop, b"\x1b[?1006l");
    assert!(
        stop.windows(expected_alt_exit.len())
            .any(|window| window == expected_alt_exit),
        "fallback stop should leave the alternate screen"
    );
}

#[test]
fn structured_shell_commands_use_server_resolved_shell_and_cwd(
) -> Result<(), Box<dyn std::error::Error>> {
    if std::env::var(CONTROLLING_TTY_CASE_ENV).as_deref() != Ok(STRUCTURED_SHELL_TTY_CASE) {
        return run_test_with_controlling_tty(
            "attach::tests::structured_shell_commands_use_server_resolved_shell_and_cwd",
            STRUCTURED_SHELL_TTY_CASE,
        );
    }

    let nonce = SystemTime::now().duration_since(UNIX_EPOCH)?.as_nanos();
    let root = std::env::temp_dir().join(format!(
        "rmux-client-shell-context-{}-{nonce}",
        std::process::id()
    ));
    let cwd = root.join("cwd");
    std::fs::create_dir_all(&cwd)?;
    let shell = root.join("shell-wrapper");
    std::fs::write(
        &shell,
        b"#!/bin/sh\nprintf wrapper > wrapper.txt\nexec /bin/sh \"$@\"\n",
    )?;
    let mut permissions = std::fs::metadata(&shell)?.permissions();
    permissions.set_mode(0o700);
    std::fs::set_permissions(&shell, permissions)?;

    let raw = RawTerminal::from_fd(&io::stdin())?;
    let command = AttachShellCommand::new(
        "printf command > command.txt".to_owned(),
        shell.to_string_lossy().into_owned(),
        cwd.to_string_lossy().into_owned(),
    );
    raw.run_lock_shell_command(&command)?;
    drop(raw);

    assert_eq!(std::fs::read_to_string(cwd.join("wrapper.txt"))?, "wrapper");
    assert_eq!(std::fs::read_to_string(cwd.join("command.txt"))?, "command");
    std::fs::remove_dir_all(root)?;
    Ok(())
}

#[test]
fn attach_with_terminal_restores_mouse_off_after_protocol_error(
) -> Result<(), Box<dyn std::error::Error>> {
    let pair = PtyPair::open_with_size(rmux_pty::TerminalSize::new(80, 24))?;
    let (master, slave) = pair.into_split();
    let mut master = File::from(master.into_owned_fd()?);
    let terminal = File::from(slave.into_owned_fd());
    let _slave_keepalive = terminal.try_clone()?;
    let input = terminal.try_clone()?;
    let output = terminal.try_clone()?;
    let (client_stream, mut server_stream) = UnixStream::pair()?;

    let attach_thread =
        std::thread::spawn(move || attach_with_terminal(client_stream, &terminal, input, output));

    let start = encode_attach_message(&AttachMessage::Data(
        b"\x1b[?1006h\x1b[?1002h\x1b[?1000h\x1b[?1049h".to_vec(),
    ))?;
    server_stream.write_all(&start)?;
    server_stream.flush()?;
    server_stream.write_all(&[255])?;
    server_stream.flush()?;
    drop(server_stream);

    let attach_result = attach_thread.join().map_err(|_| "attach thread panicked")?;
    assert!(
        attach_result.is_err(),
        "invalid server frame should fail the attach client"
    );

    let timeout = Timespec {
        tv_sec: 0,
        tv_nsec: 50_000_000,
    };
    let mut collected = Vec::new();
    let mut buffer = [0_u8; 512];
    loop {
        let mut fds = [PollFd::new(&master, PollFlags::IN)];
        if poll(&mut fds, Some(&timeout))? == 0 {
            break;
        }
        let bytes_read = match master.read(&mut buffer) {
            Ok(bytes_read) => bytes_read,
            Err(error) if error.raw_os_error() == Some(5) => break,
            Err(error) => return Err(Box::new(error)),
        };
        if bytes_read == 0 {
            break;
        }
        collected.extend_from_slice(&buffer[..bytes_read]);
    }

    assert_contains(&collected, b"\x1b[?1000l");
    assert_contains(&collected, b"\x1b[?1002l");
    assert_contains(&collected, b"\x1b[?1003l");
    assert_contains(&collected, b"\x1b[?1005l");
    assert_contains(&collected, b"\x1b[?1006l");
    assert!(
        collected
            .windows(b"\x1b[0m\x1b[H\x1b[2J".len())
            .any(|window| window == b"\x1b[0m\x1b[H\x1b[2J"),
        "client fallback should redraw a clean terminal frame on protocol errors"
    );
    Ok(())
}

fn assert_contains(haystack: &[u8], needle: &[u8]) {
    assert!(
        haystack
            .windows(needle.len())
            .any(|window| window == needle),
        "expected {needle:?} in {haystack:?}"
    );
}