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
459
460
461
462
463
464
465
466
467
468
469
470
use super::*;

#[tokio::test]
async fn attached_copy_mode_renders_mark_regular_and_current_match_styles() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let mut control_rx = create_attached_session(&handler, requester_pid, &alpha).await;
    let target = PaneTarget::new(alpha.clone(), 0);
    replace_transcript_contents(
        &handler,
        &target,
        TerminalSize { cols: 40, rows: 6 },
        b"needle-one\r\nplain\r\nneedle-two\r\n",
    )
    .await;
    for (option, value) in [
        (OptionName::CopyModeMarkStyle, "bg=colour17,fg=colour231"),
        (OptionName::CopyModeMatchStyle, "bg=colour18,fg=colour231"),
        (
            OptionName::CopyModeCurrentMatchStyle,
            "bg=colour19,fg=colour231",
        ),
    ] {
        assert!(matches!(
            handler
                .handle(Request::SetOption(SetOptionRequest {
                    scope: ScopeSelector::Window(WindowTarget::with_window(alpha.clone(), 0)),
                    option,
                    value: value.to_owned(),
                    mode: SetOptionMode::Replace,
                }))
                .await,
            Response::SetOption(_)
        ));
    }
    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: false,
            }))
            .await,
        Response::CopyMode(_)
    ));
    let _ = recv_render_frame(&mut control_rx, "copy-mode initial refresh").await;
    drain_attach_controls(&mut control_rx);

    assert!(matches!(
        super::copy_mode_keys::send_attached_copy_mode_command(&handler, &target, &["set-mark"])
            .await,
        Response::SendKeys(_)
    ));
    let mark_frame = recv_render_frame(&mut control_rx, "copy-mode mark refresh").await;
    assert!(
        mark_frame.contains("\u{1b}[48;5;17m"),
        "mark style must reach the attached render frame: {mark_frame:?}"
    );

    assert!(matches!(
        super::copy_mode_keys::send_attached_copy_mode_command(
            &handler,
            &target,
            &["search-forward-text", "needle"],
        )
        .await,
        Response::SendKeys(_)
    ));
    let search_frame = recv_render_frame(&mut control_rx, "copy-mode search refresh").await;
    assert!(
        search_frame.contains("\u{1b}[48;5;18m"),
        "a non-current search result must use copy-mode-match-style: {search_frame:?}"
    );
    assert!(
        search_frame.contains("\u{1b}[48;5;19m"),
        "the current search result must use copy-mode-current-match-style: {search_frame:?}"
    );
}

#[tokio::test]
async fn attached_copy_mode_u_attach_render_matches_mode_capture_source() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let mut control_rx = create_attached_session(&handler, requester_pid, &alpha).await;
    let target = PaneTarget::new(alpha.clone(), 0);
    replace_transcript_contents(
        &handler,
        &target,
        TerminalSize { cols: 40, rows: 6 },
        b"mode-render-01\r\nmode-render-02\r\nmode-render-03\r\nmode-render-04\r\nmode-render-05\r\nmode-render-06\r\nmode-render-07\r\nmode-render-08\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 = recv_render_frame(&mut control_rx, "copy-mode -u refresh").await;
    let mode_capture = {
        let response = handler
            .handle(Request::CapturePane(Box::new(CapturePaneRequest {
                target,
                start: None,
                end: None,
                print: true,
                buffer_name: None,
                alternate: false,
                escape_ansi: false,
                escape_sequences: false,
                include_format: false,
                hyperlinks: false,
                line_numbers: false,
                join_wrapped: false,
                use_mode_screen: true,
                preserve_trailing_spaces: false,
                do_not_trim_spaces: false,
                pending_input: false,
                quiet: false,
                start_is_absolute: false,
                end_is_absolute: false,
            })))
            .await;
        let output = response
            .command_output()
            .expect("capture-pane -p -M should return command output");
        String::from_utf8(output.stdout().to_vec()).expect("mode capture stdout is utf-8")
    };
    assert!(
        frame.contains("mode-render-03"),
        "attached refresh should include the same copy-mode backing content, got {frame:?}"
    );
    assert!(
        mode_capture.contains("mode-render-03"),
        "mode capture should include the copy-mode backing content, got {mode_capture:?}"
    );
}

