mentra 0.26.0

An agent runtime for tool-using LLM 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
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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
use std::{
    sync::{
        Arc, Barrier,
        atomic::{AtomicBool, AtomicUsize, Ordering},
    },
    thread,
    time::{SystemTime, UNIX_EPOCH},
};

use async_trait::async_trait;
use serde_json::{Value, json};

use crate::{
    ContentBlock,
    error::RuntimeError,
    runtime::{CancellationToken, RunOptions},
    runtime::{FileRuntimeStore, PermissionRuleStore, RuntimeStore, VolatileRuntimeStore},
    session::{
        PermissionDecision, PermissionRuleAddress, PermissionRuleScope, RememberedRule, RuleKey,
        SessionEvent,
    },
    test::{MockRuntime, MockToolCall},
    tool::{
        ParallelToolContext, ToolAuthorizationDecision, ToolAuthorizationRequest, ToolAuthorizer,
        ToolDefinition, ToolExecutor, ToolResult, ToolSpec,
    },
};

const PROBE_TOOL: &str = "permission_store_probe";

fn now_nanos() -> u128 {
    SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .expect("time")
        .as_nanos()
}

fn rule(scope: PermissionRuleScope, allow: bool) -> RememberedRule {
    RememberedRule {
        key: RuleKey {
            tool_name: PROBE_TOOL.to_owned(),
            pattern: None,
        },
        allow,
        scope,
        reason: (!allow).then(|| format!("{scope:?} refuses")),
    }
}

fn address(scope: PermissionRuleScope) -> PermissionRuleAddress {
    PermissionRuleAddress {
        scope,
        key: RuleKey {
            tool_name: PROBE_TOOL.to_owned(),
            pattern: None,
        },
    }
}

#[test]
fn live_sessions_share_project_and_global_mutations_without_a_cache() {
    let store = VolatileRuntimeStore::new();
    let mock = MockRuntime::builder()
        .with_store(store)
        .build()
        .expect("build runtime");
    let session_a = mock
        .runtime()
        .create_session_full(
            "a",
            mock.model(),
            Default::default(),
            Some("project-1".to_owned()),
        )
        .expect("create session a");
    let session_b = mock
        .runtime()
        .create_session_full(
            "b",
            mock.model(),
            Default::default(),
            Some("project-1".to_owned()),
        )
        .expect("create session b");
    let session_c = mock
        .runtime()
        .create_session_full(
            "c",
            mock.model(),
            Default::default(),
            Some("project-2".to_owned()),
        )
        .expect("create session c");
    let permissions_a = session_a.permission_handle();
    let permissions_b = session_b.permission_handle();
    let permissions_c = session_c.permission_handle();

    permissions_a
        .remember_rule(rule(PermissionRuleScope::Global, false))
        .expect("remember global rule");
    permissions_a
        .remember_rule(rule(PermissionRuleScope::Project, false))
        .expect("remember project rule");
    permissions_a
        .remember_rule(rule(PermissionRuleScope::Session, true))
        .expect("remember session rule");

    assert_eq!(
        permissions_a
            .matching_rule(PROBE_TOOL, None)
            .expect("match session a")
            .expect("session a rule")
            .scope,
        PermissionRuleScope::Session
    );
    assert_eq!(
        permissions_b
            .matching_rule(PROBE_TOOL, None)
            .expect("match session b")
            .expect("session b rule")
            .scope,
        PermissionRuleScope::Project
    );
    assert_eq!(
        permissions_c
            .matching_rule(PROBE_TOOL, None)
            .expect("match session c")
            .expect("session c rule")
            .scope,
        PermissionRuleScope::Global
    );

    assert!(
        permissions_b
            .revoke_rule(&address(PermissionRuleScope::Project))
            .expect("revoke shared project rule")
    );
    assert_eq!(
        permissions_a
            .matching_rule(PROBE_TOOL, None)
            .expect("match session a after project revoke")
            .expect("session a keeps its own rule")
            .scope,
        PermissionRuleScope::Session
    );
    assert_eq!(
        permissions_b
            .matching_rule(PROBE_TOOL, None)
            .expect("match session b after project revoke")
            .expect("session b falls back to global")
            .scope,
        PermissionRuleScope::Global
    );

    assert_eq!(
        permissions_c
            .clear_scope(PermissionRuleScope::Global)
            .expect("clear global namespace"),
        1
    );
    assert!(
        permissions_b
            .matching_rule(PROBE_TOOL, None)
            .expect("match session b after global clear")
            .is_none()
    );
}

