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

use crate::handler::prompt_support::PromptInputEvent;
use rmux_core::command_parser::CommandParser;
use rmux_proto::{
    PaneResizeRequest, ResizePaneAdjustment, ResizePaneRequest, SplitWindowExtRequest,
};

struct LinkedMutationFixture {
    owner: SessionName,
    grouped_peer: SessionName,
    linked_peer: SessionName,
    pane_one_id: rmux_proto::PaneId,
}

impl LinkedMutationFixture {
    fn targets(&self) -> [WindowTarget; 3] {
        [
            WindowTarget::with_window(self.owner.clone(), 0),
            WindowTarget::with_window(self.grouped_peer.clone(), 0),
            WindowTarget::with_window(self.linked_peer.clone(), 1),
        ]
    }
}

async fn linked_mutation_fixture(handler: &RequestHandler, label: &str) -> LinkedMutationFixture {
    let status = handler
        .handle(Request::SetOption(SetOptionRequest {
            scope: ScopeSelector::Global,
            option: OptionName::Status,
            value: "off".to_owned(),
            mode: SetOptionMode::Replace,
        }))
        .await;
    assert!(matches!(status, Response::SetOption(_)), "{status:?}");

    let owner = session_name(&format!("{label}-owner"));
    let grouped_peer = session_name(&format!("{label}-grouped"));
    let linked_peer = session_name(&format!("{label}-linked"));
    create_session(handler, owner.as_str()).await;
    create_grouped_session(handler, grouped_peer.as_str(), &owner).await;
    let split = handler
        .handle(Request::SplitWindow(SplitWindowRequest {
            target: SplitWindowTarget::Session(owner.clone()),
            direction: SplitDirection::Vertical,
            before: false,
            environment: None,
        }))
        .await;
    assert!(matches!(split, Response::SplitWindow(_)), "{split:?}");

    create_session(handler, linked_peer.as_str()).await;
    let linked = handler
        .handle(Request::LinkWindow(LinkWindowRequest {
            source: WindowTarget::with_window(owner.clone(), 0),
            target: WindowTarget::with_window(linked_peer.clone(), 1),
            after: false,
            before: false,
            kill_destination: false,
            detached: true,
        }))
        .await;
    assert!(matches!(linked, Response::LinkWindow(_)), "{linked:?}");
    handler.wait_for_initial_panes_for_test().await;

    let fixture = {
        let mut state = handler.state.lock().await;
        for target in [
            WindowTarget::with_window(owner.clone(), 0),
            WindowTarget::with_window(grouped_peer.clone(), 0),
            WindowTarget::with_window(linked_peer.clone(), 1),
        ] {
            state
                .sessions
                .session_mut(target.session_name())
                .expect("fixture session exists")
                .select_pane_in_window(target.window_index(), 0)
                .expect("fixture pane zero selection succeeds");
        }
        let window = state
            .sessions
            .session(&owner)
            .and_then(|session| session.window_at(0))
            .expect("fixture owner window exists");
        LinkedMutationFixture {
            owner,
            grouped_peer,
            linked_peer,
            pane_one_id: window.pane(1).expect("pane one exists").id(),
        }
    };
    assert_alias_windows_identical(handler, &fixture).await;
    fixture
}

async fn assert_alias_windows_identical(handler: &RequestHandler, fixture: &LinkedMutationFixture) {
    let state = handler.state.lock().await;
    let expected = state
        .sessions
        .session(&fixture.owner)
        .and_then(|session| session.window_at(0))
        .expect("owner window exists")
        .clone();
    for target in fixture.targets() {
        assert_eq!(
            state
                .sessions
                .session(target.session_name())
                .and_then(|session| session.window_at(target.window_index()))
                .expect("window alias exists"),
            &expected,
            "window model diverged for {target}"
        );
    }
}

async fn assert_alias_zoom(
    handler: &RequestHandler,
    fixture: &LinkedMutationFixture,
    zoomed: bool,
    active_pane: u32,
) {
    assert_alias_windows_identical(handler, fixture).await;
    let state = handler.state.lock().await;
    for target in fixture.targets() {
        let window = state
            .sessions
            .session(target.session_name())
            .and_then(|session| session.window_at(target.window_index()))
            .expect("window alias exists");
        assert_eq!(window.is_zoomed(), zoomed, "zoom diverged for {target}");
        assert_eq!(
            window.active_pane_index(),
            active_pane,
            "active pane diverged for {target}"
        );
    }
}

