apcore 0.22.0

Schema-driven module standard for AI-perceivable interfaces
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
// Issue #65 — Registry on_load ordering: deferred-publish pattern
// Tests that modules are NOT visible during on_load, concurrent same-ID
// registration is rejected, and failures emit load_failed callbacks.

use apcore::context::Context;
use apcore::errors::{ErrorCode, ModuleError};
use apcore::module::Module;
use apcore::registry::registry::{ModuleDescriptor, Registry};
use async_trait::async_trait;
use parking_lot::Mutex;
use serde_json::{json, Value};
use std::collections::HashMap;
use std::sync::Arc;
use std::time::{Duration, Instant};

fn make_descriptor(id: &str) -> ModuleDescriptor {
    ModuleDescriptor {
        module_id: id.to_string(),
        name: None,
        description: String::new(),
        documentation: None,
        input_schema: json!({}),
        output_schema: json!({}),
        version: "1.0.0".to_string(),
        tags: vec![],
        annotations: None,
        examples: vec![],
        metadata: HashMap::new(),
        display: None,
        sunset_date: None,
        dependencies: vec![],
        enabled: true,
    }
}

// ---------------------------------------------------------------------------
// Module with configurable on_load delay and optional failure
// ---------------------------------------------------------------------------

struct DelayedModule {
    delay_ms: u64,
    fail: bool,
}

#[async_trait]
impl Module for DelayedModule {
    #[allow(clippy::unnecessary_literal_bound)]
    fn description(&self) -> &str {
        "delayed"
    }
    fn input_schema(&self) -> Value {
        json!({})
    }
    fn output_schema(&self) -> Value {
        json!({})
    }
    fn on_load(&self) -> Result<(), ModuleError> {
        if self.delay_ms > 0 {
            std::thread::sleep(Duration::from_millis(self.delay_ms));
        }
        if self.fail {
            Err(ModuleError::new(
                ErrorCode::ModuleLoadError,
                "intentional on_load failure",
            ))
        } else {
            Ok(())
        }
    }
    async fn execute(&self, _: Value, _: &Context<Value>) -> Result<Value, ModuleError> {
        Ok(json!({}))
    }
}

// ---------------------------------------------------------------------------
// Module that checks its own visibility during on_load
// ---------------------------------------------------------------------------

struct VisibilityCheckModule {
    registry: Arc<Registry>,
    id: String,
    delay_ms: u64,
    visible_during_load: Arc<Mutex<Option<bool>>>,
}

