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

use std::time::Duration;

use rmux_proto::{LinkWindowRequest, UnlinkWindowRequest};

use crate::handler::scripting_support::install_queue_exact_target_capture_pause;

fn terminal_size() -> TerminalSize {
    TerminalSize { cols: 80, rows: 24 }
}

async fn create_session(handler: &RequestHandler, name: &str) -> SessionName {
    let name = session_name(name);
    let response = handler
        .handle(Request::NewSession(NewSessionRequest {
            session_name: name.clone(),
            detached: true,
            size: Some(terminal_size()),
            environment: None,
        }))
        .await;
    assert!(matches!(response, Response::NewSession(_)), "{response:?}");
    name
}

fn pane_context(session_name: &SessionName, window_index: u32) -> QueueExecutionContext {
    QueueExecutionContext::without_caller_cwd().with_current_target(Some(Target::Pane(
        PaneTarget::with_window(session_name.clone(), window_index, 0),
    )))
}

async fn replace_window_slot(
    handler: &RequestHandler,
    source: &SessionName,
    target: &SessionName,
) -> rmux_core::WindowId {
    let response = handler
        .handle(Request::LinkWindow(LinkWindowRequest {
            source: WindowTarget::with_window(source.clone(), 0),
            target: WindowTarget::with_window(target.clone(), 0),
            after: false,
            before: false,
            kill_destination: true,
            detached: true,
        }))
        .await;
    assert!(matches!(response, Response::LinkWindow(_)), "{response:?}");
    handler
        .state
        .lock()
        .await
        .sessions
        .session(target)
        .and_then(|session| session.window_at(0))
        .map(rmux_core::Window::id)
        .expect("replacement window survives")
}

async fn wait_for_pause(pause: &crate::handler::scripting_support::QueueExactTargetCapturePause) {
    tokio::time::timeout(Duration::from_secs(2), pause.reached.notified())
        .await
        .expect("queued command reaches exact-target capture pause");
}

#[tokio::test]
async fn exact_window_and_pane_targets_reject_post_parse_slot_replacement() {
    for command_name in ["rename-window", "kill-pane"] {
        let handler = RequestHandler::new();
        let source = create_session(&handler, &format!("exact-{command_name}-source")).await;
        let target = create_session(&handler, &format!("exact-{command_name}-target")).await;
        let (selector, original_window_id) = {
            let state = handler.state.lock().await;
            let window = state
                .sessions
                .session(&target)
                .and_then(|session| session.window_at(0))
                .expect("target window exists");
            let selector = if command_name == "rename-window" {
                window.id().to_string()
            } else {
                window.pane(0).expect("target pane exists").id().to_string()
            };
            (selector, window.id())
        };
        let command = if command_name == "rename-window" {
            format!("rename-window -t {selector} stale-name")
        } else {
            format!("kill-pane -t {selector}")
        };
        let parsed = CommandParser::new()
            .parse(&command)
            .expect("command parses");
        let pause = install_queue_exact_target_capture_pause(&handler, command_name);
        let queued_handler = handler.clone();
        let queued_target = target.clone();
        let queued = tokio::spawn(async move {
            queued_handler
                .execute_parsed_commands(
                    std::process::id(),
                    parsed,
                    pane_context(&queued_target, 0),
                )
                .await
        });

        wait_for_pause(&pause).await;
        let replacement_id = replace_window_slot(&handler, &source, &target).await;
        assert_ne!(replacement_id, original_window_id);
        pause.release.notify_one();

        let error = tokio::time::timeout(Duration::from_secs(2), queued)
            .await
            .expect("queued command finishes")
            .expect("queued task joins")
            .expect_err("replacement must invalidate the captured target");
        assert!(
            error.to_string().contains("target identity changed"),
            "{error}"
        );
        let state = handler.state.lock().await;
        let replacement = state
            .sessions
            .session(&target)
            .and_then(|session| session.window_at(0))
            .expect("replacement survives stale command");
        assert_eq!(replacement.id(), replacement_id);
        assert_ne!(replacement.name(), Some("stale-name"));
    }
}

