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
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
use super::RequestHandler;
use crate::pane_io::AttachControl;
use rmux_core::command_parser::CommandParser;
use rmux_proto::{NewSessionRequest, Request, Response, RmuxError, SessionName, TerminalSize};
use tokio::sync::mpsc;
use tokio::time::{timeout, Duration};

fn session_name(value: &str) -> SessionName {
    SessionName::new(value).expect("valid session name")
}

async fn create_attached_session(
    handler: &RequestHandler,
    requester_pid: u32,
    name: &str,
) -> mpsc::UnboundedReceiver<AttachControl> {
    let session_name = session_name(name);
    assert!(matches!(
        handler
            .handle(Request::NewSession(NewSessionRequest {
                session_name: session_name.clone(),
                detached: true,
                size: Some(TerminalSize { cols: 80, rows: 24 }),
                environment: None,
            }))
            .await,
        Response::NewSession(_)
    ));

    let (control_tx, control_rx) = mpsc::unbounded_channel();
    handler
        .register_attach(requester_pid, session_name, control_tx)
        .await;
    control_rx
}

async fn recv_switch_frame(control_rx: &mut mpsc::UnboundedReceiver<AttachControl>) -> String {
    loop {
        let control = timeout(Duration::from_secs(1), control_rx.recv())
            .await
            .expect("prompt refresh timeout")
            .expect("attached refresh");
        if let AttachControl::Switch(target) = control {
            return String::from_utf8(target.into_target().render_frame)
                .expect("render frame is utf-8");
        }
    }
}

async fn recv_switch_frame_containing(
    control_rx: &mut mpsc::UnboundedReceiver<AttachControl>,
    needle: &str,
) -> String {
    loop {
        let frame = recv_switch_frame(control_rx).await;
        if frame.contains(needle) {
            return frame;
        }
    }
}

fn parse_command(command: &str) -> rmux_core::command_parser::ParsedCommands {
    CommandParser::new()
        .parse_one_group(command)
        .expect("command parses")
}

#[tokio::test]
async fn active_command_prompt_accepts_one_megabyte_frame_with_bounded_work() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let mut control_rx = create_attached_session(&handler, requester_pid, "prompt-bulk").await;
    let parsed = parse_command("command-prompt -b -pbulk");
    handler
        .execute_parsed_commands_for_test(requester_pid, parsed)
        .await
        .expect("background command prompt starts");
    let frame = recv_switch_frame_containing(&mut control_rx, "bulk ").await;
    assert!(frame.contains("bulk "), "{frame}");

    let input = vec![b'a'; 1_000_000];
    timeout(
        if cfg!(windows) {
            Duration::from_secs(30)
        } else {
            Duration::from_secs(2)
        },
        handler.handle_attached_live_input_for_test(requester_pid, &input),
    )
    .await
    .expect("one-megabyte prompt frame must have bounded processing work")
    .expect("one-megabyte prompt input succeeds");

    let prompt = handler
        .attached_prompt_render(requester_pid)
        .await
        .expect("command prompt remains active");
    assert_eq!(prompt.input.len(), input.len());
    assert!(prompt.input.bytes().all(|byte| byte == b'a'));
    handler.clear_prompt_for_attach(requester_pid).await;
}

#[tokio::test]
async fn batched_prompt_text_preserves_split_utf8_at_the_input_boundary() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let mut control_rx =
        create_attached_session(&handler, requester_pid, "prompt-split-utf8").await;
    let parsed = parse_command("command-prompt -b -pbulk");
    handler
        .execute_parsed_commands_for_test(requester_pid, parsed)
        .await
        .expect("background command prompt starts");
    let _ = recv_switch_frame_containing(&mut control_rx, "bulk ").await;

    let mut pending_input = Vec::new();
    handler
        .handle_attached_live_input(requester_pid, &mut pending_input, b"a\xe6\x97")
        .await
        .expect("partial prompt UTF-8 succeeds");
    assert_eq!(pending_input, b"\xe6\x97");

    handler
        .handle_attached_live_input(requester_pid, &mut pending_input, b"\xa5b")
        .await
        .expect("completed prompt UTF-8 succeeds");
    assert!(pending_input.is_empty());
    let prompt = handler
        .attached_prompt_render(requester_pid)
        .await
        .expect("command prompt remains active");
    assert_eq!(prompt.input, "aæ—¥b");
    assert_eq!(prompt.cursor, 3);
    handler.clear_prompt_for_attach(requester_pid).await;
}