async fn pane_terminal_size(
    handler: &RequestHandler,
    session_name: &SessionName,
    window_index: u32,
    pane_index: u32,
) -> TerminalSize {
    let master = handler
        .state
        .lock()
        .await
        .clone_pane_master_if_alive(session_name, window_index, pane_index)
        .expect("pane terminal remains alive");
    let size = master.size().expect("pane terminal exposes its size");
    TerminalSize {
        cols: size.cols,
        rows: size.rows,
    }
}

async fn assert_active_runtime_and_lifecycle_match(
    handler: &RequestHandler,
    fixture: &LinkedMutationFixture,
) {
    let (active_pane, expected_size, lifecycle_size) = {
        let state = handler.state.lock().await;
        let window = state
            .sessions
            .session(&fixture.owner)
            .and_then(|session| session.window_at(0))
            .expect("owner window exists");
        let active_pane = window.active_pane_index();
        let pane = window.pane(active_pane).expect("active pane exists");
        (
            active_pane,
            TerminalSize {
                cols: pane.geometry().cols(),
                rows: pane.geometry().rows(),
            },
            state
                .pane_lifecycle(pane.id())
                .expect("active pane lifecycle exists")
                .dimensions(),
        )
    };
    assert_eq!(lifecycle_size, expected_size);
    assert_eq!(
        pane_terminal_size(handler, &fixture.owner, 0, active_pane).await,
        expected_size,
        "shared PTY size must commit with the linked window model"
    );
}

#[tokio::test]
async fn cli_and_sdk_zoom_commit_linked_model_runtime_and_lifecycle_together() {
    let handler = RequestHandler::new();
    let fixture = linked_mutation_fixture(&handler, "linked-zoom").await;
    let resize_count_before = handler
        .state
        .lock()
        .await
        .window_runtime_resize_count_for_test();

    let zoomed = handler
        .handle(Request::ResizePane(ResizePaneRequest {
            target: PaneTarget::with_window(fixture.linked_peer.clone(), 1, 1),
            adjustment: ResizePaneAdjustment::Zoom,
        }))
        .await;
    assert!(matches!(zoomed, Response::ResizePane(_)), "{zoomed:?}");
    assert_alias_zoom(&handler, &fixture, true, 1).await;
    assert_active_runtime_and_lifecycle_match(&handler, &fixture).await;

    let unzoomed = handler
        .handle(Request::PaneResize(PaneResizeRequest {
            target: PaneTargetRef::by_id(fixture.owner.clone(), fixture.pane_one_id),
            adjustment: ResizePaneAdjustment::Zoom,
        }))
        .await;
    assert!(matches!(unzoomed, Response::ResizePane(_)), "{unzoomed:?}");
    assert_alias_zoom(&handler, &fixture, false, 1).await;
    assert_active_runtime_and_lifecycle_match(&handler, &fixture).await;

    assert_eq!(
        handler
            .state
            .lock()
            .await
            .window_runtime_resize_count_for_test(),
        resize_count_before + 2,
        "CLI and stable-id SDK zooms must each resize the shared window runtime once"
    );
}

#[tokio::test]
async fn pane_selection_resize_failure_rolls_back_every_alias_and_the_shared_runtime() {
    let handler = RequestHandler::new();
    let fixture = linked_mutation_fixture(&handler, "linked-select-rollback").await;
    let terminal_size_before = pane_terminal_size(&handler, &fixture.owner, 0, 0).await;
    let resize_count_before = {
        let mut state = handler.state.lock().await;
        let count = state.window_runtime_resize_count_for_test();
        state.fail_next_resize_for_test();
        count
    };

    let response = handler
        .handle(Request::SelectPane(Box::new(SelectPaneRequest {
            target: PaneTarget::with_window(fixture.owner.clone(), 0, 1),
            title: None,
            style: None,
            input_disabled: None,
            preserve_zoom: false,
        })))
        .await;
    assert_eq!(
        response,
        Response::Error(rmux_proto::ErrorResponse {
            error: rmux_proto::RmuxError::Server(
                "injected pane terminal resize failure".to_owned(),
            ),
        })
    );
    assert_alias_zoom(&handler, &fixture, false, 0).await;
    assert_eq!(
        pane_terminal_size(&handler, &fixture.owner, 0, 0).await,
        terminal_size_before
    );
    assert_eq!(
        handler
            .state
            .lock()
            .await
            .window_runtime_resize_count_for_test(),
        resize_count_before + 2,
        "failed commit and runtime rollback must each issue one bounded resize"
    );
}