#[tokio::test]
async fn exact_pane_target_rejects_respawned_output_generation() {
    let handler = RequestHandler::new();
    let target_session = create_session(&handler, "exact-pane-respawn").await;
    let target = PaneTarget::with_window(target_session.clone(), 0, 0);
    let (pane_id, initial_generation) = {
        let state = handler.state.lock().await;
        let pane_id = state
            .sessions
            .session(&target_session)
            .and_then(|session| session.window_at(0))
            .and_then(|window| window.pane(0))
            .map(rmux_core::Pane::id)
            .expect("target pane exists");
        (
            pane_id,
            state.pane_output_generation_for_target(&target, pane_id),
        )
    };
    let parsed = CommandParser::new()
        .parse(&format!("kill-pane -t {pane_id}"))
        .expect("command parses");
    let pause = install_queue_exact_target_capture_pause(&handler, "kill-pane");
    let queued_handler = handler.clone();
    let queued_session = target_session.clone();
    let queued = tokio::spawn(async move {
        queued_handler
            .execute_parsed_commands(std::process::id(), parsed, pane_context(&queued_session, 0))
            .await
    });

    wait_for_pause(&pause).await;
    let respawned = handler
        .handle(Request::RespawnPane(Box::new(RespawnPaneRequest {
            target: target.clone(),
            kill: true,
            start_directory: None,
            environment: None,
            command: Some(vec![crate::test_shell::stdin_discard_command()]),
            process_command: None,
        })))
        .await;
    assert!(
        matches!(respawned, Response::RespawnPane(_)),
        "{respawned:?}"
    );
    let replacement_generation = {
        let state = handler.state.lock().await;
        assert_eq!(
            state
                .sessions
                .session(&target_session)
                .and_then(|session| session.window_at(0))
                .and_then(|window| window.pane(0))
                .map(rmux_core::Pane::id),
            Some(pane_id),
            "respawn must preserve PaneId for this regression"
        );
        state.pane_output_generation_for_target(&target, pane_id)
    };
    assert_ne!(replacement_generation, initial_generation);
    pause.release.notify_one();

    let error = tokio::time::timeout(Duration::from_secs(2), queued)
        .await
        .expect("queued command finishes")
        .expect("queued task joins")
        .expect_err("the stale kill must not reach the respawned process");
    assert!(
        error.to_string().contains("target identity changed"),
        "{error}"
    );
    let state = handler.state.lock().await;
    assert_eq!(
        state
            .sessions
            .session(&target_session)
            .and_then(|session| session.window_at(0))
            .and_then(|window| window.pane(0))
            .map(rmux_core::Pane::id),
        Some(pane_id),
        "the respawned pane must survive the stale command"
    );
}

#[tokio::test]
async fn capture_initializes_only_the_addressed_lazy_occurrence() {
    let handler = RequestHandler::new();
    let target = session_name("exact-target-lazy-occurrence");
    let selector = {
        let mut state = handler.state.lock().await;
        state
            .sessions
            .create_session(target.clone(), terminal_size())
            .expect("create direct session");
        assert_eq!(state.window_link_occurrence_id(&target, 0), None);
        state
            .sessions
            .session(&target)
            .and_then(|session| session.window_at(0))
            .map(rmux_core::Window::id)
            .expect("target window exists")
            .to_string()
    };
    let parsed = CommandParser::new()
        .parse(&format!("rename-window -t {selector} guarded"))
        .expect("command parses");
    let pause = install_queue_exact_target_capture_pause(&handler, "rename-window");
    let queued_handler = handler.clone();
    let queued_target = target.clone();
    let queued = tokio::spawn(async move {
        queued_handler
            .execute_parsed_commands(std::process::id(), parsed, pane_context(&queued_target, 0))
            .await
    });

    wait_for_pause(&pause).await;
    {
        let mut state = handler.state.lock().await;
        assert!(
            state.window_link_occurrence_id(&target, 0).is_some(),
            "capture must initialize the addressed occurrence"
        );
        state.ensure_live_window_link_occurrences();
    }
    pause.release.notify_one();
    tokio::time::timeout(Duration::from_secs(2), queued)
        .await
        .expect("queued command finishes")
        .expect("queued task joins")
        .expect("later lazy initialization must not create a false stale target");

    let state = handler.state.lock().await;
    assert_eq!(
        state
            .sessions
            .session(&target)
            .and_then(|session| session.window_at(0))
            .and_then(rmux_core::Window::name),
        Some("guarded")
    );
}

