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
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
use super::*;

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

    let parsed = CommandParser::new()
        .parse("display-message -p -F '#{session_name}' -t alpha")
        .expect("commands parse");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("display-message -F executes");

    assert_eq!(output.stdout(), b"alpha\n");
}

#[tokio::test]
async fn parsed_queue_display_message_consumes_implemented_compat_flags_before_message() {
    let handler = RequestHandler::new();

    let parsed = CommandParser::new()
        .parse("display-message -p -I -l -v hello")
        .expect("display-message compat flags parse");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("display-message compat flags execute");

    assert_eq!(
        output.stdout(),
        b"# expanding format: hello\n# result is: hello\nhello\n"
    );
}

#[tokio::test]
async fn parsed_queue_display_message_rejects_multiple_message_arguments() {
    let handler = RequestHandler::new();
    let parsed = CommandParser::new()
        .parse("display-message a b c")
        .expect("command parser keeps queue validation for execution");
    let error = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect_err("display-message must accept at most one message argument");

    assert!(
        error
            .to_string()
            .contains("command display-message: too many arguments (need at most 1)"),
        "unexpected error: {error}"
    );
}

#[tokio::test]
async fn parsed_queue_display_message_accepts_delay_and_ignore_input_flags() {
    let handler = RequestHandler::new();

    for command in [
        "display-message -d0 -p hello",
        "display-message -pN hello",
        "display-message -pd1 hello",
    ] {
        let parsed = CommandParser::new()
            .parse(command)
            .expect("generic command parser preserves display-message flags");
        let output = handler
            .execute_parsed_commands_for_test(std::process::id(), parsed)
            .await
            .expect("tmux display-message timing flags execute");
        assert_eq!(output.stdout(), b"hello\n");
    }
}

#[tokio::test]
async fn parsed_queue_display_message_reports_tmux_delay_errors() {
    let handler = RequestHandler::new();

    for (value, expected) in [
        ("-1", "delay too small"),
        ("4294967296", "delay too large"),
        ("1 ", "delay invalid"),
        ("1.0", "delay invalid"),
    ] {
        let parsed = CommandParser::new()
            .parse(&format!("display-message -d '{value}' -p hello"))
            .expect("generic command parser preserves display-message delay");
        let error = handler
            .execute_parsed_commands_for_test(std::process::id(), parsed)
            .await
            .expect_err("invalid display-message delay must fail");
        assert_eq!(error, rmux_proto::RmuxError::Message(expected.to_owned()));
    }
}

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

    let parsed = CommandParser::new()
        .parse("display-message -pt alpha:0.0 'hi-#{pane_index}'")
        .expect("display-message -pt cluster parses");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("display-message -pt cluster executes");

    assert_eq!(output.stdout(), b"hi-0\n");
}

#[tokio::test]
async fn parsed_queue_display_message_c_missing_client_is_noop() {
    let handler = RequestHandler::new();

    let parsed = CommandParser::new()
        .parse("display-message -c 999999 hello")
        .expect("display-message -c parses");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("missing target-client is a tmux-compatible noop");

    assert!(output.stdout().is_empty());
}

#[tokio::test]
async fn parsed_queue_display_message_print_ignores_missing_target_client() {
    let handler = RequestHandler::new();

    let parsed = CommandParser::new()
        .parse("display-message -p -c 999999 hello")
        .expect("display-message -p -c parses");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("print with missing target-client still succeeds");

    assert_eq!(output.stdout(), b"hello\n");
}

