rmux-server 0.10.0

Tokio daemon and request dispatcher 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
use super::*;

#[tokio::test]
async fn live_attach_synchronize_panes_writes_to_each_live_pane() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");
    let requester_pid = std::process::id();

    create_send_keys_test_session(&handler, &alpha).await;
    let split = handler
        .handle(Request::SplitWindow(SplitWindowRequest {
            target: SplitWindowTarget::Pane(PaneTarget::new(alpha.clone(), 0)),
            direction: SplitDirection::Horizontal,
            before: false,
            environment: None,
        }))
        .await;
    assert!(matches!(split, Response::SplitWindow(_)));

    let select_first = handler
        .handle(Request::SelectPane(Box::new(SelectPaneRequest {
            target: PaneTarget::with_window(alpha.clone(), 0, 0),
            title: None,
            style: None,
            input_disabled: None,
            preserve_zoom: false,
        })))
        .await;
    assert!(matches!(select_first, Response::SelectPane(_)));

    let set_sync = handler
        .handle(Request::SetOption(SetOptionRequest {
            scope: ScopeSelector::Window(WindowTarget::with_window(alpha.clone(), 0)),
            option: OptionName::SynchronizePanes,
            value: "on".to_owned(),
            mode: SetOptionMode::Replace,
        }))
        .await;
    assert!(matches!(set_sync, Response::SetOption(_)));

    let pane_zero = PaneTarget::with_window(alpha.clone(), 0, 0);
    let pane_one = PaneTarget::with_window(alpha.clone(), 0, 1);
    {
        let state = handler.state.lock().await;
        state.start_pane_input_capture_for_test(&pane_zero);
        state.start_pane_input_capture_for_test(&pane_one);
    }

    let (control_tx, _control_rx) = mpsc::unbounded_channel();
    let _attach_id = handler
        .register_attach(requester_pid, alpha.clone(), control_tx)
        .await;

    handler
        .handle_attached_live_input_for_test(requester_pid, b"sync")
        .await
        .expect("live attach input");

    let state = handler.state.lock().await;
    assert_eq!(
        state.pane_input_capture_for_test(&pane_zero),
        Some(b"sync".to_vec())
    );
    assert_eq!(
        state.pane_input_capture_for_test(&pane_one),
        Some(b"sync".to_vec())
    );
}

#[tokio::test]
async fn live_attach_synchronize_panes_keeps_terminal_responses_on_active_pane() {
    let handler = RequestHandler::new();
    let alpha = session_name("sync-terminal-response");
    let (requester_pid, pane_zero, pane_one) = setup_synchronized_attached_mode_captures(
        &handler,
        &alpha,
        0,
        b"\x1b[?1004h",
        b"\x1b[?1004h",
    )
    .await;

    let kitty_response = b"\x1b_Gi=7;OK\x1b\\";
    let mut expected = Vec::new();
    for split in 1..kitty_response.len() {
        let mut pending_input = Vec::new();
        handler
            .handle_attached_live_input(requester_pid, &mut pending_input, &kitty_response[..split])
            .await
            .expect("first fragmented Kitty APC chunk succeeds");
        assert_eq!(pending_input, kitty_response[..split], "split at {split}");
        handler
            .handle_attached_live_input(requester_pid, &mut pending_input, &kitty_response[split..])
            .await
            .expect("second fragmented Kitty APC chunk succeeds");
        assert!(pending_input.is_empty(), "split at {split}");
        expected.extend_from_slice(kitty_response);
    }

    let mut pending_input = Vec::new();
    for response_fragment in [
        b"\x1b[12;".as_slice(),
        b"34R".as_slice(),
        b"\x1b[".as_slice(),
        b"I".as_slice(),
    ] {
        handler
            .handle_attached_live_input(requester_pid, &mut pending_input, response_fragment)
            .await
            .expect("pane-bound terminal response succeeds");
    }
    assert!(pending_input.is_empty());
    expected.extend_from_slice(b"\x1b[12;34R\x1b[I");

    let state = handler.state.lock().await;
    assert_eq!(
        state.pane_input_capture_for_test(&pane_zero),
        Some(expected)
    );
    assert_eq!(
        state.pane_input_capture_for_test(&pane_one),
        Some(Vec::new())
    );
}