#[tokio::test]
async fn attached_copy_mode_clipped_cursor_marker_wins_over_position_badge() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("copy-line-marker");
    let mut control_rx = create_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"\x1b[1;80H",
    )
    .await;
    assert!(matches!(
        handler
            .handle(Request::SetOption(SetOptionRequest {
                scope: ScopeSelector::Window(WindowTarget::with_window(alpha.clone(), 0)),
                option: OptionName::CopyModeLineNumbers,
                value: "absolute".to_owned(),
                mode: SetOptionMode::Replace,
            }))
            .await,
        Response::SetOption(_)
    ));
    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 = recv_render_frame(&mut control_rx, "line-number marker refresh").await;
    let rendered = {
        let mut screen = Screen::new(TerminalSize { cols: 80, rows: 24 }, 0);
        let mut parser = InputParser::new();
        parser.parse(frame.as_bytes(), &mut screen);
        String::from_utf8(screen.capture_transcript(Default::default(), Default::default()))
            .expect("render frame replay is utf-8")
    };
    assert!(
        rendered
            .lines()
            .next()
            .is_some_and(|line| line.ends_with('$')),
        "tmux paints '$' after the overlapping badge: frame={frame:?} replay={rendered:?}"
    );
}

#[tokio::test]
async fn attached_copy_mode_hide_and_toggle_position_control_the_badge() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("copy-position-hidden");
    let mut control_rx = create_attached_session(&handler, requester_pid, &alpha).await;
    let target = PaneTarget::new(alpha.clone(), 0);
    assert!(matches!(
        handler
            .handle(Request::SetOption(SetOptionRequest {
                scope: ScopeSelector::Window(WindowTarget::with_window(alpha.clone(), 0)),
                option: OptionName::CopyModePositionFormat,
                value: "POSITION-VISIBLE".to_owned(),
                mode: SetOptionMode::Replace,
            }))
            .await,
        Response::SetOption(_)
    ));
    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: true,
                mouse_drag_start: false,
                cancel_mode: false,
                scrollbar_scroll: false,
                source: None,
                page_up: false,
            }))
            .await,
        Response::CopyMode(_)
    ));
    let hidden = recv_render_frame(&mut control_rx, "hidden position refresh").await;
    assert!(
        !hidden.contains("POSITION-VISIBLE"),
        "hidden frame: {hidden:?}"
    );

    assert!(matches!(
        super::copy_mode_keys::send_attached_copy_mode_command(
            &handler,
            &target,
            &["toggle-position"],
        )
        .await,
        Response::SendKeys(_)
    ));
    let visible = recv_render_frame(&mut control_rx, "toggled position refresh").await;
    assert!(
        visible.contains("POSITION-VISIBLE"),
        "toggle-position should reveal the badge: {visible:?}"
    );
}

