rmux-server 0.1.1

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

#[tokio::test]
async fn lock_client_with_empty_lock_command_is_noop() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");

    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(_)));

    handler
        .handle(Request::SetOption(SetOptionRequest {
            scope: ScopeSelector::Global,
            option: OptionName::LockCommand,
            value: String::new(),
            mode: SetOptionMode::Replace,
        }))
        .await;

    let (control_tx, mut control_rx) = mpsc::unbounded_channel();
    let _attach_id = handler
        .register_attach(std::process::id(), alpha, control_tx)
        .await;

    let response = handler
        .handle(Request::LockClient(rmux_proto::LockClientRequest {
            target_client: "=".to_owned(),
        }))
        .await;
    assert!(matches!(response, Response::LockClient(_)));

    assert!(
        matches!(control_rx.try_recv(), Err(TryRecvError::Empty)),
        "empty lock-command must not send lock control"
    );
}

#[tokio::test]
async fn lock_client_with_invalid_target_returns_error() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");

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

    let response = handler
        .handle(Request::LockClient(rmux_proto::LockClientRequest {
            target_client: "not-a-number".to_owned(),
        }))
        .await;
    assert!(
        matches!(response, Response::Error(_)),
        "non-numeric lock-client target must fail"
    );

    let response = handler
        .handle(Request::LockClient(rmux_proto::LockClientRequest {
            target_client: "99999".to_owned(),
        }))
        .await;
    assert!(
        matches!(response, Response::Error(_)),
        "lock-client for unattached PID must fail"
    );
}

#[cfg(unix)]
#[tokio::test]
async fn lock_client_accepts_tty_path_targets() {
    let handler = RequestHandler::new();
    let alpha = session_name("alpha");

    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(_)));

    handler
        .handle(Request::SetOption(SetOptionRequest {
            scope: ScopeSelector::Global,
            option: OptionName::LockCommand,
            value: String::new(),
            mode: SetOptionMode::Replace,
        }))
        .await;

    let mut child = spawn_tty_child().expect("spawn tty child");
    let tty_path = rmux_os::process::fd_path(child.id(), 0).expect("tty path");
    let tty_target = tty_path.display().to_string();
    let tty_basename = tty_path
        .strip_prefix("/dev")
        .expect("strip /dev prefix")
        .display()
        .to_string();

    let (control_tx, _control_rx) = mpsc::unbounded_channel();
    let _attach_id = handler.register_attach(child.id(), alpha, control_tx).await;

    let response = handler
        .handle(Request::LockClient(rmux_proto::LockClientRequest {
            target_client: tty_target,
        }))
        .await;
    assert!(
        matches!(response, Response::LockClient(_)),
        "full tty path target should lock the client, got {response:?}"
    );

    let response = handler
        .handle(Request::LockClient(rmux_proto::LockClientRequest {
            target_client: tty_basename,
        }))
        .await;
    assert!(
        matches!(response, Response::LockClient(_)),
        "basename tty target should lock the client, got {response:?}"
    );

    terminate_child(&mut child);
}

#[tokio::test]
async fn server_access_list_returns_server_access_response() {
    let handler = RequestHandler::with_owner_uid(1000);

    let response = handler
        .handle(Request::ServerAccess(rmux_proto::ServerAccessRequest {
            add: false,
            deny: false,
            list: true,
            read_only: false,
            write: false,
            user: None,
        }))
        .await;
    assert!(
        matches!(response, Response::ServerAccess(_)),
        "server-access -l must return ServerAccess response"
    );
}

#[cfg(unix)]
struct TtyChild {
    spawned: rmux_pty::SpawnedPty,
}

#[cfg(unix)]
impl TtyChild {
    fn id(&self) -> u32 {
        self.spawned.child().pid().as_u32()
    }
}

#[cfg(unix)]
fn spawn_tty_child() -> Result<TtyChild, Box<dyn std::error::Error>> {
    let spawned = ChildCommand::new("sh")
        .arg("-c")
        .arg("sleep 60")
        .size(PtyTerminalSize { cols: 80, rows: 24 })
        .spawn()?;

    Ok(TtyChild { spawned })
}

#[cfg(unix)]
fn terminate_child(child: &mut TtyChild) {
    let _ = child.spawned.child().terminate_forcefully();
    let _ = child.spawned.child_mut().wait();
}

#[tokio::test]
async fn detach_client_all_other_detaches_only_non_requester_clients() {
    use rmux_proto::request::DetachClientExtRequest;

    let handler = RequestHandler::new();
    let alpha = session_name("alpha");

    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 (first_tx, mut first_rx) = mpsc::unbounded_channel();
    let (second_tx, mut second_rx) = mpsc::unbounded_channel();
    let _first_attach = handler.register_attach(101, alpha.clone(), first_tx).await;
    let _second_attach = handler.register_attach(202, alpha, second_tx).await;

    let response = handler
        .dispatch(
            101,
            Request::DetachClientExt(DetachClientExtRequest {
                target_client: None,
                all_other_clients: true,
                target_session: None,
                kill_on_detach: false,
                exec_command: None,
            }),
        )
        .await
        .response;
    assert!(matches!(response, Response::DetachClient(_)));

    assert!(
        matches!(first_rx.try_recv(), Err(TryRecvError::Empty)),
        "the requester itself must not be detached"
    );
    assert!(
        matches!(second_rx.try_recv(), Ok(AttachControl::Detach)),
        "the other client must receive a detach control"
    );
}

