rig-core 0.44.0

An opinionated library for building LLM powered applications.
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
use std::sync::{
    Arc, Mutex,
    atomic::{AtomicUsize, Ordering},
};

use futures::StreamExt;
use serde_json::json;

use super::*;
use crate::{
    effect::{FamilyDescriptor, HandlerKey},
    operation::Finish,
    streaming::{Item, StreamEvent},
};

fn custom(payload: serde_json::Value) -> EffectKind {
    EffectKind::Custom {
        kind: Arc::from("test"),
        payload,
    }
}

/// Answers a custom effect with its payload; counts its calls.
struct Echo {
    served: Arc<AtomicUsize>,
}

impl Serve for Echo {
    type Family = family::Dynamic;

    fn descriptor(&self) -> HandlerDescriptor {
        HandlerDescriptor {
            key: HandlerKey::from("echo"),
            family: FamilyDescriptor::Custom {
                kind: "test".into(),
            },
            layers: Vec::new(),
        }
    }

    async fn serve(&self, kind: EffectKind, _dispatch: Dispatch) -> Reply {
        self.served.fetch_add(1, Ordering::SeqCst);
        let outcome = match kind {
            EffectKind::Custom { payload, .. } => Ok(Outcome::Custom { payload }),
            other => Err(ErrorReport::new(
                ErrorKind::Internal,
                format!("echo received {}", other.name()),
            )),
        };
        Reply::Outcome(outcome)
    }
}

/// Streams two text deltas and a terminal.
struct Streamer;

impl Serve for Streamer {
    type Family = family::Dynamic;

    fn descriptor(&self) -> HandlerDescriptor {
        HandlerDescriptor {
            key: HandlerKey::from("streamer"),
            family: FamilyDescriptor::Custom {
                kind: "test".into(),
            },
            layers: Vec::new(),
        }
    }

    async fn serve(&self, _kind: EffectKind, _dispatch: Dispatch) -> Reply {
        Reply::written(
            crate::message::Origin::new("test", "test", "test"),
            |mut writer| async move {
                writer.text("hel").await.expect("open");
                writer.text("lo").await.expect("open");
                writer.finish(Finish::default()).await.expect("open");
            },
        )
    }
}

type Before = Box<dyn Fn(&EffectKind) -> Decision + Send + Sync>;
type After = Box<dyn Fn(&Result<Outcome, ErrorReport>) -> Verdict + Send + Sync>;

/// Records what it saw, in order, and decides as configured.
struct Policy {
    name: &'static str,
    seen: Arc<Mutex<Vec<String>>>,
    before: Before,
    after: After,
}

impl Policy {
    fn observing(name: &'static str, seen: &Arc<Mutex<Vec<String>>>) -> Self {
        Self {
            name,
            seen: Arc::clone(seen),
            before: Box::new(|_| Decision::Proceed),
            after: Box::new(|_| Verdict::Keep),
        }
    }
}

impl Intercept for Policy {
    fn name(&self) -> String {
        self.name.to_owned()
    }

    async fn before(&self, _id: EffectId, kind: &EffectKind) -> Decision {
        self.seen
            .lock()
            .expect("seen")
            .push(format!("{}.before", self.name));
        (self.before)(kind)
    }

    async fn after(
        &self,
        _id: EffectId,
        _kind: &EffectKind,
        outcome: &Result<Outcome, ErrorReport>,
    ) -> Verdict {
        self.seen
            .lock()
            .expect("seen")
            .push(format!("{}.after", self.name));
        (self.after)(outcome)
    }
}

/// A recorder's view: outcomes, events and discards, as the driver's tap
/// would deliver them.
#[derive(Default)]
struct Tapped {
    outcomes: Mutex<Vec<Result<Outcome, ErrorReport>>>,
    events: Mutex<Vec<Item<StreamEvent>>>,
    discarded: AtomicUsize,
    patched: Mutex<Vec<EffectKind>>,
}

impl super::super::Observe for Arc<Tapped> {
    fn origin(&mut self, _origin: &crate::message::Origin) {}
    fn outcome(&mut self, outcome: &Result<Outcome, ErrorReport>) {
        self.outcomes
            .lock()
            .expect("outcomes")
            .push(outcome.clone());
    }

    fn keep_events(&self) -> bool {
        true
    }

    fn event(&mut self, event: &Item<StreamEvent>) {
        self.events.lock().expect("events").push(event.clone());
    }

    fn discard(&mut self, _: &str) {
        self.discarded.fetch_add(1, Ordering::SeqCst);
    }