#[tokio::test]
async fn live_attach_synchronize_panes_wraps_paste_per_pane_when_active_is_plain() {
    let handler = RequestHandler::new();
    let alpha = session_name("sync-paste-active-plain");
    let (requester_pid, pane_zero, pane_one) = setup_synchronized_attached_mode_captures(
        &handler,
        &alpha,
        0,
        b"\x1b[?2004l",
        b"\x1b[?2004h",
    )
    .await;

    let body = b"A\nB";
    handler
        .handle_attached_live_input_for_test(requester_pid, b"\x1b[200~A\nB\x1b[201~")
        .await
        .expect("synchronized bracketed paste succeeds");

    let state = handler.state.lock().await;
    assert_eq!(
        state.pane_input_capture_for_test(&pane_zero),
        Some(body.to_vec())
    );
    assert_eq!(
        state.pane_input_capture_for_test(&pane_one),
        Some(b"\x1b[200~A\nB\x1b[201~".to_vec())
    );
}

#[tokio::test]
async fn live_attach_synchronize_panes_strips_paste_per_pane_when_active_is_bracketed() {
    let handler = RequestHandler::new();
    let alpha = session_name("sync-paste-active-bracketed");
    let (requester_pid, pane_zero, pane_one) = setup_synchronized_attached_mode_captures(
        &handler,
        &alpha,
        1,
        b"\x1b[?2004l",
        b"\x1b[?2004h",
    )
    .await;

    let wrapped = b"\x1b[200~A\nB\x1b[201~";
    handler
        .handle_attached_live_input_for_test(requester_pid, wrapped)
        .await
        .expect("synchronized bracketed paste succeeds");

    let state = handler.state.lock().await;
    assert_eq!(
        state.pane_input_capture_for_test(&pane_zero),
        Some(b"A\nB".to_vec())
    );
    assert_eq!(
        state.pane_input_capture_for_test(&pane_one),
        Some(wrapped.to_vec())
    );
}

#[tokio::test]
async fn live_attach_synchronize_panes_encodes_decckm_per_pane_when_active_is_normal() {
    let handler = RequestHandler::new();
    let alpha = session_name("sync-cursor-active-normal");
    let (requester_pid, pane_zero, pane_one) =
        setup_synchronized_attached_mode_captures(&handler, &alpha, 0, b"\x1b[?1l", b"\x1b[?1h")
            .await;

    handler
        .handle_attached_live_input_for_test(requester_pid, b"\x1b[A")
        .await
        .expect("synchronized cursor key succeeds");

    assert_per_pane_up_encoding(&handler, &pane_zero, &pane_one).await;
}

#[tokio::test]
async fn live_attach_synchronize_panes_encodes_decckm_per_pane_when_active_is_application() {
    let handler = RequestHandler::new();
    let alpha = session_name("sync-cursor-active-application");
    let (requester_pid, pane_zero, pane_one) =
        setup_synchronized_attached_mode_captures(&handler, &alpha, 1, b"\x1b[?1l", b"\x1b[?1h")
            .await;

    handler
        .handle_attached_live_input_for_test(requester_pid, b"\x1b[A")
        .await
        .expect("synchronized cursor key succeeds");

    assert_per_pane_up_encoding(&handler, &pane_zero, &pane_one).await;
}

