rmux-server 0.1.2

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
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
use super::*;

async fn send_attached_copy_mode_command(
    handler: &RequestHandler,
    target: &PaneTarget,
    tokens: &[&str],
) -> Response {
    handler
        .handle(Request::SendKeysExt(rmux_proto::SendKeysExtRequest {
            target: Some(target.clone()),
            keys: tokens.iter().map(|token| (*token).to_owned()).collect(),
            expand_formats: false,
            hex: false,
            literal: false,
            dispatch_key_table: false,
            copy_mode_command: true,
            forward_mouse_event: false,
            reset_terminal: false,
            repeat_count: None,
        }))
        .await
}

#[tokio::test]
async fn attached_copy_mode_emacs_slash_is_unbound_and_not_forwarded() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let _control_rx = create_quiet_attached_session(&handler, requester_pid, &alpha).await;
    let target = PaneTarget::new(alpha.clone(), 0);
    replace_transcript_contents(
        &handler,
        &target,
        TerminalSize { cols: 80, rows: 24 },
        b"P0-LINE-12\r\n",
    )
    .await;
    assert!(matches!(
        handler
            .handle(Request::CopyMode(CopyModeRequest {
                target: Some(target.clone()),
                page_down: false,
                exit_on_scroll: false,
                hide_position: false,
                mouse_drag_start: false,
                cancel_mode: false,
                scrollbar_scroll: false,
                source: None,
                page_up: false,
            }))
            .await,
        Response::CopyMode(_)
    ));
    assert_eq!(
        pane_mode_status(&handler, &alpha).await,
        "1:copy-mode:0:0\n"
    );
    let mut pending_input = Vec::new();
    let forwarded_to_pane = handler
        .handle_attached_live_input_inner(requester_pid, &mut pending_input, b"/")
        .await
        .expect("copy-mode slash key");

    assert_eq!(
        pane_mode_status(&handler, &alpha).await,
        "1:copy-mode:0:0\n",
        "default emacs copy-mode must not treat / as a search prompt"
    );
    assert!(
        !forwarded_to_pane,
        "unbound copy-mode keys must be consumed instead of leaking to the pane"
    );
    assert!(
        pending_input.is_empty(),
        "fully decoded key should not be buffered"
    );
}

#[tokio::test]
async fn attached_copy_mode_emacs_ctrl_s_opens_search_prompt() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let _control_rx = create_quiet_attached_session(&handler, requester_pid, &alpha).await;
    let target = PaneTarget::new(alpha.clone(), 0);
    replace_transcript_contents(
        &handler,
        &target,
        TerminalSize { cols: 80, rows: 24 },
        b"P0-LINE-12\r\n",
    )
    .await;
    assert!(matches!(
        handler
            .handle(Request::CopyMode(CopyModeRequest {
                target: Some(target),
                page_down: false,
                exit_on_scroll: false,
                hide_position: false,
                mouse_drag_start: false,
                cancel_mode: false,
                scrollbar_scroll: false,
                source: None,
                page_up: false,
            }))
            .await,
        Response::CopyMode(_)
    ));

    handler
        .handle_attached_live_input_for_test(requester_pid, b"\x13P0-LINE-12\r")
        .await
        .expect("copy-mode C-s search");
    tokio::time::sleep(std::time::Duration::from_millis(150)).await;

    assert_eq!(
        pane_mode_status(&handler, &alpha).await,
        "1:copy-mode:1:0\n"
    );
}