#[tokio::test]
async fn timed_out_partial_prompt_mouse_resolves_as_escape() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let mut control_rx =
        create_attached_session(&handler, requester_pid, "prompt-partial-mouse").await;
    let parsed = parse_command("command-prompt -b -pname");
    handler
        .execute_parsed_commands_for_test(requester_pid, parsed)
        .await
        .expect("background command prompt starts");
    let _ = recv_switch_frame_containing(&mut control_rx, "name ").await;

    let mut pending_input = Vec::new();
    handler
        .handle_attached_live_input(requester_pid, &mut pending_input, b"\x1b[<")
        .await
        .expect("partial prompt mouse input");
    assert_eq!(pending_input, b"\x1b[<");
    assert!(handler
        .attached_prompt_render(requester_pid)
        .await
        .is_some());

    handler
        .flush_attached_pending_escape_input(requester_pid, &mut pending_input)
        .await
        .expect("prompt escape timeout");

    assert!(pending_input.is_empty());
    assert!(
        handler
            .attached_prompt_render(requester_pid)
            .await
            .is_none(),
        "the timeout must cancel the prompt rather than retain input forever"
    );
}

#[tokio::test]
async fn command_prompt_renders_prompt_and_executes_substituted_command() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let mut control_rx = create_attached_session(&handler, requester_pid, "alpha").await;
    let parsed = parse_command("command-prompt -pname { display-message -p -- 'value=%%' }");
    let handler_task = handler.clone();
    let join = tokio::spawn(async move {
        handler_task
            .execute_parsed_commands_for_test(requester_pid, parsed)
            .await
    });

    let frame = recv_switch_frame_containing(&mut control_rx, "name ").await;
    assert!(frame.contains("name "), "{frame}");

    handler
        .handle_attached_live_input_for_test(requester_pid, b"delta\r")
        .await
        .expect("prompt input");

    let output = join
        .await
        .expect("prompt task join")
        .expect("prompt command output");
    assert_eq!(output.stdout(), b"value=delta\n");
}

#[tokio::test]
async fn rename_session_rekeys_the_active_prompt_execution_context() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let alpha = session_name("prompt-rename-alpha");
    let beta = session_name("prompt-rename-beta");
    let mut control_rx = create_attached_session(&handler, requester_pid, alpha.as_str()).await;
    let parsed = parse_command("command-prompt -pgo { display-message -p '#{session_name}' }");
    let context = super::scripting_support::QueueExecutionContext::without_caller_cwd()
        .with_implicit_current_target(Some(rmux_proto::Target::Pane(rmux_proto::PaneTarget::new(
            alpha.clone(),
            0,
        ))));
    let handler_task = handler.clone();
    let join = tokio::spawn(async move {
        handler_task
            .execute_parsed_commands(requester_pid, parsed, context)
            .await
    });
    let _ = recv_switch_frame_containing(&mut control_rx, "go ").await;

    let response = handler
        .handle(Request::RenameSession(rmux_proto::RenameSessionRequest {
            target: alpha,
            new_name: beta.clone(),
        }))
        .await;
    assert!(
        matches!(response, Response::RenameSession(_)),
        "{response:?}"
    );
    handler
        .handle_attached_live_input_for_test(requester_pid, b"\r")
        .await
        .expect("renamed prompt accepts input");

    let output = join
        .await
        .expect("prompt task join")
        .expect("prompt context resolves after rename");
    assert_eq!(output.stdout(), format!("{beta}\n").as_bytes());
}

#[tokio::test]
async fn command_prompt_default_label_uses_first_template_command_name() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let mut control_rx = create_attached_session(&handler, requester_pid, "alpha").await;
    let parsed = parse_command("command-prompt -I'#W' { rename-window -- '%%' }");
    let handler_task = handler.clone();
    let join = tokio::spawn(async move {
        handler_task
            .execute_parsed_commands_for_test(requester_pid, parsed)
            .await
    });

    let frame = recv_switch_frame_containing(&mut control_rx, "(rename-window) ").await;
    assert!(frame.contains("(rename-window) "), "{frame}");
    assert!(!frame.contains("(rename-window --"), "{frame}");

    handler
        .handle_attached_live_input_for_test(requester_pid, b"delta\r")
        .await
        .expect("prompt input");

    let output = join
        .await
        .expect("prompt task join")
        .expect("rename prompt output");
    assert!(output.stdout().is_empty());
}

#[tokio::test]
async fn command_prompt_multi_prompt_substitutes_percent_indices() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let mut control_rx = create_attached_session(&handler, requester_pid, "alpha").await;
    let parsed = parse_command(
        "command-prompt -pfirst,second { display-message -p -- 'first=%1 second=%2 default=%%' }",
    );
    let handler_task = handler.clone();
    let join = tokio::spawn(async move {
        handler_task
            .execute_parsed_commands_for_test(requester_pid, parsed)
            .await
    });

    let first_frame = recv_switch_frame_containing(&mut control_rx, "first ").await;
    assert!(first_frame.contains("first "), "{first_frame}");
    handler
        .handle_attached_live_input_for_test(requester_pid, b"alpha\r")
        .await
        .expect("first prompt input");

    let second_frame = recv_switch_frame_containing(&mut control_rx, "second ").await;
    assert!(second_frame.contains("second "), "{second_frame}");
    handler
        .handle_attached_live_input_for_test(requester_pid, b"beta\r")
        .await
        .expect("second prompt input");

    let output = join
        .await
        .expect("prompt task join")
        .expect("prompt command output");
    assert_eq!(output.stdout(), b"first=alpha second=beta default=alpha\n");
}

