subc-daemon 0.36.5

Embeddable subc daemon: bootstrap, module supervision, and opaque-byte splice routing.
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
use subc_protocol::scope::ScopeRecordResult;

const HASH: &str = "4bb06f8e4e3a7715d201d573d0aa423762e55dabd61a2c02278fa56cc6d294e0";
const PROOF: &str = "BwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwc";

fn direct_session(epoch: u64) -> ScopeRecord {
    let mut record = session(epoch);
    record.carriers.push(ScopeCarrier::new(Principal::Direct));
    record
}

#[tokio::test]
async fn idle_replace_ignores_reserved_routes() {
    for delta in [false, true] {
        for opener in [OWNER, AFT] {
            let mut rig = rig().await;
            rig.sync(vec![session(1)]).await;
            let mut route = rig
                .bound(Some(opener), PLEXUS, Some(rig.selector("s", Some(1))))
                .await;
            assert_eq!(
                change(&mut rig, vec![session(2).with_replace_only_if_idle(true)], delta)
                    .await[0]
                    .outcome,
                ScopeRecordOutcome::Replaced
            );
            assert!(!rig.live(&route));
            assert_eq!(route.closed_reason(), RouteCloseReason::ScopeEnded);
        }
    }
}

#[tokio::test]
async fn reserved_hold_presence_records_nothing() {
    for opener in [OWNER, AFT] {
        let mut rig = rig().await;
        rig.sync(vec![session(1)]).await;
        let route = rig
            .bound(
                Some(opener),
                PLEXUS,
                Some(rig.selector("s", Some(1)).with_hold_presence(true)),
            )
            .await;
        rig.handler
            .cleanup_connection(rig.modules[PLEXUS].0.connection_id)
            .unwrap();
        assert!(!rig.live(&route));
        assert_eq!(
            change(&mut rig, vec![session(2).with_replace_only_if_idle(true)], true)
                .await[0]
                .outcome,
            ScopeRecordOutcome::Replaced
        );
    }
}

async fn change(rig: &mut Rig, records: Vec<ScopeRecord>, delta: bool) -> Vec<ScopeRecordResult> {
    rig.generation += 1;
    let request = if delta {
        ModuleControlRequestFromModule::ScopeApply {
            generation: rig.generation,
            upsert: records,
            end: vec![],
        }
    } else {
        ModuleControlRequestFromModule::ScopeSync {
            generation: rig.generation,
            scopes: records,
        }
    };
    let reply = call(&rig.handler, &rig.owner, &request).await;
    match serde_json::from_slice(&reply.body).unwrap() {
        ModuleControlResponseToModule::ScopeSync { results, .. }
        | ModuleControlResponseToModule::ScopeApply { results, .. } => results,
        other => panic!("unexpected reply: {other:?}"),
    }
}

fn refused(result: &ScopeRecordResult) {
    assert_eq!(result.outcome, ScopeRecordOutcome::Refused);
    assert_eq!(
        result.code.as_deref(),
        Some(error_codes::SCOPE_EPOCH_IN_USE)
    );
    assert_eq!(
        result.message.as_deref(),
        Some("routes are still bound to the live scope epoch")
    );
}

#[tokio::test]
async fn idle_replace_refuses_live_route_then_succeeds_after_close() {
    for delta in [false, true] {
        let mut rig = rig().await;
        rig.sync(vec![direct_session(1)]).await;
        let route = rig
            .bound(None, PLEXUS, Some(rig.selector("s", Some(1))))
            .await;
        let replacement = direct_session(2)
            .with_bind_proof_sha256(Some(HASH.into()))
            .with_replace_only_if_idle(true);
        let before = describe(&rig.handler, &rig.owner, OWNER, "s").await;
        let results = change(
            &mut rig,
            vec![
                replacement.clone(),
                head("independent", 1).with_replace_only_if_idle(true),
            ],
            delta,
        )
        .await;
        refused(&results[0]);
        assert_eq!(results[1].outcome, ScopeRecordOutcome::Created);
        assert!(rig.live(&route));
        assert_eq!(describe(&rig.handler, &rig.owner, OWNER, "s").await, before);
        rig.handler
            .cleanup_connection(route.client.connection_id)
            .unwrap();
        while rig.modules.get_mut(PLEXUS).unwrap().1.try_recv().is_ok() {}
        let results = change(&mut rig, vec![replacement], delta).await;
        assert_eq!(results[0].outcome, ScopeRecordOutcome::Replaced);
        assert_eq!(
            rig.refused(None, PLEXUS, Some(rig.selector("s", Some(2))))
                .await,
            error_codes::SCOPE_BIND_PROOF_REQUIRED
        );
        let new_route = rig
            .bound(
                None,
                PLEXUS,
                Some(
                    rig.selector("s", Some(2))
                        .with_bind_proof(Some(PROOF.into())),
                ),
            )
            .await;
        assert!(rig.live(&new_route));
    }
}

