astrid-capsule 0.5.0

Core runtime management for User-Space Capsules in Astrid OS
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
use super::*;
use astrid_events::EventBus;
use astrid_events::ipc::IpcPayload;

/// Publish N IPC messages to a bus and return a receiver subscribed to them.
fn publish_ipc_messages(bus: &EventBus, topic: &str, count: usize) {
    for i in 0..count {
        let msg = IpcMessage::new(
            topic,
            IpcPayload::Custom {
                data: serde_json::json!({"i": i}),
            },
            uuid::Uuid::new_v4(),
        );
        bus.publish(AstridEvent::Ipc {
            metadata: EventMetadata::new("test"),
            message: msg,
        });
    }
}

#[test]
fn drain_receiver_collects_all_available_messages() {
    let bus = EventBus::new();
    let mut receiver = bus.subscribe_topic("test.topic");

    publish_ipc_messages(&bus, "test.topic", 5);

    let result = drain_receiver(&mut receiver, 10 * 1024 * 1024);
    assert_eq!(result.messages.len(), 5);
    assert_eq!(result.dropped, 0);
    assert_eq!(result.lagged, 0);
}

#[test]
fn drain_receiver_returns_empty_when_no_messages() {
    let bus = EventBus::new();
    let mut receiver = bus.subscribe_topic("test.topic");

    let result = drain_receiver(&mut receiver, 10 * 1024 * 1024);
    assert!(result.messages.is_empty());
    assert_eq!(result.dropped, 0);
    assert_eq!(result.lagged, 0);
}

#[test]
fn drain_receiver_drops_on_buffer_overflow() {
    let bus = EventBus::new();
    let mut receiver = bus.subscribe_topic("test.topic");

    // Publish messages — each has a small JSON payload.
    publish_ipc_messages(&bus, "test.topic", 10);

    // Use a tiny buffer limit so the drain hits the overflow.
    // Each message payload `{"i":0}` serializes to ~20+ bytes as IpcPayload.
    let result = drain_receiver(&mut receiver, 50);
    assert!(
        result.messages.len() < 10,
        "should not have drained all 10 with 50-byte limit, got {}",
        result.messages.len()
    );
    assert_eq!(
        result.dropped, 1,
        "one message should be dropped on overflow"
    );
}

#[test]
fn drain_receiver_surfaces_lag_from_broadcast_overflow() {
    // Tiny channel capacity to force lag.
    let bus = EventBus::with_capacity(2);
    let mut receiver = bus.subscribe_topic("test.topic");

    // Publish 5 messages into a capacity-2 channel — the receiver will lag.
    publish_ipc_messages(&bus, "test.topic", 5);

    let result = drain_receiver(&mut receiver, 10 * 1024 * 1024);
    assert!(
        result.lagged > 0,
        "expected lag from broadcast overflow, got 0"
    );
    // Should still receive the messages that weren't lost.
    assert!(
        !result.messages.is_empty(),
        "should still get some messages after lag"
    );
}

#[test]
fn serialize_envelope_produces_valid_json_with_all_fields() {
    let msg = IpcMessage::new(
        "test.topic",
        IpcPayload::Custom {
            data: serde_json::json!({"hello": "world"}),
        },
        uuid::Uuid::new_v4(),
    );

    let result = DrainResult {
        messages: vec![msg],
        dropped: 2,
        lagged: 5,
    };

    let json = serialize_envelope(&result).expect("serialization should succeed");
    let parsed: serde_json::Value = serde_json::from_str(&json).expect("should be valid JSON");

    assert_eq!(
        parsed["messages"]
            .as_array()
            .expect("messages is array")
            .len(),
        1
    );
    assert_eq!(parsed["dropped"], 2);
    assert_eq!(parsed["lagged"], 5);
}

#[test]
fn serialize_envelope_empty_messages() {
    let result = DrainResult {
        messages: vec![],
        dropped: 0,
        lagged: 0,
    };

    let json = serialize_envelope(&result).expect("serialization should succeed");
    let parsed: serde_json::Value = serde_json::from_str(&json).unwrap();

    assert!(parsed["messages"].as_array().unwrap().is_empty());
    assert_eq!(parsed["dropped"], 0);
    assert_eq!(parsed["lagged"], 0);
}

