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

async fn link_alias(handler: &RequestHandler, source: WindowTarget, destination: WindowTarget) {
    let response = handler
        .handle(Request::LinkWindow(LinkWindowRequest {
            source,
            target: destination,
            after: false,
            before: false,
            kill_destination: false,
            detached: true,
        }))
        .await;
    assert!(matches!(response, Response::LinkWindow(_)), "{response:?}");
}

fn timer_snapshot(handler: &RequestHandler, target: &WindowTarget) -> (u64, tokio::time::Instant) {
    handler
        .silence_timer_snapshot_for_test(target)
        .expect("silence timer is armed")
}

async fn settled_timer_snapshot(
    handler: &RequestHandler,
    target: &WindowTarget,
) -> (u64, tokio::time::Instant) {
    // Observe the production timer until any in-flight ConPTY startup activity
    // has finished re-arming it. Do not replace the deadline here: doing so
    // would manufacture the baseline that these fanout tests are meant to
    // preserve.
    let settle_deadline = tokio::time::Instant::now() + Duration::from_secs(5);
    let mut previous = timer_snapshot(handler, target);
    let mut stable_since = tokio::time::Instant::now();
    loop {
        tokio::time::sleep(Duration::from_millis(25)).await;
        let current = timer_snapshot(handler, target);
        let now = tokio::time::Instant::now();
        if current == previous {
            if now.duration_since(stable_since) >= Duration::from_millis(500) {
                return current;
            }
        } else {
            previous = current;
            stable_since = now;
        }
        if now >= settle_deadline {
            panic!(
                "silence timer did not settle naturally for {target}; last snapshot: {previous:?}"
            );
        }
    }
}

async fn create_destination_group(
    handler: &RequestHandler,
    owner_name: &str,
    peer_name: &str,
) -> (SessionName, SessionName) {
    let owner = session_name(owner_name);
    let peer = session_name(peer_name);
    create_session(handler, owner.as_str()).await;
    create_grouped_session(handler, peer.as_str(), &owner).await;
    (owner, peer)
}

async fn set_session_monitor_silence(handler: &RequestHandler, session: &SessionName, value: &str) {
    let response = handler
        .handle(Request::SetOption(SetOptionRequest {
            scope: ScopeSelector::Session(session.clone()),
            option: OptionName::MonitorSilence,
            value: value.to_owned(),
            mode: SetOptionMode::Replace,
        }))
        .await;
    assert!(matches!(response, Response::SetOption(_)), "{response:?}");
}

async fn expire_session_window_zero(handler: &RequestHandler, session: &SessionName) {
    let target = WindowTarget::with_window(session.clone(), 0);
    let identity = handler
        .silence_timer_identity_for_test(&target)
        .expect("silence timer is armed before expiry");
    handler
        .expire_silence_timer_for_test(target, identity.0, identity.1, identity.2)
        .await;
}

#[tokio::test]
async fn new_group_peer_arms_fresh_when_matching_source_alias_is_unmonitored() {
    let handler = RequestHandler::new();
    let owner = session_name("new-peer-unmonitored-owner");
    create_session(&handler, owner.as_str()).await;
    handler.wait_for_initial_panes_for_test().await;
    enable_global_monitor_silence(&handler).await;

    let response = handler
        .handle(Request::SetOption(SetOptionRequest {
            scope: ScopeSelector::Session(owner.clone()),
            option: OptionName::MonitorSilence,
            value: "0".to_owned(),
            mode: SetOptionMode::Replace,
        }))
        .await;
    assert!(matches!(response, Response::SetOption(_)), "{response:?}");
    assert_eq!(
        handler.silence_timer_snapshot_for_test(&WindowTarget::with_window(owner.clone(), 0)),
        None
    );

    let peer = session_name("new-peer-unmonitored-peer");
    create_grouped_session(&handler, peer.as_str(), &owner).await;
    assert!(
        handler
            .silence_timer_snapshot_for_test(&WindowTarget::with_window(peer, 0))
            .is_some(),
        "an unmonitored source is not an expired source; the monitored peer arms fresh"
    );
}

async fn assert_new_group_peer_uses_requested_template_silence_state(
    label: &str,
    template_is_expired: bool,
) {
    let handler = RequestHandler::new();
    let first = session_name(&format!("a-{label}"));
    let template = session_name(&format!("b-{label}"));
    let created = session_name(&format!("c-{label}"));
    create_session(&handler, first.as_str()).await;
    create_grouped_session(&handler, template.as_str(), &first).await;
    handler.wait_for_initial_panes_for_test().await;
    enable_global_monitor_silence(&handler).await;

    if template_is_expired {
        set_session_monitor_silence(&handler, &first, "0").await;
        expire_session_window_zero(&handler, &template).await;
    } else {
        expire_session_window_zero(&handler, &first).await;
        set_session_monitor_silence(&handler, &template, "0").await;
    }

    create_grouped_session(&handler, created.as_str(), &template).await;
    let created_target = WindowTarget::with_window(created.clone(), 0);
    assert_eq!(
        handler
            .silence_timer_snapshot_for_test(&created_target)
            .is_some(),
        !template_is_expired,
        "the new peer must inherit the requested template's monitored state"
    );
    let state = handler.state.lock().await;
    assert_eq!(
        state
            .sessions
            .session(&created)
            .expect("new grouped peer exists")
            .winlink_alert_flags(0)
            .contains(rmux_core::WINLINK_SILENCE),
        template_is_expired,
        "the cloned flag and inherited timer state must describe the same template"
    );
}