#[tokio::test]
async fn send_keys_synchronize_panes_writes_to_each_live_pane() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");

    create_synchronized_two_pane_session(&handler, &alpha).await;

    let pane_zero = PaneTarget::with_window(alpha.clone(), 0, 0);
    let pane_one = PaneTarget::with_window(alpha.clone(), 0, 1);
    {
        let state = handler.state.lock().await;
        state.start_pane_input_capture_for_test(&pane_zero);
        state.start_pane_input_capture_for_test(&pane_one);
    }

    let response = handler
        .handle(Request::SendKeys(SendKeysRequest {
            target: pane_zero.clone(),
            keys: vec!["sync".to_owned()],
        }))
        .await;
    assert!(matches!(
        response,
        Response::SendKeys(SendKeysResponse { key_count: 1 })
    ));

    let state = handler.state.lock().await;
    assert_eq!(
        state.pane_input_capture_for_test(&pane_zero),
        Some(b"sync".to_vec())
    );
    assert_eq!(
        state.pane_input_capture_for_test(&pane_one),
        Some(b"sync".to_vec())
    );
}

#[cfg(windows)]
#[tokio::test]
async fn pane_input_ref_multi_token_ctrl_c_stays_on_referenced_pane_when_synchronized() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");

    create_synchronized_two_pane_session(&handler, &alpha).await;

    let pane_zero = PaneTarget::with_window(alpha.clone(), 0, 0);
    let pane_one = PaneTarget::with_window(alpha.clone(), 0, 1);
    let pane_zero_id = {
        let state = handler.state.lock().await;
        state.start_pane_input_capture_for_test(&pane_zero);
        state.start_pane_input_capture_for_test(&pane_one);
        state
            .sessions
            .session(&alpha)
            .and_then(|session| session.window_at(0))
            .and_then(|window| window.pane(0))
            .map(|pane| pane.id())
            .expect("test pane exists")
    };

    let response = handler
        .handle(Request::PaneInput(rmux_proto::PaneInputRequest {
            target: PaneTargetRef::by_id(alpha.clone(), pane_zero_id),
            keys: vec!["C-c".to_owned(), "Enter".to_owned()],
            literal: false,
        }))
        .await;
    assert!(matches!(
        response,
        Response::SendKeys(SendKeysResponse { key_count: 2 })
    ));

    let mut expected = vec![0x03];
    let enter = key_string_lookup_string("Enter").expect("Enter key exists");
    expected.extend_from_slice(&encode_key(0, ExtendedKeyFormat::Xterm, enter).unwrap());

    let state = handler.state.lock().await;
    assert_eq!(
        state.pane_input_capture_for_test(&pane_zero),
        Some(expected)
    );
    assert_eq!(
        state.pane_input_capture_for_test(&pane_one),
        Some(Vec::new())
    );
}

#[tokio::test]
async fn send_prefix_synchronize_panes_writes_to_each_live_pane() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");

    create_synchronized_two_pane_session(&handler, &alpha).await;

    let pane_zero = PaneTarget::with_window(alpha.clone(), 0, 0);
    let pane_one = PaneTarget::with_window(alpha.clone(), 0, 1);
    {
        let state = handler.state.lock().await;
        state.start_pane_input_capture_for_test(&pane_zero);
        state.start_pane_input_capture_for_test(&pane_one);
    }

    let response = handler
        .handle(Request::SendPrefix(SendPrefixRequest {
            target: Some(pane_zero.clone()),
            secondary: false,
        }))
        .await;
    assert!(matches!(
        response,
        Response::SendPrefix(SendPrefixResponse { key_count: 1, .. })
    ));

    let state = handler.state.lock().await;
    assert_eq!(
        state.pane_input_capture_for_test(&pane_zero),
        Some(b"\x02".to_vec())
    );
    assert_eq!(
        state.pane_input_capture_for_test(&pane_one),
        Some(b"\x02".to_vec())
    );
}

