rmux-server 0.6.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
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
use super::*;

#[tokio::test]
async fn parsed_queue_assignments_apply_before_following_commands() {
    let handler = RequestHandler::new();
    let parsed = CommandParser::new()
        .parse("FOO=bar ; run-shell true")
        .expect("commands parse");

    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("queue succeeds");

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

    let state = handler.state.lock().await;
    assert_eq!(state.environment.global_value("FOO"), Some("bar"));
}

#[tokio::test]
async fn parsed_queue_lock_client_defaults_to_current_client() {
    let handler = RequestHandler::new();
    let alpha = SessionName::new("alpha").expect("valid session name");

    let created = handler
        .handle(Request::NewSession(NewSessionRequest {
            session_name: alpha.clone(),
            detached: true,
            size: Some(TerminalSize { cols: 80, rows: 24 }),
            environment: None,
        }))
        .await;
    assert!(matches!(created, Response::NewSession(_)));

    let (control_tx, _control_rx) = tokio::sync::mpsc::unbounded_channel();
    let _attach_id = handler
        .register_attach(std::process::id(), alpha, control_tx)
        .await;

    let parsed = CommandParser::new()
        .parse("lock-client")
        .expect("commands parse");

    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("queue succeeds");

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

#[tokio::test]
async fn if_shell_inserted_hidden_assignments_stay_out_of_process_environments() {
    let handler = RequestHandler::new();
    let parsed = CommandParser::new()
        .parse("if-shell -F 1 { %hidden SECRET=classified } ; run-shell true")
        .expect("commands parse");

    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("queue succeeds");

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

    let state = handler.state.lock().await;
    let entries = state
        .environment
        .show_environment_entries(&ScopeSelector::Global, true, Some("SECRET"))
        .expect("hidden show-environment succeeds");
    assert_eq!(entries.len(), 1);
    assert_eq!(entries[0].value.as_deref(), Some("classified"));
    let mut process_environment =
        std::collections::HashMap::from([("SECRET".to_owned(), "client".to_owned())]);
    state
        .environment
        .apply_to_process_environment(None, &mut process_environment);
    assert_eq!(process_environment.get("SECRET"), None);
}

#[tokio::test]
async fn queue_error_aborts_later_commands_in_the_same_group_only() {
    let handler = RequestHandler::new();
    let parsed = CommandParser::new()
        .parse("show-buffer -b missing ; set-buffer -b skipped no\nset-buffer -b kept yes")
        .expect("commands parse");

    let result = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await;

    assert!(result.is_err());
    assert!(matches!(
        handler
            .handle(Request::ShowBuffer(ShowBufferRequest {
                name: Some("skipped".to_owned()),
            }))
            .await,
        Response::Error(_)
    ));
    assert_eq!(
        handler
            .handle(Request::ShowBuffer(ShowBufferRequest {
                name: Some("kept".to_owned()),
            }))
            .await
            .command_output()
            .expect("kept buffer output")
            .stdout(),
        b"yes"
    );
}

#[tokio::test]
async fn parsed_queue_set_buffer_accepts_target_and_rename_trailing_content() {
    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-buffer -t alpha target-tolerated; \
             set-buffer -b src original; \
             set-buffer -b src -n dst ignored",
        )
        .expect("commands parse");
    let output = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("queue succeeds");
    assert!(output.stdout().is_empty());

    assert_eq!(
        handler
            .handle(Request::ShowBuffer(ShowBufferRequest { name: None }))
            .await
            .command_output()
            .expect("default buffer output")
            .stdout(),
        b"target-tolerated"
    );
    assert_eq!(
        handler
            .handle(Request::ShowBuffer(ShowBufferRequest {
                name: Some("dst".to_owned()),
            }))
            .await
            .command_output()
            .expect("renamed buffer output")
            .stdout(),
        b"original"
    );
}

#[tokio::test]
async fn if_shell_uses_preparsed_brace_command_lists_at_execution_time() {
    let handler = RequestHandler::new();
    let parsed = CommandParser::new()
        .parse("if-shell -F 1 { show-buffer -b missing\nset-buffer -b kept yes }")
        .expect("commands parse");

    let result = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await;

    assert!(result.is_err());
    assert_eq!(
        handler
            .handle(Request::ShowBuffer(ShowBufferRequest {
                name: Some("kept".to_owned()),
            }))
            .await
            .command_output()
            .expect("kept buffer output")
            .stdout(),
        b"yes"
    );
}