#[tokio::test]
async fn confirm_before_accepts_enter_with_default_yes_and_skips_on_decline() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let mut control_rx = create_attached_session(&handler, requester_pid, "alpha").await;
    let parsed = parse_command("confirm-before -y -psure { display-message -p -- 'confirmed' }");
    let handler_task = handler.clone();
    let accept_join = tokio::spawn(async move {
        handler_task
            .execute_parsed_commands_for_test(requester_pid, parsed)
            .await
    });

    let frame = recv_switch_frame_containing(&mut control_rx, "sure ").await;
    assert!(frame.contains("sure "), "{frame}");
    handler
        .handle_attached_live_input_for_test(requester_pid, b"\r")
        .await
        .expect("confirm input");

    let accepted = accept_join
        .await
        .expect("confirm task join")
        .expect("confirm command output");
    assert_eq!(accepted.stdout(), b"confirmed\n");

    let parsed = parse_command("confirm-before -pstop { display-message -p -- 'blocked' }");
    let handler_task = handler.clone();
    let decline_join = tokio::spawn(async move {
        handler_task
            .execute_parsed_commands_for_test(requester_pid, parsed)
            .await
    });

    let frame = recv_switch_frame_containing(&mut control_rx, "stop ").await;
    assert!(frame.contains("stop "), "{frame}");
    handler
        .handle_attached_live_input_for_test(requester_pid, b"n")
        .await
        .expect("decline input");

    let declined = decline_join
        .await
        .expect("decline task join")
        .expect("decline prompt output");
    assert!(declined.stdout().is_empty());
}

#[tokio::test]
async fn prompt_commands_return_tmux_style_errors_for_unknown_target_clients() {
    let handler = RequestHandler::new();
    assert!(matches!(
        handler
            .handle(Request::NewSession(NewSessionRequest {
                session_name: session_name("alpha"),
                detached: true,
                size: Some(TerminalSize { cols: 80, rows: 24 }),
                environment: None,
            }))
            .await,
        Response::NewSession(_)
    ));

    let prompt_error = handler
        .execute_parsed_commands_for_test(
            std::process::id(),
            parse_command("command-prompt -t 99999 -pname { display-message -p -- 'value=%%' }"),
        )
        .await
        .expect_err("unknown target client should fail");
    assert_eq!(
        prompt_error,
        RmuxError::Message("can't find client: 99999".to_owned())
    );

    let confirm_error = handler
        .execute_parsed_commands_for_test(
            std::process::id(),
            parse_command("confirm-before -t 99999 -psure { display-message -p -- 'confirmed' }"),
        )
        .await
        .expect_err("unknown target client should fail");
    assert_eq!(
        confirm_error,
        RmuxError::Message("can't find client: 99999".to_owned())
    );
}

#[tokio::test]
async fn second_prompt_request_returns_immediately_while_prompt_is_active() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let mut control_rx = create_attached_session(&handler, requester_pid, "alpha").await;
    let first = parse_command("command-prompt -pfirst { display-message -p -- 'first=%%' }");
    let handler_task = handler.clone();
    let first_join = tokio::spawn(async move {
        handler_task
            .execute_parsed_commands_for_test(requester_pid, first)
            .await
    });

    let frame = recv_switch_frame_containing(&mut control_rx, "first ").await;
    assert!(frame.contains("first "), "{frame}");

    let second = parse_command("command-prompt -psecond { display-message -p -- 'second=%%' }");
    let second_output = timeout(
        Duration::from_millis(250),
        handler.execute_parsed_commands_for_test(requester_pid, second),
    )
    .await
    .expect("second prompt returns immediately")
    .expect("second prompt output");
    assert!(second_output.stdout().is_empty());

    handler
        .handle_attached_live_input_for_test(requester_pid, b"done\r")
        .await
        .expect("first prompt input");
    let first_output = first_join
        .await
        .expect("first prompt task join")
        .expect("first prompt output");
    assert_eq!(first_output.stdout(), b"first=done\n");
}

