Skip to main content

valence_backend_mem/
lib.rs

1//! In-memory [`DatabaseBackend`](valence_core::DatabaseBackend) reference adapter.
2
3#![deny(missing_docs)]
4
5mod backend;
6mod query_filter;
7
8pub use backend::{InMemoryBackend, ENGINE_ID};
9pub use valence_core::{router_key, DatabaseRouter, KnownEngines, DEFAULT_IN_MEMORY_ROUTER_KEY};
10
11use std::sync::Arc;
12
13/// Register the default in-memory backend under [`DEFAULT_IN_MEMORY_ROUTER_KEY`].
14pub fn install_default_mem_router() -> Arc<DatabaseRouter> {
15    let router = Arc::new(DatabaseRouter::new());
16    let backend = Arc::new(InMemoryBackend::new());
17    let key = router_key("default", ENGINE_ID);
18    router
19        .register_runtime(key, backend)
20        .expect("register default mem backend");
21    router
22}
23
24#[cfg(test)]
25mod tests {
26    use super::*;
27
28    #[test]
29    fn install_default_registers_key() {
30        let router = install_default_mem_router();
31        let backend = router.resolve(DEFAULT_IN_MEMORY_ROUTER_KEY).unwrap();
32        assert_eq!(backend.engine_id(), ENGINE_ID);
33    }
34
35    #[tokio::test]
36    async fn instrumented_wrap_emits_read_counter() {
37        use std::sync::Arc;
38
39        use valence_core::instrumentation::wrap_backend;
40        use valence_telemetry::{install_telemetry_sink, RecordingSink};
41
42        let sink = RecordingSink::new();
43        install_telemetry_sink(Arc::new(sink.clone()));
44        let wrapped = wrap_backend(Arc::new(InMemoryBackend::new()));
45        let _ = wrapped.get_record("fixture", "id").await.expect("get");
46        assert!(!sink
47            .recorded_counters_matching("valence_db_reads", &[("op", "get")])
48            .is_empty());
49    }
50}