#[tokio::test]
async fn attached_copy_mode_gets_first_refusal_for_search_and_selection_keys() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let _control_rx = create_quiet_attached_session(&handler, requester_pid, &alpha).await;
    let target = PaneTarget::new(alpha.clone(), 0);
    replace_transcript_contents(
        &handler,
        &target,
        TerminalSize { cols: 80, rows: 24 },
        b"P0-LINE-12\r\n",
    )
    .await;

    assert!(matches!(
        handler
            .handle(Request::SetOption(SetOptionRequest {
                scope: ScopeSelector::Window(WindowTarget::with_window(alpha.clone(), 0)),
                option: OptionName::ModeKeys,
                value: "vi".to_owned(),
                mode: SetOptionMode::Replace,
            }))
            .await,
        Response::SetOption(_)
    ));
    assert!(matches!(
        handler
            .handle(Request::CopyMode(CopyModeRequest {
                target: Some(target.clone()),
                page_down: false,
                exit_on_scroll: false,
                hide_position: false,
                mouse_drag_start: false,
                cancel_mode: false,
                scrollbar_scroll: false,
                source: None,
                page_up: false,
            }))
            .await,
        Response::CopyMode(_)
    ));
    assert!(handler
        .target_is_in_copy_mode(&target)
        .await
        .expect("copy-mode status"));

    handler
        .handle_attached_live_input_for_test(requester_pid, b"/P0-LINE-12\r ")
        .await
        .expect("copy-mode attached keys");
    tokio::time::sleep(std::time::Duration::from_millis(50)).await;

    assert_eq!(
        pane_mode_status(&handler, &alpha).await,
        "1:copy-mode:1:1\n"
    );
}

#[tokio::test]
async fn attached_copy_mode_q_exits_and_refreshes_normal_surface() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let mut control_rx = create_quiet_attached_session(&handler, requester_pid, &alpha).await;
    let target = PaneTarget::new(alpha.clone(), 0);
    replace_transcript_contents(
        &handler,
        &target,
        TerminalSize { cols: 80, rows: 24 },
        b"P0-LINE-12\r\n",
    )
    .await;
    assert!(matches!(
        handler
            .handle(Request::SetOption(SetOptionRequest {
                scope: ScopeSelector::Window(WindowTarget::with_window(alpha.clone(), 0)),
                option: OptionName::ModeKeys,
                value: "vi".to_owned(),
                mode: SetOptionMode::Replace,
            }))
            .await,
        Response::SetOption(_)
    ));
    assert!(matches!(
        handler
            .handle(Request::CopyMode(CopyModeRequest {
                target: Some(target.clone()),
                page_down: false,
                exit_on_scroll: false,
                hide_position: false,
                mouse_drag_start: false,
                cancel_mode: false,
                scrollbar_scroll: false,
                source: None,
                page_up: false,
            }))
            .await,
        Response::CopyMode(_)
    ));
    assert_eq!(
        pane_mode_status(&handler, &alpha).await,
        "1:copy-mode:0:0\n"
    );
    handler
        .handle_attached_live_input_for_test(requester_pid, b"/P0-LINE-12\r ")
        .await
        .expect("copy-mode search/select attached keys");
    tokio::time::sleep(std::time::Duration::from_millis(150)).await;
    assert_eq!(
        pane_mode_status(&handler, &alpha).await,
        "1:copy-mode:1:1\n"
    );
    drain_attach_controls(&mut control_rx);

    handler
        .handle_attached_live_input_for_test(requester_pid, b"q\x1b")
        .await
        .expect("q exits copy-mode");
    tokio::time::sleep(std::time::Duration::from_millis(50)).await;

    assert_eq!(pane_mode_status(&handler, &alpha).await, "0:::\n");
    let frame = take_render_frame(control_rx.try_recv().expect("exit refresh"));
    assert!(
        !frame.is_empty(),
        "exit refresh should re-render the attached normal surface"
    );
    assert!(
        !capture_pane_print(&handler, target).await.contains("\nq"),
        "q must be consumed by copy-mode instead of leaking to the pane"
    );
}

