Skip to content

The fastest, cheapest, most efficient open-source agent harness. Run more than 500 agents on a $10 VPS.

8.2 KB
Raw Blame
//! The memory facade against TinyMemory's in-memory reference engine: one
//! runtime, two tenant roots, and the guarantee that neither reaches the
//! other.
//!
//! One `#[test]` because a runtime claims a process-wide slot, and the host
//! engine it installs is process-wide too.

mod common;

use std::sync::Arc;

use common::{offline_config, runtime};
use openhuman_embed::memory::api::conformance::ReferenceEngine;
use openhuman_embed::memory::api::{
    ItemKind, LearningKind, MemoryEngine, MemoryMeta, Namespace, Role, SourceKind, StoreItem, Turn,
    WriteOptions,
};
use openhuman_embed::memory::{ItemsQuery, LearnParams, SearchQuery};
use openhuman_embed::{Runtime, Workspace};

fn learning(text: &str) -> LearnParams {
    serde_json::from_value(serde_json::json!({ "text": text })).expect("learn params")
}

async fn store_at(engine: &ReferenceEngine, node: &str, text: &str) -> String {
    let meta = MemoryMeta {
        namespace: node.parse::<Namespace>().expect("node"),
        ..MemoryMeta::default()
    };
    engine
        .store(StoreItem::learning(text, LearningKind::Fact, 0.9, meta))
        .await
        .expect("store")
        .id
        .0
}

#[test]
fn a_tenant_root_confines_every_call() {
    runtime().block_on(async {
        tokio::spawn(async {
            let engine = Arc::new(ReferenceEngine::new());
            let rt = Runtime::builder()
                .workspace(Workspace::Ephemeral)
                .config(offline_config())
                .memory_engine(engine.clone())
                .build()
                .await
                .expect("runtime");

            let acme = rt.memory("team:acme").expect("acme");
            let globex = rt.memory("team:globex").expect("globex");
            assert!(acme.status().on, "the installed engine binds");
            assert!(rt.memory("").is_err(), "the store root is no tenant");

            // Learnings land at the tenant root, whatever the caller's meta says.
            let mut params = learning("Acme ships on Fridays");
            params.meta = Some(MemoryMeta {
                namespace: "team:globex".parse().unwrap(),
                ..MemoryMeta::default()
            });
            let learned = acme.learn(params).await.expect("learn");
            let got = acme.get(vec![learned.id.clone()]).await.expect("get");
            assert_eq!(got.len(), 1);
            assert_eq!(got[0].meta.namespace.to_string(), "team:acme");
            assert!(globex
                .get(vec![learned.id.clone()])
                .await
                .unwrap()
                .is_empty());

            // One agent's node, listed on its own.
            let ceo = store_at(&engine, "team:acme/agent:ceo", "the CEO prefers email").await;
            let cfo = store_at(
                &engine,
                "team:acme/agent:cfo",
                "the CFO closes books monthly",
            )
            .await;
            let ceo_items = acme
                .list(ItemsQuery {
                    agent_id: Some("ceo".into()),
                    ..ItemsQuery::default()
                })
                .await
                .expect("list ceo");
            let ids: Vec<_> = ceo_items.items.iter().map(|hit| hit.id.0.clone()).collect();
            assert_eq!(ids, vec![ceo.clone()]);

            let all = acme.list(ItemsQuery::default()).await.expect("list all");
            assert_eq!(all.items.len(), 3);
            let learnings = acme
                .list(ItemsQuery {
                    kinds: vec![ItemKind::Learning],
                    ..ItemsQuery::default()
                })
                .await
                .unwrap();
            assert_eq!(learnings.items.len(), 3);
            assert!(globex
                .list(ItemsQuery::default())
                .await
                .unwrap()
                .items
                .is_empty());

            // Another tenant cannot forget acme's items by id.
            let forgotten = globex
                .forget(vec![ceo.clone(), learned.id.clone()])
                .await
                .unwrap();
            assert_eq!(forgotten.forgotten, 0);
            assert_eq!(acme.get(vec![ceo.clone()]).await.unwrap().len(), 1);

            // Forgetting one agent leaves its teammates and the shared learnings.
            assert_eq!(acme.forget_agent("ceo").await.expect("forget agent"), 1);
            assert!(acme.get(vec![ceo]).await.unwrap().is_empty());
            assert_eq!(acme.get(vec![cfo]).await.unwrap().len(), 1);
            assert_eq!(acme.get(vec![learned.id]).await.unwrap().len(), 1);

            // A host's own captures: stored at the root or one agent's node,
            // whatever namespace they name, and searched by tag.
            let mut meta = MemoryMeta::from_source(SourceKind::Conversation, Some("x:1".into()));
            meta.namespace = "team:globex".parse().unwrap();
            meta.tags = vec!["mention".into(), "@ana".into()];
            let mention = StoreItem::Conversation {
                turns: vec![Turn::new(Role::User, "is the launch on fridays too")],
                meta,
            };
            let stored = acme
                .store(mention.clone(), None, WriteOptions::visible())
                .await
                .expect("store at the root");
            assert!(!stored.replayed);
            let again = acme
                .store(mention, None, WriteOptions::accepted())
                .await
                .expect("store again");
            assert!(again.replayed, "an identical capture is a replay");
            assert_eq!(again.id, stored.id);
            let got = acme.get(vec![stored.id.0.clone()]).await.unwrap();
            assert_eq!(got[0].meta.namespace.to_string(), "team:acme");
            assert_eq!(got[0].meta.source.id.as_deref(), Some("x:1"));
            assert!(globex
                .get(vec![stored.id.0.clone()])
                .await
                .unwrap()
                .is_empty());

            let note = StoreItem::document(
                "fridays are for the launch notes",
                MemoryMeta {
                    tags: vec!["activity".into()],
                    ..MemoryMeta::default()
                },
            );
            let filed = acme
                .store(note, Some("cfo"), WriteOptions::visible())
                .await
                .expect("store at an agent");
            let filed = acme.get(vec![filed.id.0]).await.unwrap();
            assert_eq!(filed[0].meta.namespace.to_string(), "team:acme/agent:cfo");

            let tagged = acme
                .search(SearchQuery {
                    query: "fridays".into(),
                    tags_any: vec!["@ana".into()],
                    ..SearchQuery::default()
                })
                .await
                .expect("search by tag");
            let ids: Vec<_> = tagged.hits.iter().map(|hit| hit.id.0.clone()).collect();
            assert_eq!(ids, vec![stored.id.0.clone()]);
            let documents = acme
                .search(SearchQuery {
                    query: "fridays".into(),
                    kinds: vec![ItemKind::Document],
                    ..SearchQuery::default()
                })
                .await
                .expect("search by kind");
            assert_eq!(documents.hits.len(), 1);
            assert_eq!(documents.hits[0].kind, ItemKind::Document);
            let ceo_reads = acme
                .search(SearchQuery {
                    query: "fridays".into(),
                    agent_id: Some("ceo".into()),
                    ..SearchQuery::default()
                })
                .await
                .expect("search one agent");
            assert!(
                ceo_reads
                    .hits
                    .iter()
                    .all(|hit| hit.meta.namespace.to_string() != "team:acme/agent:cfo"),
                "an agent's search never reads a sibling's node"
            );
            assert!(globex
                .search(SearchQuery {
                    query: "fridays".into(),
                    ..SearchQuery::default()
                })
                .await
                .unwrap()
                .hits
                .is_empty());

            assert!(openhuman_embed::memory::clear_host_engine());
        })
        .await
        .expect("memory facade test task");
    });
}