#[tokio::test]
async fn idle_hash_change_refuses_bound_but_unchanged_never_refuses() {
    let mut rig = rig().await;
    rig.sync(vec![direct_session(1)]).await;
    let route = rig
        .bound(None, PLEXUS, Some(rig.selector("s", Some(1))))
        .await;
    let results = change(
        &mut rig,
        vec![direct_session(1).with_replace_only_if_idle(true)],
        true,
    )
    .await;
    assert_eq!(results[0].outcome, ScopeRecordOutcome::Unchanged);
    let update = direct_session(1)
        .with_bind_proof_sha256(Some(HASH.into()))
        .with_replace_only_if_idle(true);
    refused(&change(&mut rig, vec![update.clone()], true).await[0]);
    assert!(rig.live(&route));
    rig.handler
        .cleanup_connection(route.client.connection_id)
        .unwrap();
    while rig.modules.get_mut(PLEXUS).unwrap().1.try_recv().is_ok() {}
    assert_eq!(
        change(&mut rig, vec![update], true).await[0].outcome,
        ScopeRecordOutcome::Updated
    );
    assert_eq!(
        rig.refused(None, PLEXUS, Some(rig.selector("s", Some(1))))
            .await,
        error_codes::SCOPE_BIND_PROOF_REQUIRED
    );
    let new_route = rig
        .bound(
            None,
            PLEXUS,
            Some(
                rig.selector("s", Some(1))
                    .with_bind_proof(Some(PROOF.into())),
            ),
        )
        .await;
    assert!(rig.live(&new_route));
}

#[tokio::test]
async fn unconditional_replace_still_closes_routes() {
    let mut rig = rig().await;
    rig.sync(vec![direct_session(1)]).await;
    let mut route = rig
        .bound(None, PLEXUS, Some(rig.selector("s", Some(1))))
        .await;
    assert_eq!(
        change(&mut rig, vec![direct_session(2)], true).await[0].outcome,
        ScopeRecordOutcome::Replaced
    );
    assert!(!rig.live(&route));
    assert_eq!(route.closed_reason(), RouteCloseReason::ScopeEnded);
}

#[tokio::test]
async fn idle_replace_counts_admitted_bind_before_egress_reservation() {
    use std::future::Future;
    let mut rig = rig().await;
    rig.sync(vec![direct_session(1)]).await;
    let (client, mut rx, frame) =
        rig.open_frame(None, PLEXUS, Some(rig.selector("s", Some(1))));
    for _ in 0..64 {
        client.egress.try_send(route_bind_ack(1)).unwrap();
    }
    let handler = rig.handler.clone();
    let mut open = Box::pin(handler.handle_control_frame(&client, frame));
    std::future::poll_fn(|cx| {
        assert!(open.as_mut().poll(cx).is_pending());
        std::task::Poll::Ready(())
    })
    .await;
    refused(
        &change(
            &mut rig,
            vec![direct_session(2).with_replace_only_if_idle(true)],
            true,
        )
        .await[0],
    );
    // Dropping the admitted future releases usage even before forwarding has
    // reserved its route handles.
    drop(open);
    rx.try_recv().unwrap();
    assert_eq!(
        change(
            &mut rig,
            vec![direct_session(2).with_replace_only_if_idle(true)],
            true
        )
        .await[0]
            .outcome,
        ScopeRecordOutcome::Replaced
    );
}

#[tokio::test]
async fn presence_survives_target_disconnect_until_holder_disconnect() {
    let mut rig = rig().await;
    rig.sync(vec![direct_session(1)]).await;
    let route = rig
        .bound(
            None,
            PLEXUS,
            Some(rig.selector("s", Some(1)).with_hold_presence(true)),
        )
        .await;
    rig.handler
        .cleanup_connection(rig.modules[PLEXUS].0.connection_id)
        .unwrap();
    assert!(!rig.live(&route));
    let replacement = direct_session(2).with_replace_only_if_idle(true);
    refused(&change(&mut rig, vec![replacement.clone()], true).await[0]);
    rig.handler
        .cleanup_connection(route.client.connection_id)
        .unwrap();
    assert_eq!(
        change(&mut rig, vec![replacement], true).await[0].outcome,
        ScopeRecordOutcome::Replaced
    );
}

#[tokio::test]
async fn refused_open_does_not_hold_presence() {
    let mut rig = rig().await;
    rig.sync(vec![direct_session(1).with_bind_proof_sha256(Some(HASH.into()))])
        .await;
    assert_eq!(
        rig.refused(
            None,
            PLEXUS,
            Some(rig.selector("s", Some(1)).with_hold_presence(true))
        )
        .await,
        error_codes::SCOPE_BIND_PROOF_REQUIRED
    );
    assert_eq!(
        change(
            &mut rig,
            vec![direct_session(2).with_replace_only_if_idle(true)],
            true
        )
        .await[0]
            .outcome,
        ScopeRecordOutcome::Replaced
    );
}