#[tokio::test]
async fn suspend_client_marks_client_as_suspended() {
    use rmux_proto::request::SuspendClientRequest;

    let handler = RequestHandler::new();
    let alpha = session_name("alpha");

    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, mut control_rx) = mpsc::unbounded_channel();
    let _attach_id = handler
        .register_attach(std::process::id(), alpha, control_tx)
        .await;

    let response = handler
        .dispatch(
            std::process::id(),
            Request::SuspendClient(SuspendClientRequest {
                target_client: None,
            }),
        )
        .await
        .response;
    assert!(matches!(response, Response::SuspendClient(_)));
    assert!(
        matches!(control_rx.try_recv(), Ok(AttachControl::Suspend)),
        "suspend-client must emit Suspend control"
    );

    {
        let active_attach = handler.active_attach.lock().await;
        let active = active_attach
            .by_pid
            .get(&std::process::id())
            .expect("attached client must exist");
        assert!(active.suspended, "client must be marked suspended");
    }
}

#[tokio::test]
async fn client_flags_apply_named_supports_negate_prefix() {
    use super::super::attach_support::ClientFlags;

    let mut flags = ClientFlags::default();
    flags.apply_named("read-only").expect("apply read-only");
    assert!(flags.contains(ClientFlags::READONLY));

    flags.apply_named("!read-only").expect("negate read-only");
    assert!(!flags.contains(ClientFlags::READONLY));

    flags.apply_named("active-pane").expect("apply active-pane");
    flags
        .apply_named("no-detach-on-destroy")
        .expect("apply no-detach-on-destroy");
    assert!(flags.contains(ClientFlags::ACTIVEPANE));
    assert!(flags.contains(ClientFlags::NO_DETACH_ON_DESTROY));

    flags
        .apply_named("!active-pane")
        .expect("negate active-pane");
    assert!(!flags.contains(ClientFlags::ACTIVEPANE));
    assert!(flags.contains(ClientFlags::NO_DETACH_ON_DESTROY));
}

#[tokio::test]
async fn refresh_client_flags_merge_incrementally() {
    use rmux_proto::request::RefreshClientRequest;

    let handler = RequestHandler::new();
    let alpha = session_name("alpha");

    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) = mpsc::unbounded_channel();
    let _attach_id = handler
        .register_attach(std::process::id(), alpha, control_tx)
        .await;

    let response = handler
        .dispatch(
            std::process::id(),
            Request::RefreshClient(RefreshClientRequest {
                target_client: None,
                adjustment: None,
                clear_pan: false,
                pan_left: false,
                pan_right: false,
                pan_up: false,
                pan_down: false,
                status_only: false,
                clipboard_query: false,
                flags: Some("active-pane".to_owned()),
                flags_alias: None,
                subscriptions: vec![],
                subscriptions_format: vec![],
                control_size: None,
                colour_report: None,
            }),
        )
        .await
        .response;
    assert!(matches!(response, Response::RefreshClient(_)));

    {
        let active_attach = handler.active_attach.lock().await;
        let active = active_attach
            .by_pid
            .get(&std::process::id())
            .expect("attached client must exist");
        assert!(
            active
                .flags
                .contains(super::super::attach_support::ClientFlags::ACTIVEPANE),
            "active-pane flag must be set after refresh-client -f"
        );
    }

    let response = handler
        .dispatch(
            std::process::id(),
            Request::RefreshClient(RefreshClientRequest {
                target_client: None,
                adjustment: None,
                clear_pan: false,
                pan_left: false,
                pan_right: false,
                pan_up: false,
                pan_down: false,
                status_only: false,
                clipboard_query: false,
                flags: Some("no-detach-on-destroy".to_owned()),
                flags_alias: None,
                subscriptions: vec![],
                subscriptions_format: vec![],
                control_size: None,
                colour_report: None,
            }),
        )
        .await
        .response;
    assert!(matches!(response, Response::RefreshClient(_)));

    {
        let active_attach = handler.active_attach.lock().await;
        let active = active_attach
            .by_pid
            .get(&std::process::id())
            .expect("attached client must exist");
        assert!(
            active
                .flags
                .contains(super::super::attach_support::ClientFlags::ACTIVEPANE),
            "active-pane flag must still be set after second refresh-client -f"
        );
        assert!(
            active
                .flags
                .contains(super::super::attach_support::ClientFlags::NO_DETACH_ON_DESTROY),
            "no-detach-on-destroy flag must be set after second refresh-client -f"
        );
    }
}