async fn create_synchronized_two_pane_session(
    handler: &RequestHandler,
    alpha: &rmux_proto::SessionName,
) {
    // Inert, silent panes: these tests stamp DEC private modes onto the
    // transcripts and assert per-pane input encoding, so a real login shell's
    // startup output must not race the stamped modes (the same class as the
    // double-click content race fixed in live_attach.rs).
    create_quiet_input_session(handler, alpha).await;
    let split = handler
        .handle(Request::SplitWindowExt(Box::new(
            rmux_proto::SplitWindowExtRequest {
                target: SplitWindowTarget::Pane(PaneTarget::new(alpha.clone(), 0)),
                direction: SplitDirection::Horizontal,
                before: false,
                environment: None,
                command: Some(quiet_pane_command()),
                process_command: None,
                start_directory: None,
                keep_alive_on_exit: None,
                detached: false,
                size: None,
                preserve_zoom: false,
                full_size: false,
                stdin_payload: None,
            },
        )))
        .await;
    let Response::SplitWindow(split) = split else {
        panic!("expected split-window response: {split:?}");
    };
    handler
        .wait_for_pane_startup_to_finish_for_test(&split.pane)
        .await;

    let select_first = handler
        .handle(Request::SelectPane(Box::new(SelectPaneRequest {
            target: PaneTarget::with_window(alpha.clone(), 0, 0),
            title: None,
            style: None,
            input_disabled: None,
            preserve_zoom: false,
        })))
        .await;
    assert!(matches!(select_first, Response::SelectPane(_)));

    let set_sync = handler
        .handle(Request::SetOption(SetOptionRequest {
            scope: ScopeSelector::Window(WindowTarget::with_window(alpha.clone(), 0)),
            option: OptionName::SynchronizePanes,
            value: "on".to_owned(),
            mode: SetOptionMode::Replace,
        }))
        .await;
    assert!(matches!(set_sync, Response::SetOption(_)));
}

async fn setup_synchronized_attached_mode_captures(
    handler: &RequestHandler,
    session_name: &rmux_proto::SessionName,
    active_pane: u32,
    pane_zero_mode: &[u8],
    pane_one_mode: &[u8],
) -> (u32, PaneTarget, PaneTarget) {
    create_synchronized_two_pane_session(handler, session_name).await;
    let pane_zero = PaneTarget::with_window(session_name.clone(), 0, 0);
    let pane_one = PaneTarget::with_window(session_name.clone(), 0, 1);
    {
        let mut state = handler.state.lock().await;
        state
            .append_bytes_to_pane_transcript_for_test(session_name, 0, 0, pane_zero_mode)
            .expect("first pane mode update succeeds");
        state
            .append_bytes_to_pane_transcript_for_test(session_name, 0, 1, pane_one_mode)
            .expect("second pane mode update succeeds");
        state.start_pane_input_capture_for_test(&pane_zero);
        state.start_pane_input_capture_for_test(&pane_one);
    }

    let selected = handler
        .handle(Request::SelectPane(Box::new(SelectPaneRequest {
            target: PaneTarget::with_window(session_name.clone(), 0, active_pane),
            title: None,
            style: None,
            input_disabled: None,
            preserve_zoom: false,
        })))
        .await;
    assert!(matches!(selected, Response::SelectPane(_)));

    let requester_pid = std::process::id();
    let (control_tx, _control_rx) = mpsc::unbounded_channel();
    let _attach_id = handler
        .register_attach(requester_pid, session_name.clone(), control_tx)
        .await;
    (requester_pid, pane_zero, pane_one)
}

async fn assert_per_pane_up_encoding(
    handler: &RequestHandler,
    normal_target: &PaneTarget,
    application_target: &PaneTarget,
) {
    let up = key_string_lookup_string("Up").expect("Up key exists");
    let normal = encode_key(0, ExtendedKeyFormat::Xterm, up).expect("normal Up encodes");
    let application = encode_key(mode::MODE_KCURSOR, ExtendedKeyFormat::Xterm, up)
        .expect("application Up encodes");
    let state = handler.state.lock().await;
    assert_eq!(
        state.pane_input_capture_for_test(normal_target),
        Some(normal)
    );
    assert_eq!(
        state.pane_input_capture_for_test(application_target),
        Some(application)
    );
}