#[tokio::test]
async fn unconditional_replace_drops_old_epoch_presence() {
    let mut rig = rig().await;
    rig.sync(vec![direct_session(1)]).await;
    let route = rig
        .bound(
            None,
            PLEXUS,
            Some(rig.selector("s", Some(1)).with_hold_presence(true)),
        )
        .await;
    assert_eq!(
        change(&mut rig, vec![direct_session(2)], true).await[0].outcome,
        ScopeRecordOutcome::Replaced
    );
    assert!(!rig.live(&route));
    assert_eq!(
        change(
            &mut rig,
            vec![direct_session(3).with_replace_only_if_idle(true)],
            true
        )
        .await[0]
            .outcome,
        ScopeRecordOutcome::Replaced
    );
}

#[tokio::test]
async fn presence_holder_limit_does_not_refuse_opens() {
    let mut rig = rig().await;
    rig.sync(vec![direct_session(1)]).await;
    let mut routes = Vec::new();
    for _ in 0..9 {
        routes.push(
            rig.bound(
                None,
                PLEXUS,
                Some(rig.selector("s", Some(1)).with_hold_presence(true)),
            )
            .await,
        );
    }
    rig.handler
        .cleanup_connection(rig.modules[PLEXUS].0.connection_id)
        .unwrap();
    let replacement = direct_session(2).with_replace_only_if_idle(true);
    refused(&change(&mut rig, vec![replacement.clone()], true).await[0]);
    for route in &routes[..8] {
        rig.handler
            .cleanup_connection(route.client.connection_id)
            .unwrap();
    }
    assert_eq!(
        change(&mut rig, vec![replacement], true).await[0].outcome,
        ScopeRecordOutcome::Replaced
    );
}

#[tokio::test]
async fn idle_condition_is_checked_under_scope_write_lock() {
    let mut rig = rig().await;
    rig.sync(vec![direct_session(1)]).await;
    let scopes = Arc::downgrade(&rig.handler.scopes);
    let calls = Arc::new(std::sync::atomic::AtomicUsize::new(0));
    let observed = Arc::clone(&calls);
    rig.handler.scopes.write().unwrap().idle_check_hook = Some(Arc::new(move || {
        let scopes = scopes.upgrade().unwrap();
        assert!(
            matches!(scopes.try_read(), Err(std::sync::TryLockError::WouldBlock)),
            "idle condition must exclude admission until apply completes"
        );
        assert!(
            matches!(scopes.try_write(), Err(std::sync::TryLockError::WouldBlock)),
            "route.open must not slip between idle check and apply"
        );
        observed.fetch_add(1, std::sync::atomic::Ordering::SeqCst);
    }));
    assert_eq!(
        change(
            &mut rig,
            vec![direct_session(2).with_replace_only_if_idle(true)],
            true
        )
        .await[0]
            .outcome,
        ScopeRecordOutcome::Replaced
    );
    assert_eq!(calls.load(std::sync::atomic::Ordering::SeqCst), 1);
}

#[tokio::test]
async fn closed_route_snapshots_do_not_keep_epoch_busy() {
    let mut rig = rig().await;
    rig.sync(vec![direct_session(1)]).await;
    let route = rig
        .bound(None, PLEXUS, Some(rig.selector("s", Some(1))))
        .await;
    let snapshot = rig
        .forwarding
        .lookup_data_route(route.client.connection_id, route.channel, route.epoch)
        .unwrap();
    rig.handler
        .cleanup_connection(route.client.connection_id)
        .unwrap();
    assert_eq!(
        change(
            &mut rig,
            vec![direct_session(2).with_replace_only_if_idle(true)],
            true
        )
        .await[0]
            .outcome,
        ScopeRecordOutcome::Replaced
    );
    drop(snapshot);
}

#[tokio::test]
async fn module_refused_open_does_not_hold_presence() {
    let mut rig = rig().await;
    rig.sync(vec![direct_session(1)]).await;
    let relayed = rig
        .relayed(
            None,
            PLEXUS,
            Some(rig.selector("s", Some(1)).with_hold_presence(true)),
        )
        .await;
    let rejection = control_error_body_frame(
        &relayed.bind,
        ErrorBody::new("not_allowed", "provider refused"),
    )
    .unwrap();
    rig.handler
        .handle_control_frame(&rig.modules[PLEXUS].0, rejection)
        .await
        .unwrap();
    let replies = relayed.task.await.unwrap();
    assert_eq!(parse_error(&replies[0])["code"], "not_allowed");
    assert_eq!(
        change(
            &mut rig,
            vec![direct_session(2).with_replace_only_if_idle(true)],
            true
        )
        .await[0]
            .outcome,
        ScopeRecordOutcome::Replaced
    );
}