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

//! Tests for call chain guard utilities.
//!
//! Covers `guard_call_chain` and `guard_call_chain_with_repeat` — depth limit,
//! circular call detection, frequency throttle, happy path, and edge cases.

use apcore::errors::ErrorCode;
use apcore::{guard_call_chain, guard_call_chain_with_repeat, Context};

fn anon_ctx() -> Context<serde_json::Value> {
    Context::<serde_json::Value>::anonymous()
}

fn ctx_with_chain(chain: Vec<&str>) -> Context<serde_json::Value> {
    let mut ctx = anon_ctx();
    ctx.call_chain = chain.into_iter().map(String::from).collect();
    ctx
}

// ---------------------------------------------------------------------------
// Happy path
// ---------------------------------------------------------------------------

#[test]
fn guard_empty_chain_passes() {
    let ctx = anon_ctx();
    assert!(guard_call_chain(&ctx, "mod.a", 10).is_ok());
}

#[test]
fn guard_single_module_in_chain_passes() {
    let ctx = ctx_with_chain(vec!["mod.a"]);
    assert!(guard_call_chain(&ctx, "mod.b", 10).is_ok());
}

#[test]
fn guard_short_diverse_chain_passes() {
    let ctx = ctx_with_chain(vec!["mod.a", "mod.b"]);
    assert!(guard_call_chain(&ctx, "mod.c", 10).is_ok());
}

#[test]
fn guard_module_repeated_below_limit_passes() {
    // mod.a appears twice; default repeat limit is 3, so one more is allowed.
    let ctx = ctx_with_chain(vec!["mod.a", "mod.b", "mod.a"]);
    assert!(guard_call_chain(&ctx, "mod.c", 100).is_ok());
}

// ---------------------------------------------------------------------------
// Depth limit exceeded
// ---------------------------------------------------------------------------

#[test]
fn guard_depth_exceeded_returns_error() {
    // chain of 4 entries exceeds max_depth=3
    let ctx = ctx_with_chain(vec!["a", "b", "c", "d"]);
    let result = guard_call_chain(&ctx, "e", 3);
    assert!(result.is_err());
    assert_eq!(result.unwrap_err().code, ErrorCode::CallDepthExceeded);
}

#[test]
fn guard_depth_exactly_at_limit_passes() {
    // chain length == max_depth is allowed (guard checks `>`, not `>=`)
    let ctx = ctx_with_chain(vec!["a", "b", "c"]);
    assert!(guard_call_chain(&ctx, "d", 3).is_ok());
}

#[test]
fn guard_depth_one_above_limit_errors() {
    let ctx = ctx_with_chain(vec!["a", "b", "c", "d"]);
    let result = guard_call_chain(&ctx, "e", 3);
    assert!(result.is_err());
    assert_eq!(result.unwrap_err().code, ErrorCode::CallDepthExceeded);
}

#[test]
fn guard_max_depth_one_empty_chain_passes() {
    let ctx = anon_ctx();
    assert!(guard_call_chain(&ctx, "mod.a", 1).is_ok());
}

#[test]
fn guard_max_depth_one_chain_of_one_passes() {
    // chain length == max_depth (1), no violation
    let ctx = ctx_with_chain(vec!["mod.a"]);
    assert!(guard_call_chain(&ctx, "mod.b", 1).is_ok());
}

#[test]
fn guard_max_depth_one_chain_of_two_errors() {
    let ctx = ctx_with_chain(vec!["a", "b"]);
    let result = guard_call_chain(&ctx, "c", 1);
    assert!(result.is_err());
    assert_eq!(result.unwrap_err().code, ErrorCode::CallDepthExceeded);
}

// ---------------------------------------------------------------------------
// Circular call detection
// ---------------------------------------------------------------------------

#[test]
fn guard_circular_call_returns_error() {
    // mod.a -> mod.b -> mod.a: circular
    let ctx = ctx_with_chain(vec!["mod.a", "mod.b", "mod.a"]);
    let result = guard_call_chain(&ctx, "mod.a", 100);
    assert!(result.is_err());
    assert_eq!(result.unwrap_err().code, ErrorCode::CircularCall);
}

#[test]
fn guard_circular_longer_chain_detected() {
    // a -> b -> c -> a is circular when calling a again
    let ctx = ctx_with_chain(vec!["a", "b", "c", "a"]);
    let result = guard_call_chain(&ctx, "a", 100);
    assert!(result.is_err());
    assert_eq!(result.unwrap_err().code, ErrorCode::CircularCall);
}

// ---------------------------------------------------------------------------
// Frequency throttle exceeded
// ---------------------------------------------------------------------------

#[test]
fn guard_frequency_at_default_limit_passes() {
    // A-D-040: canonical frequency uses `count > max_module_repeat`. The chain
    // includes the trailing self, so exactly 3 occurrences == default limit 3
    // is allowed (3 > 3 is false).
    let ctx = ctx_with_chain(vec!["mod.a", "mod.a", "mod.a"]);
    assert!(guard_call_chain(&ctx, "mod.a", 100).is_ok());
}