#[tokio::test]
async fn if_shell_inserted_brace_errors_do_not_abort_parent_line_tail() {
    let handler = RequestHandler::new();
    let parsed = CommandParser::new()
        .parse("if-shell -F 1 { show-buffer -b missing } ; set-buffer -b kept yes")
        .expect("commands parse");

    let result = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await;

    assert!(result.is_err());
    assert_eq!(
        handler
            .handle(Request::ShowBuffer(ShowBufferRequest {
                name: Some("kept".to_owned()),
            }))
            .await
            .command_output()
            .expect("kept buffer output")
            .stdout(),
        b"yes"
    );
}

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

    let response = handler
        .handle(Request::IfShell(IfShellRequest {
            condition: "1".to_owned(),
            format_mode: true,
            then_command: "show-buffer -b missing\nset-buffer -b skipped no".to_owned(),
            else_command: None,
            target: None,
            caller_cwd: None,
            background: false,
        }))
        .await;

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

#[tokio::test]
async fn parsed_queue_resolves_unresolved_window_targets_before_protocol_dispatch() {
    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(_)
    ));
    assert!(matches!(
        handler
            .handle(Request::NewWindow(NewWindowRequest {
                target: alpha.clone(),
                name: Some("logs".to_owned()),
                detached: true,
                start_directory: None,
                environment: None,
                command: None,
                process_command: None,
                target_window_index: None,
                insert_at_target: false,
            }))
            .await,
        Response::NewWindow(_)
    ));

    let parsed = CommandParser::new()
        .parse("rename-window -t alp:1 renamed")
        .expect("commands parse");

    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("queue command succeeds");

    let state = handler.state.lock().await;
    assert_eq!(
        state
            .sessions
            .session(&alpha)
            .expect("session exists")
            .window_at(1)
            .expect("window exists")
            .name(),
        Some("renamed")
    );
}

#[tokio::test]
async fn parsed_queue_resolves_session_only_new_window_targets_at_protocol_boundary() {
    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("new-window -t alp -d -n logs")
        .expect("commands parse");

    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("queue command succeeds");

    let state = handler.state.lock().await;
    assert_eq!(
        state
            .sessions
            .session(&alpha)
            .expect("session exists")
            .window_at(1)
            .expect("window exists")
            .name(),
        Some("logs")
    );
}

#[tokio::test]
async fn parsed_queue_resolves_session_colon_new_window_targets_at_protocol_boundary() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha-colon");
    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("new-window -t alpha-col: -d -n logs")
        .expect("commands parse");

    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("queue command resolves session: targets through target-find");

    let state = handler.state.lock().await;
    assert_eq!(
        state
            .sessions
            .session(&alpha)
            .expect("session exists")
            .window_at(1)
            .expect("window exists")
            .name(),
        Some("logs")
    );
}

#[tokio::test]
async fn parsed_queue_keeps_signed_new_window_targets_relative() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha-relative");
    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(
            "new-window -d -t alpha-relative:1 -n one ; \
             select-window -t alpha-relative:1 ; \
             new-window -d -t alpha-relative:+1 -n rel",
        )
        .expect("commands parse");

    handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect("relative target should not be treated as absolute index 1");

    let state = handler.state.lock().await;
    let session = state.sessions.session(&alpha).expect("session exists");
    assert_eq!(
        session.window_at(1).and_then(|window| window.name()),
        Some("one")
    );
    assert_eq!(
        session.window_at(2).and_then(|window| window.name()),
        Some("rel")
    );
}