#[tokio::test]
async fn subscription_lifecycle_remove_and_reinsert() {
    // Tests the Mutex-drop-before-blocking pattern used by recv_impl:
    // remove receiver from subscriptions, use it, re-insert it.
    let bus = EventBus::new();
    let receiver = bus.subscribe_topic("test.*");

    let mut subscriptions = std::collections::HashMap::new();
    let handle_id: u64 = 42;
    subscriptions.insert(handle_id, receiver);

    // Remove (simulates the lock-drop pattern in recv_impl).
    let mut removed = subscriptions
        .remove(&handle_id)
        .expect("should find handle");
    assert!(
        !subscriptions.contains_key(&handle_id),
        "handle should be gone after remove"
    );

    // Publish while receiver is outside the map.
    publish_ipc_messages(&bus, "test.foo", 3);

    // Drain from the removed receiver — should still work.
    let result = drain_receiver(&mut removed, 10 * 1024 * 1024);
    assert_eq!(result.messages.len(), 3, "receiver should work outside map");

    // Re-insert.
    subscriptions.insert(handle_id, removed);
    assert!(
        subscriptions.contains_key(&handle_id),
        "handle should be back after re-insert"
    );

    // Publish more and verify the re-inserted receiver still works.
    publish_ipc_messages(&bus, "test.bar", 2);
    let receiver = subscriptions.get_mut(&handle_id).unwrap();
    let result = drain_receiver(receiver, 10 * 1024 * 1024);
    assert_eq!(
        result.messages.len(),
        2,
        "receiver should work after re-insert"
    );
}

#[tokio::test]
async fn recv_blocking_wake_plus_drain_burst() {
    // Simulates what recv_impl does: block on recv(), then drain remaining.
    let bus = EventBus::new();
    let mut receiver = bus.subscribe_topic("burst.*");

    let bus_clone = bus.clone();
    tokio::spawn(async move {
        tokio::time::sleep(std::time::Duration::from_millis(10)).await;
        // Publish 5 messages in a burst.
        publish_ipc_messages(&bus_clone, "burst.test", 5);
    });

    // Block until first message arrives.
    let first = tokio::time::timeout(std::time::Duration::from_secs(5), receiver.recv())
        .await
        .expect("should not timeout")
        .expect("should get a message");

    // Small delay to let remaining messages arrive in the channel.
    tokio::time::sleep(std::time::Duration::from_millis(50)).await;

    // Drain remaining (simulates recv_impl's post-wake drain).
    let drain = drain_receiver(&mut receiver, 10 * 1024 * 1024);

    // The first message was consumed by recv(), drain gets the rest.
    let mut total = drain.messages.len() + 1; // +1 for the recv() message
    if let AstridEvent::Ipc { .. } = &*first {
        // first was a matching IPC message, count is correct.
    } else {
        total -= 1;
    }

    assert_eq!(
        total, 5,
        "should get all 5 messages (1 from recv + rest from drain)"
    );
}

/// Thin wrapper around the production deserialization path so we can
/// test it without a full WASM plugin context.
fn deserialize_publish_payload(payload_bytes: &[u8]) -> Result<IpcPayload, String> {
    serde_json::from_slice::<serde_json::Value>(payload_bytes)
        .map(IpcPayload::from_json_value)
        .map_err(|_| "IPC payload is not valid JSON".into())
}

#[test]
fn publish_unknown_type_tag_produces_custom() {
    let input = serde_json::json!({"type": "my_plugin_msg", "foo": 1});
    let bytes = serde_json::to_vec(&input).unwrap();
    let payload = deserialize_publish_payload(&bytes).unwrap();

    match payload {
        IpcPayload::Custom { data } => {
            assert_eq!(data["type"], "my_plugin_msg");
            assert_eq!(data["foo"], 1);
        },
        other => panic!("expected Custom, got {other:?}"),
    }
}

#[test]
fn publish_missing_type_tag_produces_custom() {
    let input = serde_json::json!({"foo": 1, "bar": "baz"});
    let bytes = serde_json::to_vec(&input).unwrap();
    let payload = deserialize_publish_payload(&bytes).unwrap();

    match payload {
        IpcPayload::Custom { data } => {
            assert_eq!(data["foo"], 1);
        },
        other => panic!("expected Custom, got {other:?}"),
    }
}