#[tokio::test]
async fn parsed_queue_display_message_targets_control_client_with_initiator_context() {
    let handler = RequestHandler::new();
    let alpha = session_name("display-control-alpha");
    let detached = session_name("display-control-detached");
    for session_name in [alpha.clone(), detached.clone()] {
        assert!(matches!(
            handler
                .handle(Request::NewSession(NewSessionRequest {
                    session_name,
                    detached: true,
                    size: Some(TerminalSize { cols: 80, rows: 24 }),
                    environment: None,
                }))
                .await,
            Response::NewSession(_)
        ));
    }
    let requester_pid = 99_613;
    let (control_id, mut events) =
        register_control_for_session(&handler, requester_pid, alpha.clone()).await;
    while events.try_recv().is_ok() {}
    let identity = ControlClientIdentity::new(requester_pid, control_id);
    let client_name = format!("client-{requester_pid}");
    let template = "#{session_name}|#{client_session}|#{client_name}";

    let parsed = CommandParser::new()
        .parse(&format!(
            "display-message -p -c {requester_pid} -t {detached} '{template}'"
        ))
        .expect("queued control display-message parses");
    let output = with_control_queue_identity(
        identity,
        handler.execute_parsed_commands_for_test(requester_pid, parsed),
    )
    .await
    .expect("queued control display-message prints");
    assert_eq!(
        output.stdout(),
        format!("{detached}|{alpha}|{client_name}\n").as_bytes()
    );

    let parsed = CommandParser::new()
        .parse(&format!(
            "display-message -c {requester_pid} -t {detached} '{template}'"
        ))
        .expect("queued control overlay parses");
    with_control_queue_identity(
        identity,
        handler.execute_parsed_commands_for_test(requester_pid, parsed),
    )
    .await
    .expect("queued control overlay executes");
    let notification = std::iter::from_fn(|| events.try_recv().ok())
        .find_map(|event| match event {
            ControlServerEvent::Notification(line) => Some(line),
            _ => None,
        })
        .expect("target control client receives a message notification");
    assert_eq!(
        notification,
        format!("%message {detached}|{alpha}|{client_name}")
    );
}

#[tokio::test]
async fn parsed_queue_send_keys_c_missing_client_is_noop() {
    let handler = RequestHandler::new();

    let parsed = CommandParser::new()
        .parse("send-keys -c 999999 A")
        .expect("send-keys -c parses");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("missing target-client is a tmux-compatible noop");

    assert!(output.stdout().is_empty());
}

#[tokio::test]
async fn parsed_queue_display_message_all_formats_uses_core_inventory() {
    let handler = RequestHandler::new();

    let parsed = CommandParser::new()
        .parse("display-message -a")
        .expect("display-message -a parses");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("display-message -a executes");
    let stdout = std::str::from_utf8(output.stdout()).expect("display-message -a utf8");

    assert!(stdout.contains("client_session="), "{stdout}");
    assert!(stdout.contains("window_offset_x="), "{stdout}");
    assert!(stdout.contains("command=display-message"), "{stdout}");
}

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

    let parsed = CommandParser::new()
        .parse("list-panes -a -F '#{session_name}:#{pane_index}'")
        .expect("list-panes -a parses");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("list-panes -a executes");
    let stdout = std::str::from_utf8(output.stdout()).expect("list-panes utf8");

    assert!(stdout.contains("alpha:0\n"), "{stdout}");
    assert!(stdout.contains("beta:0\n"), "{stdout}");
}

#[tokio::test]
async fn parse_control_commands_rejects_invalid_prompt_history_type() {
    let handler = RequestHandler::new();

    let parsed = handler
        .parse_control_commands("show-prompt-history -T bogus")
        .await
        .expect("command should parse before execution");
    let error = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect_err("invalid prompt type should fail during execution");

    assert_eq!(
        error,
        rmux_proto::RmuxError::Server("invalid type: bogus".to_owned())
    );
}

#[tokio::test]
async fn parsed_queue_set_environment_requires_a_value() {
    let handler = RequestHandler::new();
    let parsed = CommandParser::new()
        .parse("set-environment -g TERM")
        .expect("commands parse");

    let error = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect_err("missing set-environment value should fail");

    assert_eq!(
        error,
        rmux_proto::RmuxError::Server("no value specified".to_owned())
    );
}

#[tokio::test]
async fn parsed_queue_set_environment_uses_current_session_by_default() {
    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 parsed = CommandParser::new()
        .parse(
            "set-environment -h SECRET classified; \
             show-environment SECRET; \
             show-environment -h SECRET",
        )
        .expect("commands parse");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("environment commands execute");

    assert_eq!(output.stdout(), b"SECRET=classified\n");
}