#[tokio::test]
async fn project_validation_keeps_the_pending_request_available() {
    let mock = MockRuntime::builder().build().expect("build runtime");
    let session = mock
        .runtime()
        .create_session("no-project", mock.model())
        .expect("create session");
    let permissions = session.permission_handle();
    let (sender, receiver) = tokio::sync::oneshot::channel();
    let _guard = permissions.pending_permissions().insert(
        "perm-project".to_owned(),
        crate::session::permission::PendingPermissionEntry {
            tool_call_id: "call-project".to_owned(),
            tool_name: PROBE_TOOL.to_owned(),
            sender,
        },
    );

    let error = permissions
        .resolve_permission(
            "perm-project",
            PermissionDecision::allow_and_remember(PermissionRuleScope::Project),
        )
        .expect_err("project scope requires a project id");
    assert!(error.to_string().contains("project_id"), "{error}");
    assert!(permissions.pending_permissions().contains("perm-project"));
    assert!(permissions.remembered_rules().unwrap().is_empty());

    permissions
        .resolve_permission("perm-project", PermissionDecision::deny())
        .expect("the retained request can still be resolved");
    assert!(!receiver.await.expect("receive retained decision").allow);
}

#[tokio::test]
async fn a_persistence_failure_keeps_the_pending_request_retryable() {
    let root = std::env::temp_dir().join(format!(
        "mentra-live-permission-resolve-failure-{}-{}",
        std::process::id(),
        now_nanos()
    ));
    let store = FileRuntimeStore::new(&root);
    let mock = MockRuntime::builder()
        .with_store(store.clone())
        .build()
        .unwrap();
    let session = mock
        .runtime()
        .create_session("resolve-failure", mock.model())
        .unwrap();
    let permissions = session.permission_handle();
    let (sender, receiver) = tokio::sync::oneshot::channel();
    let _guard = permissions.pending_permissions().insert(
        "perm-retry".to_owned(),
        crate::session::permission::PendingPermissionEntry {
            tool_call_id: "call-retry".to_owned(),
            tool_name: PROBE_TOOL.to_owned(),
            sender,
        },
    );
    std::fs::write(store.rules_path(), b"{").expect("corrupt rules file");

    permissions
        .resolve_permission(
            "perm-retry",
            PermissionDecision::allow_and_remember(PermissionRuleScope::Session),
        )
        .expect_err("the failed durable write must be reported");
    assert!(permissions.pending_permissions().contains("perm-retry"));
    assert!(receiver.is_empty());

    std::fs::remove_file(store.rules_path()).expect("remove corrupt rules file");
    permissions
        .resolve_permission(
            "perm-retry",
            PermissionDecision::allow_and_remember(PermissionRuleScope::Session),
        )
        .expect("retry durable write");
    assert!(receiver.await.expect("receive retried decision").allow);
    assert_eq!(permissions.remembered_rules().unwrap().len(), 1);
}

#[test]
fn resolve_racing_wait_drop_never_persists_after_a_failed_send() {
    let mock = MockRuntime::builder().build().unwrap();
    let session = mock
        .runtime()
        .create_session("resolve-race", mock.model())
        .unwrap();
    let permissions = session.permission_handle();

    for iteration in 0..64 {
        let request_id = format!("perm-race-{iteration}");
        let tool_name = format!("race-tool-{iteration}");
        let (sender, receiver) = tokio::sync::oneshot::channel();
        let guard = permissions.pending_permissions().insert(
            request_id.clone(),
            crate::session::permission::PendingPermissionEntry {
                tool_call_id: format!("call-race-{iteration}"),
                tool_name: tool_name.clone(),
                sender,
            },
        );
        let barrier = Arc::new(Barrier::new(2));
        let drop_barrier = barrier.clone();
        let dropper = thread::spawn(move || {
            drop_barrier.wait();
            drop(guard);
            drop(receiver);
        });

        barrier.wait();
        let result = permissions.resolve_permission(
            &request_id,
            PermissionDecision::allow_and_remember(PermissionRuleScope::Session),
        );
        dropper.join().expect("drop thread should finish");
        let persisted = permissions
            .remembered_rules()
            .unwrap()
            .iter()
            .any(|rule| rule.key.tool_name == tool_name);
        assert_eq!(
            persisted,
            result.is_ok(),
            "iteration {iteration}: persistence and live delivery must have one winner"
        );
    }
}