#[tokio::test]
async fn unlink_relink_of_the_same_window_id_is_still_rejected() {
    let handler = RequestHandler::new();
    let owner = create_session(&handler, "exact-target-owner").await;
    let alias = create_session(&handler, "exact-target-alias").await;
    let linked = handler
        .handle(Request::LinkWindow(LinkWindowRequest {
            source: WindowTarget::with_window(owner.clone(), 0),
            target: WindowTarget::with_window(alias.clone(), 1),
            after: false,
            before: false,
            kill_destination: false,
            detached: true,
        }))
        .await;
    assert!(matches!(linked, Response::LinkWindow(_)), "{linked:?}");
    let window_id = handler
        .state
        .lock()
        .await
        .sessions
        .session(&owner)
        .and_then(|session| session.window_at(0))
        .map(rmux_core::Window::id)
        .expect("owner window exists");
    let parsed = CommandParser::new()
        .parse(&format!("rename-window -t {window_id} stale-relink"))
        .expect("command parses");
    let pause = install_queue_exact_target_capture_pause(&handler, "rename-window");
    let queued_handler = handler.clone();
    let queued_alias = alias.clone();
    let queued = tokio::spawn(async move {
        queued_handler
            .execute_parsed_commands(std::process::id(), parsed, pane_context(&queued_alias, 1))
            .await
    });

    wait_for_pause(&pause).await;
    let unlinked = handler
        .handle(Request::UnlinkWindow(UnlinkWindowRequest {
            target: WindowTarget::with_window(alias.clone(), 1),
            kill_if_last: false,
        }))
        .await;
    assert!(
        matches!(unlinked, Response::UnlinkWindow(_)),
        "{unlinked:?}"
    );
    let relinked = handler
        .handle(Request::LinkWindow(LinkWindowRequest {
            source: WindowTarget::with_window(owner.clone(), 0),
            target: WindowTarget::with_window(alias.clone(), 1),
            after: false,
            before: false,
            kill_destination: false,
            detached: true,
        }))
        .await;
    assert!(matches!(relinked, Response::LinkWindow(_)), "{relinked:?}");
    pause.release.notify_one();

    let error = tokio::time::timeout(Duration::from_secs(2), queued)
        .await
        .expect("queued command finishes")
        .expect("queued task joins")
        .expect_err("a new link occurrence must invalidate the captured command");
    assert!(
        error.to_string().contains("target identity changed"),
        "{error}"
    );
    let state = handler.state.lock().await;
    let relinked_window = state
        .sessions
        .session(&alias)
        .and_then(|session| session.window_at(1))
        .expect("relinked window survives");
    assert_eq!(relinked_window.id(), window_id);
    assert_ne!(relinked_window.name(), Some("stale-relink"));
}

#[tokio::test]
async fn control_queue_uses_the_same_exact_target_guard() {
    let handler = RequestHandler::new();
    let source = create_session(&handler, "exact-control-source").await;
    let target = create_session(&handler, "exact-control-target").await;
    let selector = handler
        .state
        .lock()
        .await
        .sessions
        .session(&target)
        .and_then(|session| session.window_at(0))
        .map(rmux_core::Window::id)
        .expect("target window exists")
        .to_string();
    let requester_pid = 82_991;
    let (_control_id, _events) =
        register_control_for_session(&handler, requester_pid, target.clone()).await;
    let parsed = CommandParser::new()
        .parse(&format!("rename-window -t {selector} stale-control"))
        .expect("command parses");
    let pause = install_queue_exact_target_capture_pause(&handler, "rename-window");
    let queued_handler = handler.clone();
    let queued = tokio::spawn(async move {
        queued_handler
            .execute_control_commands(requester_pid, parsed)
            .await
    });

    wait_for_pause(&pause).await;
    let replacement_id = replace_window_slot(&handler, &source, &target).await;
    pause.release.notify_one();
    let result = tokio::time::timeout(Duration::from_secs(2), queued)
        .await
        .expect("control command finishes")
        .expect("control task joins");
    let error = result.error.expect("control mutation must fail closed");
    assert!(
        error.to_string().contains("target identity changed"),
        "{error}"
    );
    assert_eq!(
        handler
            .state
            .lock()
            .await
            .sessions
            .session(&target)
            .and_then(|session| session.window_at(0))
            .map(rmux_core::Window::id),
        Some(replacement_id)
    );
}