#[tokio::test]
async fn hook_string_mode_newlines_share_one_abort_group() {
    let handler = RequestHandler::new();

    let result = with_hook_execution(
        crate::hook_runtime::HookExecutionContext::command(HookName::AfterShowOptions),
        Vec::new(),
        async {
            handler
                .execute_hook_command(
                    std::process::id(),
                    "show-buffer -b missing\nset-buffer -b skipped no",
                )
                .await
        },
    )
    .await;

    assert!(result.is_err());
    assert!(matches!(
        handler
            .handle(Request::ShowBuffer(ShowBufferRequest {
                name: Some("skipped".to_owned()),
            }))
            .await,
        Response::Error(_)
    ));
}

#[tokio::test]
async fn compact_short_options_execute_through_builtin_alias_in_hook() {
    let handler = RequestHandler::new();

    let result = with_hook_execution(
        crate::hook_runtime::HookExecutionContext::command(HookName::AfterShowOptions),
        Vec::new(),
        async {
            handler
                .execute_hook_command(std::process::id(), "server-info")
                .await
        },
    )
    .await;

    assert!(
        result.is_ok(),
        "builtin compact alias should execute: {result:?}"
    );
}

#[tokio::test]
async fn wait_for_signal_wakes_current_waiters_and_latches_one_future_wait() {
    let handler = Arc::new(RequestHandler::new());
    let first_waiter = {
        let handler = Arc::clone(&handler);
        tokio::spawn(async move { handler.handle(wait_for("signal", WaitForMode::Wait)).await })
    };
    let second_waiter = {
        let handler = Arc::clone(&handler);
        tokio::spawn(async move { handler.handle(wait_for("signal", WaitForMode::Wait)).await })
    };
    yield_until_counts(&handler, "signal", (2, 0, false)).await;

    assert_eq!(
        handler
            .handle(wait_for("signal", WaitForMode::Signal))
            .await,
        Response::WaitFor(WaitForResponse)
    );
    assert_eq!(
        first_waiter.await.expect("first waiter task"),
        Response::WaitFor(WaitForResponse)
    );
    assert_eq!(
        second_waiter.await.expect("second waiter task"),
        Response::WaitFor(WaitForResponse)
    );
    yield_until_counts(&handler, "signal", (0, 0, false)).await;

    assert_eq!(
        handler
            .handle(wait_for("future", WaitForMode::Signal))
            .await,
        Response::WaitFor(WaitForResponse)
    );
    yield_until_counts(&handler, "future", (0, 0, true)).await;

    let future_waiter = {
        let handler = Arc::clone(&handler);
        tokio::spawn(async move { handler.handle(wait_for("future", WaitForMode::Wait)).await })
    };
    assert_eq!(
        future_waiter.await.expect("future waiter task"),
        Response::WaitFor(WaitForResponse)
    );
    yield_until_counts(&handler, "future", (0, 0, false)).await;

    let second_future_waiter = {
        let handler = Arc::clone(&handler);
        tokio::spawn(async move { handler.handle(wait_for("future", WaitForMode::Wait)).await })
    };
    yield_until_counts(&handler, "future", (1, 0, false)).await;
    assert!(!second_future_waiter.is_finished());
    second_future_waiter.abort();
    assert!(second_future_waiter
        .await
        .expect_err("waiter is cancelled")
        .is_cancelled());
    yield_until_counts(&handler, "future", (0, 0, false)).await;
}