#[test]
fn remembering_one_session_rule_never_copies_inherited_rules() {
    let store = VolatileRuntimeStore::new();
    let mock = MockRuntime::builder()
        .with_store(store.clone())
        .build()
        .expect("build runtime");
    let session_a = mock
        .runtime()
        .create_session_full(
            "a",
            mock.model(),
            Default::default(),
            Some("project-1".to_owned()),
        )
        .expect("create session a");
    let session_b = mock
        .runtime()
        .create_session_full(
            "b",
            mock.model(),
            Default::default(),
            Some("project-1".to_owned()),
        )
        .expect("create session b");
    session_a
        .permission_handle()
        .remember_rule(rule(PermissionRuleScope::Project, false))
        .unwrap();
    session_a
        .permission_handle()
        .remember_rule(RememberedRule {
            key: RuleKey {
                tool_name: "network".to_owned(),
                pattern: None,
            },
            allow: false,
            scope: PermissionRuleScope::Global,
            reason: None,
        })
        .unwrap();
    let permissions_b = session_b.permission_handle();
    let (sender, _receiver) = tokio::sync::oneshot::channel();
    let _guard = permissions_b.pending_permissions().insert(
        "perm-session-b".to_owned(),
        crate::session::permission::PendingPermissionEntry {
            tool_call_id: "call-session-b".to_owned(),
            tool_name: PROBE_TOOL.to_owned(),
            sender,
        },
    );
    permissions_b
        .resolve_permission(
            "perm-session-b",
            PermissionDecision::allow_and_remember(PermissionRuleScope::Session),
        )
        .unwrap();

    let context = permissions_b.context().clone();
    assert_eq!(
        store
            .clear_scope(&context, PermissionRuleScope::Project)
            .unwrap(),
        1
    );
    assert_eq!(
        store
            .clear_scope(&context, PermissionRuleScope::Global)
            .unwrap(),
        1
    );
}

async fn assert_session_rule_survives_and_revocation_reopens_empty<S, F>(make_store: F, label: &str)
where
    S: RuntimeStore + Clone + 'static,
    F: Fn() -> S,
{
    let runtime_id = format!("permission-live-{label}");
    let agent_id;
    {
        let mock = MockRuntime::builder()
            .runtime_identifier(&runtime_id)
            .with_store(make_store())
            .build()
            .unwrap();
        let session = mock
            .runtime()
            .create_session("persisted", mock.model())
            .unwrap();
        agent_id = session.agent_id().to_owned();
        session
            .permission_handle()
            .remember_rule(rule(PermissionRuleScope::Session, true))
            .unwrap();
    }

    {
        let mock = MockRuntime::builder()
            .runtime_identifier(&runtime_id)
            .with_store(make_store())
            .build()
            .unwrap();
        let resumed = mock.runtime().resume_session(&agent_id).unwrap();
        assert_eq!(resumed.permission_handle().context().session_id, agent_id);
        assert_eq!(resumed.remembered_rules().unwrap().len(), 1);
        assert!(
            resumed
                .permission_handle()
                .revoke_rule(&address(PermissionRuleScope::Session))
                .unwrap()
        );
    }

    let mock = MockRuntime::builder()
        .runtime_identifier(runtime_id)
        .with_store(make_store())
        .build()
        .unwrap();
    let resumed = mock.runtime().resume_session(&agent_id).unwrap();
    assert!(resumed.remembered_rules().unwrap().is_empty());
}

#[tokio::test]
async fn file_store_session_rules_survive_resume_and_revocation_survives_reopen() {
    let root = std::env::temp_dir().join(format!(
        "mentra-live-permission-file-{}-{}",
        std::process::id(),
        now_nanos()
    ));
    assert_session_rule_survives_and_revocation_reopens_empty(
        || FileRuntimeStore::new(&root),
        "file",
    )
    .await;
}

#[cfg(feature = "store-sqlite")]
#[tokio::test]
async fn sqlite_session_rules_survive_resume_and_revocation_survives_reopen() {
    let path = std::env::temp_dir().join(format!(
        "mentra-live-permission-sqlite-{}.sqlite",
        now_nanos()
    ));
    assert_session_rule_survives_and_revocation_reopens_empty(
        || crate::runtime::SqliteRuntimeStore::new(&path),
        "sqlite",
    )
    .await;
}

#[derive(Clone)]
struct PromptThenDeny(Arc<AtomicBool>);

impl PromptThenDeny {
    fn prompting() -> Self {
        Self(Arc::new(AtomicBool::new(false)))
    }

    fn deny(&self) {
        self.0.store(true, Ordering::SeqCst);
    }
}

#[async_trait]
impl ToolAuthorizer for PromptThenDeny {
    async fn authorize(
        &self,
        _request: &ToolAuthorizationRequest,
    ) -> Result<ToolAuthorizationDecision, RuntimeError> {
        Ok(if self.0.load(Ordering::SeqCst) {
            ToolAuthorizationDecision::deny("current mode refuses")
        } else {
            ToolAuthorizationDecision::prompt("current mode asks")
        })
    }
}

#[derive(Clone)]
struct ProbeTool(Arc<AtomicUsize>);

impl ToolDefinition for ProbeTool {
    fn descriptor(&self) -> ToolSpec {
        ToolSpec::builder(PROBE_TOOL)
            .description("count permission-store executions")
            .input_schema(json!({ "type": "object" }))
            .build()
    }
}