#[tokio::test]
async fn attached_copy_mode_copies_selection_to_buffer_and_exits_cleanly() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let mut control_rx = create_quiet_attached_session(&handler, requester_pid, &alpha).await;
    let target = PaneTarget::new(alpha.clone(), 0);
    replace_transcript_contents(
        &handler,
        &target,
        TerminalSize { cols: 80, rows: 24 },
        b"alpha\r\nneedle value\r\nomega\r\n",
    )
    .await;
    assert!(matches!(
        handler
            .handle(Request::CopyMode(CopyModeRequest {
                target: Some(target.clone()),
                page_down: false,
                exit_on_scroll: false,
                hide_position: false,
                mouse_drag_start: false,
                cancel_mode: false,
                scrollbar_scroll: false,
                source: None,
                page_up: false,
            }))
            .await,
        Response::CopyMode(_)
    ));
    assert_eq!(
        pane_mode_status(&handler, &alpha).await,
        "1:copy-mode:0:0\n"
    );

    assert!(matches!(
        send_attached_copy_mode_command(&handler, &target, &["search-backward", "--", "needle"])
            .await,
        Response::SendKeys(rmux_proto::SendKeysResponse { key_count: 3 })
    ));
    assert!(matches!(
        send_attached_copy_mode_command(&handler, &target, &["select-word"]).await,
        Response::SendKeys(rmux_proto::SendKeysResponse { key_count: 1 })
    ));
    assert_eq!(
        pane_mode_status(&handler, &alpha).await,
        "1:copy-mode:1:1\n",
        "search and word selection should be active before copy"
    );
    drain_attach_controls(&mut control_rx);

    assert!(matches!(
        send_attached_copy_mode_command(&handler, &target, &["copy-selection-and-cancel"]).await,
        Response::SendKeys(rmux_proto::SendKeysResponse { key_count: 1 })
    ));

    assert_eq!(pane_mode_status(&handler, &alpha).await, "0:::\n");
    let buffer = handler
        .handle(Request::ShowBuffer(rmux_proto::ShowBufferRequest {
            name: None,
        }))
        .await;
    let output = buffer.command_output().expect("show-buffer returns output");
    assert!(
        String::from_utf8_lossy(output.stdout()).contains("needle"),
        "copy-mode transfer should publish the selected text into the rmux buffer"
    );
    let frame = take_render_frame(control_rx.try_recv().expect("copy-mode exit refresh"));
    assert!(
        !frame.is_empty(),
        "copy-mode copy-and-cancel should refresh the attached normal surface"
    );
}

#[tokio::test]
async fn attached_copy_mode_updates_automatic_window_name_on_entry_and_exit() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let _control_rx = create_quiet_attached_session(&handler, requester_pid, &alpha).await;
    let target = PaneTarget::new(alpha.clone(), 0);

    let normal_status = display_target_format(
        &handler,
        target.clone(),
        "#{window_name}|#{pane_in_mode}|#{pane_mode}",
    );
    let normal_status = normal_status.await;
    assert!(
        normal_status.ends_with("|0|\n"),
        "normal pane status should report no active mode, got {normal_status:?}"
    );
    assert!(matches!(
        handler
            .handle(Request::CopyMode(CopyModeRequest {
                target: Some(target.clone()),
                page_down: false,
                exit_on_scroll: false,
                hide_position: false,
                mouse_drag_start: false,
                cancel_mode: false,
                scrollbar_scroll: false,
                source: None,
                page_up: false,
            }))
            .await,
        Response::CopyMode(_)
    ));
    assert_eq!(
        display_target_format(
            &handler,
            target.clone(),
            "#{window_name}|#{pane_in_mode}|#{pane_mode}"
        )
        .await,
        "[rmux]|1|copy-mode\n"
    );

    handler
        .handle_attached_live_input_for_test(requester_pid, b"q")
        .await
        .expect("q exits copy-mode");
    let restored_status = display_target_format(
        &handler,
        target,
        "#{window_name}|#{pane_in_mode}|#{pane_mode}",
    )
    .await;
    assert!(
        restored_status.ends_with("|0|\n"),
        "copy-mode exit should restore normal pane mode, got {restored_status:?}"
    );
    assert!(
        !restored_status.starts_with("[rmux]|"),
        "copy-mode exit should restore a process-derived automatic window name, got {restored_status:?}"
    );
}