#[async_trait]
impl Module for VisibilityCheckModule {
    #[allow(clippy::unnecessary_literal_bound)]
    fn description(&self) -> &str {
        "visibility-check"
    }
    fn input_schema(&self) -> Value {
        json!({})
    }
    fn output_schema(&self) -> Value {
        json!({})
    }
    fn on_load(&self) -> Result<(), ModuleError> {
        // Check whether the module is visible during on_load.
        let visible = self.registry.get(&self.id).unwrap_or(None).is_some();
        *self.visible_during_load.lock() = Some(visible);
        if self.delay_ms > 0 {
            std::thread::sleep(Duration::from_millis(self.delay_ms));
        }
        Ok(())
    }
    async fn execute(&self, _: Value, _: &Context<Value>) -> Result<Value, ModuleError> {
        Ok(json!({}))
    }
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[test]
fn successful_on_load_makes_module_visible_after_register() {
    let registry = Registry::new();
    let result = registry.register(
        "executor.test.success",
        Box::new(DelayedModule {
            delay_ms: 0,
            fail: false,
        }),
        make_descriptor("executor.test.success"),
    );
    assert!(result.is_ok());
    // After register() returns Ok, the module MUST be visible.
    assert!(
        registry.get("executor.test.success").unwrap().is_some(),
        "module must be visible after successful registration"
    );
    assert!(
        registry
            .list(None, None, None)
            .contains(&"executor.test.success".to_string()),
        "module must appear in list() after successful registration"
    );
}

#[test]
fn module_not_visible_during_on_load() {
    let registry = Arc::new(Registry::new());
    let visible_during_load = Arc::new(Mutex::new(None));
    let module = VisibilityCheckModule {
        registry: Arc::clone(&registry),
        id: "executor.test.check".to_string(),
        delay_ms: 0,
        visible_during_load: Arc::clone(&visible_during_load),
    };
    registry
        .register(
            "executor.test.check",
            Box::new(module),
            make_descriptor("executor.test.check"),
        )
        .unwrap();
    let was_visible = visible_during_load.lock().unwrap();
    assert!(
        !was_visible,
        "module must NOT be visible during on_load (deferred-publish invariant)"
    );
}

#[test]
fn failing_on_load_blocks_visibility_and_emits_callback() {
    let registry = Registry::new();
    let load_failed: Arc<Mutex<Vec<String>>> = Arc::new(Mutex::new(vec![]));
    let lf = Arc::clone(&load_failed);
    registry.on_load_failed(Arc::new(move |id, _err| {
        lf.lock().push(id.to_string());
    }));

    let err = registry
        .register(
            "executor.test.failing",
            Box::new(DelayedModule {
                delay_ms: 0,
                fail: true,
            }),
            make_descriptor("executor.test.failing"),
        )
        .unwrap_err();

    // Error propagated directly (not wrapped in ModuleLoadError unless on_load says so).
    assert_eq!(err.code, ErrorCode::ModuleLoadError);

    // Module must NOT be visible after a failed on_load.
    assert!(
        registry.get("executor.test.failing").unwrap().is_none(),
        "module must not be visible after failed on_load"
    );
    assert!(
        !registry
            .list(None, None, None)
            .contains(&"executor.test.failing".to_string()),
        "module must not appear in list() after failed on_load"
    );

    // on_load_failed callback was invoked.
    let failed_ids = load_failed.lock();
    assert_eq!(
        failed_ids.len(),
        1,
        "load_failed callback must be invoked once"
    );
    assert_eq!(
        failed_ids[0], "executor.test.failing",
        "load_failed callback receives correct module_id"
    );
}

#[test]
fn concurrent_same_id_one_ok_one_err() {
    let registry = Arc::new(Registry::new());
    let r1 = Arc::clone(&registry);
    let r2 = Arc::clone(&registry);

    let h1 = std::thread::spawn(move || {
        r1.register(
            "executor.test.concurrent",
            Box::new(DelayedModule {
                delay_ms: 20,
                fail: false,
            }),
            make_descriptor("executor.test.concurrent"),
        )
    });
    let h2 = std::thread::spawn(move || {
        r2.register(
            "executor.test.concurrent",
            Box::new(DelayedModule {
                delay_ms: 20,
                fail: false,
            }),
            make_descriptor("executor.test.concurrent"),
        )
    });

    let r1 = h1.join().unwrap();
    let r2 = h2.join().unwrap();

    let ok_count = [&r1, &r2].iter().filter(|r| r.is_ok()).count();
    let err_count = [&r1, &r2].iter().filter(|r| r.is_err()).count();
    assert_eq!(ok_count, 1, "exactly one registration must succeed");
    assert_eq!(err_count, 1, "exactly one registration must fail");

    // The failing one must carry DuplicateModuleId regardless of which race path
    // fired (in_flight concurrent check OR detect_id_conflicts exact-duplicate).
    let err_result = [r1, r2].into_iter().find(Result::is_err).unwrap();
    let err = err_result.unwrap_err();
    assert_eq!(
        err.code,
        ErrorCode::DuplicateModuleId,
        "duplicate registration must use DuplicateModuleId, got {:?}: {}",
        err.code,
        err.message
    );

    // Exactly one module registered.
    assert_eq!(
        registry.count(),
        1,
        "registry must contain exactly one module after concurrent registration"
    );
}

#[test]
fn concurrent_distinct_ids_run_in_parallel() {
    let registry = Arc::new(Registry::new());
    let r1 = Arc::clone(&registry);
    let r2 = Arc::clone(&registry);

    let start = Instant::now();
    let h1 = std::thread::spawn(move || {
        r1.register(
            "executor.test.parallel_x",
            Box::new(DelayedModule {
                delay_ms: 50,
                fail: false,
            }),
            make_descriptor("executor.test.parallel_x"),
        )
    });
    let h2 = std::thread::spawn(move || {
        r2.register(
            "executor.test.parallel_y",
            Box::new(DelayedModule {
                delay_ms: 50,
                fail: false,
            }),
            make_descriptor("executor.test.parallel_y"),
        )
    });
    h1.join().unwrap().unwrap();
    h2.join().unwrap().unwrap();
    let elapsed = start.elapsed().as_millis();

    assert_eq!(registry.count(), 2, "both modules must be registered");
    assert!(
        elapsed < 90,
        "wall clock was {elapsed}ms; expected < 90ms (proves per-module parallelism — \
         distinct IDs must run on_load concurrently, not sequentially)"
    );
}

#[test]
fn load_failed_callback_receives_error_details() {
    let registry = Registry::new();
    let captured_err: Arc<Mutex<Option<ModuleError>>> = Arc::new(Mutex::new(None));
    let cap = Arc::clone(&captured_err);
    registry.on_load_failed(Arc::new(move |_id, err| {
        *cap.lock() = Some(err.clone());
    }));

    registry
        .register(
            "executor.test.err_details",
            Box::new(DelayedModule {
                delay_ms: 0,
                fail: true,
            }),
            make_descriptor("executor.test.err_details"),
        )
        .unwrap_err();

    let err = captured_err
        .lock()
        .clone()
        .expect("callback must have been called");
    assert_eq!(err.code, ErrorCode::ModuleLoadError);
    assert!(
        err.message.contains("on_load"),
        "error message should contain 'on_load'"
    );
}

// ---------------------------------------------------------------------------
// A-D-002: on_load failure emits apcore.registry.module_load_failed
// ---------------------------------------------------------------------------

use apcore::events::emitter::{ApCoreEvent, EventEmitter};
use apcore::events::subscribers::EventSubscriber;

#[derive(Debug)]
struct CapturingSubscriber {
    received: Arc<Mutex<Vec<ApCoreEvent>>>,
}

#[async_trait]
impl EventSubscriber for CapturingSubscriber {
    #[allow(clippy::unnecessary_literal_bound)]
    fn subscriber_id(&self) -> &str {
        "capture"
    }
    async fn on_event(&self, event: &ApCoreEvent) -> Result<(), ModuleError> {
        self.received.lock().push(event.clone());
        Ok(())
    }
}

/// A-D-002: when an event emitter is wired and a module's on_load fails, the
/// registry emits `apcore.registry.module_load_failed` carrying the 5-field
/// payload AND the module is not visible.
#[tokio::test]
async fn on_load_failure_emits_module_load_failed_event() {
    let received: Arc<Mutex<Vec<ApCoreEvent>>> = Arc::new(Mutex::new(Vec::new()));
    let mut emitter = EventEmitter::new();
    emitter.subscribe(Box::new(CapturingSubscriber {
        received: Arc::clone(&received),
    }));
    let emitter = Arc::new(emitter);

    let registry = Registry::new();
    registry.set_event_emitter(Arc::clone(&emitter));

    let err = registry
        .register(
            "executor.test.evt_failing",
            Box::new(DelayedModule {
                delay_ms: 0,
                fail: true,
            }),
            make_descriptor("executor.test.evt_failing"),
        )
        .unwrap_err();
    assert_eq!(err.code, ErrorCode::ModuleLoadError);

    // emit_spawn dispatches on a tokio task; poll until the event arrives.
    let mut attempts = 0;
    while received.lock().is_empty() && attempts < 200 {
        tokio::task::yield_now().await;
        tokio::time::sleep(Duration::from_millis(1)).await;
        attempts += 1;
    }

    let events = received.lock();
    let evt = events
        .iter()
        .find(|e| e.event_type == "apcore.registry.module_load_failed")
        .expect("module_load_failed event must be emitted");
    assert_eq!(evt.severity, "error");
    assert_eq!(evt.module_id.as_deref(), Some("executor.test.evt_failing"));
    let data = evt.data.as_object().expect("payload object");
    assert_eq!(
        data.get("module_id").and_then(|v| v.as_str()),
        Some("executor.test.evt_failing")
    );
    assert_eq!(
        data.get("callback_name").and_then(|v| v.as_str()),
        Some("on_load")
    );
    assert!(
        data.get("error_type").and_then(|v| v.as_str()).is_some(),
        "error_type must be present"
    );
    assert!(
        data.get("error_message")
            .and_then(|v| v.as_str())
            .is_some_and(|m| m.contains("on_load")),
        "error_message must carry the on_load failure detail"
    );
    assert!(
        data.get("timestamp").and_then(|v| v.as_str()).is_some(),
        "timestamp must be present"
    );

    // Module must NOT be visible after a failed on_load.
    assert!(
        registry.get("executor.test.evt_failing").unwrap().is_none(),
        "module must not be visible after failed on_load"
    );
}