#[tokio::test]
async fn parsed_queue_uses_current_target_for_new_window_split_and_zoom() {
    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 current_target = Target::Pane(PaneTarget::with_window(alpha.clone(), 0, 0));

    for command in ["new-window -d -n logs", "split-window -h", "resize-pane -Z"] {
        let parsed = CommandParser::new().parse(command).expect("command parses");
        handler
            .execute_parsed_commands(
                std::process::id(),
                parsed,
                QueueExecutionContext::without_caller_cwd()
                    .with_current_target(Some(current_target.clone())),
            )
            .await
            .unwrap_or_else(|error| {
                panic!("{command} should succeed with current target: {error}")
            });
    }

    let state = handler.state.lock().await;
    let session = state.sessions.session(&alpha).expect("session exists");
    assert_eq!(
        session.windows().len(),
        2,
        "new-window and split-window should both apply"
    );
    assert!(
        session.window_at(0).expect("window 0 exists").is_zoomed(),
        "resize-pane -Z should zoom the current pane"
    );
    assert_eq!(
        session.window_at(0).expect("window 0 exists").pane_count(),
        2,
        "split-window should split the current window without -t"
    );
}

#[tokio::test]
async fn parsed_queue_reports_missing_target_client_before_input() {
    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(_)
    ));

    for command in [
        "send-keys -c 999999 -t alpha:0.0 echo SHOULD_NOT_TYPE",
        "display-message -c 999999 hello",
    ] {
        let parsed = CommandParser::new()
            .parse(command)
            .expect("command parses at queue layer");
        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());
    }

    let parsed = CommandParser::new()
        .parse("display-message -p -c 999999 hello")
        .expect("command parses at queue layer");
    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_uses_current_target_for_display_panes_without_t() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");
    let requester_pid = 52_u32;
    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 (control_tx, mut control_rx) = tokio::sync::mpsc::unbounded_channel();
    handler
        .register_attach(requester_pid, alpha.clone(), control_tx)
        .await;

    let parsed = CommandParser::new()
        .parse("display-panes")
        .expect("command parses");
    handler
        .execute_parsed_commands(
            requester_pid,
            parsed,
            QueueExecutionContext::without_caller_cwd()
                .with_current_target(Some(Target::Pane(PaneTarget::with_window(alpha, 0, 0)))),
        )
        .await
        .expect("display-panes should use the current target");

    let _overlay = control_rx.recv().await.expect("display-panes overlay");
}

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

    for (command, expected) in [
        ("display-panes -t 999999", "can't find client: 999999"),
        ("display-panes -t alpha", "can't find client: alpha"),
        ("display-panes -t alpha:0", "can't find client: alpha:0"),
        ("display-panes -t alpha:", "can't find client: alpha"),
    ] {
        let parsed = CommandParser::new()
            .parse(command)
            .expect("display-panes command parses");
        let error = handler
            .execute_parsed_commands_for_test(std::process::id(), parsed)
            .await
            .expect_err("missing target-client should fail");

        assert_eq!(error, rmux_proto::RmuxError::Message(expected.to_owned()));
    }
}

#[tokio::test]
async fn parsed_queue_refresh_client_r_is_unknown_flag_like_tmux() {
    let handler = RequestHandler::new();
    let parsed = CommandParser::new()
        .parse("refresh-client -r %0")
        .expect("refresh-client command parses");

    let error = handler
        .execute_parsed_commands_for_test(std::process::id(), parsed)
        .await
        .expect_err("refresh-client -r should be rejected");

    assert_eq!(
        error,
        rmux_proto::RmuxError::Server("command refresh-client: unknown flag -r".to_owned())
    );
}

#[tokio::test]
async fn parsed_queue_uses_current_target_for_kill_pane_without_t() {
    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(_)
    ));
    assert!(matches!(
        handler
            .handle(Request::SplitWindow(SplitWindowRequest {
                target: SplitWindowTarget::Pane(PaneTarget::with_window(alpha.clone(), 0, 0)),
                direction: SplitDirection::Horizontal,
                before: false,
                environment: None,
            }))
            .await,
        Response::SplitWindow(_)
    ));

    let parsed = CommandParser::new()
        .parse("kill-pane")
        .expect("command parses");
    handler
        .execute_parsed_commands(
            std::process::id(),
            parsed,
            QueueExecutionContext::without_caller_cwd().with_current_target(Some(Target::Pane(
                PaneTarget::with_window(alpha.clone(), 0, 1),
            ))),
        )
        .await
        .expect("kill-pane should use the current pane target");

    let state = handler.state.lock().await;
    let session = state.sessions.session(&alpha).expect("session exists");
    assert_eq!(
        session.window_at(0).expect("window exists").pane_count(),
        1,
        "kill-pane without -t should remove the current pane"
    );
}