#[tokio::test]
async fn new_group_peer_prefers_requested_template_over_alphabetical_group_member() {
    assert_new_group_peer_uses_requested_template_silence_state("template-expired", true).await;
    assert_new_group_peer_uses_requested_template_silence_state("template-unmonitored", false)
        .await;
}

#[tokio::test]
async fn link_window_fans_out_source_silence_deadline_only_to_new_group_aliases() {
    let handler = RequestHandler::new();
    let source_session = session_name("link-fanout-source");
    let external_session = session_name("link-fanout-external");
    create_session(&handler, source_session.as_str()).await;
    create_session(&handler, external_session.as_str()).await;
    let source = WindowTarget::with_window(source_session, 0);
    let external = WindowTarget::with_window(external_session, 1);
    link_alias(&handler, source.clone(), external.clone()).await;
    let (owner, peer) = create_destination_group(
        &handler,
        "link-fanout-destination-owner",
        "link-fanout-destination-peer",
    )
    .await;
    handler.wait_for_initial_panes_for_test().await;
    enable_global_monitor_silence(&handler).await;

    let source_before = settled_timer_snapshot(&handler, &source).await;
    let external_before = settled_timer_snapshot(&handler, &external).await;
    let owner_unrelated = WindowTarget::with_window(owner.clone(), 0);
    let peer_unrelated = WindowTarget::with_window(peer.clone(), 0);
    let owner_unrelated_before = settled_timer_snapshot(&handler, &owner_unrelated).await;
    let peer_unrelated_before = settled_timer_snapshot(&handler, &peer_unrelated).await;
    for (label, snapshot) in [
        ("external alias", external_before),
        ("owner unrelated", owner_unrelated_before),
        ("peer unrelated", peer_unrelated_before),
    ] {
        assert_ne!(
            snapshot.1, source_before.1,
            "{label} needs a distinct natural deadline for this preservation assertion to be meaningful"
        );
    }

    let owner_destination = WindowTarget::with_window(owner, 1);
    let peer_destination = WindowTarget::with_window(peer, 1);
    link_alias(&handler, source.clone(), owner_destination.clone()).await;

    assert_eq!(timer_snapshot(&handler, &source), source_before);
    assert_eq!(timer_snapshot(&handler, &external), external_before);
    assert_eq!(
        timer_snapshot(&handler, &owner_unrelated),
        owner_unrelated_before
    );
    assert_eq!(
        timer_snapshot(&handler, &peer_unrelated),
        peer_unrelated_before
    );
    for destination in [owner_destination, peer_destination] {
        assert_eq!(
            timer_snapshot(&handler, &destination).1,
            source_before.1,
            "new destination alias {destination} inherits the addressed source deadline"
        );
    }
}

#[tokio::test]
async fn link_window_kill_clears_replaced_group_alerts_before_deadline_fanout() {
    let handler = RequestHandler::new();
    let source_session = session_name("link-kill-alert-source");
    create_session(&handler, source_session.as_str()).await;
    let source = WindowTarget::with_window(source_session, 0);
    let (owner, peer) =
        create_destination_group(&handler, "link-kill-alert-owner", "link-kill-alert-peer").await;
    handler.wait_for_initial_panes_for_test().await;
    enable_global_monitor_silence(&handler).await;
    let source_before = settled_timer_snapshot(&handler, &source).await;
    let stale_flags = rmux_core::WINLINK_ALERTFLAGS;
    {
        let mut state = handler.state.lock().await;
        for session_name in [&owner, &peer] {
            assert!(state
                .sessions
                .session_mut(session_name)
                .expect("destination group member exists")
                .add_winlink_alert_flags(0, stale_flags));
        }
    }

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

    let state = handler.state.lock().await;
    for session_name in [owner, peer] {
        let target = WindowTarget::with_window(session_name.clone(), 0);
        assert!(
            state
                .sessions
                .session(&session_name)
                .expect("destination group member survives")
                .winlink_alert_flags(0)
                .is_empty(),
            "alerts from the replaced WindowId must not survive at {target}"
        );
        assert_eq!(
            timer_snapshot(&handler, &target).1,
            source_before.1,
            "the active source deadline still fans out to {target}"
        );
    }
}