#[tokio::test]
async fn show_prompt_history_renders_tmux_sections_in_prompt_type_order() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let mut control_rx = create_attached_session(&handler, requester_pid, "alpha").await;

    let parsed = parse_command("command-prompt -pcommand { display-message -p -- 'command=%%' }");
    let handler_task = handler.clone();
    let command_join = tokio::spawn(async move {
        handler_task
            .execute_parsed_commands_for_test(requester_pid, parsed)
            .await
    });

    let frame = recv_switch_frame_containing(&mut control_rx, "command ").await;
    assert!(frame.contains("command "), "{frame}");
    handler
        .handle_attached_live_input_for_test(requester_pid, b"first\r")
        .await
        .expect("command prompt input");
    let command_output = command_join
        .await
        .expect("command prompt task join")
        .expect("command prompt output");
    assert_eq!(command_output.stdout(), b"command=first\n");

    let parsed =
        parse_command("command-prompt -T search -psearch { display-message -p -- 'search=%%' }");
    let handler_task = handler.clone();
    let search_join = tokio::spawn(async move {
        handler_task
            .execute_parsed_commands_for_test(requester_pid, parsed)
            .await
    });

    let frame = recv_switch_frame_containing(&mut control_rx, "search ").await;
    assert!(frame.contains("search "), "{frame}");
    handler
        .handle_attached_live_input_for_test(requester_pid, b"needle\r")
        .await
        .expect("search prompt input");
    let search_output = search_join
        .await
        .expect("search prompt task join")
        .expect("search prompt output");
    assert_eq!(search_output.stdout(), b"search=needle\n");

    let history = handler
        .execute_parsed_commands_for_test(requester_pid, parse_command("show-prompt-history"))
        .await
        .expect("show-prompt-history succeeds");
    assert_eq!(
        history.stdout(),
        b"History for command:\n\n1: first\n\nHistory for search:\n\n1: needle\n\nHistory for target:\n\n\nHistory for window-target:\n\n\n"
    );

    let search_history = handler
        .execute_parsed_commands_for_test(
            requester_pid,
            parse_command("show-prompt-history -T search"),
        )
        .await
        .expect("show-prompt-history -T search succeeds");
    assert_eq!(
        search_history.stdout(),
        b"History for search:\n\n1: needle\n\n"
    );
}

#[tokio::test]
async fn clear_prompt_history_clears_selected_type_without_touching_others() {
    let handler = RequestHandler::new();
    let requester_pid = std::process::id();
    let mut control_rx = create_attached_session(&handler, requester_pid, "alpha").await;

    let parsed = parse_command("command-prompt -pcommand { display-message -p -- 'command=%%' }");
    let handler_task = handler.clone();
    let command_join = tokio::spawn(async move {
        handler_task
            .execute_parsed_commands_for_test(requester_pid, parsed)
            .await
    });

    let frame = recv_switch_frame_containing(&mut control_rx, "command ").await;
    assert!(frame.contains("command "), "{frame}");
    handler
        .handle_attached_live_input_for_test(requester_pid, b"keep\r")
        .await
        .expect("command prompt input");
    let command_output = command_join
        .await
        .expect("command prompt task join")
        .expect("command prompt output");
    assert_eq!(command_output.stdout(), b"command=keep\n");

    let parsed =
        parse_command("command-prompt -T search -psearch { display-message -p -- 'search=%%' }");
    let handler_task = handler.clone();
    let search_join = tokio::spawn(async move {
        handler_task
            .execute_parsed_commands_for_test(requester_pid, parsed)
            .await
    });

    let frame = recv_switch_frame_containing(&mut control_rx, "search ").await;
    assert!(frame.contains("search "), "{frame}");
    handler
        .handle_attached_live_input_for_test(requester_pid, b"drop\r")
        .await
        .expect("search prompt input");
    let search_output = search_join
        .await
        .expect("search prompt task join")
        .expect("search prompt output");
    assert_eq!(search_output.stdout(), b"search=drop\n");

    let cleared = handler
        .execute_parsed_commands_for_test(
            requester_pid,
            parse_command("clear-prompt-history -T search"),
        )
        .await
        .expect("clear-prompt-history -T search succeeds");
    assert!(cleared.stdout().is_empty());

    let remaining = handler
        .execute_parsed_commands_for_test(requester_pid, parse_command("show-prompt-history"))
        .await
        .expect("show-prompt-history succeeds");
    assert_eq!(
        remaining.stdout(),
        b"History for command:\n\n1: keep\n\nHistory for search:\n\n\nHistory for target:\n\n\nHistory for window-target:\n\n\n"
    );

    let cleared_all = handler
        .execute_parsed_commands_for_test(requester_pid, parse_command("clear-prompt-history"))
        .await
        .expect("clear-prompt-history succeeds");
    assert!(cleared_all.stdout().is_empty());

    let empty = handler
        .execute_parsed_commands_for_test(requester_pid, parse_command("show-prompt-history"))
        .await
        .expect("show-prompt-history after clear succeeds");
    assert_eq!(
        empty.stdout(),
        b"History for command:\n\n\nHistory for search:\n\n\nHistory for target:\n\n\nHistory for window-target:\n\n\n"
    );
}