#[tokio::test]
async fn source_file_queue_uses_the_same_exact_target_guard() {
    let handler = RequestHandler::new();
    let source = create_session(&handler, "exact-source-file-source").await;
    let target = create_session(&handler, "exact-source-file-target").await;
    let selector = handler
        .state
        .lock()
        .await
        .sessions
        .session(&target)
        .and_then(|session| session.window_at(0))
        .map(rmux_core::Window::id)
        .expect("target window exists")
        .to_string();
    let root = temp_root("exact-target-guard");
    let config = root.join("guard.conf");
    write_config(
        &config,
        &format!("rename-window -t {selector} stale-source-file\n"),
    );
    let parsed = CommandParser::new()
        .parse(&format!("source-file {}", shell_quote(&config)))
        .expect("source-file command parses");
    let pause = install_queue_exact_target_capture_pause(&handler, "rename-window");
    let queued_handler = handler.clone();
    let queued_target = target.clone();
    let queued = tokio::spawn(async move {
        queued_handler
            .execute_parsed_commands(std::process::id(), parsed, pane_context(&queued_target, 0))
            .await
    });

    wait_for_pause(&pause).await;
    let replacement_id = replace_window_slot(&handler, &source, &target).await;
    pause.release.notify_one();
    let error = tokio::time::timeout(Duration::from_secs(2), queued)
        .await
        .expect("source-file command finishes")
        .expect("source-file task joins")
        .expect_err("sourced mutation must fail closed");
    assert!(
        error.to_string().contains("target identity changed"),
        "{error}"
    );
    let state = handler.state.lock().await;
    let replacement = state
        .sessions
        .session(&target)
        .and_then(|session| session.window_at(0))
        .expect("replacement survives sourced race");
    assert_eq!(replacement.id(), replacement_id);
    assert_ne!(replacement.name(), Some("stale-source-file"));
    drop(state);
    let _ = std::fs::remove_dir_all(root);
}

#[tokio::test]
async fn hook_command_path_uses_the_same_exact_target_guard() {
    let handler = RequestHandler::new();
    let source = create_session(&handler, "exact-hook-source").await;
    let target = create_session(&handler, "exact-hook-target").await;
    let selector = handler
        .state
        .lock()
        .await
        .sessions
        .session(&target)
        .and_then(|session| session.window_at(0))
        .map(rmux_core::Window::id)
        .expect("target window exists")
        .to_string();
    let pause = install_queue_exact_target_capture_pause(&handler, "rename-window");
    let queued_handler = handler.clone();
    let command = format!("rename-window -t {selector} stale-hook");
    let current_target = Some(Target::Pane(PaneTarget::with_window(source.clone(), 0, 0)));
    let queued = tokio::spawn(async move {
        queued_handler
            .execute_hook_command_with_context(std::process::id(), &command, current_target)
            .await
    });

    wait_for_pause(&pause).await;
    let replacement_id = replace_window_slot(&handler, &source, &target).await;
    pause.release.notify_one();
    tokio::time::timeout(Duration::from_secs(2), queued)
        .await
        .expect("hook command finishes")
        .expect("hook task joins")
        .expect_err("hook mutation must fail closed");

    let state = handler.state.lock().await;
    let replacement = state
        .sessions
        .session(&target)
        .and_then(|session| session.window_at(0))
        .expect("replacement survives hook race");
    assert_eq!(replacement.id(), replacement_id);
    assert_ne!(replacement.name(), Some("stale-hook"));
}