#[test]
fn publish_non_object_payload_produces_custom() {
    // A bare JSON string has no `type` field.
    let bytes = br#""hello""#;
    let payload = deserialize_publish_payload(bytes).unwrap();

    match payload {
        IpcPayload::Custom { data } => {
            assert_eq!(data, "hello");
        },
        other => panic!("expected Custom, got {other:?}"),
    }
}

#[test]
fn publish_known_type_tag_deserializes_correctly() {
    let input = serde_json::json!({"type": "connect"});
    let bytes = serde_json::to_vec(&input).unwrap();
    let payload = deserialize_publish_payload(&bytes).unwrap();

    assert_eq!(payload, IpcPayload::Connect);
}

#[test]
fn publish_known_tag_with_malformed_fields_falls_to_custom() {
    // `user_input` requires a `text` field. Without it, deserialization
    // fails and the .unwrap_or path produces Custom.
    let input = serde_json::json!({"type": "user_input"});
    let bytes = serde_json::to_vec(&input).unwrap();
    let payload = deserialize_publish_payload(&bytes).unwrap();

    match payload {
        IpcPayload::Custom { data } => {
            assert_eq!(data["type"], "user_input");
        },
        other => panic!("expected Custom (malformed known tag), got {other:?}"),
    }
}

#[test]
fn publish_custom_tag_with_data_unwraps_inner_value() {
    // A well-formed {"type": "custom", "data": {...}} should deserialize
    // via serde so that `data` is the inner value, not the outer wrapper.
    let input = serde_json::json!({"type": "custom", "data": {"foo": 1}});
    let bytes = serde_json::to_vec(&input).unwrap();
    let payload = deserialize_publish_payload(&bytes).unwrap();

    match payload {
        IpcPayload::Custom { data } => {
            assert_eq!(data, serde_json::json!({"foo": 1}));
        },
        other => panic!("expected Custom with inner data, got {other:?}"),
    }
}

#[test]
fn publish_invalid_json_is_error() {
    let result = deserialize_publish_payload(b"not json at all");
    assert!(result.is_err());
}

#[tokio::test]
async fn cancellation_token_unblocks_recv() {
    let bus = EventBus::new();
    let mut receiver = bus.subscribe_topic("cancel.test");
    let cancel_token = tokio_util::sync::CancellationToken::new();

    let token = cancel_token.clone();

    // Cancel after 50ms.
    tokio::spawn(async move {
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;
        token.cancel();
    });

    // Block on recv with a long timeout. Cancellation should unblock it
    // well before the 60-second timeout.
    let start = std::time::Instant::now();
    let event = tokio::select! {
        result = tokio::time::timeout(
            std::time::Duration::from_millis(60_000),
            receiver.recv(),
        ) => result.ok().flatten(),
        () = cancel_token.cancelled() => None,
    };

    let elapsed = start.elapsed();
    assert!(event.is_none(), "should return None on cancellation");
    assert!(
        elapsed < std::time::Duration::from_millis(500),
        "should unblock promptly, took {elapsed:?}"
    );
}

#[test]
fn protected_interceptor_handle_rejects_unsubscribe() {
    // Simulate post-auto-subscribe state: handle 1 is in subscriptions
    // and flagged as protected (runtime-owned interceptor).
    let bus = EventBus::new();
    let receiver = bus.subscribe_topic("interceptor.topic");

    let mut subscriptions = std::collections::HashMap::new();
    let handle_id: u64 = 1;
    subscriptions.insert(handle_id, receiver);

    // The production function must reject protected handles.
    let result = remove_subscription(&mut subscriptions, true, handle_id);
    assert!(
        result.is_err(),
        "should reject unsubscribe on protected handle",
    );
    assert!(
        result
            .unwrap_err()
            .to_string()
            .contains("runtime-owned interceptor handle"),
        "error should mention interceptor handle",
    );

    // Subscription must still exist.
    assert!(
        subscriptions.contains_key(&handle_id),
        "protected subscription must survive unsubscribe attempt",
    );
}