    fn patch(&mut self, kind: &EffectKind) {
        self.patched.lock().expect("patched").push(kind.clone());
    }
}

fn tapped(dispatch: Dispatch, tapped: &Arc<Tapped>) -> Dispatch {
    dispatch.with_observer(Box::new(Arc::clone(tapped)))
}

fn echo() -> (ErasedHandler, Arc<AtomicUsize>) {
    let served = Arc::new(AtomicUsize::new(0));
    (
        ErasedHandler::new(Echo {
            served: Arc::clone(&served),
        }),
        served,
    )
}

/// Dispatch `kind` unary through `handler` with a recording tap; the
/// consumer's outcome and the tap's view.
async fn unary(
    handler: &ErasedHandler,
    kind: EffectKind,
) -> (Result<Outcome, ErrorReport>, Arc<Tapped>) {
    let tap = Arc::new(Tapped::default());
    let dispatch = tapped(Dispatch::new(EffectId::from_raw(7), false), &tap);
    let outcome = handler.handle(kind, dispatch).await.into_outcome().await;
    (outcome, tap)
}

#[tokio::test]
async fn a_patch_of_another_family_is_internal_and_never_a_dispatch() {
    let seen = Arc::new(Mutex::new(Vec::new()));
    let (handler, served) = echo();
    let mut policy = Policy::observing("wrong", &seen);
    policy.before = Box::new(|_| {
        Decision::Patch(EffectKind::Memory {
            op: crate::effect::MemoryOp::Clear {
                conversation: crate::id::ConversationId::from("c"),
            },
        })
    });
    let layered = handler.layered(policy);
    let (outcome, tap) = unary(&layered, custom(json!(1))).await;
    let report = outcome.expect_err("internal");
    assert_eq!(report.kind, ErrorKind::Internal);
    assert!(
        report.message.contains("layer `wrong`"),
        "{}",
        report.message
    );
    assert!(report.message.contains("custom") && report.message.contains("memory"));
    assert_eq!(served.load(Ordering::SeqCst), 0, "no dispatch");
    assert!(
        tap.outcomes.lock().expect("outcomes").is_empty(),
        "no record"
    );
    assert_eq!(tap.discarded.load(Ordering::SeqCst), 1);
    assert_eq!(
        *seen.lock().expect("seen"),
        ["wrong.before"],
        "no after: nothing was answered"
    );
}

#[tokio::test]
async fn an_error_replacing_a_streamed_answer_follows_its_events() {
    let seen = Arc::new(Mutex::new(Vec::new()));
    let mut policy = Policy::observing("cut", &seen);
    policy.after = Box::new(|_| {
        Verdict::Replace(Err(ErrorReport::new(
            ErrorKind::Cancelled,
            "the program stops",
        )))
    });
    let layered = ErasedHandler::new(Streamer).layered(policy);
    let tap = Arc::new(Tapped::default());
    let dispatch = tapped(Dispatch::new(EffectId::from_raw(9), true), &tap);
    let items: Vec<_> = layered
        .handle(custom(json!(1)), dispatch)
        .await
        .into_stream()
        .collect()
        .await;
    let last = items.last().expect("an ending");
    assert!(
        matches!(last, Err(report) if report.kind == ErrorKind::Cancelled),
        "{last:?}"
    );
    assert!(
        items[..items.len() - 1].iter().all(Result::is_ok),
        "the events were delivered as they came"
    );
    // The record holds the handler's real answer.
    {
        let outcomes = tap.outcomes.lock().expect("outcomes");
        assert!(matches!(&outcomes[0], Ok(Outcome::Completion(_))));
    }
    // A replacement answer cannot follow events already delivered.
    let mut policy = Policy::observing("swap", &seen);
    policy.after = Box::new(|_| {
        Verdict::Replace(Ok(Outcome::Custom {
            payload: json!("late"),
        }))
    });
    let layered = ErasedHandler::new(Streamer).layered(policy);
    let items: Vec<_> = layered
        .handle(custom(json!(1)), Dispatch::new(EffectId::from_raw(9), true))
        .await
        .into_stream()
        .collect()
        .await;
    let last = items.last().expect("an ending");
    assert!(
        matches!(last, Err(report) if report.kind == ErrorKind::Internal && report.message.contains("layer `swap`")),
        "{last:?}"
    );
}