#[tokio::test]
async fn attached_copy_mode_escape_exits_and_clears_mode_state() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let mut control_rx = create_quiet_attached_session(&handler, requester_pid, &alpha).await;
    let target = PaneTarget::new(alpha.clone(), 0);
    assert!(matches!(
        handler
            .handle(Request::CopyMode(CopyModeRequest {
                target: Some(target.clone()),
                page_down: false,
                exit_on_scroll: false,
                hide_position: false,
                mouse_drag_start: false,
                cancel_mode: false,
                scrollbar_scroll: false,
                source: None,
                page_up: false,
            }))
            .await,
        Response::CopyMode(_)
    ));
    assert_eq!(
        pane_mode_status(&handler, &alpha).await,
        "1:copy-mode:0:0\n"
    );
    drain_attach_controls(&mut control_rx);

    handler
        .handle_attached_live_input_for_test(requester_pid, b"\x1b")
        .await
        .expect("Escape exits copy-mode");
    tokio::time::sleep(std::time::Duration::from_millis(50)).await;

    assert_eq!(pane_mode_status(&handler, &alpha).await, "0:::\n");
    assert!(
        matches!(control_rx.try_recv(), Ok(AttachControl::Switch(_))),
        "Escape exit should refresh the attached client"
    );
}

#[tokio::test]
async fn attached_copy_mode_u_refresh_renders_history_backing() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let mut control_rx = create_quiet_attached_session(&handler, requester_pid, &alpha).await;
    let target = PaneTarget::new(alpha.clone(), 0);
    replace_transcript_contents(
        &handler,
        &target,
        TerminalSize { cols: 80, rows: 24 },
        b"copy-u-line-01\r\ncopy-u-line-02\r\ncopy-u-line-03\r\ncopy-u-line-04\r\ncopy-u-line-05\r\ncopy-u-line-06\r\ncopy-u-line-07\r\ncopy-u-line-08\r\ncopy-u-line-09\r\ncopy-u-line-10\r\ncopy-u-line-11\r\ncopy-u-line-12\r\ncopy-u-line-13\r\ncopy-u-line-14\r\ncopy-u-line-15\r\ncopy-u-line-16\r\ncopy-u-line-17\r\ncopy-u-line-18\r\ncopy-u-line-19\r\ncopy-u-line-20\r\ncopy-u-line-21\r\ncopy-u-line-22\r\ncopy-u-line-23\r\ncopy-u-line-24\r\ncopy-u-line-25\r\ncopy-u-line-26\r\ncopy-u-line-27\r\ncopy-u-line-28\r\ncopy-u-line-29\r\ncopy-u-line-30\r\n",
    )
    .await;
    drain_attach_controls(&mut control_rx);

    assert!(matches!(
        handler
            .handle(Request::CopyMode(CopyModeRequest {
                target: Some(target.clone()),
                page_down: false,
                exit_on_scroll: false,
                hide_position: false,
                mouse_drag_start: false,
                cancel_mode: false,
                scrollbar_scroll: false,
                source: None,
                page_up: true,
            }))
            .await,
        Response::CopyMode(_)
    ));

    let frame = take_render_frame(control_rx.try_recv().expect("copy-mode -u refresh"));
    assert!(
        frame.contains("copy-u-line-12"),
        "copy-mode -u attached refresh should render history-backed copy-mode content, got {frame:?}"
    );
    assert_eq!(
        pane_mode_status(&handler, &alpha).await,
        "1:copy-mode:0:0\n"
    );
}

#[tokio::test]
async fn attached_copy_mode_refresh_renders_tmux_position_indicator() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let mut control_rx = create_quiet_attached_session(&handler, requester_pid, &alpha).await;
    let target = PaneTarget::new(alpha.clone(), 0);
    replace_transcript_contents(
        &handler,
        &target,
        TerminalSize { cols: 80, rows: 24 },
        b"copy-position-line\r\n",
    )
    .await;
    drain_attach_controls(&mut control_rx);

    assert!(matches!(
        handler
            .handle(Request::CopyMode(CopyModeRequest {
                target: Some(target),
                page_down: false,
                exit_on_scroll: false,
                hide_position: false,
                mouse_drag_start: false,
                cancel_mode: false,
                scrollbar_scroll: false,
                source: None,
                page_up: false,
            }))
            .await,
        Response::CopyMode(_)
    ));

    let frame = take_render_frame(control_rx.try_recv().expect("copy-mode refresh"));
    assert!(
        frame.contains("[0/0]"),
        "copy-mode attached refresh should render tmux position indicator, got {frame:?}"
    );
}