#[tokio::test]
async fn wait_for_unlock_hands_locks_to_queued_waiters_in_fifo_order() {
    let handler = Arc::new(RequestHandler::new());

    assert_eq!(
        handler.handle(wait_for("lock", WaitForMode::Lock)).await,
        Response::WaitFor(WaitForResponse)
    );
    yield_until_counts(&handler, "lock", (0, 0, true)).await;

    let first = spawn_wait_for(&handler, "lock", WaitForMode::Lock);
    yield_until_counts(&handler, "lock", (0, 1, true)).await;
    let second = spawn_wait_for(&handler, "lock", WaitForMode::Lock);
    yield_until_counts(&handler, "lock", (0, 2, true)).await;

    assert_eq!(
        handler.handle(wait_for("lock", WaitForMode::Unlock)).await,
        Response::WaitFor(WaitForResponse)
    );
    assert_eq!(
        first.await.expect("first lock"),
        Response::WaitFor(WaitForResponse)
    );
    yield_until_counts(&handler, "lock", (0, 1, true)).await;
    assert!(!second.is_finished());

    assert_eq!(
        handler.handle(wait_for("lock", WaitForMode::Unlock)).await,
        Response::WaitFor(WaitForResponse)
    );
    assert_eq!(
        second.await.expect("second lock"),
        Response::WaitFor(WaitForResponse)
    );
    yield_until_counts(&handler, "lock", (0, 0, true)).await;

    assert_eq!(
        handler.handle(wait_for("lock", WaitForMode::Unlock)).await,
        Response::WaitFor(WaitForResponse)
    );
    yield_until_counts(&handler, "lock", (0, 0, false)).await;
}

#[tokio::test]
async fn wait_for_unlock_on_unlocked_channel_returns_error() {
    let handler = RequestHandler::new();

    let response = handler
        .handle(wait_for("missing", WaitForMode::Unlock))
        .await;

    assert!(matches!(response, Response::Error(_)));
}

#[tokio::test]
async fn wait_for_cancellation_removes_plain_and_lock_waiters() {
    let handler = Arc::new(RequestHandler::new());

    let plain = spawn_wait_for(&handler, "cancel-plain", WaitForMode::Wait);
    yield_until_counts(&handler, "cancel-plain", (1, 0, false)).await;
    plain.abort();
    assert!(plain
        .await
        .expect_err("plain waiter is cancelled")
        .is_cancelled());
    yield_until_counts(&handler, "cancel-plain", (0, 0, false)).await;

    assert_eq!(
        handler
            .handle(wait_for("cancel-lock", WaitForMode::Lock))
            .await,
        Response::WaitFor(WaitForResponse)
    );
    let lock = spawn_wait_for(&handler, "cancel-lock", WaitForMode::Lock);
    yield_until_counts(&handler, "cancel-lock", (0, 1, true)).await;
    lock.abort();
    assert!(lock
        .await
        .expect_err("lock waiter is cancelled")
        .is_cancelled());
    yield_until_counts(&handler, "cancel-lock", (0, 0, true)).await;
}

#[tokio::test]
async fn wait_for_shutdown_releases_plain_and_lock_waiters() {
    let handler = Arc::new(RequestHandler::new());

    assert_eq!(
        handler
            .handle(wait_for("shutdown-lock", WaitForMode::Lock))
            .await,
        Response::WaitFor(WaitForResponse)
    );
    let plain = spawn_wait_for(&handler, "shutdown-plain", WaitForMode::Wait);
    yield_until_counts(&handler, "shutdown-plain", (1, 0, false)).await;
    let lock = spawn_wait_for(&handler, "shutdown-lock", WaitForMode::Lock);
    yield_until_counts(&handler, "shutdown-lock", (0, 1, true)).await;

    handler.shutdown_wait_for_for_test();

    assert!(matches!(
        plain.await.expect("plain waiter"),
        Response::Error(_)
    ));
    assert!(matches!(
        lock.await.expect("lock waiter"),
        Response::Error(_)
    ));
    yield_until_counts(&handler, "shutdown-plain", (0, 0, false)).await;
    yield_until_counts(&handler, "shutdown-lock", (0, 0, false)).await;
}

fn spawn_wait_for(
    handler: &Arc<RequestHandler>,
    channel: &'static str,
    mode: WaitForMode,
) -> tokio::task::JoinHandle<Response> {
    let handler = Arc::clone(handler);
    tokio::spawn(async move { handler.handle(wait_for(channel, mode)).await })
}

async fn yield_until_counts(
    handler: &RequestHandler,
    channel: &str,
    expected: (usize, usize, bool),
) {
    for _ in 0..100 {
        if handler.wait_for_counts(channel) == expected {
            return;
        }
        tokio::task::yield_now().await;
    }

    assert_eq!(handler.wait_for_counts(channel), expected);
}