#[test]
fn guest_handle_allows_unsubscribe() {
    // Guest-created handle (not protected) can be removed.
    let bus = EventBus::new();
    let receiver = bus.subscribe_topic("guest.topic");

    let mut subscriptions = std::collections::HashMap::new();
    let handle_id: u64 = 99;
    subscriptions.insert(handle_id, receiver);

    // The production function must allow unprotected handles.
    let result = remove_subscription(&mut subscriptions, false, handle_id);
    assert!(result.is_ok(), "should allow unsubscribe on guest handle");
    assert!(
        !subscriptions.contains_key(&handle_id),
        "subscription should be gone after removal",
    );
}

#[test]
fn unsubscribe_nonexistent_handle_returns_not_found() {
    let mut subscriptions = std::collections::HashMap::new();

    let result = remove_subscription(&mut subscriptions, false, 42);
    assert!(result.is_err(), "should reject nonexistent handle");
    assert!(
        result.unwrap_err().to_string().contains("not found"),
        "error should mention not found",
    );
}

// ── subscribe ACL tests ────────────────────────────────────────

#[test]
fn subscribe_acl_empty_patterns_denies() {
    let err = check_subscribe_acl("test-capsule", "any.topic", &[]).unwrap_err();
    assert!(err.contains("no ipc_subscribe declarations"));
}

#[test]
fn subscribe_acl_exact_match_allows() {
    let patterns = vec!["agent.v1.response".into()];
    assert!(check_subscribe_acl("test", "agent.v1.response", &patterns).is_ok());
}

#[test]
fn subscribe_acl_wildcard_matches_concrete() {
    let patterns = vec!["registry.v1.*".into()];
    assert!(check_subscribe_acl("test", "registry.v1.providers", &patterns).is_ok());
}

#[test]
fn subscribe_acl_segment_count_mismatch_denies() {
    // ACL has 3 segments, subscription has 4 - topic_matches requires equal count.
    let patterns = vec!["registry.v1.*".into()];
    let err = check_subscribe_acl("test", "registry.v1.selection.callback", &patterns).unwrap_err();
    assert!(err.contains("not allowed to subscribe"));
}

#[test]
fn subscribe_acl_wildcard_subscription_matches_wildcard_acl() {
    // A capsule with ACL "foo.*" is explicitly authorizing a "foo.*" subscription
    // (same pattern). The ACL check gates the subscription string, not individual
    // messages.
    let patterns = vec!["foo.*".into()];
    assert!(check_subscribe_acl("test", "foo.*", &patterns).is_ok());
}

#[test]
fn subscribe_acl_wildcard_subscription_denied_by_exact_acl() {
    // A capsule with ACL ["foo.bar"] must NOT be able to subscribe to "foo.*"
    // which would receive all foo.* events, not just foo.bar. This is the
    // primary scope-escalation prevention invariant.
    let patterns = vec!["foo.bar".into()];
    let result = check_subscribe_acl("test", "foo.*", &patterns);
    assert!(
        result.is_err(),
        "wildcard subscription must be denied by exact ACL"
    );
}

#[test]
fn subscribe_acl_unrelated_topic_denies() {
    let patterns = vec!["agent.v1.*".into()];
    let err = check_subscribe_acl("test", "session.v1.clear", &patterns).unwrap_err();
    assert!(err.contains("not allowed to subscribe"));
}

#[test]
fn subscribe_acl_multiple_patterns_second_matches() {
    let patterns = vec!["agent.v1.*".into(), "session.v1.response.*".into()];
    assert!(check_subscribe_acl("test", "session.v1.response.abc", &patterns).is_ok());
}

#[test]
fn subscribe_acl_malformed_pattern_silently_denies() {
    // A malformed ACL pattern (empty segments) causes topic_matches to
    // return false via has_valid_segments, resulting in a silent deny.
    // This is safe (fail-closed) but the error message is misleading.
    // See #374 for load-time validation of ipc_subscribe patterns.
    let patterns = vec!["foo..bar".into()];
    let result = check_subscribe_acl("test", "foo.x.bar", &patterns);
    assert!(
        result.is_err(),
        "malformed ACL pattern must not allow subscriptions"
    );
}