#[test]
fn decisions_and_verdicts_are_data() {
    let deny = Decision::deny("no");
    let json = serde_json::to_value(&deny).expect("serializes");
    assert_eq!(json["decision"], "deny");
    assert_eq!(json["kind"], "denied");
    let back: Decision = serde_json::from_value(json.clone()).expect("restores");
    assert_eq!(serde_json::to_value(&back).expect("serializes"), json);
    let keep = serde_json::to_value(Verdict::Keep).expect("serializes");
    assert_eq!(keep, json!({"verdict": "keep"}));
}

/// Retargeting must be refused before a nested policy can authorize a different name.
#[tokio::test]
async fn tool_target_patch_is_refused_before_inner_policy_in_unary_and_streaming() {
    use crate::{
        serve::adapters::ToolFn,
        tool::{ToolContext, ToolOutput},
        wasm_compat::WasmBoxedFuture,
    };
    for streamed in [false, true] {
        let served = Arc::new(AtomicUsize::new(0));
        let counter = served.clone();
        let tool = ToolFn::new(
            "original",
            "bound original",
            json!({"type":"object"}),
            move |_context: &mut ToolContext, _args: serde_json::Value| {
                counter.fetch_add(1, Ordering::SeqCst);
                Box::pin(async { Ok(ToolOutput::text("executed original")) })
                    as WasmBoxedFuture<'_, _>
            },
        );
        let seen = Arc::new(Mutex::new(Vec::new()));
        let mut inner = Policy::observing("inner", &seen);
        inner.before = Box::new(|kind| match kind {
            EffectKind::ToolCall { name, .. } if name == "allowed" => Decision::Proceed,
            _ => Decision::Deny(ErrorReport::new(ErrorKind::Denied, "original is forbidden")),
        });
        let mut outer = Policy::observing("outer", &seen);
        outer.before = Box::new(|_| {
            Decision::Patch(EffectKind::ToolCall {
                name: "allowed".into(),
                args: "{}".into(),
            })
        });
        let handler = ErasedHandler::new(tool).layered(inner).layered(outer);
        let kind = EffectKind::ToolCall {
            name: "original".into(),
            args: "{}".into(),
        };
        let tap = if streamed {
            let tap = Arc::new(Tapped::default());
            let events: Vec<_> = handler
                .handle(
                    kind,
                    tapped(Dispatch::new(EffectId::from_raw(7), true), &tap),
                )
                .await
                .into_stream()
                .collect()
                .await;
            assert!(events.iter().any(Result::is_err));
            tap
        } else {
            let (outcome, tap) = unary(&handler, kind).await;
            assert!(outcome.is_err());
            tap
        };
        assert_eq!(
            served.load(Ordering::SeqCst),
            0,
            "never execute the original under an authorized replacement name"
        );
        assert_eq!(*seen.lock().expect("policy trace"), ["outer.before"]);
        assert!(tap.patched.lock().expect("patches").is_empty());
        assert_eq!(tap.discarded.load(Ordering::SeqCst), 1);
    }
}

#[tokio::test]
async fn tool_argument_patches_keep_the_bound_target_and_reach_inner_policy() {
    use crate::{
        serve::adapters::ToolFn,
        tool::{ToolContext, ToolOutput},
        wasm_compat::WasmBoxedFuture,
    };
    let tool = ToolFn::new(
        "original",
        "bound original",
        json!({"type":"object"}),
        |_context: &mut ToolContext, args: serde_json::Value| {
            assert_eq!(args, json!({"patched":true}));
            Box::pin(async { Ok(ToolOutput::text("executed patched arguments")) })
                as WasmBoxedFuture<'_, _>
        },
    );
    let seen = Arc::new(Mutex::new(Vec::new()));
    let mut inner = Policy::observing("inner", &seen);
    inner.before = Box::new(|kind| {
        assert!(
            matches!(kind, EffectKind::ToolCall { name, args } if name == "original" && args == r#"{"patched":true}"#)
        );
        Decision::Proceed
    });
    let mut outer = Policy::observing("outer", &seen);
    outer.before = Box::new(|_| {
        Decision::Patch(EffectKind::ToolCall {
            name: "original".into(),
            args: r#"{"patched":true}"#.into(),
        })
    });
    let handler = ErasedHandler::new(tool).layered(inner).layered(outer);
    let (outcome, tap) = unary(
        &handler,
        EffectKind::ToolCall {
            name: "original".into(),
            args: "{}".into(),
        },
    )
    .await;
    assert!(outcome.is_ok());
    assert_eq!(
        *seen.lock().expect("policy trace"),
        ["outer.before", "inner.before", "inner.after", "outer.after"]
    );
    assert_eq!(tap.patched.lock().expect("patches").len(), 1);
}