#[async_trait]
impl ToolExecutor for ProbeTool {
    async fn execute(&self, _ctx: ParallelToolContext, _input: Value) -> ToolResult {
        self.0.fetch_add(1, Ordering::SeqCst);
        Ok("executed".to_owned())
    }
}

#[tokio::test]
async fn clearing_session_rules_and_switching_mode_governs_the_next_call() {
    let policy = PromptThenDeny::prompting();
    let mock = MockRuntime::builder()
        .tool_calls([MockToolCall::new(PROBE_TOOL, json!({}))])
        .text("first")
        .tool_calls([MockToolCall::new(PROBE_TOOL, json!({}))])
        .text("second")
        .build()
        .unwrap();
    let executions = Arc::new(AtomicUsize::new(0));
    mock.runtime().register_tool(ProbeTool(executions.clone()));
    let mut session = mock
        .runtime()
        .create_session("mode", mock.model())
        .unwrap()
        .with_tool_authorizer(policy.clone());
    session
        .permission_handle()
        .remember_rule(rule(PermissionRuleScope::Session, true))
        .unwrap();

    session
        .append_turn(vec![ContentBlock::text("first")])
        .await
        .unwrap();
    assert_eq!(executions.load(Ordering::SeqCst), 1);

    assert_eq!(
        session
            .permission_handle()
            .clear_scope(PermissionRuleScope::Session)
            .unwrap(),
        1
    );
    policy.deny();
    session
        .append_turn(vec![ContentBlock::text("second")])
        .await
        .unwrap();
    assert_eq!(executions.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn a_live_rule_store_error_fails_closed_without_prompting_or_execution() {
    let root = std::env::temp_dir().join(format!(
        "mentra-live-permission-corrupt-{}-{}",
        std::process::id(),
        now_nanos()
    ));
    let store = FileRuntimeStore::new(&root);
    let policy = PromptThenDeny::prompting();
    let mock = MockRuntime::builder()
        .with_store(store.clone())
        .tool_calls([MockToolCall::new(PROBE_TOOL, json!({}))])
        .text("done")
        .build()
        .unwrap();
    let executions = Arc::new(AtomicUsize::new(0));
    mock.runtime().register_tool(ProbeTool(executions.clone()));
    let mut session = mock
        .runtime()
        .create_session("corrupt-store", mock.model())
        .unwrap()
        .with_tool_authorizer(policy);
    let mut events = session.subscribe();
    std::fs::write(store.rules_path(), b"{").expect("corrupt rules file");

    session
        .append_turn(vec![ContentBlock::text("run")])
        .await
        .expect("authorizer failure is returned to the model as a denied tool result");

    assert_eq!(executions.load(Ordering::SeqCst), 0);
    let mut requested = false;
    while let Ok(event) = events.try_recv() {
        requested |= matches!(event, SessionEvent::PermissionRequested { .. });
    }
    assert!(!requested, "a failed store lookup must not ask or execute");
}

#[tokio::test]
async fn cancelling_a_permission_wait_removes_pending_and_rejects_late_rules() {
    let policy = PromptThenDeny::prompting();
    let mock = MockRuntime::builder()
        .tool_calls([MockToolCall::new(PROBE_TOOL, json!({}))])
        .text("never reached")
        .build()
        .unwrap();
    mock.runtime()
        .register_tool(ProbeTool(Arc::new(AtomicUsize::new(0))));
    let mut session = mock
        .runtime()
        .create_session("cancel-permission", mock.model())
        .unwrap()
        .with_tool_authorizer(policy);
    let permissions = session.permission_handle();
    let mut events = session.subscribe();
    let cancellation = CancellationToken::default();
    let cancellation_for_turn = cancellation.clone();
    let turn = tokio::spawn(async move {
        session
            .append_turn_with_options(
                vec![ContentBlock::text("run")],
                RunOptions {
                    cancellation: Some(cancellation_for_turn),
                    ..RunOptions::default()
                },
            )
            .await
    });
    let request_id = tokio::time::timeout(std::time::Duration::from_secs(2), async {
        loop {
            if let SessionEvent::PermissionRequested { request_id, .. } = events
                .recv()
                .await
                .expect("session event stream remains open")
            {
                break request_id;
            }
        }
    })
    .await
    .expect("permission request should arrive");

    cancellation.cancel();
    assert!(
        tokio::time::timeout(std::time::Duration::from_secs(2), turn)
            .await
            .expect("cancelled turn should finish")
            .expect("turn task should join")
            .is_err()
    );
    assert!(!permissions.pending_permissions().contains(&request_id));
    assert!(
        permissions
            .resolve_permission(
                &request_id,
                PermissionDecision::allow_and_remember(PermissionRuleScope::Global),
            )
            .is_err()
    );
    assert!(permissions.remembered_rules().unwrap().is_empty());
}