#[tokio::test]
async fn link_window_fans_out_expired_silence_state_without_rearming_group_aliases() {
    let handler = RequestHandler::new();
    let source_session = session_name("link-expired-fanout-source");
    create_session(&handler, source_session.as_str()).await;
    let source = WindowTarget::with_window(source_session, 0);
    let (owner, peer) = create_destination_group(
        &handler,
        "link-expired-fanout-owner",
        "link-expired-fanout-peer",
    )
    .await;
    handler.wait_for_initial_panes_for_test().await;
    enable_global_monitor_silence(&handler).await;

    let identity = handler
        .silence_timer_identity_for_test(&source)
        .expect("source silence timer is armed before expiry");
    handler
        .expire_silence_timer_for_test(source.clone(), identity.0, identity.1, identity.2)
        .await;
    assert_eq!(handler.silence_timer_snapshot_for_test(&source), None);

    let owner_destination = WindowTarget::with_window(owner, 1);
    let peer_destination = WindowTarget::with_window(peer, 1);
    link_alias(&handler, source, owner_destination.clone()).await;

    let state = handler.state.lock().await;
    for destination in [owner_destination, peer_destination] {
        assert_eq!(
            handler.silence_timer_snapshot_for_test(&destination),
            None,
            "expired alias {destination} must not be rearmed"
        );
        assert!(
            state
                .sessions
                .session(destination.session_name())
                .expect("destination group member survives")
                .winlink_alert_flags(destination.window_index())
                .contains(rmux_core::WINLINK_SILENCE),
            "expired silence flag must fan out to {destination}"
        );
    }
}

#[tokio::test]
async fn move_window_fans_out_source_silence_deadline_without_touching_external_alias() {
    let handler = RequestHandler::new();
    let source_session = session_name("move-fanout-source");
    let external_session = session_name("move-fanout-external");
    create_session(&handler, source_session.as_str()).await;
    create_session(&handler, external_session.as_str()).await;
    let source = WindowTarget::with_window(source_session, 0);
    let external = WindowTarget::with_window(external_session, 1);
    link_alias(&handler, source.clone(), external.clone()).await;
    let (owner, peer) = create_destination_group(
        &handler,
        "move-fanout-destination-owner",
        "move-fanout-destination-peer",
    )
    .await;
    handler.wait_for_initial_panes_for_test().await;
    enable_global_monitor_silence(&handler).await;

    let source_before = settled_timer_snapshot(&handler, &source).await;
    let external_before = settled_timer_snapshot(&handler, &external).await;
    let owner_unrelated = WindowTarget::with_window(owner.clone(), 0);
    let peer_unrelated = WindowTarget::with_window(peer.clone(), 0);
    let owner_unrelated_before = settled_timer_snapshot(&handler, &owner_unrelated).await;
    let peer_unrelated_before = settled_timer_snapshot(&handler, &peer_unrelated).await;
    for (label, snapshot) in [
        ("external alias", external_before),
        ("owner unrelated", owner_unrelated_before),
        ("peer unrelated", peer_unrelated_before),
    ] {
        assert_ne!(
            snapshot.1, source_before.1,
            "{label} needs a distinct natural deadline for this preservation assertion to be meaningful"
        );
    }
    let owner_destination = WindowTarget::with_window(owner.clone(), 1);
    let peer_destination = WindowTarget::with_window(peer, 1);

    let response = handler
        .handle(Request::MoveWindow(MoveWindowRequest {
            source: Some(source.clone()),
            target: MoveWindowTarget::Window(owner_destination.clone()),
            renumber: false,
            kill_destination: false,
            detached: true,
            after: false,
            before: false,
        }))
        .await;
    assert!(matches!(response, Response::MoveWindow(_)), "{response:?}");

    assert_eq!(handler.silence_timer_snapshot_for_test(&source), None);
    assert_eq!(timer_snapshot(&handler, &external), external_before);
    assert_eq!(
        timer_snapshot(&handler, &owner_unrelated),
        owner_unrelated_before
    );
    assert_eq!(
        timer_snapshot(&handler, &peer_unrelated),
        peer_unrelated_before
    );
    for destination in [owner_destination, peer_destination] {
        assert_eq!(
            timer_snapshot(&handler, &destination).1,
            source_before.1,
            "new destination alias {destination} inherits the moved source deadline"
        );
    }
}

