synaptic-macros 0.4.0

Procedural macros for the Synaptic framework (#[tool], #[chain], #[entrypoint], etc.)
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
//! Integration tests for the middleware attribute macros.

use std::sync::Arc;

use synaptic_core::{Message, SynapticError};
use synaptic_macros::{
    after_agent, after_model, before_agent, before_model, dynamic_prompt, wrap_model_call,
};
use synaptic_middleware::{AgentMiddleware, ModelCaller, ModelRequest, ModelResponse};

// ---------------------------------------------------------------------------
// #[before_agent]
// ---------------------------------------------------------------------------

#[before_agent]
async fn setup(messages: &mut Vec<Message>) -> Result<(), SynapticError> {
    messages.push(Message::system("setup ran"));
    Ok(())
}

#[tokio::test]
async fn test_before_agent_middleware() {
    let mw: Arc<dyn AgentMiddleware> = setup();
    let mut messages = vec![Message::human("hello")];
    mw.before_agent(&mut messages).await.unwrap();
    assert_eq!(messages.len(), 2);
    assert_eq!(messages[1].content(), "setup ran");
}

// ---------------------------------------------------------------------------
// #[before_model]
// ---------------------------------------------------------------------------

#[before_model]
async fn add_context(request: &mut ModelRequest) -> Result<(), SynapticError> {
    request.system_prompt = Some("Be helpful".into());
    Ok(())
}

#[tokio::test]
async fn test_before_model_middleware() {
    let mw: Arc<dyn AgentMiddleware> = add_context();
    let mut req = ModelRequest {
        messages: vec![],
        tools: vec![],
        tool_choice: None,
        system_prompt: None,
    };
    mw.before_model(&mut req).await.unwrap();
    assert_eq!(req.system_prompt.as_deref(), Some("Be helpful"));
}

// ---------------------------------------------------------------------------
// #[after_model]
// ---------------------------------------------------------------------------

#[after_model]
async fn log_response(
    _request: &ModelRequest,
    response: &mut ModelResponse,
) -> Result<(), SynapticError> {
    // Simulate modifying the response by replacing the message
    response.message = Message::ai(format!("logged: {}", response.message.content()));
    Ok(())
}

#[tokio::test]
async fn test_after_model_middleware() {
    let mw: Arc<dyn AgentMiddleware> = log_response();
    let req = ModelRequest {
        messages: vec![],
        tools: vec![],
        tool_choice: None,
        system_prompt: None,
    };
    let mut resp = ModelResponse {
        message: Message::ai("original"),
        usage: None,
    };
    mw.after_model(&req, &mut resp).await.unwrap();
    assert_eq!(resp.message.content(), "logged: original");
}

// ---------------------------------------------------------------------------
// #[after_agent]
// ---------------------------------------------------------------------------

#[after_agent]
async fn cleanup(messages: &mut Vec<Message>) -> Result<(), SynapticError> {
    messages.push(Message::system("cleanup ran"));
    Ok(())
}

#[tokio::test]
async fn test_after_agent_middleware() {
    let mw: Arc<dyn AgentMiddleware> = cleanup();
    let mut messages = vec![Message::ai("done")];
    mw.after_agent(&mut messages).await.unwrap();
    assert_eq!(messages.len(), 2);
    assert_eq!(messages[1].content(), "cleanup ran");
}

// ---------------------------------------------------------------------------
// #[dynamic_prompt]
// ---------------------------------------------------------------------------

#[dynamic_prompt]
fn custom_prompt(messages: &[Message]) -> String {
    format!("You have {} messages in context", messages.len())
}

#[tokio::test]
async fn test_dynamic_prompt_middleware() {
    let mw: Arc<dyn AgentMiddleware> = custom_prompt();
    let mut req = ModelRequest {
        messages: vec![Message::human("hi"), Message::ai("hello")],
        tools: vec![],
        tool_choice: None,
        system_prompt: None,
    };
    mw.before_model(&mut req).await.unwrap();
    assert_eq!(
        req.system_prompt.as_deref(),
        Some("You have 2 messages in context")
    );
}

// ---------------------------------------------------------------------------
// Verify middleware struct names (factory returns Arc)
// ---------------------------------------------------------------------------

#[tokio::test]
async fn test_middleware_name() {
    // The factory functions return Arc<dyn AgentMiddleware>, which proves
    // that the generated structs (SetupMiddleware, AddContextMiddleware, etc.)
    // correctly implement the AgentMiddleware trait.
    let _setup: Arc<dyn AgentMiddleware> = setup();
    let _add_context: Arc<dyn AgentMiddleware> = add_context();
    let _log_response: Arc<dyn AgentMiddleware> = log_response();
    let _cleanup: Arc<dyn AgentMiddleware> = cleanup();
    let _custom_prompt: Arc<dyn AgentMiddleware> = custom_prompt();
}

// ---------------------------------------------------------------------------
// #[wrap_model_call] — compilation test
// ---------------------------------------------------------------------------

#[wrap_model_call]
async fn passthrough_model(
    request: ModelRequest,
    next: &dyn ModelCaller,
) -> Result<ModelResponse, SynapticError> {
    next.call(request).await
}

#[tokio::test]
async fn test_wrap_model_call_middleware() {
    // We cannot easily construct a real ModelCaller in a test without
    // spinning up a full model, but we can verify the macro compiles
    // correctly and produces a valid Arc<dyn AgentMiddleware>.
    let mw: Arc<dyn AgentMiddleware> = passthrough_model();
    // Verify the default methods still work (before_agent should no-op)
    let mut messages = vec![Message::human("hi")];
    mw.before_agent(&mut messages).await.unwrap();
    assert_eq!(messages.len(), 1);
}

// ---------------------------------------------------------------------------
// Default methods are no-ops
// ---------------------------------------------------------------------------

#[tokio::test]
async fn test_before_agent_default_methods_are_noop() {
    // A before_agent middleware should have no-op implementations for
    // all other AgentMiddleware methods.
    let mw: Arc<dyn AgentMiddleware> = setup();

    // before_model should be a no-op
    let mut req = ModelRequest {
        messages: vec![],
        tools: vec![],
        tool_choice: None,
        system_prompt: None,
    };
    mw.before_model(&mut req).await.unwrap();
    assert!(req.system_prompt.is_none());

    // after_agent should be a no-op
    let mut msgs = vec![];
    mw.after_agent(&mut msgs).await.unwrap();
    assert!(msgs.is_empty());
}

// ===========================================================================
// #[field] support tests
// ===========================================================================

// ---------------------------------------------------------------------------
// #[before_agent] with #[field]
// ---------------------------------------------------------------------------

#[before_agent]
async fn prefixed_setup(
    #[field] prefix: String,
    messages: &mut Vec<Message>,
) -> Result<(), SynapticError> {
    messages.push(Message::system(format!("{}: setup ran", prefix)));
    Ok(())
}

#[tokio::test]
async fn test_before_agent_with_field() {
    let mw: Arc<dyn AgentMiddleware> = prefixed_setup("BOT".to_string());
    let mut messages = vec![Message::human("hello")];
    mw.before_agent(&mut messages).await.unwrap();
    assert_eq!(messages.len(), 2);
    assert_eq!(messages[1].content(), "BOT: setup ran");
}

// ---------------------------------------------------------------------------
// #[before_model] with #[field]
// ---------------------------------------------------------------------------

#[before_model]
async fn inject_prompt(
    #[field] prompt: String,
    request: &mut ModelRequest,
) -> Result<(), SynapticError> {
    request.system_prompt = Some(prompt);
    Ok(())
}

#[tokio::test]
async fn test_before_model_with_field() {
    let mw: Arc<dyn AgentMiddleware> = inject_prompt("You are a pirate".to_string());
    let mut req = ModelRequest {
        messages: vec![],
        tools: vec![],
        tool_choice: None,
        system_prompt: None,
    };
    mw.before_model(&mut req).await.unwrap();
    assert_eq!(req.system_prompt.as_deref(), Some("You are a pirate"));
}

// ---------------------------------------------------------------------------
// #[after_model] with #[field]
// ---------------------------------------------------------------------------

#[after_model]
async fn tag_response(
    #[field] tag: String,
    _request: &ModelRequest,
    response: &mut ModelResponse,
) -> Result<(), SynapticError> {
    response.message = Message::ai(format!("[{}] {}", tag, response.message.content()));
    Ok(())
}

#[tokio::test]
async fn test_after_model_with_field() {
    let mw: Arc<dyn AgentMiddleware> = tag_response("v2".to_string());
    let req = ModelRequest {
        messages: vec![],
        tools: vec![],
        tool_choice: None,
        system_prompt: None,
    };
    let mut resp = ModelResponse {
        message: Message::ai("hi"),
        usage: None,
    };
    mw.after_model(&req, &mut resp).await.unwrap();
    assert_eq!(resp.message.content(), "[v2] hi");
}

// ---------------------------------------------------------------------------
// #[after_agent] with #[field]
// ---------------------------------------------------------------------------

#[after_agent]
async fn append_footer(
    #[field] footer: String,
    messages: &mut Vec<Message>,
) -> Result<(), SynapticError> {
    messages.push(Message::system(footer));
    Ok(())
}

#[tokio::test]
async fn test_after_agent_with_field() {
    let mw: Arc<dyn AgentMiddleware> = append_footer("-- end --".to_string());
    let mut messages = vec![Message::ai("done")];
    mw.after_agent(&mut messages).await.unwrap();
    assert_eq!(messages.len(), 2);
    assert_eq!(messages[1].content(), "-- end --");
}

// ---------------------------------------------------------------------------
// #[dynamic_prompt] with #[field]
// ---------------------------------------------------------------------------

#[dynamic_prompt]
fn branded_prompt(#[field] brand: String, messages: &[Message]) -> String {
    format!("[{}] You have {} messages", brand, messages.len())
}

#[tokio::test]
async fn test_dynamic_prompt_with_field() {
    let mw: Arc<dyn AgentMiddleware> = branded_prompt("Acme".to_string());
    let mut req = ModelRequest {
        messages: vec![Message::human("hi")],
        tools: vec![],
        tool_choice: None,
        system_prompt: None,
    };
    mw.before_model(&mut req).await.unwrap();
    assert_eq!(
        req.system_prompt.as_deref(),
        Some("[Acme] You have 1 messages")
    );
}

// ---------------------------------------------------------------------------
// Multiple #[field] params
// ---------------------------------------------------------------------------

#[before_agent]
async fn multi_field_setup(
    #[field] prefix: String,
    #[field] max_messages: usize,
    messages: &mut Vec<Message>,
) -> Result<(), SynapticError> {
    if messages.len() < max_messages {
        messages.push(Message::system(format!("{}: initialized", prefix)));
    }
    Ok(())
}

#[tokio::test]
async fn test_multiple_fields() {
    let mw: Arc<dyn AgentMiddleware> = multi_field_setup("SYS".to_string(), 5);
    let mut messages = vec![Message::human("hello")];
    mw.before_agent(&mut messages).await.unwrap();
    assert_eq!(messages.len(), 2);
    assert_eq!(messages[1].content(), "SYS: initialized");

    // With max_messages = 1, no message should be added
    let mw2: Arc<dyn AgentMiddleware> = multi_field_setup("SYS".to_string(), 1);
    let mut messages2 = vec![Message::human("hello")];
    mw2.before_agent(&mut messages2).await.unwrap();
    assert_eq!(messages2.len(), 1); // not added because len() >= max_messages
}

// ---------------------------------------------------------------------------
// #[wrap_model_call] with #[field] — compilation test
// ---------------------------------------------------------------------------

#[wrap_model_call]
async fn retry_model(
    #[field] max_retries: usize,
    request: ModelRequest,
    next: &dyn ModelCaller,
) -> Result<ModelResponse, SynapticError> {
    let mut last_err = None;
    for attempt in 0..=max_retries {
        match next.call(request.clone()).await {
            Ok(val) => return Ok(val),
            Err(e) => {
                last_err = Some(e);
                let _ = attempt; // suppress unused warning
            }
        }
    }
    Err(last_err.unwrap())
}

#[tokio::test]
async fn test_wrap_model_call_with_field() {
    // Verify the macro compiles and produces a valid Arc<dyn AgentMiddleware>
    let mw: Arc<dyn AgentMiddleware> = retry_model(3);
    // Verify default methods still work
    let mut messages = vec![Message::human("hi")];
    mw.before_agent(&mut messages).await.unwrap();
    assert_eq!(messages.len(), 1);
}

// ---------------------------------------------------------------------------
// #[wrap_tool_call] with #[field] — compilation test
// ---------------------------------------------------------------------------

use synaptic_macros::wrap_tool_call;
use synaptic_middleware::ToolCaller;

#[wrap_tool_call]
async fn logged_tool_call(
    #[field] log_prefix: String,
    request: synaptic_middleware::ToolCallRequest,
    next: &dyn ToolCaller,
) -> Result<serde_json::Value, SynapticError> {
    let _ = format!("{}: calling {}", log_prefix, request.call.name);
    next.call(request).await
}

#[tokio::test]
async fn test_wrap_tool_call_with_field() {
    let mw: Arc<dyn AgentMiddleware> = logged_tool_call("LOG".to_string());
    // Verify default methods still work
    let mut messages = vec![Message::human("hi")];
    mw.before_agent(&mut messages).await.unwrap();
    assert_eq!(messages.len(), 1);
}