#[test]
fn guard_frequency_exceeded_returns_error() {
    // mod.a appears 4 times (consecutive, no cycle) — exceeds default
    // max_module_repeat=3 (count 4 > 3).
    let ctx = ctx_with_chain(vec!["mod.a", "mod.a", "mod.a", "mod.a"]);
    let result = guard_call_chain(&ctx, "mod.a", 100);
    assert!(result.is_err());
    assert_eq!(result.unwrap_err().code, ErrorCode::CallFrequencyExceeded);
}

#[test]
fn guard_frequency_two_occurrences_passes_with_default_limit() {
    // default limit is 3; two occurrences should not trigger it
    let ctx = ctx_with_chain(vec!["mod.a", "mod.b", "mod.a"]);
    // mod.a at chain end would create a cycle; check a different module
    let ctx2 = ctx_with_chain(vec!["mod.a", "mod.b", "mod.a", "mod.c"]);
    assert!(guard_call_chain(&ctx2, "mod.d", 100).is_ok());
    // also: mod.a appears twice; calling mod.a next would be the 3rd occurrence (allowed)
    let result = guard_call_chain(&ctx, "mod.a", 100);
    // This may trigger CircularCall (cycle a->b->a) before FrequencyExceeded
    assert!(result.is_err());
    let code = result.unwrap_err().code;
    assert!(
        code == ErrorCode::CircularCall || code == ErrorCode::CallFrequencyExceeded,
        "expected CircularCall or CallFrequencyExceeded, got {code:?}"
    );
}

// ---------------------------------------------------------------------------
// guard_call_chain_with_repeat — custom limits
// ---------------------------------------------------------------------------

#[test]
fn guard_with_repeat_max_repeat_one_single_occurrence_passes() {
    // With max_repeat=1, a single occurrence (count 1) is within the limit
    // (1 > 1 is false). The chain includes the trailing self.
    let ctx = ctx_with_chain(vec!["mod.a"]);
    assert!(guard_call_chain_with_repeat(&ctx, "mod.a", 100, 1).is_ok());
}

#[test]
fn guard_with_repeat_max_repeat_one_second_occurrence_errors() {
    // With max_repeat=1, two occurrences (count 2 > 1) exceed the limit.
    let ctx = ctx_with_chain(vec!["mod.a", "mod.a"]);
    let result = guard_call_chain_with_repeat(&ctx, "mod.a", 100, 1);
    assert!(result.is_err());
    assert_eq!(result.unwrap_err().code, ErrorCode::CallFrequencyExceeded);
}

#[test]
fn guard_with_repeat_max_repeat_one_different_module_passes() {
    let ctx = ctx_with_chain(vec!["mod.a"]);
    assert!(guard_call_chain_with_repeat(&ctx, "mod.b", 100, 1).is_ok());
}

#[test]
fn guard_with_repeat_custom_limit_two_passes_at_one_occurrence() {
    let ctx = ctx_with_chain(vec!["mod.a"]);
    assert!(guard_call_chain_with_repeat(&ctx, "mod.a", 100, 2).is_ok());
}

#[test]
fn guard_with_repeat_custom_limit_two_passes_at_two_occurrences() {
    // count 2 == max_repeat 2 → allowed (2 > 2 is false).
    let ctx = ctx_with_chain(vec!["mod.a", "mod.a"]);
    assert!(guard_call_chain_with_repeat(&ctx, "mod.a", 100, 2).is_ok());
}

#[test]
fn guard_with_repeat_custom_limit_two_errors_at_three_occurrences() {
    let ctx = ctx_with_chain(vec!["mod.a", "mod.a", "mod.a"]);
    let result = guard_call_chain_with_repeat(&ctx, "mod.a", 100, 2);
    assert!(result.is_err());
    assert_eq!(result.unwrap_err().code, ErrorCode::CallFrequencyExceeded);
}

#[test]
fn guard_with_repeat_depth_check_still_applies() {
    let ctx = ctx_with_chain(vec!["a", "b"]);
    let result = guard_call_chain_with_repeat(&ctx, "c", 1, 10);
    assert!(result.is_err());
    assert_eq!(result.unwrap_err().code, ErrorCode::CallDepthExceeded);
}

// ---------------------------------------------------------------------------
// Edge cases
// ---------------------------------------------------------------------------

#[test]
fn guard_empty_chain_max_depth_zero_empty_passes() {
    // chain length 0 is not > 0, so passes
    let ctx = anon_ctx();
    assert!(guard_call_chain(&ctx, "mod.a", 0).is_ok());
}

#[test]
fn guard_module_name_not_in_chain_passes() {
    let ctx = ctx_with_chain(vec!["x", "y", "z"]);
    assert!(guard_call_chain(&ctx, "mod.new", 100).is_ok());
}