#[tokio::test]
async fn move_window_fanout_never_overwrites_a_represented_group_peer_deadline() {
    let handler = RequestHandler::new();
    let owner = session_name("move-represented-deadline-owner");
    let peer = session_name("move-represented-deadline-peer");
    create_session(&handler, owner.as_str()).await;
    insert_window(&handler, &owner, 1).await;
    create_grouped_session(&handler, peer.as_str(), &owner).await;
    handler.wait_for_initial_panes_for_test().await;
    enable_global_monitor_silence(&handler).await;

    let owner_source = WindowTarget::with_window(owner.clone(), 0);
    let peer_source = WindowTarget::with_window(peer.clone(), 0);
    let owner_unrelated = WindowTarget::with_window(owner.clone(), 1);
    let peer_unrelated = WindowTarget::with_window(peer.clone(), 1);
    let owner_source_before = settled_timer_snapshot(&handler, &owner_source).await;
    let peer_source_before = settled_timer_snapshot(&handler, &peer_source).await;
    let owner_unrelated_before = settled_timer_snapshot(&handler, &owner_unrelated).await;
    let peer_unrelated_before = settled_timer_snapshot(&handler, &peer_unrelated).await;
    assert_ne!(
        owner_source_before.1, peer_source_before.1,
        "represented aliases need distinct natural deadlines to prove the peer wins"
    );

    let response = handler
        .handle(Request::MoveWindow(MoveWindowRequest {
            source: Some(owner_source),
            target: MoveWindowTarget::Window(WindowTarget::with_window(owner.clone(), 2)),
            renumber: false,
            kill_destination: false,
            detached: true,
            after: false,
            before: false,
        }))
        .await;
    assert!(matches!(response, Response::MoveWindow(_)), "{response:?}");

    assert_eq!(
        timer_snapshot(&handler, &WindowTarget::with_window(owner, 2)).1,
        owner_source_before.1
    );
    assert_eq!(
        timer_snapshot(&handler, &WindowTarget::with_window(peer, 2)).1,
        peer_source_before.1,
        "the peer's represented timer wins over the addressed source fanout"
    );
    assert_eq!(
        timer_snapshot(&handler, &owner_unrelated),
        owner_unrelated_before
    );
    assert_eq!(
        timer_snapshot(&handler, &peer_unrelated),
        peer_unrelated_before
    );
}

#[tokio::test]
async fn swap_window_fans_out_each_addressed_deadline_without_touching_external_links() {
    let handler = RequestHandler::new();
    let source_session = session_name("swap-fanout-source");
    let source_external_session = session_name("swap-fanout-source-external");
    let target_external_session = session_name("swap-fanout-target-external");
    create_session(&handler, source_session.as_str()).await;
    create_session(&handler, source_external_session.as_str()).await;
    create_session(&handler, target_external_session.as_str()).await;
    let source = WindowTarget::with_window(source_session, 0);
    let source_external = WindowTarget::with_window(source_external_session, 1);
    link_alias(&handler, source.clone(), source_external.clone()).await;
    let (owner, peer) = create_destination_group(
        &handler,
        "swap-fanout-destination-owner",
        "swap-fanout-destination-peer",
    )
    .await;
    let owner_target = WindowTarget::with_window(owner.clone(), 0);
    let target_external = WindowTarget::with_window(target_external_session, 1);
    link_alias(&handler, owner_target.clone(), target_external.clone()).await;
    handler.wait_for_initial_panes_for_test().await;
    enable_global_monitor_silence(&handler).await;

    let source_before = settled_timer_snapshot(&handler, &source).await;
    let source_external_before = settled_timer_snapshot(&handler, &source_external).await;
    let owner_before = settled_timer_snapshot(&handler, &owner_target).await;
    let peer_target = WindowTarget::with_window(peer, 0);
    let _peer_before = settled_timer_snapshot(&handler, &peer_target).await;
    let target_external_before = settled_timer_snapshot(&handler, &target_external).await;
    assert_ne!(
        source_before.1, owner_before.1,
        "addressed windows need distinct natural deadlines to prove the swap"
    );
    for (label, snapshot) in [
        ("source external alias", source_external_before),
        ("target external alias", target_external_before),
    ] {
        assert_ne!(
            snapshot.1, source_before.1,
            "{label} needs a distinct deadline from the source to prove it was untouched"
        );
        assert_ne!(
            snapshot.1, owner_before.1,
            "{label} needs a distinct deadline from the target to prove it was untouched"
        );
    }

    let response = handler
        .handle(Request::SwapWindow(SwapWindowRequest {
            source: source.clone(),
            target: owner_target.clone(),
            detached: true,
        }))
        .await;
    assert!(matches!(response, Response::SwapWindow(_)), "{response:?}");

    assert_eq!(timer_snapshot(&handler, &source).1, owner_before.1);
    assert_eq!(timer_snapshot(&handler, &owner_target).1, source_before.1);
    assert_eq!(timer_snapshot(&handler, &peer_target).1, source_before.1);
    assert_eq!(
        timer_snapshot(&handler, &source_external),
        source_external_before
    );
    assert_eq!(
        timer_snapshot(&handler, &target_external),
        target_external_before
    );
}