#[tokio::test]
async fn split_window_zoom_commits_the_new_zoomed_window_to_every_alias() {
    let handler = RequestHandler::new();
    let fixture = linked_mutation_fixture(&handler, "linked-split-zoom").await;

    let response = handler
        .handle(Request::SplitWindowExt(Box::new(SplitWindowExtRequest {
            target: SplitWindowTarget::Pane(PaneTarget::with_window(
                fixture.linked_peer.clone(),
                1,
                1,
            )),
            direction: SplitDirection::Vertical,
            before: false,
            environment: None,
            command: Some(quiet_window_test_command()),
            process_command: None,
            start_directory: None,
            keep_alive_on_exit: None,
            detached: false,
            size: None,
            preserve_zoom: true,
            full_size: false,
            stdin_payload: None,
        })))
        .await;
    let Response::SplitWindow(response) = response else {
        panic!("linked split-window -Z failed: {response:?}");
    };
    handler.wait_for_initial_panes_for_test().await;
    assert_alias_windows_identical(&handler, &fixture).await;
    let state = handler.state.lock().await;
    for target in fixture.targets() {
        let window = state
            .sessions
            .session(target.session_name())
            .and_then(|session| session.window_at(target.window_index()))
            .expect("window alias exists");
        assert!(window.is_zoomed(), "split zoom diverged for {target}");
        assert_eq!(window.active_pane_index(), response.pane.pane_index());
    }
    drop(state);
    let master = handler
        .state
        .lock()
        .await
        .clone_pane_master_if_alive(&fixture.owner, 0, response.pane.pane_index())
        .expect("new split pane terminal remains alive");
    let size = master.size().expect("new split pane exposes its size");
    assert_eq!(
        TerminalSize {
            cols: size.cols,
            rows: size.rows
        },
        TerminalSize {
            cols: 120,
            rows: 40
        }
    );
}

#[tokio::test]
async fn mode_tree_zoom_and_dismissal_commit_every_linked_alias() {
    let handler = RequestHandler::new();
    let fixture = linked_mutation_fixture(&handler, "linked-mode-tree-zoom").await;
    let attach_pid = std::process::id().saturating_add(9_141);
    let (control_tx, _control_rx) = mpsc::unbounded_channel();
    handler
        .register_attach(attach_pid, fixture.owner.clone(), control_tx)
        .await;

    let parsed = CommandParser::new()
        .parse_arguments(["choose-tree", "-Zw"])
        .expect("zoomed choose-tree parses");
    let command = RequestHandler::parse_mode_tree_queue_command(parsed.commands()[0].clone())
        .expect("zoomed choose-tree command is valid")
        .expect("choose-tree is recognized");
    handler
        .execute_queued_mode_tree(
            attach_pid,
            command,
            &crate::handler::scripting_support::QueueExecutionContext::without_caller_cwd(),
        )
        .await
        .expect("zoomed choose-tree opens");
    assert_alias_zoom(&handler, &fixture, true, 0).await;
    assert_active_runtime_and_lifecycle_match(&handler, &fixture).await;

    assert!(handler
        .handle_mode_tree_key_event(attach_pid, PromptInputEvent::Char('q'))
        .await
        .expect("q dismisses choose-tree"));
    assert_alias_zoom(&handler, &fixture, false, 0).await;
    assert_active_runtime_and_lifecycle_match(&handler, &fixture).await;
}

#[tokio::test]
async fn non_zoom_window_geometry_mutations_remain_transactional_across_aliases() {
    let handler = RequestHandler::new();
    let fixture = linked_mutation_fixture(&handler, "linked-layout").await;

    let resized = handler
        .handle(Request::ResizePane(ResizePaneRequest {
            target: PaneTarget::with_window(fixture.linked_peer.clone(), 1, 0),
            adjustment: ResizePaneAdjustment::AbsoluteHeight { rows: 12 },
        }))
        .await;
    assert!(matches!(resized, Response::ResizePane(_)), "{resized:?}");
    assert_alias_windows_identical(&handler, &fixture).await;

    let layout = handler
        .handle(Request::NextLayout(rmux_proto::NextLayoutRequest {
            target: WindowTarget::with_window(fixture.grouped_peer.clone(), 0),
        }))
        .await;
    assert!(matches!(layout, Response::NextLayout(_)), "{layout:?}");
    assert_alias_windows_identical(&handler, &fixture).await;

    let rotated = handler
        .handle(Request::RotateWindow(rmux_proto::RotateWindowRequest {
            target: WindowTarget::with_window(fixture.owner.clone(), 0),
            direction: RotateWindowDirection::Down,
            restore_zoom: false,
        }))
        .await;
    assert!(matches!(rotated, Response::RotateWindow(_)), "{rotated:?}");
    assert_alias_windows_identical(&handler, &fixture).await;
    assert_active_runtime_and_lifecycle_match(&handler, &fixture).await;
}