#[tokio::test]
async fn attached_mouse_drag_copy_mode_refresh_keeps_prompt_visible() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let mut control_rx = create_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"\x1b[1m\x1b[32mtester@RMUXHOST\x1b[0m:\x1b[1m\x1b[34m~\x1b[0m$ ",
    )
    .await;
    drain_attach_controls(&mut control_rx);

    let (window_id, pane_id) = {
        let state = handler.state.lock().await;
        let session = state.sessions.session(&alpha).expect("session exists");
        let window = session.window_at(0).expect("window exists");
        let pane = window.pane(0).expect("pane exists");
        (window.id(), pane.id())
    };

    let mut active_attach = handler.active_attach.lock().await;
    let active = active_attach
        .by_pid
        .get_mut(&requester_pid)
        .expect("attached client exists");
    active.mouse.current_event = Some(AttachedMouseEvent {
        raw: MouseForwardEvent {
            b: 32,
            lb: 0,
            x: 22,
            y: 17,
            lx: 22,
            ly: 17,
            sgr_b: 32,
            sgr_type: 'M',
            ignore: false,
        },
        session_id: 0,
        window_id: Some(window_id.as_u32()),
        pane_id: Some(pane_id),
        pane_target: Some(target.clone()),
        location: MouseLocation::Pane,
        status_at: None,
        status_lines: 0,
        ignore: false,
    });
    drop(active_attach);

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

    let frame = recv_render_frame(&mut control_rx, "copy-mode mouse refresh").await;
    let mode_capture = {
        let response = handler
            .handle(Request::CapturePane(Box::new(CapturePaneRequest {
                target: target.clone(),
                start: None,
                end: None,
                print: true,
                buffer_name: None,
                alternate: false,
                escape_ansi: false,
                escape_sequences: false,
                include_format: false,
                hyperlinks: false,
                line_numbers: false,
                join_wrapped: false,
                use_mode_screen: true,
                preserve_trailing_spaces: false,
                do_not_trim_spaces: false,
                pending_input: false,
                quiet: false,
                start_is_absolute: false,
                end_is_absolute: false,
            })))
            .await;
        let output = response
            .command_output()
            .expect("capture-pane -p -M should return command output");
        String::from_utf8(output.stdout().to_vec()).expect("mode capture stdout is utf-8")
    };
    let rendered_screen = {
        let mut screen = Screen::new(TerminalSize { cols: 80, rows: 24 }, 0);
        let mut parser = InputParser::new();
        parser.parse(frame.as_bytes(), &mut screen);
        String::from_utf8(screen.capture_transcript(Default::default(), Default::default()))
            .expect("render frame replay is utf-8")
    };

    assert!(
        mode_capture.contains("tester@RMUXHOST:~$"),
        "mode capture should retain the prompt line, got {mode_capture:?}"
    );
    assert!(
        rendered_screen.contains("tester@RMUXHOST:~$"),
        "attached copy-mode mouse refresh should keep the prompt visible after replay, frame={frame:?} replay={rendered_screen:?}"
    );
    // A drag start has no selected cells yet, so this frame may only carry
    // the position indicator's mode-style. Extend the selection and require
    // a second mode-style span: the indicator alone must not satisfy the
    // selection-paint assertion (the previous form of this test passed even
    // when selections were never painted, issue #90).
    assert!(
        frame.contains("\u{1b}[0;30;43m"),
        "attached copy-mode mouse refresh should style the position indicator, frame={frame:?}"
    );
    assert!(matches!(
        super::copy_mode_keys::send_attached_copy_mode_command(&handler, &target, &["select-line"])
            .await,
        Response::SendKeys(_)
    ));
    let frame = recv_render_frame(&mut control_rx, "copy-mode selection refresh").await;
    assert!(
        frame.contains("\u{1b}[30m\u{1b}[43m"),
        "extending the selection must paint selected cells with tmux mode-style; \
         the position indicator's combined ESC[0;30;43m form alone must not \
         satisfy this, frame={frame:?}"
    );
}

#[tokio::test]
async fn attached_copy_mode_unhandled_key_falls_back_to_prefix_table() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("alpha");
    let _control_rx = create_attached_session(&handler, requester_pid, &alpha).await;
    assert!(matches!(
        handler
            .handle(Request::SplitWindow(SplitWindowRequest {
                target: SplitWindowTarget::Session(alpha.clone()),
                direction: rmux_proto::SplitDirection::Horizontal,
                before: false,
                environment: None,
            }))
            .await,
        Response::SplitWindow(_)
    ));
    assert!(matches!(
        handler
            .handle(Request::SelectPane(Box::new(SelectPaneRequest {
                target: PaneTarget::new(alpha.clone(), 0),
                title: None,
                style: None,
                input_disabled: None,
                preserve_zoom: false,
            })))
            .await,
        Response::SelectPane(_)
    ));
    assert!(matches!(
        handler
            .handle(Request::CopyMode(CopyModeRequest {
                target: Some(PaneTarget::new(alpha.clone(), 0)),
                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"\x02o")
        .await
        .expect("copy-mode declined unhandled prefix navigation");

    assert_eq!(active_panes(&handler, &alpha).await, "0:0\n1:1\n");
}